API Reference

Available APIs

API Endpoint Access
GraphQL /v1/graphql Permission rules
Relay /v1beta1/relay Permission rules
Legacy GraphQL /v1alpha1/graphql Permission rules
Schema/Metadata /v1/query Admin only
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


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 Relay schema.

See details at Relay GraphQL API Reference.

Schema / metadata API

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.

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.

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.

Supported PostgreSQL types

You can refer to the following to know about all PostgreSQL types supported by the Hasura GraphQL engine: