Base URLs
#| Environment | Base URL |
|---|
| Production | https://api.browserbee.com/api/v1 |
| Development | https://api-dev.browserbee.com/api/v1 |
Resource groups
#Health
#| Method | Path | Purpose |
|---|
GET | /up | Liveness probe |
GET | /ready | Readiness probe |
Browser profiles
#| Method | Path | Purpose |
|---|
GET | /browsers | List browser profiles |
POST | /browsers | Create browser profile |
GET | /browsers/{profile_key} | Get browser profile |
PATCH | /browsers/{profile_key} | Update browser profile |
PUT | /browsers/{profile_key} | Replace browser profile |
DELETE | /browsers/{profile_key} | Delete browser profile |
POST | /browsers/{profile_key}/activate | Mark profile as available |
POST | /browsers/{profile_key}/deprecate | Mark profile as deprecated |
Tokens
#| Method | Path | Purpose |
|---|
GET | /tokens | List active API tokens |
POST | /tokens | Create API token with Basic auth |
DELETE | /tokens/{id} | Revoke API token |
Webhooks
#| Method | Path | Purpose |
|---|
GET | /webhooks | List registered webhooks |
POST | /webhooks | Register a webhook |
DELETE | /webhooks/{id} | Deactivate a webhook |
Common response patterns
#| Status | Meaning |
|---|
200 | Successful read or state transition |
201 | Resource created |
204 | Resource removed or revoked without a body |
401 | Missing or invalid credentials |
404 | Resource was not found |
422 | Validation failed |
Schemas worth knowing
#The most important BrowserBee response objects for customer integrations are:
BrowserProfileBrowserListResponseApiTokenSummaryApiTokenCreatedResponseWebhookSummaryWebhookCreatedResponse
If your team generates client bindings from OpenAPI, use the BrowserBee schemas as the source of truth and keep generated code pinned to the API version your environment expects.