HTTP Headers
REST APIs support the following HTTP headers.
Header | Description |
---|---|
Accept |
Content-Type that the response can accept. |
Accept-Encoding |
Encoding that the response can accept. |
Cache-Control |
The REST API configures this header for every HTTP response so that it can avoid using an intermediate proxy when it caches or stores the framework payload. It can include one of the following values:
|
Content-Type |
Media type of the body of the request. The REST API requires this header for each POST or PUT request. For example:
|
ETag |
If the resource changes, then the resource creates the ETag. The client can use ETag to control caching. |
If-Match |
Allows you to run a conditional request. |
If-None-Match |
Allows you to run a conditional request. |
Location |
Location in the response that identifies the URL of the new resource. The REST API adds this header when you create a new resource. |
X-HTTP-Method-Override |
Contains the name of the HTTP method. You can use this value to define the HTTP method. The REST API considers this header only in a POST method. This is a modified header that is not part of the HTTP specifications. |
X-ID-TENANT-NAME |
Identity domain name that the REST API uses to authenticate. For example:
|
X-Requested-By |
If you enable antiCSRF, then the REST API requires this header for every request, except with the following methods:
If the REST API cannot find this header, then it returns response 400, Bad Request. |