Base URL: /hub/api, Version: 0.7.0
The REST API for JupyterHub
Path | Operation | Description |
---|---|---|
/ | GET |
Get JupyterHub version |
/authorizations/cookie/{cookie_name}/{cookie_value} | GET |
Identify a user from a cookie |
/authorizations/token | POST |
Request a new API token |
/authorizations/token/{token} | GET |
Identify a user from an API token |
/groups | GET |
List groups |
/groups/{name} | DELETE |
Delete a group |
GET |
Get a group by name |
|
POST |
Create a group |
|
/groups/{name}/users | DELETE |
Remove users from a group |
POST |
Add users to a group |
|
/info | GET |
Get detailed info about JupyterHub |
/proxy | GET |
Get the proxy's routing table |
PATCH |
Notify the Hub about a new proxy |
|
POST |
Force the Hub to sync with the proxy |
|
/services | GET |
List services |
/services/{name} | GET |
Get a service by name |
/shutdown | POST |
Shutdown the Hub |
/users | GET |
List users |
POST |
Create multiple users |
|
/users/{name} | DELETE |
Delete a user |
GET |
Get a user by name |
|
PATCH |
Modify a user |
|
POST |
Create a single user |
|
/users/{name}/admin-access | POST |
Grant admin access to this user's notebook server |
/users/{name}/server | DELETE |
Stop a user's server |
POST |
Start a user's single-user notebook server |
Authorization
header
This endpoint is not authenticated for the purpose of clients and user to identify the JupyterHub version before setting up authentication.
Uses default content-types: application/json
The JupyterHub version
The version of JupyterHub itself
Uses default content-types: application/json
The list of groups
name | group name |
path | string |
Uses default content-types: application/json
The group has been deleted
name | group name |
path | string |
Uses default content-types: application/json
The group has been created
Uses default content-types: application/json
The users to remove from the group
List of usernames to remove from the group
name | group name |
path | string |
Uses default content-types: application/json
The users have been removed from the group
Uses default content-types: application/json
The users to add to the group
List of usernames to add to the group
name | group name |
path | string |
Uses default content-types: application/json
The users have been added to the group
Detailed JupyterHub information, including Python version, JupyterHub's version and executable path, and which Authenticator and Spawner are active.
Uses default content-types: application/json
Detailed JupyterHub info
The version of JupyterHub itself
The Python version, as returned by sys.version
The path to sys.executable running JupyterHub
The Python class currently active for JupyterHub Authentication
The version of the currently active Authenticator
The Python class currently active for spawning single-user notebook servers
The version of the currently active Spawner
A convenience alias for getting the routing table directly from the proxy
Uses default content-types: application/json
Routing table
configurable-http-proxy routing table (see configurable-http-proxy docs for details)
Notifies the Hub of a new proxy to use.
Uses default content-types: application/json
Any values that have changed for the new proxy. All keys are optional.
IP address of the new proxy
Port of the new proxy
Protocol of new proxy, if changed
CONFIGPROXY_AUTH_TOKEN for the new proxy
Uses default content-types: application/json
Success
Uses default content-types: application/json
Success
Uses default content-types: application/json
The service list
Uses default content-types: application/json
Whether users's notebook servers should be shutdown as well (default from Hub config)
Uses default content-types: application/json
Hub has shutdown
Uses default content-types: application/json
The Hub's user list
Uses default content-types: application/json
list of usernames to create on the Hub
whether the created users should be admins
Uses default content-types: application/json
The users have been created
The created users
name | username |
path | string |
Uses default content-types: application/json
The user has been deleted
Change a user's name or admin status
Uses default content-types: application/json
Updated user info. At least one key to be updated (name or admin) is required.
the new name (optional, if another key is updated i.e. admin)
update admin (optional, if another key is updated i.e. name)
name | username |
path | string |
Uses default content-types: application/json
The updated user info
name | username |
path | string |
Uses default content-types: application/json
The user has been created
name | username |
path | string |
Uses default content-types: application/json
Sets a cookie granting the requesting administrator access to the user's notebook server
name | username |
path | string |
Uses default content-types: application/json
The user's notebook server has not yet stopped as it is taking a while to stop
The user's notebook server has stopped
name | username |
path | string |
Uses default content-types: application/json
The user's notebook server has started
The user's notebook server has not yet started, but has been requested
The group's name
The names of users who are members of this group
The service's name
Whether the service is an admin
The internal url where the service is running
The proxied URL prefix to the service's url
The PID of the service process (if managed)
The command used to start the service (if managed)
The user's name
Whether the user is an admin
The names of groups where this user is a member
The user's notebook server's base URL, if running; null if not.
The currently pending action, if any
Timestamp of last-seen activity from the user