{ "uuid": "5c953b64-f72e-4766-a87a-c496d5cd0307", "lastMigration": 29, "name": "Runscope API", "endpointPrefix": "", "latency": 0, "port": 3000, "hostname": "", "routes": [ { "uuid": "95e1a4e2-686e-4989-9633-7f26394b060f", "documentation": "Account Resource", "method": "get", "endpoint": "account", "responses": [ { "uuid": "9a8648b1-cf1f-49ce-8a45-baab86dc6d88", "body": "{\n \"data\": {\n \"email\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"teams\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"meta\": {\n \"status\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Account owner and team information.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "a2c10026-1830-4913-913c-57bc9593809d", "body": "{\n \"code\": {{faker 'number.int' max=99999}},\n \"fields\": \"\",\n \"message\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "5f97116e-91e0-4eb3-af21-2c9de8365064", "documentation": "Returns a list of buckets.", "method": "get", "endpoint": "buckets", "responses": [ { "uuid": "70ef8005-fa4e-4eac-9152-3ae3ebe6bf0d", "body": "{\n \"data\": [\n {\n \"auth_token\": \"\",\n \"collections_url\": \"\",\n \"default\": {{faker 'datatype.boolean'}},\n \"key\": \"\",\n \"messages_url\": \"\",\n \"name\": \"\",\n \"team\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"tests_url\": \"\",\n \"trigger_url\": \"\",\n \"verify_ssl\": {{faker 'datatype.boolean'}}\n }\n ],\n \"meta\": {\n \"status\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "List of buckets associated with this authenticated account.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "a7b47e47-874e-402e-a6c5-916aa57ccd97", "body": "{\n \"code\": {{faker 'number.int' max=99999}},\n \"fields\": \"\",\n \"message\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "5b83b387-8892-494f-bba5-2e23713ce580", "documentation": "Create a new bucket", "method": "post", "endpoint": "buckets", "responses": [ { "uuid": "7bb58582-7d0f-4806-8561-57ab888ed52a", "body": "{\n \"auth_token\": \"\",\n \"collections_url\": \"\",\n \"default\": {{faker 'datatype.boolean'}},\n \"key\": \"\",\n \"messages_url\": \"\",\n \"name\": \"\",\n \"team\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"tests_url\": \"\",\n \"trigger_url\": \"\",\n \"verify_ssl\": {{faker 'datatype.boolean'}}\n}", "latency": 0, "statusCode": 200, "label": "Bucket details.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "04c529f1-da8e-4ee9-9432-3f80c2104b69", "body": "{\n \"code\": {{faker 'number.int' max=99999}},\n \"fields\": \"\",\n \"message\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "3eee7488-bbf9-4b19-952c-28f22e14b33d", "documentation": "Delete a single bucket resource.", "method": "delete", "endpoint": "buckets/:bucketKey", "responses": [ { "uuid": "8a2709f7-013e-4a61-a870-331458c30b45", "body": "", "latency": 0, "statusCode": 204, "label": "No content with no body.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "a4c94c91-3a74-4653-babc-f2e2cdcc2875", "body": "{\n \"code\": {{faker 'number.int' max=99999}},\n \"fields\": \"\",\n \"message\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "19c551a5-34e3-4d34-afc4-1893a00d20de", "documentation": "Returns a single bucket resource.", "method": "get", "endpoint": "buckets/:bucketKey", "responses": [ { "uuid": "4b5490d6-14b9-4590-99f4-4c7a33f71d2c", "body": "{\n \"auth_token\": \"\",\n \"collections_url\": \"\",\n \"default\": {{faker 'datatype.boolean'}},\n \"key\": \"\",\n \"messages_url\": \"\",\n \"name\": \"\",\n \"team\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"tests_url\": \"\",\n \"trigger_url\": \"\",\n \"verify_ssl\": {{faker 'datatype.boolean'}}\n}", "latency": 0, "statusCode": 200, "label": "Bucket details.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "cdd51af9-82c0-4b84-aa52-9dbb06c8735b", "body": "{\n \"code\": {{faker 'number.int' max=99999}},\n \"fields\": \"\",\n \"message\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "f741a2c0-8023-4611-9c66-f9a4992e6083", "documentation": "Returns list of shared environments for a specified bucket.", "method": "get", "endpoint": "buckets/:bucketKey/environments", "responses": [ { "uuid": "3da25182-ece4-42a6-a8f8-db537d07f207", "body": "", "latency": 0, "statusCode": 200, "label": "List of shared environments belonging to this bucket.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "19cae376-a7cf-49ee-8072-43a37d89478c", "documentation": "Create new shared environment.", "method": "post", "endpoint": "buckets/:bucketKey/environments", "responses": [ { "uuid": "d62bee12-cebd-44ca-8c59-87ccf51a5027", "body": "", "latency": 0, "statusCode": 201, "label": "Details of the new test environment.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "94455664-438f-451b-977c-948be37d1772", "documentation": "Update the details of a shared environment.", "method": "put", "endpoint": "buckets/:bucketKey/environments/:environmentId", "responses": [ { "uuid": "07967afc-d877-47e8-af0b-5bb416712f02", "body": "", "latency": 0, "statusCode": 201, "label": "Details of the modified test environment.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "4013f6b0-2263-40d9-a2a0-bea180a7f539", "documentation": "Retrieve a list of error messages in a bucket", "method": "get", "endpoint": "buckets/:bucketKey/errors", "responses": [ { "uuid": "e89882c2-264b-4a39-9565-39ff6441c220", "body": "", "latency": 0, "statusCode": 200, "label": "List of error messages in a bucket", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "63e13de6-e478-43f2-8eba-4b5b9ea7c984", "body": "{\n \"code\": {{faker 'number.int' max=99999}},\n \"fields\": \"\",\n \"message\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "293064a6-9a95-4d84-8fae-550f3d2f2f19", "documentation": "Clear a bucket (remove all messages).", "method": "delete", "endpoint": "buckets/:bucketKey/messages", "responses": [ { "uuid": "6b3bbd96-e1e7-4f95-b203-66c12466d3d6", "body": "", "latency": 0, "statusCode": 204, "label": "No content with no body.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "ceb69e37-6abe-44d0-aac9-0eb4421b3e17", "body": "{\n \"code\": {{faker 'number.int' max=99999}},\n \"fields\": \"\",\n \"message\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "01dc22ef-1c66-40ee-aaeb-b4c03386becd", "documentation": "Retrieve a list of messages in a bucket", "method": "get", "endpoint": "buckets/:bucketKey/messages", "responses": [ { "uuid": "009e8124-010e-4385-aa18-93d4d78ae1b3", "body": "", "latency": 0, "statusCode": 200, "label": "List of messages in a bucket", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "2ec2cecf-034d-49fa-8aac-d73d8489d4df", "body": "{\n \"code\": {{faker 'number.int' max=99999}},\n \"fields\": \"\",\n \"message\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "10a79d77-fe6f-4a41-8bce-05dfcc2f9b7f", "documentation": "Create a message", "method": "post", "endpoint": "buckets/:bucketKey/messages", "responses": [ { "uuid": "3184e725-caaf-4795-870a-d42e2d3aab1f", "body": "{\n \"data\": [\n {\n \"error\": {\n \"code\": {{faker 'number.int' max=99999}},\n \"message\": \"\",\n \"more_info\": \"\"\n },\n \"status\": \"\",\n \"unique_identifier\": \"\",\n \"uuid\": \"\",\n \"warning\": {\n \"code\": {{faker 'number.int' max=99999}},\n \"message\": \"\",\n \"more_info\": \"\"\n }\n }\n ],\n \"meta\": {\n \"error_count\": {{faker 'number.int' max=99999}},\n \"succcess_count\": {{faker 'number.int' max=99999}},\n \"warning_count\": {{faker 'number.int' max=99999}}\n }\n}", "latency": 0, "statusCode": 200, "label": "The response includes a list of result objects for the message(s) submitted. It will always return an array, even if only one message was created. The order of the result objects corresponds to the order of messages submitted.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "bb29aebc-d662-4249-b3d3-6f87e2212ad1", "body": "{\n \"code\": {{faker 'number.int' max=99999}},\n \"fields\": \"\",\n \"message\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "52f08ca8-2cb6-479a-a830-92050941d2ef", "documentation": "Retrieve the details for a single message.", "method": "get", "endpoint": "buckets/:bucketKey/messages/:messageId", "responses": [ { "uuid": "ee7d4b38-4224-4d54-9d9e-b9b47fab3e9f", "body": "", "latency": 0, "statusCode": 200, "label": "List of messages in a bucket", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "3a86f4ab-1489-4d90-b0f9-be4e97e8ea9f", "body": "{\n \"code\": {{faker 'number.int' max=99999}},\n \"fields\": \"\",\n \"message\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "c21b9105-7e75-4116-be67-6a4dbe266d2e", "documentation": "Returns a list of tests.", "method": "get", "endpoint": "buckets/:bucketKey/tests", "responses": [ { "uuid": "5f9b21f7-9a6c-4edf-9cda-f07cbc2e0b1c", "body": "{\n \"data\": [\n {\n \"created_at\": {{faker 'number.int' max=99999}},\n \"created_by\": {\n \"email\": \"\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"default_environment_id\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"last_run\": {},\n \"name\": \"\",\n \"trigger_url\": \"\"\n }\n ],\n \"meta\": {\n \"status\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "List of tests for this bucket", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "da6d80b9-84f9-4137-a6b6-c0d43cd9f7b0", "documentation": "Create a test.", "method": "post", "endpoint": "buckets/:bucketKey/tests", "responses": [ { "uuid": "17a37239-52d0-4e89-9ee1-864fc2a468b7", "body": "{\n \"data\": [\n {\n \"created_at\": {{faker 'number.int' max=99999}},\n \"created_by\": {\n \"email\": \"\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"default_environment_id\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"last_run\": {},\n \"name\": \"\",\n \"trigger_url\": \"\"\n }\n ],\n \"meta\": {\n \"status\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "List of tests for this bucket", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "ed58eab1-2109-4e6c-a950-70e857755a26", "documentation": "Delete a test, including all steps, schedules, test-specific environments and results.", "method": "delete", "endpoint": "buckets/:bucketKey/tests/:testId", "responses": [ { "uuid": "c668a226-6068-4d3c-9519-6ac23a3141d9", "body": "", "latency": 0, "statusCode": 204, "label": "No content with no body.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "e7d54c47-581b-4c11-bbd0-e3d4cbc62e75", "documentation": "Retrieve the details of a given test by ID.", "method": "get", "endpoint": "buckets/:bucketKey/tests/:testId", "responses": [ { "uuid": "344c2a81-769d-4c90-a99a-4064f829197f", "body": "{\n \"environments\": {\n \"auth\": \"\",\n \"client_certificate\": \"\",\n \"emails\": {},\n \"exported_at\": {{faker 'number.int' max=99999}},\n \"headers\": {},\n \"id\": \"\",\n \"initial_script_hash\": \"\",\n \"initial_variables\": {},\n \"integrations\": [\n {\n \"description\": \"\",\n \"id\": \"\",\n \"type\": \"\",\n \"uuid\": \"\"\n }\n ],\n \"name\": \"\",\n \"parent_environment_id\": \"\",\n \"preserve_cookies\": {{faker 'datatype.boolean'}},\n \"regions\": [\n \"\"\n ],\n \"remote_agents\": [\n {\n \"agent_id\": \"\",\n \"name\": \"\",\n \"version\": \"\"\n }\n ],\n \"retry_on_failure\": {{faker 'datatype.boolean'}},\n \"script\": \"\",\n \"script_library\": [\n \"\"\n ],\n \"stop_on_failure\": {{faker 'datatype.boolean'}},\n \"test_id\": \"\",\n \"verify_ssl\": {{faker 'datatype.boolean'}},\n \"version\": \"\",\n \"webhooks\": \"\"\n },\n \"exported_at\": {{faker 'number.int' max=99999}},\n \"last_run\": {},\n \"schedules\": [\n {\n \"environment_id\": \"\",\n \"exported_at\": {{faker 'number.int' max=99999}},\n \"id\": \"\",\n \"interval\": \"\",\n \"note\": \"\",\n \"version\": \"\"\n }\n ],\n \"steps\": [\n {}\n ],\n \"version\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Returns an object with the details of the given test.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "1356e2e8-5e7d-4e37-a26c-9c64d6772634", "body": "{\n \"code\": {{faker 'number.int' max=99999}},\n \"fields\": \"\",\n \"message\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "e5f07109-400d-4604-bcd5-50eb5af6fc4f", "documentation": "Modify a test's name, description, default environment and its steps. To modify other individual properties of a test, make requests to the steps, environments, and schedules subresources of the test.", "method": "put", "endpoint": "buckets/:bucketKey/tests/:testId", "responses": [ { "uuid": "14425de1-5c73-43ea-93c7-b3314cbb0b0f", "body": "{\n \"environments\": {\n \"auth\": \"\",\n \"client_certificate\": \"\",\n \"emails\": {},\n \"exported_at\": {{faker 'number.int' max=99999}},\n \"headers\": {},\n \"id\": \"\",\n \"initial_script_hash\": \"\",\n \"initial_variables\": {},\n \"integrations\": [\n {\n \"description\": \"\",\n \"id\": \"\",\n \"type\": \"\",\n \"uuid\": \"\"\n }\n ],\n \"name\": \"\",\n \"parent_environment_id\": \"\",\n \"preserve_cookies\": {{faker 'datatype.boolean'}},\n \"regions\": [\n \"\"\n ],\n \"remote_agents\": [\n {\n \"agent_id\": \"\",\n \"name\": \"\",\n \"version\": \"\"\n }\n ],\n \"retry_on_failure\": {{faker 'datatype.boolean'}},\n \"script\": \"\",\n \"script_library\": [\n \"\"\n ],\n \"stop_on_failure\": {{faker 'datatype.boolean'}},\n \"test_id\": \"\",\n \"verify_ssl\": {{faker 'datatype.boolean'}},\n \"version\": \"\",\n \"webhooks\": \"\"\n },\n \"exported_at\": {{faker 'number.int' max=99999}},\n \"last_run\": {},\n \"schedules\": [\n {\n \"environment_id\": \"\",\n \"exported_at\": {{faker 'number.int' max=99999}},\n \"id\": \"\",\n \"interval\": \"\",\n \"note\": \"\",\n \"version\": \"\"\n }\n ],\n \"steps\": [\n {}\n ],\n \"version\": \"\"\n}", "latency": 0, "statusCode": 201, "label": "Returns 201 and the updated test's JSON description if the test is successfully updated.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "98925ffa-f859-4fb4-9467-e5a5ee306d3b", "body": "{\n \"code\": {{faker 'number.int' max=99999}},\n \"fields\": \"\",\n \"message\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "30674352-77e5-4bdc-a330-5bdc1f6cae1e", "documentation": "Return details of the test's environments (only those that belong to the specified test)", "method": "get", "endpoint": "buckets/:bucketKey/tests/:testId/environments", "responses": [ { "uuid": "5858b1ea-be55-4333-87ad-bfe8377b2fdd", "body": "{\n \"data\": [\n {\n \"auth\": \"\",\n \"client_certificate\": \"\",\n \"emails\": {},\n \"exported_at\": {{faker 'number.int' max=99999}},\n \"headers\": {},\n \"id\": \"\",\n \"initial_script_hash\": \"\",\n \"initial_variables\": {},\n \"integrations\": [\n {\n \"description\": \"\",\n \"id\": \"\",\n \"type\": \"\",\n \"uuid\": \"\"\n }\n ],\n \"name\": \"\",\n \"parent_environment_id\": \"\",\n \"preserve_cookies\": {{faker 'datatype.boolean'}},\n \"regions\": [\n \"\"\n ],\n \"remote_agents\": [\n {\n \"agent_id\": \"\",\n \"name\": \"\",\n \"version\": \"\"\n }\n ],\n \"retry_on_failure\": {{faker 'datatype.boolean'}},\n \"script\": \"\",\n \"script_library\": [\n \"\"\n ],\n \"stop_on_failure\": {{faker 'datatype.boolean'}},\n \"test_id\": \"\",\n \"verify_ssl\": {{faker 'datatype.boolean'}},\n \"version\": \"\",\n \"webhooks\": \"\"\n }\n ],\n \"meta\": {\n \"status\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "List of environments belonging to this test.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "6726a66e-dad5-464c-87eb-f481017ffcbc", "documentation": "Create new test environment.", "method": "post", "endpoint": "buckets/:bucketKey/tests/:testId/environments", "responses": [ { "uuid": "728fd070-af6b-479c-b95e-30368ad6212c", "body": "", "latency": 0, "statusCode": 201, "label": "Details of the new test environment.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "72fc00d9-63b5-4121-8251-161d834a234f", "documentation": "Update the details of a test environment.", "method": "put", "endpoint": "buckets/:bucketKey/tests/:testId/environments/:environmentId", "responses": [ { "uuid": "6b630b7a-f89d-4b57-af44-2db5a23669a3", "body": "", "latency": 0, "statusCode": 201, "label": "Details of the modified test environment.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "9696e030-2aa3-4301-a600-4826557828d5", "documentation": "Return details of the test metrics for the specified timeframe.", "method": "get", "endpoint": "buckets/:bucketKey/tests/:testId/metrics", "responses": [ { "uuid": "5c479323-96d0-46e9-bc5a-f5ca0a827098", "body": "{\n \"changes_from_last_period\": {},\n \"environment_uuid\": \"\",\n \"region\": \"\",\n \"response_times\": [\n {\n \"avg_response_time_ms\": {{faker 'number.int' max=99999}},\n \"success_ratio\": {{faker 'number.int' max=99999}},\n \"timestamp\": {{faker 'number.int' max=99999}}\n }\n ],\n \"this_time_period\": {},\n \"timeframe\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "List of average response times and additional performance metrics belonging to this test.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "f39db7f2-dcc8-40f8-ac3a-7f348706b419", "documentation": "List test steps for a test.", "method": "get", "endpoint": "buckets/:bucketKey/tests/:testId/steps", "responses": [ { "uuid": "ddf3fadc-00a3-4ffa-bcb0-ce4740fb18f3", "body": "", "latency": 0, "statusCode": 200, "label": "List of test steps for a test", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "eff049a1-7c75-47f1-bb92-9d72c876387e", "documentation": "Add new test step.", "method": "post", "endpoint": "buckets/:bucketKey/tests/:testId/steps", "responses": [ { "uuid": "7730a25e-4ec7-48f3-a64c-b63983fc831b", "body": "", "latency": 0, "statusCode": 201, "label": "Details of the new test step.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "db82abc9-8c2f-4cda-ba8c-1da7e639ccd7", "body": "{\n \"data\": {},\n \"error\": {\n \"error\": \"\",\n \"message\": \"\",\n \"more_info\": \"\",\n \"status\": {{faker 'number.int' max=99999}}\n },\n \"meta\": {\n \"status\": \"\"\n }\n}", "latency": 0, "statusCode": 400, "label": "Must send valid JSON object to create a new test step", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "b3878771-384e-42c1-a5d7-010aab91b157", "documentation": "Delete a step from a test.", "method": "delete", "endpoint": "buckets/:bucketKey/tests/:testId/steps/:stepId", "responses": [ { "uuid": "1dcfd278-1b07-4fca-b600-d995b15ce852", "body": "", "latency": 0, "statusCode": 204, "label": "No content with no body.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "ddcefeb3-1238-4223-8370-4bf06f5a5e13", "documentation": "Update the details of a single test step.", "method": "put", "endpoint": "buckets/:bucketKey/tests/:testId/steps/:stepId", "responses": [ { "uuid": "025e464f-d037-415a-8dc1-21f8e7bc4dcf", "body": "", "latency": 0, "statusCode": 200, "label": "List of test steps for a test", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "e5668c9e-5707-45a7-9b8c-57e326620a6f", "body": "{\n \"data\": {},\n \"error\": {\n \"error\": \"\",\n \"message\": \"\",\n \"more_info\": \"\",\n \"status\": {{faker 'number.int' max=99999}}\n },\n \"meta\": {\n \"status\": \"\"\n }\n}", "latency": 0, "statusCode": 400, "label": "Unable to update template '{stepId}' for test '{testId}'", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "9695a08d-27c9-4a9f-89a0-5c6c1f490158", "documentation": "Team agents list", "method": "get", "endpoint": "teams/:teamId/agents", "responses": [ { "uuid": "556b62e8-2e29-45c5-bc1a-8585cf7b0900", "body": "[\n {\n \"agent_id\": \"\",\n \"name\": \"\",\n \"version\": \"\"\n }\n]", "latency": 0, "statusCode": 200, "label": "List of the team’s currently connected agents.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "30c2a3d4-f8df-4b82-a0fe-57691a765a31", "body": "{\n \"code\": {{faker 'number.int' max=99999}},\n \"fields\": \"\",\n \"message\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "5fdee57a-5aca-4388-b744-d35072654063", "documentation": "Team integrations list", "method": "get", "endpoint": "teams/:teamId/integrations", "responses": [ { "uuid": "06b3faa4-20ec-4d1d-9d9e-0668f016db13", "body": "{\n \"data\": [\n {\n \"description\": \"\",\n \"id\": \"\",\n \"type\": \"\",\n \"uuid\": \"\"\n }\n ],\n \"meta\": {\n \"status\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "List of integrations associated with the team.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "074202d2-af2b-4944-a1b0-9acde9be0687", "body": "{\n \"code\": {{faker 'number.int' max=99999}},\n \"fields\": \"\",\n \"message\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "c8328f64-6d97-4d6b-b01e-a18468f9f337", "documentation": "Teams Resource", "method": "get", "endpoint": "teams/:teamId/people", "responses": [ { "uuid": "cdc4a051-f48d-4923-a0e0-3029e116fef1", "body": "[\n {\n \"email\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"teams\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n]", "latency": 0, "statusCode": 200, "label": "List of people associated with the team.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "c63e733b-29bd-4e27-b73e-30ba8a2226cf", "body": "{\n \"code\": {{faker 'number.int' max=99999}},\n \"fields\": \"\",\n \"message\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" } ], "proxyMode": false, "proxyHost": "", "proxyRemovePrefix": false, "tlsOptions": { "enabled": false, "type": "CERT", "pfxPath": "", "certPath": "", "keyPath": "", "caPath": "", "passphrase": "" }, "cors": true, "headers": [], "proxyReqHeaders": [{ "key": "", "value": "" }], "proxyResHeaders": [{ "key": "", "value": "" }], "data": [], "folders": [], "rootChildren": [ { "type": "route", "uuid": "95e1a4e2-686e-4989-9633-7f26394b060f" }, { "type": "route", "uuid": "5f97116e-91e0-4eb3-af21-2c9de8365064" }, { "type": "route", "uuid": "5b83b387-8892-494f-bba5-2e23713ce580" }, { "type": "route", "uuid": "3eee7488-bbf9-4b19-952c-28f22e14b33d" }, { "type": "route", "uuid": "19c551a5-34e3-4d34-afc4-1893a00d20de" }, { "type": "route", "uuid": "f741a2c0-8023-4611-9c66-f9a4992e6083" }, { "type": "route", "uuid": "19cae376-a7cf-49ee-8072-43a37d89478c" }, { "type": "route", "uuid": "94455664-438f-451b-977c-948be37d1772" }, { "type": "route", "uuid": "4013f6b0-2263-40d9-a2a0-bea180a7f539" }, { "type": "route", "uuid": "293064a6-9a95-4d84-8fae-550f3d2f2f19" }, { "type": "route", "uuid": "01dc22ef-1c66-40ee-aaeb-b4c03386becd" }, { "type": "route", "uuid": "10a79d77-fe6f-4a41-8bce-05dfcc2f9b7f" }, { "type": "route", "uuid": "52f08ca8-2cb6-479a-a830-92050941d2ef" }, { "type": "route", "uuid": "c21b9105-7e75-4116-be67-6a4dbe266d2e" }, { "type": "route", "uuid": "da6d80b9-84f9-4137-a6b6-c0d43cd9f7b0" }, { "type": "route", "uuid": "ed58eab1-2109-4e6c-a950-70e857755a26" }, { "type": "route", "uuid": "e7d54c47-581b-4c11-bbd0-e3d4cbc62e75" }, { "type": "route", "uuid": "e5f07109-400d-4604-bcd5-50eb5af6fc4f" }, { "type": "route", "uuid": "30674352-77e5-4bdc-a330-5bdc1f6cae1e" }, { "type": "route", "uuid": "6726a66e-dad5-464c-87eb-f481017ffcbc" }, { "type": "route", "uuid": "72fc00d9-63b5-4121-8251-161d834a234f" }, { "type": "route", "uuid": "9696e030-2aa3-4301-a600-4826557828d5" }, { "type": "route", "uuid": "f39db7f2-dcc8-40f8-ac3a-7f348706b419" }, { "type": "route", "uuid": "eff049a1-7c75-47f1-bb92-9d72c876387e" }, { "type": "route", "uuid": "b3878771-384e-42c1-a5d7-010aab91b157" }, { "type": "route", "uuid": "ddcefeb3-1238-4223-8370-4bf06f5a5e13" }, { "type": "route", "uuid": "9695a08d-27c9-4a9f-89a0-5c6c1f490158" }, { "type": "route", "uuid": "5fdee57a-5aca-4388-b744-d35072654063" }, { "type": "route", "uuid": "c8328f64-6d97-4d6b-b01e-a18468f9f337" } ] }