HTTP Headers

Breaking Down HTTP Headers

The following table lists the custom API request and response headers that are used for Verto APIs. Besides these custom headers, certain standard HTTPS headers are used as well. You can read more about the Standard HTTPS header field definitions here.

API Request Headers

HTTP Request Header Field

Description

Sample Value

Accept (Optional)

Indicates a data type expected in a response sent from the server, so it's used as a response header

application/json, text/plain

Accept-Encoding
(Optional)

List of acceptable encodings. This restricts the content-codings that are acceptable in the response. Currently, Verto APIs support gzip, deflate, br, and zstd. See HTTP compression.

gzip, deflate, br, zstd

Accept-Language
(Optional)

Language in which you want to receive the response.

en-GB,en-US

Authorization
(Optional)

Allows internet users to access applications, services, websites, and application programming interfaces (APIs) without having to enter their login credentials each time they visit.

eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJtZmFUaW1lb3V0Ijo2MCwiand0VXNlckFnZW50IjoiTW96aWxsYS81LjAgKFdpbmRvd3MgTlQgMTAuMDsgV2luNjQ7IHg2NCkgQXBwbGVXZWJLaXQvNTM3LjM2IChLSFRNTCwgbGlrZSBHZWNrbykgQ2hyb21lLzEyNS4wLjAuMCBTYWZhcmkvNTM3LjM2Iiwiand0U291cmNlSXAiOiIxMDMuMTMzLjE1OC4xNzMiLCJsb2dpbk1vZGUiOiJlbWFpbCIsIm1mYSI6IjEyMzEzMiIsImlkIjozNzA1LCJjb21wYW55SWQiOjMyMDgsInByb2ZpbGVJZCI6MzcwNSwidXNlclJlY29yZElkIjozNjY1LCJyb2xlIjoiTk9STUFMX0NMSUVOVCIsInJvbGVOYW1lIjoiTm9ybWFsIFVzZXIiLCJyZWZlcmVuY2UiOiJWVS0yNzA1MjAyNC0zMTk1LVUxIiwicHJvZmlsZVJlZmVyZW5jZSI6IlZVLTI3MDUyMDI0LTMxOTUtVTEiLCJjb21wYW55UmVmZXJlbmNlIjoiVlUtMjcwNTIwMjQtMzE5NSIsImNvbXBhbnlOYW1lIjoiQWxvayBUZXN0IDIiLCJyYXRlTGltaXQiOjE1MDAsImlhdCI6MTcxODA4ODc1NSwiZXhwIjoxNzE4MTc1MTU1fQ.UbM2zH85JRPPw4e30LEoRNQa0fjz3O3uYbOMVpRVdQ8

Content-Type
(Optional)

This is used to identify the type of request. Currently, Verto APIs support only application/json.

application/json

Vfx-Correlation-Id
(Optional)

Unique ID that is used to track calls made in the same session

0e924cdf-c0aa-4673-bb36-2262325ed30b

API Response Headers

HTTP Response Header FieldDescriptionSample Value
Content-TypeThis is used to identify the type of request. Currently, Verto APIs support only application/json.application/json; charset=utf-8
Vfx-Api-Call-IdA unique verto identifier that's automatically generated for each api call (also known as API request).df96e634-0d34-4882-14c4-dee1f0bf25e2
Vfx-Api-Stack-IdThe identifier for the specific API stack being utilized.34d13709-1964-364c-f9f4-2f15d823203e
Vfx-Correlation-IdA unique verto identifier that's automatically generated for each request that enters a system. It is used to track the request as it makes its way through the system.0e924cdf-c0aa-4673-bb36-2262325ed30b