API Headers

A header specifies details about the API request and response.

Overview

In an API call, a header provides additional information about your request and preferred response, such as your authorization to access the endpoint and the format to return in the response.

Accept

The content type that you want the API response returned in. Supported in all Data Query API endpoints. Valid values are application/json, application/jsonlines, or text/csv. Default is application/json.

Accept-Language

The language that you're sending in the API request body. Use this header in PATCH calls to localize basic information, such as display names, descriptions, and explanations. You can specify one language per API call. Use any of the following language codes:

  • en: English (United States). This is the default.
  • fr: French
  • de: German
  • pt: Portguese (Brazil)
  • es: Spanish (Mexico)
  • es-ES: Spanish (Spain)

apikey

Your Visier API key. Required in all API calls. For more information, see Generate an API Key.

Authorization

The JWT for OAuth 2.0. Required in API calls using OAuth 2.0 authentication. For more information, see OAuth 2.0 with Open ID Connect (OIDC).

Content-Type

The content type that you're sending in the API request body. Default is application/json.

Cookie:VisierASIDToken

A security token. Required in API calls using basic authentication. For more information, see Basic authentication.

NonVersioned

If true, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If false, the API call executes on versioned artifacts and create/update actions release a new production version. Default is false. For more information, see Non-versioned security.

Note: Limited Availability This feature is in limited availability. If you are interested, please contact your Customer Success Manager.

ProjectID

The project UUID in which to make your changes. For more information, see Projects API.