@browserless.io/browserless 2.33.0 → 2.34.0-beta-0

package/static/docs/swagger.min.json

@@ -280,14 +280,14 @@
                 "length": {
                   "type": "number"
                 },
-                "__@toStringTag@6502": {
+                "__@toStringTag@22341": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@6502",
+                "__@toStringTag@22341",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -322,13 +322,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@6502": {
+        "__@toStringTag@22341": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@6502",
+        "__@toStringTag@22341",
         "byteLength"
       ]
     },
@@ -338,18 +338,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@15689": {
+        "__@species@31824": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@6502": {
+        "__@toStringTag@22341": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@15689",
-        "__@toStringTag@6502",
+        "__@species@31824",
+        "__@toStringTag@22341",
         "byteLength"
       ]
     },
@@ -1014,7 +1014,7 @@
   },
   "info": {
     "title": "Browserless",
-    "version": "2.33.0",
+    "version": "2.34.0-beta-0",
     "x-logo": {
       "altText": "browserless logo",
       "url": "./docs/browserless-logo-inline.svg"
@@ -1308,6 +1308,11 @@
             "code": 500,
             "description": "An internal error occurred when handling the request.",
             "message": "HTTP/1.1 500 Internal Server Error"
+          },
+          "503": {
+            "code": 503,
+            "description": "Service is unavailable.",
+            "message": "HTTP/1.1 503 Service Unavailable"
           }
         },
         "summary": "/chrome/content",
@@ -1424,6 +1429,11 @@
             "code": 500,
             "description": "An internal error occurred when handling the request.",
             "message": "HTTP/1.1 500 Internal Server Error"
+          },
+          "503": {
+            "code": 503,
+            "description": "Service is unavailable.",
+            "message": "HTTP/1.1 503 Service Unavailable"
           }
         },
         "summary": "/chrome/download",
@@ -1540,6 +1550,11 @@
             "code": 500,
             "description": "An internal error occurred when handling the request.",
             "message": "HTTP/1.1 500 Internal Server Error"
+          },
+          "503": {
+            "code": 503,
+            "description": "Service is unavailable.",
+            "message": "HTTP/1.1 503 Service Unavailable"
           }
         },
         "summary": "/chrome/function",
@@ -1644,6 +1659,11 @@
             "code": 500,
             "description": "An internal error occurred when handling the request.",
             "message": "HTTP/1.1 500 Internal Server Error"
+          },
+          "503": {
+            "code": 503,
+            "description": "Service is unavailable.",
+            "message": "HTTP/1.1 503 Service Unavailable"
           }
         },
         "summary": "/json/list",
@@ -1740,6 +1760,11 @@
             "code": 500,
             "description": "An internal error occurred when handling the request.",
             "message": "HTTP/1.1 500 Internal Server Error"
+          },
+          "503": {
+            "code": 503,
+            "description": "Service is unavailable.",
+            "message": "HTTP/1.1 503 Service Unavailable"
           }
         },
         "summary": "/json/new",
@@ -1798,6 +1823,11 @@
             "code": 500,
             "description": "An internal error occurred when handling the request.",
             "message": "HTTP/1.1 500 Internal Server Error"
+          },
+          "503": {
+            "code": 503,
+            "description": "Service is unavailable.",
+            "message": "HTTP/1.1 503 Service Unavailable"
           }
         },
         "summary": "/json/protocol",
@@ -1894,6 +1924,11 @@
             "code": 500,
             "description": "An internal error occurred when handling the request.",
             "message": "HTTP/1.1 500 Internal Server Error"
+          },
+          "503": {
+            "code": 503,
+            "description": "Service is unavailable.",
+            "message": "HTTP/1.1 503 Service Unavailable"
           }
         },
         "summary": "/json/version",
@@ -2191,6 +2226,11 @@
             "code": 500,
             "description": "An internal error occurred when handling the request.",
             "message": "HTTP/1.1 500 Internal Server Error"
+          },
+          "503": {
+            "code": 503,
+            "description": "Service is unavailable.",
+            "message": "HTTP/1.1 503 Service Unavailable"
           }
         },
         "summary": "/chrome/pdf",
@@ -2323,6 +2363,11 @@
             "code": 500,
             "description": "An internal error occurred when handling the request.",
             "message": "HTTP/1.1 500 Internal Server Error"
+          },
+          "503": {
+            "code": 503,
+            "description": "Service is unavailable.",
+            "message": "HTTP/1.1 503 Service Unavailable"
           }
         },
         "summary": "/chrome/performance",
@@ -2954,6 +2999,11 @@
             "code": 500,
             "description": "An internal error occurred when handling the request.",
             "message": "HTTP/1.1 500 Internal Server Error"
+          },
+          "503": {
+            "code": 503,
+            "description": "Service is unavailable.",
+            "message": "HTTP/1.1 503 Service Unavailable"
           }
         },
         "summary": "/chrome/scrape",
@@ -3265,6 +3315,11 @@
             "code": 500,
             "description": "An internal error occurred when handling the request.",
             "message": "HTTP/1.1 500 Internal Server Error"
+          },
+          "503": {
+            "code": 503,
+            "description": "Service is unavailable.",
+            "message": "HTTP/1.1 503 Service Unavailable"
           }
         },
         "summary": "/chrome/screenshot",
@@ -3559,6 +3614,11 @@
             "code": 500,
             "description": "An internal error occurred when handling the request.",
             "message": "HTTP/1.1 500 Internal Server Error"
+          },
+          "503": {
+            "code": 503,
+            "description": "Service is unavailable.",
+            "message": "HTTP/1.1 503 Service Unavailable"
           }
         },
         "summary": "/chromium/content",
@@ -3675,6 +3735,11 @@
             "code": 500,
             "description": "An internal error occurred when handling the request.",
             "message": "HTTP/1.1 500 Internal Server Error"
+          },
+          "503": {
+            "code": 503,
+            "description": "Service is unavailable.",
+            "message": "HTTP/1.1 503 Service Unavailable"
           }
         },
         "summary": "/chromium/download",
@@ -3791,6 +3856,11 @@
             "code": 500,
             "description": "An internal error occurred when handling the request.",
             "message": "HTTP/1.1 500 Internal Server Error"
+          },
+          "503": {
+            "code": 503,
+            "description": "Service is unavailable.",
+            "message": "HTTP/1.1 503 Service Unavailable"
           }
         },
         "summary": "/chromium/function",
@@ -4088,6 +4158,11 @@
             "code": 500,
             "description": "An internal error occurred when handling the request.",
             "message": "HTTP/1.1 500 Internal Server Error"
+          },
+          "503": {
+            "code": 503,
+            "description": "Service is unavailable.",
+            "message": "HTTP/1.1 503 Service Unavailable"
           }
         },
         "summary": "/chromium/pdf",
@@ -4220,6 +4295,11 @@
             "code": 500,
             "description": "An internal error occurred when handling the request.",
             "message": "HTTP/1.1 500 Internal Server Error"
+          },
+          "503": {
+            "code": 503,
+            "description": "Service is unavailable.",
+            "message": "HTTP/1.1 503 Service Unavailable"
           }
         },
         "summary": "/chromium/performance",
@@ -4851,6 +4931,11 @@
             "code": 500,
             "description": "An internal error occurred when handling the request.",
             "message": "HTTP/1.1 500 Internal Server Error"
+          },
+          "503": {
+            "code": 503,
+            "description": "Service is unavailable.",
+            "message": "HTTP/1.1 503 Service Unavailable"
           }
         },
         "summary": "/chromium/scrape",
@@ -5162,6 +5247,11 @@
             "code": 500,
             "description": "An internal error occurred when handling the request.",
             "message": "HTTP/1.1 500 Internal Server Error"
+          },
+          "503": {
+            "code": 503,
+            "description": "Service is unavailable.",
+            "message": "HTTP/1.1 503 Service Unavailable"
           }
         },
         "summary": "/chromium/screenshot",
@@ -5456,6 +5546,11 @@
             "code": 500,
             "description": "An internal error occurred when handling the request.",
             "message": "HTTP/1.1 500 Internal Server Error"
+          },
+          "503": {
+            "code": 503,
+            "description": "Service is unavailable.",
+            "message": "HTTP/1.1 503 Service Unavailable"
           }
         },
         "summary": "/edge/content",
@@ -5572,6 +5667,11 @@
             "code": 500,
             "description": "An internal error occurred when handling the request.",
             "message": "HTTP/1.1 500 Internal Server Error"
+          },
+          "503": {
+            "code": 503,
+            "description": "Service is unavailable.",
+            "message": "HTTP/1.1 503 Service Unavailable"
           }
         },
         "summary": "/edge/download",
@@ -5688,6 +5788,11 @@
             "code": 500,
             "description": "An internal error occurred when handling the request.",
             "message": "HTTP/1.1 500 Internal Server Error"
+          },
+          "503": {
+            "code": 503,
+            "description": "Service is unavailable.",
+            "message": "HTTP/1.1 503 Service Unavailable"
           }
         },
         "summary": "/edge/function",
@@ -5985,6 +6090,11 @@
             "code": 500,
             "description": "An internal error occurred when handling the request.",
             "message": "HTTP/1.1 500 Internal Server Error"
+          },
+          "503": {
+            "code": 503,
+            "description": "Service is unavailable.",
+            "message": "HTTP/1.1 503 Service Unavailable"
           }
         },
         "summary": "/edge/pdf",
@@ -6117,6 +6227,11 @@
             "code": 500,
             "description": "An internal error occurred when handling the request.",
             "message": "HTTP/1.1 500 Internal Server Error"
+          },
+          "503": {
+            "code": 503,
+            "description": "Service is unavailable.",
+            "message": "HTTP/1.1 503 Service Unavailable"
           }
         },
         "summary": "/edge/performance",
@@ -6748,6 +6863,11 @@
             "code": 500,
             "description": "An internal error occurred when handling the request.",
             "message": "HTTP/1.1 500 Internal Server Error"
+          },
+          "503": {
+            "code": 503,
+            "description": "Service is unavailable.",
+            "message": "HTTP/1.1 503 Service Unavailable"
           }
         },
         "summary": "/edge/scrape",
@@ -7059,6 +7179,11 @@
             "code": 500,
             "description": "An internal error occurred when handling the request.",
             "message": "HTTP/1.1 500 Internal Server Error"
+          },
+          "503": {
+            "code": 503,
+            "description": "Service is unavailable.",
+            "message": "HTTP/1.1 503 Service Unavailable"
           }
         },
         "summary": "/edge/screenshot",
@@ -7105,6 +7230,11 @@
             "code": 500,
             "description": "An internal error occurred when handling the request.",
             "message": "HTTP/1.1 500 Internal Server Error"
+          },
+          "503": {
+            "code": 503,
+            "description": "Service is unavailable.",
+            "message": "HTTP/1.1 503 Service Unavailable"
           }
         },
         "summary": "/active",
@@ -7264,6 +7394,11 @@
             "code": 500,
             "description": "An internal error occurred when handling the request.",
             "message": "HTTP/1.1 500 Internal Server Error"
+          },
+          "503": {
+            "code": 503,
+            "description": "Service is unavailable.",
+            "message": "HTTP/1.1 503 Service Unavailable"
           }
         },
         "summary": "/config",
@@ -7277,19 +7412,9 @@
         "definitions": {},
         "description": "Kill running sessions based on BrowserId or TrackingId.",
         "parameters": [
-          {
-            "in": "query",
-            "name": "token",
-            "required": true,
-            "schema": {
-              "description": "The authorization token",
-              "type": "string"
-            }
-          },
           {
             "in": "query",
             "name": "blockAds",
-            "required": false,
             "schema": {
               "description": "Whether or nor to load ad-blocking extensions for the session.\nThis currently uses uBlock-Lite and may cause certain sites\nto not load properly.",
               "type": "boolean"
@@ -7298,7 +7423,6 @@
           {
             "in": "query",
             "name": "browserId",
-            "required": false,
             "schema": {
               "type": "string"
             }
@@ -7306,7 +7430,6 @@
           {
             "in": "query",
             "name": "launch",
-            "required": false,
             "schema": {
               "description": "Launch options, which can be either an object\nof puppeteer.launch options or playwright.launchServer\noptions, depending on the API. Must be either JSON\nobject, or a base64-encoded JSON object.",
               "anyOf": [
@@ -7325,16 +7448,22 @@
           {
             "in": "query",
             "name": "timeout",
-            "required": false,
             "schema": {
               "description": "Override the system-level timeout for this request.\nAccepts a value in milliseconds.",
               "type": "number"
             }
           },
+          {
+            "in": "query",
+            "name": "token",
+            "schema": {
+              "description": "The authorization token",
+              "type": "string"
+            }
+          },
           {
             "in": "query",
             "name": "trackingId",
-            "required": false,
             "schema": {
               "description": "Custom session identifier",
               "type": "string"
@@ -7374,6 +7503,11 @@
             "code": 500,
             "description": "An internal error occurred when handling the request.",
             "message": "HTTP/1.1 500 Internal Server Error"
+          },
+          "503": {
+            "code": 503,
+            "description": "Service is unavailable.",
+            "message": "HTTP/1.1 503 Service Unavailable"
           }
         },
         "summary": "/kill/+([0-9a-zA-Z-_])",
@@ -7480,6 +7614,11 @@
             "code": 500,
             "description": "An internal error occurred when handling the request.",
             "message": "HTTP/1.1 500 Internal Server Error"
+          },
+          "503": {
+            "code": 503,
+            "description": "Service is unavailable.",
+            "message": "HTTP/1.1 503 Service Unavailable"
           }
         },
         "summary": "/meta",
@@ -7526,6 +7665,11 @@
             "code": 500,
             "description": "An internal error occurred when handling the request.",
             "message": "HTTP/1.1 500 Internal Server Error"
+          },
+          "503": {
+            "code": 503,
+            "description": "Service is unavailable.",
+            "message": "HTTP/1.1 503 Service Unavailable"
           }
         },
         "summary": "/metrics/total",
@@ -7572,6 +7716,11 @@
             "code": 500,
             "description": "An internal error occurred when handling the request.",
             "message": "HTTP/1.1 500 Internal Server Error"
+          },
+          "503": {
+            "code": 503,
+            "description": "Service is unavailable.",
+            "message": "HTTP/1.1 503 Service Unavailable"
           }
         },
         "summary": "/metrics",
@@ -7583,7 +7732,7 @@
     "/pressure": {
       "get": {
         "definitions": {},
-        "description": "Returns a JSON body of stats related to the pressure being created on the instance.",
+        "description": "Returns a JSON body of stats related to the pressure being exerted on the instance. This route is dynamic based upon the supplied \"Accept\" header, and will either return a human-readable message if the \"Accept\" header is set to \"text/plain\", or the default JSON body and a 200 HTTP code.\n\nWhen Accept is set to \"text/plain\" a human-readable message is sent back describing the state of the container, and either a \"200\" code (indicating \"ok\") or a \"503\" code (indicating that the service is unavailable due to load).\n\nIf the \"Accept\" header is set to anything else it will return a JSON body with the same information.",
         "parameters": [],
         "requestBody": {
           "content": {}
@@ -7618,6 +7767,11 @@
             "code": 500,
             "description": "An internal error occurred when handling the request.",
             "message": "HTTP/1.1 500 Internal Server Error"
+          },
+          "503": {
+            "code": 503,
+            "description": "Service is unavailable.",
+            "message": "HTTP/1.1 503 Service Unavailable"
           }
         },
         "summary": "/pressure",
@@ -7631,19 +7785,9 @@
         "definitions": {},
         "description": "Lists all currently running sessions and relevant meta-data excluding potentially open pages.",
         "parameters": [
-          {
-            "in": "query",
-            "name": "token",
-            "required": true,
-            "schema": {
-              "description": "The authorization token",
-              "type": "string"
-            }
-          },
           {
             "in": "query",
             "name": "blockAds",
-            "required": false,
             "schema": {
               "description": "Whether or nor to load ad-blocking extensions for the session.\nThis currently uses uBlock-Lite and may cause certain sites\nto not load properly.",
               "type": "boolean"
@@ -7652,7 +7796,6 @@
           {
             "in": "query",
             "name": "launch",
-            "required": false,
             "schema": {
               "description": "Launch options, which can be either an object\nof puppeteer.launch options or playwright.launchServer\noptions, depending on the API. Must be either JSON\nobject, or a base64-encoded JSON object.",
               "anyOf": [
@@ -7671,16 +7814,22 @@
           {
             "in": "query",
             "name": "timeout",
-            "required": false,
             "schema": {
               "description": "Override the system-level timeout for this request.\nAccepts a value in milliseconds.",
               "type": "number"
             }
           },
+          {
+            "in": "query",
+            "name": "token",
+            "schema": {
+              "description": "The authorization token",
+              "type": "string"
+            }
+          },
           {
             "in": "query",
             "name": "trackingId",
-            "required": false,
             "schema": {
               "description": "Custom session identifier",
               "type": "string"
@@ -7720,6 +7869,11 @@
             "code": 500,
             "description": "An internal error occurred when handling the request.",
             "message": "HTTP/1.1 500 Internal Server Error"
+          },
+          "503": {
+            "code": 503,
+            "description": "Service is unavailable.",
+            "message": "HTTP/1.1 503 Service Unavailable"
           }
         },
         "summary": "/sessions",
@@ -7766,6 +7920,11 @@
             "code": 500,
             "description": "An internal error occurred when handling the request.",
             "message": "HTTP/1.1 500 Internal Server Error"
+          },
+          "503": {
+            "code": 503,
+            "description": "Service is unavailable.",
+            "message": "HTTP/1.1 503 Service Unavailable"
           }
         },
         "summary": "/",
@@ -7863,6 +8022,11 @@
             "code": 500,
             "description": "An internal error occurred when handling the request.",
             "message": "HTTP/1.1 500 Internal Server Error"
+          },
+          "503": {
+            "code": 503,
+            "description": "Service is unavailable.",
+            "message": "HTTP/1.1 503 Service Unavailable"
           }
         },
         "summary": "/devtools/browser/*",
@@ -7960,6 +8124,11 @@
             "code": 500,
             "description": "An internal error occurred when handling the request.",
             "message": "HTTP/1.1 500 Internal Server Error"
+          },
+          "503": {
+            "code": 503,
+            "description": "Service is unavailable.",
+            "message": "HTTP/1.1 503 Service Unavailable"
           }
         },
         "summary": "/chrome",
@@ -8057,6 +8226,11 @@
             "code": 500,
             "description": "An internal error occurred when handling the request.",
             "message": "HTTP/1.1 500 Internal Server Error"
+          },
+          "503": {
+            "code": 503,
+            "description": "Service is unavailable.",
+            "message": "HTTP/1.1 503 Service Unavailable"
           }
         },
         "summary": "/devtools/page/*",
@@ -8154,6 +8328,11 @@
             "code": 500,
             "description": "An internal error occurred when handling the request.",
             "message": "HTTP/1.1 500 Internal Server Error"
+          },
+          "503": {
+            "code": 503,
+            "description": "Service is unavailable.",
+            "message": "HTTP/1.1 503 Service Unavailable"
           }
         },
         "summary": "/chrome/playwright",
@@ -8251,6 +8430,11 @@
             "code": 500,
             "description": "An internal error occurred when handling the request.",
             "message": "HTTP/1.1 500 Internal Server Error"
+          },
+          "503": {
+            "code": 503,
+            "description": "Service is unavailable.",
+            "message": "HTTP/1.1 503 Service Unavailable"
           }
         },
         "summary": "/chromium",
@@ -8348,6 +8532,11 @@
             "code": 500,
             "description": "An internal error occurred when handling the request.",
             "message": "HTTP/1.1 500 Internal Server Error"
+          },
+          "503": {
+            "code": 503,
+            "description": "Service is unavailable.",
+            "message": "HTTP/1.1 503 Service Unavailable"
           }
         },
         "summary": "/playwright/chromium",
@@ -8445,6 +8634,11 @@
             "code": 500,
             "description": "An internal error occurred when handling the request.",
             "message": "HTTP/1.1 500 Internal Server Error"
+          },
+          "503": {
+            "code": 503,
+            "description": "Service is unavailable.",
+            "message": "HTTP/1.1 503 Service Unavailable"
           }
         },
         "summary": "/edge",
@@ -8542,6 +8736,11 @@
             "code": 500,
             "description": "An internal error occurred when handling the request.",
             "message": "HTTP/1.1 500 Internal Server Error"
+          },
+          "503": {
+            "code": 503,
+            "description": "Service is unavailable.",
+            "message": "HTTP/1.1 503 Service Unavailable"
           }
         },
         "summary": "/edge/playwright",
@@ -8703,6 +8902,11 @@
             "code": 500,
             "description": "An internal error occurred when handling the request.",
             "message": "HTTP/1.1 500 Internal Server Error"
+          },
+          "503": {
+            "code": 503,
+            "description": "Service is unavailable.",
+            "message": "HTTP/1.1 503 Service Unavailable"
           }
         },
         "summary": "/playwright/firefox",
@@ -8800,6 +9004,11 @@
             "code": 500,
             "description": "An internal error occurred when handling the request.",
             "message": "HTTP/1.1 500 Internal Server Error"
+          },
+          "503": {
+            "code": 503,
+            "description": "Service is unavailable.",
+            "message": "HTTP/1.1 503 Service Unavailable"
           }
         },
         "summary": "/playwright/webkit",