@browserless.io/browserless 2.24.0-beta-5 → 2.24.1

package/static/docs/swagger.min.json

@@ -280,14 +280,14 @@
                 "length": {
                   "type": "number"
                 },
-                "__@toStringTag@43326": {
+                "__@toStringTag@14591": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@43326",
+                "__@toStringTag@14591",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -322,13 +322,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@43326": {
+        "__@toStringTag@14591": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@43326",
+        "__@toStringTag@14591",
         "byteLength"
       ]
     },
@@ -338,18 +338,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@43364": {
+        "__@species@14629": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@43326": {
+        "__@toStringTag@14591": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@43364",
-        "__@toStringTag@43326",
+        "__@species@14629",
+        "__@toStringTag@14591",
         "byteLength"
       ]
     },
@@ -1001,7 +1001,7 @@
   },
   "info": {
     "title": "Browserless",
-    "version": "2.24.0-beta-5",
+    "version": "2.24.1",
     "x-logo": {
       "altText": "browserless logo",
       "url": "./docs/browserless-logo-inline.svg"
@@ -1051,6 +1051,14 @@
               "description": "The authorization token",
               "type": "string"
             }
+          },
+          {
+            "in": "query",
+            "name": "trackingId",
+            "schema": {
+              "description": "Custom session identifier",
+              "type": "string"
+            }
           }
         ],
         "requestBody": {
@@ -1337,6 +1345,14 @@
               "description": "The authorization token",
               "type": "string"
             }
+          },
+          {
+            "in": "query",
+            "name": "trackingId",
+            "schema": {
+              "description": "Custom session identifier",
+              "type": "string"
+            }
           }
         ],
         "requestBody": {
@@ -1445,6 +1461,14 @@
               "description": "The authorization token",
               "type": "string"
             }
+          },
+          {
+            "in": "query",
+            "name": "trackingId",
+            "schema": {
+              "description": "Custom session identifier",
+              "type": "string"
+            }
           }
         ],
         "requestBody": {
@@ -1907,6 +1931,14 @@
               "description": "The authorization token",
               "type": "string"
             }
+          },
+          {
+            "in": "query",
+            "name": "trackingId",
+            "schema": {
+              "description": "Custom session identifier",
+              "type": "string"
+            }
           }
         ],
         "requestBody": {
@@ -2195,6 +2227,14 @@
               "description": "The authorization token",
               "type": "string"
             }
+          },
+          {
+            "in": "query",
+            "name": "trackingId",
+            "schema": {
+              "description": "Custom session identifier",
+              "type": "string"
+            }
           }
         ],
         "requestBody": {
@@ -2318,6 +2358,14 @@
               "description": "The authorization token",
               "type": "string"
             }
+          },
+          {
+            "in": "query",
+            "name": "trackingId",
+            "schema": {
+              "description": "Custom session identifier",
+              "type": "string"
+            }
           }
         ],
         "requestBody": {
@@ -2941,6 +2989,14 @@
               "description": "The authorization token",
               "type": "string"
             }
+          },
+          {
+            "in": "query",
+            "name": "trackingId",
+            "schema": {
+              "description": "Custom session identifier",
+              "type": "string"
+            }
           }
         ],
         "requestBody": {
@@ -3243,6 +3299,14 @@
               "description": "The authorization token",
               "type": "string"
             }
+          },
+          {
+            "in": "query",
+            "name": "trackingId",
+            "schema": {
+              "description": "Custom session identifier",
+              "type": "string"
+            }
           }
         ],
         "requestBody": {
@@ -3332,6 +3396,14 @@
               "description": "The authorization token",
               "type": "string"
             }
+          },
+          {
+            "in": "query",
+            "name": "trackingId",
+            "schema": {
+              "description": "Custom session identifier",
+              "type": "string"
+            }
           }
         ],
         "requestBody": {
@@ -3421,6 +3493,14 @@
               "description": "The authorization token",
               "type": "string"
             }
+          },
+          {
+            "in": "query",
+            "name": "trackingId",
+            "schema": {
+              "description": "Custom session identifier",
+              "type": "string"
+            }
           }
         ],
         "requestBody": {
@@ -3510,6 +3590,14 @@
               "description": "The authorization token",
               "type": "string"
             }
+          },
+          {
+            "in": "query",
+            "name": "trackingId",
+            "schema": {
+              "description": "Custom session identifier",
+              "type": "string"
+            }
           }
         ],
         "requestBody": {
@@ -3598,6 +3686,14 @@
               "description": "The authorization token",
               "type": "string"
             }
+          },
+          {
+            "in": "query",
+            "name": "trackingId",
+            "schema": {
+              "description": "Custom session identifier",
+              "type": "string"
+            }
           }
         ],
         "requestBody": {
@@ -3884,6 +3980,14 @@
               "description": "The authorization token",
               "type": "string"
             }
+          },
+          {
+            "in": "query",
+            "name": "trackingId",
+            "schema": {
+              "description": "Custom session identifier",
+              "type": "string"
+            }
           }
         ],
         "requestBody": {
@@ -3992,6 +4096,14 @@
               "description": "The authorization token",
               "type": "string"
             }
+          },
+          {
+            "in": "query",
+            "name": "trackingId",
+            "schema": {
+              "description": "Custom session identifier",
+              "type": "string"
+            }
           }
         ],
         "requestBody": {
@@ -4100,6 +4212,14 @@
               "description": "The authorization token",
               "type": "string"
             }
+          },
+          {
+            "in": "query",
+            "name": "trackingId",
+            "schema": {
+              "description": "Custom session identifier",
+              "type": "string"
+            }
           }
         ],
         "requestBody": {
@@ -4388,6 +4508,14 @@
               "description": "The authorization token",
               "type": "string"
             }
+          },
+          {
+            "in": "query",
+            "name": "trackingId",
+            "schema": {
+              "description": "Custom session identifier",
+              "type": "string"
+            }
           }
         ],
         "requestBody": {
@@ -4511,6 +4639,14 @@
               "description": "The authorization token",
               "type": "string"
             }
+          },
+          {
+            "in": "query",
+            "name": "trackingId",
+            "schema": {
+              "description": "Custom session identifier",
+              "type": "string"
+            }
           }
         ],
         "requestBody": {
@@ -5134,6 +5270,14 @@
               "description": "The authorization token",
               "type": "string"
             }
+          },
+          {
+            "in": "query",
+            "name": "trackingId",
+            "schema": {
+              "description": "Custom session identifier",
+              "type": "string"
+            }
           }
         ],
         "requestBody": {
@@ -5436,6 +5580,14 @@
               "description": "The authorization token",
               "type": "string"
             }
+          },
+          {
+            "in": "query",
+            "name": "trackingId",
+            "schema": {
+              "description": "Custom session identifier",
+              "type": "string"
+            }
           }
         ],
         "requestBody": {
@@ -5525,6 +5677,14 @@
               "description": "The authorization token",
               "type": "string"
             }
+          },
+          {
+            "in": "query",
+            "name": "trackingId",
+            "schema": {
+              "description": "Custom session identifier",
+              "type": "string"
+            }
           }
         ],
         "requestBody": {
@@ -5678,6 +5838,14 @@
               "description": "The authorization token",
               "type": "string"
             }
+          },
+          {
+            "in": "query",
+            "name": "trackingId",
+            "schema": {
+              "description": "Custom session identifier",
+              "type": "string"
+            }
           }
         ],
         "requestBody": {
@@ -5929,6 +6097,116 @@
         ]
       }
     },
+    "/kill/+([0-9a-zA-Z-_])": {
+      "get": {
+        "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 Origin and may cause certain sites\nto not load properly.",
+              "type": "boolean"
+            }
+          },
+          {
+            "in": "query",
+            "name": "browserId",
+            "required": false,
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "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": [
+                {
+                  "$ref": "#/definitions/CDPLaunchOptions"
+                },
+                {
+                  "$ref": "#/definitions/BrowserServerOptions"
+                },
+                {
+                  "type": "string"
+                }
+              ]
+            }
+          },
+          {
+            "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": "trackingId",
+            "required": false,
+            "schema": {
+              "description": "Custom session identifier",
+              "type": "string"
+            }
+          }
+        ],
+        "requestBody": {
+          "content": {}
+        },
+        "responses": {
+          "400": {
+            "code": 400,
+            "description": "The request contains errors or didn't properly encode content.",
+            "message": "HTTP/1.1 400 Bad Request"
+          },
+          "401": {
+            "code": 401,
+            "description": "The request is missing, or contains bad, authorization credentials.",
+            "message": "HTTP/1.1 401 Unauthorized"
+          },
+          "404": {
+            "code": 404,
+            "description": "Resource couldn't be found.",
+            "message": "HTTP/1.1 404 Not Found"
+          },
+          "408": {
+            "code": 408,
+            "description": "The request took has taken too long to process.",
+            "message": "HTTP/1.1 408 Request Timeout"
+          },
+          "429": {
+            "code": 429,
+            "description": "Too many requests are currently being processed.",
+            "message": "HTTP/1.1 429 Too Many Requests"
+          },
+          "500": {
+            "code": 500,
+            "description": "An internal error occurred when handling the request.",
+            "message": "HTTP/1.1 500 Internal Server Error"
+          }
+        },
+        "summary": "/kill/+([0-9a-zA-Z-_])",
+        "tags": [
+          "Management REST APIs"
+        ]
+      }
+    },
     "/meta": {
       "get": {
         "definitions": {},
@@ -6229,6 +6507,7 @@
             "name": "trackingId",
             "required": false,
             "schema": {
+              "description": "Custom session identifier",
               "type": "string"
             }
           }
@@ -6363,6 +6642,14 @@
               "description": "The authorization token",
               "type": "string"
             }
+          },
+          {
+            "in": "query",
+            "name": "trackingId",
+            "schema": {
+              "description": "Custom session identifier",
+              "type": "string"
+            }
           }
         ],
         "requestBody": {