Files
jupyterhub/docs/source/api/index.md
Min RK 868a571c73 set max depth on api/index toctree
default maxdepth seems to have changed?
2022-12-09 11:32:25 +01:00

38 lines
762 B
Markdown

(api-index)=
# JupyterHub API
<!--
Below is a MyST field list, using MyST substitution, as supported
by enabling the respective MyST extensions in docs/source/conf.py.
-->
:Date: {{ date }}
:Release: {{ version }}
JupyterHub also provides a REST API for administration of the Hub and users.
The documentation on [Using JupyterHub's REST API](../reference/rest.md) provides
information on:
- what you can do with the API
- creating an API token
- adding API tokens to the config files
- making an API request programmatically using the requests library
- learning more about JupyterHub's API
JupyterHub API Reference:
```{toctree}
:maxdepth: 3
app
auth
spawner
proxy
user
service
services.auth
```
[openapi initiative]: https://www.openapis.org/