{ "uuid": "7571a7dc-2993-4f79-b055-0fb8a97db85b", "lastMigration": 29, "name": "LambdaTest Screenshots API Documentation", "endpointPrefix": "screenshots/v1", "latency": 0, "port": 3000, "hostname": "", "routes": [ { "uuid": "5c3d92b2-ab03-4d74-aacd-08a495d5472d", "documentation": "Start Screenshot Test", "method": "post", "endpoint": "", "responses": [ { "uuid": "17056cf0-6d57-4152-9e76-7f1c526a424f", "body": "{\n \"test_id\": \"TES100968331562243938913767\"\n}", "latency": 0, "statusCode": 200, "label": "successful operation", "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": "354c8567-7736-4c20-88c6-8f7393870066", "body": "{\n \"message\": \"The os, browser, browser_version combination is either unsupported or doesn't exist. Please try again with a different combination.\"\n}", "latency": 0, "statusCode": 400, "label": "Bad Request", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "f44a0344-581d-41d4-ad9f-640573e40fe5", "body": "{\n \"message\": \"Unauthorized\"\n}", "latency": 0, "statusCode": 401, "label": "Access denied. Auth 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" }, { "uuid": "874cc599-5cc5-4af7-bcaf-b8b7401e0c20", "body": "{\n \"message\": \"Screenshot API is supported only in our premium plans. Please upgrade.\"\n}", "latency": 0, "statusCode": 403, "label": "Access denied. Auth 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": "4627eabc-3b7d-4dba-8922-a84ad8456cd4", "documentation": "Fetch all available device combinations.", "method": "get", "endpoint": "devices", "responses": [ { "uuid": "1ab2c3a2-efb4-4660-a2e1-7c4191925275", "body": "{\n \"android 7.0\": {\n \"devices\": [\n \"galaxy j7 max\",\n \"galaxy s8\",\n \"galaxy s8+\",\n \"galaxy tab s3 9.3\",\n \"huawei honor 6x\",\n \"nexus 5x\",\n \"nexus 6p\",\n \"oppo r9\"\n ]\n },\n \"ios 12.0\": {\n \"devices\": [\n \"iphone xr\",\n \"iphone xs\",\n \"iphone xs max\"\n ]\n }\n}", "latency": 0, "statusCode": 200, "label": "successful operation", "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": "bdc5b651-f3ec-4083-a2d6-eb5fd36549c0", "body": "{\n \"message\": \"Unauthorized\"\n}", "latency": 0, "statusCode": 401, "label": "Access denied. Auth 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": "98ea6926-3e09-436a-8e4f-378b464e2f7d", "documentation": "Fetch Locations", "method": "get", "endpoint": "locations", "responses": [ { "uuid": "f16f4f86-b42b-44ac-8e50-f6c223923a49", "body": "{\n \"locations\": [\n {\n \"code\": \"US\",\n \"name\": \"United States\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "successful operation", "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": "46781744-cbc7-4d8b-b870-593cff5bbbf3", "body": "{\n \"message\": \"Unauthorized\"\n}", "latency": 0, "statusCode": 401, "label": "Access denied. Auth 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": "1459bb23-c39a-49f0-96be-a268a028b5ef", "documentation": "Fetch all available os-browser combinations.", "method": "get", "endpoint": "os-browsers", "responses": [ { "uuid": "2b12dec3-37bb-48e6-87b7-6fc699c60962", "body": "{\n \"macos mojave\": {\n \"chrome\": [\n \"76\",\n \"75\"\n ],\n \"firefox\": [\n \"67\",\n \"66\"\n ],\n \"opera\": [\n \"55\",\n \"54\"\n ]\n },\n \"windows 10\": {\n \"chrome\": [\n \"76\",\n \"75\"\n ],\n \"firefox\": [\n \"67\",\n \"66\"\n ],\n \"opera\": [\n \"55\",\n \"54\"\n ]\n }\n}", "latency": 0, "statusCode": 200, "label": "successful operation", "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": "e1f87049-0d2b-4439-9a36-8bb933424ee6", "body": "{\n \"message\": \"Unauthorized\"\n}", "latency": 0, "statusCode": 401, "label": "Access denied. Auth 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": "92220da1-395d-434f-bc84-de93e533cf42", "documentation": "Fetch login profiles", "method": "get", "endpoint": "profiles", "responses": [ { "uuid": "c2cc0092-7c9b-4c3b-ab43-63d4365c944a", "body": "{\n \"profiles\": [\n {\n \"name\": \"lambda-login\",\n \"profile_config\": {\n \"credentials\": {\n \"password\": \"password\",\n \"username\": \"name\"\n },\n \"locators\": {\n \"password\": {\n \"type\": \"name\",\n \"value\": \"password\"\n },\n \"submit\": {\n \"type\": \"css\",\n \"value\": \"button.btn-lg\"\n },\n \"username\": {\n \"type\": \"name\",\n \"value\": \"email\"\n }\n },\n \"login_url\": \"https://accounts.lambdatest.com/login\",\n \"profile_name\": \"lambda-login\"\n }\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "successful operation", "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": "4dea5b5b-3e4d-4ff1-860e-8d96c6f830d5", "body": "{\n \"message\": \"Unauthorized\"\n}", "latency": 0, "statusCode": 401, "label": "Access denied. Auth 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": "6fb44f42-f019-4664-9de5-1c42ffbbca0d", "documentation": "Fetch all available resolution on different OS", "method": "get", "endpoint": "resolutions", "responses": [ { "uuid": "9a316db4-a575-4eb7-b8a5-56f9b3b6ca7d", "body": "{\n \"mac_res\": [\n \"1024x768\",\n \"1280x1024\"\n ],\n \"win_res\": [\n \"1024x768\",\n \"1280x1024\"\n ]\n}", "latency": 0, "statusCode": 200, "label": "successful operation", "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": "cec28e0f-c523-4a11-8e3b-62dc1e99cd24", "body": "{\n \"message\": \"Unauthorized\"\n}", "latency": 0, "statusCode": 401, "label": "Access denied. Auth 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": "94f960ca-7ead-4c7c-aaee-c86b1661ff1c", "documentation": "Stop specified screenshot test", "method": "put", "endpoint": "stop/:test_id", "responses": [ { "uuid": "262de7c7-2782-436b-a8f7-dc401d7765e3", "body": "{\n \"message\": \"Test stopped successfully\"\n}", "latency": 0, "statusCode": 200, "label": "successful operation", "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": "0ba26ba8-8ad1-4da9-b119-b47c73bca4a1", "body": "{\n \"message\": \"Unauthorized\"\n}", "latency": 0, "statusCode": 401, "label": "Access denied. Auth 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" }, { "uuid": "af995344-066b-48f6-ac4b-c5228e207f80", "body": "{\n \"message\": \"Screenshot API is supported only in our premium plans. Please upgrade.\"\n}", "latency": 0, "statusCode": 403, "label": "Access denied. Auth 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" }, { "uuid": "fc962def-b165-4f88-a602-a76b8e5a2a21", "body": "{\n \"message\": \"No active Screenshot test found for this test_id\"\n}", "latency": 0, "statusCode": 404, "label": "Resource not found", "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": "4a7c938b-6181-47c5-93cd-14f65fdf430d", "documentation": "Fetch specified screenshot details", "method": "get", "endpoint": ":test_id", "responses": [ { "uuid": "b45bb7f9-d967-4f72-acef-bafb870d088b", "body": "{\n \"callback_url\": \"https://www.example.com\",\n \"defer_time\": 5,\n \"screenshots\": [\n {\n \"activity_id\": \"ACT100968331562237283340194\",\n \"browser\": \"chrome\",\n \"browser_version\": \"76\",\n \"os\": \"windows 10\",\n \"resolution\": \"1024x768\",\n \"screenshot_url\": \"https://s3.amazonaws.com/s3-screenshots/prod/ACT100968331562237283340194/screenshot/win-cr-76.0.png\",\n \"status\": \"completed\",\n \"thumbnail_url\": \"https://s3.amazonaws.com/s3-screenshots/prod/ACT100968331562237283340194/screenshot/win-cr-76.0.png\"\n }\n ],\n \"test_id\": \"TES100968331562237283314836\",\n \"test_status\": \"completed\",\n \"url\": \"https://www.lambdatest.com\"\n}", "latency": 0, "statusCode": 200, "label": "successful operation", "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": "77e53d9b-073a-41f4-9312-adf09232dd73", "body": "{\n \"message\": \"Unauthorized\"\n}", "latency": 0, "statusCode": 401, "label": "Access denied. Auth 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" }, { "uuid": "2e3c73d5-d252-447e-bfc1-403b11b6e87f", "body": "{\n \"message\": \"Screenshot API is supported only in our premium plans. Please upgrade.\"\n}", "latency": 0, "statusCode": 403, "label": "Access denied. Auth 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" }, { "uuid": "059c4b53-a058-4dfc-b397-f19c244c9754", "body": "{\n \"message\": \"No data found\",\n \"reason\": \"test_id is invalid\"\n}", "latency": 0, "statusCode": 404, "label": "Resource not found", "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": "a20b600e-49a6-40b0-823b-940bcf0a81aa", "documentation": "Fetch Zipped Screenshots", "method": "get", "endpoint": ":test_id/zip", "responses": [ { "uuid": "33ff240a-9090-4c52-b2a3-b62369039167", "body": "{\n \"url\": \"https://s3-screenshots.s3.amazonaws.com/screenshots/TES1009632231568637527345629.zip\"\n}", "latency": 0, "statusCode": 200, "label": "successful operation", "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": "a0ddc7a1-b1e8-4047-97db-43dbaedbc4e8", "body": "{\n \"message\": \"Unauthorized\"\n}", "latency": 0, "statusCode": 401, "label": "Access denied. Auth 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" }, { "uuid": "3f3cb5aa-a325-48a2-b50f-64adca9a068c", "body": "{\n \"message\": \"Screenshot API is supported only in our premium plans. Please upgrade.\"\n}", "latency": 0, "statusCode": 403, "label": "Access denied. Auth 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" }, { "uuid": "7ba13afb-7b32-49ec-90e2-4f5521503e92", "body": "{\n \"message\": \"No data found\",\n \"reason\": \"test_id is invalid\"\n}", "latency": 0, "statusCode": 404, "label": "Resource not found", "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": "5c3d92b2-ab03-4d74-aacd-08a495d5472d" }, { "type": "route", "uuid": "4627eabc-3b7d-4dba-8922-a84ad8456cd4" }, { "type": "route", "uuid": "98ea6926-3e09-436a-8e4f-378b464e2f7d" }, { "type": "route", "uuid": "1459bb23-c39a-49f0-96be-a268a028b5ef" }, { "type": "route", "uuid": "92220da1-395d-434f-bc84-de93e533cf42" }, { "type": "route", "uuid": "6fb44f42-f019-4664-9de5-1c42ffbbca0d" }, { "type": "route", "uuid": "94f960ca-7ead-4c7c-aaee-c86b1661ff1c" }, { "type": "route", "uuid": "4a7c938b-6181-47c5-93cd-14f65fdf430d" }, { "type": "route", "uuid": "a20b600e-49a6-40b0-823b-940bcf0a81aa" } ] }