Edit on GitHub

Config API Reference¶

Table of contents

Introduction
Endpoint
API Spec
Disabling Config API

Introduction¶

The Config API is an admin only endpoint which gives info on the server configuration.

Endpoint¶

All requests are GET requests to the /v1alpha1/config endpoint.

API Spec¶

Request¶

GET /v1alpha1/config HTTP/1.1
X-Hasura-Role: admin

Sample response¶

HTTP/1.1 200 OK
Content-Type: application/json

{
  "version": "v1.0.0-beta.3",
  "is_function_permissions_inferred": true,
  "is_remote_schema_permissions_enabled": false,
  "is_admin_secret_set": true,
  "is_auth_hook_set": false,
  "is_jwt_set": true,
  "jwt": {
    "claims_namespace": "https://hasura.io/jwt/claims",
    "claims_format": "json"
  },
  "is_allow_list_enabled": false,
  "live_queries": {
    "batch_size": 100,
    "refetch_delay": 1
  }
}

Disabling Config API¶

The enabled-apis flag or the HASURA_GRAPHQL_ENABLED_APIS env var can be used to enable/disable this API. By default, this API is enabled. To disable it, you need to explicitly state that this API is not enabled. i.e. remove it from the list of enabled APIs.

# enable only graphql & metadata apis, disable config
--enabled-apis="graphql,metadata"
HASURA_GRAPHQL_ENABLED_APIS="graphql,metadata"

See GraphQL Engine server config reference for info on setting the above flag/env var.

« previous | next »

Want to contribute or report missing content?

edit this page on github | contributing guidelines | report an issue

Hasura GraphQL engine is open source. See license