Portabase DashboardAPI
API Introduction
Get started with the Portabase REST API for database and agent management.
The Portabase dashboard exposes a REST API for programmatic management of databases and agents. Swagger UI and the OpenAPI specification are also available.
Enable the API
Set the following environment variables in your dashboard configuration:
API_ENABLED=true
OPENAPI_ENABLED=trueAPI_ENABLED=true: enables all API routes under/api/v1.OPENAPI_ENABLED=true: enables the OpenAPI specification and Swagger UI. The API must also be enabled for this to work.
API Documentation
Once enabled:
| Resource | URL |
|---|---|
| Swagger UI | /api/v1/docs |
| OpenAPI specification | /api/v1/openapi |
Authentication
To create an API token:
- Go to your Profile in the dashboard.
- Open the Account tab.
- In the API Token section, generate a new token.
Tokens are user-level, all API actions inherit the permissions of the associated user.
Use the x-api-key header to authenticate your requests:
GET /api/v1/databases
x-api-key: <your-token>API coverage is being extended. Check the roadmap for upcoming endpoints.
Last updated on