Get all global variables

GET https://api.ap1.datadoghq.com/api/v1/synthetics/variableshttps://api.ap2.datadoghq.com/api/v1/synthetics/variableshttps://api.datadoghq.eu/api/v1/synthetics/variableshttps://api.ddog-gov.com/api/v1/synthetics/variableshttps://api.us2.ddog-gov.com/api/v1/synthetics/variableshttps://api.datadoghq.com/api/v1/synthetics/variableshttps://api.us3.datadoghq.com/api/v1/synthetics/variableshttps://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 to access this endpoint.

    Response

    OK

    Object containing an array of Synthetic global variables.

    Expand All

    Field

    Type

    Description

    variables

    [object]

    Array of Synthetic global variables.

    attributes

    object

    Attributes of the global variable.

    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.

    description [required]

    string

    Description of the global variable.

    id

    string

    Unique identifier of the global variable.

    is_fido

    boolean

    Determines if the global variable is a FIDO variable.

    is_totp

    boolean

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

    name [required]

    string

    Name of the global variable. Unique across Synthetic global 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.

    field

    string

    When type is http_header, name of the header to use to extract the value.

    localVariableName

    string

    When type is local_variable, name of the local variable to use to extract the value.

    parser

    object

    Details of the parser to use for the global variable.

    type [required]

    enum

    Type of parser for a Synthetic global variable from a synthetics test. Allowed enum values: raw,json_path,regex,x_path

    value

    string

    Regex or JSON path used for the parser. Not used with type raw.

    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

    parse_test_public_id

    string

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

    tags [required]

    [string]

    Tags of the global variable.

    value [required]

    object

    Value of the global variable.

    options

    object

    Options for the Global Variable for MFA.

    totp_parameters

    object

    Parameters for the TOTP/MFA variable

    digits

    int32

    Number of digits for the OTP code.

    refresh_interval

    int32

    Interval for which to refresh the token (in seconds).

    secure

    boolean

    Determines if the value of the variable is hidden.

    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.

    {
      "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"
          }
        }
      ]
    }

    Forbidden

    Error response object.

    Expand All

    Field

    Type

    Description

    errors [required]

    [string]

    Array of errors returned by the API.

    {
      "errors": [
        "Bad Request"
      ]
    }

    Too many requests

    Error response object.

    Expand All

    Field

    Type

    Description

    errors [required]

    [string]

    Array of errors returned by the API.

    {
      "errors": [
        "Bad Request"
      ]
    }

    Code Example

                      # Curl command
    curl -X GET "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.us2.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v1/synthetics/variables" \ -H "Accept: application/json" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -H "DD-APPLICATION-KEY: ${DD_APP_KEY}"
    """
    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 and then save the example to example.py and run following commands:

        
    DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" python3 "example.py"
    # 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 and then save the example to example.rb and run following commands:

        
    DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" rb "example.rb"
    // 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 and then save the example to main.go and run following commands:

        
    DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" go run "main.go"
    // 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 and then save the example to Example.java and run following commands:

        
    DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" java "Example.java"
    // 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 and then save the example to src/main.rs and run following commands:

        
    DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo run
    /**
     * 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 and then save the example to example.ts and run following commands:

        
    DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" tsc "example.ts"