Endpoint Reference
Every customer-facing endpoint in the SMLL API, with the role each one requires.
The complete list of endpoints available to workspace members. Administrative endpoints used by SMLL staff are not listed.
Two prefixes are elided below for readability:
| Shown as | Full prefix |
|---|
{W} | /api/v1/workspaces/{workspaceID} |
{V} | /api/v1/workspaces/{workspaceID}/vpcs/{vpcID} |
Role is the minimum needed to call the endpoint:
- Member - any role in the workspace, including Viewer.
- Admin - Owner or Admin only. Everyone else gets
403.
- - - no workspace role applies, because the endpoint is either public or scoped to you rather than to a workspace.
/health, /api/v1/cli/version, /cli/download/... and the /api/v1/status endpoints need no token at all. /otlp/v1/* authenticates with a log stream token rather than a user token. Everything else here needs a valid token but no particular workspace role.
| Method | Path | Role |
|---|
GET | /api/v1/auth/cli/sessions | - |
POST | /api/v1/auth/cli/sessions | - |
DELETE | /api/v1/auth/cli/sessions/{sessionID} | - |
GET | /api/v1/cli/version | - |
GET | /api/v1/me | - |
POST | /api/v1/me/cancel-deletion | - |
POST | /api/v1/me/delete | - |
GET | /api/v1/me/deletion-status | - |
POST | /api/v1/me/export | - |
GET | /api/v1/pricing | - |
POST | /api/v1/pricing/estimate | - |
GET | /api/v1/status | - |
GET | /api/v1/status/incidents | - |
GET | /api/v1/status/incidents/{incidentID} | - |
GET | /api/v1/workspaces | - |
GET | /cli/download/{os}/{arch}/smll | - |
GET | /health | - |
POST | /otlp/v1/logs | - |
POST | /otlp/v1/metrics | - |
POST | /webhooks/stripe | - |
| Method | Path | Role |
|---|
GET | {V}/services | Member |
POST | {V}/services | Admin |
GET | {V}/services/{serviceID} | Member |
PATCH | {V}/services/{serviceID} | Admin |
DELETE | {V}/services/{serviceID} | Admin |
GET | {V}/services/{serviceID}/backups | Member |
POST | {V}/services/{serviceID}/backups | Admin |
POST | {V}/services/{serviceID}/backups/restore | Admin |
PUT | {V}/services/{serviceID}/backups/schedule | Admin |
DELETE | {V}/services/{serviceID}/backups/schedule | Admin |
GET | {V}/services/{serviceID}/builds | Member |
POST | {V}/services/{serviceID}/builds/git | Admin |
POST | {V}/services/{serviceID}/builds/source-upload | Admin |
GET | {V}/services/{serviceID}/builds/{buildID} | Member |
POST | {V}/services/{serviceID}/builds/{buildID}/cancel | Admin |
GET | {V}/services/{serviceID}/builds/{buildID}/logs | Member |
POST | {V}/services/{serviceID}/deploy | Admin |
GET | {V}/services/{serviceID}/deployments | Member |
GET | {V}/services/{serviceID}/domains | Member |
POST | {V}/services/{serviceID}/domains | Admin |
DELETE | {V}/services/{serviceID}/domains/{domainID} | Admin |
POST | {V}/services/{serviceID}/domains/{domainID}/verify | Admin |
GET | {V}/services/{serviceID}/env | Member |
PUT | {V}/services/{serviceID}/env | Admin |
DELETE | {V}/services/{serviceID}/env/{envVarID} | Admin |
GET | {V}/services/{serviceID}/exec | - |
GET | {V}/services/{serviceID}/logs | Member |
GET | {V}/services/{serviceID}/logs/history | Member |
POST | {V}/services/{serviceID}/restart | Admin |
POST | {V}/services/{serviceID}/rollback | Admin |
GET | {V}/services/{serviceID}/uptime | Member |
POST | {V}/services/{serviceID}/uptime | Admin |
DELETE | {V}/services/{serviceID}/uptime | Admin |
| Method | Path | Role |
|---|
GET | {V}/backups | Member |
PATCH | {V}/backups/databases/{databaseID}/schedule | Admin |
GET | {V}/databases | Member |
POST | {V}/databases | Admin |
GET | {V}/databases/{databaseID} | Member |
PATCH | {V}/databases/{databaseID} | Admin |
DELETE | {V}/databases/{databaseID} | Admin |
GET | {V}/databases/{databaseID}/backups | Member |
POST | {V}/databases/{databaseID}/backups | Admin |
POST | {V}/databases/{databaseID}/backups/restore | Admin |
PATCH | {V}/databases/{databaseID}/backups/schedule | Admin |
DELETE | {V}/databases/{databaseID}/backups/{backupName} | Admin |
GET | {V}/databases/{databaseID}/connection | Member |
POST | {V}/databases/{databaseID}/fork | Admin |
POST | {V}/databases/{databaseID}/query | Admin |
PATCH | {V}/databases/{databaseID}/replicas | Admin |
GET | {V}/databases/{databaseID}/schema | Admin |
GET | {V}/databases/{databaseID}/slow-queries | Member |
POST | {V}/databases/{databaseID}/slow-queries/reset | Admin |
| Method | Path | Role |
|---|
GET | {V}/caches | Member |
POST | {V}/caches | Admin |
GET | {V}/caches/{cacheID} | Member |
PATCH | {V}/caches/{cacheID} | Admin |
DELETE | {V}/caches/{cacheID} | Admin |
GET | {V}/caches/{cacheID}/connection | Member |
GET | {V}/caches/{cacheID}/ip-allowlist | Member |
POST | {V}/caches/{cacheID}/ip-allowlist | Admin |
DELETE | {V}/caches/{cacheID}/ip-allowlist/{ruleID} | Admin |
| Method | Path | Role |
|---|
GET | {V}/queues | Member |
POST | {V}/queues | Admin |
GET | {V}/queues/{queueID} | Member |
PATCH | {V}/queues/{queueID} | Admin |
DELETE | {V}/queues/{queueID} | Admin |
GET | {V}/queues/{queueID}/connection | Member |
| Method | Path | Role |
|---|
GET | {V}/buckets | Member |
POST | {V}/buckets | Admin |
GET | {V}/buckets/{bucketID} | Member |
PATCH | {V}/buckets/{bucketID} | Admin |
DELETE | {V}/buckets/{bucketID} | Admin |
POST | {V}/buckets/{bucketID}/copy | Admin |
GET | {V}/buckets/{bucketID}/credentials | Member |
POST | {V}/buckets/{bucketID}/credentials | Admin |
GET | {V}/buckets/{bucketID}/domains | Member |
POST | {V}/buckets/{bucketID}/domains | Admin |
DELETE | {V}/buckets/{bucketID}/domains/{domainID} | Admin |
POST | {V}/buckets/{bucketID}/domains/{domainID}/verify | Admin |
POST | {V}/buckets/{bucketID}/folders | Admin |
GET | {V}/buckets/{bucketID}/objects | Member |
DELETE | {V}/buckets/{bucketID}/objects/{key:.+} | Admin |
POST | {V}/buckets/{bucketID}/presign | Admin |
GET | {V}/s3-credentials | Admin |
POST | {V}/s3-credentials | Admin |
| Method | Path | Role |
|---|
GET | {V}/secrets | Member |
POST | {V}/secrets | Admin |
GET | {V}/secrets/{secretID} | Member |
DELETE | {V}/secrets/{secretID} | Admin |
| Method | Path | Role |
|---|
GET | {V}/registry | Member |
GET | {V}/registry/credentials | Member |
GET | {V}/registry/repositories | Member |
DELETE | {V}/registry/repositories/{repoName} | Admin |
GET | {V}/registry/repositories/{repoName}/artifacts | Member |
DELETE | {V}/registry/repositories/{repoName}/artifacts/{reference} | Admin |
GET | {V}/registry/repositories/{repoName}/artifacts/{reference}/vulnerabilities | Member |
| Method | Path | Role |
|---|
GET | {V}/log-streams | Member |
POST | {V}/log-streams | Admin |
GET | {V}/log-streams/{streamID} | Admin |
DELETE | {V}/log-streams/{streamID} | Admin |
POST | {V}/log-streams/{streamID}/rotate | Admin |
GET | {V}/logs/alerts | Member |
POST | {V}/logs/alerts | Admin |
PATCH | {V}/logs/alerts/{ruleID} | Admin |
DELETE | {V}/logs/alerts/{ruleID} | Admin |
GET | {V}/logs/search | Member |
GET | {V}/logs/searches | Member |
POST | {V}/logs/searches | Member |
DELETE | {V}/logs/searches/{searchID} | Member |
GET | {V}/logs/stream | Member |
GET | {V}/metrics/* | Member |
GET | {V}/metrics/overview | Member |
GET | {V}/metrics/query | Member |
GET | {V}/metrics/query_range | Member |
GET | {V}/metrics/series | Member |
| Method | Path | Role |
|---|
GET | {W}/vpcs | Member |
POST | {W}/vpcs | Admin |
GET | {V} | Member |
PATCH | {V} | Admin |
DELETE | {V} | Admin |
POST | {V}/deploy-template | Member |
| Method | Path | Role |
|---|
GET | {W}/billing/alerts | Member |
POST | {W}/billing/alerts | Admin |
DELETE | {W}/billing/alerts/{alertID} | Admin |
GET | {W}/billing/balance | Member |
GET | {W}/billing/config | Member |
PUT | {W}/billing/config | Admin |
GET | {W}/billing/details | Member |
PUT | {W}/billing/details | Admin |
GET | {W}/billing/estimate | Member |
GET | {W}/billing/invoices | Member |
GET | {W}/billing/invoices/{period}/pdf | Admin |
GET | {W}/billing/projection | Member |
POST | {W}/billing/topup | Admin |
GET | {W}/billing/usage | Member |
GET | {W}/billing/usage/daily | Member |
GET | {W}/billing/usage/resources | Member |
GET | {W}/quotas | Member |
GET | {W}/quotas/requests | Member |
POST | {W}/quotas/requests | Admin |
| Method | Path | Role |
|---|
GET | {W}/alerting/alerts | Member |
POST | {W}/alerting/alerts | Admin |
GET | {W}/alerting/alerts/history | Member |
PATCH | {W}/alerting/alerts/{alertID} | Admin |
DELETE | {W}/alerting/alerts/{alertID} | Admin |
GET | {W}/webhooks | Member |
POST | {W}/webhooks | Admin |
PATCH | {W}/webhooks/{webhookID} | Admin |
DELETE | {W}/webhooks/{webhookID} | Admin |
POST | {W}/webhooks/{webhookID}/test | Admin |
| Method | Path | Role |
|---|
GET | {W}/api-keys | Admin |
POST | {W}/api-keys | Admin |
DELETE | {W}/api-keys/{keyID} | Admin |
GET | {W}/audit-logs | Member |
GET | {W}/audit-logs/export | Member |
| Method | Path | Role |
|---|
GET | {W} | Member |
GET | {W}/activity | Member |
GET | {W}/activity/summary | Member |
GET | {W}/buckets | Member |
GET | {W}/databases | Member |
GET | {W}/insights | Member |
GET | {W}/services | Member |
GET | {W}/summary | Member |
GET | {W}/support/tickets | Member |
POST | {W}/support/tickets | Member |
GET | {W}/support/tickets/{ticketID} | Member |
POST | {W}/support/tickets/{ticketID}/messages | Member |
187 endpoints.