API Endpoints Reference
All endpoints of the SailOps Public API, organized by resource category.
Base URL: https://app.sailops.io/api/public/api/v1
All requests except plans and pricing require the X-Api-Key header. See the Public API Overview for authentication details.
Health
| Method | Path | Description | Auth |
|---|---|---|---|
GET | /status | Check API health — returns 204 No Content when healthy | No |
Containers
Manage the full lifecycle of Docker containers running in your project.
| Method | Path | Description |
|---|---|---|
GET | /api/v1/containers | List all containers in the project |
POST | /api/v1/containers | Create a new container |
GET | /api/v1/containers/{container} | Get container details |
PUT | /api/v1/containers/{container} | Replace entire container spec (image, resources, compute class) |
PATCH | /api/v1/containers/{container} | (Deprecated) Partially update a container — use PATCH /api/v2/containers/{container} instead |
PATCH | /api/v2/containers/{container} | Partially update container spec and configuration in one atomic rollout |
DELETE | /api/v1/containers/{container} | Delete a container and its resources |
GET | /api/v1/containers/{container}/config | Get environment variables and mounted files |
PUT | /api/v1/containers/{container}/config | (Deprecated) Update environment variables and mounted files. Running instances keep their current configuration until the container is restarted, started or redeployed; PATCH /api/v2 applies it immediately |
POST | /api/v1/containers/{container}/start | Start a stopped container |
POST | /api/v1/containers/{container}/stop | Stop a running container |
POST | /api/v1/containers/{container}/restart | Restart all instances of a container. Applies any configuration saved with PUT /config since the last rollout |
GET | /api/v1/containers/{container}/logs | Get container logs with filtering and pagination |
Path parameters: {container} is the container name (e.g., my-api).
GET /api/v1/containers/{container} returns status diagnostics alongside the container spec:
| Field | Type | Description |
|---|---|---|
statusMessage | string (optional) | Why the container is in its current status |
diagnostic | object (optional) | The most relevant problem observed on the container's instances |
The diagnostic object, when present, contains:
| Field | Type | Description |
|---|---|---|
reason | string | Machine-readable cause (e.g. CrashLoopBackOff, OOMKilled, ImagePullBackOff) |
summary | string | Short human-readable description |
detail | string | Sanitized evidence reported by the runtime |
suggestions | string[] | Actionable hints to resolve the problem |
active | boolean | Whether the problem currently blocks an instance |
observedAt | date-time | When the problem was last observed |
exitCode | integer (optional) | Process exit code, when applicable |
GET /api/v1/containers/{container}/logs accepts the following optional query parameters:
| Parameter | Type | Description |
|---|---|---|
lines | integer (≤ 1000, default 100) | Number of log lines to return |
offset | integer (default 0) | Number of lines to skip — use with total for pagination |
instanceName | string | Filter to a specific pod instance (see instances in the response) |
query | string | Free-text search on the log message |
start / end | ISO 8601 date-time | Time range (e.g. 2024-02-03T15:00:00Z); apply both together |
stream | stdout | stderr | Filter by output stream |
init | boolean (default false) | Return init-container logs instead of the main container |
The response contains items (the log entries, each with timestamp, message, instance, containerImage), instances (distinct pod instances in the matched logs), and total (total lines matching the filter, independent of pagination). Time ranges are capped to your plan's log-retention window.
Containers support sharedVolumeMounts in the create (POST) and update (PUT/PATCH) request body. This field is an array of { volumeName, mountPath, readOnly } objects that reference existing shared volumes in the project. See Volumes for shared volume management.
PATCH /api/v1/containers/{container} and PUT /api/v1/containers/{container}/config are deprecated. Use PATCH /api/v2/containers/{container} instead — it updates the container spec and replaces the configuration in one atomic deployment rollout.
Spec fields merge individually (omitted fields stay unchanged). Inside config, each list is patched on its own: a list you omit is left untouched, a list you send replaces that list entirely, and an empty list purges it. Omission still deletes within a list you send.
| Body | Environment | Files |
|---|---|---|
config omitted | unchanged | unchanged |
"config": {} | unchanged | unchanged |
"config": {"environment": [...]} | replaced | unchanged |
"config": {"files": [...]} | unchanged | replaced |
"config": {"files": []} | unchanged | purged |
"config": {"environment": [], "files": []} | purged | purged |
An unknown key inside config is rejected with 400 REQUEST_VALIDATION rather than ignored, so a misspelled list name fails loudly instead of patching nothing.
Secret values are never returned by GET, so send a secret entry without a value to keep the stored one.
Mounted file names must be lowercase RFC 1123 labels (^[a-z0-9]([-a-z0-9]*[a-z0-9])?$), at most 56 characters, and unique within the container. See Container Configuration — File name rules.
curl -X PATCH \
-H "X-Api-Key: $SAILOPS_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"image": "myorg/api:v2.1.0",
"config": {
"environment": [{"name": "LOG_LEVEL", "value": "info"}],
"files": []
}
}' \
https://app.sailops.io/api/public/api/v2/containers/my-api
The v2 endpoint also supports initContainers (up to 10, replacing the deprecated initImage/initCommand fields) and spotFallbackEnabled (controls automatic Spot to Eco fallback).
initContainers follows the same absent/present/empty list rule as the lists inside config: omitting the field leaves the stored init containers untouched, sending a list replaces them all, and sending the empty list [] purges them.
PUT /api/v1/containers/{container} still applies the entire container spec — any optional field not included in the request body will be removed. Use GET-then-PUT if you need full spec replacement while preserving existing settings.
Websites
Host static HTML or PHP websites with managed storage and automatic HTTPS.
| Method | Path | Description |
|---|---|---|
GET | /api/v1/websites | List all websites in the project |
POST | /api/v1/websites | Create a new static or PHP website |
GET | /api/v1/websites/{websiteName} | Get website details |
PATCH | /api/v1/websites/{websiteName} | Partially update website settings (plan, domain, pathPrefix, Git Sync, etc.) |
DELETE | /api/v1/websites/{websiteName} | Delete a website and all its resources |
POST | /api/v1/websites/{websiteName}/start | Start a stopped website |
POST | /api/v1/websites/{websiteName}/stop | Stop a running website (scale to 0 replicas) |
PUT | /api/v1/websites/{websiteName}/domain | Set a custom domain (with gateway name and optional path prefix) |
DELETE | /api/v1/websites/{websiteName}/domain | Remove the custom domain |
GET | /api/v1/websites/{websiteName}/files | List files and directories (query param: path) |
DELETE | /api/v1/websites/{websiteName}/files | Delete a file (query param: path) |
POST | /api/v1/websites/{websiteName}/files/directories | Create a directory (JSON body: path) |
GET | /api/v1/websites/{websiteName}/files/stats | Get storage usage statistics |
POST | /api/v1/websites/{websiteName}/files/upload-url | Get a presigned upload URL (JSON body: path, optional contentType) |
GET | /api/v1/websites/{websiteName}/files/download-url | Get a presigned download URL (query param: path) |
POST | /api/v1/websites/{websiteName}/files/deploy | Deploy a ZIP archive to the website root |
Path parameters: {websiteName} is the website name (e.g., my-site).
Gateways
Manage load balancers and the domains (listeners) attached to them.
| Method | Path | Description |
|---|---|---|
GET | /api/v1/gateways | List all gateways in the project |
POST | /api/v1/gateways | Create a new gateway |
GET | /api/v1/gateways/{gateway} | Get gateway details |
DELETE | /api/v1/gateways/{gateway} | Delete a gateway and all its routes |
GET | /api/v1/gateways/{gateway}/domains | List all domains attached to a gateway |
POST | /api/v1/gateways/{gateway}/domains | Add a domain (listener) to a gateway |
DELETE | /api/v1/gateways/{gateway}/domains/{hostname} | Remove a domain from a gateway |
Path parameters: {gateway} is the gateway name; {hostname} is the domain to remove.
Routes
HTTP, TCP, gRPC, and TLS routes are nested under a gateway.
| Method | Path | Description |
|---|---|---|
GET | /api/v1/gateways/{gateway}/routes | List all routes for a gateway |
POST | /api/v1/gateways/{gateway}/routes | Create a route (HTTPRoute, TCPRoute, GRPCRoute, TLSRoute) |
GET | /api/v1/gateways/{gateway}/routes/{route} | Get route details |
PUT | /api/v1/gateways/{gateway}/routes/{route} | Update an existing route |
DELETE | /api/v1/gateways/{gateway}/routes/{route} | Delete a route |
Path parameters: {gateway} is the gateway name; {route} is the route name.
Services — PostgreSQL
| Method | Path | Description |
|---|---|---|
GET | /api/v1/services/postgresql | List all PostgreSQL services |
POST | /api/v1/services/postgresql | Create a PostgreSQL service (versions: 16, 17) |
GET | /api/v1/services/postgresql/{service} | Get PostgreSQL service details |
PUT | /api/v1/services/postgresql/{service} | Update flavor, compute class, storage, connection pooling, or I/O timing config |
DELETE | /api/v1/services/postgresql/{service} | Delete a PostgreSQL service |
The POST (create) request requires a databases array with at least one database name (e.g., ["app"]). The request will be rejected if databases is missing or empty.
PostgreSQL service responses include two read-only fields for lifecycle awareness:
| Field | Type | Description |
|---|---|---|
lifecyclePending | boolean (required) | true while a durable CREATE, RESTORE, or DELETE lifecycle task still fences mutations. A Ready status alone does not guarantee mutation readiness — wait for this field to become false. |
statusMessage | string (optional) | Operator detail about the current lifecycle state, including background provisioning or retry information. |
PostgreSQL services support optional managed PgBouncer connection pooling. Include the connectionPooling object in the create or update request body:
| Field | Type | Default | Description |
|---|---|---|---|
enabled | boolean | false | Enable or disable PgBouncer |
mode | session | transaction | session | Pooling mode |
instances | integer (1–5) | 1 | Number of PgBouncer instances |
maxClientConnections | integer (1–10 000) | 500 | Maximum client connections |
defaultPoolSize | integer (1–1 000) | 20 | Default pool size per database/user pair |
reservePoolSize | integer (0–1 000) | 5 | Reserve pool size |
When enabled, the service response includes a pooledConnectionInfo object with host, port, and database for the pooled endpoint.
The storageClass field (standard or performance) is fixed at creation. A PUT that changes the storage class is rejected. Storage size can only be increased, never reduced.
A PostgreSQL instance holds a maximum of 10 logical databases (including the initial one created with the instance). Creating an additional database beyond this limit is rejected with 409 Conflict.
Services — PostgreSQL Backups
| Method | Path | Description |
|---|---|---|
GET | /api/v1/services/postgresql/{service}/backups | List PostgreSQL backups (query: limit, offset) |
POST | /api/v1/services/postgresql/{service}/backups | Create an on-demand PostgreSQL backup |
GET | /api/v1/services/postgresql/{service}/backups/{backupId} | Get PostgreSQL backup details |
GET | /api/v1/services/postgresql/{service}/backups/{backupId}/download | Get a presigned download URL for a PostgreSQL backup |
Path parameters: {service} is the service name; {backupId} is the backup identifier.
Services — MariaDB
| Method | Path | Description |
|---|---|---|
GET | /api/v1/services/mariadb | List all MariaDB services |
POST | /api/v1/services/mariadb | Create a MariaDB service (version: 11.4) |
GET | /api/v1/services/mariadb/{service} | Get MariaDB service details |
PUT | /api/v1/services/mariadb/{service} | Update flavor, compute class, or storage |
DELETE | /api/v1/services/mariadb/{service} | Delete a MariaDB service |
The POST (create) request requires a databases array with at least one database name (e.g., ["app"]). The request will be rejected if databases is missing or empty.
MariaDB service responses include two read-only fields for lifecycle awareness:
| Field | Type | Description |
|---|---|---|
lifecyclePending | boolean (required) | true while a durable CREATE or DELETE lifecycle task still fences mutations. A Running status alone does not guarantee mutation readiness — wait for this field to become false. |
statusMessage | string (optional) | Operator detail about the current lifecycle state, including background provisioning or retry information. |
While a CREATE lifecycle task is active, the databases array also includes requested logical database names whose operator children are not yet visible.
Services — MariaDB Backups
| Method | Path | Description |
|---|---|---|
GET | /api/v1/services/mariadb/{service}/backups | List MariaDB backups (query: limit, offset) |
POST | /api/v1/services/mariadb/{service}/backups | Create an on-demand MariaDB backup |
GET | /api/v1/services/mariadb/{service}/backups/{backupId} | Get MariaDB backup details |
GET | /api/v1/services/mariadb/{service}/backups/{backupId}/download | Get a presigned download URL for a MariaDB backup |
Path parameters: {service} is the service name; {backupId} is the backup identifier.
Services — Valkey
| Method | Path | Description |
|---|---|---|
GET | /api/v1/services/valkey | List all Valkey (Redis-compatible) services |
POST | /api/v1/services/valkey | Create a Valkey service (version: 9, 1–6 replicas) |
GET | /api/v1/services/valkey/{service} | Get Valkey service details |
PUT | /api/v1/services/valkey/{service} | Update flavor, compute class, persistence, or storage size |
DELETE | /api/v1/services/valkey/{service} | Delete a Valkey service |
The replica count (number of cluster nodes) is fixed at creation. A PUT that changes the replicas field is rejected with 409 Conflict. Storage can only be grown, never reduced — a shrink request is rejected with 400.
Services — NATS
| Method | Path | Description |
|---|---|---|
GET | /api/v1/services/nats | List all NATS services |
POST | /api/v1/services/nats | Create a NATS service (versions: 2.10, 2.11, 2.12; 1–7 replicas) |
GET | /api/v1/services/nats/{service} | Get NATS service details |
PUT | /api/v1/services/nats/{service} | Update flavor, compute class, or replica count |
DELETE | /api/v1/services/nats/{service} | Delete a NATS service |
Path parameters for all service endpoints: {service} is the service name.
Services — Kafka
Manage Apache Kafka clusters for durable event streaming. See the Kafka guide for architecture and operational details.
| Method | Path | Description |
|---|---|---|
GET | /api/v1/services/kafka | List all Kafka clusters |
POST | /api/v1/services/kafka | Create a Kafka cluster (1 or 3 nodes, KRaft mode) |
GET | /api/v1/services/kafka/{clusterName} | Get cluster details |
PUT | /api/v1/services/kafka/{clusterName} | Update flavor, compute class, or storage |
DELETE | /api/v1/services/kafka/{clusterName} | Delete a cluster |
GET | /api/v1/services/kafka/{clusterName}/topics | List topics |
POST | /api/v1/services/kafka/{clusterName}/topics | Create a topic |
PUT | /api/v1/services/kafka/{clusterName}/topics/{topicName} | Update a topic (partitions can only grow) |
DELETE | /api/v1/services/kafka/{clusterName}/topics/{topicName} | Delete a topic |
GET | /api/v1/services/kafka/{clusterName}/users | List SCRAM users |
POST | /api/v1/services/kafka/{clusterName}/users | Create a SCRAM user (password returned once) |
PUT | /api/v1/services/kafka/{clusterName}/users/{userName} | Update a user's access level |
DELETE | /api/v1/services/kafka/{clusterName}/users/{userName} | Delete a user |
POST | /api/v1/services/kafka/{clusterName}/users/{userName}/regenerate-password | Regenerate a user's password |
GET | /api/v1/services/kafka/flavors | List available flavors per compute class |
GET | /api/v1/services/kafka/versions | List supported Kafka versions |
Path parameters: {clusterName} is the cluster name; {topicName} is the topic name; {userName} is the user name.
The number of nodes (1 or 3) is fixed at creation. Storage can only be grown; the storage class is fixed at creation. Trial organizations cannot provision Kafka.
The simplest way to connect a container or job is through a connection. Select Apache Kafka as the target and choose an access level. The connection injects KAFKA_BOOTSTRAP_SERVERS, KAFKA_SECURITY_PROTOCOL, KAFKA_SASL_MECHANISM, KAFKA_USERNAME and KAFKA_PASSWORD.
Services — OpenSearch
Manage OpenSearch clusters for full-text search and analytics. See the OpenSearch guide for architecture and operational details.
| Method | Path | Description |
|---|---|---|
GET | /api/v1/services/opensearch | List all OpenSearch clusters |
POST | /api/v1/services/opensearch | Create an OpenSearch cluster (version: 3.8.0; fixed 3 nodes) |
GET | /api/v1/services/opensearch/{clusterName} | Get cluster details |
PUT | /api/v1/services/opensearch/{clusterName} | Update flavor, compute class, storage, or backup policy |
DELETE | /api/v1/services/opensearch/{clusterName} | Delete a cluster |
GET | /api/v1/services/opensearch/{clusterName}/public-access | Get public access settings |
PUT | /api/v1/services/opensearch/{clusterName}/public-access | Update public access settings (enable/disable, allowed IPs) |
GET | /api/v1/services/opensearch/{clusterName}/dashboards | Get Dashboards settings |
PUT | /api/v1/services/opensearch/{clusterName}/dashboards | Update Dashboards settings (enable/disable, public access) |
GET | /api/v1/services/opensearch/{clusterName}/credentials | Get cluster credentials (username, CA certificate, endpoint; password returned once) |
POST | /api/v1/services/opensearch/{clusterName}/credentials/reset | Reset cluster credentials (re-arms one-shot password reveal) |
GET | /api/v1/services/opensearch/flavors | List available flavors per compute class (vCPU, memory, pricing per node) |
GET | /api/v1/services/opensearch/versions | List supported engine versions |
Path parameters: {clusterName} is the cluster name (1–40 characters, lowercase alphanumeric and hyphens).
Every cluster runs exactly three nodes. The node count is not configurable. Storage can only be grown (minimum 20 GiB per node), and the storage class (standard or performance) is fixed at creation. The compute class (eco, standard, or production) can be changed after creation; the update reschedules the nodes one at a time.
GET .../credentials returns the password field only on the first call. Subsequent reads return username, caCertificate, endpoint, and passwordRevealed: true, but omit password. Call POST .../credentials/reset to rotate the password and re-arm the one-shot reveal.
The create and update requests accept an optional backup object to configure scheduled snapshots:
| Field | Type | Default | Description |
|---|---|---|---|
enabled | boolean | true | Run scheduled snapshots. Existing clusters keep them running unless explicitly disabled. |
schedule | string | 0 2 * * * | Five-field cron expression in UTC. |
Snapshot storage is billed as backup storage, like the other databases. Manual snapshots are always available regardless of this setting.
Services — OpenSearch Backups
| Method | Path | Description |
|---|---|---|
GET | /api/v1/services/opensearch/{clusterName}/backups | List snapshots for a cluster |
POST | /api/v1/services/opensearch/{clusterName}/backups | Create an on-demand snapshot (body: name) |
DELETE | /api/v1/services/opensearch/{clusterName}/backups/{backupName} | Delete a snapshot |
POST | /api/v1/services/opensearch/{clusterName}/backups/{backupName}/restore | Restore a snapshot into a new cluster (body: name, optional flavor and storage) |
Path parameters: {clusterName} is the cluster name; {backupName} is the snapshot name.
Services — Supabase
Manage managed Supabase instances: a PostgreSQL database with Auth, REST, GraphQL, Realtime and Storage behind one endpoint. See the Supabase guide for what's included and operational details.
| Method | Path | Description |
|---|---|---|
GET | /api/v1/services/supabase | List all Supabase instances |
POST | /api/v1/services/supabase | Create a Supabase instance |
GET | /api/v1/services/supabase/{supabaseName} | Get instance details |
PUT | /api/v1/services/supabase/{supabaseName} | Update flavor, compute class, storage, file size limit, public access, backup policy, Studio, or Auth settings |
DELETE | /api/v1/services/supabase/{supabaseName} | Delete an instance and its database and stored files |
GET | /api/v1/services/supabase/{supabaseName}/public-access | Get public access settings |
PUT | /api/v1/services/supabase/{supabaseName}/public-access | Update public access settings (enable/disable, allowed IPs) |
GET | /api/v1/services/supabase/{supabaseName}/credentials | Get credentials (endpoint, API keys and their legacy JWT equivalents, Studio username, database connection details, Storage S3 keys; passwords returned once) |
POST | /api/v1/services/supabase/{supabaseName}/credentials/reset | Reset the Studio and database passwords (re-arms one-shot password reveal); API keys are never rotated |
GET | /api/v1/services/supabase/flavors | List available database flavors per compute class (vCPU, memory, pricing) |
GET | /api/v1/services/supabase/versions | List supported PostgreSQL versions |
Path parameters: {supabaseName} is the instance name (1–40 characters, lowercase alphanumeric and hyphens, starting with a letter).
Auth, REST, GraphQL, Realtime, Storage and the API gateway run a fixed footprint of 1,350 mCPU and 1,152 MiB of memory, billed at the instance's compute class rates on top of the database price (componentsCpuMilli, componentsMemoryMiB and componentsPricePerHour in the flavors response). While Studio is enabled, Studio and the database metadata service add studioComponentsCpuMilli, studioComponentsMemoryMiB and studioComponentsPricePerHour, plus a studioVolumeMiB volume on the instance's storage class. Flavor prices are your organization's prices. Only the database's flavor, compute class, and the database and file storage sizes are customer-selectable. Storage can only be grown; the storage class (standard or performance) is fixed at creation and applies to both the database and file volumes. The compute class can be changed after creation.
GET .../credentials returns the studioPassword and databasePassword fields only on the first call after creation or a reset. Subsequent reads omit them but return secretsRevealed: true. The publishable and secret API keys are always returned and are never rotated by a credentials reset — rotating them would break every connected client. Call POST .../credentials/reset to obtain new Studio and database passwords; the instance restarts its components to pick up the new password, which takes about one to two minutes.
The create and update requests accept an optional backup object to configure scheduled snapshots of the database and file storage volumes together:
| Field | Type | Default | Description |
|---|---|---|---|
enabled | boolean | true | Run scheduled snapshots. |
schedule | string | 0 2 * * * | Five-field cron expression in UTC. |
Snapshot storage is billed as backup storage, like the other databases. Manual snapshots are always available regardless of this setting.
The create and update requests accept an optional auth object: siteUrl, redirectUrls (up to 20 URLs or globs), signupDisabled (default true on creation; omitted on update keeps the current value), smtp (host, port, username, password, senderEmail, senderName) and providers (provider, clientId, secret). smtp.password and each provider's secret are write-only: responses return passwordConfigured and secretConfigured instead; omitting them on update keeps the stored value; an empty smtp.password removes the password, and removing a provider removes its secret. Without smtp, Auth sends no email and confirms new email accounts automatically. fileStorage.maxFileSizeMiB sets the largest upload the Storage API accepts (default 50, maximum 5120). See Authentication.
Services — Supabase Backups
| Method | Path | Description |
|---|---|---|
GET | /api/v1/services/supabase/{supabaseName}/backups | List snapshots for an instance |
POST | /api/v1/services/supabase/{supabaseName}/backups | Create an on-demand snapshot (body: name) |
GET | /api/v1/services/supabase/{supabaseName}/backups/{backupName} | Get snapshot details |
DELETE | /api/v1/services/supabase/{supabaseName}/backups/{backupName} | Delete a snapshot |
POST | /api/v1/services/supabase/{supabaseName}/backups/{backupName}/restore | Restore a snapshot into a new instance that keeps the source instance's API keys (body: name, optional flavor, storage, fileStorage) |
Path parameters: {supabaseName} is the instance name; {backupName} is the snapshot name.
A restore never overwrites the source instance. Fields left out of the restore request inherit the source instance's configuration, and storage/fileStorage sizes must be at least as large as the source's — never smaller.
Services — Keycloak
Manage managed Keycloak identity providers. Each instance stores its data in a PostgreSQL service of the project. See the Keycloak guide for operational details.
| Method | Path | Description |
|---|---|---|
GET | /api/v1/services/keycloak | List all Keycloak instances |
POST | /api/v1/services/keycloak | Create an instance on an existing PostgreSQL service (database.existing) or a new one (database.create) |
GET | /api/v1/services/keycloak/{keycloakName} | Get instance details, URLs and dependencies |
PUT | /api/v1/services/keycloak/{keycloakName} | Update instances, flavor, compute class or admin console allow-list |
DELETE | /api/v1/services/keycloak/{keycloakName} | Delete an instance and its dedicated database; ?deleteDatabaseService=true also deletes a PostgreSQL service created with it and used by nothing else |
GET | /api/v1/services/keycloak/{keycloakName}/public-access | Get the public URL and admin console allow-list |
PUT | /api/v1/services/keycloak/{keycloakName}/public-access | Update the admin console allow-list (adminAllowedIPs) |
GET | /api/v1/services/keycloak/{keycloakName}/credentials | Get the admin console URL and admin username; the password is returned once |
POST | /api/v1/services/keycloak/{keycloakName}/credentials/reset | Set a new admin password and return it once |
GET | /api/v1/services/keycloak/flavors | List flavors per compute class (vCPU, memory, price of one instance) |
GET | /api/v1/services/keycloak/versions | List supported Keycloak versions |
Path parameters: {keycloakName} is the instance name (1–40 characters, lowercase alphanumeric and hyphens, starting with a letter).
Deleting a PostgreSQL service that a Keycloak instance uses returns 409 CONFLICT with a dependents array listing the services that use it. Delete those services first.
Services — WordPress
Manage WordPress instances with persistent content, a dedicated database on a MariaDB service, and automatic HTTPS. See the WordPress guide for operational details.
| Method | Path | Description |
|---|---|---|
GET | /api/v1/services/wordpress | List all WordPress instances |
POST | /api/v1/services/wordpress | Create a WordPress instance on an existing or new MariaDB service |
GET | /api/v1/services/wordpress/{wordpressName} | Get instance details |
PUT | /api/v1/services/wordpress/{wordpressName} | Update flavor, compute class, storage, backup policy, version or custom domain |
DELETE | /api/v1/services/wordpress/{wordpressName} | Delete a WordPress instance and its dedicated database |
POST | /api/v1/services/wordpress/{wordpressName}/start | Start a stopped instance |
POST | /api/v1/services/wordpress/{wordpressName}/stop | Stop a running instance |
POST | /api/v1/services/wordpress/{wordpressName}/restart | Restart the instance |
GET | /api/v1/services/wordpress/{wordpressName}/credentials | Get admin URL and username (password returned once) |
POST | /api/v1/services/wordpress/{wordpressName}/credentials/reset | Reset the admin password and return it once |
GET | /api/v1/services/wordpress/flavors | List available flavors per compute class |
GET | /api/v1/services/wordpress/versions | List supported WordPress versions |
Path parameters: {wordpressName} is the instance name (1–40 characters, lowercase alphanumeric and hyphens, starting with a letter).
Deleting a MariaDB service that a WordPress instance uses returns 409 CONFLICT with a dependents array. Delete the WordPress instance first, or pass ?deleteDatabaseService=true when deleting WordPress if the MariaDB was created with it and has no other dependents.
Services — WordPress Backups
| Method | Path | Description |
|---|---|---|
GET | /api/v1/services/wordpress/{wordpressName}/backups | List paired backups |
POST | /api/v1/services/wordpress/{wordpressName}/backups | Create a paired backup (site briefly offline) |
DELETE | /api/v1/services/wordpress/{wordpressName}/backups/{backupId} | Delete a backup |
POST | /api/v1/services/wordpress/{wordpressName}/backups/{backupId}/restore | Restore into a new instance (body: name, optional database, flavor, storage) |
Path parameters: {wordpressName} is the instance name; {backupId} is the backup UUID.
Connections
Connect containers and jobs to services. Connections automatically inject environment variables into the source workload.
| Method | Path | Description |
|---|---|---|
GET | /api/v1/connections | List all connections in the project |
POST | /api/v1/connections | Connect a container to an existing service |
POST | /api/v1/connections/with-service | Create a new service and connect it in one orchestrated request |
GET | /api/v1/connections/{connectionId} | Get connection details |
DELETE | /api/v1/connections/{connectionId} | Remove a connection |
GET | /api/v1/connections/{connectionId}/variables | Get the environment variables injected by this connection |
Path parameters: {connectionId} is a UUID.
Connections accept an accessLevel field: full (default), readwrite, or readonly. Use readwrite for workloads that need standard read/write access without administrative privileges, and readonly for reporting or analytics workloads.
When connecting to an OpenSearch service, the create request requires an indexPatterns array (1–32 patterns, e.g. ["products-*"]). Each connection receives a scoped user restricted to those index patterns. readonly grants read and search; readwrite adds writing, index creation and mapping management; full grants all index operations on the matching patterns without cluster or security administration. The indexPatterns field is returned in the connection detail response. The create-with-service shortcut (POST /api/v1/connections/with-service) does not support OpenSearch — create the cluster first, then connect.
Supabase has no per-connection database user: the access level selects which of the instance's own credentials are injected. readonly injects SUPABASE_URL and SUPABASE_PUBLISHABLE_KEY. readwrite and full additionally inject SUPABASE_SECRET_KEY and DATABASE_URL, a direct PostgreSQL connection string that bypasses row-level security. The secret key also administers Auth users and Storage buckets, so readwrite and full give control of the whole project. readonly is only as restrictive as your row-level security policies. Lowering the level removes the injected variables but does not invalidate a secret key a workload has already read.
Jobs
One-time batch tasks. Jobs are immutable after creation.
| Method | Path | Description |
|---|---|---|
GET | /api/v1/jobs | List jobs (optional status query filter: pending, running, succeeded, failed, suspended) |
POST | /api/v1/jobs | Create a one-time job |
GET | /api/v1/jobs/{job} | Get job details |
DELETE | /api/v1/jobs/{job} | Delete a job and its resources |
GET | /api/v1/jobs/{job}/status | Get current job status |
Path parameters: {job} is the job name.
The create request accepts an optional group field (string, max 63 characters). Jobs sharing the same group are displayed together in the UI. The group is fixed at creation and returned in the job detail response.
Jobs support sharedVolumeMounts in the create request body. See Volumes.
ttlSecondsAfterFinished in options controls how long a succeeded job is kept before SailOps deletes it along with its configuration and connections. A failed job is never deleted automatically. Default: 3600 (1 hour).
activeDeadlineSeconds in options caps how long an execution may run before Kubernetes kills it. The field is nullable: send null on a CronJob update to clear a previously set timeout.
CronJobs
Scheduled recurring tasks. CronJobs support updates and can be suspended/resumed.
| Method | Path | Description |
|---|---|---|
GET | /api/v1/cronjobs | List cronjobs (optional status filter: active, suspended) |
POST | /api/v1/cronjobs | Create a scheduled cronjob |
GET | /api/v1/cronjobs/{cronjob} | Get cronjob details |
PUT | /api/v1/cronjobs/{cronjob} | Update schedule, timezone, container, or options |
DELETE | /api/v1/cronjobs/{cronjob} | Delete a cronjob |
POST | /api/v1/cronjobs/{cronjob}/run | Trigger an immediate execution; returns the created execution (name, status) to track via /executions |
POST | /api/v1/cronjobs/{cronjob}/suspend | Suspend scheduled executions |
POST | /api/v1/cronjobs/{cronjob}/resume | Resume suspended executions |
GET | /api/v1/cronjobs/{cronjob}/config | Get environment variables and mounted files |
PUT | /api/v1/cronjobs/{cronjob}/config | Update environment variables and mounted files |
GET | /api/v1/cronjobs/{cronjob}/executions | List execution history (query param: limit, max 100) |
GET | /api/v1/cronjobs/{cronjob}/executions/{execution} | Get a single execution by name (e.g. the one returned by /run) |
GET | /api/v1/cronjobs/{cronjob}/status | Get current status including next scheduled run |
Path parameters: {cronjob} is the cronjob name.
The create request accepts an optional group field (string, max 63 characters). CronJobs sharing the same group are displayed together in the UI. The group is fixed at creation and returned in the cronjob detail response.
CronJobs support sharedVolumeMounts in the create and update request bodies. See Volumes.
ttlSecondsAfterFinished in options is passed to Kubernetes as spec.jobTemplate.spec.ttlSecondsAfterFinished, so each execution is removed once it finishes — whether it succeeded or failed. Use successfulJobsHistoryLimit and failedJobsHistoryLimit to control how many executions are kept.
activeDeadlineSeconds in options caps how long each execution may run. The field is nullable: send null in a PUT update to remove a previously set timeout.
Stack
Declarative infrastructure-as-code. See the Stack Engine guide for full details.
| Method | Path | Description |
|---|---|---|
POST | /api/v1/stack/plan | Dry-run — preview what would change without applying |
POST | /api/v1/stack/apply | Apply a stack definition to create, update, or delete resources |
GET | /api/v1/stack/export | Export current project state as a stack definition (query params: format, scope) |
Volumes
Manage block (RWO) and shared (RWX) persistent volumes in your project. Block volumes are owned by containers; shared volumes are standalone and can be mounted by multiple workloads.
| Method | Path | Description |
|---|---|---|
GET | /api/v1/volumes | List all volumes in the project (query param: type filter — block or shared) |
GET | /api/v1/containers/{container}/volumes/{volume} | Get a block (RWO) volume, mounted or detached |
DELETE | /api/v1/containers/{container}/volumes/{volume} | Delete a detached block volume, its schedule, and all its snapshots (409 if still mounted) |
POST | /api/v1/shared-volumes | Create a new shared (RWX) volume |
GET | /api/v1/shared-volumes/{volume} | Get shared volume details including live mounts and usage |
PATCH | /api/v1/shared-volumes/{volume} | Resize a shared volume (grow only) |
DELETE | /api/v1/shared-volumes/{volume} | Delete a shared volume (fails with 409 if still mounted) |
Path parameters: {volume} is the volume logical name (without the sv- PVC prefix).
Volume Snapshots
Create and inspect point-in-time snapshots of block volumes. Snapshots can be listed and deleted on both mounted and detached volumes; creating a snapshot or restoring requires the volume to be mounted.
| Method | Path | Description |
|---|---|---|
GET | /api/v1/containers/{container}/volumes/{volume}/snapshots | List snapshots for a block volume |
POST | /api/v1/containers/{container}/volumes/{volume}/snapshots | Create an on-demand snapshot |
GET | /api/v1/containers/{container}/volumes/{volume}/snapshots/{snapshot} | Get snapshot details |
Path parameters: {container} is the container name; {volume} is the volume name; {snapshot} is the snapshot identifier.
Each snapshot includes:
| Field | Type | Description |
|---|---|---|
id | string | Unique snapshot identifier |
volumeName | string | Logical volume name this snapshot belongs to |
status | pending | ready | error | Current snapshot status |
type | manual | scheduled | Whether the snapshot was created on-demand or by the automatic schedule |
sizeBytes | integer (optional) | Snapshot size in bytes when available |
createdAt | date-time | Creation timestamp |
readyAt | date-time (optional) | When the snapshot became ready |
createdBy | string (optional) | User ID that created the snapshot |
error | string (optional) | Error message if the snapshot failed |
restorable | boolean | Whether this snapshot can be used for a restore |
The POST endpoint accepts an optional JSON body with a description field (max 256 characters).
Alerts
Query, acknowledge, and resolve project alerts via the v3 API.
| Method | Path | Description |
|---|---|---|
GET | /api/v3/projects/{projectId}/alerts | List alerts within a time window, most recent first |
GET | /api/v3/projects/{projectId}/alerts/summary | Count open alerts by severity and unread alerts |
PATCH | /api/v3/projects/{projectId}/alerts/{alertId} | Mark an alert read or unread |
POST | /api/v3/projects/{projectId}/alerts/{alertId}/resolve | Resolve an alert |
Path parameters: {projectId} is the project UUID; {alertId} is the alert UUID.
GET /api/v3/projects/{projectId}/alerts accepts the following optional query parameters:
| Parameter | Type | Description |
|---|---|---|
limit | integer | Maximum number of alerts to return |
offset | integer (default 0) | How many items to skip |
since | date-time | Start of the time window |
until | date-time | End of the time window (defaults to request time; pass back the until of the first page to page through the same window) |
severity | array of strings | Filter by severity: INFO, WARNING, ERROR, CRITICAL |
resourceType | string | Filter by resource type (e.g. CONTAINER, POSTGRES, MARIADB, VALKEY, NATS, OPENSEARCH, KAFKA, SUPABASE, KEYCLOAK, WORDPRESS, AI_AGENT, GATEWAY, JOB, CRONJOB, CUSTOM, MARKETPLACE, WEBSITE, SHARED_VOLUME) |
resourceName | string | Filter by resource name |
read | boolean | Only read or only unread alerts |
resolved | boolean | Only resolved or only open alerts |
The summary endpoint accepts since, until, resourceType, and resourceName.
Read state is shared across the project: marking an alert read marks it read for everyone. The PATCH body is {"read": true} or {"read": false}.
Notifications
Configure where alerts are sent, per severity level.
| Method | Path | Description |
|---|---|---|
GET | /api/v3/projects/{projectId}/notifications | List notification settings for all severities |
PATCH | /api/v3/projects/{projectId}/notifications/{severity} | Update notification channels for one severity |
POST | /api/v3/projects/{projectId}/notifications/{severity}/test | Send a test notification through saved channels |
Path parameters: {projectId} is the project UUID; {severity} is INFO, WARNING, or CRITICAL.
PATCH uses merge-patch semantics: omitted fields keep their stored value. Set a channel to null to remove it; provide an object to replace it entirely. Channel URLs are write-only and never returned in responses.
Notification channels: webhook, slack, teams, discord, mattermost. The webhook channel also supports a custom name and headers for authentication.
The test endpoint optionally accepts a request body with channel definitions to test destinations that are not saved yet. They are not persisted by this call.
Support Tickets
Open, follow, and manage support tickets for your organization via the v3 API.
| Method | Path | Description |
|---|---|---|
GET | /api/v3/organizations/{organizationId}/tickets | List support tickets for the organization |
POST | /api/v3/organizations/{organizationId}/tickets | Open a new support ticket |
GET | /api/v3/organizations/{organizationId}/tickets/{ticketId} | Get a support ticket |
GET | /api/v3/organizations/{organizationId}/tickets/{ticketId}/messages | List the messages of a ticket |
POST | /api/v3/organizations/{organizationId}/tickets/{ticketId}/messages | Reply to a ticket (multipart, up to 5 files of 10 MB) |
POST | /api/v3/organizations/{organizationId}/tickets/{ticketId}/resolve | Resolve a ticket |
POST | /api/v3/organizations/{organizationId}/tickets/{ticketId}/reopen | Reopen a resolved or closed ticket |
Path parameters: {organizationId} is the organization UUID; {ticketId} is the ticket UUID.
Support ticket endpoints require a session cookie (signed-in user). API keys are not supported.
GET .../tickets accepts the following optional query parameters:
| Parameter | Type | Description |
|---|---|---|
limit | integer (1–100, default 50) | Maximum number of tickets per page |
cursor | string | Cursor returned by a previous page (nextCursor) |
status | string | Only tickets in this status: new, open, pending, resolved, closed |
The POST request body (JSON) requires the following fields:
| Field | Type | Description |
|---|---|---|
subject | string (1–500 chars) | Ticket subject |
message | string | First message body |
category | string | question, incident, or problem |
priority | string | low, normal, high, or urgent |
projectId | UUID | The project the ticket is about |
resource | object (optional) | Affected resource: product (Container, Database, Cache, Gateway) and optional name |
POST .../messages accepts multipart/form-data with a required body text field and an optional files array (up to 5 files, 10 MB each). Accepted file types: images, PDF, plain text, CSV.
POST .../reopen accepts an optional JSON body with a message field explaining why the ticket is reopened. A ticket that is neither resolved nor closed is returned as-is.
Organizations
Query, bootstrap, and inspect the organizations you belong to via the v3 API.
| Method | Path | Description |
|---|---|---|
PUT | /api/v3/me | Sync your account (returns hasMemberships and trialAvailable) |
POST | /api/v3/me/trial | Start your free trial (one per person, requires acceptedTermsVersion) |
GET | /api/v3/organization-name-suggestion | Suggest an organization name |
GET | /api/v3/organizations | List organizations you can access, in alphabetical order (includes type and createdAt) |
GET | /api/v3/organizations/{organizationId} | Get organization details (state, support level, billing readiness) |
GET | /api/v3/organizations/{organizationId}/billing | Get billing details and balance |
Path parameters: {organizationId} is the organization UUID.
PUT /api/v3/me requires a session cookie (not an API key). Call it once per sign-in to record the account and learn whether the caller already belongs to an organization (hasMemberships) and whether they can start a free trial (trialAvailable).
To start a trial, call POST /api/v3/me/trial with a name and acceptedTermsVersion. Each person gets one trial; a second call answers CONFLICT. The organization exists when the call returns, but its first project may still be provisioning. Check state.phase — when it is provisioning, poll GET /api/v3/organizations with phase=provisioning until it transitions to the next phase.
GET /api/v3/organizations accepts the following optional query parameters:
| Parameter | Type | Description |
|---|---|---|
limit | integer | Maximum number of organizations to return |
cursor | string | Cursor returned by a previous page (nextCursor) |
phase | array of strings | Only organizations in these phases: provisioning, onboarding, trial, active, restricted, blocked, archived |
GET /api/v3/organizations/{organizationId} returns:
| Field | Type | Description |
|---|---|---|
id | UUID | Organization identifier |
name | string | Organization name |
type | PERSONAL | ENTERPRISE | Organization type |
state | object | Current phase, message, trial end date, and grace period |
createdAt | date-time | Creation timestamp |
scopes | array of strings | What you may do in this organization, as collection:verb |
supportLevel | FREE | STARTER | BUSINESS | CUSTOM | Support plan |
maxLogRetentionDays | integer (optional) | How far back the log explorer may look |
remainingTrialCredits | integer (optional) | Trial allowance remaining in cents (present only during trial phase) |
requirePaymentMethod | boolean | Whether a payment method is needed before the organization can be used |
billingComplete | boolean | Whether all billing details needed to invoice are present |
canArchive | boolean | Whether the organization can be archived now |
The state object includes phase, an optional message, an optional trialEndsAt (present during the trial phase), and an optional gracePeriod with reason (PAYMENT_FAILED or TRIAL_EXPIRED), startedAt, and an optional endsAt.
GET /api/v3/organizations/{organizationId}/billing requires the billing:read scope and returns:
| Field | Type | Description |
|---|---|---|
email | string | Where invoices are sent |
credits | integer | Account balance in cents |
address | object (optional) | Billing address (street, city, postal code, country) |
business | object (optional) | Business details for enterprise organizations (name, registration number, VAT) |
Projects
Query and inspect the projects within an organization via the v3 API.
| Method | Path | Description |
|---|---|---|
GET | /api/v3/organizations/{organizationId}/projects | List projects you can access in the organization, in alphabetical order |
GET | /api/v3/projects/{projectId} | Get project details and your scopes in it |
Path parameters: {organizationId} is the organization UUID; {projectId} is the project UUID.
GET /api/v3/organizations/{organizationId}/projects accepts the following optional query parameters:
| Parameter | Type | Description |
|---|---|---|
limit | integer | Maximum number of projects to return |
cursor | string | Cursor returned by a previous page (nextCursor) |
phase | array of strings | Only projects in these phases: active, suspended, pendingDeletion |
GET /api/v3/projects/{projectId} returns:
| Field | Type | Description |
|---|---|---|
id | UUID | Project identifier |
name | string | Project name |
state | object | Current phase and lifecycle details |
scopes | array of strings | What you may do in this project, as collection:verb |
createdAt | date-time | Creation timestamp |
updatedAt | date-time | When the project or its lifecycle last changed |
The state object includes phase (active, suspended, or pendingDeletion). When suspended, it also includes suspendedAt and suspensionReason (manual, organization, or deletion). When pendingDeletion, a deletion object with scheduledAt and reason (customer_deletion_requested or dunning_org_archived) is present.
The scopes array on a project contains only project-reachable scopes. Organization-level scopes such as organizations:write or billing:write do not appear, even if the caller holds them on the parent organization.
Audit Log
Query what was changed in an organization or a project, by whom, and through which channel.
| Method | Path | Description |
|---|---|---|
GET | /api/v3/organizations/{organizationId}/audit | List the organization's audit log (all projects) |
GET | /api/v3/projects/{projectId}/audit | List the project's audit log |
Path parameters: {organizationId} is the organization UUID; {projectId} is the project UUID.
Both endpoints accept the following optional query parameters:
| Parameter | Type | Description |
|---|---|---|
limit | integer | Maximum number of entries to return |
offset | integer (default 0) | How many entries to skip |
since | date-time | Start of the time window |
until | date-time | End of the time window (defaults to request time; pass back the until of the first page to page through the same window) |
action | array of strings | Only entries of these operations (up to 50) |
actorType | string | Only entries by actors of this type: user, api_key, or system |
actor | string | Only entries by this actor (a user's id, or a key's label) |
source | string | Only entries made through this channel: ui, mcp, public_api, internal, webhook, or cli |
The project endpoint also accepts:
| Parameter | Type | Description |
|---|---|---|
targetKind | string | Only entries about resources of this kind (e.g. container, api_key) |
target | string | Only entries about the resource with this name |
Each entry includes id, occurredAt, actor (with type, id, display), source, action, target (with kind and id), and a human-readable message. The page object includes items, total, totalExact, offset, limit, and the until timestamp of the window.
AI Models
The OpenAI-compatible endpoint itself is served at /api/ai/v1 on the host root, not under this API; see Models. These operations read and configure it for the key's project.
| Method | Path | Description | Scope |
|---|---|---|---|
GET | /api/v1/ai/models | List the models with the prices your organization is billed at | ai-models:list |
GET | /api/v1/ai/models/settings | Get the project's monthly budget and allowed models | ai-models:get |
PUT | /api/v1/ai/models/settings | Replace the monthly budget (monthlyBudgetEur) and the allowed models (allowedModels, empty allows every model) | ai-models:update |
GET | /api/v1/ai/models/usage | Token usage over a period, per model and per API key (query params: from, to; defaults to the current month) | ai-models:get |
GET | /api/v1/ai/models/usage/days | Token usage, spend, errors and latency per UTC day (query params: from, to, optional model and key) | ai-models:get |
A model in allowedModels that GET /api/v1/ai/models does not list is refused with 400. A settings change reaches the endpoint within a minute and is recorded in the audit log.
Sandboxes
Agent sandboxes — containers created with the agent-sandbox preset. Start, stop, restart, delete and logs use the container endpoints under /api/v1/containers/{container}. See Agent Sandboxes for the full guide.
| Method | Path | Description | Scope |
|---|---|---|---|
GET | /api/v1/sandboxes | List the agent sandboxes of the project | containers:list |
POST | /api/v1/sandboxes | Create an agent sandbox | containers:update |
GET | /api/v1/sandboxes/{name} | Get sandbox details | containers:list |
GET | /api/v1/sandboxes/{name}/settings | Get the idle timeout, SSH public keys and network settings | containers:list |
PUT | /api/v1/sandboxes/{name}/settings | Update settings (idle timeout, SSH keys, network isolation, software) | containers:update |
POST | /api/v1/sandboxes/{name}/exec | Run a command in the sandbox | sandboxes:exec |
Path parameters: {name} is the sandbox name.
POST .../exec runs a command without a TTY and waits for it to finish, up to timeoutSeconds (60 by default, 600 at most). The request body accepts command (string array), shell (string), optional cwd, env and timeoutSeconds. stdout and stderr are captured separately, each truncated at 1 MiB. The response includes exitCode, durationMs, stdoutTruncated, stderrTruncated and timedOut. Counts as activity for the idle stop; recorded in the audit log.
AI Agents
Manage managed AI agents in your project. See the AI Agents guide for full details.
| Method | Path | Description | Scope |
|---|---|---|---|
GET | /api/v1/ai/agents | List the managed AI agents of the project | ai-agents:list |
POST | /api/v1/ai/agents | Create a managed AI agent | ai-agents:update |
GET | /api/v1/ai/agents/{agentName} | Get an AI agent | ai-agents:list |
PUT | /api/v1/ai/agents/{agentName} | Update an AI agent (compute, storage grow, model provider, allowed IPs) | ai-agents:update |
DELETE | /api/v1/ai/agents/{agentName} | Delete an AI agent and its state volume | ai-agents:update |
POST | /api/v1/ai/agents/{agentName}/start | Start a stopped AI agent | ai-agents:update |
POST | /api/v1/ai/agents/{agentName}/stop | Stop an AI agent (volume billing remains) | ai-agents:update |
POST | /api/v1/ai/agents/{agentName}/restart | Restart an AI agent | ai-agents:update |
GET | /api/v1/ai/agents/{agentName}/credentials | Reveal the UI credential (once) | ai-agents:update |
POST | /api/v1/ai/agents/{agentName}/credentials/reset | Reset the UI credential and restart the agent | ai-agents:update |
PUT | /api/v1/ai/agents/{agentName}/secrets | Set or remove the write-only secrets (model API key, channel tokens) | ai-agents:update |
POST | /api/v1/ai/agents/{agentName}/models-binding | Point the agent at SailOps Models (creates or rotates a project API key) | ai-agents:update + ai-models:invoke |
GET | /api/v1/ai/agents/flavors | List compute flavors with eligible engines | ai-agents:list |
GET | /api/v1/ai/agents/engines | List agent engines, versions and expected secrets | ai-agents:list |
Path parameters: {agentName} is the agent name (1–40 characters, lowercase alphanumeric and hyphens).
AI agents are not available during the trial. Creating an agent on a trial organization is refused.
PUT .../secrets sets the model API key and channel tokens. An absent field keeps the stored value; an empty string removes it. The values are never returned by any endpoint.
Plans
No authentication required.
| Method | Path | Description | Auth |
|---|---|---|---|
GET | /api/v1/plans | Get the public support plan catalog | No |
The response lists every support plan (FREE, STARTER, BUSINESS, CUSTOM) with its quotas, features, and pricing. Optional quota fields are omitted when their value is negotiated per contract rather than publicly committed. All prices exclude tax.
Each plan includes:
| Field | Type | Description |
|---|---|---|
level | string | Support level (FREE, STARTER, BUSINESS, CUSTOM) |
name | string | Product name of the plan |
availability | string | SELF_SERVE or CONTACT_SALES |
priceCents | integer (optional) | Monthly base price in euro cents |
spendRatio | number (optional) | Hybrid pricing ratio: plan is invoiced at max(base price, spendRatio x usage) |
logRetentionDays | integer (optional) | Log retention in days |
metricRetentionDays | integer (optional) | Metric retention in days |
includedLogGiB | integer (optional) | Included log volume per month in GiB |
includedMetricSamplesMonthly | integer (optional) | Included metric samples per month |
includedMetricActiveSeries | integer (optional) | Included active metric series |
includedTraceSpansMonthly | integer (optional) | Included trace spans per month |
includedStorageGiBMonth | integer (optional) | Included storage in GiB-month |
metricSamplesRateLimitPerSecond | integer (optional) | Metric sample ingestion rate limit |
metricSamplesBillingEnforcementMode | string | HARD_CAP or BILL_OVERAGE |
features | array | List of plan features (see below) |
Each feature object contains:
| Field | Type | Description |
|---|---|---|
key | string | Stable feature identifier (e.g. sla.uptimePercent, support.responseTimeHours) |
included | boolean | Whether the feature is included in the plan |
value | number (optional) | Magnitude in the unit fixed by the key |
Pricing
No authentication required.
| Method | Path | Description | Auth |
|---|---|---|---|
GET | /api/v1/pricing | Get public pricing for compute, jobs, storage, load balancers, databases, managed services, and websites | No |
The pricing response includes GPU compute classes with additional fields: minCpu, minRamMiB, gpuType, gpuMode, gpuMemoryGiB, pricePerGpuHour, maxGpus, minBillSeconds, requiresPlans.
The response also includes a postgresqlPgBouncer object with pricePerInstanceHour and pricePerInstanceMonth for managed PgBouncer pricing.
jobComputeClasses lists the compute classes of jobs and cronjobs: base prices per CPU and RAM hour, the durationTiers multipliers applied according to the job's duration, and minBillingSeconds.
websitePlans lists the per-instance price of each website plan.
serviceFlavors lists the flavors of OpenSearch, Kafka, Supabase, Keycloak, and WordPress at public prices, in the shape the /api/v1/services/{service}/flavors endpoints return at your organization's prices. OpenSearch and Kafka prices are per node; Keycloak and WordPress prices are per instance; a Supabase instance bills componentsPricePerHour on top of its database price.
The usagePricing object exposes per-unit rates for usage-based resources (all prices in euros):
| Field | Sub-field | Description |
|---|---|---|
websiteStorage | pricePerGiBHour | Website S3 storage price per GiB-hour |
sharedVolumeStorage | pricePerGiBHour | Shared volume storage price per GiB-hour |
objectStorage | storagePricePerGiBMonth | Object Storage price per GiB-month stored |
objectStorage | writePricePerMillion | Object Storage price per million write and listing requests |
objectStorage | readPricePerMillion | Object Storage price per million read and HEAD requests |
objectStorage | downloadPricePerGiB | Object Storage price per GiB downloaded |
logStorage | overagePricePerGiBMonth | Log storage overage price per GiB-month |
backupStorage | pricePerGiBMonth | Backup storage price per GiB-month |
observability | metricSamplesPricePerMillion | Metric sample price per million |
observability | traceSpansPricePerMillion | Trace span price per million |
observability | storagePricePerGiBMonth | Observability storage price per GiB-month |
Resources
Query, tag, and delete resources across all types in a project. See Resource tags for details.
| Method | Path | Description |
|---|---|---|
GET | /api/v1/resources | List resources with optional tag filters and pagination |
PUT | /api/v1/resources/{resourceId}/tags | Replace all tags on a resource (requires revision for optimistic concurrency) |
DELETE | /api/v1/resources/{resourceId} | Delete a resource and its owned children |
Path parameters: {resourceId} is the resource UUID.
GET /api/v1/resources accepts the following optional query parameters:
| Parameter | Type | Description |
|---|---|---|
tag | string (repeatable) | Filter by tag, format key=value; all filters must match |
kind | string | Filter by resource kind (e.g. CONTAINER, POSTGRES, MARIADB, VALKEY, NATS, OPENSEARCH, KAFKA, SUPABASE, KEYCLOAK, WORDPRESS, AI_AGENT, GATEWAY, JOB, CRONJOB, CUSTOM, MARKETPLACE, WEBSITE, SHARED_VOLUME) |
limit | integer (1–200, default 100) | Page size |
cursor | UUID | Cursor from nextCursor of a previous page |
All resource creation endpoints (POST) accept an optional tags object with up to 50 key/value pairs. Tags are set at creation and can later be replaced via PUT /api/v1/resources/{resourceId}/tags.
PUT /api/v1/resources/{resourceId}/tags requires a revision field matching the current tag revision of the resource. A concurrent edit returns 409 Conflict — re-fetch the resource and retry.
DELETE /api/v1/resources/{resourceId} follows each resource type's existing deletion rules. Parent-managed resources and custom services cannot be deleted through this endpoint (canDelete: false in the listing response). The API refuses to delete a replacement that was created after a previous listing.
Error Codes
The API returns specific error codes in error responses to help identify the issue:
ORGANIZATION_SETUP_REQUIRED— Organization setup is incomplete. Complete billing information and add a payment method to start using it.ORGANIZATION_BLOCKED— Organization is blocked. Resolve the billing issue in organization settings. Any outstanding invoices must be paid before access can be restored.ORGANIZATION_RESTRICTED— Organization is restricted. Resource modifications are disabled until billing is resolved.ORGANIZATION_ARCHIVED— Organization is archived. Modifications are no longer permitted.ORGANIZATION_HAS_ACTIVE_PROJECTS— Cannot archive an organization while active or pending-deletion projects remain.PLAN_RESOURCE_LIMIT— The organization's support plan does not allow the requested resource (e.g. GPU compute class restricted to a higher tier).SERVICE_UNAVAILABLE— The service is temporarily unavailable; retry the request. Returned with HTTP503.
Practical Examples
Deploy a container image update
Use PATCH v2 to update the image and optionally the configuration in a single atomic rollout:
curl -X PATCH \
-H "X-Api-Key: $SAILOPS_API_KEY" \
-H "Content-Type: application/json" \
-d '{"image": "ghcr.io/myorg/api:v2.1.0"}' \
https://app.sailops.io/api/public/api/v2/containers/my-api
To update the image along with init containers:
curl -X PATCH \
-H "X-Api-Key: $SAILOPS_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"image": "ghcr.io/myorg/api:v2.1.0",
"initContainers": [
{"image": "ghcr.io/myorg/migrate:v2.1.0", "command": "./migrate.sh"}
]
}' \
https://app.sailops.io/api/public/api/v2/containers/my-api
Update image, resources, and config in one call
PATCH v2 also accepts optional computeClass, resources, and config fields. This is useful for CI/CD pipelines that manage the full container configuration:
curl -X PATCH \
-H "X-Api-Key: $SAILOPS_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"computeClass": "standard",
"resources": {"cpu": 2000, "memory": 2048},
"image": "ghcr.io/myorg/api:v2.1.0",
"initContainers": [
{"image": "ghcr.io/myorg/migrate:v2.1.0"}
],
"config": {
"environment": [
{"name": "DATABASE_URL", "value": "postgresql://..."},
{"name": "LOG_LEVEL", "value": "info"}
],
"files": []
}
}' \
https://app.sailops.io/api/public/api/v2/containers/my-api
If the CPU/RAM ratio does not match the selected compute class, the API returns a 400 error with a descriptive message.
Create a container with persistent volumes
curl -X POST \
-H "X-Api-Key: $SAILOPS_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "my-app",
"spec": {
"computeClass": "standard",
"image": "myapp:latest",
"resources": {"cpu": 500, "memory": 512},
"volumes": [
{
"name": "data",
"mountPath": "/data",
"sizeInMB": 2048,
"storageClass": "standard"
},
{
"name": "uploads",
"mountPath": "/app/uploads",
"sizeInMB": 10240,
"storageClass": "performance"
}
]
}
}' \
https://app.sailops.io/api/public/api/v1/containers
Containers with persistent volumes are limited to 1 replica and cannot use autoscaling (up to 5 volumes per container). See the Persistent Volumes guide for details.
Create a PostgreSQL database
curl -X POST \
-H "X-Api-Key: $SAILOPS_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "my-db",
"version": 16,
"flavor": "small",
"computeClass": "standard",
"storage": "20Gi",
"databases": ["app"]
}' \
https://app.sailops.io/api/public/api/v1/services/postgresql
Expose a container via a gateway route
# 1. Create a gateway
curl -X POST \
-H "X-Api-Key: $SAILOPS_API_KEY" \
-H "Content-Type: application/json" \
-d '{"name": "main-lb", "class": "gw-small"}' \
https://app.sailops.io/api/public/api/v1/gateways
# 2. Add a domain
curl -X POST \
-H "X-Api-Key: $SAILOPS_API_KEY" \
-H "Content-Type: application/json" \
-d '{"hostname": "api.example.com", "port": 443, "protocol": "HTTPS"}' \
https://app.sailops.io/api/public/api/v1/gateways/main-lb/domains
# 3. Create an HTTP route
curl -X POST \
-H "X-Api-Key: $SAILOPS_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "api-route",
"type": "HTTPRoute",
"httpSpec": {
"hostnames": ["api.example.com"],
"rules": [
{
"matches": [{"path": {"type": "PathPrefix", "value": "/"}}],
"backendRefs": [{"name": "my-api", "port": 8080}]
}
]
}
}' \
https://app.sailops.io/api/public/api/v1/gateways/main-lb/routes
Trigger a cronjob manually
curl -X POST \
-H "X-Api-Key: $SAILOPS_API_KEY" \
https://app.sailops.io/api/public/api/v1/cronjobs/nightly-report/run
List and download database backups
# List PostgreSQL backups
curl -H "X-Api-Key: $SAILOPS_API_KEY" \
https://app.sailops.io/api/public/api/v1/services/postgresql/my-db/backups
# Download a PostgreSQL backup
curl -H "X-Api-Key: $SAILOPS_API_KEY" \
https://app.sailops.io/api/public/api/v1/services/postgresql/my-db/backups/backup-123/download
Create a shared volume and mount it
# 1. Create a shared volume
curl -X POST \
-H "X-Api-Key: $SAILOPS_API_KEY" \
-H "Content-Type: application/json" \
-d '{"name": "shared-data", "sizeInMB": 10240}' \
https://app.sailops.io/api/public/api/v1/shared-volumes
# 2. Mount it on a container
curl -X PATCH \
-H "X-Api-Key: $SAILOPS_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"image": "myapp:latest",
"sharedVolumeMounts": [
{"volumeName": "shared-data", "mountPath": "/mnt/shared"}
]
}' \
https://app.sailops.io/api/public/api/v1/containers/my-worker