Query Atlassian Cloud

Rely on cnquery to query and inventory your Atlassian Cloud resources, including Jira, Confluence, Admin, and SCIM configurations.

Requirements

To analyze your Atlassian Cloud environment with cnquery, you must have:

cnquery installed on your workstation.
An Atlassian Cloud account with appropriate access.
API tokens for the products you want to query.

Configure access to Atlassian

Atlassian Admin

To query Atlassian Admin, you need an admin API token:

cnquery shell atlassian admin --admin-token YOUR_ADMIN_TOKEN

You can also set the ATLASSIAN_ADMIN_TOKEN environment variable.

Jira

To query Jira, provide your host, user, and user token:

cnquery shell atlassian jira --host https://example.atlassian.net --user your@email.com --user-token YOUR_USER_TOKEN

You can also set these environment variables:

ATLASSIAN_HOST
ATLASSIAN_USER
ATLASSIAN_USER_TOKEN

Confluence

To query Confluence, provide your host, user, and user token:

cnquery shell atlassian confluence --host https://example.atlassian.net --user your@email.com --user-token YOUR_USER_TOKEN

SCIM

To query SCIM, provide your directory ID and SCIM token (provided when you set up an identity provider):

cnquery shell atlassian scim DIRECTORY_ID --scim-token YOUR_SCIM_TOKEN

Example queries

Jira queries

This query retrieves Jira project information:

cnquery> atlassian.jira.projects
atlassian.jira.projects: [
  0: atlassian.jira.project name="Engineering"
  1: atlassian.jira.project name="Support"
  ...
]

Confluence queries

This query retrieves Confluence spaces:

cnquery> atlassian.confluence.spaces
atlassian.confluence.spaces: [
  0: atlassian.confluence.space name="Documentation"
  ...
]

Admin queries

This query retrieves organization information:

cnquery> atlassian.admin.organizations
atlassian.admin.organizations: [
  0: atlassian.admin.organization name="My Company"
  ...
]

SCIM queries

This query retrieves SCIM users:

cnquery> atlassian.scim.users
atlassian.scim.users: [
  0: atlassian.scim.user name="John Doe"
  ...
]

Exit the cnquery shell

To exit the cnquery shell, either press Ctrl + D or type exit.

Learn more

To learn more about how the MQL query language works, read Write Effective MQL.
For a list of all the Atlassian resources and fields you can query, read the Atlassian Resource Pack Reference.

Query Atlassian Cloud

On this page