Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
; 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"
; ]
; }
json.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateBool(json,"config.request.allow_insecure",0)
CkJsonObject::ckUpdateString(json,"config.request.basicAuth.password","PaSSw0RD!")
CkJsonObject::ckUpdateString(json,"config.request.basicAuth.username","my_username")
CkJsonObject::ckUpdateString(json,"config.request.basicAuth.type","web")
CkJsonObject::ckUpdateString(json,"config.request.body","dolore")
CkJsonObject::ckUpdateString(json,"config.request.bodyType","text/plain")
CkJsonObject::ckUpdateString(json,"config.request.callType","unary")
CkJsonObject::ckUpdateString(json,"config.request.certificate.cert.content","dolor mollit id eu")
CkJsonObject::ckUpdateString(json,"config.request.certificate.cert.filename","enim ")
CkJsonObject::ckUpdateString(json,"config.request.certificate.cert.updatedAt","ad labore d")
CkJsonObject::ckUpdateString(json,"config.request.certificate.key.content","anim ut consequat eiusmod")
CkJsonObject::ckUpdateString(json,"config.request.certificate.key.filename","non consectetur voluptate")
CkJsonObject::ckUpdateString(json,"config.request.certificate.key.updatedAt","proi")
CkJsonObject::ckUpdateString(json,"config.request.compressedJsonDescriptor","velit cillum")
CkJsonObject::ckUpdateString(json,"config.request.dnsServer","sint irure sit commodo")
CkJsonObject::ckUpdateInt(json,"config.request.dnsServerPort",63263)
CkJsonObject::ckUpdateBool(json,"config.request.follow_redirects",1)
CkJsonObject::ckUpdateString(json,"config.request.headers.nulla_735","esse enim velit")
CkJsonObject::ckUpdateString(json,"config.request.headers.nulla_b_","laboris ut")
CkJsonObject::ckUpdateString(json,"config.request.host","aliquip nostrud")
CkJsonObject::ckUpdateString(json,"config.request.message","Lorem laboris")
CkJsonObject::ckUpdateString(json,"config.request.metadata.eub0d","sint")
CkJsonObject::ckUpdateString(json,"config.request.metadata.exercitation1","ut Duis")
CkJsonObject::ckUpdateString(json,"config.request.method","dolo")
CkJsonObject::ckUpdateBool(json,"config.request.noSavingResponseBody",0)
CkJsonObject::ckUpdateInt(json,"config.request.numberOfPackets",1)
CkJsonObject::ckUpdateBool(json,"config.request.persistCookies",1)
CkJsonObject::ckUpdateInt(json,"config.request.port",82704033)
CkJsonObject::ckUpdateString(json,"config.request.proxy.url","https://example.com")
CkJsonObject::ckUpdateString(json,"config.request.proxy.headers.ipsum83a","ea laborum")
CkJsonObject::ckUpdateString(json,"config.request.proxy.headers.irure_8","dolor eiusmod aliqua ")
CkJsonObject::ckUpdateString(json,"config.request.proxy.headers.esse67f","veniam qui in")
CkJsonObject::ckUpdateNewObject(json,"config.request.query")
CkJsonObject::ckUpdateString(json,"config.request.servername","Duis sed minim quis")
CkJsonObject::ckUpdateString(json,"config.request.service","Greeter")
CkJsonObject::ckUpdateBool(json,"config.request.shouldTrackHops",0)
CkJsonObject::ckUpdateNumber(json,"config.request.timeout","48414705.45711616")
CkJsonObject::ckUpdateString(json,"config.request.url","https://example.com")
CkJsonObject::ckUpdateString(json,"config.configVariables[0].description","Example for the variable.")
CkJsonObject::ckUpdateString(json,"config.configVariables[0].type","string")
CkJsonObject::ckUpdateString(json,"config.configVariables[1].description","Example for the variable.")
CkJsonObject::ckUpdateString(json,"config.configVariables[1].type","string")
CkJsonObject::ckUpdateString(json,"config.setCookie","anim")
CkJsonObject::ckUpdateString(json,"config.variables[0].description","Example for the variable.")
CkJsonObject::ckUpdateString(json,"config.variables[0].type","string")
CkJsonObject::ckUpdateString(json,"config.variables[1].description","Example for the variable.")
CkJsonObject::ckUpdateString(json,"config.variables[1].type","string")
CkJsonObject::ckUpdateString(json,"locations[0]","aws:eu-west-3")
CkJsonObject::ckUpdateString(json,"name","Example test name")
CkJsonObject::ckUpdateBool(json,"options.accept_self_signed",1)
CkJsonObject::ckUpdateBool(json,"options.allow_insecure",0)
CkJsonObject::ckUpdateBool(json,"options.checkCertificateRevocation",0)
CkJsonObject::ckUpdateString(json,"options.ci.executionRule","skipped")
CkJsonObject::ckUpdateString(json,"options.device_ids[0]","laptop_large")
CkJsonObject::ckUpdateString(json,"options.device_ids[1]","laptop_large")
CkJsonObject::ckUpdateBool(json,"options.disableCors",1)
CkJsonObject::ckUpdateBool(json,"options.disableCsp",0)
CkJsonObject::ckUpdateBool(json,"options.follow_redirects",1)
CkJsonObject::ckUpdateString(json,"options.httpVersion","http2")
CkJsonObject::ckUpdateBool(json,"options.ignoreServerCertificateError",0)
CkJsonObject::ckUpdateInt(json,"options.initialNavigationTimeout",-93160400)
CkJsonObject::ckUpdateInt(json,"options.min_failure_duration",9338007)
CkJsonObject::ckUpdateInt(json,"options.min_location_failed",-22553383)
CkJsonObject::ckUpdateString(json,"options.monitor_name","nostrud dolor ullamco")
CkJsonObject::ckUpdateInt(json,"options.monitor_options.renotify_interval",261)
CkJsonObject::ckUpdateInt(json,"options.monitor_priority",3)
CkJsonObject::ckUpdateBool(json,"options.noScreenshot",0)
CkJsonObject::ckUpdateString(json,"options.restricted_roles[0]","xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx")
CkJsonObject::ckUpdateInt(json,"options.retry.count",67368482)
CkJsonObject::ckUpdateNumber(json,"options.retry.interval","59042710.53770983")
CkJsonObject::ckUpdateString(json,"options.rumSettings.applicationId","xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx")
CkJsonObject::ckUpdateInt(json,"options.rumSettings.clientTokenId",12345)
CkJsonObject::ckUpdateBool(json,"options.rumSettings.isEnabled",1)
CkJsonObject::ckUpdateInt(json,"options.scheduling.timeframes[0].day",1)
CkJsonObject::ckUpdateString(json,"options.scheduling.timeframes[0].from","07:00")
CkJsonObject::ckUpdateString(json,"options.scheduling.timeframes[0].to","16:00")
CkJsonObject::ckUpdateInt(json,"options.scheduling.timeframes[1].day",3)
CkJsonObject::ckUpdateString(json,"options.scheduling.timeframes[1].from","07:00")
CkJsonObject::ckUpdateString(json,"options.scheduling.timeframes[1].to","16:00")
CkJsonObject::ckUpdateString(json,"options.scheduling.timezone","America/New_York")
CkJsonObject::ckUpdateInt(json,"options.tick_every",427884)
CkJsonObject::ckUpdateString(json,"type","browser")
CkJsonObject::ckUpdateString(json,"message","")
CkJsonObject::ckUpdateInt(json,"monitor_id",-23388126)
CkJsonObject::ckUpdateString(json,"public_id","cupidatat ipsum")
CkJsonObject::ckUpdateString(json,"status","live")
CkJsonObject::ckUpdateBool(json,"steps[0].allowFailure",0)
CkJsonObject::ckUpdateBool(json,"steps[0].isCritical",1)
CkJsonObject::ckUpdateString(json,"steps[0].name","proident dolore ex")
CkJsonObject::ckUpdateBool(json,"steps[0].noScreenshot",1)
CkJsonObject::ckUpdateNewObject(json,"steps[0].params")
CkJsonObject::ckUpdateInt(json,"steps[0].timeout",70509439)
CkJsonObject::ckUpdateString(json,"steps[0].type","assertElementContent")
CkJsonObject::ckUpdateBool(json,"steps[1].allowFailure",1)
CkJsonObject::ckUpdateBool(json,"steps[1].isCritical",1)
CkJsonObject::ckUpdateString(json,"steps[1].name","adipisicing volupt")
CkJsonObject::ckUpdateBool(json,"steps[1].noScreenshot",0)
CkJsonObject::ckUpdateNewObject(json,"steps[1].params")
CkJsonObject::ckUpdateInt(json,"steps[1].timeout",-22942790)
CkJsonObject::ckUpdateString(json,"steps[1].type","assertElementContent")
CkJsonObject::ckUpdateString(json,"tags[0]","env:prod")
CkHttp::ckSetRequestHeader(http,"Content-Type","application/json")
CkHttp::ckSetRequestHeader(http,"Accept","application/json")
resp.i = CkHttp::ckPostJson3(http,"https://api.app.ddog-gov.com/api/v1/synthetics/tests/browser","application/json",json)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
ProcedureReturn
EndIf
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkHttpResponse::ckGetBodySb(resp,sbResponseBody)
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
respStatusCode.i = CkHttpResponse::ckStatusCode(resp)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttpResponse::ckHeader(resp)
Debug "Failed."
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
CkHttpResponse::ckDispose(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
description.s
strVal.s
day.i
from.s
v_to.s
allowFailure.i
isCritical.i
noScreenshot.i
timeout.i
Allow_insecure.i = CkJsonObject::ckBoolOf(jResp,"config.request.allow_insecure")
Password.s = CkJsonObject::ckStringOf(jResp,"config.request.basicAuth.password")
Username.s = CkJsonObject::ckStringOf(jResp,"config.request.basicAuth.username")
v_Type.s = CkJsonObject::ckStringOf(jResp,"config.request.basicAuth.type")
Body.s = CkJsonObject::ckStringOf(jResp,"config.request.body")
BodyType.s = CkJsonObject::ckStringOf(jResp,"config.request.bodyType")
CallType.s = CkJsonObject::ckStringOf(jResp,"config.request.callType")
Content.s = CkJsonObject::ckStringOf(jResp,"config.request.certificate.cert.content")
Filename.s = CkJsonObject::ckStringOf(jResp,"config.request.certificate.cert.filename")
UpdatedAt.s = CkJsonObject::ckStringOf(jResp,"config.request.certificate.cert.updatedAt")
KeyContent.s = CkJsonObject::ckStringOf(jResp,"config.request.certificate.key.content")
KeyFilename.s = CkJsonObject::ckStringOf(jResp,"config.request.certificate.key.filename")
KeyUpdatedAt.s = CkJsonObject::ckStringOf(jResp,"config.request.certificate.key.updatedAt")
CompressedJsonDescriptor.s = CkJsonObject::ckStringOf(jResp,"config.request.compressedJsonDescriptor")
DnsServer.s = CkJsonObject::ckStringOf(jResp,"config.request.dnsServer")
DnsServerPort.i = CkJsonObject::ckIntOf(jResp,"config.request.dnsServerPort")
Follow_redirects.i = CkJsonObject::ckBoolOf(jResp,"config.request.follow_redirects")
Nulla_735.s = CkJsonObject::ckStringOf(jResp,"config.request.headers.nulla_735")
Nulla_b_.s = CkJsonObject::ckStringOf(jResp,"config.request.headers.nulla_b_")
Host.s = CkJsonObject::ckStringOf(jResp,"config.request.host")
Message.s = CkJsonObject::ckStringOf(jResp,"config.request.message")
Eub0d.s = CkJsonObject::ckStringOf(jResp,"config.request.metadata.eub0d")
Exercitation1.s = CkJsonObject::ckStringOf(jResp,"config.request.metadata.exercitation1")
Method.s = CkJsonObject::ckStringOf(jResp,"config.request.method")
NoSavingResponseBody.i = CkJsonObject::ckBoolOf(jResp,"config.request.noSavingResponseBody")
NumberOfPackets.i = CkJsonObject::ckIntOf(jResp,"config.request.numberOfPackets")
PersistCookies.i = CkJsonObject::ckBoolOf(jResp,"config.request.persistCookies")
Port.i = CkJsonObject::ckIntOf(jResp,"config.request.port")
v_Url.s = CkJsonObject::ckStringOf(jResp,"config.request.proxy.url")
Ipsum83a.s = CkJsonObject::ckStringOf(jResp,"config.request.proxy.headers.ipsum83a")
Irure_8.s = CkJsonObject::ckStringOf(jResp,"config.request.proxy.headers.irure_8")
Esse67f.s = CkJsonObject::ckStringOf(jResp,"config.request.proxy.headers.esse67f")
Servername.s = CkJsonObject::ckStringOf(jResp,"config.request.servername")
Service.s = CkJsonObject::ckStringOf(jResp,"config.request.service")
ShouldTrackHops.i = CkJsonObject::ckBoolOf(jResp,"config.request.shouldTrackHops")
Timeout.s = CkJsonObject::ckStringOf(jResp,"config.request.timeout")
RequestUrl.s = CkJsonObject::ckStringOf(jResp,"config.request.url")
SetCookie.s = CkJsonObject::ckStringOf(jResp,"config.setCookie")
name.s = CkJsonObject::ckStringOf(jResp,"name")
Accept_self_signed.i = CkJsonObject::ckBoolOf(jResp,"options.accept_self_signed")
optionsAllow_insecure.i = CkJsonObject::ckBoolOf(jResp,"options.allow_insecure")
CheckCertificateRevocation.i = CkJsonObject::ckBoolOf(jResp,"options.checkCertificateRevocation")
ExecutionRule.s = CkJsonObject::ckStringOf(jResp,"options.ci.executionRule")
DisableCors.i = CkJsonObject::ckBoolOf(jResp,"options.disableCors")
DisableCsp.i = CkJsonObject::ckBoolOf(jResp,"options.disableCsp")
optionsFollow_redirects.i = CkJsonObject::ckBoolOf(jResp,"options.follow_redirects")
HttpVersion.s = CkJsonObject::ckStringOf(jResp,"options.httpVersion")
IgnoreServerCertificateError.i = CkJsonObject::ckBoolOf(jResp,"options.ignoreServerCertificateError")
InitialNavigationTimeout.i = CkJsonObject::ckIntOf(jResp,"options.initialNavigationTimeout")
Min_failure_duration.i = CkJsonObject::ckIntOf(jResp,"options.min_failure_duration")
Min_location_failed.i = CkJsonObject::ckIntOf(jResp,"options.min_location_failed")
Monitor_name.s = CkJsonObject::ckStringOf(jResp,"options.monitor_name")
Renotify_interval.i = CkJsonObject::ckIntOf(jResp,"options.monitor_options.renotify_interval")
Monitor_priority.i = CkJsonObject::ckIntOf(jResp,"options.monitor_priority")
NoScreenshot.i = CkJsonObject::ckBoolOf(jResp,"options.noScreenshot")
Count.i = CkJsonObject::ckIntOf(jResp,"options.retry.count")
Interval.s = CkJsonObject::ckStringOf(jResp,"options.retry.interval")
ApplicationId.s = CkJsonObject::ckStringOf(jResp,"options.rumSettings.applicationId")
ClientTokenId.i = CkJsonObject::ckIntOf(jResp,"options.rumSettings.clientTokenId")
IsEnabled.i = CkJsonObject::ckBoolOf(jResp,"options.rumSettings.isEnabled")
Timezone.s = CkJsonObject::ckStringOf(jResp,"options.scheduling.timezone")
Tick_every.i = CkJsonObject::ckIntOf(jResp,"options.tick_every")
v_type.s = CkJsonObject::ckStringOf(jResp,"type")
message.s = CkJsonObject::ckStringOf(jResp,"message")
monitor_id.i = CkJsonObject::ckIntOf(jResp,"monitor_id")
public_id.s = CkJsonObject::ckStringOf(jResp,"public_id")
status.s = CkJsonObject::ckStringOf(jResp,"status")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"config.configVariables")
While i < count_i
CkJsonObject::setCkI(jResp, i)
description = CkJsonObject::ckStringOf(jResp,"config.configVariables[i].description")
v_type = CkJsonObject::ckStringOf(jResp,"config.configVariables[i].type")
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"config.variables")
While i < count_i
CkJsonObject::setCkI(jResp, i)
description = CkJsonObject::ckStringOf(jResp,"config.variables[i].description")
v_type = CkJsonObject::ckStringOf(jResp,"config.variables[i].type")
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"locations")
While i < count_i
CkJsonObject::setCkI(jResp, i)
strVal = CkJsonObject::ckStringOf(jResp,"locations[i]")
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"options.device_ids")
While i < count_i
CkJsonObject::setCkI(jResp, i)
strVal = CkJsonObject::ckStringOf(jResp,"options.device_ids[i]")
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"options.restricted_roles")
While i < count_i
CkJsonObject::setCkI(jResp, i)
strVal = CkJsonObject::ckStringOf(jResp,"options.restricted_roles[i]")
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"options.scheduling.timeframes")
While i < count_i
CkJsonObject::setCkI(jResp, i)
day = CkJsonObject::ckIntOf(jResp,"options.scheduling.timeframes[i].day")
from = CkJsonObject::ckStringOf(jResp,"options.scheduling.timeframes[i].from")
v_to = CkJsonObject::ckStringOf(jResp,"options.scheduling.timeframes[i].to")
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"steps")
While i < count_i
CkJsonObject::setCkI(jResp, i)
allowFailure = CkJsonObject::ckBoolOf(jResp,"steps[i].allowFailure")
isCritical = CkJsonObject::ckBoolOf(jResp,"steps[i].isCritical")
name = CkJsonObject::ckStringOf(jResp,"steps[i].name")
noScreenshot = CkJsonObject::ckBoolOf(jResp,"steps[i].noScreenshot")
timeout = CkJsonObject::ckIntOf(jResp,"steps[i].timeout")
v_type = CkJsonObject::ckStringOf(jResp,"steps[i].type")
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"tags")
While i < count_i
CkJsonObject::setCkI(jResp, i)
strVal = CkJsonObject::ckStringOf(jResp,"tags[i]")
i = i + 1
Wend
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
Curl Command
curl -X POST
-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
Postman Collection Item JSON
{
"name": "Create a browser test",
"request": {
"method": "POST",
"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",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
"browser"
]
},
"description": "Create a Synthetic browser test."
},
"response": [
{
"name": "OK - Returns the created test details.",
"originalRequest": {
"method": "POST",
"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",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
"browser"
]
}
},
"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- Creation failed",
"originalRequest": {
"method": "POST",
"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",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
"browser"
]
}
},
"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": "Test quota is reached",
"originalRequest": {
"method": "POST",
"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",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
"browser"
]
}
},
"status": "Payment Required",
"code": 402,
"_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": "POST",
"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",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
"browser"
]
}
},
"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": "Too many requests",
"originalRequest": {
"method": "POST",
"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",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
"browser"
]
}
},
"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}"
}
]
}
