API tokens

You can use an API token to authenticate a script or other process with an Atlassian cloud product. You generate the token from your Atlassian account, then copy and paste it to the script.

If you use two-step verification to authenticate, your script will need to use a REST API token to authenticate.

API tokens can be used with the Jira Cloud and Confluence Cloud REST APIs.

If you're using Bitbucket Cloud, see App passwords.

Create an API token

Create an API token from your Atlassian account:

  1. Log in to https://id.atlassian.com/manage/api-tokens.
  2. Click Create API token.
  3. From the dialog that appears, enter a memorable and concise Label for your token and click Create.
  4. Click Copy to clipboard, then paste the token to your script, or elsewhere to save:

Note:

  • For security reasons it isn't possible to view the token after closing the creation dialog; if necessary, create a new token.
  • You should store the token securely, just as for any password.

    Use an API token

    A primary use case for API tokens is to allow scripts to access REST APIs for Atlassian cloud products using HTTP basic authentication.

    Depending on the details of the HTTP library you use, simply replace your password with the token. For example, when using curl, you could do something like this:

    curl -v https://mysite.atlassian.net --user me@example.com:my-api-token

    Note that me@example.com here is the email address for the Atlassian account you're using to create the token.


Last modified on Nov 9, 2019

Was this helpful?

Yes
No
Provide feedback about this article
Powered by Confluence and Scroll Viewport.