How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

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 6 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against 2 base URLs: https://{subdomain}.auth.{region}.nhost.run/v1, https://{subdomain}.storage.{region}.nhost.run/v1.

4 operations 3 paths 6 schemas 3 GET1 HEAD

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://{subdomain}.nhost.run/v1/graphql
Authentication
HTTP Bearer, HTTP Bearer, HTTP Bearer, API Key
Resource Areas
1

Authentication & Security 4

Nhost system API declares 4 security schemes for authenticating requests. It accepts HTTP bearer tokens (BearerAuth). It accepts HTTP bearer tokens (BearerAuthElevated). It accepts HTTP bearer tokens (JWT) (Authorization). An API key is passed in the header as X-Hasura-Admin-Secret (X-Hasura-Admin-Secret).

  • 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…
  • Authorization — API key to authorize requests.
  • X-Hasura-Admin-Secret — Hasura admin secret key for backend/administrative operations.

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 4

System operations including health checks, service version, and public key endpoints

GET
/.well-known/jwks.json
Get public keys for JWT verification in JWK Set format
getJWKs → 200default
GET
/healthz
Health check (GET)
healthCheckGet → 200default
HEAD
/healthz
Health check (HEAD)
healthCheckHead → 200default
GET
/version
Get service version
getVersion → 200default

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are JWK (6 properties), ErrorResponse (3 properties), VersionInformation (1 property), ErrorResponse_2 (1 property). Each schema is shown below with its type and property counts.

JWK
object
JSON Web Key for JWT verification
6 properties 6 required
JWKSet
object
JSON Web Key Set for verifying JWT signatures
1 property 1 required
ErrorResponse
object
Standardized error response
3 properties 3 required
OKResponse
string
ErrorResponse_2
object
Error information returned by the API.
1 property
VersionInformation
object
Contains version information about the storage service.
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nhost-system-api-openapi.yml Raw ↑

Other APIs Nhost publishes across the network.

Nhost GraphQL API
Nhost Serverless Functions API
Nhost AI API
Nhost authentication API
Nhost documentation API
Nhost excludeme API
Nhost files API
Nhost operations API
Nhost security API
Nhost session API
Nhost storage API
Nhost user API
Where this information came from

This is an independent, third-party profile of Nhost system API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.