---
page_template: redoc.html
# see: https://redocly.com/docs/redoc/config/ for options
redoc_options:
  hideHostname: true
  hideLoading: true
---

(jupyterhub-rest-API)=

# JupyterHub REST API

NOTE: The contents of this markdown file are not used,
this page is entirely generated from `_templates/redoc.html` and `_static/rest-api.yml`

REST API methods can be linked by their operationId in rest-api.yml,
prefixed with `rest-api-`, e.g.

```markdown
you cat [GET /api/users](rest-api-get-users)
```

```{jupyterhub-rest-api-links}

```