---
title: "POST /v1/{+name}:introspectGraphql"
method: POST
path: "/v1/{+name}:introspectGraphql"
tags: ["projects"]
---

# POST /v1/{+name}:introspectGraphql

`POST /v1/{+name}:introspectGraphql`

Execute introspection query against the Firebase SQL Connect's generated GraphQL schema. GraphQL introspection query provides metadata such as what tables the schema have, what queries and mutations can be performed on the schema, and so on. Read more at https://graphql.org/learn/introspection. IntrospectGraphql can read schema metadata but cannot read rows from Cloud SQL instance, which can be done via ExecuteGraphqlRead.

## Path parameters

- `name` string, required

## Request body

- GraphqlRequest — The GraphQL request to Firebase SQL Connect. It strives to match the GraphQL over HTTP spec. https://github.com/graphql/graphql-over-http/blob/main/spec/GraphQLOverHTTP.md#post
  - `query` string — Required. The GraphQL query document source.
  - `variables` object — Optional. Values for GraphQL variables provided in this request.
  - `extensions` GraphqlRequestExtensions — GraphqlRequestExtensions contains additional information of `GraphqlRequest`.
    - `impersonate` Impersonation — Impersonation configures the Firebase Auth context to impersonate.
      - `unauthenticated` boolean — Evaluate the auth policy as an unauthenticated request. Can only be set to true.
      - `authClaims` object — Evaluate the auth policy with a customized JWT auth token. Should follow the Firebase Auth token format. https://firebase.google.com/docs/rules/rules-and-auth For example: a verified user may have auth_claims of {"sub": , "email_verified": true}
      - `includeDebugDetails` boolean — Optional. If set, include debug details in GraphQL error extensions.
  - `operationName` string — Optional. The name of the GraphQL operation name. Required only if `query` contains multiple operations. See https://graphql.org/learn/queries/#operation-name.

## Response `200`

Successful response

---

[API](https://skmtc.net/google/apis/firebasedataconnect.md) · [All operations](https://skmtc.net/google/apis/firebasedataconnect/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/google/firebasedataconnect/revisions/dda665bc52bd/schema)