Metadata API Reference: GraphQL Introspection Options¶

Table of contents

Introduction
set_graphql_introspection_options

Introduction¶

API to set GraphQL introspection options. One of the options is to disable introspection for the specified roles.

set_graphql_introspection_options¶

set_graphql_schema_introspection_options is used to set graphql introspection options. Calling this API will replace existing (if any) introspection options.

This API can be used to disable graphql introspection for the specified roles.

POST /v1/metadata HTTP/1.1
Content-Type: application/json
X-Hasura-Role: admin

{
    "type": "set_graphql_schema_introspection_options",
    "args": {
        "disabled_for_roles": [
            "guest",
            "public"
        ]
    }
}

Key	Required	Schema	Description
disabled_for_roles	true	Array of RoleName	Roles for which GraphQL schema introspection should be disabled (supported only in cloud/enterprise versions)

« 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