Sample code for 30+ languages & platforms
CkPython Requires Chilkat v11.0.0+

Jira Cloud: Download an Issue Attachment

See more Jira Examples

Find an attachment by issue key and filename, obtain its ID from issue metadata, and download it through the documented attachment-content endpoint. The code requires exactly one matching filename; if duplicates exist, select an attachment ID explicitly using its author or creation time.

The example asks Jira to return content without a redirect and handles an HTTPS redirect if one is returned. A separate Http object downloads a signed URL without forwarding the Jira credentials. The destination is an application-chosen local path, not an untrusted server filename. Create the output directory first. This simple version buffers the response in memory, so use a streaming download for very large attachments.

The code uses an Atlassian account email and an API token without scopes with the site URL. For a scoped API token, keep Basic authentication and change baseUrl to https://api.atlassian.com/ex/jira/YOUR_CLOUD_ID. For OAuth2, use that gateway URL, omit Login/Password/BasicAuth, and set http.AuthToken to the access token. See API token authentication and OAuth2 authorization. The account must have permission for the operation; OAuth scopes do not grant additional Jira permissions.

Targets Jira Cloud. Jira Data Center has a separate REST API and may require different paths, authentication, or payloads.

Atlassian REST API documentation

Chilkat CkPython Downloads

CkPython
import sys
import chilkat

success = False

#  Assumes Chilkat is unlocked. See Global Unlock Sample.

http = chilkat.CkHttp()
http.put_RequireSslCertVerify(True)
http.put_BasicAuth(True)
#  Read these credentials from private application configuration.
http.put_Login("YOUR_ATLASSIAN_EMAIL")
http.put_Password("YOUR_API_TOKEN")
baseUrl = "https://your-domain.atlassian.net"
http.put_Accept("application/json")
url = chilkat.CkStringBuilder()
resp = chilkat.CkHttpResponse()
reply = chilkat.CkJsonObject()
issueKey = "PROJECT-123"
http.SetUrlVar("issueKey",issueKey)
attachmentName = "report.pdf"
attachmentId = ""
localPath = "qa_output/report.pdf"
matches = 0
url.SetString(baseUrl)
url.Append("/rest/api/3/issue/{$issueKey}?fields=attachment")
success = http.HttpNoBody("GET",url.getAsString(),resp)
if (resp.get_StatusCode() == 0):
    print("No HTTP response was received. Check connectivity and TLS settings.")
    sys.exit()

if ((success != True) or (resp.get_StatusCode() < 200) or (resp.get_StatusCode() >= 300)):
    print("Request failed. HTTP " + str(resp.get_StatusCode()))
    if (resp.get_StatusCode() == 429):
        print("Rate limited. Retry-After: " + resp.getHeaderField("Retry-After"))

    #  Inspect this response locally; it can contain private Jira data.
    print(resp.bodyStr())
    sys.exit()

success = reply.Load(resp.bodyStr())
if (success != True):
    print("Expected a JSON object in the response.")
    sys.exit()

if (reply.JsonTypeOf("fields.attachment") != 4):
    print("Expected an array: fields.attachment")
    sys.exit()

i = 0
while (i < reply.SizeOfArray("fields.attachment")) :
    reply.put_I(i)
    if (reply.StringOfEquals("fields.attachment[i].filename",attachmentName,True) == True):
        attachmentId = reply.stringOf("fields.attachment[i].id")
        matches = matches + 1

    i = i + 1

if ((matches != 1) or (attachmentId == "")):
    print("Expected exactly one attachment with this filename. Matches: " + str(matches))
    sys.exit()

http.SetUrlVar("attachmentId",attachmentId)
http.put_FollowRedirects(False)
http.put_Accept("*/*")
url.SetString(baseUrl)
url.Append("/rest/api/3/attachment/content/{$attachmentId}?redirect=false")
success = http.HttpNoBody("GET",url.getAsString(),resp)
if ((resp.get_StatusCode() == 302) or (resp.get_StatusCode() == 303) or (resp.get_StatusCode() == 307)):
    location = chilkat.CkStringBuilder()
    location.SetString(resp.getHeaderField("Location"))
    if (location.StartsWith("https://",False) != True):
        print("Expected an HTTPS attachment redirect.")
        sys.exit()

    download = chilkat.CkHttp()
    download.put_RequireSslCertVerify(True)
    #  The signed URL authorizes this request; do not add Jira credentials.
    success = download.HttpNoBody("GET",location.getAsString(),resp)

if ((success != True) or (resp.get_StatusCode() != 200)):
    print("Attachment download failed. HTTP " + str(resp.get_StatusCode()))
    sys.exit()

success = resp.SaveBodyBinary(localPath)
if (success != True):
    print("Could not save the downloaded attachment.")
    sys.exit()

print("Saved attachment to " + localPath)