https://browserbee.github.io/docs/reference/Recent content in Reference on BrowserBeeHugo -- gohugo.ioen-us© 2026 BrowserBeehttps://browserbee.github.io/docs/reference/api-overview/Mon, 01 Jan 0001 00:00:00 +0000https://browserbee.github.io/docs/reference/api-overview/<h2 class="relative group">Base URLs <div id="base-urls" class="anchor"></div> <span class="absolute top-0 w-6 transition-opacity opacity-0 -start-6 not-prose group-hover:opacity-100 select-none"> <a class="text-primary-300 dark:text-neutral-700 !no-underline" href="#base-urls" aria-label="Anchor">#</a> </span> </h2> <table> <thead> <tr> <th>Environment</th> <th>Base URL</th> </tr> </thead> <tbody> <tr> <td>Production</td> <td><code>https://api.browserbee.com/api/v1</code></td> </tr> <tr> <td>Development</td> <td><code>https://api-dev.browserbee.com/api/v1</code></td> </tr> </tbody> </table> <h2 class="relative group">Resource groups <div id="resource-groups" class="anchor"></div> <span class="absolute top-0 w-6 transition-opacity opacity-0 -start-6 not-prose group-hover:opacity-100 select-none"> <a class="text-primary-300 dark:text-neutral-700 !no-underline" href="#resource-groups" aria-label="Anchor">#</a> </span> </h2> <h3 class="relative group">Health <div id="health" class="anchor"></div> <span class="absolute top-0 w-6 transition-opacity opacity-0 -start-6 not-prose group-hover:opacity-100 select-none"> <a class="text-primary-300 dark:text-neutral-700 !no-underline" href="#health" aria-label="Anchor">#</a> </span> </h3> <table> <thead> <tr> <th>Method</th> <th>Path</th> <th>Purpose</th> </tr> </thead> <tbody> <tr> <td><code>GET</code></td> <td><code>/up</code></td> <td>Liveness probe</td> </tr> <tr> <td><code>GET</code></td> <td><code>/ready</code></td> <td>Readiness probe</td> </tr> </tbody> </table> <h3 class="relative group">Browser profiles <div id="browser-profiles" class="anchor"></div> <span class="absolute top-0 w-6 transition-opacity opacity-0 -start-6 not-prose group-hover:opacity-100 select-none"> <a class="text-primary-300 dark:text-neutral-700 !no-underline" href="#browser-profiles" aria-label="Anchor">#</a> </span> </h3> <table> <thead> <tr> <th>Method</th> <th>Path</th> <th>Purpose</th> </tr> </thead> <tbody> <tr> <td><code>GET</code></td> <td><code>/browsers</code></td> <td>List browser profiles</td> </tr> <tr> <td><code>POST</code></td> <td><code>/browsers</code></td> <td>Create browser profile</td> </tr> <tr> <td><code>GET</code></td> <td><code>/browsers/{profile_key}</code></td> <td>Get browser profile</td> </tr> <tr> <td><code>PATCH</code></td> <td><code>/browsers/{profile_key}</code></td> <td>Update browser profile</td> </tr> <tr> <td><code>PUT</code></td> <td><code>/browsers/{profile_key}</code></td> <td>Replace browser profile</td> </tr> <tr> <td><code>DELETE</code></td> <td><code>/browsers/{profile_key}</code></td> <td>Delete browser profile</td> </tr> <tr> <td><code>POST</code></td> <td><code>/browsers/{profile_key}/activate</code></td> <td>Mark profile as available</td> </tr> <tr> <td><code>POST</code></td> <td><code>/browsers/{profile_key}/deprecate</code></td> <td>Mark profile as deprecated</td> </tr> </tbody> </table> <h3 class="relative group">Tokens <div id="tokens" class="anchor"></div> <span class="absolute top-0 w-6 transition-opacity opacity-0 -start-6 not-prose group-hover:opacity-100 select-none"> <a class="text-primary-300 dark:text-neutral-700 !no-underline" href="#tokens" aria-label="Anchor">#</a> </span> </h3> <table> <thead> <tr> <th>Method</th> <th>Path</th> <th>Purpose</th> </tr> </thead> <tbody> <tr> <td><code>GET</code></td> <td><code>/tokens</code></td> <td>List active API tokens</td> </tr> <tr> <td><code>POST</code></td> <td><code>/tokens</code></td> <td>Create API token with Basic auth</td> </tr> <tr> <td><code>DELETE</code></td> <td><code>/tokens/{id}</code></td> <td>Revoke API token</td> </tr> </tbody> </table> <h3 class="relative group">Webhooks <div id="webhooks" class="anchor"></div> <span class="absolute top-0 w-6 transition-opacity opacity-0 -start-6 not-prose group-hover:opacity-100 select-none"> <a class="text-primary-300 dark:text-neutral-700 !no-underline" href="#webhooks" aria-label="Anchor">#</a> </span> </h3> <table> <thead> <tr> <th>Method</th> <th>Path</th> <th>Purpose</th> </tr> </thead> <tbody> <tr> <td><code>GET</code></td> <td><code>/webhooks</code></td> <td>List registered webhooks</td> </tr> <tr> <td><code>POST</code></td> <td><code>/webhooks</code></td> <td>Register a webhook</td> </tr> <tr> <td><code>DELETE</code></td> <td><code>/webhooks/{id}</code></td> <td>Deactivate a webhook</td> </tr> </tbody> </table> <h2 class="relative group">Common response patterns <div id="common-response-patterns" class="anchor"></div> <span class="absolute top-0 w-6 transition-opacity opacity-0 -start-6 not-prose group-hover:opacity-100 select-none"> <a class="text-primary-300 dark:text-neutral-700 !no-underline" href="#common-response-patterns" aria-label="Anchor">#</a> </span> </h2> <table> <thead> <tr> <th>Status</th> <th>Meaning</th> </tr> </thead> <tbody> <tr> <td><code>200</code></td> <td>Successful read or state transition</td> </tr> <tr> <td><code>201</code></td> <td>Resource created</td> </tr> <tr> <td><code>204</code></td> <td>Resource removed or revoked without a body</td> </tr> <tr> <td><code>401</code></td> <td>Missing or invalid credentials</td> </tr> <tr> <td><code>404</code></td> <td>Resource was not found</td> </tr> <tr> <td><code>422</code></td> <td>Validation failed</td> </tr> </tbody> </table> <h2 class="relative group">Schemas worth knowing <div id="schemas-worth-knowing" class="anchor"></div> <span class="absolute top-0 w-6 transition-opacity opacity-0 -start-6 not-prose group-hover:opacity-100 select-none"> <a class="text-primary-300 dark:text-neutral-700 !no-underline" href="#schemas-worth-knowing" aria-label="Anchor">#</a> </span> </h2> <p>The most important BrowserBee response objects for customer integrations are:</p>