Sample code for 30+ languages & platforms
CkJava 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 CkJava Downloads

CkJava
import com.chilkatsoft.*;

public class ChilkatExample {

  static {
    try {
        System.loadLibrary("chilkat");
    } catch (UnsatisfiedLinkError e) {
      System.err.println("Native code library failed to load.\n" + e);
      System.exit(1);
    }
  }

  public static void main(String argv[])
  {
    boolean success = false;

    //  Assumes Chilkat is unlocked. See Global Unlock Sample.

    CkHttp http = new 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");
    String baseUrl = "https://your-domain.atlassian.net";
    http.put_Accept("application/json");
    CkStringBuilder url = new CkStringBuilder();
    CkHttpResponse resp = new CkHttpResponse();
    CkJsonObject reply = new CkJsonObject();
    String issueKey = "PROJECT-123";
    http.SetUrlVar("issueKey",issueKey);
    String attachmentName = "report.pdf";
    String attachmentId = "";
    String localPath = "qa_output/report.pdf";
    int 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) {
        System.out.println("No HTTP response was received. Check connectivity and TLS settings.");
        return;
        }

    if ((success != true) || (resp.get_StatusCode() < 200) || (resp.get_StatusCode() >= 300)) {
        System.out.println("Request failed. HTTP " + resp.get_StatusCode());
        if (resp.get_StatusCode() == 429) {
            System.out.println("Rate limited. Retry-After: " + resp.getHeaderField("Retry-After"));
            }

        //  Inspect this response locally; it can contain private Jira data.
        System.out.println(resp.bodyStr());
        return;
        }

    success = reply.Load(resp.bodyStr());
    if (success != true) {
        System.out.println("Expected a JSON object in the response.");
        return;
        }

    if (reply.JsonTypeOf("fields.attachment") != 4) {
        System.out.println("Expected an array: fields.attachment");
        return;
        }

    int 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) || (attachmentId == "")) {
        System.out.println("Expected exactly one attachment with this filename. Matches: " + matches);
        return;
        }

    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) || (resp.get_StatusCode() == 303) || (resp.get_StatusCode() == 307)) {
        CkStringBuilder location = new CkStringBuilder();
        location.SetString(resp.getHeaderField("Location"));
        if (location.StartsWith("https://",false) != true) {
            System.out.println("Expected an HTTPS attachment redirect.");
            return;
            }

        CkHttp download = new 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) || (resp.get_StatusCode() != 200)) {
        System.out.println("Attachment download failed. HTTP " + resp.get_StatusCode());
        return;
        }

    success = resp.SaveBodyBinary(localPath);
    if (success != true) {
        System.out.println("Could not save the downloaded attachment.");
        return;
        }

    System.out.println("Saved attachment to " + localPath);
  }
}