Back to Collection Items
var
http: HCkHttp;
success: Boolean;
sbResponseBody: HCkStringBuilder;
jResp: HCkJsonObject;
respStatusCode: Integer;
operator: PWideChar;
target: Integer;
strVal: PWideChar;
day: Integer;
from: PWideChar;
v_to: PWideChar;
name: PWideChar;
Method: PWideChar;
v_Url: PWideChar;
Accept_self_signed: Boolean;
Allow_insecure: Boolean;
CheckCertificateRevocation: Boolean;
ExecutionRule: PWideChar;
DisableCors: Boolean;
DisableCsp: Boolean;
Follow_redirects: Boolean;
HttpVersion: PWideChar;
IgnoreServerCertificateError: Boolean;
InitialNavigationTimeout: Integer;
Min_failure_duration: Integer;
Min_location_failed: Integer;
Monitor_name: PWideChar;
Renotify_interval: Integer;
Monitor_priority: Integer;
NoScreenshot: Boolean;
Count: Integer;
Interval: PWideChar;
ApplicationId: PWideChar;
ClientTokenId: Integer;
IsEnabled: Boolean;
Timezone: PWideChar;
Tick_every: Integer;
v_type: PWideChar;
message: PWideChar;
monitor_id: Integer;
public_id: PWideChar;
status: PWideChar;
subtype: PWideChar;
i: Integer;
count_i: Integer;
begin
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http := CkHttp_Create();
CkHttp_SetRequestHeader(http,'Accept','application/json');
sbResponseBody := CkStringBuilder_Create();
success := CkHttp_QuickGetSb(http,'https://api.app.ddog-gov.com/api/v1/synthetics/tests/api/:public_id',sbResponseBody);
if (success = False) then
begin
Memo1.Lines.Add(CkHttp__lastErrorText(http));
Exit;
end;
jResp := CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,False);
Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(CkJsonObject__emit(jResp));
respStatusCode := CkHttp_getLastStatus(http);
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
begin
Memo1.Lines.Add('Response Header:');
Memo1.Lines.Add(CkHttp__lastHeader(http));
Memo1.Lines.Add('Failed.');
Exit;
end;
// 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
name := CkJsonObject__stringOf(jResp,'name');
Method := CkJsonObject__stringOf(jResp,'config.request.method');
v_Url := CkJsonObject__stringOf(jResp,'config.request.url');
Accept_self_signed := CkJsonObject_BoolOf(jResp,'options.accept_self_signed');
Allow_insecure := CkJsonObject_BoolOf(jResp,'options.allow_insecure');
CheckCertificateRevocation := CkJsonObject_BoolOf(jResp,'options.checkCertificateRevocation');
ExecutionRule := CkJsonObject__stringOf(jResp,'options.ci.executionRule');
DisableCors := CkJsonObject_BoolOf(jResp,'options.disableCors');
DisableCsp := CkJsonObject_BoolOf(jResp,'options.disableCsp');
Follow_redirects := CkJsonObject_BoolOf(jResp,'options.follow_redirects');
HttpVersion := CkJsonObject__stringOf(jResp,'options.httpVersion');
IgnoreServerCertificateError := CkJsonObject_BoolOf(jResp,'options.ignoreServerCertificateError');
InitialNavigationTimeout := CkJsonObject_IntOf(jResp,'options.initialNavigationTimeout');
Min_failure_duration := CkJsonObject_IntOf(jResp,'options.min_failure_duration');
Min_location_failed := CkJsonObject_IntOf(jResp,'options.min_location_failed');
Monitor_name := CkJsonObject__stringOf(jResp,'options.monitor_name');
Renotify_interval := CkJsonObject_IntOf(jResp,'options.monitor_options.renotify_interval');
Monitor_priority := CkJsonObject_IntOf(jResp,'options.monitor_priority');
NoScreenshot := CkJsonObject_BoolOf(jResp,'options.noScreenshot');
Count := CkJsonObject_IntOf(jResp,'options.retry.count');
Interval := CkJsonObject__stringOf(jResp,'options.retry.interval');
ApplicationId := CkJsonObject__stringOf(jResp,'options.rumSettings.applicationId');
ClientTokenId := CkJsonObject_IntOf(jResp,'options.rumSettings.clientTokenId');
IsEnabled := CkJsonObject_BoolOf(jResp,'options.rumSettings.isEnabled');
Timezone := CkJsonObject__stringOf(jResp,'options.scheduling.timezone');
Tick_every := CkJsonObject_IntOf(jResp,'options.tick_every');
v_type := CkJsonObject__stringOf(jResp,'type');
message := CkJsonObject__stringOf(jResp,'message');
monitor_id := CkJsonObject_IntOf(jResp,'monitor_id');
public_id := CkJsonObject__stringOf(jResp,'public_id');
status := CkJsonObject__stringOf(jResp,'status');
subtype := CkJsonObject__stringOf(jResp,'subtype');
i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'config.assertions');
while i < count_i do
begin
CkJsonObject_putI(jResp,i);
operator := CkJsonObject__stringOf(jResp,'config.assertions[i].operator');
target := CkJsonObject_IntOf(jResp,'config.assertions[i].target');
v_type := CkJsonObject__stringOf(jResp,'config.assertions[i].type');
i := i + 1;
end;
i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'locations');
while i < count_i do
begin
CkJsonObject_putI(jResp,i);
strVal := CkJsonObject__stringOf(jResp,'locations[i]');
i := i + 1;
end;
i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'options.device_ids');
while i < count_i do
begin
CkJsonObject_putI(jResp,i);
strVal := CkJsonObject__stringOf(jResp,'options.device_ids[i]');
i := i + 1;
end;
i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'options.restricted_roles');
while i < count_i do
begin
CkJsonObject_putI(jResp,i);
strVal := CkJsonObject__stringOf(jResp,'options.restricted_roles[i]');
i := i + 1;
end;
i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'options.scheduling.timeframes');
while i < count_i do
begin
CkJsonObject_putI(jResp,i);
day := CkJsonObject_IntOf(jResp,'options.scheduling.timeframes[i].day');
from := CkJsonObject__stringOf(jResp,'options.scheduling.timeframes[i].from');
v_to := CkJsonObject__stringOf(jResp,'options.scheduling.timeframes[i].to');
i := i + 1;
end;
i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'tags');
while i < count_i do
begin
CkJsonObject_putI(jResp,i);
strVal := CkJsonObject__stringOf(jResp,'tags[i]');
i := i + 1;
end;
CkHttp_Dispose(http);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
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}"
}
]
}
