Authorization

You must go through authorization before using any of the backup management APIs. To do so, you must go through basic authentication.

Basic authentication is one of the methods used for authorization, where you provide a username and password with their request to prove their identity.

However, for enhanced security, we encourage the use of API tokens instead of passwords for basic authentication. An API token acts as a secure alternative to using your password for accessing Atlassian APIs. Learn more about basic auth for REST APIs

To create an API token in Atlassian:

1. Log in to https://id.atlassian.com/manage-profile/security/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 store the token safely.

It's crucial to keep your API token confidential and treat it as securely as you would your password. For more detailed guidance, see this article: Manage API tokens for your Atlassian account

Once you have the API token, you can pass the API token in two ways.

Option 1

You can pass the request by sending your API token by passing a --user argument in your curl command.

1
2
curl --location '<REQUEST_URL>' \
--header 'Content-Type: application/json' \
--user 'useremail:<YOUR_API_TOKEN>' \

Option 2

Alternatively, you can build a string of the form useremail:<YOUR_API_TOKEN>.

1. Encode the string in base 64.

• Linux/Unix/MacOS:

  1
  2
    echo -n user@example.com:api_token_string | base64
  

• Windows 7 and later, using Powershell:

  1
  2
  $Text = ‘user@example.com:api_token_string’
  $Bytes = [System.Text.Encoding]::UTF8.GetBytes($Text)
  $EncodedText = [Convert]::ToBase64String($Bytes)
  $EncodedText
  

2. Supply an Authorization header with content Basic followed by the base 64-encoded string.

1
2
  curl --location '<REQUEST_URL>' \
  --header "Content-Type: application/json" \
  -header "Authorization: Basic <BASE64_ENCODED_STRING>" \