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

Jira Cloud: Upload an Attachment

See more Jira Examples

Upload a local file as an issue attachment using multipart/form-data. Jira requires the form field name file and the header X-Atlassian-Token: no-check. Chilkat supplies the multipart boundary; do not construct it yourself.

Attachments must be enabled and the account must have permission to create attachments. The site attachment settings endpoint reports the upload limit. Re-running this example uploads another attachment; filenames are not unique identifiers. The returned attachment ID is useful for subsequent download or deletion.

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)
request = chilkat.CkHttpRequest()
request.put_HttpVerb("POST")
request.put_ContentType("multipart/form-data")
request.AddHeader("Accept","application/json")
request.AddHeader("X-Atlassian-Token","no-check")
success = request.AddFileForUpload2("file","qa_data/report.pdf","application/pdf")
if (success != True):
    print("Could not open the local attachment file.")
    sys.exit()

url.SetString(baseUrl)
url.Append("/rest/api/3/issue/{$issueKey}/attachments")
success = http.HttpReq(url.getAsString(),request,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()

attachments = chilkat.CkJsonArray()
success = attachments.Load(resp.bodyStr())
if (success != True):
    print("Expected an array of uploaded attachments.")
    sys.exit()

attachment = chilkat.CkJsonObject()
i = 0
while (i < attachments.get_Size()) :
    # attachment is a CkJsonObject
    attachment = attachments.ObjectAt(i)
    print("Uploaded: " + attachment.stringOf("filename") + "  ID: " + attachment.stringOf("id"))

    i = i + 1