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

 Release :

    - xanadu

ft:locale :

    - en-US

ft:publication_title :

    - Xanadu API Reference

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# Define scripted REST API headers

# Define scripted REST API headers {#ariaid-title1}

* Release version: Xanadu
* 
* Updated August 1, 2024
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 1 minute to read

Define scripted REST API headers to control which headers the API accepts and can
respond with.

## Before you begin

There must be a scripted REST API defined before you can create headers.

Role
required: web_service_admin

## Procedure

1. Navigate to AllSystem Web ServicesScripted REST APIs.
2. Select a scripted REST API record.
3. In the Request Headers related list, select New.
4. Enter a Header name.
5. Enter a Short description and Example value to explain how to use the header.
6. Select Submit.
7. **Optional:** From the Request Headers tab, locate the header name and set Is required to "true" to document this request header as required.  
   Note:  
   If you set Is required to "true", the scripted REST service doesn't enforce requiring the header. To enforce requiring a header, you must add logic to the scripted REST API resource that rejects requests that are missing the required headers.
{#t_DefineRESTServiceHeaders__steps_dxp_5b4_bs}

## What to do next

After defining available headers, associate the headers with a scripted REST resource.

*[\>]: and then