--- title: Get all global variables description: Datadog, the leading service for cloud-scale monitoring. breadcrumbs: Docs > API Reference > Synthetics --- # Get all global variables{% #get-all-global-variables %} Copy pageCopied {% tab title="v1" %} | Datadog site | API endpoint | | ----------------- | ------------------------------------------------------------- | | ap1.datadoghq.com | GET https://api.ap1.datadoghq.com/api/v1/synthetics/variables | | ap2.datadoghq.com | GET https://api.ap2.datadoghq.com/api/v1/synthetics/variables | | app.datadoghq.eu | GET https://api.datadoghq.eu/api/v1/synthetics/variables | | app.ddog-gov.com | GET https://api.ddog-gov.com/api/v1/synthetics/variables | | us2.ddog-gov.com | GET https://api.us2.ddog-gov.com/api/v1/synthetics/variables | | app.datadoghq.com | GET https://api.datadoghq.com/api/v1/synthetics/variables | | us3.datadoghq.com | GET https://api.us3.datadoghq.com/api/v1/synthetics/variables | | us5.datadoghq.com | GET https://api.us5.datadoghq.com/api/v1/synthetics/variables | ### Overview Get the list of all Synthetic global variables. This endpoint requires any of the following permissions: `synthetics_global_variable_read``apm_api_catalog_read` OAuth apps require the `apm_api_catalog_read` authorization [scope](https://docs.datadoghq.com/api/latest/scopes.md#synthetics) to access this endpoint. ### Response {% tab title="200" %} OK {% tab title="Model" %} Object containing an array of Synthetic global variables. | Parent field | Field | Type | Description | | ------------------ | ----------------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | | variables | [object] | Array of Synthetic global variables. | | variables | attributes | object | Attributes of the global variable. | | attributes | restricted_roles | [string] | **DEPRECATED**: A list of role identifiers that can be pulled from the Roles API, for restricting read and write access. This field is deprecated. Use the restriction policies API to manage permissions. | | variables | description [*required*] | string | Description of the global variable. | | variables | id | string | Unique identifier of the global variable. | | variables | is_fido | boolean | Determines if the global variable is a FIDO variable. | | variables | is_totp | boolean | Determines if the global variable is a TOTP/MFA variable. | | variables | name [*required*] | string | Name of the global variable. Unique across Synthetic global variables. | | variables | parse_test_options | object | Parser options to use for retrieving a Synthetic global variable from a Synthetic test. Used in conjunction with `parse_test_public_id`. | | parse_test_options | field | string | When type is `http_header`, name of the header to use to extract the value. | | parse_test_options | localVariableName | string | When type is `local_variable`, name of the local variable to use to extract the value. | | parse_test_options | parser | object | Details of the parser to use for the global variable. | | parser | type [*required*] | enum | Type of parser for a Synthetic global variable from a synthetics test. Allowed enum values: `raw,json_path,regex,x_path` | | parser | value | string | Regex or JSON path used for the parser. Not used with type `raw`. | | parse_test_options | type [*required*] | enum | Type of value to extract from a test for a Synthetic global variable. Allowed enum values: `http_body,http_header,http_status_code,local_variable` | | variables | parse_test_public_id | string | A Synthetic test ID to use as a test to generate the variable value. | | variables | tags [*required*] | [string] | Tags of the global variable. | | variables | value [*required*] | object | Value of the global variable. | | value | options | object | Options for the Global Variable for MFA. | | options | totp_parameters | object | Parameters for the TOTP/MFA variable | | totp_parameters | digits | int32 | Number of digits for the OTP code. | | totp_parameters | refresh_interval | int32 | Interval for which to refresh the token (in seconds). | | value | secure | boolean | Determines if the value of the variable is hidden. | | value | value | string | Value of the global variable. When reading a global variable, the value will not be present if the variable is hidden with the `secure` property. | {% /tab %} {% tab title="Example" %} ```json { "variables": [ { "attributes": { "restricted_roles": [ "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" ] }, "description": "Example description", "id": "string", "is_fido": false, "is_totp": false, "name": "MY_VARIABLE", "parse_test_options": { "field": "content-type", "localVariableName": "LOCAL_VARIABLE", "parser": { "type": "raw", "value": "string" }, "type": "http_body" }, "parse_test_public_id": "abc-def-123", "tags": [ "team:front", "test:workflow-1" ], "value": { "options": { "totp_parameters": { "digits": 6, "refresh_interval": 30 } }, "secure": false, "value": "example-value" } } ] } ``` {% /tab %} {% /tab %} {% tab title="403" %} Forbidden {% tab title="Model" %} Error response object. | Field | Type | Description | | ------------------------ | -------- | ------------------------------------ | | errors [*required*] | [string] | Array of errors returned by the API. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} {% tab title="429" %} Too many requests {% tab title="Model" %} Error response object. | Field | Type | Description | | ------------------------ | -------- | ------------------------------------ | | errors [*required*] | [string] | Array of errors returned by the API. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} ### Code Example ##### \# Curl command curl -X GET "https://api.datadoghq.com/api/v1/synthetics/variables" \ -H "Accept: application/json" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -H "DD-APPLICATION-KEY: ${DD_APP_KEY}" ##### ```python """ Get all global variables returns "OK" response """ from datadog_api_client import ApiClient, Configuration from datadog_api_client.v1.api.synthetics_api import SyntheticsApi configuration = Configuration() with ApiClient(configuration) as api_client: api_instance = SyntheticsApi(api_client) response = api_instance.list_global_variables() print(response) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=python) and then save the example to `example.py` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" python3 "example.py" ##### ```ruby # Get all global variables returns "OK" response require "datadog_api_client" api_instance = DatadogAPIClient::V1::SyntheticsAPI.new p api_instance.list_global_variables() ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=ruby) and then save the example to `example.rb` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" rb "example.rb" ##### ```go // Get all global variables returns "OK" response package main import ( "context" "encoding/json" "fmt" "os" "github.com/DataDog/datadog-api-client-go/v2/api/datadog" "github.com/DataDog/datadog-api-client-go/v2/api/datadogV1" ) func main() { ctx := datadog.NewDefaultContext(context.Background()) configuration := datadog.NewConfiguration() apiClient := datadog.NewAPIClient(configuration) api := datadogV1.NewSyntheticsApi(apiClient) resp, r, err := api.ListGlobalVariables(ctx) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `SyntheticsApi.ListGlobalVariables`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `SyntheticsApi.ListGlobalVariables`:\n%s\n", responseContent) } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=go) and then save the example to `main.go` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" go run "main.go" ##### ```java // Get all global variables returns "OK" response import com.datadog.api.client.ApiClient; import com.datadog.api.client.ApiException; import com.datadog.api.client.v1.api.SyntheticsApi; import com.datadog.api.client.v1.model.SyntheticsListGlobalVariablesResponse; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); SyntheticsApi apiInstance = new SyntheticsApi(defaultClient); try { SyntheticsListGlobalVariablesResponse result = apiInstance.listGlobalVariables(); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling SyntheticsApi#listGlobalVariables"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=java) and then save the example to `Example.java` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" java "Example.java" ##### ```rust // Get all global variables returns "OK" response use datadog_api_client::datadog; use datadog_api_client::datadogV1::api_synthetics::SyntheticsAPI; #[tokio::main] async fn main() { let configuration = datadog::Configuration::new(); let api = SyntheticsAPI::with_config(configuration); let resp = api.list_global_variables().await; if let Ok(value) = resp { println!("{:#?}", value); } else { println!("{:#?}", resp.unwrap_err()); } } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=rust) and then save the example to `src/main.rs` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" cargo run ##### ```typescript /** * Get all global variables returns "OK" response */ import { client, v1 } from "@datadog/datadog-api-client"; const configuration = client.createConfiguration(); const apiInstance = new v1.SyntheticsApi(configuration); apiInstance .listGlobalVariables() .then((data: v1.SyntheticsListGlobalVariablesResponse) => { console.log( "API called successfully. Returned data: " + JSON.stringify(data) ); }) .catch((error: any) => console.error(error)); ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=typescript) and then save the example to `example.ts` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" tsc "example.ts" {% /tab %}