Chilkat Online Tools

Node.js / Datadog API Collection / Edit a private location

Back to Collection Items

var os = require('os');
if (os.platform() == 'win32') {  
    if (os.arch() == 'ia32') {
        var chilkat = require('@chilkat/ck-node21-win-ia32');
    } else {
        var chilkat = require('@chilkat/ck-node21-win64'); 
    }
} else if (os.platform() == 'linux') {
    if (os.arch() == 'arm') {
        var chilkat = require('@chilkat/ck-node21-arm');
    } else if (os.arch() == 'x86') {
        var chilkat = require('@chilkat/ck-node21-linux32');
    } else {
        var chilkat = require('@chilkat/ck-node21-linux64');
    }
} else if (os.platform() == 'darwin') {
    if (os.arch() == 'arm64') {
        var chilkat = require('@chilkat/ck-node21-mac-m1');
    } else {
        var chilkat = require('@chilkat/ck-node21-macosx');
    }
}


function chilkatExample() {

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

    var http = new chilkat.Http();
    var 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.

    // {
    //   "name": "New private location",
    //   "description": "Description of private location",
    //   "tags": [
    //     "team:front"
    //   ],
    //   "id": "Duis incididunt ea Lorem",
    //   "metadata": {
    //     "restricted_roles": [
    //       "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
    //     ]
    //   },
    //   "secrets": {
    //     "authentication": {
    //       "id": "quis aliqua dolor reprehenderit",
    //       "key": "laboris pariatur"
    //     },
    //     "config_decryption": {
    //       "key": "voluptate mollit commodo deserunt"
    //     }
    //   }
    // }

    var json = new chilkat.JsonObject();
    json.UpdateString("name","New private location");
    json.UpdateString("description","Description of private location");
    json.UpdateString("tags[0]","team:front");
    json.UpdateString("id","Duis incididunt ea Lorem");
    json.UpdateString("metadata.restricted_roles[0]","xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx");
    json.UpdateString("secrets.authentication.id","quis aliqua dolor reprehenderit");
    json.UpdateString("secrets.authentication.key","laboris pariatur");
    json.UpdateString("secrets.config_decryption.key","voluptate mollit commodo deserunt");

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

    var sbRequestBody = new chilkat.StringBuilder();
    json.EmitSb(sbRequestBody);

    // resp: HttpResponse
    var resp = http.PTextSb("PUT","https://api.app.ddog-gov.com/api/v1/synthetics/private-locations/:location_id",sbRequestBody,"utf-8","application/json",false,false);
    if (http.LastMethodSuccess == false) {
        console.log(http.LastErrorText);
        return;
    }

    var sbResponseBody = new chilkat.StringBuilder();
    resp.GetBodySb(sbResponseBody);

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

    console.log("Response Body:");
    console.log(jResp.Emit());

    var respStatusCode = resp.StatusCode;
    console.log("Response Status Code = " + respStatusCode);
    if (respStatusCode >= 400) {
        console.log("Response Header:");
        console.log(resp.Header);
        console.log("Failed.");

        return;
    }

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

    // {
    //   "name": "New private location",
    //   "description": "Description of private location",
    //   "tags": [
    //     "team:front"
    //   ],
    //   "id": "Duis incididunt ea Lorem",
    //   "metadata": {
    //     "restricted_roles": [
    //       "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
    //     ]
    //   },
    //   "secrets": {
    //     "authentication": {
    //       "id": "quis aliqua dolor reprehenderit",
    //       "key": "laboris pariatur"
    //     },
    //     "config_decryption": {
    //       "key": "voluptate mollit commodo deserunt"
    //     }
    //   }
    // }

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

    var strVal;

    var name = jResp.StringOf("name");
    var description = jResp.StringOf("description");
    var id = jResp.StringOf("id");
    var Id = jResp.StringOf("secrets.authentication.id");
    var Key = jResp.StringOf("secrets.authentication.key");
    var Config_decryptionKey = jResp.StringOf("secrets.config_decryption.key");
    var i = 0;
    var 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("metadata.restricted_roles");
    while (i < count_i) {
        jResp.I = i;
        strVal = jResp.StringOf("metadata.restricted_roles[i]");
        i = i+1;
    }


}

chilkatExample();

Curl Command

curl -X PUT
	-H "Content-Type: application/json"
	-H "Accept: application/json"
	-d '{
  "name": "New private location",
  "description": "Description of private location",
  "tags": [
    "team:front"
  ],
  "id": "Duis incididunt ea Lorem",
  "metadata": {
    "restricted_roles": [
      "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
    ]
  },
  "secrets": {
    "authentication": {
      "id": "quis aliqua dolor reprehenderit",
      "key": "laboris pariatur"
    },
    "config_decryption": {
      "key": "voluptate mollit commodo deserunt"
    }
  }
}'
https://api.app.ddog-gov.com/api/v1/synthetics/private-locations/:location_id

Postman Collection Item JSON

{
  "name": "Edit a private location",
  "request": {
    "method": "PUT",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      },
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"name\": \"New private location\",\n  \"description\": \"Description of private location\",\n  \"tags\": [\n    \"team:front\"\n  ],\n  \"id\": \"Duis incididunt ea Lorem\",\n  \"metadata\": {\n    \"restricted_roles\": [\n      \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n    ]\n  },\n  \"secrets\": {\n    \"authentication\": {\n      \"id\": \"quis aliqua dolor reprehenderit\",\n      \"key\": \"laboris pariatur\"\n    },\n    \"config_decryption\": {\n      \"key\": \"voluptate mollit commodo deserunt\"\n    }\n  }\n}",
      "options": {
        "raw": {
          "headerFamily": "json",
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{baseUrl}}/api/v1/synthetics/private-locations/:location_id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v1",
        "synthetics",
        "private-locations",
        ":location_id"
      ],
      "variable": [
        {
          "key": "location_id",
          "value": "tempor Ut sed velit"
        }
      ]
    },
    "description": "Edit a Synthetic private location."
  },
  "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  \"name\": \"New private location\",\n  \"description\": \"Description of private location\",\n  \"tags\": [\n    \"team:front\"\n  ],\n  \"id\": \"Duis incididunt ea Lorem\",\n  \"metadata\": {\n    \"restricted_roles\": [\n      \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n    ]\n  },\n  \"secrets\": {\n    \"authentication\": {\n      \"id\": \"quis aliqua dolor reprehenderit\",\n      \"key\": \"laboris pariatur\"\n    },\n    \"config_decryption\": {\n      \"key\": \"voluptate mollit commodo deserunt\"\n    }\n  }\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v1/synthetics/private-locations/:location_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "synthetics",
            "private-locations",
            ":location_id"
          ],
          "variable": [
            {
              "key": "location_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"name\": \"New private location\",\n  \"description\": \"Description of private location\",\n  \"tags\": [\n    \"team:front\"\n  ],\n  \"id\": \"Duis incididunt ea Lorem\",\n  \"metadata\": {\n    \"restricted_roles\": [\n      \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n    ]\n  },\n  \"secrets\": {\n    \"authentication\": {\n      \"id\": \"quis aliqua dolor reprehenderit\",\n      \"key\": \"laboris pariatur\"\n    },\n    \"config_decryption\": {\n      \"key\": \"voluptate mollit commodo deserunt\"\n    }\n  }\n}"
    },
    {
      "name": "- Private locations are not activated for the user\n- Private location does not exist",
      "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  \"name\": \"New private location\",\n  \"description\": \"Description of private location\",\n  \"tags\": [\n    \"team:front\"\n  ],\n  \"id\": \"Duis incididunt ea Lorem\",\n  \"metadata\": {\n    \"restricted_roles\": [\n      \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n    ]\n  },\n  \"secrets\": {\n    \"authentication\": {\n      \"id\": \"quis aliqua dolor reprehenderit\",\n      \"key\": \"laboris pariatur\"\n    },\n    \"config_decryption\": {\n      \"key\": \"voluptate mollit commodo deserunt\"\n    }\n  }\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v1/synthetics/private-locations/:location_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "synthetics",
            "private-locations",
            ":location_id"
          ],
          "variable": [
            {
              "key": "location_id"
            }
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_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  \"name\": \"New private location\",\n  \"description\": \"Description of private location\",\n  \"tags\": [\n    \"team:front\"\n  ],\n  \"id\": \"Duis incididunt ea Lorem\",\n  \"metadata\": {\n    \"restricted_roles\": [\n      \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n    ]\n  },\n  \"secrets\": {\n    \"authentication\": {\n      \"id\": \"quis aliqua dolor reprehenderit\",\n      \"key\": \"laboris pariatur\"\n    },\n    \"config_decryption\": {\n      \"key\": \"voluptate mollit commodo deserunt\"\n    }\n  }\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v1/synthetics/private-locations/:location_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "synthetics",
            "private-locations",
            ":location_id"
          ],
          "variable": [
            {
              "key": "location_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}"
    }
  ]
}