graphql

GraphQL query/mutation

Execute a GraphQL operation. Accepts the standard GraphQL request envelope (query, optional variables, operationName, extensions). Authentication is optional: an admin secret grants admin role; a valid JWT bearer grants the user's role; anonymous requests are served with the public role.

post/v1/graphql

Request

  • Base URL
    / (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /v1/graphql
  • Auth
    • API key in header X-Hasura-Admin-Secret
    • or HTTP bearer
    • or none

Request body

querystring required

GraphQL document text

operationNamestring nullable

Operation to execute when the document defines more than one

variablesobject nullable

Variable bindings referenced by the document

extensionsobject nullable

Protocol extensions (persisted queries, tracing toggles, ...)

Response

GraphQL response envelope (may carry partial data + errors)

dataunknown
extensionsobject

Protocol extensions (tracing, persisted-query acks, ...)

Changes

No recorded changes to this operation across all 1 revision of this API.