API Reference

Available APIs

API Endpoint Access
GraphQL /v1/graphql Permission rules
Relay /v1beta1/relay Permission rules
Legacy GraphQL /v1alpha1/graphql Permission rules
Schema (> v2.0) /v2/query Admin only
Metadata (> v2.0) /v1/metadata Admin only
Schema/Metadata (< v1.3) /v1/query Admin only
Restified GQL /api/rest GQL REST Routes
Version /v1/version Public
Health /healthz Public
PG Dump /v1alpha1/pg_dump Admin only
Config /v1alpha1/config Admin only
Explain /v1/graphql/explain Admin only

GraphQL API

All GraphQL requests for queries, subscriptions and mutations are made to the GraphQL API.

See details at GraphQL API Reference.

Relay API

Hasura exposes a Relay schema for GraphQL requests for queries, subscriptions and mutations.

See docs at Postgres: Relay schema.

See details at Relay GraphQL API Reference.

Schema API (v2.0 and above)

Hasura exposes a schema API for directly executing SQL on the underlying Postgres.

This is primarily intended to be used as an admin API to manage the Hasura schema.

See details at Schema API Reference (v2.0 and above).

Metadata API (v2.0 and above)

Hasura exposes a metadata API for managing metadata.

This is primarily intended to be used as an admin API to manage the Hasura metadata.

See details at Metadata API Reference (v2.0 and above).

Schema / metadata API (v1.3 and below)

Hasura exposes a schema / metadata API for managing metadata for permissions/relationships or for directly executing SQL on the underlying Postgres.

This is primarily intended to be used as an admin API to manage the Hasura schema and metadata.

See details at Schema / Metadata API Reference .

RESTified GraphQL API

Hasura allows saved GraphQL queries and mutations to be accesed through a REST interface.

See details at RESTified GraphQL Endpoints API Reference.

Version API

The /v1/version is a public endpoint that responds with the current server version in JSON format.

See details at Version API Reference.

Health check API

The /healthz is a public endpoint that returns the server health status. There’s also /hasura/healthz available as an alternative, which mirrors /healthz completely.

See details at Health check API Reference.

pg_dump API

The /v1alpha1/pg_dump is an admin-only endpoint that can be used to execute pg_dump on the Postgres instance connected to Hasura. The pg_dump CLI tool’s argument can be passed as a POST request body to the API and the response is sent back to the client.

See details at PG Dump API Reference.

Config API

v1alpha1/config is an admin-only endpoint to get the current server configuration.

See details at Config API Reference.

Explain API

v1/graphql/explain returns the Postgres plan for a query or subscription based on the defined permissions.

See details at Explain API Reference.