Nhost system API
System operations including health checks, service version, and public key endpoints
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/nhost-system-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Nhost System API
version: 1.0.0
contact:
name: Nhost Support
email: support@nhost.io
url: https://nhost.io
description: 'Operations tagged system across 2 of this provider''s published API definitions: nhost-authentication-openapi.yml, nhost-storage-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://{subdomain}.auth.{region}.nhost.run/v1
description: Nhost Authentication API Server
- url: https://{subdomain}.storage.{region}.nhost.run/v1
description: Nhost Storage API Server
tags:
- name: system
description: System operations including health checks, service version, and public key endpoints
paths:
/.well-known/jwks.json:
get:
summary: Get public keys for JWT verification in JWK Set format
description: Retrieve the JSON Web Key Set (JWKS) containing public keys used to verify JWT signatures. This endpoint is used by clients to validate access tokens.
operationId: getJWKs
tags:
- system
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/JWKSet'
description: The public keys in JWK Set format
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: An error occurred while processing the request
servers:
- url: https://{subdomain}.auth.{region}.nhost.run/v1
description: Nhost Authentication API Server
/healthz:
get:
summary: Health check (GET)
description: Verify if the authentication service is operational using GET method
operationId: healthCheckGet
tags:
- system
responses:
'200':
description: Service is healthy and operational
content:
application/json:
schema:
$ref: '#/components/schemas/OKResponse'
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: An error occurred while processing the request
head:
summary: Health check (HEAD)
description: Verify if the authentication service is operational using HEAD method
operationId: healthCheckHead
tags:
- system
responses:
'200':
description: Service is healthy and operational
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: An error occurred while processing the request
servers:
- url: https://{subdomain}.auth.{region}.nhost.run/v1
description: Nhost Authentication API Server
/version:
get:
summary: Get service version
description: Retrieve version information about the authentication service
operationId: getVersion
tags:
- system
responses:
'200':
description: Version information successfully retrieved
content:
application/json:
schema:
type: object
additionalProperties: false
properties:
version:
type: string
description: The version of the authentication service
example: 1.2.3
required:
- version
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: An error occurred while processing the request
servers:
- url: https://{subdomain}.auth.{region}.nhost.run/v1
description: Nhost Authentication API Server
components:
schemas:
JWK:
type: object
description: JSON Web Key for JWT verification
additionalProperties: false
properties:
alg:
type: string
description: Algorithm used with this key
example: RS256
e:
type: string
description: RSA public exponent
example: AQAB
kid:
type: string
description: Key ID
example: key-id-1
kty:
type: string
description: Key type
example: RSA
n:
type: string
description: RSA modulus
example: abcd1234...
use:
type: string
description: Key usage
example: sig
required:
- alg
- e
- kid
- kty
- n
- use
JWKSet:
type: object
description: JSON Web Key Set for verifying JWT signatures
additionalProperties: false
properties:
keys:
type: array
description: Array of public keys
items:
$ref: '#/components/schemas/JWK'
required:
- keys
ErrorResponse:
type: object
description: Standardized error response
additionalProperties: false
properties:
status:
description: HTTP status error code
type: integer
example: 400
message:
description: Human-friendly error message
type: string
example: Invalid email format
error:
description: Error code identifying the specific application error
type: string
enum:
- default-role-must-be-in-allowed-roles
- disabled-endpoint
- disabled-user
- email-already-in-use
- email-already-verified
- forbidden-anonymous
- internal-server-error
- invalid-email-password
- invalid-request
- locale-not-allowed
- password-too-short
- password-in-hibp-database
- redirectTo-not-allowed
- role-not-allowed
- signup-disabled
- unverified-user
- user-not-anonymous
- invalid-pat
- invalid-refresh-token
- invalid-ticket
- disabled-mfa-totp
- no-totp-secret
- invalid-totp
- mfa-type-not-found
- totp-already-active
- invalid-state
- oauth-token-echange-failed
- oauth-profile-fetch-failed
- oauth-provider-error
- invalid-otp
- cannot-send-sms
required:
- status
- message
- error
OKResponse:
type: string
additionalProperties: false
enum:
- OK
ErrorResponse_2:
type: object
description: Error information returned by the API.
properties:
error:
type: object
additionalProperties: false
description: Error details.
properties:
message:
type: string
description: Human-readable error message.
example: File not found
data:
type: object
additionalProperties: true
description: Additional data related to the error, if any.
required:
- message
additionalProperties: false
VersionInformation:
type: object
description: Contains version information about the storage service.
additionalProperties: false
properties:
buildVersion:
type: string
description: The version number of the storage service build.
example: 1.2.3
required:
- buildVersion
securitySchemes:
BearerAuth:
type: http
scheme: bearer
description: Bearer authentication with JWT access token. Used to authenticate requests to protected endpoints.
BearerAuthElevated:
type: http
scheme: bearer
description: Bearer authentication that requires elevated permissions. Used for sensitive operations that may require additional security measures such as recent authentication. For details see https://docs.nhost.io/guides/auth/elevated-permissions
Authorization:
type: http
scheme: bearer
bearerFormat: JWT
description: API key to authorize requests.
X-Hasura-Admin-Secret:
type: apiKey
name: X-Hasura-Admin-Secret
in: header
description: Hasura admin secret key for backend/administrative operations.
x-refined-from:
- nhost-authentication-openapi.yml
- nhost-storage-openapi.yml