--- title: Create a global variable description: Datadog, the leading service for cloud-scale monitoring. breadcrumbs: Docs > API Reference > Synthetics --- # Create a global variable{% #create-a-global-variable %} {% tab title="v1" %} | Datadog site | API endpoint | | ----------------- | -------------------------------------------------------------- | | ap1.datadoghq.com | POST https://api.ap1.datadoghq.com/api/v1/synthetics/variables | | ap2.datadoghq.com | POST https://api.ap2.datadoghq.com/api/v1/synthetics/variables | | app.datadoghq.eu | POST https://api.datadoghq.eu/api/v1/synthetics/variables | | app.ddog-gov.com | POST https://api.ddog-gov.com/api/v1/synthetics/variables | | us2.ddog-gov.com | POST https://api.us2.ddog-gov.com/api/v1/synthetics/variables | | app.datadoghq.com | POST https://api.datadoghq.com/api/v1/synthetics/variables | | us3.datadoghq.com | POST https://api.us3.datadoghq.com/api/v1/synthetics/variables | | us5.datadoghq.com | POST https://api.us5.datadoghq.com/api/v1/synthetics/variables | ### Overview Create a Synthetic global variable. This endpoint requires the `synthetics_global_variable_write` permission. OAuth apps require the `synthetics_global_variable_write` authorization [scope](https://docs.datadoghq.com/api/latest/scopes.md#synthetics) to access this endpoint. ### Request #### Body Data (required) Details of the global variable to create. {% tab title="Model" %} | Parent field | Field | Type | Description | | ------------------ | ----------------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | | 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. | | | 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`. | | 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` | | | 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 | 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 { "description": "", "is_fido": true, "name": "GLOBAL_VARIABLE_FIDO_PAYLOAD_EXAMPLESYNTHETIC", "tags": [] } ``` ##### ```json { "description": "", "is_totp": true, "name": "GLOBAL_VARIABLE_TOTP_PAYLOAD_EXAMPLESYNTHETIC", "tags": [], "value": { "secure": false, "value": "", "options": { "totp_parameters": { "digits": 6, "refresh_interval": 30 } } } } ``` ##### ```json { "description": "", "name": "GLOBAL_VARIABLE_FROM_TEST_PAYLOAD_EXAMPLESYNTHETIC", "tags": [], "value": { "secure": false, "value": "" }, "parse_test_public_id": "123-abc-456", "parse_test_options": { "type": "local_variable", "localVariableName": "EXTRACTED_VALUE" } } ``` {% /tab %} ### Response {% tab title="200" %} OK {% tab title="Model" %} Synthetic global variable. | Parent field | Field | Type | Description | | ------------------ | ----------------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | | 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. | | | 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`. | | 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` | | | 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. | | 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 { "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="400" %} Invalid request {% 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="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="409" %} Conflict {% 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 ##### \## default # \# Curl command curl -X POST "https://api.datadoghq.com/api/v1/synthetics/variables" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \ -d @- << EOF { "description": "Example description", "name": "MY_VARIABLE", "tags": [ "team:front", "test:workflow-1" ], "value": { "secure": false, "value": "variable-value" } } EOF ##### \## default # \# Curl command curl -X POST "https://api.datadoghq.com/api/v1/synthetics/variables" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \ -d @- << EOF { "description": "Example description", "name": "MY_VARIABLE", "tags": [ "team:front", "test:workflow-1" ], "value": { "secure": false, "value": "variable-value" } } EOF ##### \## default # \# Curl command curl -X POST "https://api.datadoghq.com/api/v1/synthetics/variables" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \ -d @- << EOF { "description": "Example description", "name": "MY_VARIABLE", "tags": [ "team:front", "test:workflow-1" ], "value": { "secure": false, "value": "variable-value" } } EOF ##### ```go // Create a FIDO global variable 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() { body := datadogV1.SyntheticsGlobalVariableRequest{ Description: "", IsFido: datadog.PtrBool(true), Name: "GLOBAL_VARIABLE_FIDO_PAYLOAD_EXAMPLESYNTHETIC", Tags: []string{}, } ctx := datadog.NewDefaultContext(context.Background()) configuration := datadog.NewConfiguration() apiClient := datadog.NewAPIClient(configuration) api := datadogV1.NewSyntheticsApi(apiClient) resp, r, err := api.CreateGlobalVariable(ctx, body) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `SyntheticsApi.CreateGlobalVariable`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `SyntheticsApi.CreateGlobalVariable`:\n%s\n", responseContent) } ``` ##### ```go // Create a TOTP global variable 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() { body := datadogV1.SyntheticsGlobalVariableRequest{ Description: "", IsTotp: datadog.PtrBool(true), Name: "GLOBAL_VARIABLE_TOTP_PAYLOAD_EXAMPLESYNTHETIC", Tags: []string{}, Value: &datadogV1.SyntheticsGlobalVariableValue{ Secure: datadog.PtrBool(false), Value: datadog.PtrString(""), Options: &datadogV1.SyntheticsGlobalVariableOptions{ TotpParameters: &datadogV1.SyntheticsGlobalVariableTOTPParameters{ Digits: datadog.PtrInt32(6), RefreshInterval: datadog.PtrInt32(30), }, }, }, } ctx := datadog.NewDefaultContext(context.Background()) configuration := datadog.NewConfiguration() apiClient := datadog.NewAPIClient(configuration) api := datadogV1.NewSyntheticsApi(apiClient) resp, r, err := api.CreateGlobalVariable(ctx, body) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `SyntheticsApi.CreateGlobalVariable`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `SyntheticsApi.CreateGlobalVariable`:\n%s\n", responseContent) } ``` ##### ```go // Create a global variable from test 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() { // there is a valid "synthetics_api_test_multi_step" in the system SyntheticsAPITestMultiStepPublicID := os.Getenv("SYNTHETICS_API_TEST_MULTI_STEP_PUBLIC_ID") body := datadogV1.SyntheticsGlobalVariableRequest{ Description: "", Name: "GLOBAL_VARIABLE_FROM_TEST_PAYLOAD_EXAMPLESYNTHETIC", Tags: []string{}, Value: &datadogV1.SyntheticsGlobalVariableValue{ Secure: datadog.PtrBool(false), Value: datadog.PtrString(""), }, ParseTestPublicId: datadog.PtrString(SyntheticsAPITestMultiStepPublicID), ParseTestOptions: &datadogV1.SyntheticsGlobalVariableParseTestOptions{ Type: datadogV1.SYNTHETICSGLOBALVARIABLEPARSETESTOPTIONSTYPE_LOCAL_VARIABLE, LocalVariableName: datadog.PtrString("EXTRACTED_VALUE"), }, } ctx := datadog.NewDefaultContext(context.Background()) configuration := datadog.NewConfiguration() apiClient := datadog.NewAPIClient(configuration) api := datadogV1.NewSyntheticsApi(apiClient) resp, r, err := api.CreateGlobalVariable(ctx, body) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `SyntheticsApi.CreateGlobalVariable`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `SyntheticsApi.CreateGlobalVariable`:\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 // Create a FIDO global variable 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.SyntheticsGlobalVariable; import com.datadog.api.client.v1.model.SyntheticsGlobalVariableRequest; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); SyntheticsApi apiInstance = new SyntheticsApi(defaultClient); SyntheticsGlobalVariableRequest body = new SyntheticsGlobalVariableRequest() .description("") .isFido(true) .name("GLOBAL_VARIABLE_FIDO_PAYLOAD_EXAMPLESYNTHETIC"); try { SyntheticsGlobalVariable result = apiInstance.createGlobalVariable(body); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling SyntheticsApi#createGlobalVariable"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ##### ```java // Create a TOTP global variable 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.SyntheticsGlobalVariable; import com.datadog.api.client.v1.model.SyntheticsGlobalVariableOptions; import com.datadog.api.client.v1.model.SyntheticsGlobalVariableRequest; import com.datadog.api.client.v1.model.SyntheticsGlobalVariableTOTPParameters; import com.datadog.api.client.v1.model.SyntheticsGlobalVariableValue; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); SyntheticsApi apiInstance = new SyntheticsApi(defaultClient); SyntheticsGlobalVariableRequest body = new SyntheticsGlobalVariableRequest() .description("") .isTotp(true) .name("GLOBAL_VARIABLE_TOTP_PAYLOAD_EXAMPLESYNTHETIC") .value( new SyntheticsGlobalVariableValue() .secure(false) .value("") .options( new SyntheticsGlobalVariableOptions() .totpParameters( new SyntheticsGlobalVariableTOTPParameters() .digits(6) .refreshInterval(30)))); try { SyntheticsGlobalVariable result = apiInstance.createGlobalVariable(body); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling SyntheticsApi#createGlobalVariable"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ##### ```java // Create a global variable from test 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.SyntheticsGlobalVariable; import com.datadog.api.client.v1.model.SyntheticsGlobalVariableParseTestOptions; import com.datadog.api.client.v1.model.SyntheticsGlobalVariableParseTestOptionsType; import com.datadog.api.client.v1.model.SyntheticsGlobalVariableRequest; import com.datadog.api.client.v1.model.SyntheticsGlobalVariableValue; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); SyntheticsApi apiInstance = new SyntheticsApi(defaultClient); // there is a valid "synthetics_api_test_multi_step" in the system String SYNTHETICS_API_TEST_MULTI_STEP_PUBLIC_ID = System.getenv("SYNTHETICS_API_TEST_MULTI_STEP_PUBLIC_ID"); SyntheticsGlobalVariableRequest body = new SyntheticsGlobalVariableRequest() .description("") .name("GLOBAL_VARIABLE_FROM_TEST_PAYLOAD_EXAMPLESYNTHETIC") .value(new SyntheticsGlobalVariableValue().secure(false).value("")) .parseTestPublicId(SYNTHETICS_API_TEST_MULTI_STEP_PUBLIC_ID) .parseTestOptions( new SyntheticsGlobalVariableParseTestOptions() .type(SyntheticsGlobalVariableParseTestOptionsType.LOCAL_VARIABLE) .localVariableName("EXTRACTED_VALUE")); try { SyntheticsGlobalVariable result = apiInstance.createGlobalVariable(body); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling SyntheticsApi#createGlobalVariable"); 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" ##### ```python """ Create a FIDO global variable returns "OK" response """ from datadog_api_client import ApiClient, Configuration from datadog_api_client.v1.api.synthetics_api import SyntheticsApi from datadog_api_client.v1.model.synthetics_global_variable_request import SyntheticsGlobalVariableRequest body = SyntheticsGlobalVariableRequest( description="", is_fido=True, name="GLOBAL_VARIABLE_FIDO_PAYLOAD_EXAMPLESYNTHETIC", tags=[], ) configuration = Configuration() with ApiClient(configuration) as api_client: api_instance = SyntheticsApi(api_client) response = api_instance.create_global_variable(body=body) print(response) ``` ##### ```python """ Create a TOTP global variable returns "OK" response """ from datadog_api_client import ApiClient, Configuration from datadog_api_client.v1.api.synthetics_api import SyntheticsApi from datadog_api_client.v1.model.synthetics_global_variable_options import SyntheticsGlobalVariableOptions from datadog_api_client.v1.model.synthetics_global_variable_request import SyntheticsGlobalVariableRequest from datadog_api_client.v1.model.synthetics_global_variable_totp_parameters import ( SyntheticsGlobalVariableTOTPParameters, ) from datadog_api_client.v1.model.synthetics_global_variable_value import SyntheticsGlobalVariableValue body = SyntheticsGlobalVariableRequest( description="", is_totp=True, name="GLOBAL_VARIABLE_TOTP_PAYLOAD_EXAMPLESYNTHETIC", tags=[], value=SyntheticsGlobalVariableValue( secure=False, value="", options=SyntheticsGlobalVariableOptions( totp_parameters=SyntheticsGlobalVariableTOTPParameters( digits=6, refresh_interval=30, ), ), ), ) configuration = Configuration() with ApiClient(configuration) as api_client: api_instance = SyntheticsApi(api_client) response = api_instance.create_global_variable(body=body) print(response) ``` ##### ```python """ Create a global variable from test returns "OK" response """ from os import environ from datadog_api_client import ApiClient, Configuration from datadog_api_client.v1.api.synthetics_api import SyntheticsApi from datadog_api_client.v1.model.synthetics_global_variable_parse_test_options import ( SyntheticsGlobalVariableParseTestOptions, ) from datadog_api_client.v1.model.synthetics_global_variable_parse_test_options_type import ( SyntheticsGlobalVariableParseTestOptionsType, ) from datadog_api_client.v1.model.synthetics_global_variable_request import SyntheticsGlobalVariableRequest from datadog_api_client.v1.model.synthetics_global_variable_value import SyntheticsGlobalVariableValue # there is a valid "synthetics_api_test_multi_step" in the system SYNTHETICS_API_TEST_MULTI_STEP_PUBLIC_ID = environ["SYNTHETICS_API_TEST_MULTI_STEP_PUBLIC_ID"] body = SyntheticsGlobalVariableRequest( description="", name="GLOBAL_VARIABLE_FROM_TEST_PAYLOAD_EXAMPLESYNTHETIC", tags=[], value=SyntheticsGlobalVariableValue( secure=False, value="", ), parse_test_public_id=SYNTHETICS_API_TEST_MULTI_STEP_PUBLIC_ID, parse_test_options=SyntheticsGlobalVariableParseTestOptions( type=SyntheticsGlobalVariableParseTestOptionsType.LOCAL_VARIABLE, local_variable_name="EXTRACTED_VALUE", ), ) configuration = Configuration() with ApiClient(configuration) as api_client: api_instance = SyntheticsApi(api_client) response = api_instance.create_global_variable(body=body) 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 # Create a FIDO global variable returns "OK" response require "datadog_api_client" api_instance = DatadogAPIClient::V1::SyntheticsAPI.new body = DatadogAPIClient::V1::SyntheticsGlobalVariableRequest.new({ description: "", is_fido: true, name: "GLOBAL_VARIABLE_FIDO_PAYLOAD_EXAMPLESYNTHETIC", tags: [], }) p api_instance.create_global_variable(body) ``` ##### ```ruby # Create a TOTP global variable returns "OK" response require "datadog_api_client" api_instance = DatadogAPIClient::V1::SyntheticsAPI.new body = DatadogAPIClient::V1::SyntheticsGlobalVariableRequest.new({ description: "", is_totp: true, name: "GLOBAL_VARIABLE_TOTP_PAYLOAD_EXAMPLESYNTHETIC", tags: [], value: DatadogAPIClient::V1::SyntheticsGlobalVariableValue.new({ secure: false, value: "", options: DatadogAPIClient::V1::SyntheticsGlobalVariableOptions.new({ totp_parameters: DatadogAPIClient::V1::SyntheticsGlobalVariableTOTPParameters.new({ digits: 6, refresh_interval: 30, }), }), }), }) p api_instance.create_global_variable(body) ``` ##### ```ruby # Create a global variable from test returns "OK" response require "datadog_api_client" api_instance = DatadogAPIClient::V1::SyntheticsAPI.new # there is a valid "synthetics_api_test_multi_step" in the system SYNTHETICS_API_TEST_MULTI_STEP_PUBLIC_ID = ENV["SYNTHETICS_API_TEST_MULTI_STEP_PUBLIC_ID"] body = DatadogAPIClient::V1::SyntheticsGlobalVariableRequest.new({ description: "", name: "GLOBAL_VARIABLE_FROM_TEST_PAYLOAD_EXAMPLESYNTHETIC", tags: [], value: DatadogAPIClient::V1::SyntheticsGlobalVariableValue.new({ secure: false, value: "", }), parse_test_public_id: SYNTHETICS_API_TEST_MULTI_STEP_PUBLIC_ID, parse_test_options: DatadogAPIClient::V1::SyntheticsGlobalVariableParseTestOptions.new({ type: DatadogAPIClient::V1::SyntheticsGlobalVariableParseTestOptionsType::LOCAL_VARIABLE, local_variable_name: "EXTRACTED_VALUE", }), }) p api_instance.create_global_variable(body) ``` #### 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" ##### ```rust // Create a FIDO global variable returns "OK" response use datadog_api_client::datadog; use datadog_api_client::datadogV1::api_synthetics::SyntheticsAPI; use datadog_api_client::datadogV1::model::SyntheticsGlobalVariableRequest; #[tokio::main] async fn main() { let body = SyntheticsGlobalVariableRequest::new( "".to_string(), "GLOBAL_VARIABLE_FIDO_PAYLOAD_EXAMPLESYNTHETIC".to_string(), vec![], ) .is_fido(true); let configuration = datadog::Configuration::new(); let api = SyntheticsAPI::with_config(configuration); let resp = api.create_global_variable(body).await; if let Ok(value) = resp { println!("{:#?}", value); } else { println!("{:#?}", resp.unwrap_err()); } } ``` ##### ```rust // Create a TOTP global variable returns "OK" response use datadog_api_client::datadog; use datadog_api_client::datadogV1::api_synthetics::SyntheticsAPI; use datadog_api_client::datadogV1::model::SyntheticsGlobalVariableOptions; use datadog_api_client::datadogV1::model::SyntheticsGlobalVariableRequest; use datadog_api_client::datadogV1::model::SyntheticsGlobalVariableTOTPParameters; use datadog_api_client::datadogV1::model::SyntheticsGlobalVariableValue; #[tokio::main] async fn main() { let body = SyntheticsGlobalVariableRequest::new( "".to_string(), "GLOBAL_VARIABLE_TOTP_PAYLOAD_EXAMPLESYNTHETIC".to_string(), vec![], ) .is_totp(true) .value( SyntheticsGlobalVariableValue::new() .options( SyntheticsGlobalVariableOptions::new().totp_parameters( SyntheticsGlobalVariableTOTPParameters::new() .digits(6) .refresh_interval(30), ), ) .secure(false) .value("".to_string()), ); let configuration = datadog::Configuration::new(); let api = SyntheticsAPI::with_config(configuration); let resp = api.create_global_variable(body).await; if let Ok(value) = resp { println!("{:#?}", value); } else { println!("{:#?}", resp.unwrap_err()); } } ``` ##### ```rust // Create a global variable from test returns "OK" response use datadog_api_client::datadog; use datadog_api_client::datadogV1::api_synthetics::SyntheticsAPI; use datadog_api_client::datadogV1::model::SyntheticsGlobalVariableParseTestOptions; use datadog_api_client::datadogV1::model::SyntheticsGlobalVariableParseTestOptionsType; use datadog_api_client::datadogV1::model::SyntheticsGlobalVariableRequest; use datadog_api_client::datadogV1::model::SyntheticsGlobalVariableValue; #[tokio::main] async fn main() { // there is a valid "synthetics_api_test_multi_step" in the system let synthetics_api_test_multi_step_public_id = std::env::var("SYNTHETICS_API_TEST_MULTI_STEP_PUBLIC_ID").unwrap(); let body = SyntheticsGlobalVariableRequest::new( "".to_string(), "GLOBAL_VARIABLE_FROM_TEST_PAYLOAD_EXAMPLESYNTHETIC".to_string(), vec![], ) .parse_test_options( SyntheticsGlobalVariableParseTestOptions::new( SyntheticsGlobalVariableParseTestOptionsType::LOCAL_VARIABLE, ) .local_variable_name("EXTRACTED_VALUE".to_string()), ) .parse_test_public_id(synthetics_api_test_multi_step_public_id.clone()) .value( SyntheticsGlobalVariableValue::new() .secure(false) .value("".to_string()), ); let configuration = datadog::Configuration::new(); let api = SyntheticsAPI::with_config(configuration); let resp = api.create_global_variable(body).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 /** * Create a FIDO global variable returns "OK" response */ import { client, v1 } from "@datadog/datadog-api-client"; const configuration = client.createConfiguration(); const apiInstance = new v1.SyntheticsApi(configuration); const params: v1.SyntheticsApiCreateGlobalVariableRequest = { body: { description: "", isFido: true, name: "GLOBAL_VARIABLE_FIDO_PAYLOAD_EXAMPLESYNTHETIC", tags: [], }, }; apiInstance .createGlobalVariable(params) .then((data: v1.SyntheticsGlobalVariable) => { console.log( "API called successfully. Returned data: " + JSON.stringify(data) ); }) .catch((error: any) => console.error(error)); ``` ##### ```typescript /** * Create a TOTP global variable returns "OK" response */ import { client, v1 } from "@datadog/datadog-api-client"; const configuration = client.createConfiguration(); const apiInstance = new v1.SyntheticsApi(configuration); const params: v1.SyntheticsApiCreateGlobalVariableRequest = { body: { description: "", isTotp: true, name: "GLOBAL_VARIABLE_TOTP_PAYLOAD_EXAMPLESYNTHETIC", tags: [], value: { secure: false, value: "", options: { totpParameters: { digits: 6, refreshInterval: 30, }, }, }, }, }; apiInstance .createGlobalVariable(params) .then((data: v1.SyntheticsGlobalVariable) => { console.log( "API called successfully. Returned data: " + JSON.stringify(data) ); }) .catch((error: any) => console.error(error)); ``` ##### ```typescript /** * Create a global variable from test returns "OK" response */ import { client, v1 } from "@datadog/datadog-api-client"; const configuration = client.createConfiguration(); const apiInstance = new v1.SyntheticsApi(configuration); // there is a valid "synthetics_api_test_multi_step" in the system const SYNTHETICS_API_TEST_MULTI_STEP_PUBLIC_ID = process.env .SYNTHETICS_API_TEST_MULTI_STEP_PUBLIC_ID as string; const params: v1.SyntheticsApiCreateGlobalVariableRequest = { body: { description: "", name: "GLOBAL_VARIABLE_FROM_TEST_PAYLOAD_EXAMPLESYNTHETIC", tags: [], value: { secure: false, value: "", }, parseTestPublicId: SYNTHETICS_API_TEST_MULTI_STEP_PUBLIC_ID, parseTestOptions: { type: "local_variable", localVariableName: "EXTRACTED_VALUE", }, }, }; apiInstance .createGlobalVariable(params) .then((data: v1.SyntheticsGlobalVariable) => { 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 %}