Attachment API
The Attachment API provides endpoints that allow you to upload and query file attachments.
You can upload or retrieve a single file with each request.
The Attachment API respects any system limitations on uploaded files, such as maximum file size and allowed attachment types. You can control these settings using the properties com.glide.attachment.max_size, 1024MB by default, and glide.attachment.extensions.
Note: The Attachment API accepts all Content-Type values (*/*). Specify the file content type when uploading an attachment. The content type is stored with file metadata allowing other tools to correctly identify and parse the file.
The following video provides more information on the Attachment API:
Attachment API role requirements
To create attachments, the user record used to authenticate the HTTP request with ServiceNow must have any roles required to create Attachment [sys_attachment] records. It must also have any roles required to read and write records on the target table, such as the itil role to add attachments to incident records.
By default there is no single role allowing a user to add attachments. You can create a role to explicitly allow adding attachments, then assign this role to the user account being used to make the request.
Parent Topic:REST API reference
Attachment - DELETE /now/attachment/{sys_id}
Deletes a specified attachment.
URL format
Versioned URL: /api/now/v1/attachment/{sys_id}
Default URL: /api/now/attachment/{sys_id}
Note: Available versions are specified in the REST API Explorer. For scripted REST APIs there is additional version information on the Scripted REST Service form.
Supported request parameters
|
Name |
Description |
|---|---|
|
sys_id |
Sys_id of the attachment.Data type: String Table: Attachment [sys_attachment] |
| Name | Description |
|---|---|
| None |
Headers
The following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see Supported REST API headers.
| Header | Description |
|---|---|
| None |
| Header | Description |
|---|---|
| None |
Status codes
The following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see REST API HTTP response codes.
| Status code | Description |
|---|---|
| 204 | Indicates the request ran successfully. |
| 401 | Unauthorized. The user credentials are incorrect or have not been passed. |
| 404 | Not found. The requested item wasn't found. |
| 500 | Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error. |
Response body parameters (JSON or XML)
| Name | Description |
|---|---|
| None |
cURL request
curl "https://instance.servicenow.com/api/now/attachment/615ea769c0a80166001cf5f2367302f5" \--request DELETE \--user 'username':'password'""Attachment - DELETE /now/attachment/{sys_id}/attributes
Deletes all attributes for an attachment.
Attributes are deleted from the Attachment Attributes [sys_attachment_attribute] table.
URL format
Versioned URL: /api/now/{api_version}/attachment/{sys_id}/attributes
Default URL: /api/now/attachment/{sys_id}/attributes
Supported request parameters
|
Name |
Description |
|---|---|
|
api_version |
Optional. Version of the endpoint to access. For example, |
|
sys_id |
Sys_id of the attachment.Data type: String Table: Attachment [sys_attachment] |
| Name | Description |
|---|---|
| None |
Headers
The following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see Supported REST API headers.
| Header | Description |
|---|---|
| None |
| Header | Description |
|---|---|
| None |
Status codes
The following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see REST API HTTP response codes.
| Status code | Description |
|---|---|
| 204 | No Content. The attributes were successfully deleted and no content was returned in the response body. |
| 400 | Bad Request. A bad request type or malformed request was detected. |
| 404 | Not found. The requested item wasn't found. |
Response body parameters (JSON or XML)
| Name | Description |
|---|---|
| None |
cURL request
This example deletes all attributes from an attachment.
curl "https://instance.service-now.com/api/now/attachment/a3af695b0a0006871b657c200acf62e0/attributes" \--request DELETE \--user 'username':'password'Response body.
""Attachment - DELETE /now/attachment/{sys_id}/attributes/{attribute_key}
Deletes a specified attribute from an attachment.
Attributes are deleted from the Attachment Attributes [sys_attachment_attribute] table.
URL format
Versioned URL: /api/now/{api_version}/attachment/{sys_id}/attributes/{attribute_key}
Default URL: /api/now/attachment/{sys_id}/attributes/{attribute_key}
Supported request parameters
|
Name |
Description |
|---|---|
|
api_version |
Optional. Version of the endpoint to access. For example, |
|
sys_id |
Sys_id of the attachment.Data type: String Table: Attachment [sys_attachment] |
|
attribute_key |
Attribute key.Data type: String Table: Attachment Attributes [sys_attachment_attribute] Column: Key |
| Name | Description |
|---|---|
| None |
Headers
The following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see Supported REST API headers.
| Header | Description |
|---|---|
| None |
| Header | Description |
|---|---|
| None |
Status codes
The following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see REST API HTTP response codes.
| Status code | Description |
|---|---|
| 204 | No Content. The attribute was successfully deleted and no content was returned in the response body. |
| 400 | Bad Request. A bad request type or malformed request was detected. |
| 404 | Not found. The requested item wasn't found. |
Response body parameters (JSON or XML)
| Name | Description |
|---|---|
| None |
cURL request
This example deletes a specified attribute from an attachment.
curl "https://instance.service-now.com/api/now/attachment/a3af695b0a0006871b657c200acf62e0/attributes/example_key" \--request DELETE \--user 'username':'password'Response body.
""Attachment - GET /now/attachment
Returns the metadata for multiple attachments.
URL format
Versioned URL: api/now/v1/attachment
Default URL: api/now/attachment
Note: Available versions are specified in the REST API Explorer. For scripted REST APIs there is additional version information on the Scripted REST Service form.
Supported request parameters
| Name | Description |
|---|---|
| None |
|
Name |
Description |
|---|---|
|
sysparm_limit |
Limit to be applied on pagination. Note: Unusually large Data type: String Default: 1000 |
|
sysparm_offset |
Number of records to exclude from the query. Use this parameter to get more records than specified in sysparm_limit parameter. For example, if sysparm_limit is set to 500, but there are additional records you want to query, you can specify a sysparm_offset parameter value of 500 to get the second set of records.Data type: String Default: 0 |
|
sysparm_query |
Encoded query. Queries for the Attachment API are relative to the Attachments [sys_attachment] table.For example: (sysparm_query=file_name=attachment.doc) The encoded query provides support for order by. To sort responses based on certain fields, use the ORDERBY and ORDERBYDESC clauses in sysparm_query. For example, Data type: String |
Headers
The following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see Supported REST API headers.
|
Header |
Description |
|---|---|
|
Accept |
Data format of the response body. Supported types: application/json or application/xml. Default: application/json |
Status codes
The following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see REST API HTTP response codes.
| Status code | Description |
|---|---|
| 200 | Successful. The request was successfully processed. |
| 401 | Unauthorized. The user credentials are incorrect or have not been passed. |
| 500 | Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error. |
Response body parameters (JSON or XML)
| Name | Description |
|---|---|
| Returned information depends on the selected attachments. |
cURL request
curl "https://instance.servicenow.com/api/now/attachment?sysparm_limit=1" \--request GET \--header "Accept:application/json" \--user "username":"password"{ "result": [ { "table_sys_id": "5054b6f8c0a800060056addcf551ecf8", "size_bytes": "462", "download_link": "https://instance.service-now.com/api/now/attachment/615ea769c0a80166001cf5f2367302f5/file", "sys_updated_on": "2009-05-21 04:12:21", "sys_id": "615ea769c0a80166001cf5f2367302f5", "image_height": "", "sys_created_on": "2009-05-21 04:12:21", "file_name": "blocks.swf", "sys_created_by": "glide.maint", "compressed": "true", "average_image_color": "", "sys_updated_by": "glide.maint", "sys_tags": "", "table_name": "content_block_programmatic", "image_width": "", "sys_mod_count": "0", "content_type": "application/x-shockwave-flash", "size_compressed": "485" } ]}Attachment - GET /now/attachment/{sys_id}
Returns the metadata for the attachment file with a specific sys_id value.
URL format
Versioned URL: /api/now/v1/attachment/{sys_id}
Default URL: /api/now/attachment/{sys_id}
Note: Available versions are specified in the REST API Explorer. For scripted REST APIs there is additional version information on the Scripted REST Service form.
Supported request parameters
| Name | Description |
|---|---|
| sys_id | Sys_id of the attachment record for which to retrieve the metadata. |
| Name | Description |
|---|---|
| None |
| Name | Description |
|---|---|
| None |
Headers
The following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see Supported REST API headers.
|
Header |
Description |
|---|---|
|
Accept |
Data format of the response body. Supported types: application/json or application/xml. Default: application/json |
Status codes
The following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see REST API HTTP response codes.
| Status code | Description |
|---|---|
| 200 | Successful. The request was successfully processed. |
| 401 | Unauthorized. The user credentials are incorrect or have not been passed. |
| 404 | Indicates the specified attachment does not exist, or the current user cannot access it. |
| 500 | Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error. |
Response body parameters (JSON or XML)
| Name | Description |
|---|---|
| Metadata specific to the specified attachment. |
cURL request
curl "https://instance.servicenow.com/api/now/attachment/615ea769c0a80166001cf5f2367302f5" \--request GET \--header "Accept:application/json" \--user "username":"password"{ "result": { "table_sys_id": "5054b6f8c0a800060056addcf551ecf8", "size_bytes": "462", "download_link": "https://instance.service-now.com/api/now/attachment/615ea769c0a80166001cf5f2367302f5/file", "sys_updated_on": "2009-05-21 04:12:21", "sys_id": "615ea769c0a80166001cf5f2367302f5", "image_height": "", "sys_created_on": "2009-05-21 04:12:21", "file_name": "blocks.swf", "sys_created_by": "glide.maint", "compressed": "true", "average_image_color": "", "sys_updated_by": "glide.maint", "sys_tags": "", "table_name": "content_block_programmatic", "image_width": "", "sys_mod_count": "0", "content_type": "application/x-shockwave-flash", "size_compressed": "485" }}Attachment - GET /now/attachment/{sys_id}/attributes
Retrieves all attributes for an attachment.
Attributes are retrieved from the Attachment Attributes [sys_attachment_attribute] table.
URL format
Versioned URL: /api/now/{api_version}/attachment/{sys_id}/attributes
Default URL: /api/now/attachment/{sys_id}/attributes
Supported request parameters
|
Name |
Description |
|---|---|
|
api_version |
Optional. Version of the endpoint to access. For example, |
|
sys_id |
Sys_id of the attachment.Data type: String Table: Attachment [sys_attachment] |
| Name | Description |
|---|---|
| None |
Headers
The following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see Supported REST API headers.
|
Header |
Description |
|---|---|
|
Accept |
Data format of the response body. Supported types: application/json or application/xml. Default: application/json |
Status codes
The following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see REST API HTTP response codes.
| Status code | Description |
|---|---|
| 200 | Successful. The request was successfully processed. |
| 400 | Bad Request. A bad request type or malformed request was detected. |
| 404 | Not found. The requested item wasn't found. |
Response body parameters (JSON or XML)
|
Name |
Description |
|---|---|
|
result |
Array of objects containing a key-value pair for each attribute.Data type: Array Text |
|
result.key |
Attribute key.Data type: String Table: Attachment Attributes [sys_attachment_attribute] Column: Key |
|
result.value |
Attribute value.Data type: String Table: Attachment Attributes [sys_attachment_attribute] Column: Value |
This example retrieves all attributes for the specified attachment.
curl "https://instance.service-now.com/api/now/attachment/a3af695b0a0006871b657c200acf62e0/attributes" \--request GET \--header "Accept:application/json" \--user 'username':'password'Response body.
{ "result": [ { "key": "example_key", "value": "example_value" }, { "key": "another_key", "value": "another_value" } ]}Attachment - GET /now/attachment/{sys_id}/attributes/{attribute_key}
Retrieves a specified attribute from an attachment.
Attributes are retrieved from the Attachment Attributes [sys_attachment_attribute] table.
URL format
Versioned URL: /api/now/{api_version}/attachment/{sys_id}/attributes/{attribute_key}
Default URL: /api/now/attachment/{sys_id}/attributes/{attribute_key}
Supported request parameters
|
Name |
Description |
|---|---|
|
api_version |
Optional. Version of the endpoint to access. For example, |
|
sys_id |
Sys_id of the attachment.Data type: String Table: Attachment [sys_attachment] |
|
attribute_key |
Attribute key.Data type: String Table: Attachment Attributes [sys_attachment_attribute] Column: Key |
| Name | Description |
|---|---|
| None |
Headers
The following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see Supported REST API headers.
|
Header |
Description |
|---|---|
|
Accept |
Data format of the response body. Supported types: application/json or application/xml. Default: application/json |
Status codes
The following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see REST API HTTP response codes.
| Status code | Description |
|---|---|
| 200 | Successful. The request was successfully processed. |
| 400 | Bad Request. A bad request type or malformed request was detected. |
| 404 | Not found. The requested item wasn't found. |
Response body parameters (JSON or XML)
|
Name |
Description |
|---|---|
|
result |
Object containing the key-value pair for the attribute.Data type: Object Text |
|
result.key |
Attribute key.Data type: String Table: Attachment Attributes [sys_attachment_attribute] Column: Key |
|
result.value |
Attribute value.Data type: String Table: Attachment Attributes [sys_attachment_attribute] Column: Value |
This example retrieves a specified attribute from an attachment.
curl "https://instance.service-now.com/api/now/attachment/a3af695b0a0006871b657c200acf62e0/attributes/example_key" \--request GET \--header "Accept:application/json" \--user 'username':'password'Response body.
{ "result": { "key": "example_key", "value": "example_value" }}Attachment - GET /now/attachment/{sys_id}/file
Returns the binary file attachment with a specific sys_id value.
URL format
Versioned URL: /api/now/v1/attachment/{sys_id}/file
Default URL: /api/now/attachment/{sys_id}/file
Note: Available versions are specified in the REST API Explorer. For scripted REST APIs there is additional version information on the Scripted REST Service form.
Supported request parameters
| Name | Description |
|---|---|
| sys_id | Sys_id of the attachment record from which to return binary data. |
| Name | Description |
|---|---|
| None |
| Name | Description |
|---|---|
| None |
Headers
The following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see Supported REST API headers.
|
Header |
Description |
|---|---|
|
Accept |
Data format of the response body. For example, use |
Status codes
The following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see REST API HTTP response codes.
| Status code | Description |
|---|---|
| 200 | Successful. The request was successfully processed. |
| 400 | Bad Request. A bad request type or malformed request was detected. |
| 401 | Unauthorized. The user credentials are incorrect or have not been passed. |
| 500 | Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error. |
Response body parameters (JSON or XML)
| Name | Description |
|---|---|
| Binary file attachment |
cURL request
curl "https://instance.servicenow.com/api/now/attachment/615ea769c0a80166001cf5f2367302f5/file" \--request GET \--header "Accept:*/*" \--user "username":"password"Binary response not shown.Attachment - PATCH /now/attachment/{sys_id}
Renames an attachment.
URL format
Versioned URL: /api/now/{api_version}/attachment/{sys_id}
Default URL: /api/now/attachment/{sys_id}
Supported request parameters
|
Name |
Description |
|---|---|
|
api_version |
Optional. Version of the endpoint to access. For example, |
|
sys_id |
Sys_id of the attachment.Table: Attachment [sys_attachment] Data type: String |
|
Name |
Description |
|---|---|
|
file_name |
Required. New name for the attachment.Data type: String |
The following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see Supported REST API headers.
|
Header |
Description |
|---|---|
|
Accept |
Data format of the response body. Supported types: application/json or application/xml. Default: application/json |
|
Content-Type |
Data format of the request body. Supported types: application/json or application/xml. Default: application/json |
Status codes
The following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see REST API HTTP response codes.
| Status code | Description |
|---|---|
| 204 | No Content. The attachment was successfully renamed and no content was returned in the response body. |
| 400 | Bad Request. A bad request type or malformed request was detected. |
| 401 | Unauthorized. The user credentials are incorrect or have not been passed. |
Response body parameters (JSON or XML)
|
Name |
Description |
|---|---|
|
error |
Error information. This parameter is only returned if the request failed.Data type: Object Text |
|
error.detail |
Additional details about why the request failed.Data type: String |
|
error.message |
Error message containing the reason the request failed.Data type: String |
|
status |
Status of the API request. This parameter is only returned if the request failed so the only possible value is |
This example renames an attachment.
curl "https://instance.service-now.com/api/now/attachment/a3af695b0a0006871b657c200acf62e0" \--request PATCH \--header "Accept:application/json" \--header "Content-Type:application/json" \--data "{ \"file_name\": \"new_attachment_name\" }" \--user 'username':'password'Response body.
""Attachment - POST /now/attachment/{sys_id}/attributes
Adds an attribute to a specified attachment.
Attributes are added in the Attachment Attributes [sys_attachment_attribute] table.
This endpoint can be used to add alt text to an attachment.
URL format
Versioned URL: /api/now/{api_version}/attachment/{sys_id}/attributes
Default URL: /api/now/attachment/{sys_id}/attributes
Supported request parameters
|
Name |
Description |
|---|---|
|
api_version |
Optional. Version of the endpoint to access. For example, |
|
sys_id |
Sys_id of the attachment.Data type: String Table: Attachment [sys_attachment] |
|
Name |
Description |
|---|---|
|
key |
Required. Key to use for the attribute.Data type: String |
|
value |
Required. Value to use for the attribute.Data type: String |
The following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see Supported REST API headers.
|
Header |
Description |
|---|---|
|
Accept |
Data format of the response body. Supported types: application/json or application/xml. Default: application/json |
|
Content-Type |
Data format of the request body. Supported types: application/json or application/xml. Default: application/json |
Status codes
The following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see REST API HTTP response codes.
| Status code | Description |
|---|---|
| 201 | Created. The attribute was successfully created. |
| 400 | Bad Request. A bad request type or malformed request was detected. |
| 404 | Not found. The requested item wasn't found. |
Response body parameters (JSON or XML)
|
Name |
Description |
|---|---|
|
result |
Object containing the key-value pair for the attribute.Data type: Object Text |
|
result.key |
Attribute key.Data type: String Table: Attachment Attributes [sys_attachment_attribute] Column: Key |
|
result.value |
Attribute value.Data type: String Table: Attachment Attributes [sys_attachment_attribute] Column: Value |
This example adds an attribute to an attachment.
curl "https://instance.service-now.com/api/now/attachment/a3af695b0a0006871b657c200acf62e0/attributes" \--request POST \--header "Accept:application/json" \--header "Content-Type:application/json" \--data "{ \"key\": \"example_key\", \"value\": \"example_value\"}" \--user 'username':'password'Response body.
{ "result": { "key": "example_key", "value": "example_value" }}Attachment - POST /now/attachment/file
Uploads a specified binary file as an attachment to a specified record.
Note: The file to attach must be specified after the last parameter in the passed-in request parameter list.
URL format
Versioned URL: /api/now/v1/attachment/file
Default URL: /api/now/attachment/file
Note: Available versions are specified in the REST API Explorer. For scripted REST APIs there is additional version information on the Scripted REST Service form.
Supported request parameters
| Name | Description |
|---|---|
| None |
|
Name |
Description |
|---|---|
|
creation_time |
Creation date and time of the attachment. Use this parameter to capture attachment creation times when the Now Mobile app is offline and the attachment is uploaded to a record at a later time. Data type: String Default: The current date and time. |
|
encryption_context |
Sys_id of an encryption context record. Specify this parameter to allow only users with the specified encryption context to access the attachment. For additional information on encryption context records, see Field Encryption.Data type: String Default: File is encrypted using encryption context accessible to the user, otherwise the attached file is not encrypted with any encryption context. |
|
file_name |
Required. Name to give the attachment. Data type: String |
|
table_name |
Required. Name of the table to attach the file to.Data type: String |
|
table_sys_id |
Required. Sys_id of the record in the table specified in table_name that you want to attach the file to. Data type: String |
Headers
The following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see Supported REST API headers.
|
Header |
Description |
|---|---|
|
Accept |
Data format of the response body. Supported types: application/json or application/xml. Default: application/json |
|
Content-Type |
Content type of the file to attach, such as image/jpeg or */*. This header is mandatory to post file attachments. |
Status codes
The following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see REST API HTTP response codes.
|
Status code |
Description |
|---|---|
|
201 |
Indicates the query ran successfully. |
|
400 |
Indicates that one or more mandatory parameters were missing from the request. |
|
403 |
Forbidden. The user doesn't have access rights to the specified record.Note: To authenticate with this API, use OAuth 2.0 or enable preemptive authentication on the REST client. For more information, see KB3054410. |
|
404 |
Indicates the record specified by the table_name and table_sys_id parameters does not exist or is not accessible to the current user. |
|
500 |
Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error. |
|
Element |
Description |
|---|---|
|
result |
Metadata of the requested attachment.Data type: Object JSON |
|
result.average_image_color |
If the attachment is an image, the sum of all colors.Data type: String Unit: RGB or number of pixels. |
|
result.compressed |
Flag that indicates whether the attachment file has been compressed.Possible values:
Data type: String |
|
result.content_type |
Content-type of the associated attachment file, such as image or jpeg or application/x-shockwave-flash.Data type: String |
|
result.created_by_name |
Full name of entity that originally created the attachment file.Data type: String |
|
result.download_link |
Download URL of the attachment on the ServiceNow instance.Data type: String |
|
result.file_name |
File name of the attachment.Data type: String |
|
result.image_height |
If an image file, the height of the image.Data type: String Unit: Pixels |
|
result.image_width |
If an image file, the width of the image.Data type: String Unit: Pixels |
|
result.size_bytes |
Size of the attachment.Data type: String Unit: Bytes |
|
result.size_compressed |
Size of the compressed attachment file. If the file is not compressed, empty.Data type: String Unit: Bytes |
|
result.sys_created_by |
Entity that originally created the attachment file.Data type: String |
|
result.sys_created_on |
Date and time that the attachment file was initially saved to the instance.Data type: String |
|
result.sys_id |
Sys_id of the attachment file.Data type: String |
|
result.sys_mod_count |
Number of times the attachment file has been modified (uploaded to the instance).Data type: String |
|
result.sys_tags |
Any system tags associated with the attachment file.Data type: String |
|
result.sys_updated_by |
Entity that last updated the attachment file.Data type: String |
|
result.sys_updated_on |
Date and time that the attachment file was last updated.Data type: String |
|
result.table_name |
Name of the table to which the attachment is associated.Data type: String |
|
result.table_sys_id |
Sys_id of the table associated with the attachment.Data type: String |
|
result.updated_by_name |
Full name of entity that last updated the attachment file.Data type: String |
curl "https://instance.servicenow.com/api/now/attachment/file?table_name=incident&table_sys_id=d71f7935c0a8016700802b64c67c11c6&file_name=Issue_screenshot" \--request POST \--header "Accept:application/json" \--header "Content-Type: image/jpeg" \--user "username":"password" \--data-binary "@ location of the file on file system"{ "result": { "table_sys_id": "d71f7935c0a8016700802b64c67c11c6", "size_bytes": "36597", "download_link": "https://instance.servicenow.com/api/now/attachment/6ea10fe64f411200adf9f8e18110c739/file", "sys_updated_on": "2016-01-22 15:14:07", "sys_id": "6ea10fe64f411200adf9f8e18110c739", "image_height": "", "sys_created_on": "2016-01-22 15:14:07", "file_name": "Issue_screenshot", "sys_created_by": "admin", "compressed": "true", "average_image_color": "", "sys_updated_by": "admin", "sys_tags": "", "table_name": "incident", "image_width": "", "sys_mod_count": "0", "content_type": "image/jpeg", "size_compressed": "25130" }}Attachment - POST /now/attachment/upload
Uploads a multipart file attachment.
The multipart POST method does not accept any parameters. You must specify the table name and record sys_id values within the form body. See the cURL example for a sample of a multipart/form-data request.
Important: When using multipart POST, ensure that the file content is contained in the final part of the message only. Earlier parts should contain only metadata such as table name and record sys_id.
URL format
Versioned URL: /api/now/v1/attachment/upload
Default URL: /api/now/attachment/upload
Note: Available versions are specified in the REST API Explorer. For scripted REST APIs there is additional version information on the Scripted REST Service form.
Supported request parameters
| Name | Description |
|---|---|
| None |
| Name | Description |
|---|---|
| None |
| Name | Description |
|---|---|
| None |
Headers
The following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see Supported REST API headers.
|
Header |
Description |
|---|---|
|
Accept |
Data format of the response body. Supported types: application/json or application/xml. Default: application/json |
|
Content-Type |
Content type of the request. Set this value to multipart/form-data when using the multipart POST method. |
Status codes
The following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see REST API HTTP response codes.
| Status code | Description |
|---|---|
| 201 | Indicates the query ran successfully. |
| 400 | Bad Request. A bad request type or malformed request was detected. |
| 401 | Unauthorized. The user credentials are incorrect or have not been passed. |
| 404 | Not found. The requested item wasn't found. |
| 500 | Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error. |
Response body parameters (JSON or XML)
|
Element |
Description |
|---|---|
|
result |
Metadata of the requested attachment.Data type: Object JSON |
|
result.average_image_color |
If the attachment is an image, the sum of all colors.Data type: String Unit: RGB or number of pixels. |
|
result.compressed |
Flag that indicates whether the attachment file has been compressed.Possible values:
Data type: String |
|
result.content_type |
Content-type of the associated attachment file, such as image or jpeg or application/x-shockwave-flash.Data type: String |
|
result.created_by_name |
Full name of entity that originally created the attachment file.Data type: String |
|
result.download_link |
Download URL of the attachment on the ServiceNow instance.Data type: String |
|
result.file_name |
File name of the attachment.Data type: String |
|
result.image_height |
If an image file, the height of the image.Data type: String Unit: Pixels |
|
result.image_width |
If an image file, the width of the image.Data type: String Unit: Pixels |
|
result.size_bytes |
Size of the attachment.Data type: String Unit: Bytes |
|
result.size_compressed |
Size of the compressed attachment file. If the file is not compressed, empty.Data type: String Unit: Bytes |
|
result.sys_created_by |
Entity that originally created the attachment file.Data type: String |
|
result.sys_created_on |
Date and time that the attachment file was initially saved to the instance.Data type: String |
|
result.sys_id |
Sys_id of the attachment file.Data type: String |
|
result.sys_mod_count |
Number of times the attachment file has been modified (uploaded to the instance).Data type: String |
|
result.sys_tags |
Any system tags associated with the attachment file.Data type: String |
|
result.sys_updated_by |
Entity that last updated the attachment file.Data type: String |
|
result.sys_updated_on |
Date and time that the attachment file was last updated.Data type: String |
|
result.table_name |
Name of the table to which the attachment is associated.Data type: String |
|
result.table_sys_id |
Sys_id of the table associated with the attachment.Data type: String |
|
result.updated_by_name |
Full name of entity that last updated the attachment file.Data type: String |
When sending a multipart POST request to upload a file attachment, include attachment data in the message body, not in the URL parameters. You must specify these values in the message body:
|
Value |
Description |
|---|---|
|
Content-Type |
Content-Type of the file, included in the message body for multipart uploads.Note: The Content-Type must be defined within the file portion of the POST message, not within the form data. See the sample POST multipart message for an example of a multipart message. Data type: String |
|
table_name |
Name of the table to which you want to attach the file.Data type: String |
|
table_sys_id |
Sys_id of the record on the specified table to which you want to attach the file.Data type: String |
curl "https://instance.servicenow.com/api/now/attachment/upload" \--request POST \--header "Accept:application/json"\--user "username":"password"\--header "Content-Type:multipart/form-data"\ -F 'table_name=incident' \ -F 'table_sys_id=d71f7935c0a8016700802b64c67c11c6'\ -F 'uploadFile=@ location of the file on file system'\{ "result": { "table_sys_id": "d71f7935c0a8016700802b64c67c11c6", "size_bytes": "36597", "download_link": "https://instance.service-now.com/api/now/attachment/994adbc64f511200adf9f8e18110c796/file", "sys_updated_on": "2016-02-02 14:00:21", "sys_id": "994adbc64f511200adf9f8e18110c796", "image_height": "", "sys_created_on": "2016-02-02 14:00:21", "file_name": "banner-CS0001345_v1_1.jpeg", "sys_created_by": "admin", "compressed": "true", "average_image_color": "", "sys_updated_by": "admin", "sys_tags": "", "table_name": "incident", "image_width": "", "sys_mod_count": "0", "content_type": "image/jpeg", "size_compressed": "25130" }}Attachment - PUT /now/attachment/{sys_id}/attributes/{attribute_key}
Updates the value of an existing attribute for an attachment.
Attributes are updated in the Attachment Attributes [sys_attachment_attribute] table.
URL format
Versioned URL: /api/now/{api_version}/attachment/{sys_id}/attributes/{attribute_key}
Default URL: /api/now/attachment/{sys_id}/attributes/{attribute_key}
Supported request parameters
|
Name |
Description |
|---|---|
|
api_version |
Optional. Version of the endpoint to access. For example, |
|
sys_id |
Sys_id of the attachment.Data type: String Table: Attachment [sys_attachment] |
|
attribute_key |
Attribute key.Data type: String Table: Attachment Attributes [sys_attachment_attribute] Column: Key |
|
Name |
Description |
|---|---|
|
value |
Required. New value for the attribute.Data type: String |
The following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see Supported REST API headers.
|
Header |
Description |
|---|---|
|
Accept |
Data format of the response body. Supported types: application/json or application/xml. Default: application/json |
|
Content-Type |
Data format of the request body. Supported types: application/json or application/xml. Default: application/json |
Status codes
The following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see REST API HTTP response codes.
| Status code | Description |
|---|---|
| 200 | Successful. The request was successfully processed. |
| 400 | Bad Request. A bad request type or malformed request was detected. |
| 404 | Not found. The requested item wasn't found. |
Response body parameters (JSON or XML)
|
Name |
Description |
|---|---|
|
result |
Object containing the key-value pair for the attribute.Data type: Object Text |
|
result.key |
Attribute key.Data type: String Table: Attachment Attributes [sys_attachment_attribute] Column: Key |
|
result.value |
Attribute value.Data type: String Table: Attachment Attributes [sys_attachment_attribute] Column: Value |
This example updates the value of the example_key attribute for the specified attachment.
curl "https://instance.service-now.com/api/now/attachment/a3af695b0a0006871b657c200acf62e0/attributes/example_key" \--request PUT \--header "Accept:application/json" \--header "Content-Type:application/json" \--data "{ \"value\": \"new_value\"}" \--user 'username':'password'Response body.
{ "result": { "key": "example_key", "value": "new_value" }}---
title: Attachment API
description: The Attachment API provides endpoints that allow you to upload and query file attachments.Deletes a specified attachment.Deletes all attributes for an attachment.Deletes a specified attribute from an attachment.Returns the metadata for multiple attachments.Returns the metadata for the attachment file with a specific sys\_id value.Retrieves all attributes for an attachment.Retrieves a specified attribute from an attachment.Returns the binary file attachment with a specific sys\_id value.Renames an attachment.Adds an attribute to a specified attachment.Uploads a specified binary file as an attachment to a specified record.Uploads a multipart file attachment.Updates the value of an existing attribute for an attachment.
locale: en-US
canonical_url: https://www.servicenow.com/docs/r/api-reference/rest-apis/c\_AttachmentAPI.html
release: brazil
product: REST APIs
classification: rest-apis
topic_type: concept
last_updated: "2026-09-10"
reading_time_minutes: 31
breadcrumb: [REST API reference, API reference, API implementation and reference]
---
# Attachment API
The Attachment API provides endpoints that allow you to upload and query file attachments.
You can upload or retrieve a single file with each request.
The Attachment API respects any system limitations on uploaded files, such as maximum file size and allowed attachment types. You can control these settings using the properties **com.glide.attachment.max\_size**, 1024MB by default, and **glide.attachment.extensions**.
**Note:** The Attachment API accepts all Content-Type values \(\*/\*\). Specify the file content type when uploading an attachment. The content type is stored with file metadata allowing other tools to correctly identify and parse the file.
The following video provides more information on the Attachment API:
## Attachment API role requirements
To create attachments, the user record used to authenticate the HTTP request with ServiceNow must have any roles required to create Attachment \[sys\_attachment\] records. It must also have any roles required to read and write records on the target table, such as the itil role to add attachments to incident records.
By default there is no single role allowing a user to add attachments. You can create a role to explicitly allow adding attachments, then assign this role to the user account being used to make the request.
**Parent Topic:**[REST API reference](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/brazil/markdown/api-reference/rest-apis/api-rest.md)
## Attachment - DELETE /now/attachment/\{sys\_id\}
Deletes a specified attachment.
### URL format
Versioned URL: `/api/now/v1/attachment/{sys_id}`
Default URL: `/api/now/attachment/{sys_id}`
**Note:** Available versions are specified in the [REST API Explorer](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/brazil/markdown/api-reference/rest-api-explorer/use-REST-API-Explorer.md). For scripted REST APIs there is additional version information on the [Scripted REST Service form](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/brazil/markdown/api-reference/rest-api-explorer/c_CustomWebServices.md).
### Supported request parameters
<table class="rest_api_path_parameters"><thead><tr><th>
Name
</th><th>
Description
</th></tr></thead><tbody><tr><td>
sys\_id
</td><td>
Sys\_id of the attachment.Data type: String
Table: Attachment \[sys\_attachment\]
</td></tr></tbody>
</table>|Name|Description|
|----|-----------|
|None| |
|Name|Description|
|----|-----------|
|None| |
### Headers
The following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see [Supported REST API headers](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/brazil/markdown/api-reference/rest-api-explorer/c_RESTAPI.md).
|Header|Description|
|------|-----------|
|None| |
|Header|Description|
|------|-----------|
|None| |
### Status codes
The following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see [REST API HTTP response codes](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/brazil/markdown/api-reference/rest-api-explorer/c_RESTAPI.md).
|Status code|Description|
|-----------|-----------|
|204|Indicates the request ran successfully.|
|401|Unauthorized. The user credentials are incorrect or have not been passed.|
|404|Not found. The requested item wasn't found.|
|500|Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error.|
### Response body parameters \(JSON or XML\)
|Name|Description|
|----|-----------|
|None||
### cURL request
```
curl "https://instance.servicenow.com/api/now/attachment/615ea769c0a80166001cf5f2367302f5" \
--request DELETE \
--user 'username':'password'
```
```
""
```
## Attachment - DELETE /now/attachment/\{sys\_id\}/attributes
Deletes all attributes for an attachment.
Attributes are deleted from the Attachment Attributes \[sys\_attachment\_attribute\] table.
### URL format
Versioned URL: `/api/now/{api_version}/attachment/{sys_id}/attributes`
Default URL: `/api/now/attachment/{sys_id}/attributes`
### Supported request parameters
<table class="rest_api_path_parameters"><thead><tr><th>
Name
</th><th>
Description
</th></tr></thead><tbody><tr><td>
api\_version
</td><td id="version-entry-RESTAPI">
Optional. Version of the endpoint to access. For example, `v1` or `v2`. Only specify this value to use an endpoint version other than the latest. Data type: String
</td></tr><tr><td>
sys\_id
</td><td>
Sys\_id of the attachment.Data type: String
Table: Attachment \[sys\_attachment\]
</td></tr></tbody>
</table>|Name|Description|
|----|-----------|
|None| |
|Name|Description|
|----|-----------|
|None| |
### Headers
The following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see [Supported REST API headers](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/brazil/markdown/api-reference/rest-api-explorer/c_RESTAPI.md).
|Header|Description|
|------|-----------|
|None| |
|Header|Description|
|------|-----------|
|None| |
### Status codes
The following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see [REST API HTTP response codes](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/brazil/markdown/api-reference/rest-api-explorer/c_RESTAPI.md).
|Status code|Description|
|-----------|-----------|
|204|No Content. The attributes were successfully deleted and no content was returned in the response body.|
|400|Bad Request. A bad request type or malformed request was detected.|
|404|Not found. The requested item wasn't found.|
### Response body parameters \(JSON or XML\)
|Name|Description|
|----|-----------|
|None||
### cURL request
This example deletes all attributes from an attachment.
```
curl "https://instance.service-now.com/api/now/attachment/a3af695b0a0006871b657c200acf62e0/attributes" \
--request DELETE \
--user 'username':'password'
```
Response body.
```
""
```
## Attachment - DELETE /now/attachment/\{sys\_id\}/attributes/\{attribute\_key\}
Deletes a specified attribute from an attachment.
Attributes are deleted from the Attachment Attributes \[sys\_attachment\_attribute\] table.
### URL format
Versioned URL: `/api/now/{api_version}/attachment/{sys_id}/attributes/{attribute_key}`
Default URL: `/api/now/attachment/{sys_id}/attributes/{attribute_key}`
### Supported request parameters
<table id="table_oxc_cqh_g3c" class="rest_api_path_parameters"><thead><tr><th>
Name
</th><th>
Description
</th></tr></thead><tbody><tr><td>
api\_version
</td><td id="version-entry-RESTAPI">
Optional. Version of the endpoint to access. For example, `v1` or `v2`. Only specify this value to use an endpoint version other than the latest. Data type: String
</td></tr><tr><td>
sys\_id
</td><td>
Sys\_id of the attachment.Data type: String
Table: Attachment \[sys\_attachment\]
</td></tr><tr><td>
attribute\_key
</td><td>
Attribute key.Data type: String
Table: Attachment Attributes \[sys\_attachment\_attribute\]
Column: Key
</td></tr></tbody>
</table>|Name|Description|
|----|-----------|
|None| |
|Name|Description|
|----|-----------|
|None| |
### Headers
The following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see [Supported REST API headers](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/brazil/markdown/api-reference/rest-api-explorer/c_RESTAPI.md).
|Header|Description|
|------|-----------|
|None| |
|Header|Description|
|------|-----------|
|None| |
### Status codes
The following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see [REST API HTTP response codes](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/brazil/markdown/api-reference/rest-api-explorer/c_RESTAPI.md).
|Status code|Description|
|-----------|-----------|
|204|No Content. The attribute was successfully deleted and no content was returned in the response body.|
|400|Bad Request. A bad request type or malformed request was detected.|
|404|Not found. The requested item wasn't found.|
### Response body parameters \(JSON or XML\)
|Name|Description|
|----|-----------|
|None||
### cURL request
This example deletes a specified attribute from an attachment.
```
curl "https://instance.service-now.com/api/now/attachment/a3af695b0a0006871b657c200acf62e0/attributes/example_key" \
--request DELETE \
--user 'username':'password'
```
Response body.
```
""
```
## Attachment - GET /now/attachment
Returns the metadata for multiple attachments.
### URL format
Versioned URL: `api/now/v1/attachment`
Default URL: `api/now/attachment`
**Note:** Available versions are specified in the [REST API Explorer](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/brazil/markdown/api-reference/rest-api-explorer/use-REST-API-Explorer.md). For scripted REST APIs there is additional version information on the [Scripted REST Service form](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/brazil/markdown/api-reference/rest-api-explorer/c_CustomWebServices.md).
### Supported request parameters
|Name|Description|
|----|-----------|
|None| |
<table class="rest_api_query_parameters"><thead><tr><th>
Name
</th><th>
Description
</th></tr></thead><tbody><tr><td>
sysparm\_limit
</td><td>
Limit to be applied on pagination. **Note:** Unusually large `sysparm_limit` values can impact system performance.
Data type: String
Default: 1000
</td></tr><tr id="row_sysparm_offset"><td>
sysparm\_offset
</td><td>
Number of records to exclude from the query. Use this parameter to get more records than specified in **sysparm\_limit** parameter. For example, if **sysparm\_limit** is set to 500, but there are additional records you want to query, you can specify a **sysparm\_offset** parameter value of 500 to get the second set of records.Data type: String
Default: 0
</td></tr><tr><td>
sysparm\_query
</td><td>
Encoded query. Queries for the Attachment API are relative to the Attachments \[sys\_attachment\] table.For example: **\(sysparm\_query=file\_name=attachment.doc\)**
The encoded query provides support for order by. To sort responses based on certain fields, use the ORDERBY and ORDERBYDESC clauses in sysparm\_query. For example, `sysparm_query=ORDERBYfile_name^ORDERBYDESCtable_Name` orders the results in ascending order by name first, then in descending order by table name.
Data type: String
</td></tr></tbody>
</table>|Name|Description|
|----|-----------|
|None| |
### Headers
The following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see [Supported REST API headers](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/brazil/markdown/api-reference/rest-api-explorer/c_RESTAPI.md).
<table class="rest_api_request_headers"><thead><tr><th>
Header
</th><th>
Description
</th></tr></thead><tbody><tr><td>
Accept
</td><td id="accept-entry-RESTAPI">
Data format of the response body. Supported types: **application/json** or **application/xml**. Default: **application/json**
</td></tr></tbody>
</table>|Header|Description|
|------|-----------|
|Content-Type|Content type of the response. For metadata requests, this is the content type of the metadata, not the content type of the attachment files.|
|Link|Links to download the attachments.|
### Status codes
The following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see [REST API HTTP response codes](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/brazil/markdown/api-reference/rest-api-explorer/c_RESTAPI.md).
|Status code|Description|
|-----------|-----------|
|200|Successful. The request was successfully processed.|
|401|Unauthorized. The user credentials are incorrect or have not been passed.|
|500|Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error.|
### Response body parameters \(JSON or XML\)
|Name|Description|
|----|-----------|
|Returned information depends on the selected attachments.||
### cURL request
```
curl "https://instance.servicenow.com/api/now/attachment?sysparm_limit=1" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
```
```
{
"result": [
{
"table_sys_id": "5054b6f8c0a800060056addcf551ecf8",
"size_bytes": "462",
"download_link": "https://instance.service-now.com/api/now/attachment/615ea769c0a80166001cf5f2367302f5/file",
"sys_updated_on": "2009-05-21 04:12:21",
"sys_id": "615ea769c0a80166001cf5f2367302f5",
"image_height": "",
"sys_created_on": "2009-05-21 04:12:21",
"file_name": "blocks.swf",
"sys_created_by": "glide.maint",
"compressed": "true",
"average_image_color": "",
"sys_updated_by": "glide.maint",
"sys_tags": "",
"table_name": "content_block_programmatic",
"image_width": "",
"sys_mod_count": "0",
"content_type": "application/x-shockwave-flash",
"size_compressed": "485"
}
]
}
```
## Attachment - GET /now/attachment/\{sys\_id\}
Returns the metadata for the attachment file with a specific sys\_id value.
### URL format
Versioned URL: `/api/now/v1/attachment/{sys_id}`
Default URL: `/api/now/attachment/{sys_id}`
**Note:** Available versions are specified in the [REST API Explorer](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/brazil/markdown/api-reference/rest-api-explorer/use-REST-API-Explorer.md). For scripted REST APIs there is additional version information on the [Scripted REST Service form](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/brazil/markdown/api-reference/rest-api-explorer/c_CustomWebServices.md).
### Supported request parameters
|Name|Description|
|----|-----------|
|sys\_id|Sys\_id of the attachment record for which to retrieve the metadata.|
|Name|Description|
|----|-----------|
|None| |
|Name|Description|
|----|-----------|
|None| |
### Headers
The following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see [Supported REST API headers](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/brazil/markdown/api-reference/rest-api-explorer/c_RESTAPI.md).
<table class="rest_api_request_headers"><thead><tr><th>
Header
</th><th>
Description
</th></tr></thead><tbody><tr><td>
Accept
</td><td id="accept-entry-RESTAPI">
Data format of the response body. Supported types: **application/json** or **application/xml**. Default: **application/json**
</td></tr></tbody>
</table>|Header|Description|
|------|-----------|
|Content-Type|The content type of the response. For metadata requests, this is the content type of the metadata, not the content type of the attachment files.|
### Status codes
The following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see [REST API HTTP response codes](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/brazil/markdown/api-reference/rest-api-explorer/c_RESTAPI.md).
|Status code|Description|
|-----------|-----------|
|200|Successful. The request was successfully processed.|
|401|Unauthorized. The user credentials are incorrect or have not been passed.|
|404|Indicates the specified attachment does not exist, or the current user cannot access it.|
|500|Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error.|
### Response body parameters \(JSON or XML\)
|Name|Description|
|----|-----------|
|Metadata specific to the specified attachment.||
### cURL request
```
curl "https://instance.servicenow.com/api/now/attachment/615ea769c0a80166001cf5f2367302f5" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
```
```
{
"result": {
"table_sys_id": "5054b6f8c0a800060056addcf551ecf8",
"size_bytes": "462",
"download_link": "https://instance.service-now.com/api/now/attachment/615ea769c0a80166001cf5f2367302f5/file",
"sys_updated_on": "2009-05-21 04:12:21",
"sys_id": "615ea769c0a80166001cf5f2367302f5",
"image_height": "",
"sys_created_on": "2009-05-21 04:12:21",
"file_name": "blocks.swf",
"sys_created_by": "glide.maint",
"compressed": "true",
"average_image_color": "",
"sys_updated_by": "glide.maint",
"sys_tags": "",
"table_name": "content_block_programmatic",
"image_width": "",
"sys_mod_count": "0",
"content_type": "application/x-shockwave-flash",
"size_compressed": "485"
}
}
```
## Attachment - GET /now/attachment/\{sys\_id\}/attributes
Retrieves all attributes for an attachment.
Attributes are retrieved from the Attachment Attributes \[sys\_attachment\_attribute\] table.
### URL format
Versioned URL: `/api/now/{api_version}/attachment/{sys_id}/attributes`
Default URL: `/api/now/attachment/{sys_id}/attributes`
### Supported request parameters
<table class="rest_api_path_parameters"><thead><tr><th>
Name
</th><th>
Description
</th></tr></thead><tbody><tr><td>
api\_version
</td><td id="version-entry-RESTAPI">
Optional. Version of the endpoint to access. For example, `v1` or `v2`. Only specify this value to use an endpoint version other than the latest. Data type: String
</td></tr><tr><td>
sys\_id
</td><td>
Sys\_id of the attachment.Data type: String
Table: Attachment \[sys\_attachment\]
</td></tr></tbody>
</table>|Name|Description|
|----|-----------|
|None| |
|Name|Description|
|----|-----------|
|None| |
### Headers
The following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see [Supported REST API headers](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/brazil/markdown/api-reference/rest-api-explorer/c_RESTAPI.md).
<table class="rest_api_request_headers"><thead><tr><th>
Header
</th><th>
Description
</th></tr></thead><tbody><tr><td>
Accept
</td><td id="accept-entry-RESTAPI">
Data format of the response body. Supported types: **application/json** or **application/xml**. Default: **application/json**
</td></tr></tbody>
</table>|Header|Description|
|------|-----------|
|None| |
### Status codes
The following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see [REST API HTTP response codes](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/brazil/markdown/api-reference/rest-api-explorer/c_RESTAPI.md).
|Status code|Description|
|-----------|-----------|
|200|Successful. The request was successfully processed.|
|400|Bad Request. A bad request type or malformed request was detected.|
|404|Not found. The requested item wasn't found.|
### Response body parameters \(JSON or XML\)
<table id="table_ykm_12b_g3c"><thead><tr><th>
Name
</th><th>
Description
</th></tr></thead><tbody><tr><td>
result
</td><td>
Array of objects containing a key-value pair for each attribute.Data type: Array
```
"result": [
{
"key": "example_key",
"value": "example_value"
}
]
```
</td></tr><tr><td>
result.key
</td><td>
Attribute key.Data type: String
Table: Attachment Attributes \[sys\_attachment\_attribute\]
Column: Key
</td></tr><tr><td>
result.value
</td><td>
Attribute value.Data type: String
Table: Attachment Attributes \[sys\_attachment\_attribute\]
Column: Value
</td></tr></tbody>
</table>### cURL request
This example retrieves all attributes for the specified attachment.
```
curl "https://instance.service-now.com/api/now/attachment/a3af695b0a0006871b657c200acf62e0/attributes" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'
```
Response body.
```
{
"result": [
{
"key": "example_key",
"value": "example_value"
},
{
"key": "another_key",
"value": "another_value"
}
]
}
```
## Attachment - GET /now/attachment/\{sys\_id\}/attributes/\{attribute\_key\}
Retrieves a specified attribute from an attachment.
Attributes are retrieved from the Attachment Attributes \[sys\_attachment\_attribute\] table.
### URL format
Versioned URL: `/api/now/{api_version}/attachment/{sys_id}/attributes/{attribute_key}`
Default URL: `/api/now/attachment/{sys_id}/attributes/{attribute_key}`
### Supported request parameters
<table class="rest_api_path_parameters"><thead><tr><th>
Name
</th><th>
Description
</th></tr></thead><tbody><tr><td>
api\_version
</td><td id="version-entry-RESTAPI">
Optional. Version of the endpoint to access. For example, `v1` or `v2`. Only specify this value to use an endpoint version other than the latest. Data type: String
</td></tr><tr><td>
sys\_id
</td><td>
Sys\_id of the attachment.Data type: String
Table: Attachment \[sys\_attachment\]
</td></tr><tr><td>
attribute\_key
</td><td>
Attribute key.Data type: String
Table: Attachment Attributes \[sys\_attachment\_attribute\]
Column: Key
</td></tr></tbody>
</table>|Name|Description|
|----|-----------|
|None| |
|Name|Description|
|----|-----------|
|None| |
### Headers
The following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see [Supported REST API headers](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/brazil/markdown/api-reference/rest-api-explorer/c_RESTAPI.md).
<table class="rest_api_request_headers"><thead><tr><th>
Header
</th><th>
Description
</th></tr></thead><tbody><tr><td>
Accept
</td><td id="accept-entry-RESTAPI">
Data format of the response body. Supported types: **application/json** or **application/xml**. Default: **application/json**
</td></tr></tbody>
</table>|Header|Description|
|------|-----------|
|None| |
### Status codes
The following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see [REST API HTTP response codes](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/brazil/markdown/api-reference/rest-api-explorer/c_RESTAPI.md).
|Status code|Description|
|-----------|-----------|
|200|Successful. The request was successfully processed.|
|400|Bad Request. A bad request type or malformed request was detected.|
|404|Not found. The requested item wasn't found.|
### Response body parameters \(JSON or XML\)
<table id="table_fvb_gw3_g3c"><thead><tr><th>
Name
</th><th>
Description
</th></tr></thead><tbody><tr><td>
result
</td><td>
Object containing the key-value pair for the attribute.Data type: Object
```
"result": {
"key": "String",
"value": "String"
}
```
</td></tr><tr><td>
result.key
</td><td>
Attribute key.Data type: String
Table: Attachment Attributes \[sys\_attachment\_attribute\]
Column: Key
</td></tr><tr><td>
result.value
</td><td>
Attribute value.Data type: String
Table: Attachment Attributes \[sys\_attachment\_attribute\]
Column: Value
</td></tr></tbody>
</table>### cURL request
This example retrieves a specified attribute from an attachment.
```
curl "https://instance.service-now.com/api/now/attachment/a3af695b0a0006871b657c200acf62e0/attributes/example_key" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'
```
Response body.
```
{
"result": {
"key": "example_key",
"value": "example_value"
}
}
```
## Attachment - GET /now/attachment/\{sys\_id\}/file
Returns the binary file attachment with a specific sys\_id value.
### URL format
Versioned URL: `/api/now/v1/attachment/{sys_id}/file`
Default URL: `/api/now/attachment/{sys_id}/file`
**Note:** Available versions are specified in the [REST API Explorer](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/brazil/markdown/api-reference/rest-api-explorer/use-REST-API-Explorer.md). For scripted REST APIs there is additional version information on the [Scripted REST Service form](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/brazil/markdown/api-reference/rest-api-explorer/c_CustomWebServices.md).
### Supported request parameters
|Name|Description|
|----|-----------|
|sys\_id|Sys\_id of the attachment record from which to return binary data.|
|Name|Description|
|----|-----------|
|None| |
|Name|Description|
|----|-----------|
|None| |
### Headers
The following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see [Supported REST API headers](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/brazil/markdown/api-reference/rest-api-explorer/c_RESTAPI.md).
<table class="rest_api_request_headers"><thead><tr><th>
Header
</th><th>
Description
</th></tr></thead><tbody><tr><td>
Accept
</td><td>
Data format of the response body. For example, use `image/jpeg` or `image/png` to accept JPEG or PNG image files exclusively. To allow all image types, specify `image/*`; to allow any file type, specify `*/*`.Default: \*/\*
</td></tr></tbody>
</table>|Header|Description|
|------|-----------|
|X-Attachment-Metadata|Metadata about the returned file, such as size, name, and file type.|
### Status codes
The following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see [REST API HTTP response codes](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/brazil/markdown/api-reference/rest-api-explorer/c_RESTAPI.md).
|Status code|Description|
|-----------|-----------|
|200|Successful. The request was successfully processed.|
|400|Bad Request. A bad request type or malformed request was detected.|
|401|Unauthorized. The user credentials are incorrect or have not been passed.|
|500|Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error.|
### Response body parameters \(JSON or XML\)
|Name|Description|
|----|-----------|
|Binary file attachment||
### cURL request
```
curl "https://instance.servicenow.com/api/now/attachment/615ea769c0a80166001cf5f2367302f5/file" \
--request GET \
--header "Accept:*/*" \
--user "username":"password"
```
```
Binary response not shown.
```
## Attachment - PATCH /now/attachment/\{sys\_id\}
Renames an attachment.
### URL format
Versioned URL: `/api/now/{api_version}/attachment/{sys_id}`
Default URL: `/api/now/attachment/{sys_id}`
### Supported request parameters
<table class="rest_api_path_parameters"><thead><tr><th>
Name
</th><th>
Description
</th></tr></thead><tbody><tr><td>
api\_version
</td><td id="version-entry-RESTAPI">
Optional. Version of the endpoint to access. For example, `v1` or `v2`. Only specify this value to use an endpoint version other than the latest. Data type: String
</td></tr><tr><td>
sys\_id
</td><td>
Sys\_id of the attachment.Table: Attachment \[sys\_attachment\]
Data type: String
</td></tr></tbody>
</table>|Name|Description|
|----|-----------|
|None| |
<table class="rest_api_request_body"><thead><tr><th>
Name
</th><th>
Description
</th></tr></thead><tbody><tr><td>
file\_name
</td><td>
Required. New name for the attachment.Data type: String
</td></tr></tbody>
</table>### Headers
The following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see [Supported REST API headers](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/brazil/markdown/api-reference/rest-api-explorer/c_RESTAPI.md).
<table class="rest_api_request_headers"><thead><tr><th>
Header
</th><th>
Description
</th></tr></thead><tbody><tr><td>
Accept
</td><td id="accept-entry-RESTAPI">
Data format of the response body. Supported types: **application/json** or **application/xml**. Default: **application/json**
</td></tr><tr><td>
Content-Type
</td><td id="content_type-entry-RESTAPI">
Data format of the request body. Supported types: **application/json** or **application/xml**. Default: **application/json**
</td></tr></tbody>
</table>|Header|Description|
|------|-----------|
|None| |
### Status codes
The following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see [REST API HTTP response codes](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/brazil/markdown/api-reference/rest-api-explorer/c_RESTAPI.md).
|Status code|Description|
|-----------|-----------|
|204|No Content. The attachment was successfully renamed and no content was returned in the response body.|
|400|Bad Request. A bad request type or malformed request was detected.|
|401|Unauthorized. The user credentials are incorrect or have not been passed.|
### Response body parameters \(JSON or XML\)
<table><thead><tr><th>
Name
</th><th>
Description
</th></tr></thead><tbody><tr><td>
error
</td><td>
Error information. This parameter is only returned if the request failed.Data type: Object
```
"error": {
"detail": "String",
"message": "String"
}
```
</td></tr><tr><td>
error.detail
</td><td>
Additional details about why the request failed.Data type: String
</td></tr><tr><td>
error.message
</td><td>
Error message containing the reason the request failed.Data type: String
</td></tr><tr><td>
status
</td><td>
Status of the API request. This parameter is only returned if the request failed so the only possible value is `failure`.Data type: String
</td></tr></tbody>
</table>### cURL request
This example renames an attachment.
```
curl "https://instance.service-now.com/api/now/attachment/a3af695b0a0006871b657c200acf62e0" \
--request PATCH \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
\"file_name\": \"new_attachment_name\"
}" \
--user 'username':'password'
```
Response body.
```
""
```
## Attachment - POST /now/attachment/\{sys\_id\}/attributes
Adds an attribute to a specified attachment.
Attributes are added in the Attachment Attributes \[sys\_attachment\_attribute\] table.
This endpoint can be used to add alt text to an attachment.
### URL format
Versioned URL: `/api/now/{api_version}/attachment/{sys_id}/attributes`
Default URL: `/api/now/attachment/{sys_id}/attributes`
### Supported request parameters
<table class="rest_api_path_parameters"><thead><tr><th>
Name
</th><th>
Description
</th></tr></thead><tbody><tr><td>
api\_version
</td><td id="version-entry-RESTAPI">
Optional. Version of the endpoint to access. For example, `v1` or `v2`. Only specify this value to use an endpoint version other than the latest. Data type: String
</td></tr><tr><td>
sys\_id
</td><td>
Sys\_id of the attachment.Data type: String
Table: Attachment \[sys\_attachment\]
</td></tr></tbody>
</table>|Name|Description|
|----|-----------|
|None| |
<table class="rest_api_request_body"><thead><tr><th>
Name
</th><th>
Description
</th></tr></thead><tbody><tr><td>
key
</td><td>
Required. Key to use for the attribute.Data type: String
</td></tr><tr><td>
value
</td><td>
Required. Value to use for the attribute.Data type: String
</td></tr></tbody>
</table>### Headers
The following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see [Supported REST API headers](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/brazil/markdown/api-reference/rest-api-explorer/c_RESTAPI.md).
<table id="table_fnw_xy1_g3c" class="rest_api_request_headers"><thead><tr><th>
Header
</th><th>
Description
</th></tr></thead><tbody><tr><td>
Accept
</td><td id="accept-entry-RESTAPI">
Data format of the response body. Supported types: **application/json** or **application/xml**. Default: **application/json**
</td></tr><tr><td>
Content-Type
</td><td id="content_type-entry-RESTAPI">
Data format of the request body. Supported types: **application/json** or **application/xml**. Default: **application/json**
</td></tr></tbody>
</table>|Header|Description|
|------|-----------|
|None| |
### Status codes
The following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see [REST API HTTP response codes](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/brazil/markdown/api-reference/rest-api-explorer/c_RESTAPI.md).
|Status code|Description|
|-----------|-----------|
|201|Created. The attribute was successfully created.|
|400|Bad Request. A bad request type or malformed request was detected.|
|404|Not found. The requested item wasn't found.|
### Response body parameters \(JSON or XML\)
<table><thead><tr><th>
Name
</th><th>
Description
</th></tr></thead><tbody><tr><td>
result
</td><td>
Object containing the key-value pair for the attribute.Data type: Object
```
"result": {
"key": "String",
"value": "String"
}
```
</td></tr><tr><td>
result.key
</td><td>
Attribute key.Data type: String
Table: Attachment Attributes \[sys\_attachment\_attribute\]
Column: Key
</td></tr><tr><td>
result.value
</td><td>
Attribute value.Data type: String
Table: Attachment Attributes \[sys\_attachment\_attribute\]
Column: Value
</td></tr></tbody>
</table>### cURL request
This example adds an attribute to an attachment.
```
curl "https://instance.service-now.com/api/now/attachment/a3af695b0a0006871b657c200acf62e0/attributes" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
\"key\": \"example_key\",
\"value\": \"example_value\"
}" \
--user 'username':'password'
```
Response body.
```
{
"result": {
"key": "example_key",
"value": "example_value"
}
}
```
## Attachment - POST /now/attachment/file
Uploads a specified binary file as an attachment to a specified record.
**Note:** The file to attach must be specified after the last parameter in the passed-in request parameter list.
### URL format
Versioned URL: `/api/now/v1/attachment/file`
Default URL: `/api/now/attachment/file`
**Note:** Available versions are specified in the [REST API Explorer](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/brazil/markdown/api-reference/rest-api-explorer/use-REST-API-Explorer.md). For scripted REST APIs there is additional version information on the [Scripted REST Service form](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/brazil/markdown/api-reference/rest-api-explorer/c_CustomWebServices.md).
### Supported request parameters
|Name|Description|
|----|-----------|
|None| |
<table class="rest_api_query_parameters"><thead><tr><th>
Name
</th><th>
Description
</th></tr></thead><tbody><tr><td>
creation\_time
</td><td>
Creation date and time of the attachment. Use this parameter to capture attachment creation times when the Now Mobile app is offline and the attachment is uploaded to a record at a later time.
Data type: String
Default: The current date and time.
</td></tr><tr><td>
encryption\_context
</td><td>
Sys\_id of an encryption context record. Specify this parameter to allow only users with the specified encryption context to access the attachment. For additional information on encryption context records, see [Field Encryption](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/brazil/markdown/platform-security/field-encryption.md).Data type: String
Default: File is encrypted using encryption context accessible to the user, otherwise the attached file is not encrypted with any encryption context.
</td></tr><tr><td>
file\_name
</td><td>
Required. Name to give the attachment. Data type: String
</td></tr><tr><td>
table\_name
</td><td>
Required. Name of the table to attach the file to.Data type: String
</td></tr><tr><td>
table\_sys\_id
</td><td>
Required. Sys\_id of the record in the table specified in **table\_name** that you want to attach the file to. Data type: String
</td></tr></tbody>
</table>|Name|Description|
|----|-----------|
|<String>|Path to the binary file to attach to the specified record.|
### Headers
The following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see [Supported REST API headers](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/brazil/markdown/api-reference/rest-api-explorer/c_RESTAPI.md).
<table class="rest_api_request_headers"><thead><tr><th>
Header
</th><th>
Description
</th></tr></thead><tbody><tr><td>
Accept
</td><td id="accept-entry-RESTAPI">
Data format of the response body. Supported types: **application/json** or **application/xml**. Default: **application/json**
</td></tr><tr><td>
Content-Type
</td><td>
Content type of the file to attach, such as image/jpeg or \*/\*. This header is mandatory to post file attachments.
</td></tr></tbody>
</table>|Header|Description|
|------|-----------|
|Location|URL of the new attachment.|
### Status codes
The following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see [REST API HTTP response codes](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/brazil/markdown/api-reference/rest-api-explorer/c_RESTAPI.md).
<table><thead><tr><th>
Status code
</th><th>
Description
</th></tr></thead><tbody><tr><td>
201
</td><td>
Indicates the query ran successfully.
</td></tr><tr><td>
400
</td><td>
Indicates that one or more mandatory parameters were missing from the request.
</td></tr><tr><td>
403
</td><td>
Forbidden. The user doesn't have access rights to the specified record.**Note:** To authenticate with this API, use OAuth 2.0 or enable preemptive authentication on the REST client. For more information, see [KB3054410](https://support.servicenow.com/kb?id=kb_article_view&sysparm_article=KB3054410).
</td></tr><tr><td>
404
</td><td>
Indicates the record specified by the **table\_name** and **table\_sys\_id** parameters does not exist or is not accessible to the current user.
</td></tr><tr><td>
500
</td><td id="entry-500-status-code">
Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error.
</td></tr></tbody>
</table>### Response body parameters \(JSON or XML\)
<table id="table_kbr_qck_llb"><thead><tr><th>
Element
</th><th>
Description
</th></tr></thead><tbody><tr><td>
result
</td><td>
Metadata of the requested attachment.Data type: Object
```
"result": {
"average_image_color": "String",
"compressed": "String",
"content_type": "String",
"created_by_name": "String",
"download_link": "String",
"file_name": "String",
"image_height": "String",
"image_width": "String",
"size_bytes": "String",
"size_compressed": "String",
"sys_created_by": "String",
"sys_created_on": "String",
"sys_id": "String",
"sys_mod_count": "String",
"sys_tags": "String",
"sys_updated_by": "String",
"sys_updated_on": "String",
"table_name": "String",
"table_sys_id": "String",
"updated_by_name": "String"
}
```
</td></tr><tr><td>
result.average\_image\_color
</td><td>
If the attachment is an image, the sum of all colors.Data type: String
Unit: RGB or number of pixels.
</td></tr><tr><td>
result.compressed
</td><td>
Flag that indicates whether the attachment file has been compressed.Possible values:
- true: File has been compressed.
- false: File has not been compressed.
Data type: String
</td></tr><tr><td>
result.content\_type
</td><td>
Content-type of the associated attachment file, such as image or jpeg or application/x-shockwave-flash.Data type: String
</td></tr><tr><td>
result.created\_by\_name
</td><td>
Full name of entity that originally created the attachment file.Data type: String
</td></tr><tr><td>
result.download\_link
</td><td>
Download URL of the attachment on the ServiceNow instance.Data type: String
</td></tr><tr><td>
result.file\_name
</td><td>
File name of the attachment.Data type: String
</td></tr><tr><td>
result.image\_height
</td><td>
If an image file, the height of the image.Data type: String
Unit: Pixels
</td></tr><tr><td>
result.image\_width
</td><td>
If an image file, the width of the image.Data type: String
Unit: Pixels
</td></tr><tr><td>
result.size\_bytes
</td><td>
Size of the attachment.Data type: String
Unit: Bytes
</td></tr><tr><td>
result.size\_compressed
</td><td>
Size of the compressed attachment file. If the file is not compressed, empty.Data type: String
Unit: Bytes
</td></tr><tr><td>
result.sys\_created\_by
</td><td>
Entity that originally created the attachment file.Data type: String
</td></tr><tr><td>
result.sys\_created\_on
</td><td>
Date and time that the attachment file was initially saved to the instance.Data type: String
</td></tr><tr><td>
result.sys\_id
</td><td>
Sys\_id of the attachment file.Data type: String
</td></tr><tr><td>
result.sys\_mod\_count
</td><td>
Number of times the attachment file has been modified \(uploaded to the instance\).Data type: String
</td></tr><tr><td>
result.sys\_tags
</td><td>
Any system tags associated with the attachment file.Data type: String
</td></tr><tr><td>
result.sys\_updated\_by
</td><td>
Entity that last updated the attachment file.Data type: String
</td></tr><tr><td>
result.sys\_updated\_on
</td><td>
Date and time that the attachment file was last updated.Data type: String
</td></tr><tr><td>
result.table\_name
</td><td>
Name of the table to which the attachment is associated.Data type: String
</td></tr><tr><td>
result.table\_sys\_id
</td><td>
Sys\_id of the table associated with the attachment.Data type: String
</td></tr><tr><td>
result.updated\_by\_name
</td><td>
Full name of entity that last updated the attachment file.Data type: String
</td></tr></tbody>
</table>### cURL request
```
curl "https://instance.servicenow.com/api/now/attachment/file?table_name=incident&table_sys_id=d71f7935c0a8016700802b64c67c11c6&file_name=Issue_screenshot" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type: image/jpeg" \
--user "username":"password" \
--data-binary "@ location of the file on file system"
```
```
{
"result": {
"table_sys_id": "d71f7935c0a8016700802b64c67c11c6",
"size_bytes": "36597",
"download_link": "https://instance.servicenow.com/api/now/attachment/6ea10fe64f411200adf9f8e18110c739/file",
"sys_updated_on": "2016-01-22 15:14:07",
"sys_id": "6ea10fe64f411200adf9f8e18110c739",
"image_height": "",
"sys_created_on": "2016-01-22 15:14:07",
"file_name": "Issue_screenshot",
"sys_created_by": "admin",
"compressed": "true",
"average_image_color": "",
"sys_updated_by": "admin",
"sys_tags": "",
"table_name": "incident",
"image_width": "",
"sys_mod_count": "0",
"content_type": "image/jpeg",
"size_compressed": "25130"
}
}
```
## Attachment - POST /now/attachment/upload
Uploads a multipart file attachment.
The multipart POST method does not accept any parameters. You must specify the table name and record sys\_id values within the form body. See the cURL example for a sample of a multipart/form-data request.
**Important:** When using multipart POST, ensure that the file content is contained in the final part of the message only. Earlier parts should contain only metadata such as table name and record sys\_id.
### URL format
Versioned URL: `/api/now/v1/attachment/upload`
Default URL: `/api/now/attachment/upload`
**Note:** Available versions are specified in the [REST API Explorer](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/brazil/markdown/api-reference/rest-api-explorer/use-REST-API-Explorer.md). For scripted REST APIs there is additional version information on the [Scripted REST Service form](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/brazil/markdown/api-reference/rest-api-explorer/c_CustomWebServices.md).
### Supported request parameters
|Name|Description|
|----|-----------|
|None| |
|Name|Description|
|----|-----------|
|None| |
|Name|Description|
|----|-----------|
|None| |
### Headers
The following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see [Supported REST API headers](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/brazil/markdown/api-reference/rest-api-explorer/c_RESTAPI.md).
<table class="rest_api_request_headers"><thead><tr><th>
Header
</th><th>
Description
</th></tr></thead><tbody><tr><td>
Accept
</td><td id="accept-entry-RESTAPI">
Data format of the response body. Supported types: **application/json** or **application/xml**. Default: **application/json**
</td></tr><tr><td>
Content-Type
</td><td>
Content type of the request. Set this value to multipart/form-data when using the multipart POST method.
</td></tr></tbody>
</table>|Header|Description|
|------|-----------|
|Location|URL of the new attachment.|
### Status codes
The following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see [REST API HTTP response codes](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/brazil/markdown/api-reference/rest-api-explorer/c_RESTAPI.md).
|Status code|Description|
|-----------|-----------|
|201|Indicates the query ran successfully.|
|400|Bad Request. A bad request type or malformed request was detected.|
|401|Unauthorized. The user credentials are incorrect or have not been passed.|
|404|Not found. The requested item wasn't found.|
|500|Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error.|
### Response body parameters \(JSON or XML\)
<table id="table_bbj_pfk_llb"><thead><tr><th>
Element
</th><th>
Description
</th></tr></thead><tbody><tr><td>
result
</td><td>
Metadata of the requested attachment.Data type: Object
```
"result": {
"average_image_color": "String",
"compressed": "String",
"content_type": "String",
"created_by_name": "String",
"download_link": "String",
"file_name": "String",
"image_height": "String",
"image_width": "String",
"size_bytes": "String",
"size_compressed": "String",
"sys_created_by": "String",
"sys_created_on": "String",
"sys_id": "String",
"sys_mod_count": "String",
"sys_tags": "String",
"sys_updated_by": "String",
"sys_updated_on": "String",
"table_name": "String",
"table_sys_id": "String",
"updated_by_name": "String"
}
```
</td></tr><tr><td>
result.average\_image\_color
</td><td>
If the attachment is an image, the sum of all colors.Data type: String
Unit: RGB or number of pixels.
</td></tr><tr><td>
result.compressed
</td><td>
Flag that indicates whether the attachment file has been compressed.Possible values:
- true: File has been compressed.
- false: File has not been compressed.
Data type: String
</td></tr><tr><td>
result.content\_type
</td><td>
Content-type of the associated attachment file, such as image or jpeg or application/x-shockwave-flash.Data type: String
</td></tr><tr><td>
result.created\_by\_name
</td><td>
Full name of entity that originally created the attachment file.Data type: String
</td></tr><tr><td>
result.download\_link
</td><td>
Download URL of the attachment on the ServiceNow instance.Data type: String
</td></tr><tr><td>
result.file\_name
</td><td>
File name of the attachment.Data type: String
</td></tr><tr><td>
result.image\_height
</td><td>
If an image file, the height of the image.Data type: String
Unit: Pixels
</td></tr><tr><td>
result.image\_width
</td><td>
If an image file, the width of the image.Data type: String
Unit: Pixels
</td></tr><tr><td>
result.size\_bytes
</td><td>
Size of the attachment.Data type: String
Unit: Bytes
</td></tr><tr><td>
result.size\_compressed
</td><td>
Size of the compressed attachment file. If the file is not compressed, empty.Data type: String
Unit: Bytes
</td></tr><tr><td>
result.sys\_created\_by
</td><td>
Entity that originally created the attachment file.Data type: String
</td></tr><tr><td>
result.sys\_created\_on
</td><td>
Date and time that the attachment file was initially saved to the instance.Data type: String
</td></tr><tr><td>
result.sys\_id
</td><td>
Sys\_id of the attachment file.Data type: String
</td></tr><tr><td>
result.sys\_mod\_count
</td><td>
Number of times the attachment file has been modified \(uploaded to the instance\).Data type: String
</td></tr><tr><td>
result.sys\_tags
</td><td>
Any system tags associated with the attachment file.Data type: String
</td></tr><tr><td>
result.sys\_updated\_by
</td><td>
Entity that last updated the attachment file.Data type: String
</td></tr><tr><td>
result.sys\_updated\_on
</td><td>
Date and time that the attachment file was last updated.Data type: String
</td></tr><tr><td>
result.table\_name
</td><td>
Name of the table to which the attachment is associated.Data type: String
</td></tr><tr><td>
result.table\_sys\_id
</td><td>
Sys\_id of the table associated with the attachment.Data type: String
</td></tr><tr><td>
result.updated\_by\_name
</td><td>
Full name of entity that last updated the attachment file.Data type: String
</td></tr></tbody>
</table>### POST multipart mandatory values
When sending a multipart POST request to upload a file attachment, include attachment data in the message body, not in the URL parameters. You must specify these values in the message body:
<table id="table_p1v_nnj_js"><thead><tr><th>
Value
</th><th>
Description
</th></tr></thead><tbody><tr><td>
Content-Type
</td><td>
Content-Type of the file, included in the message body for multipart uploads.**Note:** The Content-Type must be defined within the file portion of the POST message, not within the form data. See the sample POST multipart message for an example of a multipart message.
Data type: String
</td></tr><tr><td>
table\_name
</td><td>
Name of the table to which you want to attach the file.Data type: String
</td></tr><tr><td>
table\_sys\_id
</td><td>
Sys\_id of the record on the specified table to which you want to attach the file.Data type: String
</td></tr></tbody>
</table>### cURL request
```
curl "https://instance.servicenow.com/api/now/attachment/upload" \
--request POST \
--header "Accept:application/json"\
--user "username":"password"\
--header "Content-Type:multipart/form-data"\
-F 'table_name=incident' \
-F 'table_sys_id=d71f7935c0a8016700802b64c67c11c6'\
-F 'uploadFile=@ location of the file on file system'
\
```
```
{
"result": {
"table_sys_id": "d71f7935c0a8016700802b64c67c11c6",
"size_bytes": "36597",
"download_link": "https://instance.service-now.com/api/now/attachment/994adbc64f511200adf9f8e18110c796/file",
"sys_updated_on": "2016-02-02 14:00:21",
"sys_id": "994adbc64f511200adf9f8e18110c796",
"image_height": "",
"sys_created_on": "2016-02-02 14:00:21",
"file_name": "banner-CS0001345_v1_1.jpeg",
"sys_created_by": "admin",
"compressed": "true",
"average_image_color": "",
"sys_updated_by": "admin",
"sys_tags": "",
"table_name": "incident",
"image_width": "",
"sys_mod_count": "0",
"content_type": "image/jpeg",
"size_compressed": "25130"
}
}
```
## Attachment - PUT /now/attachment/\{sys\_id\}/attributes/\{attribute\_key\}
Updates the value of an existing attribute for an attachment.
Attributes are updated in the Attachment Attributes \[sys\_attachment\_attribute\] table.
### URL format
Versioned URL: `/api/now/{api_version}/attachment/{sys_id}/attributes/{attribute_key}`
Default URL: `/api/now/attachment/{sys_id}/attributes/{attribute_key}`
### Supported request parameters
<table class="rest_api_path_parameters"><thead><tr><th>
Name
</th><th>
Description
</th></tr></thead><tbody><tr><td>
api\_version
</td><td id="version-entry-RESTAPI">
Optional. Version of the endpoint to access. For example, `v1` or `v2`. Only specify this value to use an endpoint version other than the latest. Data type: String
</td></tr><tr><td>
sys\_id
</td><td>
Sys\_id of the attachment.Data type: String
Table: Attachment \[sys\_attachment\]
</td></tr><tr><td>
attribute\_key
</td><td>
Attribute key.Data type: String
Table: Attachment Attributes \[sys\_attachment\_attribute\]
Column: Key
</td></tr></tbody>
</table>|Name|Description|
|----|-----------|
|None| |
<table class="rest_api_request_body"><thead><tr><th>
Name
</th><th>
Description
</th></tr></thead><tbody><tr><td>
value
</td><td>
Required. New value for the attribute.Data type: String
</td></tr></tbody>
</table>### Headers
The following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see [Supported REST API headers](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/brazil/markdown/api-reference/rest-api-explorer/c_RESTAPI.md).
<table id="table_fnw_xy1_g3c" class="rest_api_request_headers"><thead><tr><th>
Header
</th><th>
Description
</th></tr></thead><tbody><tr><td>
Accept
</td><td id="accept-entry-RESTAPI">
Data format of the response body. Supported types: **application/json** or **application/xml**. Default: **application/json**
</td></tr><tr><td>
Content-Type
</td><td id="content_type-entry-RESTAPI">
Data format of the request body. Supported types: **application/json** or **application/xml**. Default: **application/json**
</td></tr></tbody>
</table>|Header|Description|
|------|-----------|
|None| |
### Status codes
The following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see [REST API HTTP response codes](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/brazil/markdown/api-reference/rest-api-explorer/c_RESTAPI.md).
|Status code|Description|
|-----------|-----------|
|200|Successful. The request was successfully processed.|
|400|Bad Request. A bad request type or malformed request was detected.|
|404|Not found. The requested item wasn't found.|
### Response body parameters \(JSON or XML\)
<table id="table_tmm_qw3_g3c"><thead><tr><th>
Name
</th><th>
Description
</th></tr></thead><tbody><tr><td>
result
</td><td>
Object containing the key-value pair for the attribute.Data type: Object
```
"result": {
"key": "String",
"value": "String"
}
```
</td></tr><tr><td>
result.key
</td><td>
Attribute key.Data type: String
Table: Attachment Attributes \[sys\_attachment\_attribute\]
Column: Key
</td></tr><tr><td>
result.value
</td><td>
Attribute value.Data type: String
Table: Attachment Attributes \[sys\_attachment\_attribute\]
Column: Value
</td></tr></tbody>
</table>### cURL request
This example updates the value of the `example_key` attribute for the specified attachment.
```
curl "https://instance.service-now.com/api/now/attachment/a3af695b0a0006871b657c200acf62e0/attributes/example_key" \
--request PUT \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
\"value\": \"new_value\"
}" \
--user 'username':'password'
```
Response body.
```
{
"result": {
"key": "example_key",
"value": "new_value"
}
}
```
| title | Attachment API |
| description | The Attachment API provides endpoints that allow you to upload and query file attachments.Deletes a specified attachment.Deletes all attributes for an attachment.Deletes a specified attribute from an attachment.Returns the metadata for multiple attachments.Returns the metadata for the attachment file with a specific sys\_id value.Retrieves all attributes for an attachment.Retrieves a specified attribute from an attachment.Returns the binary file attachment with a specific sys\_id value.Renames an attachment.Adds an attribute to a specified attachment.Uploads a specified binary file as an attachment to a specified record.Uploads a multipart file attachment.Updates the value of an existing attribute for an attachment. |
| locale | en-US |
| canonical_url | https://www.servicenow.com/docs/r/api-reference/rest-apis/c\_AttachmentAPI.html |
| release | brazil |
| product | REST APIs |
| classification | rest-apis |
| topic_type | concept |
| last_updated | 2026-09-10 |
| reading_time_minutes | 31 |
| breadcrumb | REST API referenceAPI referenceAPI implementation and reference |