Last updated Jul 8, 2025

Build your ARI

All entities in the GraphQL Gateway should be queried using their ARIs. An ARI is an Atlassian resource identifier that acts as one single entry point, and thus needs to have routing information to know which tenant to go to. Some common ARIs you may need are:

  • Workspace ARI: ari:cloud:beacon:{cloudId}:workspace/{workspaceId}
  • Alert ARI: ari:cloud:beacon:{cloudId}:alert/{workspaceId}/{alertId}

Use the following table to learn the differences between your Atlassian IDs. This page also has instructions on how to assemble or retrieve your ARI.

Understand your Atlassian IDs

ID typeDescriptionURL location
Org ID

The ID for your central place for managing your users and apps.

This isn’t needed in the ARI, but you can use it to use GraphQL to build sections of your ARI.

Example: 2949a768-1846-16jb-k194-88cd7jc56055

Look for the string after /o/ in your URL.
Cloud ID

The ID for your specific Atlassian domain, such as your-company.atlassian.com.

Example: 1a11d016-8984-4c3e-b9ab-142dd06acb1b

Look for the string after /s/ in your URL.
Workspace ID

The ID for a specific app instance, such as your Guard Detect workspace, or a Confluence site.

Example: 84d8e33f-139b-4ca4-b5cd-586a5d858a2f

Look for the string after /w/ in your URL.
Alert ID

The ID for a specific alert within Guard Detect.

Example: 67f42cd4f6e5bb72e88ae028

Look for the string after /alerts/ in your URL.

Find your IDs manually

Org ID

  1. Navigate to admin.atlassian.com. If you're a member of more than one, select the relevant organization.
  2. The org ID is listed after /o/ in your address bar.

Workspace ID

  1. Navigate to Guard Detect.
  2. The workspace ID is listed after the /w/ in your address bar.

Cloud ID

  1. Navigate to admin.atlassian.com. If you're a member of more than one, select the relevant organization.
  2. Select the Apps tab.
  3. Find the relevant site at the bottom of the left panel and click on it.
  4. The cloud ID is listed after /s/ in your address bar.

Alert ID

  1. Navigate to Guard Detect.
  2. Find the relevant alert and click on it.
  3. The alert ID is listed after /alerts/ in your address bar.

Use GraphQL to find sections of your ARI

Your alert ID is the most variable part of your ARI, and it’s easy to find from your alert in Guard Detect. Your workspace ID and cloud ID are more static, so you can use GraphQL to build these parts of your ARI, then manually add an individual alert ID to complete your ARI.

Get your cloud ID

You can find your cloud ID through a GraphQL query. In the API explorer, paste this code into the main query window:

1
2
query getCloudIdByActivationId($workspaceId: ID!) {
  tenantContexts(activationIds: [$workspaceId]) {
    cloudId
    __typename
  }
}

Note that ActivationId and workspaceId refer to the same string.

Variables:

1
2
{ "workspaceId": "your-workspace-id-here" }

Sample response:

1
2
{
  "tenantContexts": [
    {
      "cloudId": "0626c985-4528-48ad-b462-55ef9ae78377",
      "__typename": "TenantContext"
    }
  ]
}

Get your workspace ARI (cloud ID and workspace ID)

You can use a query to return the Guard Detect workspace ARI. This contains your cloud ID and your workspace ID.

In the API explorer, paste this code into the main query window:

1
2
query getWorkspaceByOrg($orgId: ID!) {
  shepherd {
    workspaceByOrgId(orgId: $orgId) {
      ari
    }
  }
}

Variables:

1
2
{ "orgId": "2949a768-1846-16jb-k194-88cd7jc56055" }

Sample response

1
2
{
  "data": {
    "shepherd": {
      "workspaceByOrgId": {
        "ari": "ari:cloud:beacon:0626c985-4528-48ad-b462-55ef9ae78377:workspace/6ab72b68-f091-4793-885a-2babf02aebf5"
      }
    }
  }
}

Assemble your alert ARI

To assemble your alert ARI, use the relevant cloud ID, workspace ID and alert ID with the following syntax:

1
2
ari:cloud:beacon:<your-cloud-ID>:alert/<your-workspace-ID>/<an-alert-ID>

For example:

1
2
ari:cloud:beacon:0626c985-4528-48ad-b462-55ef9ae78377:alert/67f42cd4f6e5bb72e88ae028/6ab72b68-f091-4793-885a-2babf02aebf5

Rate this page: