REST API

GET /api/bookstore

Info about bookstore

Status Codes:
  • 200 OK – Successfully requested
GET /bookstore/clone

Landing page for initiating cloning.

This serves a simple html page that allows avoiding xsrf issues on a jupyter server.

Query Parameters:
 
  • s3_bucket (string) – S3_bucket being targeted (Required)
  • s3_key (string) – S3 object key being requested (Required)
  • s3_version_id (string) – S3 object key being requested
Status Codes:
POST /api/bookstore/clone

Trigger clone from s3

Status Codes:
GET /bookstore/fs-clone

Landing page for initiating file-system cloning.

This serves a simple html page that allows avoiding xsrf issues on a jupyter server.

Query Parameters:
 
  • relpath (string) – relative path being targeted (Required)
Status Codes:
  • 200 OK – successful operation
  • 400 Bad Request – Request malformed, must provide a relative path.
  • 404 Not Found – Request to clone from a path outside of base directory
POST /api/bookstore/fs-clone

Trigger clone from file system

Status Codes:
  • 200 OK – Successfully cloned
  • 400 Bad Request – Malformed request. Provide a valid relative path.
  • 404 Not Found – Invalid request. Cloning from a path outside of the base directory is not allowed.
PUT /api/bookstore/publish/{path}

Publish a notebook to s3

Parameters:
  • path (string) – Path to publish to, it will be prefixed by the preconfigured published bucket.
Status Codes:
  • 200 OK – Successfully published.