Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Hasura Graphql API

The Graphql API from Hasura — 2 operation(s) for graphql.

Hasura Graphql API is one of 13 APIs that Hasura publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Graphql. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 2 operations across 2 paths, and defines 2 schemas. It is described by OpenAPI 3.1.0, at version 2.0.0.

Requests are made against a single base URL, https://my-graphql-engine.example.com.

2 operations 2 paths 2 schemas 2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2.0.0
Server
https://my-graphql-engine.example.com
Authentication
API Key, HTTP Bearer
Contact
Resource Areas
1

Authentication & Security 2

Hasura Graphql API declares 2 security schemes for authenticating requests. An API key is passed in the header as x-hasura-admin-secret (adminSecret). It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

  • adminSecret — Admin secret configured via HASURAGRAPHQLADMINSECRET.
  • bearerAuth — JWT token, when JWT authentication is configured.

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 2 POST. Each is listed below with its method, path, parameters, and response codes.

Graphql 2
POST
/v1/graphql
Execute a GraphQL query, mutation, or subscription
graphql body → 200
POST
/v1/graphql/explain
Explain a GraphQL query
explain body → 200

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are GraphQLResponse (3 properties), GraphQLRequest (3 properties). Each schema is shown below with its type and property counts.

GraphQLRequest
object
3 properties 1 required
GraphQLResponse
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hasura-graphql-api-openapi.yml Raw ↑

Other APIs Hasura publishes across the network.

Hasura Metadata API
Hasura DDN GraphQL API
Hasura Cloud API
PromptQL Natural Language API
Hasura Healthz API
Hasura Metadata API
Hasura Query API
Hasura Source Health API
Hasura V1alpha1 API
Hasura V1beta1 API
Hasura Version API