Support for Server products ended Feb. 15, 2024. Learn what this means for you.

Server

Jira Service Management / Reference / REST API

attachment

Operations

GET/api/2/attachment/meta GET/api/2/attachment/{id}DEL/api/2/attachment/{id}GET/api/2/attachment/{id}/expand/human GET/api/2/attachment/{id}/expand/raw

GET

Get attachment capabilities

Returns the meta information for an attachments, specifically if they are enabled and the maximum upload size allowed.

Forge and OAuth2 apps cannot access this REST resource.

Request

This request has no parameters.

Responses

JSON representation of the attachment capabilities. Consumers of this resource may also need to check if the logged in user has permission to upload or otherwise manipulate attachments using the com.atlassian.jira.rest.v2.permission.PermissionsResource

application/json

AttachmentMetaBean

GET/api/2/attachment/meta

curl

Node.js

Java

Python

PHP

curl --request GET \
  --url 'http://{baseurl}/rest/api/2/attachment/meta' \
  --user 'email@example.com:<api_token>' \
  --header 'Accept: application/json'

GET

Get the meta-data for an attachment, including the URI of the actual attached file

Returns the meta-data for an attachment, including the URI of the actual attached file.

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

string

Required

Responses

JSON representation of the attachment meta-data. The representation does not contain the attachment itself, but contains a URI that can be used to download the actual attached file.

application/json

AttachmentBean

GET/api/2/attachment/{id}

curl

Node.js

Java

Python

PHP

curl --request GET \
  --url 'http://{baseurl}/rest/api/2/attachment/{id}' \
  --user 'email@example.com:<api_token>' \
  --header 'Accept: application/json'

DEL

Delete an attachment from an issue

Remove an attachment from an issue.

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

string

Required

Responses

Removal was successful

DEL/api/2/attachment/{id}

curl

Node.js

Java

Python

PHP

1
2
3

curl --request DELETE \
  --url 'http://{baseurl}/rest/api/2/attachment/{id}' \
  --user 'email@example.com:<api_token>'

GET

Get human-readable attachment expansionExperimental

Tries to expand an attachment. Output is human-readable and subject to change.

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

string

Required

Responses

JSON representation of the attachment expanded contents. Empty entry list means that attachment cannot be expanded. It's either empty, corrupt or not an archive at all.

application/json

HumanReadableArchive

GET/api/2/attachment/{id}/expand/human

curl

Node.js

Java

Python

PHP

curl --request GET \
  --url 'http://{baseurl}/rest/api/2/attachment/{id}/expand/human' \
  --user 'email@example.com:<api_token>' \
  --header 'Accept: application/json'

GET

Get raw attachment expansionExperimental

Tries to expand an attachment. Output is raw and should be backwards-compatible through the course of time.

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

string

Required

Responses

JSON representation of the attachment expanded contents. Empty entry list means that attachment cannot be expanded. It's either empty, corrupt or not an archive at all.

application/json

AttachmentArchiveImpl

GET/api/2/attachment/{id}/expand/raw

curl

Node.js

Java

Python

PHP

curl --request GET \
  --url 'http://{baseurl}/rest/api/2/attachment/{id}/expand/raw' \
  --user 'email@example.com:<api_token>' \
  --header 'Accept: application/json'