API Reference
Complete REST API documentation
API Reference
The ACT API is a RESTful API that provides programmatic access to all ACT functionality.
Base URL
https://api.actplatform.dev/api/v1
For self-hosted installations, replace with your server’s URL.
Authentication
All API requests require authentication via Bearer token:
curl -H "Authorization: Bearer YOUR_API_TOKEN" \
https://api.actplatform.dev/api/v1/servers
Endpoints
Servers
| Method | Endpoint | Description |
|---|---|---|
GET | /servers | List all servers |
POST | /servers | Create a server |
GET | /servers/:id | Get server details |
PUT | /servers/:id | Update a server |
DELETE | /servers/:id | Delete a server |
POST | /servers/:id/commission | Commission a server |
GET | /servers/:id/status | Get server status |
Resources
| Method | Endpoint | Description |
|---|---|---|
GET | /resources | List all resources |
POST | /resources | Create a resource |
GET | /resources/:id | Get resource details |
PUT | /resources/:id | Update a resource |
DELETE | /resources/:id | Delete a resource |
POST | /resources/:id/deploy | Deploy a resource |
GET | /resources/:id/logs | Stream resource logs (WebSocket) |
Environments
| Method | Endpoint | Description |
|---|---|---|
GET | /environments | List all environments |
POST | /environments | Create an environment |
GET | /environments/:id | Get environment details |
PUT | /environments/:id | Update an environment |
DELETE | /environments/:id | Delete an environment |
Storage Providers
| Method | Endpoint | Description |
|---|---|---|
GET | /storage | List storage providers |
POST | /storage | Create a storage provider |
GET | /storage/:id | Get storage provider details |
DELETE | /storage/:id | Delete a storage provider |
GET | /storage/:id/browse | Browse storage contents |
WebSocket Endpoints
Terminal
ws://api.actplatform.dev/api/v1/terminal?server=<server_id>
Opens an interactive SSH terminal session to the specified server.
Logs
ws://api.actplatform.dev/api/v1/resources/:id/logs
Streams real-time logs from a running resource.
Error Responses
All errors return a JSON object with an error field:
{
"error": "Server not found"
}
Common HTTP status codes:
| Code | Description |
|---|---|
400 | Bad Request - Invalid input |
401 | Unauthorized - Invalid or missing token |
404 | Not Found - Resource doesn’t exist |
500 | Internal Server Error |
No content in this section yet.