Define scripted REST API headers

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 System Web Services > Scripted REST APIs.
  2. Select a scripted REST API record.
  3. In the Request Headers related list, click New.
  4. Enter a Header name.
  5. (Optional) Select Is required to make this header mandatory for all requests to associated scripted REST resources.
  6. Enter a Short description and Example value to explain how to use the header.
  7. Click Submit.

What to do next

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