DAdatadog
Synthetics

Get a global variable

Get the detailed configuration of a global variable.

get/api/v1/synthetics/variables/{variable_id}

Request

  • Base URL
    https://api.datadoghq.com
  • URL
    https://api.datadoghq.com/api/v1/synthetics/variables/{variable_id}
  • Auth
    • API key in header DD-API-KEY and API key in header DD-APPLICATION-KEY
    • or OAuth 2
      Authorization code: /oauth2/v1/authorize
      Token URL: /oauth2/v1/token scopes: synthetics_global_variable_read

Path parameters

variable_idstring required

The ID of the global variable.

Response

OK

descriptionstring required

Description of the global variable.

idstring

Unique identifier of the global variable.

is_fidoboolean

Determines if the global variable is a FIDO variable.

is_totpboolean

Determines if the global variable is a TOTP/MFA variable.

namestring required

Name of the global variable. Unique across Synthetic global variables.

parse_test_public_idstring

A Synthetic test ID to use as a test to generate the variable value.

tagsstring[] required

Tags of the global variable.

Example response

{
  "attributes": {
    "restricted_roles": [
      "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
    ]
  },
  "description": "Example description",
  "name": "MY_VARIABLE",
  "parse_test_options": {
    "field": "content-type",
    "localVariableName": "LOCAL_VARIABLE",
    "parser": {
      "type": "regex",
      "value": ".*"
    },
    "type": "http_body"
  },
  "parse_test_public_id": "abc-def-123",
  "tags": [
    "team:front",
    "test:workflow-1"
  ],
  "value": {
    "secure": true,
    "value": "value"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.