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.
openapi: 3.2.0
info:
title: Hasura Engine HTTP APIs Graphql V1beta1 API
description: 'Hasura GraphQL Engine exposes a small set of HTTP APIs in addition to its
GraphQL endpoint. This specification documents the most commonly used
endpoints: GraphQL queries/mutations/subscriptions, Relay GraphQL, the
Metadata API, the Schema API, the PG Dump API, the Explain API, the
Health Check API, the Source Health Check API, the Config API, and the
Version API.
Authentication: When the engine is started with HASURA_GRAPHQL_ADMIN_SECRET,
requests must include the `x-hasura-admin-secret` header (or a valid JWT).
Roles and session variables are passed via `x-hasura-role` and any
`x-hasura-*` session headers.
'
version: 2.0.0
contact:
name: Hasura
url: https://hasura.io/docs/2.0/api-reference/overview/
servers:
- url: https://my-graphql-engine.example.com
description: Self-hosted Hasura GraphQL Engine
security:
- adminSecret: []
- bearerAuth: []
tags:
- name: V1beta1
paths:
/v1beta1/relay:
post:
summary: Execute a Relay-compatible GraphQL operation
operationId: relayGraphql
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/GraphQLRequest'
responses:
'200':
description: GraphQL response.
content:
application/json:
schema:
$ref: '#/components/schemas/GraphQLResponse'
tags:
- V1beta1
components:
schemas:
GraphQLResponse:
type: object
properties:
data:
type: object
additionalProperties: true
errors:
type: array
items:
type: object
additionalProperties: true
extensions:
type: object
additionalProperties: true
GraphQLRequest:
type: object
required:
- query
properties:
query:
type: string
description: The GraphQL query string.
operationName:
type: string
description: Name of the operation to execute, if multiple are provided.
variables:
type: object
description: Variables for the GraphQL operation.
additionalProperties: true
securitySchemes:
adminSecret:
type: apiKey
in: header
name: x-hasura-admin-secret
description: Admin secret configured via HASURA_GRAPHQL_ADMIN_SECRET.
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
description: JWT token, when JWT authentication is configured.