Documentation
Overview
Developer Platform is a read-oriented HTTP API. All responses are JSON encoded in UTF-8.
Quick start
Every resource is reachable under https://api.badgerproxy.com/api/v1. No SDK is required.
Authentication
Requests carry a project key in the Authorization header. Keys are scoped per environment and may be rotated without downtime.
Errors
Errors return a JSON object with an error.code and error.message. The HTTP status carries the same meaning as the code.
Rate limits
Limits are applied per key. Exceeding a limit returns 429 with a Retry-After header.
Endpoints
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/v1 | Version index and resource map. |
| GET | /api/v1/environments | Environments available for deployment. |
| GET | /api/v1/regions | Regions in which services may be scheduled. |
| GET | /api/v1/limits | Platform quotas and request limits. |
| GET | /api/v1/status | Machine-readable service status. |