API Reference

Based Page provides an HTTP API for creating and managing deployments.

Base URL

https://api.based.page

Authentication

Most endpoints require a valid API key in the Authorization header:

Authorization: Bearer bp_xxxxx

See Authentication for details on obtaining and managing API keys.

Content Type

Requests and responses use JSON (application/json).

Endpoints

Deployments

Method	Path	Description
POST	/deploy	Create a new deployment
GET	/deploy/:id	Get deployment status
PUT	/deploy/:id	Update deployment content
DELETE	/deploy/:id	Delete a deployment
GET	/deploys	List all deployments

Error Handling

All error responses return a JSON object with an error field. See Errors & Rate Limits for status codes, rate limits, and examples.