Chilkat Online Tools

C++ / Datadog API Collection / Get a test configuration

Back to Collection Items

#include <CkHttp.h>
#include <CkStringBuilder.h>
#include <CkJsonObject.h>

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

    CkHttp http;
    bool success;

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

    CkStringBuilder sbResponseBody;
    success = http.QuickGetSb("https://api.app.ddog-gov.com/api/v1/synthetics/tests/:public_id",sbResponseBody);
    if (success == false) {
        std::cout << http.lastErrorText() << "\r\n";
        return;
    }

    CkJsonObject jResp;
    jResp.LoadSb(sbResponseBody);
    jResp.put_EmitCompact(false);

    std::cout << "Response Body:" << "\r\n";
    std::cout << jResp.emit() << "\r\n";

    int respStatusCode = http.get_LastStatus();
    std::cout << "Response Status Code = " << respStatusCode << "\r\n";
    if (respStatusCode >= 400) {
        std::cout << "Response Header:" << "\r\n";
        std::cout << http.lastHeader() << "\r\n";
        std::cout << "Failed." << "\r\n";
        return;
    }

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

    // {
    //   "config": {
    //     "configVariables": [
    //       {
    //         "description": "Example for the variable.",
    //         "type": "string"
    //       },
    //       {
    //         "description": "Example for the variable.",
    //         "type": "string"
    //       }
    //     ],
    //     "request": {
    //       "allow_insecure": false,
    //       "basicAuth": {
    //         "password": "PaSSw0RD!",
    //         "username": "my_username",
    //         "type": "web"
    //       },
    //       "body": "deserunt non",
    //       "bodyType": "text/plain",
    //       "callType": "unary",
    //       "certificate": {
    //         "cert": {
    //           "content": "ad dolor",
    //           "filename": "culpa adipisicing",
    //           "updatedAt": "ipsum magna irure aliquip"
    //         },
    //         "key": {
    //           "content": "in labore",
    //           "filename": "sit magna non dolore",
    //           "updatedAt": "ipsum aute in"
    //         }
    //       },
    //       "compressedJsonDescriptor": "co",
    //       "dnsServer": "adipisicing dolore fugiat",
    //       "dnsServerPort": 43085,
    //       "follow_redirects": false,
    //       "headers": {
    //         "dolor77f": "laboris aliquip in",
    //         "Excepteur5": "in ullamco est repr",
    //         "cupidatatb2": "ex magna dolore"
    //       },
    //       "host": "qui eu",
    //       "message": "dolore anim tempor minim dolor",
    //       "metadata": {
    //         "cillum_f": "elit ad ex ven",
    //         "quicbd": "ut ipsum Duis cillum dolor",
    //         "dolore2_7": "pariatur adipisicing enim dolore nulla"
    //       },
    //       "method": "deserunt",
    //       "noSavingResponseBody": true,
    //       "numberOfPackets": 9,
    //       "persistCookies": false,
    //       "port": -81939613,
    //       "proxy": {
    //         "url": "https://example.com",
    //         "headers": {
    //           "ut_a": "ut"
    //         }
    //       },
    //       "query": {},
    //       "servername": "adipisicing id dolore",
    //       "service": "Greeter",
    //       "shouldTrackHops": false,
    //       "timeout": 10817249.274777964,
    //       "url": "https://example.com"
    //     },
    //     "variables": [
    //       {
    //         "description": "Example for the variable.",
    //         "type": "string"
    //       },
    //       {
    //         "description": "Example for the variable.",
    //         "type": "string"
    //       }
    //     ]
    //   },
    //   "creator": {
    //     "email": "enim exercitation commodo in",
    //     "handle": "et nulla eu",
    //     "name": "cupidatat proident"
    //   },
    //   "locations": [
    //     "aws:eu-west-3"
    //   ],
    //   "message": "eu do sunt commodo aliquip",
    //   "monitor_id": -1517547,
    //   "name": "deserunt amet occaecat",
    //   "options": {
    //     "accept_self_signed": true,
    //     "allow_insecure": true,
    //     "checkCertificateRevocation": true,
    //     "ci": {
    //       "executionRule": "non_blocking"
    //     },
    //     "device_ids": [
    //       "laptop_large",
    //       "laptop_large"
    //     ],
    //     "disableCors": true,
    //     "disableCsp": true,
    //     "follow_redirects": true,
    //     "httpVersion": "http2",
    //     "ignoreServerCertificateError": false,
    //     "initialNavigationTimeout": -26222184,
    //     "min_failure_duration": 76083858,
    //     "min_location_failed": -39662994,
    //     "monitor_name": "paria",
    //     "monitor_options": {
    //       "renotify_interval": 214
    //     },
    //     "monitor_priority": 4,
    //     "noScreenshot": true,
    //     "restricted_roles": [
    //       "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
    //     ],
    //     "retry": {
    //       "count": 1859540,
    //       "interval": -51339928.952870026
    //     },
    //     "rumSettings": {
    //       "applicationId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    //       "clientTokenId": 12345,
    //       "isEnabled": true
    //     },
    //     "scheduling": {
    //       "timeframes": [
    //         {
    //           "day": 1,
    //           "from": "07:00",
    //           "to": "16:00"
    //         },
    //         {
    //           "day": 3,
    //           "from": "07:00",
    //           "to": "16:00"
    //         }
    //       ],
    //       "timezone": "America/New_York"
    //     },
    //     "tick_every": 74879
    //   },
    //   "public_id": "magna",
    //   "status": "live",
    //   "steps": [
    //     {
    //       "allowFailure": false,
    //       "isCritical": true,
    //       "name": "ea laborum ve",
    //       "noScreenshot": false,
    //       "params": {},
    //       "timeout": 51909556,
    //       "type": "assertElementContent"
    //     },
    //     {
    //       "allowFailure": false,
    //       "isCritical": true,
    //       "name": "pariatur reprehenderit do",
    //       "noScreenshot": false,
    //       "params": {},
    //       "timeout": 72919471,
    //       "type": "assertElementContent"
    //     }
    //   ],
    //   "subtype": "http",
    //   "tags": [
    //     "dolor Ut anim nisi ea",
    //     "dolore anim ipsum pariatur"
    //   ],
    //   "type": "browser"
    // }

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

    // Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.

    const char *description = 0;
    const char *strVal = 0;
    int day;
    const char *from = 0;
    const char *v_to = 0;
    bool allowFailure;
    bool isCritical;
    bool noScreenshot;
    int timeout;

    bool Allow_insecure = jResp.BoolOf("config.request.allow_insecure");
    const char *Password = jResp.stringOf("config.request.basicAuth.password");
    const char *Username = jResp.stringOf("config.request.basicAuth.username");
    const char *v_Type = jResp.stringOf("config.request.basicAuth.type");
    const char *Body = jResp.stringOf("config.request.body");
    const char *BodyType = jResp.stringOf("config.request.bodyType");
    const char *CallType = jResp.stringOf("config.request.callType");
    const char *Content = jResp.stringOf("config.request.certificate.cert.content");
    const char *Filename = jResp.stringOf("config.request.certificate.cert.filename");
    const char *UpdatedAt = jResp.stringOf("config.request.certificate.cert.updatedAt");
    const char *KeyContent = jResp.stringOf("config.request.certificate.key.content");
    const char *KeyFilename = jResp.stringOf("config.request.certificate.key.filename");
    const char *KeyUpdatedAt = jResp.stringOf("config.request.certificate.key.updatedAt");
    const char *CompressedJsonDescriptor = jResp.stringOf("config.request.compressedJsonDescriptor");
    const char *DnsServer = jResp.stringOf("config.request.dnsServer");
    int DnsServerPort = jResp.IntOf("config.request.dnsServerPort");
    bool Follow_redirects = jResp.BoolOf("config.request.follow_redirects");
    const char *Dolor77f = jResp.stringOf("config.request.headers.dolor77f");
    const char *Excepteur5 = jResp.stringOf("config.request.headers.Excepteur5");
    const char *Cupidatatb2 = jResp.stringOf("config.request.headers.cupidatatb2");
    const char *Host = jResp.stringOf("config.request.host");
    const char *Message = jResp.stringOf("config.request.message");
    const char *Cillum_f = jResp.stringOf("config.request.metadata.cillum_f");
    const char *Quicbd = jResp.stringOf("config.request.metadata.quicbd");
    const char *Dolore2_7 = jResp.stringOf("config.request.metadata.dolore2_7");
    const char *Method = jResp.stringOf("config.request.method");
    bool NoSavingResponseBody = jResp.BoolOf("config.request.noSavingResponseBody");
    int NumberOfPackets = jResp.IntOf("config.request.numberOfPackets");
    bool PersistCookies = jResp.BoolOf("config.request.persistCookies");
    int Port = jResp.IntOf("config.request.port");
    const char *v_Url = jResp.stringOf("config.request.proxy.url");
    const char *Ut_a = jResp.stringOf("config.request.proxy.headers.ut_a");
    const char *Servername = jResp.stringOf("config.request.servername");
    const char *Service = jResp.stringOf("config.request.service");
    bool ShouldTrackHops = jResp.BoolOf("config.request.shouldTrackHops");
    const char *Timeout = jResp.stringOf("config.request.timeout");
    const char *RequestUrl = jResp.stringOf("config.request.url");
    const char *v_Email = jResp.stringOf("creator.email");
    const char *Handle = jResp.stringOf("creator.handle");
    const char *Name = jResp.stringOf("creator.name");
    const char *message = jResp.stringOf("message");
    int monitor_id = jResp.IntOf("monitor_id");
    const char *name = jResp.stringOf("name");
    bool Accept_self_signed = jResp.BoolOf("options.accept_self_signed");
    bool optionsAllow_insecure = jResp.BoolOf("options.allow_insecure");
    bool CheckCertificateRevocation = jResp.BoolOf("options.checkCertificateRevocation");
    const char *ExecutionRule = jResp.stringOf("options.ci.executionRule");
    bool DisableCors = jResp.BoolOf("options.disableCors");
    bool DisableCsp = jResp.BoolOf("options.disableCsp");
    bool optionsFollow_redirects = jResp.BoolOf("options.follow_redirects");
    const char *HttpVersion = jResp.stringOf("options.httpVersion");
    bool IgnoreServerCertificateError = jResp.BoolOf("options.ignoreServerCertificateError");
    int InitialNavigationTimeout = jResp.IntOf("options.initialNavigationTimeout");
    int Min_failure_duration = jResp.IntOf("options.min_failure_duration");
    int Min_location_failed = jResp.IntOf("options.min_location_failed");
    const char *Monitor_name = jResp.stringOf("options.monitor_name");
    int Renotify_interval = jResp.IntOf("options.monitor_options.renotify_interval");
    int Monitor_priority = jResp.IntOf("options.monitor_priority");
    bool NoScreenshot = jResp.BoolOf("options.noScreenshot");
    int Count = jResp.IntOf("options.retry.count");
    const char *Interval = jResp.stringOf("options.retry.interval");
    const char *ApplicationId = jResp.stringOf("options.rumSettings.applicationId");
    int ClientTokenId = jResp.IntOf("options.rumSettings.clientTokenId");
    bool IsEnabled = jResp.BoolOf("options.rumSettings.isEnabled");
    const char *Timezone = jResp.stringOf("options.scheduling.timezone");
    int Tick_every = jResp.IntOf("options.tick_every");
    const char *public_id = jResp.stringOf("public_id");
    const char *status = jResp.stringOf("status");
    const char *subtype = jResp.stringOf("subtype");
    const char *v_type = jResp.stringOf("type");
    int i = 0;
    int count_i = jResp.SizeOfArray("config.configVariables");
    while (i < count_i) {
        jResp.put_I(i);
        description = jResp.stringOf("config.configVariables[i].description");
        v_type = jResp.stringOf("config.configVariables[i].type");
        i = i + 1;
    }

    i = 0;
    count_i = jResp.SizeOfArray("config.variables");
    while (i < count_i) {
        jResp.put_I(i);
        description = jResp.stringOf("config.variables[i].description");
        v_type = jResp.stringOf("config.variables[i].type");
        i = i + 1;
    }

    i = 0;
    count_i = jResp.SizeOfArray("locations");
    while (i < count_i) {
        jResp.put_I(i);
        strVal = jResp.stringOf("locations[i]");
        i = i + 1;
    }

    i = 0;
    count_i = jResp.SizeOfArray("options.device_ids");
    while (i < count_i) {
        jResp.put_I(i);
        strVal = jResp.stringOf("options.device_ids[i]");
        i = i + 1;
    }

    i = 0;
    count_i = jResp.SizeOfArray("options.restricted_roles");
    while (i < count_i) {
        jResp.put_I(i);
        strVal = jResp.stringOf("options.restricted_roles[i]");
        i = i + 1;
    }

    i = 0;
    count_i = jResp.SizeOfArray("options.scheduling.timeframes");
    while (i < count_i) {
        jResp.put_I(i);
        day = jResp.IntOf("options.scheduling.timeframes[i].day");
        from = jResp.stringOf("options.scheduling.timeframes[i].from");
        v_to = jResp.stringOf("options.scheduling.timeframes[i].to");
        i = i + 1;
    }

    i = 0;
    count_i = jResp.SizeOfArray("steps");
    while (i < count_i) {
        jResp.put_I(i);
        allowFailure = jResp.BoolOf("steps[i].allowFailure");
        isCritical = jResp.BoolOf("steps[i].isCritical");
        name = jResp.stringOf("steps[i].name");
        noScreenshot = jResp.BoolOf("steps[i].noScreenshot");
        timeout = jResp.IntOf("steps[i].timeout");
        v_type = jResp.stringOf("steps[i].type");
        i = i + 1;
    }

    i = 0;
    count_i = jResp.SizeOfArray("tags");
    while (i < count_i) {
        jResp.put_I(i);
        strVal = jResp.stringOf("tags[i]");
        i = i + 1;
    }
    }

Curl Command

curl -X GET
	-H "Accept: application/json"
https://api.app.ddog-gov.com/api/v1/synthetics/tests/:public_id

Postman Collection Item JSON

{
  "name": "Get a test configuration",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v1/synthetics/tests/:public_id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v1",
        "synthetics",
        "tests",
        ":public_id"
      ],
      "variable": [
        {
          "key": "public_id",
          "value": "tempor Ut sed velit"
        }
      ]
    },
    "description": "Get the detailed configuration associated with a Synthetic test."
  },
  "response": [
    {
      "name": "OK",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "DD-API-KEY",
            "value": "<API Key>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v1/synthetics/tests/:public_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "synthetics",
            "tests",
            ":public_id"
          ],
          "variable": [
            {
              "key": "public_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"config\": {\n    \"configVariables\": [\n      {\n        \"description\": \"Example for the variable.\",\n        \"type\": \"string\"\n      },\n      {\n        \"description\": \"Example for the variable.\",\n        \"type\": \"string\"\n      }\n    ],\n    \"request\": {\n      \"allow_insecure\": false,\n      \"basicAuth\": {\n        \"password\": \"PaSSw0RD!\",\n        \"username\": \"my_username\",\n        \"type\": \"web\"\n      },\n      \"body\": \"deserunt non\",\n      \"bodyType\": \"text/plain\",\n      \"callType\": \"unary\",\n      \"certificate\": {\n        \"cert\": {\n          \"content\": \"ad dolor\",\n          \"filename\": \"culpa adipisicing\",\n          \"updatedAt\": \"ipsum magna irure aliquip\"\n        },\n        \"key\": {\n          \"content\": \"in labore\",\n          \"filename\": \"sit magna non dolore\",\n          \"updatedAt\": \"ipsum aute in\"\n        }\n      },\n      \"compressedJsonDescriptor\": \"co\",\n      \"dnsServer\": \"adipisicing dolore fugiat\",\n      \"dnsServerPort\": 43085,\n      \"follow_redirects\": false,\n      \"headers\": {\n        \"dolor77f\": \"laboris aliquip in\",\n        \"Excepteur5\": \"in ullamco est repr\",\n        \"cupidatatb2\": \"ex magna dolore\"\n      },\n      \"host\": \"qui eu\",\n      \"message\": \"dolore anim tempor minim dolor\",\n      \"metadata\": {\n        \"cillum_f\": \"elit ad ex ven\",\n        \"quicbd\": \"ut ipsum Duis cillum dolor\",\n        \"dolore2_7\": \"pariatur adipisicing enim dolore nulla\"\n      },\n      \"method\": \"deserunt\",\n      \"noSavingResponseBody\": true,\n      \"numberOfPackets\": 9,\n      \"persistCookies\": false,\n      \"port\": -81939613,\n      \"proxy\": {\n        \"url\": \"https://example.com\",\n        \"headers\": {\n          \"ut_a\": \"ut\"\n        }\n      },\n      \"query\": {},\n      \"servername\": \"adipisicing id dolore\",\n      \"service\": \"Greeter\",\n      \"shouldTrackHops\": false,\n      \"timeout\": 10817249.274777964,\n      \"url\": \"https://example.com\"\n    },\n    \"variables\": [\n      {\n        \"description\": \"Example for the variable.\",\n        \"type\": \"string\"\n      },\n      {\n        \"description\": \"Example for the variable.\",\n        \"type\": \"string\"\n      }\n    ]\n  },\n  \"creator\": {\n    \"email\": \"enim exercitation commodo in\",\n    \"handle\": \"et nulla eu\",\n    \"name\": \"cupidatat proident\"\n  },\n  \"locations\": [\n    \"aws:eu-west-3\"\n  ],\n  \"message\": \"eu do sunt commodo aliquip\",\n  \"monitor_id\": -1517547,\n  \"name\": \"deserunt amet occaecat\",\n  \"options\": {\n    \"accept_self_signed\": true,\n    \"allow_insecure\": true,\n    \"checkCertificateRevocation\": true,\n    \"ci\": {\n      \"executionRule\": \"non_blocking\"\n    },\n    \"device_ids\": [\n      \"laptop_large\",\n      \"laptop_large\"\n    ],\n    \"disableCors\": true,\n    \"disableCsp\": true,\n    \"follow_redirects\": true,\n    \"httpVersion\": \"http2\",\n    \"ignoreServerCertificateError\": false,\n    \"initialNavigationTimeout\": -26222184,\n    \"min_failure_duration\": 76083858,\n    \"min_location_failed\": -39662994,\n    \"monitor_name\": \"paria\",\n    \"monitor_options\": {\n      \"renotify_interval\": 214\n    },\n    \"monitor_priority\": 4,\n    \"noScreenshot\": true,\n    \"restricted_roles\": [\n      \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n    ],\n    \"retry\": {\n      \"count\": 1859540,\n      \"interval\": -51339928.952870026\n    },\n    \"rumSettings\": {\n      \"applicationId\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n      \"clientTokenId\": 12345,\n      \"isEnabled\": true\n    },\n    \"scheduling\": {\n      \"timeframes\": [\n        {\n          \"day\": 1,\n          \"from\": \"07:00\",\n          \"to\": \"16:00\"\n        },\n        {\n          \"day\": 3,\n          \"from\": \"07:00\",\n          \"to\": \"16:00\"\n        }\n      ],\n      \"timezone\": \"America/New_York\"\n    },\n    \"tick_every\": 74879\n  },\n  \"public_id\": \"magna\",\n  \"status\": \"live\",\n  \"steps\": [\n    {\n      \"allowFailure\": false,\n      \"isCritical\": true,\n      \"name\": \"ea laborum ve\",\n      \"noScreenshot\": false,\n      \"params\": {},\n      \"timeout\": 51909556,\n      \"type\": \"assertElementContent\"\n    },\n    {\n      \"allowFailure\": false,\n      \"isCritical\": true,\n      \"name\": \"pariatur reprehenderit do\",\n      \"noScreenshot\": false,\n      \"params\": {},\n      \"timeout\": 72919471,\n      \"type\": \"assertElementContent\"\n    }\n  ],\n  \"subtype\": \"http\",\n  \"tags\": [\n    \"dolor Ut anim nisi ea\",\n    \"dolore anim ipsum pariatur\"\n  ],\n  \"type\": \"browser\"\n}"
    },
    {
      "name": "Forbidden",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "DD-API-KEY",
            "value": "<API Key>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v1/synthetics/tests/:public_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "synthetics",
            "tests",
            ":public_id"
          ],
          "variable": [
            {
              "key": "public_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": "- Synthetic is not activated for the user\n- Test is not owned by the user",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "DD-API-KEY",
            "value": "<API Key>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v1/synthetics/tests/:public_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "synthetics",
            "tests",
            ":public_id"
          ],
          "variable": [
            {
              "key": "public_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": "GET",
        "header": [
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "DD-API-KEY",
            "value": "<API Key>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v1/synthetics/tests/:public_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "synthetics",
            "tests",
            ":public_id"
          ],
          "variable": [
            {
              "key": "public_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}"
    }
  ]
}