Bokeh Server REST API

GET /bokeh/loginfromapikey

Log in a user from an API key.

Status Codes:
  • 302 Found – redirect to index on success, to login on failure
GET /bokeh/favicon.ico

Return favicon.

Status Codes:
GET /bokeh/sampleerror
GET /bokeh/register

Register a new user via a view.

Status Codes:
  • 200 OK – render registration form
POST /bokeh/register

Register a new user via a submission.

Status Codes:
  • 200 OK – registration result
GET /bokeh/userinfo/
GET /bokeh/logout

Log out the current user.

Status Codes:
GET /bokeh/login

Log in a user from a form.

Status Codes:
  • 200 OK – render login view
POST /bokeh/login

Log in user from a submission.

Status Codes:
  • 200 OK – if API flag set, log in status
  • 302 Found – if API flag not set, redirect to index on success, to login on failue
GET /bokeh/wsurl/
GET /bokeh/ping

Test whether Bokeh server is up.

Status Codes:
POST /bokeh/doc/
POST /bokeh/doc
GET /bokeh/doc/
GET /bokeh/

Render main page.

Status Codes:
  • 200 OK – if current user logged in
  • 302 Found – otherwise redirect to login
GET /

Render main page.

Status Codes:
  • 200 OK – if current user logged in
  • 302 Found – otherwise redirect to login
GET /bokeh/jsgenerate/(parentname)/(modulename)/(classname)
GET /bokeh/bb/(docid)/(typename)/(id)/

Retrieve a specific model with a given id and typename for a given Document.

Parameters:
  • docid – id of the Document to update or insert into
  • typename – the type of objects to find and return
  • id – unique id of the object to retrieve
Status Codes:
PUT /bokeh/bb/(docid)/(typename)/(id)/

Update a specific model with a given id and typename for a given Document.

Parameters:
  • docid – id of the Document to update or insert into
  • typename – the type of objects to find and return
  • id – unique id of the object to retrieve
Status Codes:
PATCH /bokeh/bb/(docid)/(typename)/(id)/

Update a specific model with a given id and typename for a given Document.

Parameters:
  • docid – id of the Document to update or insert into
  • typename – the type of objects to find and return
  • id – unique id of the object to retrieve
Status Codes:
DELETE /bokeh/bb/(docid)/(typename)/(id)/

Delete a specific model with a given id and typename for a given Document.

Parameters:
  • docid – id of the Document to update or insert into
  • typename – the type of objects to find and return
  • id – unique id of the object to retrieve
Status Codes:
GET /bokeh/objinfo/(docid)/(objid)
GET /bokeh/doc/(title)/show
GET /bokeh/doc/(docid)/(objid)
POST /bokeh/bb/(docid)/bulkupsert

Update or insert new objects for a given Document.

Parameters:
  • docid – id of the Document to update or insert into
Status Codes:
POST /bokeh/bb/(docid)/gc
POST /bokeh/bb/(docid)/(typename)/

Update or insert new objects for a given Document.

Parameters:
  • docid – id of the Document to update or insert into
Status Codes:
GET /bokeh/bb/(docid)/(typename)/

Retrieve all objects of a specified typename for a given Document.

Parameters:
  • docid – id of the Document to update or insert into
  • typename – the type of objects to find and return
Status Codes:
GET /bokehjs/static/(path: filename)

Return a specific BokehJS deployment file

Parameters:
  • filename – name of the file to retrieve
Status Codes:
GET /bokehjs/src/(path: filename)

Return a specific BokehJS source code file

Parameters:
  • filename – name of the file to retrieve
Status Codes:
GET /bokeh/getdocapikey/(docid)
GET /bokeh/autoload.js/(elementid)

Return autoload script for given elementid

Parameters:
  • elementid – DOM element ID to target
Status Codes:
GET /bokeh/bokehinfo/(docid)/
GET /bokeh/static/(path: filename)

Function used internally to send static files from the static folder to the browser.

New in version 0.5.

DELETE /bokeh/doc/(docid)/
DELETE /bokeh/doc/(docid)
GET /bokeh/doc/(docid)/
GET /bokeh/bb/(docid)/

Retrieve all objects for a given Document.

Parameters:
  • docid – id of the Document to update or insert into
Status Codes:
POST /bokeh/(docid)/publish
GET /static/(path: filename)

Function used internally to send static files from the static folder to the browser.

New in version 0.5.