The Atlassian GraphQL API allows you to access all sorts of Atlassian data including Jira projects, Bitbucket repositories, Opsgenie teams, and cross-product work activities using one common mechanism through the Atlassian GraphQL Gateway. Use the /atlassian/graphql/{target} endpoint to proxy requests to the Atlassian GraphQL API.

Operations

POST/atlassian/graphql/

POST

Proxy POST request to Atlassian GraphQL API

Proxies POST requests to the Atlassian GraphQL API.

API Documentation: Atlassian GraphQL API

Examples:

Query Example:


1
2
3
{
  "query": "query GetProjects { projects { id name key } }"
}

Mutation Example:


1
2
3
4
5
6
7
8
9
10
{
  "query": "mutation CreateIssue($input: CreateIssueInput!) { createIssue(input: $input) { issue { id key summary } } }",
  "variables": {
    "input": {
      "projectId": "10001",
      "summary": "New issue from GraphQL",
      "description": "Issue description"
    }
  }
}

Forge and OAuth2 apps cannot access this REST resource.

Request

Header parameters

forge-proxy-authorization

string

Required

Content-Type

string

Request bodyapplication/json

Generic request body

object

Responses

Request successfully proxied to Atlassian GraphQL API

application/json

object

POST/atlassian/graphql/

curl

Node.js

Java

Python

PHP

curl --request POST \
  --url '{FORGE_EGRESS_PROXY_URL}/atlassian/graphql/' \
  --header 'Accept: application/json' \
  --header 'forge-proxy-authorization: Forge as=app,id=invocation-123' \
  --header 'Content-Type: application/json' \
  --data '{}'