Skip to main content
Version: v2.x

Metadata API Reference: 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"
]
}
}

Args syntax

KeyRequiredSchemaDescription
disabled_for_rolestrueArray of RoleNameRoles for which GraphQL schema introspection should be disabled (supported only in cloud/enterprise versions)