Last updated Jan 25, 2024

Check the status and results

After you schedule a job to update links, you’ll receive its ID in the response. You can use it to check the status and results.

Check the status

Use the following request:

1
2
curl \
  -u "$YOUR_EMAIL:$YOUR_API_TOKEN" \
  https://api.atlassian.com/links/v1/${SITE_ID}/jobs/status/${JOB_ID}

Example request

1
2
export YOUR_EMAIL=charlie@atlassian.com
export YOUR_API_TOKEN=21Iv4we2ZtoLixXX21OUQiF06a
export SITE_ID=b436336f-99ce-2fbc-4520-7301132h1674
export JOB_ID=b0476a8b-4cc4-4818-a7b4-2fa08cd7703a
 
curl \
  -u "$YOUR_EMAIL:$YOUR_API_TOKEN" \
  https://api.atlassian.com/links/v1/${SITE_ID}/jobs/status/${JOB_ID}

Statuses

Every job can be described with one of the following statuses:

  • Pending: The initial status. The job has been scheduled and waits in the queue.
  • Backup: The job hasn’t been started, because a Cloud backup is in progress.
  • In_progress: The job is in progress, links are being updated.
  • Complete: The job has completed, and the results are ready to view.
  • Retry: There was an issue updating a batch of links. We’re trying again for the selected batch.
  • Error: The job couldn’t be started or completed.

Download log files with results

Once a job is complete, download the audit log and history log with results of link updates:

  • History report: Shows the summary of link updates performed for a single product. This report focuses on the summary of link updates rather than specific modifications.

  • Audit log: Shows all links updated in a single product within the last 29 days, consolidating results of all link updates performed during this time. This report focuses on specific modifications.

History log

To download the history report, use the following request. Make sure to update the parameters with your data, like in other requests:

1
2
YOUR_EMAIL=charlie@atlassian.com
YOUR_API_TOKEN=21Iv4we2ZtoLixXX21OUQiF06a
SITE_ID=b436336f-99ce-2fbc-4520-7301132h1674
 
PRODUCT=JIRA
PRODUCT_URL="https://jira.atlassian.net"
 
REQUEST_BODY="{
    \"product\":          \"$PRODUCT\",
    \"productURL\":       \"$PRODUCT_URL\"
}"
 
curl \
  -u "$YOUR_EMAIL:$YOUR_API_TOKEN" \
  -H 'Content-Type: application/json' \
  -XPOST "https://api.atlassian.com/links/v1/${SITE_ID}/report/jobs" \
  --data "$REQUEST_BODY"

After sending the request, you’ll get an email with a download link. You can use it to download the history report as a CSV file.

Audit log

To download the audit log, use the following request. Make sure to update the parameters with your data, like in other requests:

1
2
YOUR_EMAIL=charlie@atlassian.com
YOUR_API_TOKEN=21Iv4we2ZtoLixXX21OUQiF06a
SITE_ID=b436336f-99ce-2fbc-4520-7301132h1674
 
PRODUCT=JIRA
PRODUCT_URL="https://jira.atlassian.net"
 
REQUEST_BODY="{
\"product\":          \"$PRODUCT\",
\"productURL\":       \"$PRODUCT_URL\"
}"
 
curl \
  -u "$YOUR_EMAIL:$YOUR_API_TOKEN" \
  -H 'Content-Type: application/json' \
  -XPOST "https://api.atlassian.com/links/v1/${SITE_ID}/report/links" \
  --data "$REQUEST_BODY"

After sending the request, you’ll get an email with a download link. You can use it to download the audit log as a CSV file.

Rate this page: