Chilkat Online Tools

C# / Datadog API Collection / Get an API test

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;

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

Chilkat.StringBuilder sbResponseBody = new Chilkat.StringBuilder();
success = http.QuickGetSb("https://api.app.ddog-gov.com/api/v1/synthetics/tests/api/:public_id",sbResponseBody);
if (success == false) {
    Debug.WriteLine(http.LastErrorText);
    return;
}

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

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

int respStatusCode = http.LastStatus;
Debug.WriteLine("Response Status Code = " + Convert.ToString(respStatusCode));
if (respStatusCode >= 400) {
    Debug.WriteLine("Response Header:");
    Debug.WriteLine(http.LastHeader);
    Debug.WriteLine("Failed.");
    return;
}

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

// {
//   "name": "Example test name",
//   "config": {
//     "assertions": [
//       {
//         "operator": "lessThan",
//         "target": 1000,
//         "type": "responseTime"
//       }
//     ],
//     "request": {
//       "method": "GET",
//       "url": "https://example.com"
//     }
//   },
//   "locations": [
//     "aws:eu-west-3"
//   ],
//   "options": {
//     "accept_self_signed": true,
//     "allow_insecure": true,
//     "checkCertificateRevocation": true,
//     "ci": {
//       "executionRule": "non_blocking"
//     },
//     "device_ids": [
//       "laptop_large",
//       "laptop_large"
//     ],
//     "disableCors": false,
//     "disableCsp": false,
//     "follow_redirects": true,
//     "httpVersion": "http1",
//     "ignoreServerCertificateError": false,
//     "initialNavigationTimeout": 87780679,
//     "min_failure_duration": -32472759,
//     "min_location_failed": -5806955,
//     "monitor_name": "et deserunt ",
//     "monitor_options": {
//       "renotify_interval": 834
//     },
//     "monitor_priority": 3,
//     "noScreenshot": false,
//     "restricted_roles": [
//       "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
//     ],
//     "retry": {
//       "count": -50657150,
//       "interval": -91565669.0691471
//     },
//     "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": 384020
//   },
//   "type": "api",
//   "message": "Notification message",
//   "monitor_id": 12345678,
//   "public_id": "123-abc-456",
//   "status": "live",
//   "subtype": "http",
//   "tags": [
//     "env:production"
//   ]
// }

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

string operator;
int target;
string strVal;
int day;
string from;
string v_to;

string name = jResp.StringOf("name");
string Method = jResp.StringOf("config.request.method");
string v_Url = jResp.StringOf("config.request.url");
bool Accept_self_signed = jResp.BoolOf("options.accept_self_signed");
bool Allow_insecure = jResp.BoolOf("options.allow_insecure");
bool CheckCertificateRevocation = jResp.BoolOf("options.checkCertificateRevocation");
string ExecutionRule = jResp.StringOf("options.ci.executionRule");
bool DisableCors = jResp.BoolOf("options.disableCors");
bool DisableCsp = jResp.BoolOf("options.disableCsp");
bool Follow_redirects = jResp.BoolOf("options.follow_redirects");
string 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");
string 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");
string Interval = jResp.StringOf("options.retry.interval");
string ApplicationId = jResp.StringOf("options.rumSettings.applicationId");
int ClientTokenId = jResp.IntOf("options.rumSettings.clientTokenId");
bool IsEnabled = jResp.BoolOf("options.rumSettings.isEnabled");
string Timezone = jResp.StringOf("options.scheduling.timezone");
int Tick_every = jResp.IntOf("options.tick_every");
string v_type = jResp.StringOf("type");
string message = jResp.StringOf("message");
int monitor_id = jResp.IntOf("monitor_id");
string public_id = jResp.StringOf("public_id");
string status = jResp.StringOf("status");
string subtype = jResp.StringOf("subtype");
int i = 0;
int count_i = jResp.SizeOfArray("config.assertions");
while (i < count_i) {
    jResp.I = i;
    operator = jResp.StringOf("config.assertions[i].operator");
    target = jResp.IntOf("config.assertions[i].target");
    v_type = jResp.StringOf("config.assertions[i].type");
    i = i + 1;
}

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

i = 0;
count_i = jResp.SizeOfArray("options.device_ids");
while (i < count_i) {
    jResp.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.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.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("tags");
while (i < count_i) {
    jResp.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/api/:public_id

Postman Collection Item JSON

{
  "name": "Get an API test",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v1/synthetics/tests/api/:public_id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v1",
        "synthetics",
        "tests",
        "api",
        ":public_id"
      ],
      "variable": [
        {
          "key": "public_id",
          "value": "tempor Ut sed velit"
        }
      ]
    },
    "description": "Get the detailed configuration associated with\na Synthetic API 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/api/:public_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "synthetics",
            "tests",
            "api",
            ":public_id"
          ],
          "variable": [
            {
              "key": "public_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"name\": \"Example test name\",\n  \"config\": {\n    \"assertions\": [\n      {\n        \"operator\": \"lessThan\",\n        \"target\": 1000,\n        \"type\": \"responseTime\"\n      }\n    ],\n    \"request\": {\n      \"method\": \"GET\",\n      \"url\": \"https://example.com\"\n    }\n  },\n  \"locations\": [\n    \"aws:eu-west-3\"\n  ],\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\": false,\n    \"disableCsp\": false,\n    \"follow_redirects\": true,\n    \"httpVersion\": \"http1\",\n    \"ignoreServerCertificateError\": false,\n    \"initialNavigationTimeout\": 87780679,\n    \"min_failure_duration\": -32472759,\n    \"min_location_failed\": -5806955,\n    \"monitor_name\": \"et deserunt \",\n    \"monitor_options\": {\n      \"renotify_interval\": 834\n    },\n    \"monitor_priority\": 3,\n    \"noScreenshot\": false,\n    \"restricted_roles\": [\n      \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n    ],\n    \"retry\": {\n      \"count\": -50657150,\n      \"interval\": -91565669.0691471\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\": 384020\n  },\n  \"type\": \"api\",\n  \"message\": \"Notification message\",\n  \"monitor_id\": 12345678,\n  \"public_id\": \"123-abc-456\",\n  \"status\": \"live\",\n  \"subtype\": \"http\",\n  \"tags\": [\n    \"env:production\"\n  ]\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/api/:public_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "synthetics",
            "tests",
            "api",
            ":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 Monitoring 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/api/:public_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "synthetics",
            "tests",
            "api",
            ":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/api/:public_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "synthetics",
            "tests",
            "api",
            ":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}"
    }
  ]
}