Chilkat Online Tools

.NET Core C# / Datadog API Collection / Edit a global variable

Back to Collection Items

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

Chilkat.Http http = new Chilkat.Http();
bool success;

// Use this online tool to generate code from sample JSON: Generate Code to Create JSON

// The following JSON is sent in the request body.

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

Chilkat.JsonObject json = new Chilkat.JsonObject();
json.UpdateString("description","Example description");
json.UpdateString("name","MY_VARIABLE");
json.UpdateString("tags[0]","team:front");
json.UpdateString("tags[1]","test:workflow-1");
json.UpdateBool("value.secure",true);
json.UpdateString("value.value","value");
json.UpdateString("attributes.restricted_roles[0]","xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx");
json.UpdateString("id","anim irure id cupidatat");
json.UpdateString("parse_test_options.type","http_body");
json.UpdateString("parse_test_options.field","content-type");
json.UpdateString("parse_test_options.localVariableName","LOCAL_VARIABLE");
json.UpdateString("parse_test_options.parser.type","regex");
json.UpdateString("parse_test_options.parser.value",".*");
json.UpdateString("parse_test_public_id","abc-def-123");

http.SetRequestHeader("Content-Type","application/json");
http.SetRequestHeader("Accept","application/json");

Chilkat.StringBuilder sbRequestBody = new Chilkat.StringBuilder();
json.EmitSb(sbRequestBody);

Chilkat.HttpResponse resp = http.PTextSb("PUT","https://api.app.ddog-gov.com/api/v1/synthetics/variables/:variable_id",sbRequestBody,"utf-8","application/json",false,false);
if (http.LastMethodSuccess == false) {
    Debug.WriteLine(http.LastErrorText);
    return;
}

Chilkat.StringBuilder sbResponseBody = new Chilkat.StringBuilder();
resp.GetBodySb(sbResponseBody);

Chilkat.JsonObject jResp = new Chilkat.JsonObject();
jResp.LoadSb(sbResponseBody);
jResp.EmitCompact = false;

Debug.WriteLine("Response Body:");
Debug.WriteLine(jResp.Emit());

int respStatusCode = resp.StatusCode;
Debug.WriteLine("Response Status Code = " + Convert.ToString(respStatusCode));
if (respStatusCode >= 400) {
    Debug.WriteLine("Response Header:");
    Debug.WriteLine(resp.Header);
    Debug.WriteLine("Failed.");

    return;
}

// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)

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

// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

string strVal;

string description = jResp.StringOf("description");
string name = jResp.StringOf("name");
bool Secure = jResp.BoolOf("value.secure");
string Value = jResp.StringOf("value.value");
string id = jResp.StringOf("id");
string v_Type = jResp.StringOf("parse_test_options.type");
string Field = jResp.StringOf("parse_test_options.field");
string LocalVariableName = jResp.StringOf("parse_test_options.localVariableName");
string ParserType = jResp.StringOf("parse_test_options.parser.type");
string ParserValue = jResp.StringOf("parse_test_options.parser.value");
string parse_test_public_id = jResp.StringOf("parse_test_public_id");
int i = 0;
int count_i = jResp.SizeOfArray("tags");
while (i < count_i) {
    jResp.I = i;
    strVal = jResp.StringOf("tags[i]");
    i = i + 1;
}

i = 0;
count_i = jResp.SizeOfArray("attributes.restricted_roles");
while (i < count_i) {
    jResp.I = i;
    strVal = jResp.StringOf("attributes.restricted_roles[i]");
    i = i + 1;
}

Curl Command

curl -X PUT
	-H "Content-Type: application/json"
	-H "Accept: application/json"
	-d '{
  "description": "Example description",
  "name": "MY_VARIABLE",
  "tags": [
    "team:front",
    "test:workflow-1"
  ],
  "value": {
    "secure": true,
    "value": "value"
  },
  "attributes": {
    "restricted_roles": [
      "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
    ]
  },
  "id": "anim irure id cupidatat",
  "parse_test_options": {
    "type": "http_body",
    "field": "content-type",
    "localVariableName": "LOCAL_VARIABLE",
    "parser": {
      "type": "regex",
      "value": ".*"
    }
  },
  "parse_test_public_id": "abc-def-123"
}'
https://api.app.ddog-gov.com/api/v1/synthetics/variables/:variable_id

Postman Collection Item JSON

{
  "name": "Edit a global variable",
  "request": {
    "method": "PUT",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      },
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"description\": \"Example description\",\n  \"name\": \"MY_VARIABLE\",\n  \"tags\": [\n    \"team:front\",\n    \"test:workflow-1\"\n  ],\n  \"value\": {\n    \"secure\": true,\n    \"value\": \"value\"\n  },\n  \"attributes\": {\n    \"restricted_roles\": [\n      \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n    ]\n  },\n  \"id\": \"anim irure id cupidatat\",\n  \"parse_test_options\": {\n    \"type\": \"http_body\",\n    \"field\": \"content-type\",\n    \"localVariableName\": \"LOCAL_VARIABLE\",\n    \"parser\": {\n      \"type\": \"regex\",\n      \"value\": \".*\"\n    }\n  },\n  \"parse_test_public_id\": \"abc-def-123\"\n}",
      "options": {
        "raw": {
          "headerFamily": "json",
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{baseUrl}}/api/v1/synthetics/variables/:variable_id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v1",
        "synthetics",
        "variables",
        ":variable_id"
      ],
      "variable": [
        {
          "key": "variable_id",
          "value": "tempor Ut sed velit"
        }
      ]
    },
    "description": "Edit a Synthetic global variable."
  },
  "response": [
    {
      "name": "OK",
      "originalRequest": {
        "method": "PUT",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          },
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "DD-API-KEY",
            "value": "<API Key>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"description\": \"Example description\",\n  \"name\": \"MY_VARIABLE\",\n  \"tags\": [\n    \"team:front\",\n    \"test:workflow-1\"\n  ],\n  \"value\": {\n    \"secure\": true,\n    \"value\": \"value\"\n  },\n  \"attributes\": {\n    \"restricted_roles\": [\n      \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n    ]\n  },\n  \"id\": \"anim irure id cupidatat\",\n  \"parse_test_options\": {\n    \"type\": \"http_body\",\n    \"field\": \"content-type\",\n    \"localVariableName\": \"LOCAL_VARIABLE\",\n    \"parser\": {\n      \"type\": \"regex\",\n      \"value\": \".*\"\n    }\n  },\n  \"parse_test_public_id\": \"abc-def-123\"\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v1/synthetics/variables/:variable_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "synthetics",
            "variables",
            ":variable_id"
          ],
          "variable": [
            {
              "key": "variable_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"description\": \"Example description\",\n  \"name\": \"MY_VARIABLE\",\n  \"tags\": [\n    \"team:front\",\n    \"test:workflow-1\"\n  ],\n  \"value\": {\n    \"secure\": true,\n    \"value\": \"value\"\n  },\n  \"attributes\": {\n    \"restricted_roles\": [\n      \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n    ]\n  },\n  \"id\": \"anim irure id cupidatat\",\n  \"parse_test_options\": {\n    \"type\": \"http_body\",\n    \"field\": \"content-type\",\n    \"localVariableName\": \"LOCAL_VARIABLE\",\n    \"parser\": {\n      \"type\": \"regex\",\n      \"value\": \".*\"\n    }\n  },\n  \"parse_test_public_id\": \"abc-def-123\"\n}"
    },
    {
      "name": "Invalid request",
      "originalRequest": {
        "method": "PUT",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          },
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "DD-API-KEY",
            "value": "<API Key>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"description\": \"Example description\",\n  \"name\": \"MY_VARIABLE\",\n  \"tags\": [\n    \"team:front\",\n    \"test:workflow-1\"\n  ],\n  \"value\": {\n    \"secure\": true,\n    \"value\": \"value\"\n  },\n  \"attributes\": {\n    \"restricted_roles\": [\n      \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n    ]\n  },\n  \"id\": \"anim irure id cupidatat\",\n  \"parse_test_options\": {\n    \"type\": \"http_body\",\n    \"field\": \"content-type\",\n    \"localVariableName\": \"LOCAL_VARIABLE\",\n    \"parser\": {\n      \"type\": \"regex\",\n      \"value\": \".*\"\n    }\n  },\n  \"parse_test_public_id\": \"abc-def-123\"\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v1/synthetics/variables/:variable_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "synthetics",
            "variables",
            ":variable_id"
          ],
          "variable": [
            {
              "key": "variable_id"
            }
          ]
        }
      },
      "status": "Bad Request",
      "code": 400,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"errors\": [\n    \"Bad Request\",\n    \"Bad Request\"\n  ]\n}"
    },
    {
      "name": "Forbidden",
      "originalRequest": {
        "method": "PUT",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          },
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "DD-API-KEY",
            "value": "<API Key>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"description\": \"Example description\",\n  \"name\": \"MY_VARIABLE\",\n  \"tags\": [\n    \"team:front\",\n    \"test:workflow-1\"\n  ],\n  \"value\": {\n    \"secure\": true,\n    \"value\": \"value\"\n  },\n  \"attributes\": {\n    \"restricted_roles\": [\n      \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n    ]\n  },\n  \"id\": \"anim irure id cupidatat\",\n  \"parse_test_options\": {\n    \"type\": \"http_body\",\n    \"field\": \"content-type\",\n    \"localVariableName\": \"LOCAL_VARIABLE\",\n    \"parser\": {\n      \"type\": \"regex\",\n      \"value\": \".*\"\n    }\n  },\n  \"parse_test_public_id\": \"abc-def-123\"\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v1/synthetics/variables/:variable_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "synthetics",
            "variables",
            ":variable_id"
          ],
          "variable": [
            {
              "key": "variable_id"
            }
          ]
        }
      },
      "status": "Forbidden",
      "code": 403,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"errors\": [\n    \"Bad Request\",\n    \"Bad Request\"\n  ]\n}"
    },
    {
      "name": "Too many requests",
      "originalRequest": {
        "method": "PUT",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          },
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "DD-API-KEY",
            "value": "<API Key>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"description\": \"Example description\",\n  \"name\": \"MY_VARIABLE\",\n  \"tags\": [\n    \"team:front\",\n    \"test:workflow-1\"\n  ],\n  \"value\": {\n    \"secure\": true,\n    \"value\": \"value\"\n  },\n  \"attributes\": {\n    \"restricted_roles\": [\n      \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n    ]\n  },\n  \"id\": \"anim irure id cupidatat\",\n  \"parse_test_options\": {\n    \"type\": \"http_body\",\n    \"field\": \"content-type\",\n    \"localVariableName\": \"LOCAL_VARIABLE\",\n    \"parser\": {\n      \"type\": \"regex\",\n      \"value\": \".*\"\n    }\n  },\n  \"parse_test_public_id\": \"abc-def-123\"\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v1/synthetics/variables/:variable_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "synthetics",
            "variables",
            ":variable_id"
          ],
          "variable": [
            {
              "key": "variable_id"
            }
          ]
        }
      },
      "status": "Too Many Requests",
      "code": 429,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"errors\": [\n    \"Bad Request\",\n    \"Bad Request\"\n  ]\n}"
    }
  ]
}