hazza/jupyterhub
1
0
Fork 0
mirror of https://github.com/jupyterhub/jupyterhub.git synced 2025-10-17 23:13:00 +00:00
Code Issues Packages Projects Releases Wiki Activity

[pre-commit.ci] auto fixes from pre-commit.com hooks

Browse Source 
for more information, see https://pre-commit.ci
This commit is contained in:
pre-commit-ci[bot]
2022-10-18 01:25:27 +00:00
parent 10c54353da
commit 28de35facd
1 changed files with 3 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/source/reference/rest.md
View File

@@ -10,7 +10,6 @@ This section will give you information on:
- [how to make an API request programmatically using the requests library](#make-an-api-request) - [how to make an API request programmatically using the requests library](#make-an-api-request)
- [where to learn more about JupyterHub's API](#learn-more-about-the-api) - [where to learn more about JupyterHub's API](#learn-more-about-the-api)
Before we discuss about JupyterHub's REST API, you can learn about [REST APIs here](https://en.wikipedia.org/wiki/Representational_state_transfer). A REST Before we discuss about JupyterHub's REST API, you can learn about [REST APIs here](https://en.wikipedia.org/wiki/Representational_state_transfer). A REST
API provides a standard way for users to get and send information to the API provides a standard way for users to get and send information to the
Hub. Hub.
@@ -26,12 +25,10 @@ such as:
- authenticating services - authenticating services
- communicating with an individual Jupyter server's REST API - communicating with an individual Jupyter server's REST API
## Create an API token ## Create an API token
To send requests using JupyterHub API, you must pass an API token with To send requests using JupyterHub API, you must pass an API token with
the request. the request.
The preferred way of generating an API token is by running: The preferred way of generating an API token is by running:
@@ -179,11 +176,10 @@ r.json()
``` ```
The same API token can also authorize access to the [Jupyter Notebook REST API](https://jupyterhub.readthedocs.io/en/stable/reference/rest-api.html#/) The same API token can also authorize access to the [Jupyter Notebook REST API](https://jupyterhub.readthedocs.io/en/stable/reference/rest-api.html#/)
provided by notebook servers managed by JupyterHub if it has the necessary `access:users:servers` scope. provided by notebook servers managed by JupyterHub if it has the necessary `access:users:servers` scope.
<p>&nbsp;</p> <p>&nbsp;</p>
## Paginating API requests ## Paginating API requests
```{versionadded} 2.0 ```{versionadded} 2.0