Create Multiple Synthetic API Monitoring Jobs API

This page describes the API used to create multiple Synthetic API monitoring jobs using a single API request.

Request

JAVASCRIPTCopy

{ "schedules": [ { "scheduleRunConfigs": [ { "rate": { "value": 15, "unit": "MINUTES" }, "daysOfWeek": [ "SUN", "WED", "THUR", "FRI", "MON", "TUES", "SAT" ], "timezone": "UTC" } ], "description": "jobUI", "apiMetadata": { "script": { "contentType": "JAVASCRIPT", "script": "// Javascript based API Monitoring Test\n\nconst assert = require(\"assert\");\n(async () => {\n var response = await client.get(\"<URL>\");\n assert.equal(response.statusCode, 200);\n assert.equal(response.statusMessage, \"OK\");\n for(var key in response.headers) {\n console.log(`${key} : ${response.headers[key]}`);\n }\n assert.equal(response.body, \"response body\");\n})()" } }, "browserCodes": [ "API" ], "chromeVersions": [], "locationCodes": [ "M50" ], "timeoutSeconds": 15, "appKey": "appKey", "composableConfig": { "numBeforeConfirmedError": 0, "resourceErrorDetection": { "ignoreWhen": { "resourceUrlContains": [], "resourceMimeType": [] }, "onlyWhen": { "resourceUrlContains": [], "resourceMimeType": [] } } }, "performanceCriteria": { "retestOnWarning": false, "retestOnCritical": false, "warningCriterion": [], "criticalCriterion": [] } } ] }

{
"schedules": [
{
"scheduleRunConfigs": [
{
"rate": {
"value": 15,
"unit": "MINUTES"
},
"daysOfWeek": [
"SUN",
"WED",
"THUR",
"FRI",
"MON",
"TUES",
"SAT"
],
"timezone": "UTC"
}
],
"description": "jobUI",
"apiMetadata": {
"script": {
"contentType": "JAVASCRIPT",
"script": "// Javascript based API Monitoring Test\n\nconst assert = require(\"assert\");\n(async () => {\n    var response = await client.get(\"<URL>\");\n    assert.equal(response.statusCode, 200);\n    assert.equal(response.statusMessage, \"OK\");\n    for(var key in response.headers) {\n        console.log(`${key} : ${response.headers[key]}`);\n    }\n    assert.equal(response.body, \"response body\");\n})()"
}
},
"browserCodes": [
"API"
],
"chromeVersions": [],
"locationCodes": [
"M50"
],
"timeoutSeconds": 15,
"appKey": "appKey",
"composableConfig": {
"numBeforeConfirmedError": 0,
"resourceErrorDetection": {
"ignoreWhen": {
"resourceUrlContains": [],
"resourceMimeType": []
},
"onlyWhen": {
"resourceUrlContains": [],
"resourceMimeType": []
}
}
},
"performanceCriteria": {
"retestOnWarning": false,
"retestOnCritical": false,
"warningCriterion": [],
"criticalCriterion": []
}
}
]
}

Response

JSONCopy

[ { "status": "200", "errorMessage": "null", "scheduleId": "ID" }, { "status": "422", "errorMessage": "timeout field value exceeds range", "scheduleId": "null" } ]

[
{
"status": "200",
"errorMessage": "null",
"scheduleId": "ID"
},
{
"status": "422",
"errorMessage": "timeout field value exceeds range",
"scheduleId": "null"
}
]