Back to Collection Items
#include <CkHttp.h>
#include <CkJsonObject.h>
#include <CkStringBuilder.h>
#include <CkHttpResponse.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;
// Use this online tool to generate code from sample JSON: Generate Code to Create JSON
// The following JSON is sent in the request body.
// {
// "config": {
// "request": {
// "allow_insecure": false,
// "basicAuth": {
// "password": "PaSSw0RD!",
// "username": "my_username",
// "type": "web"
// },
// "body": "dolore",
// "bodyType": "text/plain",
// "callType": "unary",
// "certificate": {
// "cert": {
// "content": "dolor mollit id eu",
// "filename": "enim ",
// "updatedAt": "ad labore d"
// },
// "key": {
// "content": "anim ut consequat eiusmod",
// "filename": "non consectetur voluptate",
// "updatedAt": "proi"
// }
// },
// "compressedJsonDescriptor": "velit cillum",
// "dnsServer": "sint irure sit commodo",
// "dnsServerPort": 63263,
// "follow_redirects": true,
// "headers": {
// "nulla_735": "esse enim velit",
// "nulla_b_": "laboris ut"
// },
// "host": "aliquip nostrud",
// "message": "Lorem laboris",
// "metadata": {
// "eub0d": "sint",
// "exercitation1": "ut Duis"
// },
// "method": "dolo",
// "noSavingResponseBody": false,
// "numberOfPackets": 1,
// "persistCookies": true,
// "port": 82704033,
// "proxy": {
// "url": "https://example.com",
// "headers": {
// "ipsum83a": "ea laborum",
// "irure_8": "dolor eiusmod aliqua ",
// "esse67f": "veniam qui in"
// }
// },
// "query": {},
// "servername": "Duis sed minim quis",
// "service": "Greeter",
// "shouldTrackHops": false,
// "timeout": 48414705.45711616,
// "url": "https://example.com"
// },
// "configVariables": [
// {
// "description": "Example for the variable.",
// "type": "string"
// },
// {
// "description": "Example for the variable.",
// "type": "string"
// }
// ],
// "setCookie": "anim",
// "variables": [
// {
// "description": "Example for the variable.",
// "type": "string"
// },
// {
// "description": "Example for the variable.",
// "type": "string"
// }
// ]
// },
// "locations": [
// "aws:eu-west-3"
// ],
// "name": "Example test name",
// "options": {
// "accept_self_signed": true,
// "allow_insecure": false,
// "checkCertificateRevocation": false,
// "ci": {
// "executionRule": "skipped"
// },
// "device_ids": [
// "laptop_large",
// "laptop_large"
// ],
// "disableCors": true,
// "disableCsp": false,
// "follow_redirects": true,
// "httpVersion": "http2",
// "ignoreServerCertificateError": false,
// "initialNavigationTimeout": -93160400,
// "min_failure_duration": 9338007,
// "min_location_failed": -22553383,
// "monitor_name": "nostrud dolor ullamco",
// "monitor_options": {
// "renotify_interval": 261
// },
// "monitor_priority": 3,
// "noScreenshot": false,
// "restricted_roles": [
// "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
// ],
// "retry": {
// "count": 67368482,
// "interval": 59042710.53770983
// },
// "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": 427884
// },
// "type": "browser",
// "message": "",
// "monitor_id": -23388126,
// "public_id": "cupidatat ipsum",
// "status": "live",
// "steps": [
// {
// "allowFailure": false,
// "isCritical": true,
// "name": "proident dolore ex",
// "noScreenshot": true,
// "params": {},
// "timeout": 70509439,
// "type": "assertElementContent"
// },
// {
// "allowFailure": true,
// "isCritical": true,
// "name": "adipisicing volupt",
// "noScreenshot": false,
// "params": {},
// "timeout": -22942790,
// "type": "assertElementContent"
// }
// ],
// "tags": [
// "env:prod"
// ]
// }
CkJsonObject json;
json.UpdateBool("config.request.allow_insecure",false);
json.UpdateString("config.request.basicAuth.password","PaSSw0RD!");
json.UpdateString("config.request.basicAuth.username","my_username");
json.UpdateString("config.request.basicAuth.type","web");
json.UpdateString("config.request.body","dolore");
json.UpdateString("config.request.bodyType","text/plain");
json.UpdateString("config.request.callType","unary");
json.UpdateString("config.request.certificate.cert.content","dolor mollit id eu");
json.UpdateString("config.request.certificate.cert.filename","enim ");
json.UpdateString("config.request.certificate.cert.updatedAt","ad labore d");
json.UpdateString("config.request.certificate.key.content","anim ut consequat eiusmod");
json.UpdateString("config.request.certificate.key.filename","non consectetur voluptate");
json.UpdateString("config.request.certificate.key.updatedAt","proi");
json.UpdateString("config.request.compressedJsonDescriptor","velit cillum");
json.UpdateString("config.request.dnsServer","sint irure sit commodo");
json.UpdateInt("config.request.dnsServerPort",63263);
json.UpdateBool("config.request.follow_redirects",true);
json.UpdateString("config.request.headers.nulla_735","esse enim velit");
json.UpdateString("config.request.headers.nulla_b_","laboris ut");
json.UpdateString("config.request.host","aliquip nostrud");
json.UpdateString("config.request.message","Lorem laboris");
json.UpdateString("config.request.metadata.eub0d","sint");
json.UpdateString("config.request.metadata.exercitation1","ut Duis");
json.UpdateString("config.request.method","dolo");
json.UpdateBool("config.request.noSavingResponseBody",false);
json.UpdateInt("config.request.numberOfPackets",1);
json.UpdateBool("config.request.persistCookies",true);
json.UpdateInt("config.request.port",82704033);
json.UpdateString("config.request.proxy.url","https://example.com");
json.UpdateString("config.request.proxy.headers.ipsum83a","ea laborum");
json.UpdateString("config.request.proxy.headers.irure_8","dolor eiusmod aliqua ");
json.UpdateString("config.request.proxy.headers.esse67f","veniam qui in");
json.UpdateNewObject("config.request.query");
json.UpdateString("config.request.servername","Duis sed minim quis");
json.UpdateString("config.request.service","Greeter");
json.UpdateBool("config.request.shouldTrackHops",false);
json.UpdateNumber("config.request.timeout","48414705.45711616");
json.UpdateString("config.request.url","https://example.com");
json.UpdateString("config.configVariables[0].description","Example for the variable.");
json.UpdateString("config.configVariables[0].type","string");
json.UpdateString("config.configVariables[1].description","Example for the variable.");
json.UpdateString("config.configVariables[1].type","string");
json.UpdateString("config.setCookie","anim");
json.UpdateString("config.variables[0].description","Example for the variable.");
json.UpdateString("config.variables[0].type","string");
json.UpdateString("config.variables[1].description","Example for the variable.");
json.UpdateString("config.variables[1].type","string");
json.UpdateString("locations[0]","aws:eu-west-3");
json.UpdateString("name","Example test name");
json.UpdateBool("options.accept_self_signed",true);
json.UpdateBool("options.allow_insecure",false);
json.UpdateBool("options.checkCertificateRevocation",false);
json.UpdateString("options.ci.executionRule","skipped");
json.UpdateString("options.device_ids[0]","laptop_large");
json.UpdateString("options.device_ids[1]","laptop_large");
json.UpdateBool("options.disableCors",true);
json.UpdateBool("options.disableCsp",false);
json.UpdateBool("options.follow_redirects",true);
json.UpdateString("options.httpVersion","http2");
json.UpdateBool("options.ignoreServerCertificateError",false);
json.UpdateInt("options.initialNavigationTimeout",-93160400);
json.UpdateInt("options.min_failure_duration",9338007);
json.UpdateInt("options.min_location_failed",-22553383);
json.UpdateString("options.monitor_name","nostrud dolor ullamco");
json.UpdateInt("options.monitor_options.renotify_interval",261);
json.UpdateInt("options.monitor_priority",3);
json.UpdateBool("options.noScreenshot",false);
json.UpdateString("options.restricted_roles[0]","xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx");
json.UpdateInt("options.retry.count",67368482);
json.UpdateNumber("options.retry.interval","59042710.53770983");
json.UpdateString("options.rumSettings.applicationId","xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx");
json.UpdateInt("options.rumSettings.clientTokenId",12345);
json.UpdateBool("options.rumSettings.isEnabled",true);
json.UpdateInt("options.scheduling.timeframes[0].day",1);
json.UpdateString("options.scheduling.timeframes[0].from","07:00");
json.UpdateString("options.scheduling.timeframes[0].to","16:00");
json.UpdateInt("options.scheduling.timeframes[1].day",3);
json.UpdateString("options.scheduling.timeframes[1].from","07:00");
json.UpdateString("options.scheduling.timeframes[1].to","16:00");
json.UpdateString("options.scheduling.timezone","America/New_York");
json.UpdateInt("options.tick_every",427884);
json.UpdateString("type","browser");
json.UpdateString("message","");
json.UpdateInt("monitor_id",-23388126);
json.UpdateString("public_id","cupidatat ipsum");
json.UpdateString("status","live");
json.UpdateBool("steps[0].allowFailure",false);
json.UpdateBool("steps[0].isCritical",true);
json.UpdateString("steps[0].name","proident dolore ex");
json.UpdateBool("steps[0].noScreenshot",true);
json.UpdateNewObject("steps[0].params");
json.UpdateInt("steps[0].timeout",70509439);
json.UpdateString("steps[0].type","assertElementContent");
json.UpdateBool("steps[1].allowFailure",true);
json.UpdateBool("steps[1].isCritical",true);
json.UpdateString("steps[1].name","adipisicing volupt");
json.UpdateBool("steps[1].noScreenshot",false);
json.UpdateNewObject("steps[1].params");
json.UpdateInt("steps[1].timeout",-22942790);
json.UpdateString("steps[1].type","assertElementContent");
json.UpdateString("tags[0]","env:prod");
http.SetRequestHeader("Content-Type","application/json");
http.SetRequestHeader("Accept","application/json");
CkStringBuilder sbRequestBody;
json.EmitSb(sbRequestBody);
CkHttpResponse *resp = http.PTextSb("PUT","https://api.app.ddog-gov.com/api/v1/synthetics/tests/browser/:public_id",sbRequestBody,"utf-8","application/json",false,false);
if (http.get_LastMethodSuccess() == false) {
std::cout << http.lastErrorText() << "\r\n";
return;
}
CkStringBuilder sbResponseBody;
resp->GetBodySb(sbResponseBody);
CkJsonObject jResp;
jResp.LoadSb(sbResponseBody);
jResp.put_EmitCompact(false);
std::cout << "Response Body:" << "\r\n";
std::cout << jResp.emit() << "\r\n";
int respStatusCode = resp->get_StatusCode();
std::cout << "Response Status Code = " << respStatusCode << "\r\n";
if (respStatusCode >= 400) {
std::cout << "Response Header:" << "\r\n";
std::cout << resp->header() << "\r\n";
std::cout << "Failed." << "\r\n";
delete resp;
return;
}
delete resp;
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "config": {
// "request": {
// "allow_insecure": false,
// "basicAuth": {
// "password": "PaSSw0RD!",
// "username": "my_username",
// "type": "web"
// },
// "body": "dolore",
// "bodyType": "text/plain",
// "callType": "unary",
// "certificate": {
// "cert": {
// "content": "dolor mollit id eu",
// "filename": "enim ",
// "updatedAt": "ad labore d"
// },
// "key": {
// "content": "anim ut consequat eiusmod",
// "filename": "non consectetur voluptate",
// "updatedAt": "proi"
// }
// },
// "compressedJsonDescriptor": "velit cillum",
// "dnsServer": "sint irure sit commodo",
// "dnsServerPort": 63263,
// "follow_redirects": true,
// "headers": {
// "nulla_735": "esse enim velit",
// "nulla_b_": "laboris ut"
// },
// "host": "aliquip nostrud",
// "message": "Lorem laboris",
// "metadata": {
// "eub0d": "sint",
// "exercitation1": "ut Duis"
// },
// "method": "dolo",
// "noSavingResponseBody": false,
// "numberOfPackets": 1,
// "persistCookies": true,
// "port": 82704033,
// "proxy": {
// "url": "https://example.com",
// "headers": {
// "ipsum83a": "ea laborum",
// "irure_8": "dolor eiusmod aliqua ",
// "esse67f": "veniam qui in"
// }
// },
// "query": {},
// "servername": "Duis sed minim quis",
// "service": "Greeter",
// "shouldTrackHops": false,
// "timeout": 48414705.45711616,
// "url": "https://example.com"
// },
// "configVariables": [
// {
// "description": "Example for the variable.",
// "type": "string"
// },
// {
// "description": "Example for the variable.",
// "type": "string"
// }
// ],
// "setCookie": "anim",
// "variables": [
// {
// "description": "Example for the variable.",
// "type": "string"
// },
// {
// "description": "Example for the variable.",
// "type": "string"
// }
// ]
// },
// "locations": [
// "aws:eu-west-3"
// ],
// "name": "Example test name",
// "options": {
// "accept_self_signed": true,
// "allow_insecure": false,
// "checkCertificateRevocation": false,
// "ci": {
// "executionRule": "skipped"
// },
// "device_ids": [
// "laptop_large",
// "laptop_large"
// ],
// "disableCors": true,
// "disableCsp": false,
// "follow_redirects": true,
// "httpVersion": "http2",
// "ignoreServerCertificateError": false,
// "initialNavigationTimeout": -93160400,
// "min_failure_duration": 9338007,
// "min_location_failed": -22553383,
// "monitor_name": "nostrud dolor ullamco",
// "monitor_options": {
// "renotify_interval": 261
// },
// "monitor_priority": 3,
// "noScreenshot": false,
// "restricted_roles": [
// "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
// ],
// "retry": {
// "count": 67368482,
// "interval": 59042710.53770983
// },
// "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": 427884
// },
// "type": "browser",
// "message": "",
// "monitor_id": -23388126,
// "public_id": "cupidatat ipsum",
// "status": "live",
// "steps": [
// {
// "allowFailure": false,
// "isCritical": true,
// "name": "proident dolore ex",
// "noScreenshot": true,
// "params": {},
// "timeout": 70509439,
// "type": "assertElementContent"
// },
// {
// "allowFailure": true,
// "isCritical": true,
// "name": "adipisicing volupt",
// "noScreenshot": false,
// "params": {},
// "timeout": -22942790,
// "type": "assertElementContent"
// }
// ],
// "tags": [
// "env:prod"
// ]
// }
// 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 *Nulla_735 = jResp.stringOf("config.request.headers.nulla_735");
const char *Nulla_b_ = jResp.stringOf("config.request.headers.nulla_b_");
const char *Host = jResp.stringOf("config.request.host");
const char *Message = jResp.stringOf("config.request.message");
const char *Eub0d = jResp.stringOf("config.request.metadata.eub0d");
const char *Exercitation1 = jResp.stringOf("config.request.metadata.exercitation1");
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 *Ipsum83a = jResp.stringOf("config.request.proxy.headers.ipsum83a");
const char *Irure_8 = jResp.stringOf("config.request.proxy.headers.irure_8");
const char *Esse67f = jResp.stringOf("config.request.proxy.headers.esse67f");
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 *SetCookie = jResp.stringOf("config.setCookie");
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 *v_type = jResp.stringOf("type");
const char *message = jResp.stringOf("message");
int monitor_id = jResp.IntOf("monitor_id");
const char *public_id = jResp.stringOf("public_id");
const char *status = jResp.stringOf("status");
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 PUT
-H "Content-Type: application/json"
-H "Accept: application/json"
-d '{
"config": {
"request": {
"allow_insecure": false,
"basicAuth": {
"password": "PaSSw0RD!",
"username": "my_username",
"type": "web"
},
"body": "dolore",
"bodyType": "text/plain",
"callType": "unary",
"certificate": {
"cert": {
"content": "dolor mollit id eu",
"filename": "enim ",
"updatedAt": "ad labore d"
},
"key": {
"content": "anim ut consequat eiusmod",
"filename": "non consectetur voluptate",
"updatedAt": "proi"
}
},
"compressedJsonDescriptor": "velit cillum",
"dnsServer": "sint irure sit commodo",
"dnsServerPort": 63263,
"follow_redirects": true,
"headers": {
"nulla_735": "esse enim velit",
"nulla_b_": "laboris ut"
},
"host": "aliquip nostrud",
"message": "Lorem laboris",
"metadata": {
"eub0d": "sint",
"exercitation1": "ut Duis"
},
"method": "dolo",
"noSavingResponseBody": false,
"numberOfPackets": 1,
"persistCookies": true,
"port": 82704033,
"proxy": {
"url": "https://example.com",
"headers": {
"ipsum83a": "ea laborum",
"irure_8": "dolor eiusmod aliqua ",
"esse67f": "veniam qui in"
}
},
"query": {},
"servername": "Duis sed minim quis",
"service": "Greeter",
"shouldTrackHops": false,
"timeout": 48414705.45711616,
"url": "https://example.com"
},
"configVariables": [
{
"description": "Example for the variable.",
"type": "string"
},
{
"description": "Example for the variable.",
"type": "string"
}
],
"setCookie": "anim",
"variables": [
{
"description": "Example for the variable.",
"type": "string"
},
{
"description": "Example for the variable.",
"type": "string"
}
]
},
"locations": [
"aws:eu-west-3"
],
"name": "Example test name",
"options": {
"accept_self_signed": true,
"allow_insecure": false,
"checkCertificateRevocation": false,
"ci": {
"executionRule": "skipped"
},
"device_ids": [
"laptop_large",
"laptop_large"
],
"disableCors": true,
"disableCsp": false,
"follow_redirects": true,
"httpVersion": "http2",
"ignoreServerCertificateError": false,
"initialNavigationTimeout": -93160400,
"min_failure_duration": 9338007,
"min_location_failed": -22553383,
"monitor_name": "nostrud dolor ullamco",
"monitor_options": {
"renotify_interval": 261
},
"monitor_priority": 3,
"noScreenshot": false,
"restricted_roles": [
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
],
"retry": {
"count": 67368482,
"interval": 59042710.53770983
},
"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": 427884
},
"type": "browser",
"message": "",
"monitor_id": -23388126,
"public_id": "cupidatat ipsum",
"status": "live",
"steps": [
{
"allowFailure": false,
"isCritical": true,
"name": "proident dolore ex",
"noScreenshot": true,
"params": {},
"timeout": 70509439,
"type": "assertElementContent"
},
{
"allowFailure": true,
"isCritical": true,
"name": "adipisicing volupt",
"noScreenshot": false,
"params": {},
"timeout": -22942790,
"type": "assertElementContent"
}
],
"tags": [
"env:prod"
]
}'
https://api.app.ddog-gov.com/api/v1/synthetics/tests/browser/:public_id
Postman Collection Item JSON
{
"name": "Edit a browser test",
"request": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"config\": {\n \"request\": {\n \"allow_insecure\": false,\n \"basicAuth\": {\n \"password\": \"PaSSw0RD!\",\n \"username\": \"my_username\",\n \"type\": \"web\"\n },\n \"body\": \"dolore\",\n \"bodyType\": \"text/plain\",\n \"callType\": \"unary\",\n \"certificate\": {\n \"cert\": {\n \"content\": \"dolor mollit id eu\",\n \"filename\": \"enim \",\n \"updatedAt\": \"ad labore d\"\n },\n \"key\": {\n \"content\": \"anim ut consequat eiusmod\",\n \"filename\": \"non consectetur voluptate\",\n \"updatedAt\": \"proi\"\n }\n },\n \"compressedJsonDescriptor\": \"velit cillum\",\n \"dnsServer\": \"sint irure sit commodo\",\n \"dnsServerPort\": 63263,\n \"follow_redirects\": true,\n \"headers\": {\n \"nulla_735\": \"esse enim velit\",\n \"nulla_b_\": \"laboris ut\"\n },\n \"host\": \"aliquip nostrud\",\n \"message\": \"Lorem laboris\",\n \"metadata\": {\n \"eub0d\": \"sint\",\n \"exercitation1\": \"ut Duis\"\n },\n \"method\": \"dolo\",\n \"noSavingResponseBody\": false,\n \"numberOfPackets\": 1,\n \"persistCookies\": true,\n \"port\": 82704033,\n \"proxy\": {\n \"url\": \"https://example.com\",\n \"headers\": {\n \"ipsum83a\": \"ea laborum\",\n \"irure_8\": \"dolor eiusmod aliqua \",\n \"esse67f\": \"veniam qui in\"\n }\n },\n \"query\": {},\n \"servername\": \"Duis sed minim quis\",\n \"service\": \"Greeter\",\n \"shouldTrackHops\": false,\n \"timeout\": 48414705.45711616,\n \"url\": \"https://example.com\"\n },\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 \"setCookie\": \"anim\",\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 \"locations\": [\n \"aws:eu-west-3\"\n ],\n \"name\": \"Example test name\",\n \"options\": {\n \"accept_self_signed\": true,\n \"allow_insecure\": false,\n \"checkCertificateRevocation\": false,\n \"ci\": {\n \"executionRule\": \"skipped\"\n },\n \"device_ids\": [\n \"laptop_large\",\n \"laptop_large\"\n ],\n \"disableCors\": true,\n \"disableCsp\": false,\n \"follow_redirects\": true,\n \"httpVersion\": \"http2\",\n \"ignoreServerCertificateError\": false,\n \"initialNavigationTimeout\": -93160400,\n \"min_failure_duration\": 9338007,\n \"min_location_failed\": -22553383,\n \"monitor_name\": \"nostrud dolor ullamco\",\n \"monitor_options\": {\n \"renotify_interval\": 261\n },\n \"monitor_priority\": 3,\n \"noScreenshot\": false,\n \"restricted_roles\": [\n \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n ],\n \"retry\": {\n \"count\": 67368482,\n \"interval\": 59042710.53770983\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\": 427884\n },\n \"type\": \"browser\",\n \"message\": \"\",\n \"monitor_id\": -23388126,\n \"public_id\": \"cupidatat ipsum\",\n \"status\": \"live\",\n \"steps\": [\n {\n \"allowFailure\": false,\n \"isCritical\": true,\n \"name\": \"proident dolore ex\",\n \"noScreenshot\": true,\n \"params\": {},\n \"timeout\": 70509439,\n \"type\": \"assertElementContent\"\n },\n {\n \"allowFailure\": true,\n \"isCritical\": true,\n \"name\": \"adipisicing volupt\",\n \"noScreenshot\": false,\n \"params\": {},\n \"timeout\": -22942790,\n \"type\": \"assertElementContent\"\n }\n ],\n \"tags\": [\n \"env:prod\"\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/browser/:public_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
"browser",
":public_id"
],
"variable": [
{
"key": "public_id",
"value": "tempor Ut sed velit"
}
]
},
"description": "Edit the configuration of a Synthetic browser test."
},
"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 \"config\": {\n \"request\": {\n \"allow_insecure\": false,\n \"basicAuth\": {\n \"password\": \"PaSSw0RD!\",\n \"username\": \"my_username\",\n \"type\": \"web\"\n },\n \"body\": \"dolore\",\n \"bodyType\": \"text/plain\",\n \"callType\": \"unary\",\n \"certificate\": {\n \"cert\": {\n \"content\": \"dolor mollit id eu\",\n \"filename\": \"enim \",\n \"updatedAt\": \"ad labore d\"\n },\n \"key\": {\n \"content\": \"anim ut consequat eiusmod\",\n \"filename\": \"non consectetur voluptate\",\n \"updatedAt\": \"proi\"\n }\n },\n \"compressedJsonDescriptor\": \"velit cillum\",\n \"dnsServer\": \"sint irure sit commodo\",\n \"dnsServerPort\": 63263,\n \"follow_redirects\": true,\n \"headers\": {\n \"nulla_735\": \"esse enim velit\",\n \"nulla_b_\": \"laboris ut\"\n },\n \"host\": \"aliquip nostrud\",\n \"message\": \"Lorem laboris\",\n \"metadata\": {\n \"eub0d\": \"sint\",\n \"exercitation1\": \"ut Duis\"\n },\n \"method\": \"dolo\",\n \"noSavingResponseBody\": false,\n \"numberOfPackets\": 1,\n \"persistCookies\": true,\n \"port\": 82704033,\n \"proxy\": {\n \"url\": \"https://example.com\",\n \"headers\": {\n \"ipsum83a\": \"ea laborum\",\n \"irure_8\": \"dolor eiusmod aliqua \",\n \"esse67f\": \"veniam qui in\"\n }\n },\n \"query\": {},\n \"servername\": \"Duis sed minim quis\",\n \"service\": \"Greeter\",\n \"shouldTrackHops\": false,\n \"timeout\": 48414705.45711616,\n \"url\": \"https://example.com\"\n },\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 \"setCookie\": \"anim\",\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 \"locations\": [\n \"aws:eu-west-3\"\n ],\n \"name\": \"Example test name\",\n \"options\": {\n \"accept_self_signed\": true,\n \"allow_insecure\": false,\n \"checkCertificateRevocation\": false,\n \"ci\": {\n \"executionRule\": \"skipped\"\n },\n \"device_ids\": [\n \"laptop_large\",\n \"laptop_large\"\n ],\n \"disableCors\": true,\n \"disableCsp\": false,\n \"follow_redirects\": true,\n \"httpVersion\": \"http2\",\n \"ignoreServerCertificateError\": false,\n \"initialNavigationTimeout\": -93160400,\n \"min_failure_duration\": 9338007,\n \"min_location_failed\": -22553383,\n \"monitor_name\": \"nostrud dolor ullamco\",\n \"monitor_options\": {\n \"renotify_interval\": 261\n },\n \"monitor_priority\": 3,\n \"noScreenshot\": false,\n \"restricted_roles\": [\n \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n ],\n \"retry\": {\n \"count\": 67368482,\n \"interval\": 59042710.53770983\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\": 427884\n },\n \"type\": \"browser\",\n \"message\": \"\",\n \"monitor_id\": -23388126,\n \"public_id\": \"cupidatat ipsum\",\n \"status\": \"live\",\n \"steps\": [\n {\n \"allowFailure\": false,\n \"isCritical\": true,\n \"name\": \"proident dolore ex\",\n \"noScreenshot\": true,\n \"params\": {},\n \"timeout\": 70509439,\n \"type\": \"assertElementContent\"\n },\n {\n \"allowFailure\": true,\n \"isCritical\": true,\n \"name\": \"adipisicing volupt\",\n \"noScreenshot\": false,\n \"params\": {},\n \"timeout\": -22942790,\n \"type\": \"assertElementContent\"\n }\n ],\n \"tags\": [\n \"env:prod\"\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/browser/:public_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
"browser",
":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 \"request\": {\n \"allow_insecure\": false,\n \"basicAuth\": {\n \"password\": \"PaSSw0RD!\",\n \"username\": \"my_username\",\n \"type\": \"web\"\n },\n \"body\": \"dolore\",\n \"bodyType\": \"text/plain\",\n \"callType\": \"unary\",\n \"certificate\": {\n \"cert\": {\n \"content\": \"dolor mollit id eu\",\n \"filename\": \"enim \",\n \"updatedAt\": \"ad labore d\"\n },\n \"key\": {\n \"content\": \"anim ut consequat eiusmod\",\n \"filename\": \"non consectetur voluptate\",\n \"updatedAt\": \"proi\"\n }\n },\n \"compressedJsonDescriptor\": \"velit cillum\",\n \"dnsServer\": \"sint irure sit commodo\",\n \"dnsServerPort\": 63263,\n \"follow_redirects\": true,\n \"headers\": {\n \"nulla_735\": \"esse enim velit\",\n \"nulla_b_\": \"laboris ut\"\n },\n \"host\": \"aliquip nostrud\",\n \"message\": \"Lorem laboris\",\n \"metadata\": {\n \"eub0d\": \"sint\",\n \"exercitation1\": \"ut Duis\"\n },\n \"method\": \"dolo\",\n \"noSavingResponseBody\": false,\n \"numberOfPackets\": 1,\n \"persistCookies\": true,\n \"port\": 82704033,\n \"proxy\": {\n \"url\": \"https://example.com\",\n \"headers\": {\n \"ipsum83a\": \"ea laborum\",\n \"irure_8\": \"dolor eiusmod aliqua \",\n \"esse67f\": \"veniam qui in\"\n }\n },\n \"query\": {},\n \"servername\": \"Duis sed minim quis\",\n \"service\": \"Greeter\",\n \"shouldTrackHops\": false,\n \"timeout\": 48414705.45711616,\n \"url\": \"https://example.com\"\n },\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 \"setCookie\": \"anim\",\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 \"locations\": [\n \"aws:eu-west-3\"\n ],\n \"name\": \"Example test name\",\n \"options\": {\n \"accept_self_signed\": true,\n \"allow_insecure\": false,\n \"checkCertificateRevocation\": false,\n \"ci\": {\n \"executionRule\": \"skipped\"\n },\n \"device_ids\": [\n \"laptop_large\",\n \"laptop_large\"\n ],\n \"disableCors\": true,\n \"disableCsp\": false,\n \"follow_redirects\": true,\n \"httpVersion\": \"http2\",\n \"ignoreServerCertificateError\": false,\n \"initialNavigationTimeout\": -93160400,\n \"min_failure_duration\": 9338007,\n \"min_location_failed\": -22553383,\n \"monitor_name\": \"nostrud dolor ullamco\",\n \"monitor_options\": {\n \"renotify_interval\": 261\n },\n \"monitor_priority\": 3,\n \"noScreenshot\": false,\n \"restricted_roles\": [\n \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n ],\n \"retry\": {\n \"count\": 67368482,\n \"interval\": 59042710.53770983\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\": 427884\n },\n \"type\": \"browser\",\n \"message\": \"\",\n \"monitor_id\": -23388126,\n \"public_id\": \"cupidatat ipsum\",\n \"status\": \"live\",\n \"steps\": [\n {\n \"allowFailure\": false,\n \"isCritical\": true,\n \"name\": \"proident dolore ex\",\n \"noScreenshot\": true,\n \"params\": {},\n \"timeout\": 70509439,\n \"type\": \"assertElementContent\"\n },\n {\n \"allowFailure\": true,\n \"isCritical\": true,\n \"name\": \"adipisicing volupt\",\n \"noScreenshot\": false,\n \"params\": {},\n \"timeout\": -22942790,\n \"type\": \"assertElementContent\"\n }\n ],\n \"tags\": [\n \"env:prod\"\n ]\n}"
},
{
"name": "- JSON format is wrong\n- Updating sub-type is 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 \"config\": {\n \"request\": {\n \"allow_insecure\": false,\n \"basicAuth\": {\n \"password\": \"PaSSw0RD!\",\n \"username\": \"my_username\",\n \"type\": \"web\"\n },\n \"body\": \"dolore\",\n \"bodyType\": \"text/plain\",\n \"callType\": \"unary\",\n \"certificate\": {\n \"cert\": {\n \"content\": \"dolor mollit id eu\",\n \"filename\": \"enim \",\n \"updatedAt\": \"ad labore d\"\n },\n \"key\": {\n \"content\": \"anim ut consequat eiusmod\",\n \"filename\": \"non consectetur voluptate\",\n \"updatedAt\": \"proi\"\n }\n },\n \"compressedJsonDescriptor\": \"velit cillum\",\n \"dnsServer\": \"sint irure sit commodo\",\n \"dnsServerPort\": 63263,\n \"follow_redirects\": true,\n \"headers\": {\n \"nulla_735\": \"esse enim velit\",\n \"nulla_b_\": \"laboris ut\"\n },\n \"host\": \"aliquip nostrud\",\n \"message\": \"Lorem laboris\",\n \"metadata\": {\n \"eub0d\": \"sint\",\n \"exercitation1\": \"ut Duis\"\n },\n \"method\": \"dolo\",\n \"noSavingResponseBody\": false,\n \"numberOfPackets\": 1,\n \"persistCookies\": true,\n \"port\": 82704033,\n \"proxy\": {\n \"url\": \"https://example.com\",\n \"headers\": {\n \"ipsum83a\": \"ea laborum\",\n \"irure_8\": \"dolor eiusmod aliqua \",\n \"esse67f\": \"veniam qui in\"\n }\n },\n \"query\": {},\n \"servername\": \"Duis sed minim quis\",\n \"service\": \"Greeter\",\n \"shouldTrackHops\": false,\n \"timeout\": 48414705.45711616,\n \"url\": \"https://example.com\"\n },\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 \"setCookie\": \"anim\",\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 \"locations\": [\n \"aws:eu-west-3\"\n ],\n \"name\": \"Example test name\",\n \"options\": {\n \"accept_self_signed\": true,\n \"allow_insecure\": false,\n \"checkCertificateRevocation\": false,\n \"ci\": {\n \"executionRule\": \"skipped\"\n },\n \"device_ids\": [\n \"laptop_large\",\n \"laptop_large\"\n ],\n \"disableCors\": true,\n \"disableCsp\": false,\n \"follow_redirects\": true,\n \"httpVersion\": \"http2\",\n \"ignoreServerCertificateError\": false,\n \"initialNavigationTimeout\": -93160400,\n \"min_failure_duration\": 9338007,\n \"min_location_failed\": -22553383,\n \"monitor_name\": \"nostrud dolor ullamco\",\n \"monitor_options\": {\n \"renotify_interval\": 261\n },\n \"monitor_priority\": 3,\n \"noScreenshot\": false,\n \"restricted_roles\": [\n \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n ],\n \"retry\": {\n \"count\": 67368482,\n \"interval\": 59042710.53770983\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\": 427884\n },\n \"type\": \"browser\",\n \"message\": \"\",\n \"monitor_id\": -23388126,\n \"public_id\": \"cupidatat ipsum\",\n \"status\": \"live\",\n \"steps\": [\n {\n \"allowFailure\": false,\n \"isCritical\": true,\n \"name\": \"proident dolore ex\",\n \"noScreenshot\": true,\n \"params\": {},\n \"timeout\": 70509439,\n \"type\": \"assertElementContent\"\n },\n {\n \"allowFailure\": true,\n \"isCritical\": true,\n \"name\": \"adipisicing volupt\",\n \"noScreenshot\": false,\n \"params\": {},\n \"timeout\": -22942790,\n \"type\": \"assertElementContent\"\n }\n ],\n \"tags\": [\n \"env:prod\"\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/browser/:public_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
"browser",
":public_id"
],
"variable": [
{
"key": "public_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 \"config\": {\n \"request\": {\n \"allow_insecure\": false,\n \"basicAuth\": {\n \"password\": \"PaSSw0RD!\",\n \"username\": \"my_username\",\n \"type\": \"web\"\n },\n \"body\": \"dolore\",\n \"bodyType\": \"text/plain\",\n \"callType\": \"unary\",\n \"certificate\": {\n \"cert\": {\n \"content\": \"dolor mollit id eu\",\n \"filename\": \"enim \",\n \"updatedAt\": \"ad labore d\"\n },\n \"key\": {\n \"content\": \"anim ut consequat eiusmod\",\n \"filename\": \"non consectetur voluptate\",\n \"updatedAt\": \"proi\"\n }\n },\n \"compressedJsonDescriptor\": \"velit cillum\",\n \"dnsServer\": \"sint irure sit commodo\",\n \"dnsServerPort\": 63263,\n \"follow_redirects\": true,\n \"headers\": {\n \"nulla_735\": \"esse enim velit\",\n \"nulla_b_\": \"laboris ut\"\n },\n \"host\": \"aliquip nostrud\",\n \"message\": \"Lorem laboris\",\n \"metadata\": {\n \"eub0d\": \"sint\",\n \"exercitation1\": \"ut Duis\"\n },\n \"method\": \"dolo\",\n \"noSavingResponseBody\": false,\n \"numberOfPackets\": 1,\n \"persistCookies\": true,\n \"port\": 82704033,\n \"proxy\": {\n \"url\": \"https://example.com\",\n \"headers\": {\n \"ipsum83a\": \"ea laborum\",\n \"irure_8\": \"dolor eiusmod aliqua \",\n \"esse67f\": \"veniam qui in\"\n }\n },\n \"query\": {},\n \"servername\": \"Duis sed minim quis\",\n \"service\": \"Greeter\",\n \"shouldTrackHops\": false,\n \"timeout\": 48414705.45711616,\n \"url\": \"https://example.com\"\n },\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 \"setCookie\": \"anim\",\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 \"locations\": [\n \"aws:eu-west-3\"\n ],\n \"name\": \"Example test name\",\n \"options\": {\n \"accept_self_signed\": true,\n \"allow_insecure\": false,\n \"checkCertificateRevocation\": false,\n \"ci\": {\n \"executionRule\": \"skipped\"\n },\n \"device_ids\": [\n \"laptop_large\",\n \"laptop_large\"\n ],\n \"disableCors\": true,\n \"disableCsp\": false,\n \"follow_redirects\": true,\n \"httpVersion\": \"http2\",\n \"ignoreServerCertificateError\": false,\n \"initialNavigationTimeout\": -93160400,\n \"min_failure_duration\": 9338007,\n \"min_location_failed\": -22553383,\n \"monitor_name\": \"nostrud dolor ullamco\",\n \"monitor_options\": {\n \"renotify_interval\": 261\n },\n \"monitor_priority\": 3,\n \"noScreenshot\": false,\n \"restricted_roles\": [\n \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n ],\n \"retry\": {\n \"count\": 67368482,\n \"interval\": 59042710.53770983\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\": 427884\n },\n \"type\": \"browser\",\n \"message\": \"\",\n \"monitor_id\": -23388126,\n \"public_id\": \"cupidatat ipsum\",\n \"status\": \"live\",\n \"steps\": [\n {\n \"allowFailure\": false,\n \"isCritical\": true,\n \"name\": \"proident dolore ex\",\n \"noScreenshot\": true,\n \"params\": {},\n \"timeout\": 70509439,\n \"type\": \"assertElementContent\"\n },\n {\n \"allowFailure\": true,\n \"isCritical\": true,\n \"name\": \"adipisicing volupt\",\n \"noScreenshot\": false,\n \"params\": {},\n \"timeout\": -22942790,\n \"type\": \"assertElementContent\"\n }\n ],\n \"tags\": [\n \"env:prod\"\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/browser/:public_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
"browser",
":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\n- Test can't be found",
"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 \"config\": {\n \"request\": {\n \"allow_insecure\": false,\n \"basicAuth\": {\n \"password\": \"PaSSw0RD!\",\n \"username\": \"my_username\",\n \"type\": \"web\"\n },\n \"body\": \"dolore\",\n \"bodyType\": \"text/plain\",\n \"callType\": \"unary\",\n \"certificate\": {\n \"cert\": {\n \"content\": \"dolor mollit id eu\",\n \"filename\": \"enim \",\n \"updatedAt\": \"ad labore d\"\n },\n \"key\": {\n \"content\": \"anim ut consequat eiusmod\",\n \"filename\": \"non consectetur voluptate\",\n \"updatedAt\": \"proi\"\n }\n },\n \"compressedJsonDescriptor\": \"velit cillum\",\n \"dnsServer\": \"sint irure sit commodo\",\n \"dnsServerPort\": 63263,\n \"follow_redirects\": true,\n \"headers\": {\n \"nulla_735\": \"esse enim velit\",\n \"nulla_b_\": \"laboris ut\"\n },\n \"host\": \"aliquip nostrud\",\n \"message\": \"Lorem laboris\",\n \"metadata\": {\n \"eub0d\": \"sint\",\n \"exercitation1\": \"ut Duis\"\n },\n \"method\": \"dolo\",\n \"noSavingResponseBody\": false,\n \"numberOfPackets\": 1,\n \"persistCookies\": true,\n \"port\": 82704033,\n \"proxy\": {\n \"url\": \"https://example.com\",\n \"headers\": {\n \"ipsum83a\": \"ea laborum\",\n \"irure_8\": \"dolor eiusmod aliqua \",\n \"esse67f\": \"veniam qui in\"\n }\n },\n \"query\": {},\n \"servername\": \"Duis sed minim quis\",\n \"service\": \"Greeter\",\n \"shouldTrackHops\": false,\n \"timeout\": 48414705.45711616,\n \"url\": \"https://example.com\"\n },\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 \"setCookie\": \"anim\",\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 \"locations\": [\n \"aws:eu-west-3\"\n ],\n \"name\": \"Example test name\",\n \"options\": {\n \"accept_self_signed\": true,\n \"allow_insecure\": false,\n \"checkCertificateRevocation\": false,\n \"ci\": {\n \"executionRule\": \"skipped\"\n },\n \"device_ids\": [\n \"laptop_large\",\n \"laptop_large\"\n ],\n \"disableCors\": true,\n \"disableCsp\": false,\n \"follow_redirects\": true,\n \"httpVersion\": \"http2\",\n \"ignoreServerCertificateError\": false,\n \"initialNavigationTimeout\": -93160400,\n \"min_failure_duration\": 9338007,\n \"min_location_failed\": -22553383,\n \"monitor_name\": \"nostrud dolor ullamco\",\n \"monitor_options\": {\n \"renotify_interval\": 261\n },\n \"monitor_priority\": 3,\n \"noScreenshot\": false,\n \"restricted_roles\": [\n \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n ],\n \"retry\": {\n \"count\": 67368482,\n \"interval\": 59042710.53770983\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\": 427884\n },\n \"type\": \"browser\",\n \"message\": \"\",\n \"monitor_id\": -23388126,\n \"public_id\": \"cupidatat ipsum\",\n \"status\": \"live\",\n \"steps\": [\n {\n \"allowFailure\": false,\n \"isCritical\": true,\n \"name\": \"proident dolore ex\",\n \"noScreenshot\": true,\n \"params\": {},\n \"timeout\": 70509439,\n \"type\": \"assertElementContent\"\n },\n {\n \"allowFailure\": true,\n \"isCritical\": true,\n \"name\": \"adipisicing volupt\",\n \"noScreenshot\": false,\n \"params\": {},\n \"timeout\": -22942790,\n \"type\": \"assertElementContent\"\n }\n ],\n \"tags\": [\n \"env:prod\"\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/browser/:public_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
"browser",
":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": "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 \"config\": {\n \"request\": {\n \"allow_insecure\": false,\n \"basicAuth\": {\n \"password\": \"PaSSw0RD!\",\n \"username\": \"my_username\",\n \"type\": \"web\"\n },\n \"body\": \"dolore\",\n \"bodyType\": \"text/plain\",\n \"callType\": \"unary\",\n \"certificate\": {\n \"cert\": {\n \"content\": \"dolor mollit id eu\",\n \"filename\": \"enim \",\n \"updatedAt\": \"ad labore d\"\n },\n \"key\": {\n \"content\": \"anim ut consequat eiusmod\",\n \"filename\": \"non consectetur voluptate\",\n \"updatedAt\": \"proi\"\n }\n },\n \"compressedJsonDescriptor\": \"velit cillum\",\n \"dnsServer\": \"sint irure sit commodo\",\n \"dnsServerPort\": 63263,\n \"follow_redirects\": true,\n \"headers\": {\n \"nulla_735\": \"esse enim velit\",\n \"nulla_b_\": \"laboris ut\"\n },\n \"host\": \"aliquip nostrud\",\n \"message\": \"Lorem laboris\",\n \"metadata\": {\n \"eub0d\": \"sint\",\n \"exercitation1\": \"ut Duis\"\n },\n \"method\": \"dolo\",\n \"noSavingResponseBody\": false,\n \"numberOfPackets\": 1,\n \"persistCookies\": true,\n \"port\": 82704033,\n \"proxy\": {\n \"url\": \"https://example.com\",\n \"headers\": {\n \"ipsum83a\": \"ea laborum\",\n \"irure_8\": \"dolor eiusmod aliqua \",\n \"esse67f\": \"veniam qui in\"\n }\n },\n \"query\": {},\n \"servername\": \"Duis sed minim quis\",\n \"service\": \"Greeter\",\n \"shouldTrackHops\": false,\n \"timeout\": 48414705.45711616,\n \"url\": \"https://example.com\"\n },\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 \"setCookie\": \"anim\",\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 \"locations\": [\n \"aws:eu-west-3\"\n ],\n \"name\": \"Example test name\",\n \"options\": {\n \"accept_self_signed\": true,\n \"allow_insecure\": false,\n \"checkCertificateRevocation\": false,\n \"ci\": {\n \"executionRule\": \"skipped\"\n },\n \"device_ids\": [\n \"laptop_large\",\n \"laptop_large\"\n ],\n \"disableCors\": true,\n \"disableCsp\": false,\n \"follow_redirects\": true,\n \"httpVersion\": \"http2\",\n \"ignoreServerCertificateError\": false,\n \"initialNavigationTimeout\": -93160400,\n \"min_failure_duration\": 9338007,\n \"min_location_failed\": -22553383,\n \"monitor_name\": \"nostrud dolor ullamco\",\n \"monitor_options\": {\n \"renotify_interval\": 261\n },\n \"monitor_priority\": 3,\n \"noScreenshot\": false,\n \"restricted_roles\": [\n \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n ],\n \"retry\": {\n \"count\": 67368482,\n \"interval\": 59042710.53770983\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\": 427884\n },\n \"type\": \"browser\",\n \"message\": \"\",\n \"monitor_id\": -23388126,\n \"public_id\": \"cupidatat ipsum\",\n \"status\": \"live\",\n \"steps\": [\n {\n \"allowFailure\": false,\n \"isCritical\": true,\n \"name\": \"proident dolore ex\",\n \"noScreenshot\": true,\n \"params\": {},\n \"timeout\": 70509439,\n \"type\": \"assertElementContent\"\n },\n {\n \"allowFailure\": true,\n \"isCritical\": true,\n \"name\": \"adipisicing volupt\",\n \"noScreenshot\": false,\n \"params\": {},\n \"timeout\": -22942790,\n \"type\": \"assertElementContent\"\n }\n ],\n \"tags\": [\n \"env:prod\"\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/browser/:public_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
"browser",
":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}"
}
]
}
