/
How to Generate an Atlassian API Key

How to Generate an Atlassian API Key

Use this guide to create an Atlassian API key for tools, scripts, or integrations that need to access Atlassian Cloud services on your behalf. API keys are commonly used for authenticated requests and can help you connect Jira, Confluence, and other Atlassian products to external applications more securely than using your main password.

An Atlassian API key grants access tied to your Atlassian account. Treat it like a password: store it securely, share it only through approved secret-management tools, and rotate it if you believe it has been exposed.

Before you begin

  • You need an active Atlassian account.

  • You must be able to sign in to your Atlassian account settings.

  • You should know which application, script, or integration will use the key.

  • You should have a secure place ready to store the key, such as a password manager or secrets vault.

Instructions

  1. Sign in to your Atlassian account via Orange Tracker or Answers.

  2. From your avatar in the top-right, go to your Atlassian Account Settings.

  3. Select the Security tab.

  4. Under API tokens, select Create and manage API tokens.

  5. Select either Create API token or Create API token with scopes.
    Scoped API tokens are greatly more secure than non-scoped ones as the owner controls what actions and data the token has access to.

  6. Set the Name and Expiration of the token.
    When prompted, enter a clear label that explains what the key will be used for, such as Jira reporting script or Confluence integration. Also note that there is a max lifetime of 365 days for an API token.

  7. If using a Scoped API token, follow through the rest of the prompts and set data/action access.

  8. Select Create.

  9. Copy the key and store it immediately.
    After the key is generated, copy it right away and save it in an approved secure location. In most cases, you will not be able to view the full key again later.

  10. Use the key in your integration.
    Paste the key into the application, script, or connector that requested it. Follow that tool’s authentication instructions to complete setup and test the connection.

Use a unique label for each API key so you can quickly identify and revoke a single key without affecting other integrations.

Best practices

  • Create one key per use case so access can be managed cleanly.

  • Do not send keys over chat or email unless your organization explicitly approves a secure method.

  • Rotate keys periodically for long-running integrations.

  • Revoke unused keys to reduce risk.

  • Document ownership so teams know who is responsible for each integration key.

Troubleshooting

  • The key does not work: Confirm you copied the full value and that the integration expects an Atlassian API key rather than another authentication method.

  • You cannot find the API key option: Make sure you are in your Atlassian account security settings and signed in with the correct account.

  • You lost the key after creation: Generate a new one and replace the old credential in the integration.

  • You suspect the key was exposed: Revoke it immediately and create a replacement.

If an API key is used in automation, update all dependent systems before revoking the old key to avoid service interruptions.

Table of Contents

Space Tree