Using your GraphQL API

This is the documentation of the GraphQL Library version 7. For the long-term support (LTS) version 5, refer to GraphQL Library version 5 LTS.

Querying your GraphQL API

When the status for the GraphQL API is "Ready" you can send GraphQL requests to it. As all requests are subject to authentication, you must include an API key or JWT token.

With an API key authentication provider

Add x-api-key: YOUR_API_KEY to the header of the request. For example, with cURL:

curl --location <YOUR_GRAPHQL_API_URL> --header 'Content-Type: application/json' --header 'x-api-key: <YOUR_API_KEY>' --data '<YOUR_GRAPHQL_QUERY>'

With a JWKS authentication provider

Obtain a JWT from your identity provider. Using the JWT, add Authorization: Bearer <YOUR_JWT> to the headers of the request.

For example, with cURL:

curl --location <YOUR_GRAPHQL_API_URL> --header 'Authorization: Bearer <YOUR_JWT>'--header 'Content-Type: application/json --data '<YOUR_GRAPHQL_QUERY>'