---
sourceDocument: Australia API Reference
sourceDocumentLink: https://www.servicenow.com/docs/r/api-reference

 Release :

    - australia

ft:locale :

    - en-US

ft:publication_title :

    - Australia API Reference

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# Attachment API

# Attachment API {#ariaid-title1}

* Release version: Australia
* 
* Updated March 12, 2026
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 25 minutes to read

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:

<br />

## Attachment API role requirements {#c_AttachmentAPI__section_tby_gn1_xhb}

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.

## Attachment - DELETE /now/attachment/{sys_id} {#ariaid-title2}

Deletes a specified attachment.

### URL format {#attachment-DELETE__section_xl1_kft_2mb}

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://www.servicenow.com/docs/zBKcyeP3If8_~R67hD_ZHg "In this tutorial you will use the REST API Explorer to test the ServiceNow REST APIs."). For scripted REST APIs there is additional version information on the [Scripted REST Service form](https://www.servicenow.com/docs/Zk3PxcZ0l8CqUYfw7mHiLg "The scripted REST API feature allows application developers to build custom web service APIs.").

### Supported request parameters

{#attachment-DELETE__entry__2}

| Name | Description |
|-|-|
| sys_id | Sys_id of the attachment. Data type: String Table: Attachment \[sys_attachment\] |
[Table 1. Path parameters]

{#attachment-DELETE__entry__6}

| Name | Description |
|-|-|
| None |   |
[Table 2. Query parameters]

{#attachment-DELETE__entry__10}

| Name | Description |
|-|-|
| None |   |
[Table 3. Request body parameters (XML or JSON)]

### 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://www.servicenow.com/docs/qh7RcF0RI6a~i9u3octdlg "REST (REpresentational State Transfer) is a simple stateless architecture that provides standards between computer systems on the web, making it easier for them to communicate with each other.").
{#attachment-DELETE__entry__14}

| Header | Description |
|-|-|
| None |   |
[Table 4. Request headers]

{#attachment-DELETE__entry__18}

| Header | Description |
|-|-|
| None |   |
[Table 5. Response headers]

### 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://www.servicenow.com/docs/qh7RcF0RI6a~i9u3octdlg "REST (REpresentational State Transfer) is a simple stateless architecture that provides standards between computer systems on the web, making it easier for them to communicate with each other.").
{#attachment-DELETE__entry__22}{#attachment-DELETE__entry-401-status-code}{#attachment-DELETE__entry-404-status-code}{#attachment-DELETE__entry-500-status-code}

| 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. |
[Table 6. Status codes]

### Response body parameters (JSON or XML)

{#attachment-DELETE__entry__32}

| 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 {#ariaid-title3}

Deletes all attributes for an attachment.
Attributes are deleted from the Attachment Attributes \[sys_attachment_attribute\] table.

### URL format {#attachment-DELETE-attributes__section_jjv_4th_g3c}

Versioned URL: /api/now/{api_version}/attachment/{sys_id}/attributes

Default URL: /api/now/attachment/{sys_id}/attributes

### Supported request parameters

{#attachment-DELETE-attributes__entry__2}{#attachment-DELETE-attributes__version-not_optional-RESTAPI}

| Name | Description |
|-|-|
| api_version | Optional. Version of the endpoint to access. For example, <kbd class="ph userinput">v1</kbd> or <kbd class="ph userinput">v2</kbd>. Only specify this value to use an endpoint version other than the latest. Data type: String |
| sys_id | Sys_id of the attachment. Data type: String Table: Attachment \[sys_attachment\] |
[Table 7. Path parameters]

{#attachment-DELETE-attributes__entry__8}

| Name | Description |
|-|-|
| None |   |
[Table 8. Query parameters]

{#attachment-DELETE-attributes__entry__12}

| Name | Description |
|-|-|
| None |   |
[Table 9. Request body parameters (XML or JSON)]

### 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://www.servicenow.com/docs/qh7RcF0RI6a~i9u3octdlg "REST (REpresentational State Transfer) is a simple stateless architecture that provides standards between computer systems on the web, making it easier for them to communicate with each other.").
{#attachment-DELETE-attributes__table_px3_yth_g3c__entry__2}

| Header | Description |
|-|-|
| None |   |
[Table 10. Request headers]

{#attachment-DELETE-attributes__table_px3_yth_g3c} {#attachment-DELETE-attributes__entry__20}

| Header | Description |
|-|-|
| None |   |
[Table 11. Response headers]

### 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://www.servicenow.com/docs/qh7RcF0RI6a~i9u3octdlg "REST (REpresentational State Transfer) is a simple stateless architecture that provides standards between computer systems on the web, making it easier for them to communicate with each other.").
{#attachment-DELETE-attributes__table_hvl_brh_g3c__entry__2}{#attachment-DELETE-attributes__entry-400-status-code}{#attachment-DELETE-attributes__entry-404-status-code}

| 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. |
[Table 12. Status codes]

{#attachment-DELETE-attributes__table_hvl_brh_g3c}

### Response body parameters (JSON or XML)

{#attachment-DELETE-attributes__entry__32}

| Name | Description |
|-|-|
| None |   |
[ ]

### cURL request {#attachment-DELETE-attributes__example_wzh_d5h_g3c}

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} {#ariaid-title4}

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

{#attachment-DELETE-attributes-key__table_oxc_cqh_g3c__entry__2}{#attachment-DELETE-attributes-key__version-not_optional-RESTAPI}

| Name | Description |
|-|-|
| api_version | Optional. Version of the endpoint to access. For example, <kbd class="ph userinput">v1</kbd> or <kbd class="ph userinput">v2</kbd>. Only specify this value to use an endpoint version other than the latest. Data type: String |
| 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 |
[Table 13. Path parameters]

{#attachment-DELETE-attributes-key__table_oxc_cqh_g3c} {#attachment-DELETE-attributes-key__entry__10}

| Name | Description |
|-|-|
| None |   |
[Table 14. Query parameters]

{#attachment-DELETE-attributes-key__entry__14}

| Name | Description |
|-|-|
| None |   |
[Table 15. Request body parameters (XML or JSON)]

### 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://www.servicenow.com/docs/qh7RcF0RI6a~i9u3octdlg "REST (REpresentational State Transfer) is a simple stateless architecture that provides standards between computer systems on the web, making it easier for them to communicate with each other.").
{#attachment-DELETE-attributes-key__entry__18}

| Header | Description |
|-|-|
| None |   |
[Table 16. Request headers]

{#attachment-DELETE-attributes-key__entry__22}

| Header | Description |
|-|-|
| None |   |
[Table 17. Response headers]

### 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://www.servicenow.com/docs/qh7RcF0RI6a~i9u3octdlg "REST (REpresentational State Transfer) is a simple stateless architecture that provides standards between computer systems on the web, making it easier for them to communicate with each other.").
{#attachment-DELETE-attributes-key__table_hvl_brh_g3c__entry__2}{#attachment-DELETE-attributes-key__entry-400-status-code}{#attachment-DELETE-attributes-key__entry-404-status-code}

| 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. |
[Table 18. Status codes]

{#attachment-DELETE-attributes-key__table_hvl_brh_g3c}

### Response body parameters (JSON or XML)

{#attachment-DELETE-attributes-key__entry__34}

| 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 {#ariaid-title5}

Returns the metadata for multiple attachments.

### URL format {#attachment-GET__section_efx_gw4_dmb}

Versioned URL:
api/now/v1/attachment

Default URL: api/now/attachment  
Note:  
Available versions are specified in the [REST API Explorer](https://www.servicenow.com/docs/zBKcyeP3If8_~R67hD_ZHg "In this tutorial you will use the REST API Explorer to test the ServiceNow REST APIs."). For scripted REST APIs there is additional version information on the [Scripted REST Service form](https://www.servicenow.com/docs/Zk3PxcZ0l8CqUYfw7mHiLg "The scripted REST API feature allows application developers to build custom web service APIs.").

### Supported request parameters

{#attachment-GET__entry__2}

| Name | Description |
|-|-|
| None |   |
[Table 19. Path parameters]

{#attachment-GET__entry__6}{#attachment-GET__row_sysparm_offset}

| Name | Description |
|-|-|
| sysparm_limit | Limit to be applied on pagination. Note: Unusually large `sysparm_limit` values can impact system performance. 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, `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 |
[Table 20. Query parameters]

{#attachment-GET__entry__14}

| Name | Description |
|-|-|
| None |   |
[Table 21. Request body parameters (XML or JSON)]

### 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://www.servicenow.com/docs/qh7RcF0RI6a~i9u3octdlg "REST (REpresentational State Transfer) is a simple stateless architecture that provides standards between computer systems on the web, making it easier for them to communicate with each other.").
{#attachment-GET__entry__18}{#attachment-GET__accept-RESTAPI}

| Header | Description |
|-|-|
| Accept | Data format of the response body. Supported types: application/json or application/xml. Default: application/json |
[Table 22. Request headers]

{#attachment-GET__entry__22}

| 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. |
[Table 23. Response headers]

### 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://www.servicenow.com/docs/qh7RcF0RI6a~i9u3octdlg "REST (REpresentational State Transfer) is a simple stateless architecture that provides standards between computer systems on the web, making it easier for them to communicate with each other.").
{#attachment-GET__entry__28}{#attachment-GET__entry-200-status-code}{#attachment-GET__entry-401-status-code}{#attachment-GET__entry-500-status-code}

| 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. |
[Table 24. Status codes]

### Response body parameters (JSON or XML)

{#attachment-GET__entry__36}

| 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} {#ariaid-title6}

Returns the metadata for the attachment file with a specific sys_id value.

### URL format {#attachment-GET-sys_id__section_wmy_pyj_2mb}

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://www.servicenow.com/docs/zBKcyeP3If8_~R67hD_ZHg "In this tutorial you will use the REST API Explorer to test the ServiceNow REST APIs."). For scripted REST APIs there is additional version information on the [Scripted REST Service form](https://www.servicenow.com/docs/Zk3PxcZ0l8CqUYfw7mHiLg "The scripted REST API feature allows application developers to build custom web service APIs.").

### Supported request parameters

{#attachment-GET-sys_id__entry__2}

| Name | Description |
|-|-|
| sys_id | Sys_id of the attachment record for which to retrieve the metadata. |
[Table 25. Path parameters]

{#attachment-GET-sys_id__entry__6}

| Name | Description |
|-|-|
| None |   |
[Table 26. Query parameters]

{#attachment-GET-sys_id__entry__10}

| Name | Description |
|-|-|
| None |   |
[Table 27. Request body parameters (XML or JSON)]

### 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://www.servicenow.com/docs/qh7RcF0RI6a~i9u3octdlg "REST (REpresentational State Transfer) is a simple stateless architecture that provides standards between computer systems on the web, making it easier for them to communicate with each other.").
{#attachment-GET-sys_id__entry__14}{#attachment-GET-sys_id__accept-RESTAPI}

| Header | Description |
|-|-|
| Accept | Data format of the response body. Supported types: application/json or application/xml. Default: application/json |
[Table 28. Request headers]

{#attachment-GET-sys_id__entry__18}

| 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. |
[Table 29. Response headers]

### 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://www.servicenow.com/docs/qh7RcF0RI6a~i9u3octdlg "REST (REpresentational State Transfer) is a simple stateless architecture that provides standards between computer systems on the web, making it easier for them to communicate with each other.").
{#attachment-GET-sys_id__entry__22}{#attachment-GET-sys_id__entry-200-status-code}{#attachment-GET-sys_id__entry-401-status-code}{#attachment-GET-sys_id__entry-500-status-code}

| 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. |
[Table 30. Status codes]

### Response body parameters (JSON or XML)

{#attachment-GET-sys_id__entry__32}

| 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 {#ariaid-title7}

Retrieves all attributes for an attachment.
Attributes are retrieved from the Attachment Attributes \[sys_attachment_attribute\] table.

### URL format {#attachment-GET-attributes__section_kgh_bgb_g3c}

Versioned URL: /api/now/{api_version}/attachment/{sys_id}/attributes

Default URL: /api/now/attachment/{sys_id}/attributes

### Supported request parameters

{#attachment-GET-attributes__entry__2}{#attachment-GET-attributes__version-not_optional-RESTAPI}

| Name | Description |
|-|-|
| api_version | Optional. Version of the endpoint to access. For example, <kbd class="ph userinput">v1</kbd> or <kbd class="ph userinput">v2</kbd>. Only specify this value to use an endpoint version other than the latest. Data type: String |
| sys_id | Sys_id of the attachment. Data type: String Table: Attachment \[sys_attachment\] |
[Table 31. Path parameters]

{#attachment-GET-attributes__entry__8}

| Name | Description |
|-|-|
| None |   |
[Table 32. Query parameters]

{#attachment-GET-attributes__entry__12}

| Name | Description |
|-|-|
| None |   |
[Table 33. Request body parameters (XML or JSON)]

### 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://www.servicenow.com/docs/qh7RcF0RI6a~i9u3octdlg "REST (REpresentational State Transfer) is a simple stateless architecture that provides standards between computer systems on the web, making it easier for them to communicate with each other.").
{#attachment-GET-attributes__entry__16}{#attachment-GET-attributes__accept-RESTAPI}

| Header | Description |
|-|-|
| Accept | Data format of the response body. Supported types: application/json or application/xml. Default: application/json |
[Table 34. Request headers]

{#attachment-GET-attributes__entry__20}

| Header | Description |
|-|-|
| None |   |
[Table 35. Response headers]

### Status codes {#attachment-GET-attributes__section_jsv_b3b_g3c}

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://www.servicenow.com/docs/qh7RcF0RI6a~i9u3octdlg "REST (REpresentational State Transfer) is a simple stateless architecture that provides standards between computer systems on the web, making it easier for them to communicate with each other.").
{#attachment-GET-attributes__table_ksv_b3b_g3c__entry__2}{#attachment-GET-attributes__entry-200-status-code}{#attachment-GET-attributes__entry-400-status-code}{#attachment-GET-attributes__entry-404-status-code}

| 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. |
[Table 36. Status codes]

{#attachment-GET-attributes__table_ksv_b3b_g3c}

### Response body parameters (JSON or XML) {#attachment-GET-attributes__section_xkm_12b_g3c}

{#attachment-GET-attributes__table_ykm_12b_g3c__entry__2}

| Name | Description |
|-|-|
| result | Array of objects containing a key-value pair for each attribute. Data type: Array "result": [ { "key": "example_key", "value": "example_value" } ] |
| 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 |
[ ]

{#attachment-GET-attributes__table_ykm_12b_g3c}  

### 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} {#ariaid-title8}

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

{#attachment-GET-attributes-key__entry__2}{#attachment-GET-attributes-key__version-not_optional-RESTAPI}

| Name | Description |
|-|-|
| api_version | Optional. Version of the endpoint to access. For example, <kbd class="ph userinput">v1</kbd> or <kbd class="ph userinput">v2</kbd>. Only specify this value to use an endpoint version other than the latest. Data type: String |
| 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 |
[Table 37. Path parameters]

{#attachment-GET-attributes-key__entry__10}

| Name | Description |
|-|-|
| None |   |
[Table 38. Query parameters]

{#attachment-GET-attributes-key__entry__14}

| Name | Description |
|-|-|
| None |   |
[Table 39. Request body parameters (XML or JSON)]

### 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://www.servicenow.com/docs/qh7RcF0RI6a~i9u3octdlg "REST (REpresentational State Transfer) is a simple stateless architecture that provides standards between computer systems on the web, making it easier for them to communicate with each other.").
{#attachment-GET-attributes-key__entry__18}{#attachment-GET-attributes-key__accept-RESTAPI}

| Header | Description |
|-|-|
| Accept | Data format of the response body. Supported types: application/json or application/xml. Default: application/json |
[Table 40. Request headers]

{#attachment-GET-attributes-key__entry__22}

| Header | Description |
|-|-|
| None |   |
[Table 41. Response headers]

### 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://www.servicenow.com/docs/qh7RcF0RI6a~i9u3octdlg "REST (REpresentational State Transfer) is a simple stateless architecture that provides standards between computer systems on the web, making it easier for them to communicate with each other.").
{#attachment-GET-attributes-key__entry__26}{#attachment-GET-attributes-key__entry-200-status-code}{#attachment-GET-attributes-key__entry-400-status-code}{#attachment-GET-attributes-key__entry-404-status-code}

| 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. |
[Table 42. Status codes]

### Response body parameters (JSON or XML) {#attachment-GET-attributes-key__section_evb_gw3_g3c}

{#attachment-GET-attributes-key__table_fvb_gw3_g3c__entry__2}

| Name | Description |
|-|-|
| result | Object containing the key-value pair for the attribute. Data type: Object "result": { "key": "String", "value": "String" } |
| 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 |
[ ]

{#attachment-GET-attributes-key__table_fvb_gw3_g3c}  

### 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 {#ariaid-title9}

Returns the binary file attachment with a specific sys_id value.

### URL format {#attachment-GET-file__section_apn_ybk_2mb}

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://www.servicenow.com/docs/zBKcyeP3If8_~R67hD_ZHg "In this tutorial you will use the REST API Explorer to test the ServiceNow REST APIs."). For scripted REST APIs there is additional version information on the [Scripted REST Service form](https://www.servicenow.com/docs/Zk3PxcZ0l8CqUYfw7mHiLg "The scripted REST API feature allows application developers to build custom web service APIs.").

### Supported request parameters

{#attachment-GET-file__entry__2}

| Name | Description |
|-|-|
| sys_id | Sys_id of the attachment record from which to return binary data. |
[Table 43. Path parameters]

{#attachment-GET-file__entry__6}

| Name | Description |
|-|-|
| None |   |
[Table 44. Query parameters]

{#attachment-GET-file__entry__10}

| Name | Description |
|-|-|
| None |   |
[Table 45. Request body parameters (XML or JSON)]

### 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://www.servicenow.com/docs/qh7RcF0RI6a~i9u3octdlg "REST (REpresentational State Transfer) is a simple stateless architecture that provides standards between computer systems on the web, making it easier for them to communicate with each other.").
{#attachment-GET-file__entry__14}

| Header | Description |
|-|-|
| Accept | 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: \*/\* |
[Table 46. Request headers]

{#attachment-GET-file__entry__18}

| Header | Description |
|-|-|
| X-Attachment-Metadata | Metadata about the returned file, such as size, name, and file type. |
[Table 47. Response headers]

### 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://www.servicenow.com/docs/qh7RcF0RI6a~i9u3octdlg "REST (REpresentational State Transfer) is a simple stateless architecture that provides standards between computer systems on the web, making it easier for them to communicate with each other.").
{#attachment-GET-file__entry__22}{#attachment-GET-file__entry-200-status-code}{#attachment-GET-file__entry-400-status-code}{#attachment-GET-file__entry-401-status-code}{#attachment-GET-file__entry-500-status-code}

| 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. |
[Table 48. Status codes]

### Response body parameters (JSON or XML)

{#attachment-GET-file__entry__32}

| 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} {#ariaid-title10}

Renames an attachment.

### URL format

Versioned URL: /api/now/{api_version}/attachment/{sys_id}

Default URL: /api/now/attachment/{sys_id}

### Supported request parameters

{#attachment-PATCH__entry__2}{#attachment-PATCH__version-not_optional-RESTAPI}

| Name | Description |
|-|-|
| api_version | Optional. Version of the endpoint to access. For example, <kbd class="ph userinput">v1</kbd> or <kbd class="ph userinput">v2</kbd>. Only specify this value to use an endpoint version other than the latest. Data type: String |
| sys_id | Sys_id of the attachment. Table: Attachment \[sys_attachment\] Data type: String |
[Table 49. Path parameters]

{#attachment-PATCH__entry__8}

| Name | Description |
|-|-|
| None |   |
[Table 50. Query parameters]

{#attachment-PATCH__entry__12}

| Name | Description |
|-|-|
| file_name | Required. New name for the attachment. Data type: String |
[Table 51. Request body parameters (XML or JSON)]

### 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://www.servicenow.com/docs/qh7RcF0RI6a~i9u3octdlg "REST (REpresentational State Transfer) is a simple stateless architecture that provides standards between computer systems on the web, making it easier for them to communicate with each other.").
{#attachment-PATCH__entry__16}{#attachment-PATCH__accept-RESTAPI}{#attachment-PATCH__content_type-RESTAPI}

| 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 |
[Table 52. Request headers]

{#attachment-PATCH__entry__22}

| Header | Description |
|-|-|
| None |   |
[Table 53. Response headers]

### 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://www.servicenow.com/docs/qh7RcF0RI6a~i9u3octdlg "REST (REpresentational State Transfer) is a simple stateless architecture that provides standards between computer systems on the web, making it easier for them to communicate with each other.").
{#attachment-PATCH__entry__26}{#attachment-PATCH__entry-400-status-code}{#attachment-PATCH__entry-401-status-code}

| 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. |
[Table 54. Status codes]

### Response body parameters (JSON or XML)

{#attachment-PATCH__entry__34}

| Name | Description |
|-|-|
| error | Error information. This parameter is only returned if the request failed. Data type: Object "error": { "detail": "String", "message": "String" } |
| 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 `failure`. Data type: String |
[ ]

### 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 {#ariaid-title11}

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

{#attachment-POST-attributes__entry__2}{#attachment-POST-attributes__version-not_optional-RESTAPI}

| Name | Description |
|-|-|
| api_version | Optional. Version of the endpoint to access. For example, <kbd class="ph userinput">v1</kbd> or <kbd class="ph userinput">v2</kbd>. Only specify this value to use an endpoint version other than the latest. Data type: String |
| sys_id | Sys_id of the attachment. Data type: String Table: Attachment \[sys_attachment\] |
[Table 55. Path parameters]

{#attachment-POST-attributes__entry__8}

| Name | Description |
|-|-|
| None |   |
[Table 56. Query parameters]

{#attachment-POST-attributes__entry__12}

| Name | Description |
|-|-|
| key | Required. Key to use for the attribute. Data type: String |
| value | Required. Value to use for the attribute. Data type: String |
[Table 57. Request body parameters (XML or JSON)]

### 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://www.servicenow.com/docs/qh7RcF0RI6a~i9u3octdlg "REST (REpresentational State Transfer) is a simple stateless architecture that provides standards between computer systems on the web, making it easier for them to communicate with each other.").
{#attachment-POST-attributes__table_fnw_xy1_g3c__entry__2}{#attachment-POST-attributes__accept-RESTAPI}{#attachment-POST-attributes__content_type-RESTAPI}

| 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 |
[Table 58. Request headers]

{#attachment-POST-attributes__table_fnw_xy1_g3c} {#attachment-POST-attributes__entry__24}

| Header | Description |
|-|-|
| None |   |
[Table 59. Response headers]

### 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://www.servicenow.com/docs/qh7RcF0RI6a~i9u3octdlg "REST (REpresentational State Transfer) is a simple stateless architecture that provides standards between computer systems on the web, making it easier for them to communicate with each other.").
{#attachment-POST-attributes__entry__28}{#attachment-POST-attributes__entry-400-status-code}{#attachment-POST-attributes__entry-404-status-code}

| 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. |
[Table 60. Status codes]

### Response body parameters (JSON or XML)

{#attachment-POST-attributes__entry__36}

| Name | Description |
|-|-|
| result | Object containing the key-value pair for the attribute. Data type: Object "result": { "key": "String", "value": "String" } |
| 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 |
[ ]

### 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 {#ariaid-title12}

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 {#attachment-POST-file__section_phs_45s_2mb}

Versioned URL:
/api/now/v1/attachment/file

Default URL:
/api/now/attachment/file  
Note:  
Available versions are specified in the [REST API Explorer](https://www.servicenow.com/docs/zBKcyeP3If8_~R67hD_ZHg "In this tutorial you will use the REST API Explorer to test the ServiceNow REST APIs."). For scripted REST APIs there is additional version information on the [Scripted REST Service form](https://www.servicenow.com/docs/Zk3PxcZ0l8CqUYfw7mHiLg "The scripted REST API feature allows application developers to build custom web service APIs.").

### Supported request parameters

{#attachment-POST-file__entry__2}

| Name | Description |
|-|-|
| None |   |
[Table 61. Path parameters]

{#attachment-POST-file__entry__6}

| 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](https://www.servicenow.com/docs/access?context=field-encryption&version=australia&pubname=australia-platform-security&ft:locale=en-US). 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 |
[Table 62. Query parameters]

{#attachment-POST-file__entry__18}

| Name | Description |
|-|-|
| \<String\> | Path to the binary file to attach to the specified record. |
[Table 63. Request body parameters (XML or JSON)]

### 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://www.servicenow.com/docs/qh7RcF0RI6a~i9u3octdlg "REST (REpresentational State Transfer) is a simple stateless architecture that provides standards between computer systems on the web, making it easier for them to communicate with each other.").
{#attachment-POST-file__entry__22}{#attachment-POST-file__accept-RESTAPI}

| 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. |
[Table 64. Request headers]

{#attachment-POST-file__entry__28}

| Header | Description |
|-|-|
| Location | URL of the new attachment. |
[Table 65. Response headers]

### 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://www.servicenow.com/docs/qh7RcF0RI6a~i9u3octdlg "REST (REpresentational State Transfer) is a simple stateless architecture that provides standards between computer systems on the web, making it easier for them to communicate with each other.").
{#attachment-POST-file__entry__32}{#attachment-POST-file__entry-500-status-code}

| Status code | Description |
|-|-|
| 201 | Indicates the query ran successfully. |
| 400 | Indicates that one or more mandatory parameters were missing from the request. |
| 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. |
[Table 66. Status codes]

### Response body parameters (JSON or XML)

{#attachment-POST-file__table_kbr_qck_llb__entry__2}

| Element | Description |
|-|-|
| result | 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" } |
| 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: * true: File has been compressed. * false: File has not been compressed. {#attachment-POST-file__ul_ev1_fmk_jlb} 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 |
[ ]

{#attachment-POST-file__table_kbr_qck_llb}  

### 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 {#ariaid-title13}

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 {#attachment-POST-upload__section_jby_v2t_2mb}

Versioned URL:
/api/now/v1/attachment/upload

Default URL:
/api/now/attachment/upload  
Note:  
Available versions are specified in the [REST API Explorer](https://www.servicenow.com/docs/zBKcyeP3If8_~R67hD_ZHg "In this tutorial you will use the REST API Explorer to test the ServiceNow REST APIs."). For scripted REST APIs there is additional version information on the [Scripted REST Service form](https://www.servicenow.com/docs/Zk3PxcZ0l8CqUYfw7mHiLg "The scripted REST API feature allows application developers to build custom web service APIs.").

### Supported request parameters

{#attachment-POST-upload__entry__2}

| Name | Description |
|-|-|
| None |   |
[Table 67. Path parameters]

{#attachment-POST-upload__entry__6}

| Name | Description |
|-|-|
| None |   |
[Table 68. Query parameters]

{#attachment-POST-upload__entry__10}

| Name | Description |
|-|-|
| None |   |
[Table 69. Request body parameters (XML or JSON)]

### 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://www.servicenow.com/docs/qh7RcF0RI6a~i9u3octdlg "REST (REpresentational State Transfer) is a simple stateless architecture that provides standards between computer systems on the web, making it easier for them to communicate with each other.").
{#attachment-POST-upload__entry__14}{#attachment-POST-upload__accept-RESTAPI}

| 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. |
[Table 70. Request headers]

{#attachment-POST-upload__entry__20}

| Header | Description |
|-|-|
| Location | URL of the new attachment. |
[Table 71. Response headers]

### 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://www.servicenow.com/docs/qh7RcF0RI6a~i9u3octdlg "REST (REpresentational State Transfer) is a simple stateless architecture that provides standards between computer systems on the web, making it easier for them to communicate with each other.").
{#attachment-POST-upload__entry__24}{#attachment-POST-upload__entry-400-status-code}{#attachment-POST-upload__entry-401-status-code}{#attachment-POST-upload__entry-404-status-code}{#attachment-POST-upload__entry-500-status-code}

| 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. |
[Table 72. Status codes]

### Response body parameters (JSON or XML)

{#attachment-POST-upload__table_bbj_pfk_llb__entry__2}

| Element | Description |
|-|-|
| result | 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" } |
| 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: * true: File has been compressed. * false: File has not been compressed. {#attachment-POST-upload__ul_ev1_fmk_jlb} 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 |
[ ]

{#attachment-POST-upload__table_bbj_pfk_llb}

### POST multipart mandatory values {#attachment-POST-upload__section_tk4_1ft_2mb}

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:{#attachment-POST-upload__table_p1v_nnj_js__entry__2}

| 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 |
[Table 73. Mandatory values]

{#attachment-POST-upload__table_p1v_nnj_js}  

### 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} {#ariaid-title14}

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

{#attachment-PUT-attributes__entry__2}{#attachment-PUT-attributes__version-not_optional-RESTAPI}

| Name | Description |
|-|-|
| api_version | Optional. Version of the endpoint to access. For example, <kbd class="ph userinput">v1</kbd> or <kbd class="ph userinput">v2</kbd>. Only specify this value to use an endpoint version other than the latest. Data type: String |
| 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 |
[Table 74. Path parameters]

{#attachment-PUT-attributes__entry__10}

| Name | Description |
|-|-|
| None |   |
[Table 75. Query parameters]

{#attachment-PUT-attributes__entry__14}

| Name | Description |
|-|-|
| value | Required. New value for the attribute. Data type: String |
[Table 76. Request body parameters (XML or JSON)]

### 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://www.servicenow.com/docs/qh7RcF0RI6a~i9u3octdlg "REST (REpresentational State Transfer) is a simple stateless architecture that provides standards between computer systems on the web, making it easier for them to communicate with each other.").
{#attachment-PUT-attributes__table_fnw_xy1_g3c__entry__2}{#attachment-PUT-attributes__accept-RESTAPI}{#attachment-PUT-attributes__content_type-RESTAPI}

| 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 |
[Table 77. Request headers]

{#attachment-PUT-attributes__table_fnw_xy1_g3c} {#attachment-PUT-attributes__entry__24}

| Header | Description |
|-|-|
| None |   |
[Table 78. Response headers]

### 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://www.servicenow.com/docs/qh7RcF0RI6a~i9u3octdlg "REST (REpresentational State Transfer) is a simple stateless architecture that provides standards between computer systems on the web, making it easier for them to communicate with each other.").
{#attachment-PUT-attributes__table_ksv_b3b_g3c__entry__2}{#attachment-PUT-attributes__entry-200-status-code}{#attachment-PUT-attributes__entry-400-status-code}{#attachment-PUT-attributes__entry-404-status-code}

| 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. |
[Table 79. Status codes]

{#attachment-PUT-attributes__table_ksv_b3b_g3c}

### Response body parameters (JSON or XML) {#attachment-PUT-attributes__section_smm_qw3_g3c}

{#attachment-PUT-attributes__table_tmm_qw3_g3c__entry__2}

| Name | Description |
|-|-|
| result | Object containing the key-value pair for the attribute. Data type: Object "result": { "key": "String", "value": "String" } |
| 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 |
[ ]

{#attachment-PUT-attributes__table_tmm_qw3_g3c}  

### 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"
      }
    }