Skip to content

Function: addAttachment() ​

ts
function addAttachment(
   client, 
   parameters, 
   options?
): Promise<object[]>;

Defined in: src/server/api/issues.ts:522

Add one or more attachments to an issue. This resource expects a multipart post. The media-type multipart/form-data is defined in RFC 1867. Most client libraries have classes that make dealing with multipart posts simple. For instance, in Java the Apache HTTP Components library provides a MultiPartEntity that makes it simple to submit a multipart POST. In order to protect against XSRF attacks, because this method accepts multipart/form-data, it has XSRF protection on it. This means you must submit a header of X-Atlassian-Token: no-check with the request, otherwise it will be blocked. The name of the multipart/form-data parameter that contains attachments must be file. A simple example to upload a file called "myfile.txt" to issue TEST-123: curl -D- -u admin:admin -X POST -H "X-Atlassian-Token: no-check" -F "file=@myfile.txt" http://myhost/rest/api/2/issue/TEST-123/attachments

Parameters ​

ParameterTypeDescription
clientClient-
parameters{ attachments: | AttachmentInput | AttachmentInput[]; issueIdOrKey: string; }-
parameters.attachments| AttachmentInput | AttachmentInput[]-
parameters.issueIdOrKey?stringIssue id or key
options?RequestOptions-

Returns ​

Promise<object[]>