Create an admin API key

On this page

Still need help?

The Atlassian Community is here for you.

Ask the community

API keys allow you to manage your organization via the admin APIs. You can update organization settings with the organizations REST API and manage user accounts with the user management REST API. To make requests to the API with the client of your choice, create an API key.

For security reasons, API keys expire 7 days after creation. To keep making requests after a key expires, create another API key and replace it with your old one.

To create an API key:

  1. From your organization at admin.atlassian.com, select Settings and then API keys.

  2. Click Create API key in the top right.

  3. Enter a name that you’ll remember to identify the API key

  4. By default, the key expires one week from today. If you’d like to change the expiration date, pick a new date under Expires on. You’re unable to select a date longer than a year from the date of creation.

  5. Click Create to save the API key.

  6. Copy the values for your Organization ID and API key. You'll need those to access your organization later.

    Make sure you store these values in a safe place, as we won't show them to you again.

  7. Click Done and you’ll see the key in your list of API keys.

To revoke an API key, click Revoke next to the API key.

Revoking an API key is permanent. It may take up to 10 minutes for a revoked key to stop working.

Last modified on Sep 18, 2019

Was this helpful?

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