--- title: Create Variable Declaration component: pingone-api-ea page_id: pingone-api-ea:platform:early-access/configuration-management/promotion-variables/create-variable-declaration canonical_url: https://developer.pingidentity.com/pingone-api-ea/platform/early-access/configuration-management/promotion-variables/create-variable-declaration.html section_ids: headers: Headers body: Body example-request: Example Request example-response: Example Response --- # Create Variable Declaration ##   ```none POST {{apiPath}}/v1/environments/{{envId}}/promotionVariableDeclarations ``` Use the POST `{{apiPath}}/v1/environments/{{envId}}/promotionVariableDeclarations` request to declare (assign a value to) a promotion variable for use in the specified environment. You must first have defined the promotion variable using the [Create Variable Definition](create-variable-definition.html) request. | | | | - | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | | When creating or updating promotion variable declarations, if the bound resource attribute is classified as sensitive (such as for client secrets or passwords), the associated variable definition in the target environment must also be marked as sensitive (the `isSensitive` attribute set to `true`). If it is not, the request fails with a validation error. | > **Collapse: Request Model** > > | Property | Type | Required | > | ------------ | ------ | -------- | > | `resourceId` | String | Required | > | `variables` | Map | Required | ### Headers Authorization      Bearer {{accessToken}} Content-Type      application/json ### Body raw ( application/json ) ```json { "resource": {"id": "d8e643d9-105b-4f59-82f0-e549a34ee0c0"}, "variables": {"sloEndpoint": "${promotionVariable: sloEndpointVar}"} } ``` ## ### Example Request * cURL * C# * Go * HTTP * Java * jQuery * NodeJS * Python * PHP * Ruby * Swift ```shell curl --location --globoff '{{apiPath}}/v1/environments/{{envId}}/promotionVariableDeclarations' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer {{accessToken}}' \ --data '{ "resource": {"id": "d8e643d9-105b-4f59-82f0-e549a34ee0c0"}, "variables": {"sloEndpoint": "${promotionVariable: sloEndpointVar}"} }' ``` ```csharp var options = new RestClientOptions("{{apiPath}}/v1/environments/{{envId}}/promotionVariableDeclarations") { MaxTimeout = -1, }; var client = new RestClient(options); var request = new RestRequest("", Method.Post); request.AddHeader("Content-Type", "application/json"); request.AddHeader("Authorization", "Bearer {{accessToken}}"); var body = @"{" + "\n" + @" ""resource"": {""id"": ""d8e643d9-105b-4f59-82f0-e549a34ee0c0""}," + "\n" + @" ""variables"": {""sloEndpoint"": ""${promotionVariable: sloEndpointVar}""}" + "\n" + @"}"; request.AddStringBody(body, DataFormat.Json); RestResponse response = await client.ExecuteAsync(request); Console.WriteLine(response.Content); ``` ```golang package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "{{apiPath}}/v1/environments/{{envId}}/promotionVariableDeclarations" method := "POST" payload := strings.NewReader(`{ "resource": {"id": "d8e643d9-105b-4f59-82f0-e549a34ee0c0"}, "variables": {"sloEndpoint": "${promotionVariable: sloEndpointVar}"} }`) client := &http.Client { } req, err := http.NewRequest(method, url, payload) if err != nil { fmt.Println(err) return } req.Header.Add("Content-Type", "application/json") req.Header.Add("Authorization", "Bearer {{accessToken}}") res, err := client.Do(req) if err != nil { fmt.Println(err) return } defer res.Body.Close() body, err := io.ReadAll(res.Body) if err != nil { fmt.Println(err) return } fmt.Println(string(body)) } ``` ```http POST /v1/environments/{{envId}}/promotionVariableDeclarations HTTP/1.1 Host: {{apiPath}} Content-Type: application/json Authorization: Bearer {{accessToken}} { "resource": {"id": "d8e643d9-105b-4f59-82f0-e549a34ee0c0"}, "variables": {"sloEndpoint": "${promotionVariable: sloEndpointVar}"} } ``` ```java OkHttpClient client = new OkHttpClient().newBuilder() .build(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "{\n \"resource\": {\"id\": \"d8e643d9-105b-4f59-82f0-e549a34ee0c0\"},\n \"variables\": {\"sloEndpoint\": \"${promotionVariable: sloEndpointVar}\"}\n}"); Request request = new Request.Builder() .url("{{apiPath}}/v1/environments/{{envId}}/promotionVariableDeclarations") .method("POST", body) .addHeader("Content-Type", "application/json") .addHeader("Authorization", "Bearer {{accessToken}}") .build(); Response response = client.newCall(request).execute(); ``` ```javascript var settings = { "url": "{{apiPath}}/v1/environments/{{envId}}/promotionVariableDeclarations", "method": "POST", "timeout": 0, "headers": { "Content-Type": "application/json", "Authorization": "Bearer {{accessToken}}" }, "data": JSON.stringify({ "resource": { "id": "d8e643d9-105b-4f59-82f0-e549a34ee0c0" }, "variables": { "sloEndpoint": "${promotionVariable: sloEndpointVar}" } }), }; $.ajax(settings).done(function (response) { console.log(response); }); ``` ```javascript var request = require('request'); var options = { 'method': 'POST', 'url': '{{apiPath}}/v1/environments/{{envId}}/promotionVariableDeclarations', 'headers': { 'Content-Type': 'application/json', 'Authorization': 'Bearer {{accessToken}}' }, body: JSON.stringify({ "resource": { "id": "d8e643d9-105b-4f59-82f0-e549a34ee0c0" }, "variables": { "sloEndpoint": "${promotionVariable: sloEndpointVar}" } }) }; request(options, function (error, response) { if (error) throw new Error(error); console.log(response.body); }); ``` ```python import requests import json url = "{{apiPath}}/v1/environments/{{envId}}/promotionVariableDeclarations" payload = json.dumps({ "resource": { "id": "d8e643d9-105b-4f59-82f0-e549a34ee0c0" }, "variables": { "sloEndpoint": "${promotionVariable: sloEndpointVar}" } }) headers = { 'Content-Type': 'application/json', 'Authorization': 'Bearer {{accessToken}}' } response = requests.request("POST", url, headers=headers, data=payload) print(response.text) ``` ```php setUrl('{{apiPath}}/v1/environments/{{envId}}/promotionVariableDeclarations'); $request->setMethod(HTTP_Request2::METHOD_POST); $request->setConfig(array( 'follow_redirects' => TRUE )); $request->setHeader(array( 'Content-Type' => 'application/json', 'Authorization' => 'Bearer {{accessToken}}' )); $request->setBody('{\n "resource": {"id": "d8e643d9-105b-4f59-82f0-e549a34ee0c0"},\n "variables": {"sloEndpoint": "${promotionVariable: sloEndpointVar}"}\n}'); try { $response = $request->send(); if ($response->getStatus() == 200) { echo $response->getBody(); } else { echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' . $response->getReasonPhrase(); } } catch(HTTP_Request2_Exception $e) { echo 'Error: ' . $e->getMessage(); } ``` ```ruby require "uri" require "json" require "net/http" url = URI("{{apiPath}}/v1/environments/{{envId}}/promotionVariableDeclarations") http = Net::HTTP.new(url.host, url.port); request = Net::HTTP::Post.new(url) request["Content-Type"] = "application/json" request["Authorization"] = "Bearer {{accessToken}}" request.body = JSON.dump({ "resource": { "id": "d8e643d9-105b-4f59-82f0-e549a34ee0c0" }, "variables": { "sloEndpoint": "\${promotionVariable: sloEndpointVar}" } }) response = http.request(request) puts response.read_body ``` ```swift let parameters = "{\n \"resource\": {\"id\": \"d8e643d9-105b-4f59-82f0-e549a34ee0c0\"},\n \"variables\": {\"sloEndpoint\": \"${promotionVariable: sloEndpointVar}\"}\n}" let postData = parameters.data(using: .utf8) var request = URLRequest(url: URL(string: "{{apiPath}}/v1/environments/{{envId}}/promotionVariableDeclarations")!,timeoutInterval: Double.infinity) request.addValue("application/json", forHTTPHeaderField: "Content-Type") request.addValue("Bearer {{accessToken}}", forHTTPHeaderField: "Authorization") request.httpMethod = "POST" request.httpBody = postData let task = URLSession.shared.dataTask(with: request) { data, response, error in guard let data = data else { print(String(describing: error)) return } print(String(data: data, encoding: .utf8)!) } task.resume() ``` ### Example Response 201 Created ```json { "_links": { "self": { "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/promotionVariableDeclarations/d8e643d9-105b-4f59-82f0-e549a34ee0c0" }, "environment": { "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6" } }, "environment": { "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6" }, "resource": { "id": "d8e643d9-105b-4f59-82f0-e549a34ee0c0" }, "variables": { "sloEndpoint": "${promotionVariable: sloEndpointVar}" }, "createdAt": "2024-09-09T17:37:23.136Z", "updatedAt": "2024-09-09T17:37:23.136Z" } ```