JupyterHub API#
- Release:
2.3.1
- Date:
Jan 20, 2024
JupyterHub also provides a REST API for administration of the Hub and users. The documentation on Using JupyterHub’s REST API 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:
- Application configuration
- Module:
jupyterhub.appJupyterHubJupyterHubJupyterHub.active_server_limitJupyterHub.active_user_windowJupyterHub.activity_resolutionJupyterHub.admin_accessJupyterHub.admin_usersJupyterHub.allow_named_serversJupyterHub.answer_yesJupyterHub.api_page_default_limitJupyterHub.api_page_max_limitJupyterHub.api_tokensJupyterHub.authenticate_prometheusJupyterHub.authenticator_classJupyterHub.base_urlJupyterHub.bind_urlJupyterHub.cleanup_proxyJupyterHub.cleanup_serversJupyterHub.concurrent_spawn_limitJupyterHub.config_fileJupyterHub.confirm_no_sslJupyterHub.cookie_max_age_daysJupyterHub.cookie_secretJupyterHub.cookie_secret_fileJupyterHub.data_files_pathJupyterHub.db_kwargsJupyterHub.db_urlJupyterHub.debug_dbJupyterHub.debug_proxyJupyterHub.default_server_nameJupyterHub.default_urlJupyterHub.external_ssl_authoritiesJupyterHub.extra_handlersJupyterHub.extra_log_fileJupyterHub.extra_log_handlersJupyterHub.forwarded_host_headerJupyterHub.generate_certsJupyterHub.generate_configJupyterHub.hub_bind_urlJupyterHub.hub_connect_ipJupyterHub.hub_connect_portJupyterHub.hub_connect_urlJupyterHub.hub_ipJupyterHub.hub_portJupyterHub.hub_routespecJupyterHub.implicit_spawn_secondsJupyterHub.init_spawners_timeoutJupyterHub.internal_certs_locationJupyterHub.internal_sslJupyterHub.ipJupyterHub.jinja_environment_optionsJupyterHub.last_activity_intervalJupyterHub.load_groupsJupyterHub.load_rolesJupyterHub.log_datefmtJupyterHub.log_formatJupyterHub.log_levelJupyterHub.logging_configJupyterHub.logo_fileJupyterHub.named_server_limit_per_userJupyterHub.oauth_token_expires_inJupyterHub.pid_fileJupyterHub.portJupyterHub.proxy_api_ipJupyterHub.proxy_api_portJupyterHub.proxy_auth_tokenJupyterHub.proxy_check_intervalJupyterHub.proxy_classJupyterHub.proxy_cmdJupyterHub.recreate_internal_certsJupyterHub.redirect_to_serverJupyterHub.reset_dbJupyterHub.service_check_intervalJupyterHub.service_tokensJupyterHub.servicesJupyterHub.show_configJupyterHub.show_config_jsonJupyterHub.shutdown_on_logoutJupyterHub.spawner_classJupyterHub.ssl_certJupyterHub.ssl_keyJupyterHub.statsd_hostJupyterHub.statsd_portJupyterHub.statsd_prefixJupyterHub.subdomain_hostJupyterHub.template_pathsJupyterHub.template_varsJupyterHub.tornado_settingsJupyterHub.trust_user_provided_tokensJupyterHub.trusted_alt_namesJupyterHub.trusted_downstream_ipsJupyterHub.upgrade_dbJupyterHub.use_legacy_stopped_server_status_codeJupyterHub.user_redirect_hook
- Module:
- Authenticators
- Module:
jupyterhub.authAuthenticatorAuthenticatorAuthenticator.add_user()Authenticator.admin_usersAuthenticator.allowed_usersAuthenticator.auth_refresh_ageAuthenticator.authenticate()Authenticator.auto_loginAuthenticator.auto_login_oauth2_authorizeAuthenticator.blocked_usersAuthenticator.check_allowed()Authenticator.check_blocked_users()Authenticator.custom_htmlAuthenticator.delete_invalid_usersAuthenticator.delete_user()Authenticator.enable_auth_stateAuthenticator.get_authenticated_user()Authenticator.get_custom_html()Authenticator.get_handlers()Authenticator.is_admin()Authenticator.login_serviceAuthenticator.login_url()Authenticator.logout_url()Authenticator.manage_groupsAuthenticator.normalize_username()Authenticator.post_auth_hookAuthenticator.post_spawn_stop()Authenticator.pre_spawn_start()Authenticator.refresh_pre_spawnAuthenticator.refresh_user()Authenticator.run_post_auth_hook()Authenticator.username_mapAuthenticator.username_patternAuthenticator.username_regexAuthenticator.validate_username()Authenticator.whitelist
LocalAuthenticatorLocalAuthenticatorLocalAuthenticator.add_system_user()LocalAuthenticator.add_user()LocalAuthenticator.add_user_cmdLocalAuthenticator.admin_usersLocalAuthenticator.allowed_groupsLocalAuthenticator.allowed_usersLocalAuthenticator.auth_refresh_ageLocalAuthenticator.auto_loginLocalAuthenticator.auto_login_oauth2_authorizeLocalAuthenticator.blocked_usersLocalAuthenticator.check_allowed()LocalAuthenticator.check_allowed_groups()LocalAuthenticator.create_system_usersLocalAuthenticator.delete_invalid_usersLocalAuthenticator.enable_auth_stateLocalAuthenticator.group_whitelistLocalAuthenticator.manage_groupsLocalAuthenticator.post_auth_hookLocalAuthenticator.refresh_pre_spawnLocalAuthenticator.system_user_exists()LocalAuthenticator.uidsLocalAuthenticator.username_mapLocalAuthenticator.username_patternLocalAuthenticator.whitelist
PAMAuthenticatorPAMAuthenticatorPAMAuthenticator.add_user_cmdPAMAuthenticator.admin_groupsPAMAuthenticator.admin_usersPAMAuthenticator.allowed_groupsPAMAuthenticator.allowed_usersPAMAuthenticator.auth_refresh_agePAMAuthenticator.auto_loginPAMAuthenticator.auto_login_oauth2_authorizePAMAuthenticator.blocked_usersPAMAuthenticator.check_accountPAMAuthenticator.create_system_usersPAMAuthenticator.delete_invalid_usersPAMAuthenticator.enable_auth_statePAMAuthenticator.encodingPAMAuthenticator.group_whitelistPAMAuthenticator.manage_groupsPAMAuthenticator.open_sessionsPAMAuthenticator.pam_normalize_usernamePAMAuthenticator.post_auth_hookPAMAuthenticator.refresh_pre_spawnPAMAuthenticator.servicePAMAuthenticator.uidsPAMAuthenticator.username_mapPAMAuthenticator.username_patternPAMAuthenticator.whitelist
DummyAuthenticatorDummyAuthenticatorDummyAuthenticator.admin_usersDummyAuthenticator.allowed_usersDummyAuthenticator.auth_refresh_ageDummyAuthenticator.auto_loginDummyAuthenticator.auto_login_oauth2_authorizeDummyAuthenticator.blocked_usersDummyAuthenticator.delete_invalid_usersDummyAuthenticator.enable_auth_stateDummyAuthenticator.manage_groupsDummyAuthenticator.passwordDummyAuthenticator.post_auth_hookDummyAuthenticator.refresh_pre_spawnDummyAuthenticator.username_mapDummyAuthenticator.username_patternDummyAuthenticator.whitelist
- Module:
- Spawners
- Module:
jupyterhub.spawnerSpawnerSpawnerSpawner.argsSpawner.auth_state_hookSpawner.cmdSpawner.consecutive_failure_limitSpawner.cpu_guaranteeSpawner.cpu_limitSpawner.create_certs()Spawner.debugSpawner.default_urlSpawner.disable_user_configSpawner.env_keepSpawner.environmentSpawner.format_string()Spawner.get_args()Spawner.get_env()Spawner.get_state()Spawner.http_timeoutSpawner.hub_connect_urlSpawner.ipSpawner.mem_guaranteeSpawner.mem_limitSpawner.move_certs()Spawner.notebook_dirSpawner.oauth_rolesSpawner.options_formSpawner.options_from_formSpawner.poll()Spawner.poll_intervalSpawner.portSpawner.post_stop_hookSpawner.pre_spawn_hookSpawner.ssl_alt_namesSpawner.ssl_alt_names_include_localSpawner.start()Spawner.start_timeoutSpawner.stop()Spawner.template_namespace()
LocalProcessSpawnerLocalProcessSpawnerLocalProcessSpawner.argsLocalProcessSpawner.auth_state_hookLocalProcessSpawner.cmdLocalProcessSpawner.consecutive_failure_limitLocalProcessSpawner.cpu_guaranteeLocalProcessSpawner.cpu_limitLocalProcessSpawner.debugLocalProcessSpawner.default_urlLocalProcessSpawner.disable_user_configLocalProcessSpawner.env_keepLocalProcessSpawner.environmentLocalProcessSpawner.http_timeoutLocalProcessSpawner.hub_connect_urlLocalProcessSpawner.interrupt_timeoutLocalProcessSpawner.ipLocalProcessSpawner.kill_timeoutLocalProcessSpawner.mem_guaranteeLocalProcessSpawner.mem_limitLocalProcessSpawner.notebook_dirLocalProcessSpawner.oauth_rolesLocalProcessSpawner.options_formLocalProcessSpawner.options_from_formLocalProcessSpawner.poll_intervalLocalProcessSpawner.popen_kwargsLocalProcessSpawner.portLocalProcessSpawner.post_stop_hookLocalProcessSpawner.pre_spawn_hookLocalProcessSpawner.shell_cmdLocalProcessSpawner.ssl_alt_namesLocalProcessSpawner.ssl_alt_names_include_localLocalProcessSpawner.start_timeoutLocalProcessSpawner.term_timeout
- Module:
- Proxies
- Module:
jupyterhub.proxyProxyProxyProxy.add_all_services()Proxy.add_all_users()Proxy.add_hub_route()Proxy.add_route()Proxy.add_service()Proxy.add_user()Proxy.check_routes()Proxy.delete_route()Proxy.delete_service()Proxy.delete_user()Proxy.extra_routesProxy.get_all_routes()Proxy.get_route()Proxy.should_startProxy.start()Proxy.stop()Proxy.validate_routespec()
ConfigurableHTTPProxyConfigurableHTTPProxyConfigurableHTTPProxy.api_urlConfigurableHTTPProxy.auth_tokenConfigurableHTTPProxy.check_running_intervalConfigurableHTTPProxy.commandConfigurableHTTPProxy.concurrencyConfigurableHTTPProxy.debugConfigurableHTTPProxy.extra_routesConfigurableHTTPProxy.pid_fileConfigurableHTTPProxy.should_start
- Module:
- Users
- Services
- Services Authentication
- Module:
jupyterhub.services.authHubAuthHubAuthHubAuth.api_tokenHubAuth.api_urlHubAuth.base_urlHubAuth.cache_max_ageHubAuth.certfileHubAuth.check_scopes()HubAuth.client_caHubAuth.cookie_cache_max_ageHubAuth.cookie_optionsHubAuth.get_session_id()HubAuth.get_token()HubAuth.get_user()HubAuth.hub_hostHubAuth.hub_prefixHubAuth.keyfileHubAuth.login_urlHubAuth.oauth_scopesHubAuth.user_for_cookie()HubAuth.user_for_token()
HubOAuthHubOAuthHubOAuth.api_tokenHubOAuth.api_urlHubOAuth.base_urlHubOAuth.cache_max_ageHubOAuth.certfileHubOAuth.clear_cookie()HubOAuth.client_caHubOAuth.cookie_nameHubOAuth.cookie_optionsHubOAuth.generate_state()HubOAuth.get_next_url()HubOAuth.get_state_cookie_name()HubOAuth.hub_hostHubOAuth.hub_prefixHubOAuth.keyfileHubOAuth.login_urlHubOAuth.oauth_authorization_urlHubOAuth.oauth_client_idHubOAuth.oauth_redirect_uriHubOAuth.oauth_scopesHubOAuth.oauth_token_urlHubOAuth.set_cookie()HubOAuth.set_state_cookie()HubOAuth.state_cookie_nameHubOAuth.token_for_code()
HubAuthenticatedHubOAuthenticatedHubOAuthCallbackHandler
- Module: