Proxy a GraphQL query or mutation
POST
/api/graphql/{path}
const url = 'https://example.com/api/graphql/example';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"query":"example","variables":{},"operationName":"example"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://example.com/api/graphql/example \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "query": "example", "variables": {}, "operationName": "example" }'Proxies a POST request (GraphQL query/mutation) to the backend GraphQL server for the given repository path.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”path
required
GraphQL backend path (typically the repository CACHE_ROOT)
string
Request Body
Section titled “Request Body”Media typeapplication/json
object
query
required
GraphQL query or mutation
string
variables
GraphQL variables
object
operationName
Operation name
string
Examplegenerated
{ "query": "example", "variables": {}, "operationName": "example"}Responses
Section titled “Responses”Proxied GraphQL response
Media typeapplication/json
object
Examplegenerated
{}