{ "uuid": "282a6218-43c2-4f32-995b-0eed598509c2", "lastMigration": 19, "name": "Runscope API", "endpointPrefix": "", "latency": 0, "port": 3000, "hostname": "0.0.0.0", "routes": [ { "uuid": "aa61afe3-33cb-44b5-85d0-ca03e7e11789", "documentation": "Account Resource", "method": "get", "endpoint": "account", "responses": [ { "uuid": "6d71416d-9446-4013-8f34-a5d027d33643", "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" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "8a2e2566-eb72-4fdf-9fed-f11e968ce7c9", "body": "{\n \"code\": {{faker 'random.number'}},\n \"fields\": \"\",\n \"message\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "e53b7a0b-00df-41af-88c7-82f4ad4a586c", "documentation": "Returns a list of buckets.", "method": "get", "endpoint": "buckets", "responses": [ { "uuid": "d07dc372-5f97-4e2c-afb2-b775222c7155", "body": "{\n \"data\": [\n {\n \"auth_token\": \"\",\n \"collections_url\": \"\",\n \"default\": {{faker 'random.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 'random.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" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "cbf8e898-ae4e-420c-95b3-cf8612ea0ff7", "body": "{\n \"code\": {{faker 'random.number'}},\n \"fields\": \"\",\n \"message\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "ffe3f472-a2cc-4e1f-bec3-e031876f614d", "documentation": "Create a new bucket", "method": "post", "endpoint": "buckets", "responses": [ { "uuid": "b38e85f3-99eb-483e-95f7-bdaebcc5b9ec", "body": "{\n \"auth_token\": \"\",\n \"collections_url\": \"\",\n \"default\": {{faker 'random.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 'random.boolean'}}\n}", "latency": 0, "statusCode": 200, "label": "Bucket details.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "6e64c026-7df6-4e99-818a-7912fb2780d4", "body": "{\n \"code\": {{faker 'random.number'}},\n \"fields\": \"\",\n \"message\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "fdee3017-4b70-40d8-b0b6-01a2898a7a2d", "documentation": "Delete a single bucket resource.", "method": "delete", "endpoint": "buckets/:bucketKey", "responses": [ { "uuid": "e127c360-95c4-4b33-8ee9-a80a012eb42e", "body": "", "latency": 0, "statusCode": 204, "label": "No content with no body.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "59bb564f-562c-4e52-9995-70bf40e442f3", "body": "{\n \"code\": {{faker 'random.number'}},\n \"fields\": \"\",\n \"message\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "fedd9746-b463-4bf5-adce-f7c5959bc578", "documentation": "Returns a single bucket resource.", "method": "get", "endpoint": "buckets/:bucketKey", "responses": [ { "uuid": "f45d20cc-2ad9-4e35-a2d7-d87c2dd54ee7", "body": "{\n \"auth_token\": \"\",\n \"collections_url\": \"\",\n \"default\": {{faker 'random.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 'random.boolean'}}\n}", "latency": 0, "statusCode": 200, "label": "Bucket details.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "377f182f-be2c-4c30-be5d-d688e6608f02", "body": "{\n \"code\": {{faker 'random.number'}},\n \"fields\": \"\",\n \"message\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "9ee8b59d-1808-4388-9b6c-e289005e23bf", "documentation": "Returns list of shared environments for a specified bucket.", "method": "get", "endpoint": "buckets/:bucketKey/environments", "responses": [ { "uuid": "f7799346-f0be-450c-8b79-26f320d82ee9", "body": "", "latency": 0, "statusCode": 200, "label": "List of shared environments belonging to this bucket.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "fb603be1-64ad-492e-9dcd-274ec1fcc6e6", "documentation": "Create new shared environment.", "method": "post", "endpoint": "buckets/:bucketKey/environments", "responses": [ { "uuid": "da797fa9-5931-40ac-8825-1522bbe7ab86", "body": "", "latency": 0, "statusCode": 201, "label": "Details of the new test environment.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "2d7fa214-5c11-4a5f-b8bd-477c95c71f7a", "documentation": "Update the details of a shared environment.", "method": "put", "endpoint": "buckets/:bucketKey/environments/:environmentId", "responses": [ { "uuid": "fbbd779d-559c-4c32-9f7d-a18492f30478", "body": "", "latency": 0, "statusCode": 201, "label": "Details of the modified test environment.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "67c0851d-5148-431d-9f50-dcd32263d9cb", "documentation": "Retrieve a list of error messages in a bucket", "method": "get", "endpoint": "buckets/:bucketKey/errors", "responses": [ { "uuid": "eeab0fb2-7a18-41cc-abc3-c93ce3097630", "body": "", "latency": 0, "statusCode": 200, "label": "List of error messages in a bucket", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "ef0962d5-c2d3-4422-8c03-ce669b851658", "body": "{\n \"code\": {{faker 'random.number'}},\n \"fields\": \"\",\n \"message\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "24704168-ab19-4000-a344-3dbb394d67b0", "documentation": "Clear a bucket (remove all messages).", "method": "delete", "endpoint": "buckets/:bucketKey/messages", "responses": [ { "uuid": "d65ffd93-a09d-49be-b571-bd61f64b54ab", "body": "", "latency": 0, "statusCode": 204, "label": "No content with no body.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "2a7f0722-e005-4817-b982-8096f95e4ac3", "body": "{\n \"code\": {{faker 'random.number'}},\n \"fields\": \"\",\n \"message\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "d5c35a49-f8af-4577-a8c2-9bfaa539e681", "documentation": "Retrieve a list of messages in a bucket", "method": "get", "endpoint": "buckets/:bucketKey/messages", "responses": [ { "uuid": "809819b4-45fb-4b62-ac4a-888678d2c58c", "body": "", "latency": 0, "statusCode": 200, "label": "List of messages in a bucket", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "7f8a1f51-266a-4a38-8e4d-695a399aae28", "body": "{\n \"code\": {{faker 'random.number'}},\n \"fields\": \"\",\n \"message\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "9fe7725c-74b5-45db-9a65-6e06fc04637d", "documentation": "Create a message", "method": "post", "endpoint": "buckets/:bucketKey/messages", "responses": [ { "uuid": "3d57436b-f784-4019-9e8b-df04df8871b7", "body": "{\n \"data\": [\n {\n \"error\": {\n \"code\": {{faker 'random.number'}},\n \"message\": \"\",\n \"more_info\": \"\"\n },\n \"status\": \"\",\n \"unique_identifier\": \"\",\n \"uuid\": \"\",\n \"warning\": {\n \"code\": {{faker 'random.number'}},\n \"message\": \"\",\n \"more_info\": \"\"\n }\n }\n ],\n \"meta\": {\n \"error_count\": {{faker 'random.number'}},\n \"succcess_count\": {{faker 'random.number'}},\n \"warning_count\": {{faker 'random.number'}}\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" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "7cebf864-a628-4b6d-8dee-844613d6413d", "body": "{\n \"code\": {{faker 'random.number'}},\n \"fields\": \"\",\n \"message\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "5d15cef1-1e2c-43f9-ac4f-376cebbdc0a1", "documentation": "Retrieve the details for a single message.", "method": "get", "endpoint": "buckets/:bucketKey/messages/:messageId", "responses": [ { "uuid": "c03649b3-7335-4ce4-9f9d-b50b2451a6d9", "body": "", "latency": 0, "statusCode": 200, "label": "List of messages in a bucket", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "c5abb05e-ed75-4fc7-bb79-9e97b80f6c46", "body": "{\n \"code\": {{faker 'random.number'}},\n \"fields\": \"\",\n \"message\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "2d444bd7-6d33-4e72-8148-930dfea53fc1", "documentation": "Returns a list of tests.", "method": "get", "endpoint": "buckets/:bucketKey/tests", "responses": [ { "uuid": "0d4cfde6-d476-4b3d-9163-3ba93fc943c9", "body": "{\n \"data\": [\n {\n \"created_at\": {{faker 'random.number'}},\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" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "b5819096-e7f9-450d-9cc2-04219e472a5f", "documentation": "Create a test.", "method": "post", "endpoint": "buckets/:bucketKey/tests", "responses": [ { "uuid": "87e0b737-8ae0-4db8-b05f-aa7b4869c875", "body": "{\n \"data\": [\n {\n \"created_at\": {{faker 'random.number'}},\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" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "5c9de814-5c18-4d35-aa5d-34ff5b440f50", "documentation": "Delete a test, including all steps, schedules, test-specific environments and results.", "method": "delete", "endpoint": "buckets/:bucketKey/tests/:testId", "responses": [ { "uuid": "ed90c091-362f-4565-b42f-0cc74778404a", "body": "", "latency": 0, "statusCode": 204, "label": "No content with no body.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "7cfb1ee8-19e7-43ce-a740-52538121fcad", "documentation": "Retrieve the details of a given test by ID.", "method": "get", "endpoint": "buckets/:bucketKey/tests/:testId", "responses": [ { "uuid": "afce1d4f-632c-40c9-a914-056a0d2361c4", "body": "{\n \"environments\": {\n \"auth\": \"\",\n \"client_certificate\": \"\",\n \"emails\": {},\n \"exported_at\": {{faker 'random.number'}},\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 'random.boolean'}},\n \"regions\": [\n \"\"\n ],\n \"remote_agents\": [\n {\n \"agent_id\": \"\",\n \"name\": \"\",\n \"version\": \"\"\n }\n ],\n \"retry_on_failure\": {{faker 'random.boolean'}},\n \"script\": \"\",\n \"script_library\": [\n \"\"\n ],\n \"stop_on_failure\": {{faker 'random.boolean'}},\n \"test_id\": \"\",\n \"verify_ssl\": {{faker 'random.boolean'}},\n \"version\": \"\",\n \"webhooks\": \"\"\n },\n \"exported_at\": {{faker 'random.number'}},\n \"last_run\": {},\n \"schedules\": [\n {\n \"environment_id\": \"\",\n \"exported_at\": {{faker 'random.number'}},\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" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "f14ac7a2-afaa-4ed4-b126-d2340326032b", "body": "{\n \"code\": {{faker 'random.number'}},\n \"fields\": \"\",\n \"message\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "c82c24b2-02e5-4714-81be-cc186d7ce27e", "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": "67672d33-4587-429a-a2ef-680a40b9d374", "body": "{\n \"environments\": {\n \"auth\": \"\",\n \"client_certificate\": \"\",\n \"emails\": {},\n \"exported_at\": {{faker 'random.number'}},\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 'random.boolean'}},\n \"regions\": [\n \"\"\n ],\n \"remote_agents\": [\n {\n \"agent_id\": \"\",\n \"name\": \"\",\n \"version\": \"\"\n }\n ],\n \"retry_on_failure\": {{faker 'random.boolean'}},\n \"script\": \"\",\n \"script_library\": [\n \"\"\n ],\n \"stop_on_failure\": {{faker 'random.boolean'}},\n \"test_id\": \"\",\n \"verify_ssl\": {{faker 'random.boolean'}},\n \"version\": \"\",\n \"webhooks\": \"\"\n },\n \"exported_at\": {{faker 'random.number'}},\n \"last_run\": {},\n \"schedules\": [\n {\n \"environment_id\": \"\",\n \"exported_at\": {{faker 'random.number'}},\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" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "ed98772a-98fb-42b8-90f8-0614d531323c", "body": "{\n \"code\": {{faker 'random.number'}},\n \"fields\": \"\",\n \"message\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "6140c945-670d-42ba-bd43-3146701cc817", "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": "af541439-1d67-4435-b7dd-5e29b2d0d3ec", "body": "{\n \"data\": [\n {\n \"auth\": \"\",\n \"client_certificate\": \"\",\n \"emails\": {},\n \"exported_at\": {{faker 'random.number'}},\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 'random.boolean'}},\n \"regions\": [\n \"\"\n ],\n \"remote_agents\": [\n {\n \"agent_id\": \"\",\n \"name\": \"\",\n \"version\": \"\"\n }\n ],\n \"retry_on_failure\": {{faker 'random.boolean'}},\n \"script\": \"\",\n \"script_library\": [\n \"\"\n ],\n \"stop_on_failure\": {{faker 'random.boolean'}},\n \"test_id\": \"\",\n \"verify_ssl\": {{faker 'random.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" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "6bdb5d06-631b-4274-a7bc-0f6a947e8bb9", "documentation": "Create new test environment.", "method": "post", "endpoint": "buckets/:bucketKey/tests/:testId/environments", "responses": [ { "uuid": "ad539733-a095-4bb8-abf9-84dffd6ebae6", "body": "", "latency": 0, "statusCode": 201, "label": "Details of the new test environment.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "7ab4ba51-a1ef-4130-ad15-1c49c8c4ee74", "documentation": "Update the details of a test environment.", "method": "put", "endpoint": "buckets/:bucketKey/tests/:testId/environments/:environmentId", "responses": [ { "uuid": "27077e1c-278e-4215-89ee-ef73d91f693e", "body": "", "latency": 0, "statusCode": 201, "label": "Details of the modified test environment.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "a9887cfe-b761-4959-a8e5-c440dad874e7", "documentation": "Return details of the test metrics for the specified timeframe.", "method": "get", "endpoint": "buckets/:bucketKey/tests/:testId/metrics", "responses": [ { "uuid": "c3062a7f-c45c-4659-959b-3f4867c9fa48", "body": "{\n \"changes_from_last_period\": {},\n \"environment_uuid\": \"\",\n \"region\": \"\",\n \"response_times\": [\n {\n \"avg_response_time_ms\": {{faker 'random.number'}},\n \"success_ratio\": {{faker 'random.number'}},\n \"timestamp\": {{faker 'random.number'}}\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" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "2644e92d-ffc2-4ba2-b4ee-838f674f8d27", "documentation": "List test steps for a test.", "method": "get", "endpoint": "buckets/:bucketKey/tests/:testId/steps", "responses": [ { "uuid": "140c65e6-bcf7-4bd2-b713-ef4c95098a13", "body": "", "latency": 0, "statusCode": 200, "label": "List of test steps for a test", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "4a23f329-4e8f-47a6-82c8-a2d3600964e7", "documentation": "Add new test step.", "method": "post", "endpoint": "buckets/:bucketKey/tests/:testId/steps", "responses": [ { "uuid": "b54fc5ad-da95-46cc-8eb3-f69adc742019", "body": "", "latency": 0, "statusCode": 201, "label": "Details of the new test step.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "177b708a-0756-437f-aabf-8ab46ec0eb85", "body": "{\n \"data\": {},\n \"error\": {\n \"error\": \"\",\n \"message\": \"\",\n \"more_info\": \"\",\n \"status\": {{faker 'random.number'}}\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" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "89619bb6-9428-49a0-a73f-1055bc5ed45f", "documentation": "Delete a step from a test.", "method": "delete", "endpoint": "buckets/:bucketKey/tests/:testId/steps/:stepId", "responses": [ { "uuid": "90a51f55-7a8e-4e50-8dab-5c7e5f7b2259", "body": "", "latency": 0, "statusCode": 204, "label": "No content with no body.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "60c3f265-bbaf-41d7-b05a-4c6f66db5274", "documentation": "Update the details of a single test step.", "method": "put", "endpoint": "buckets/:bucketKey/tests/:testId/steps/:stepId", "responses": [ { "uuid": "e0a7606b-9788-4ee4-ad1d-ab9d23264e5f", "body": "", "latency": 0, "statusCode": 200, "label": "List of test steps for a test", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "bfe6352b-a056-46e6-9bf5-43bb73950de8", "body": "{\n \"data\": {},\n \"error\": {\n \"error\": \"\",\n \"message\": \"\",\n \"more_info\": \"\",\n \"status\": {{faker 'random.number'}}\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" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "65f63529-bb6a-4a44-b14b-0f3d75f54c29", "documentation": "Team agents list", "method": "get", "endpoint": "teams/:teamId/agents", "responses": [ { "uuid": "2f88848a-b9ba-404a-a29a-3103e616e1e1", "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" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "c8d11c48-a5da-41df-9fe6-7bc3ead6474b", "body": "{\n \"code\": {{faker 'random.number'}},\n \"fields\": \"\",\n \"message\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "5157433c-89e1-4b4e-9092-ffc2b081f4d3", "documentation": "Team integrations list", "method": "get", "endpoint": "teams/:teamId/integrations", "responses": [ { "uuid": "1eb04512-10db-4c84-83b5-36b16666db39", "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" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "8d4d1d04-9223-49dc-ab2f-6a43a14c5dc1", "body": "{\n \"code\": {{faker 'random.number'}},\n \"fields\": \"\",\n \"message\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "614fe3f2-db36-41b2-8878-082a2eec9f9a", "documentation": "Teams Resource", "method": "get", "endpoint": "teams/:teamId/people", "responses": [ { "uuid": "48a1cbc2-2524-4cd1-af15-235322909b69", "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" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "a708ea76-e054-4655-bde7-a16517d05053", "body": "{\n \"code\": {{faker 'random.number'}},\n \"fields\": \"\",\n \"message\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false } ], "proxyMode": false, "proxyHost": "", "proxyRemovePrefix": false, "tlsOptions": { "enabled": false, "type": "CERT", "pfxPath": "", "certPath": "", "keyPath": "", "caPath": "", "passphrase": "" }, "cors": true, "headers": [], "proxyReqHeaders": [ { "key": "", "value": "" } ], "proxyResHeaders": [ { "key": "", "value": "" } ] }