Skip to main content

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​

MethodPathDescriptionAuth
GET/statusCheck API health — returns 204 No Content when healthyNo

Containers​

Manage the full lifecycle of Docker containers running in your project.

MethodPathDescription
GET/api/v1/containersList all containers in the project
POST/api/v1/containersCreate 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}/configGet 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}/startStart a stopped container
POST/api/v1/containers/{container}/stopStop a running container
POST/api/v1/containers/{container}/restartRestart all instances of a container. Applies any configuration saved with PUT /config since the last rollout
GET/api/v1/containers/{container}/logsGet container logs with filtering and pagination

Path parameters: {container} is the container name (e.g., my-api).

Container detail response fields

GET /api/v1/containers/{container} returns status diagnostics alongside the container spec:

FieldTypeDescription
statusMessagestring (optional)Why the container is in its current status
diagnosticobject (optional)The most relevant problem observed on the container's instances

The diagnostic object, when present, contains:

FieldTypeDescription
reasonstringMachine-readable cause (e.g. CrashLoopBackOff, OOMKilled, ImagePullBackOff)
summarystringShort human-readable description
detailstringSanitized evidence reported by the runtime
suggestionsstring[]Actionable hints to resolve the problem
activebooleanWhether the problem currently blocks an instance
observedAtdate-timeWhen the problem was last observed
exitCodeinteger (optional)Process exit code, when applicable
Container logs query parameters

GET /api/v1/containers/{container}/logs accepts the following optional query parameters:

ParameterTypeDescription
linesinteger (≤ 1000, default 100)Number of log lines to return
offsetinteger (default 0)Number of lines to skip — use with total for pagination
instanceNamestringFilter to a specific pod instance (see instances in the response)
querystringFree-text search on the log message
start / endISO 8601 date-timeTime range (e.g. 2024-02-03T15:00:00Z); apply both together
streamstdout | stderrFilter by output stream
initboolean (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.

Shared volume mounts

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.

Migration: use PATCH v2 for CI/CD

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.

BodyEnvironmentFiles
config omittedunchangedunchanged
"config": {}unchangedunchanged
"config": {"environment": [...]}replacedunchanged
"config": {"files": [...]}unchangedreplaced
"config": {"files": []}unchangedpurged
"config": {"environment": [], "files": []}purgedpurged

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.

MethodPathDescription
GET/api/v1/websitesList all websites in the project
POST/api/v1/websitesCreate 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}/startStart a stopped website
POST/api/v1/websites/{websiteName}/stopStop a running website (scale to 0 replicas)
PUT/api/v1/websites/{websiteName}/domainSet a custom domain (with gateway name and optional path prefix)
DELETE/api/v1/websites/{websiteName}/domainRemove the custom domain
GET/api/v1/websites/{websiteName}/filesList files and directories (query param: path)
DELETE/api/v1/websites/{websiteName}/filesDelete a file (query param: path)
POST/api/v1/websites/{websiteName}/files/directoriesCreate a directory (JSON body: path)
GET/api/v1/websites/{websiteName}/files/statsGet storage usage statistics
POST/api/v1/websites/{websiteName}/files/upload-urlGet a presigned upload URL (JSON body: path, optional contentType)
GET/api/v1/websites/{websiteName}/files/download-urlGet a presigned download URL (query param: path)
POST/api/v1/websites/{websiteName}/files/deployDeploy 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.

MethodPathDescription
GET/api/v1/gatewaysList all gateways in the project
POST/api/v1/gatewaysCreate 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}/domainsList all domains attached to a gateway
POST/api/v1/gateways/{gateway}/domainsAdd 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.

MethodPathDescription
GET/api/v1/gateways/{gateway}/routesList all routes for a gateway
POST/api/v1/gateways/{gateway}/routesCreate 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​

MethodPathDescription
GET/api/v1/services/postgresqlList all PostgreSQL services
POST/api/v1/services/postgresqlCreate 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
Required databases field

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.

Lifecycle status fields

PostgreSQL service responses include two read-only fields for lifecycle awareness:

FieldTypeDescription
lifecyclePendingboolean (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.
statusMessagestring (optional)Operator detail about the current lifecycle state, including background provisioning or retry information.
Connection pooling (PgBouncer)

PostgreSQL services support optional managed PgBouncer connection pooling. Include the connectionPooling object in the create or update request body:

FieldTypeDefaultDescription
enabledbooleanfalseEnable or disable PgBouncer
modesession | transactionsessionPooling mode
instancesinteger (1–5)1Number of PgBouncer instances
maxClientConnectionsinteger (1–10 000)500Maximum client connections
defaultPoolSizeinteger (1–1 000)20Default pool size per database/user pair
reservePoolSizeinteger (0–1 000)5Reserve pool size

When enabled, the service response includes a pooledConnectionInfo object with host, port, and database for the pooled endpoint.

Storage class is immutable

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.

Logical database limit

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​

MethodPathDescription
GET/api/v1/services/postgresql/{service}/backupsList PostgreSQL backups (query: limit, offset)
POST/api/v1/services/postgresql/{service}/backupsCreate 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}/downloadGet a presigned download URL for a PostgreSQL backup

Path parameters: {service} is the service name; {backupId} is the backup identifier.


Services — MariaDB​

MethodPathDescription
GET/api/v1/services/mariadbList all MariaDB services
POST/api/v1/services/mariadbCreate 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
Required databases field

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.

Lifecycle status fields

MariaDB service responses include two read-only fields for lifecycle awareness:

FieldTypeDescription
lifecyclePendingboolean (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.
statusMessagestring (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​

MethodPathDescription
GET/api/v1/services/mariadb/{service}/backupsList MariaDB backups (query: limit, offset)
POST/api/v1/services/mariadb/{service}/backupsCreate 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}/downloadGet a presigned download URL for a MariaDB backup

Path parameters: {service} is the service name; {backupId} is the backup identifier.


Services — Valkey​

MethodPathDescription
GET/api/v1/services/valkeyList all Valkey (Redis-compatible) services
POST/api/v1/services/valkeyCreate 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
Immutable replica count

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​

MethodPathDescription
GET/api/v1/services/natsList all NATS services
POST/api/v1/services/natsCreate 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.

MethodPathDescription
GET/api/v1/services/kafkaList all Kafka clusters
POST/api/v1/services/kafkaCreate 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}/topicsList topics
POST/api/v1/services/kafka/{clusterName}/topicsCreate 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}/usersList SCRAM users
POST/api/v1/services/kafka/{clusterName}/usersCreate 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-passwordRegenerate a user's password
GET/api/v1/services/kafka/flavorsList available flavors per compute class
GET/api/v1/services/kafka/versionsList supported Kafka versions

Path parameters: {clusterName} is the cluster name; {topicName} is the topic name; {userName} is the user name.

Immutable node count

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.

Connection

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.

MethodPathDescription
GET/api/v1/services/opensearchList all OpenSearch clusters
POST/api/v1/services/opensearchCreate 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-accessGet public access settings
PUT/api/v1/services/opensearch/{clusterName}/public-accessUpdate public access settings (enable/disable, allowed IPs)
GET/api/v1/services/opensearch/{clusterName}/dashboardsGet Dashboards settings
PUT/api/v1/services/opensearch/{clusterName}/dashboardsUpdate Dashboards settings (enable/disable, public access)
GET/api/v1/services/opensearch/{clusterName}/credentialsGet cluster credentials (username, CA certificate, endpoint; password returned once)
POST/api/v1/services/opensearch/{clusterName}/credentials/resetReset cluster credentials (re-arms one-shot password reveal)
GET/api/v1/services/opensearch/flavorsList available flavors per compute class (vCPU, memory, pricing per node)
GET/api/v1/services/opensearch/versionsList supported engine versions

Path parameters: {clusterName} is the cluster name (1–40 characters, lowercase alphanumeric and hyphens).

Fixed three-node topology

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.

One-shot password reveal

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.

Backup policy

The create and update requests accept an optional backup object to configure scheduled snapshots:

FieldTypeDefaultDescription
enabledbooleantrueRun scheduled snapshots. Existing clusters keep them running unless explicitly disabled.
schedulestring0 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​

MethodPathDescription
GET/api/v1/services/opensearch/{clusterName}/backupsList snapshots for a cluster
POST/api/v1/services/opensearch/{clusterName}/backupsCreate 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}/restoreRestore 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.

MethodPathDescription
GET/api/v1/services/supabaseList all Supabase instances
POST/api/v1/services/supabaseCreate 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-accessGet public access settings
PUT/api/v1/services/supabase/{supabaseName}/public-accessUpdate public access settings (enable/disable, allowed IPs)
GET/api/v1/services/supabase/{supabaseName}/credentialsGet 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/resetReset the Studio and database passwords (re-arms one-shot password reveal); API keys are never rotated
GET/api/v1/services/supabase/flavorsList available database flavors per compute class (vCPU, memory, pricing)
GET/api/v1/services/supabase/versionsList supported PostgreSQL versions

Path parameters: {supabaseName} is the instance name (1–40 characters, lowercase alphanumeric and hyphens, starting with a letter).

Fixed component footprint

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.

One-shot password reveal

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.

Backup policy

The create and update requests accept an optional backup object to configure scheduled snapshots of the database and file storage volumes together:

FieldTypeDefaultDescription
enabledbooleantrueRun scheduled snapshots.
schedulestring0 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.

Auth settings and file size limit

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​

MethodPathDescription
GET/api/v1/services/supabase/{supabaseName}/backupsList snapshots for an instance
POST/api/v1/services/supabase/{supabaseName}/backupsCreate 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}/restoreRestore 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.

Restore always creates a new instance

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.

MethodPathDescription
GET/api/v1/services/keycloakList all Keycloak instances
POST/api/v1/services/keycloakCreate 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-accessGet the public URL and admin console allow-list
PUT/api/v1/services/keycloak/{keycloakName}/public-accessUpdate the admin console allow-list (adminAllowedIPs)
GET/api/v1/services/keycloak/{keycloakName}/credentialsGet the admin console URL and admin username; the password is returned once
POST/api/v1/services/keycloak/{keycloakName}/credentials/resetSet a new admin password and return it once
GET/api/v1/services/keycloak/flavorsList flavors per compute class (vCPU, memory, price of one instance)
GET/api/v1/services/keycloak/versionsList supported Keycloak versions

Path parameters: {keycloakName} is the instance name (1–40 characters, lowercase alphanumeric and hyphens, starting with a letter).

Service dependencies

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.

MethodPathDescription
GET/api/v1/services/wordpressList all WordPress instances
POST/api/v1/services/wordpressCreate 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}/startStart a stopped instance
POST/api/v1/services/wordpress/{wordpressName}/stopStop a running instance
POST/api/v1/services/wordpress/{wordpressName}/restartRestart the instance
GET/api/v1/services/wordpress/{wordpressName}/credentialsGet admin URL and username (password returned once)
POST/api/v1/services/wordpress/{wordpressName}/credentials/resetReset the admin password and return it once
GET/api/v1/services/wordpress/flavorsList available flavors per compute class
GET/api/v1/services/wordpress/versionsList supported WordPress versions

Path parameters: {wordpressName} is the instance name (1–40 characters, lowercase alphanumeric and hyphens, starting with a letter).

Service dependencies

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​

MethodPathDescription
GET/api/v1/services/wordpress/{wordpressName}/backupsList paired backups
POST/api/v1/services/wordpress/{wordpressName}/backupsCreate 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}/restoreRestore 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.

MethodPathDescription
GET/api/v1/connectionsList all connections in the project
POST/api/v1/connectionsConnect a container to an existing service
POST/api/v1/connections/with-serviceCreate 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}/variablesGet the environment variables injected by this connection

Path parameters: {connectionId} is a UUID.

Access levels

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.

OpenSearch connections

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 connections

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.

MethodPathDescription
GET/api/v1/jobsList jobs (optional status query filter: pending, running, succeeded, failed, suspended)
POST/api/v1/jobsCreate 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}/statusGet current job status

Path parameters: {job} is the job name.

Group field

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.

Shared volume mounts

Jobs support sharedVolumeMounts in the create request body. See Volumes.

TTL after success

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).

Execution timeout

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.

MethodPathDescription
GET/api/v1/cronjobsList cronjobs (optional status filter: active, suspended)
POST/api/v1/cronjobsCreate 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}/runTrigger an immediate execution; returns the created execution (name, status) to track via /executions
POST/api/v1/cronjobs/{cronjob}/suspendSuspend scheduled executions
POST/api/v1/cronjobs/{cronjob}/resumeResume suspended executions
GET/api/v1/cronjobs/{cronjob}/configGet environment variables and mounted files
PUT/api/v1/cronjobs/{cronjob}/configUpdate environment variables and mounted files
GET/api/v1/cronjobs/{cronjob}/executionsList 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}/statusGet current status including next scheduled run

Path parameters: {cronjob} is the cronjob name.

Group field

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.

Shared volume mounts

CronJobs support sharedVolumeMounts in the create and update request bodies. See Volumes.

TTL on CronJob executions

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.

Execution timeout

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.

MethodPathDescription
POST/api/v1/stack/planDry-run — preview what would change without applying
POST/api/v1/stack/applyApply a stack definition to create, update, or delete resources
GET/api/v1/stack/exportExport 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.

MethodPathDescription
GET/api/v1/volumesList 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-volumesCreate 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.

MethodPathDescription
GET/api/v1/containers/{container}/volumes/{volume}/snapshotsList snapshots for a block volume
POST/api/v1/containers/{container}/volumes/{volume}/snapshotsCreate 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.

Snapshot properties

Each snapshot includes:

FieldTypeDescription
idstringUnique snapshot identifier
volumeNamestringLogical volume name this snapshot belongs to
statuspending | ready | errorCurrent snapshot status
typemanual | scheduledWhether the snapshot was created on-demand or by the automatic schedule
sizeBytesinteger (optional)Snapshot size in bytes when available
createdAtdate-timeCreation timestamp
readyAtdate-time (optional)When the snapshot became ready
createdBystring (optional)User ID that created the snapshot
errorstring (optional)Error message if the snapshot failed
restorablebooleanWhether 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.

MethodPathDescription
GET/api/v3/projects/{projectId}/alertsList alerts within a time window, most recent first
GET/api/v3/projects/{projectId}/alerts/summaryCount 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}/resolveResolve an alert

Path parameters: {projectId} is the project UUID; {alertId} is the alert UUID.

Query parameters for listing alerts

GET /api/v3/projects/{projectId}/alerts accepts the following optional query parameters:

ParameterTypeDescription
limitintegerMaximum number of alerts to return
offsetinteger (default 0)How many items to skip
sincedate-timeStart of the time window
untildate-timeEnd of the time window (defaults to request time; pass back the until of the first page to page through the same window)
severityarray of stringsFilter by severity: INFO, WARNING, ERROR, CRITICAL
resourceTypestringFilter 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)
resourceNamestringFilter by resource name
readbooleanOnly read or only unread alerts
resolvedbooleanOnly resolved or only open alerts

The summary endpoint accepts since, until, resourceType, and resourceName.

Read state

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.

MethodPathDescription
GET/api/v3/projects/{projectId}/notificationsList 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}/testSend a test notification through saved channels

Path parameters: {projectId} is the project UUID; {severity} is INFO, WARNING, or CRITICAL.

Merge-patch semantics

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.

Supported channels

Notification channels: webhook, slack, teams, discord, mattermost. The webhook channel also supports a custom name and headers for authentication.

Testing unsaved channels

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.

MethodPathDescription
GET/api/v3/organizations/{organizationId}/ticketsList support tickets for the organization
POST/api/v3/organizations/{organizationId}/ticketsOpen a new support ticket
GET/api/v3/organizations/{organizationId}/tickets/{ticketId}Get a support ticket
GET/api/v3/organizations/{organizationId}/tickets/{ticketId}/messagesList the messages of a ticket
POST/api/v3/organizations/{organizationId}/tickets/{ticketId}/messagesReply to a ticket (multipart, up to 5 files of 10 MB)
POST/api/v3/organizations/{organizationId}/tickets/{ticketId}/resolveResolve a ticket
POST/api/v3/organizations/{organizationId}/tickets/{ticketId}/reopenReopen a resolved or closed ticket

Path parameters: {organizationId} is the organization UUID; {ticketId} is the ticket UUID.

Authentication

Support ticket endpoints require a session cookie (signed-in user). API keys are not supported.

Query parameters for listing tickets

GET .../tickets accepts the following optional query parameters:

ParameterTypeDescription
limitinteger (1–100, default 50)Maximum number of tickets per page
cursorstringCursor returned by a previous page (nextCursor)
statusstringOnly tickets in this status: new, open, pending, resolved, closed
Creating a ticket

The POST request body (JSON) requires the following fields:

FieldTypeDescription
subjectstring (1–500 chars)Ticket subject
messagestringFirst message body
categorystringquestion, incident, or problem
prioritystringlow, normal, high, or urgent
projectIdUUIDThe project the ticket is about
resourceobject (optional)Affected resource: product (Container, Database, Cache, Gateway) and optional name
Replying to a ticket

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.

Reopening a ticket

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.

MethodPathDescription
PUT/api/v3/meSync your account (returns hasMemberships and trialAvailable)
POST/api/v3/me/trialStart your free trial (one per person, requires acceptedTermsVersion)
GET/api/v3/organization-name-suggestionSuggest an organization name
GET/api/v3/organizationsList 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}/billingGet billing details and balance

Path parameters: {organizationId} is the organization UUID.

Account sync and trial

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.

Query parameters for listing organizations

GET /api/v3/organizations accepts the following optional query parameters:

ParameterTypeDescription
limitintegerMaximum number of organizations to return
cursorstringCursor returned by a previous page (nextCursor)
phasearray of stringsOnly organizations in these phases: provisioning, onboarding, trial, active, restricted, blocked, archived
Organization detail response

GET /api/v3/organizations/{organizationId} returns:

FieldTypeDescription
idUUIDOrganization identifier
namestringOrganization name
typePERSONAL | ENTERPRISEOrganization type
stateobjectCurrent phase, message, trial end date, and grace period
createdAtdate-timeCreation timestamp
scopesarray of stringsWhat you may do in this organization, as collection:verb
supportLevelFREE | STARTER | BUSINESS | CUSTOMSupport plan
maxLogRetentionDaysinteger (optional)How far back the log explorer may look
remainingTrialCreditsinteger (optional)Trial allowance remaining in cents (present only during trial phase)
requirePaymentMethodbooleanWhether a payment method is needed before the organization can be used
billingCompletebooleanWhether all billing details needed to invoice are present
canArchivebooleanWhether 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.

Organization billing response

GET /api/v3/organizations/{organizationId}/billing requires the billing:read scope and returns:

FieldTypeDescription
emailstringWhere invoices are sent
creditsintegerAccount balance in cents
addressobject (optional)Billing address (street, city, postal code, country)
businessobject (optional)Business details for enterprise organizations (name, registration number, VAT)

Projects​

Query and inspect the projects within an organization via the v3 API.

MethodPathDescription
GET/api/v3/organizations/{organizationId}/projectsList 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.

Query parameters for listing projects

GET /api/v3/organizations/{organizationId}/projects accepts the following optional query parameters:

ParameterTypeDescription
limitintegerMaximum number of projects to return
cursorstringCursor returned by a previous page (nextCursor)
phasearray of stringsOnly projects in these phases: active, suspended, pendingDeletion
Project detail response

GET /api/v3/projects/{projectId} returns:

FieldTypeDescription
idUUIDProject identifier
namestringProject name
stateobjectCurrent phase and lifecycle details
scopesarray of stringsWhat you may do in this project, as collection:verb
createdAtdate-timeCreation timestamp
updatedAtdate-timeWhen 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.

MethodPathDescription
GET/api/v3/organizations/{organizationId}/auditList the organization's audit log (all projects)
GET/api/v3/projects/{projectId}/auditList the project's audit log

Path parameters: {organizationId} is the organization UUID; {projectId} is the project UUID.

Query parameters

Both endpoints accept the following optional query parameters:

ParameterTypeDescription
limitintegerMaximum number of entries to return
offsetinteger (default 0)How many entries to skip
sincedate-timeStart of the time window
untildate-timeEnd of the time window (defaults to request time; pass back the until of the first page to page through the same window)
actionarray of stringsOnly entries of these operations (up to 50)
actorTypestringOnly entries by actors of this type: user, api_key, or system
actorstringOnly entries by this actor (a user's id, or a key's label)
sourcestringOnly entries made through this channel: ui, mcp, public_api, internal, webhook, or cli

The project endpoint also accepts:

ParameterTypeDescription
targetKindstringOnly entries about resources of this kind (e.g. container, api_key)
targetstringOnly entries about the resource with this name
Response

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.

MethodPathDescriptionScope
GET/api/v1/ai/modelsList the models with the prices your organization is billed atai-models:list
GET/api/v1/ai/models/settingsGet the project's monthly budget and allowed modelsai-models:get
PUT/api/v1/ai/models/settingsReplace the monthly budget (monthlyBudgetEur) and the allowed models (allowedModels, empty allows every model)ai-models:update
GET/api/v1/ai/models/usageToken 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/daysToken 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.

MethodPathDescriptionScope
GET/api/v1/sandboxesList the agent sandboxes of the projectcontainers:list
POST/api/v1/sandboxesCreate an agent sandboxcontainers:update
GET/api/v1/sandboxes/{name}Get sandbox detailscontainers:list
GET/api/v1/sandboxes/{name}/settingsGet the idle timeout, SSH public keys and network settingscontainers:list
PUT/api/v1/sandboxes/{name}/settingsUpdate settings (idle timeout, SSH keys, network isolation, software)containers:update
POST/api/v1/sandboxes/{name}/execRun a command in the sandboxsandboxes:exec

Path parameters: {name} is the sandbox name.

Exec details

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.

MethodPathDescriptionScope
GET/api/v1/ai/agentsList the managed AI agents of the projectai-agents:list
POST/api/v1/ai/agentsCreate a managed AI agentai-agents:update
GET/api/v1/ai/agents/{agentName}Get an AI agentai-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 volumeai-agents:update
POST/api/v1/ai/agents/{agentName}/startStart a stopped AI agentai-agents:update
POST/api/v1/ai/agents/{agentName}/stopStop an AI agent (volume billing remains)ai-agents:update
POST/api/v1/ai/agents/{agentName}/restartRestart an AI agentai-agents:update
GET/api/v1/ai/agents/{agentName}/credentialsReveal the UI credential (once)ai-agents:update
POST/api/v1/ai/agents/{agentName}/credentials/resetReset the UI credential and restart the agentai-agents:update
PUT/api/v1/ai/agents/{agentName}/secretsSet or remove the write-only secrets (model API key, channel tokens)ai-agents:update
POST/api/v1/ai/agents/{agentName}/models-bindingPoint the agent at SailOps Models (creates or rotates a project API key)ai-agents:update + ai-models:invoke
GET/api/v1/ai/agents/flavorsList compute flavors with eligible enginesai-agents:list
GET/api/v1/ai/agents/enginesList agent engines, versions and expected secretsai-agents:list

Path parameters: {agentName} is the agent name (1–40 characters, lowercase alphanumeric and hyphens).

Trial restriction

AI agents are not available during the trial. Creating an agent on a trial organization is refused.

Write-only secrets

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.

MethodPathDescriptionAuth
GET/api/v1/plansGet the public support plan catalogNo

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:

FieldTypeDescription
levelstringSupport level (FREE, STARTER, BUSINESS, CUSTOM)
namestringProduct name of the plan
availabilitystringSELF_SERVE or CONTACT_SALES
priceCentsinteger (optional)Monthly base price in euro cents
spendRationumber (optional)Hybrid pricing ratio: plan is invoiced at max(base price, spendRatio x usage)
logRetentionDaysinteger (optional)Log retention in days
metricRetentionDaysinteger (optional)Metric retention in days
includedLogGiBinteger (optional)Included log volume per month in GiB
includedMetricSamplesMonthlyinteger (optional)Included metric samples per month
includedMetricActiveSeriesinteger (optional)Included active metric series
includedTraceSpansMonthlyinteger (optional)Included trace spans per month
includedStorageGiBMonthinteger (optional)Included storage in GiB-month
metricSamplesRateLimitPerSecondinteger (optional)Metric sample ingestion rate limit
metricSamplesBillingEnforcementModestringHARD_CAP or BILL_OVERAGE
featuresarrayList of plan features (see below)

Each feature object contains:

FieldTypeDescription
keystringStable feature identifier (e.g. sla.uptimePercent, support.responseTimeHours)
includedbooleanWhether the feature is included in the plan
valuenumber (optional)Magnitude in the unit fixed by the key

Pricing​

No authentication required.

MethodPathDescriptionAuth
GET/api/v1/pricingGet public pricing for compute, jobs, storage, load balancers, databases, managed services, and websitesNo

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):

FieldSub-fieldDescription
websiteStoragepricePerGiBHourWebsite S3 storage price per GiB-hour
sharedVolumeStoragepricePerGiBHourShared volume storage price per GiB-hour
objectStoragestoragePricePerGiBMonthObject Storage price per GiB-month stored
objectStoragewritePricePerMillionObject Storage price per million write and listing requests
objectStoragereadPricePerMillionObject Storage price per million read and HEAD requests
objectStoragedownloadPricePerGiBObject Storage price per GiB downloaded
logStorageoveragePricePerGiBMonthLog storage overage price per GiB-month
backupStoragepricePerGiBMonthBackup storage price per GiB-month
observabilitymetricSamplesPricePerMillionMetric sample price per million
observabilitytraceSpansPricePerMillionTrace span price per million
observabilitystoragePricePerGiBMonthObservability storage price per GiB-month

Resources​

Query, tag, and delete resources across all types in a project. See Resource tags for details.

MethodPathDescription
GET/api/v1/resourcesList resources with optional tag filters and pagination
PUT/api/v1/resources/{resourceId}/tagsReplace 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.

Query parameters for listing resources

GET /api/v1/resources accepts the following optional query parameters:

ParameterTypeDescription
tagstring (repeatable)Filter by tag, format key=value; all filters must match
kindstringFilter 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)
limitinteger (1–200, default 100)Page size
cursorUUIDCursor from nextCursor of a previous page
Resource tags on creation

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.

Optimistic concurrency for tag updates

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 safety

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 HTTP 503.

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
Volume Constraints

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