---
sourceDocument: Australia API Reference
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/api-reference

 Release :

    - australia

ft:locale :

    - en-US

ft:publication_title :

    - Australia API Reference

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# Associate a request header with a resource

# Associate a request header with a resource {#ariaid-title1}

Release version: Australia  
Updated March 12, 2026  
![](https://www.servicenow.com/docs/portal-asset/ico-clock) 1 minute to read  
Define which request headers are expected for each resource within a scripted REST API.

## Before you begin

A REST API resource and a request header must already be defined within the scripted REST API.

Role required: web_service_admin

## About this task

The following procedure describes the process for manually associating a REST API request header with a resource. For details about automatically generating request header definitions in non-production instances, see [Automatically generate API request definitions](https://servicenow-prod.fluidtopics.net/PMIDsmNMHbcgTE5adyjmIg "Use sample requests made to an API resource to generate request header associations, query parameter associations, and a request schema for that resource.").

## Procedure

1. Create a Scripted REST Header Association record in one of the following ways

   | Option | Procedure |
   | Navigate through a scripted REST API record | 1. Navigate to AllSystem Web ServicesScripted REST APIs. 2. Select a scripted REST API record. 3. In the Resources related list, select a resource. 4. In the Request Header Associations tab, select New. {#associate-header-api-resource__ol_hr1_pyc_j3c} |
   | Navigate directly to a new Scripted REST Header Association record | Navigate to AllFilter and enter <kbd class="ph userinput">sys_ws_header_map.form</kbd>. |
   |-|-|

   {#associate-header-api-resource__choicetable_fv4_myc_j3c}
2. In the API request header field, select or enter the request header to associate with the resource.
3. **Optional:** In the API resource field, select or enter the API resource the request header should be associated with.  
   If you navigated to a new Scripted REST Header Association record through a scripted REST API record, API resource is pre-populated.
4. Select Submit.

## Result

The request headers that you added are included in the exportable OpenAPI specification in the REST API Explorer with a "type: string" schema definition. For more information about exporting OpenAPI specifications, see [Export to OpenAPI specification](https://servicenow-prod.fluidtopics.net/VM1BPwWaXiyDxp0N9N0zPg "Export a REST API as an OpenAPI specification to import it into another web services tool.").

*[\>]: and then