Nhost system API
System operations including health checks, service version, and public key endpoints
Nhost system API is one of 14 APIs that Nhost publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include system. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 4 operations across 3 paths, and defines 4 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.
Requests are made against a single base URL, https://{subdomain}.auth.{region}.nhost.run/v1.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Nhost system API declares
2 security schemes
for authenticating requests.
It accepts HTTP bearer tokens (BearerAuth).
It accepts HTTP bearer tokens (BearerAuthElevated).
BearerAuth— Bearer authentication with JWT access token. Used to authenticate requests to protected endpoints.BearerAuthElevated— Bearer authentication that requires elevated permissions. Used for sensitive operations that may require additional security measures such as recent authentica…
Paths & Operations 4
Across 3 paths, the API surfaces 4 operations — 3 GET, 1 HEAD. Each is listed below with its method, path, parameters, and response codes.
System operations including health checks, service version, and public key endpoints
Schemas 4
The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are JWK (6 properties), ErrorResponse (3 properties), JWKSet (1 property). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Nhost 12
Other APIs Nhost publishes across the network.