Aller au contenu principal

Référence des endpoints

Tous les endpoints de l'API publique SailOps, organisés par catégorie de ressource.

URL de base : https://app.sailops.io/api/public/api/v1

Toutes les requêtes, sauf les plans et la lecture des tarifs, exigent l'en-tête X-Api-Key. Consultez la vue d'ensemble de l'API publique pour l'authentification.


Santé​

MéthodeCheminDescriptionAuth
GET/statusVérifie la santé de l'API — retourne 204 No Content si le service est opérationnelNon

Conteneurs​

Gérez le cycle de vie complet des conteneurs Docker dans votre projet.

MéthodeCheminDescription
GET/api/v1/containersLister les conteneurs du projet
POST/api/v1/containersCréer un conteneur
GET/api/v1/containers/{container}Lire les détails d'un conteneur
PUT/api/v1/containers/{container}Remplacer la spec complète (image, ressources, classe de calcul)
PATCH/api/v1/containers/{container}(Déprécié) Mettre à jour partiellement — utilisez PATCH /api/v2/containers/{container}
PATCH/api/v2/containers/{container}Mettre à jour spec et configuration en un seul rollout atomique
DELETE/api/v1/containers/{container}Supprimer un conteneur et ses ressources
GET/api/v1/containers/{container}/configLire les variables d'environnement et fichiers montés
PUT/api/v1/containers/{container}/config(Déprécié) Remplacer la configuration. Les instances en cours gardent leur configuration actuelle jusqu'au redémarrage, démarrage ou redéploiement ; PATCH /api/v2 l'applique immédiatement
POST/api/v1/containers/{container}/startDémarrer un conteneur arrêté
POST/api/v1/containers/{container}/stopArrêter un conteneur en cours d'exécution
POST/api/v1/containers/{container}/restartRedémarrer toutes les instances d'un conteneur. Applique la configuration enregistrée avec PUT /config depuis le dernier rollout
GET/api/v1/containers/{container}/logsLire les logs avec filtrage et pagination

Paramètres de chemin : {container} est le nom du conteneur (ex. my-api).

Champs de la réponse détaillée d'un conteneur

GET /api/v1/containers/{container} retourne des informations de diagnostic en plus de la spec du conteneur :

ChampTypeDescription
statusMessagestring (optionnel)Raison pour laquelle le conteneur est dans son statut actuel
diagnosticobject (optionnel)Le problème le plus pertinent observé sur les instances du conteneur

L'objet diagnostic, lorsqu'il est présent, contient :

ChampTypeDescription
reasonstringCause lisible par une machine (ex. CrashLoopBackOff, OOMKilled, ImagePullBackOff)
summarystringDescription courte et lisible
detailstringPreuve nettoyée rapportée par le runtime
suggestionsstring[]Conseils pour résoudre le problème
activebooleanIndique si le problème bloque actuellement une instance
observedAtdate-timeDate de la dernière observation du problème
exitCodeinteger (optionnel)Code de sortie du processus, le cas échéant
Paramètres de requête des logs conteneur

GET /api/v1/containers/{container}/logs accepte les paramètres de requête optionnels suivants :

ParamètreTypeDescription
linesinteger (≤ 1000, défaut 100)Nombre de lignes de logs à retourner
offsetinteger (défaut 0)Nombre de lignes à sauter — à utiliser avec total pour la pagination
instanceNamestringFiltrer sur une instance pod spécifique (voir instances dans la réponse)
querystringRecherche libre sur le message de log
start / enddate-time ISO 8601Fenêtre temporelle (ex. 2024-02-03T15:00:00Z) ; appliquer les deux ensemble
streamstdout | stderrFiltrer par flux de sortie
initboolean (défaut false)Retourner les logs de l'init-container au lieu du conteneur principal

La réponse contient items (les entrées de log, chacune avec timestamp, message, instance, containerImage), instances (instances pod distinctes dans les logs correspondants) et total (nombre total de lignes correspondant au filtre, indépendant de la pagination). Les fenêtres temporelles sont limitées à la rétention de logs de votre plan.

Montages de volumes partagés

Les conteneurs supportent sharedVolumeMounts dans les requêtes de création (POST) et mise à jour (PUT/PATCH). Ce champ est un tableau d'objets { volumeName, mountPath, readOnly } référençant des volumes partagés existants dans le projet. Voir Volumes pour la gestion des volumes partagés.

Migration : utilisez PATCH v2 pour le CI/CD

PATCH /api/v1/containers/{container} et PUT /api/v1/containers/{container}/config sont dépréciés. Utilisez PATCH /api/v2/containers/{container} — il met à jour la spec du conteneur et remplace la configuration en un seul rollout atomique.

Les champs de spec fusionnent individuellement (les champs omis restent inchangés). Dans config, chaque liste est traitée séparément : une liste omise est laissée intacte, une liste envoyée remplace intégralement cette liste, et une liste vide la purge. À l'intérieur d'une liste envoyée, l'omission supprime toujours.

CorpsEnvironnementFichiers
config omisinchangéinchangé
"config": {}inchangéinchangé
"config": {"environment": [...]}remplacéinchangé
"config": {"files": [...]}inchangéremplacé
"config": {"files": []}inchangépurgé
"config": {"environment": [], "files": []}purgépurgé

Une clé inconnue dans config est rejetée par un 400 REQUEST_VALIDATION au lieu d'être ignorée : un nom de liste mal orthographié échoue bruyamment plutôt que de ne rien modifier.

Les valeurs secret ne sont jamais renvoyées par GET : envoyez une entrée secret sans valeur pour conserver celle qui est stockée.

Les noms de fichiers montés doivent être des labels RFC 1123 en minuscules (^[a-z0-9]([-a-z0-9]*[a-z0-9])?$), de 56 caractères maximum, et uniques au sein du conteneur. Voir Configuration des Conteneurs — Règles de nommage.

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

Le endpoint v2 supporte aussi initContainers (jusqu'à 10, remplaçant les champs dépréciés initImage/initCommand) et spotFallbackEnabled (contrôle le fallback automatique Spot vers Eco).

initContainers suit la même règle absent/présent/vide que les listes dans config : omettre le champ laisse les init containers existants inchangés, envoyer une liste les remplace tous, et envoyer la liste vide [] les purge.

PUT /api/v1/containers/{container} applique toujours la spec complète du conteneur — tout champ optionnel non inclus dans le corps de la requête sera supprimé. Utilisez GET-puis-PUT si vous avez besoin d'un remplacement complet tout en préservant les paramètres existants.


Websites​

Hébergez des sites statiques HTML ou PHP avec stockage géré et HTTPS automatique.

MéthodeCheminDescription
GET/api/v1/websitesLister les sites du projet
POST/api/v1/websitesCréer un site statique ou PHP
GET/api/v1/websites/{websiteName}Lire les détails d'un site
PATCH/api/v1/websites/{websiteName}Mettre à jour les paramètres (plan, domaine, pathPrefix, Git Sync, etc.)
DELETE/api/v1/websites/{websiteName}Supprimer un site et toutes ses ressources
POST/api/v1/websites/{websiteName}/startDémarrer un site arrêté
POST/api/v1/websites/{websiteName}/stopArrêter un site (scale à 0 réplicas)
PUT/api/v1/websites/{websiteName}/domainConfigurer un domaine personnalisé (avec nom de gateway et préfixe de chemin optionnel)
DELETE/api/v1/websites/{websiteName}/domainRetirer le domaine personnalisé
GET/api/v1/websites/{websiteName}/filesLister les fichiers et répertoires (paramètre : path)
DELETE/api/v1/websites/{websiteName}/filesSupprimer un fichier (paramètre : path)
POST/api/v1/websites/{websiteName}/files/directoriesCréer un répertoire (corps JSON : path)
GET/api/v1/websites/{websiteName}/files/statsLire l'utilisation du stockage
POST/api/v1/websites/{websiteName}/files/upload-urlObtenir une URL d'envoi présignée (corps JSON : path, contentType optionnel)
GET/api/v1/websites/{websiteName}/files/download-urlObtenir une URL de téléchargement présignée (paramètre : path)
POST/api/v1/websites/{websiteName}/files/deployDéployer une archive ZIP à la racine du site

Paramètres de chemin : {websiteName} est le nom du site (ex. my-site).


Gateways​

Gérez les load balancers et les domaines (listeners) qui y sont attachés.

MéthodeCheminDescription
GET/api/v1/gatewaysLister les gateways du projet
POST/api/v1/gatewaysCréer une gateway
GET/api/v1/gateways/{gateway}Lire les détails d'une gateway
DELETE/api/v1/gateways/{gateway}Supprimer une gateway et toutes ses routes
GET/api/v1/gateways/{gateway}/domainsLister les domaines d'une gateway
POST/api/v1/gateways/{gateway}/domainsAjouter un domaine (listener) à une gateway
DELETE/api/v1/gateways/{gateway}/domains/{hostname}Retirer un domaine d'une gateway

Paramètres de chemin : {gateway} est le nom de la gateway ; {hostname} est le domaine à retirer.


Routes​

Les routes HTTP, TCP, gRPC et TLS sont imbriquées sous une gateway.

MéthodeCheminDescription
GET/api/v1/gateways/{gateway}/routesLister les routes d'une gateway
POST/api/v1/gateways/{gateway}/routesCréer une route (HTTPRoute, TCPRoute, GRPCRoute, TLSRoute)
GET/api/v1/gateways/{gateway}/routes/{route}Lire les détails d'une route
PUT/api/v1/gateways/{gateway}/routes/{route}Mettre à jour une route
DELETE/api/v1/gateways/{gateway}/routes/{route}Supprimer une route

Paramètres de chemin : {gateway} est le nom de la gateway ; {route} est le nom de la route.


Services — PostgreSQL​

MéthodeCheminDescription
GET/api/v1/services/postgresqlLister les services PostgreSQL
POST/api/v1/services/postgresqlCréer un service PostgreSQL (versions : 16, 17)
GET/api/v1/services/postgresql/{service}Lire les détails d'un service PostgreSQL
PUT/api/v1/services/postgresql/{service}Mettre à jour le flavor, la classe de calcul, le stockage, le pooling ou la mesure des E/S
DELETE/api/v1/services/postgresql/{service}Supprimer un service PostgreSQL
Champ databases obligatoire

La requête POST (création) exige un tableau databases contenant au moins un nom de base de données (ex. ["app"]). La requête sera rejetée si databases est absent ou vide.

Champs de statut du cycle de vie

Les réponses des services PostgreSQL incluent deux champs en lecture seule pour le suivi du cycle de vie :

ChampTypeDescription
lifecyclePendingboolean (obligatoire)true tant qu'une tâche durable de CREATE, RESTORE ou DELETE bloque les mutations. Un statut Ready seul ne garantit pas que les mutations sont possibles — attendez que ce champ passe à false.
statusMessagestring (optionnel)Détail de l'opérateur sur l'état actuel du cycle de vie, y compris le provisionnement en arrière-plan ou les informations de nouvelle tentative.
Connection pooling (PgBouncer)

Les services PostgreSQL supportent un PgBouncer managé optionnel. Incluez l'objet connectionPooling dans la requête de création ou de mise à jour :

ChampTypeDéfautDescription
enabledbooleanfalseActiver ou désactiver PgBouncer
modesession | transactionsessionMode de pooling
instancesinteger (1–5)1Nombre d'instances PgBouncer
maxClientConnectionsinteger (1–10 000)500Connexions client maximum
defaultPoolSizeinteger (1–1 000)20Taille de pool par défaut par paire base/utilisateur
reservePoolSizeinteger (0–1 000)5Taille du pool de réserve

Lorsqu'il est activé, la réponse inclut un objet pooledConnectionInfo avec host, port et database pour le endpoint poolé.

Classe de stockage immuable

Le champ storageClass (standard ou performance) est fixé à la création. Un PUT qui modifie la classe de stockage est rejeté. La taille du stockage ne peut être qu'augmentée, jamais réduite.

Limite de bases de données logiques

Une instance PostgreSQL contient au maximum 10 bases de données logiques (y compris celle créée avec l'instance). La création d'une base supplémentaire au-delà de cette limite est rejetée avec 409 Conflict.


Services — Sauvegardes PostgreSQL​

MéthodeCheminDescription
GET/api/v1/services/postgresql/{service}/backupsLister les sauvegardes (paramètres : limit, offset)
POST/api/v1/services/postgresql/{service}/backupsCréer une sauvegarde à la demande
GET/api/v1/services/postgresql/{service}/backups/{backupId}Lire les détails d'une sauvegarde
GET/api/v1/services/postgresql/{service}/backups/{backupId}/downloadObtenir une URL de téléchargement présignée

Paramètres de chemin : {service} est le nom du service ; {backupId} est l'identifiant de la sauvegarde.


Services — MariaDB​

MéthodeCheminDescription
GET/api/v1/services/mariadbLister les services MariaDB
POST/api/v1/services/mariadbCréer un service MariaDB (version : 11.4)
GET/api/v1/services/mariadb/{service}Lire les détails d'un service MariaDB
PUT/api/v1/services/mariadb/{service}Mettre à jour le flavor, la classe de calcul ou le stockage
DELETE/api/v1/services/mariadb/{service}Supprimer un service MariaDB
Champ databases obligatoire

La requête POST (création) exige un tableau databases contenant au moins un nom de base de données (ex. ["app"]). La requête sera rejetée si databases est absent ou vide.

Champs de statut du cycle de vie

Les réponses des services MariaDB incluent deux champs en lecture seule pour le suivi du cycle de vie :

ChampTypeDescription
lifecyclePendingboolean (obligatoire)true tant qu'une tâche durable de CREATE ou DELETE bloque les mutations. Un statut Running seul ne garantit pas que les mutations sont possibles — attendez que ce champ passe à false.
statusMessagestring (optionnel)Détail de l'opérateur sur l'état actuel du cycle de vie, y compris le provisionnement en arrière-plan ou les informations de nouvelle tentative.

Pendant qu'une tâche de CREATE est active, le tableau databases inclut également les noms de bases de données logiques demandés dont les enfants opérateur ne sont pas encore visibles.


Services — Sauvegardes MariaDB​

MéthodeCheminDescription
GET/api/v1/services/mariadb/{service}/backupsLister les sauvegardes (paramètres : limit, offset)
POST/api/v1/services/mariadb/{service}/backupsCréer une sauvegarde à la demande
GET/api/v1/services/mariadb/{service}/backups/{backupId}Lire les détails d'une sauvegarde
GET/api/v1/services/mariadb/{service}/backups/{backupId}/downloadObtenir une URL de téléchargement présignée

Paramètres de chemin : {service} est le nom du service ; {backupId} est l'identifiant de la sauvegarde.


Services — Valkey​

MéthodeCheminDescription
GET/api/v1/services/valkeyLister les services Valkey (compatibles Redis)
POST/api/v1/services/valkeyCréer un service Valkey (version : 9, 1–6 réplicas)
GET/api/v1/services/valkey/{service}Lire les détails d'un service Valkey
PUT/api/v1/services/valkey/{service}Mettre à jour le flavor, la classe de calcul, la persistance ou la taille du stockage
DELETE/api/v1/services/valkey/{service}Supprimer un service Valkey
Nombre de réplicas immuable

Le nombre de réplicas (nœuds du cluster) est fixé à la création. Un PUT qui modifie le champ replicas est rejeté avec 409 Conflict. Le stockage ne peut être qu'augmenté, jamais réduit — une demande de réduction est rejetée avec 400.


Services — NATS​

MéthodeCheminDescription
GET/api/v1/services/natsLister les services NATS
POST/api/v1/services/natsCréer un service NATS (versions : 2.10, 2.11, 2.12 ; 1–7 réplicas)
GET/api/v1/services/nats/{service}Lire les détails d'un service NATS
PUT/api/v1/services/nats/{service}Mettre à jour le flavor, la classe de calcul ou les réplicas
DELETE/api/v1/services/nats/{service}Supprimer un service NATS

Paramètres de chemin pour tous les endpoints de services : {service} est le nom du service.


Services — Kafka​

Gérez les clusters Apache Kafka pour le streaming d'événements durable. Voir le guide Kafka pour l'architecture et les détails opérationnels.

MéthodeCheminDescription
GET/api/v1/services/kafkaLister les clusters Kafka
POST/api/v1/services/kafkaCréer un cluster Kafka (1 ou 3 nœuds, mode KRaft)
GET/api/v1/services/kafka/{clusterName}Lire les détails d'un cluster
PUT/api/v1/services/kafka/{clusterName}Mettre à jour le flavor, la classe de calcul ou le stockage
DELETE/api/v1/services/kafka/{clusterName}Supprimer un cluster
GET/api/v1/services/kafka/{clusterName}/topicsLister les topics
POST/api/v1/services/kafka/{clusterName}/topicsCréer un topic
PUT/api/v1/services/kafka/{clusterName}/topics/{topicName}Mettre à jour un topic (les partitions ne peuvent qu'augmenter)
DELETE/api/v1/services/kafka/{clusterName}/topics/{topicName}Supprimer un topic
GET/api/v1/services/kafka/{clusterName}/usersLister les utilisateurs SCRAM
POST/api/v1/services/kafka/{clusterName}/usersCréer un utilisateur SCRAM (mot de passe renvoyé une seule fois)
PUT/api/v1/services/kafka/{clusterName}/users/{userName}Modifier le niveau d'accès d'un utilisateur
DELETE/api/v1/services/kafka/{clusterName}/users/{userName}Supprimer un utilisateur
POST/api/v1/services/kafka/{clusterName}/users/{userName}/regenerate-passwordRégénérer le mot de passe d'un utilisateur
GET/api/v1/services/kafka/flavorsLister les flavors disponibles par classe de calcul
GET/api/v1/services/kafka/versionsLister les versions Kafka supportées

Paramètres de chemin : {clusterName} est le nom du cluster ; {topicName} est le nom du topic ; {userName} est le nom de l'utilisateur.

Nombre de nœuds immuable

Le nombre de nœuds (1 ou 3) est fixé à la création. Le stockage ne peut être qu'augmenté ; la classe de stockage est fixée à la création. Les organisations en période d'essai ne peuvent pas provisionner Kafka.

Connexion

Le plus simple pour connecter un conteneur ou un job est une connexion. Sélectionnez Apache Kafka comme cible et choisissez un niveau d'accès. La connexion injecte KAFKA_BOOTSTRAP_SERVERS, KAFKA_SECURITY_PROTOCOL, KAFKA_SASL_MECHANISM, KAFKA_USERNAME et KAFKA_PASSWORD.


Services — OpenSearch​

Gérez les clusters OpenSearch pour la recherche plein texte et l'analyse. Voir le guide OpenSearch pour l'architecture et les détails opérationnels.

MéthodeCheminDescription
GET/api/v1/services/opensearchLister les clusters OpenSearch
POST/api/v1/services/opensearchCréer un cluster OpenSearch (version : 3.8.0 ; 3 nœuds fixes)
GET/api/v1/services/opensearch/{clusterName}Lire les détails d'un cluster
PUT/api/v1/services/opensearch/{clusterName}Mettre à jour le flavor, la classe de calcul, le stockage ou la politique de sauvegarde
DELETE/api/v1/services/opensearch/{clusterName}Supprimer un cluster
GET/api/v1/services/opensearch/{clusterName}/public-accessLire les paramètres d'accès public
PUT/api/v1/services/opensearch/{clusterName}/public-accessMettre à jour l'accès public (activation, IPs autorisées)
GET/api/v1/services/opensearch/{clusterName}/dashboardsLire les paramètres de Dashboards
PUT/api/v1/services/opensearch/{clusterName}/dashboardsMettre à jour Dashboards (activation, accès public)
GET/api/v1/services/opensearch/{clusterName}/credentialsLire les identifiants du cluster (utilisateur, certificat CA, endpoint ; mot de passe renvoyé une seule fois)
POST/api/v1/services/opensearch/{clusterName}/credentials/resetRéinitialiser les identifiants du cluster (réarme la révélation unique du mot de passe)
GET/api/v1/services/opensearch/flavorsLister les flavors disponibles par classe de calcul (vCPU, mémoire, tarification par nœud)
GET/api/v1/services/opensearch/versionsLister les versions du moteur supportées

Paramètres de chemin : {clusterName} est le nom du cluster (1–40 caractères, alphanumérique minuscule et tirets).

Topologie à trois nœuds fixe

Chaque cluster utilise exactement trois nœuds. Le nombre de nœuds n'est pas configurable. Le stockage ne peut être qu'augmenté (minimum 20 Gio par nœud), et la classe de stockage (standard ou performance) est fixée à la création. La classe de calcul (eco, standard ou production) peut être modifiée après création ; la mise à jour replanifie les nœuds un par un.

Mot de passe à révélation unique

GET .../credentials renvoie le champ password uniquement lors du premier appel. Les lectures suivantes renvoient username, caCertificate, endpoint et passwordRevealed: true, mais omettent password. Appelez POST .../credentials/reset pour effectuer une rotation du mot de passe et réarmer la révélation unique.

Politique de sauvegarde

Les requêtes de création et de mise à jour acceptent un objet backup optionnel pour configurer les snapshots planifiés :

ChampTypeDéfautDescription
enabledbooleantrueExécuter les snapshots planifiés. Les clusters existants les conservent actifs sauf désactivation explicite.
schedulestring0 2 * * *Expression cron à cinq champs en UTC.

Le stockage des snapshots est facturé comme stockage de sauvegarde, à l'identique des autres bases de données. Les snapshots manuels restent disponibles quel que soit ce paramètre.


Services — Sauvegardes OpenSearch​

MéthodeCheminDescription
GET/api/v1/services/opensearch/{clusterName}/backupsLister les snapshots d'un cluster
POST/api/v1/services/opensearch/{clusterName}/backupsCréer un snapshot à la demande (corps : name)
DELETE/api/v1/services/opensearch/{clusterName}/backups/{backupName}Supprimer un snapshot
POST/api/v1/services/opensearch/{clusterName}/backups/{backupName}/restoreRestaurer un snapshot dans un nouveau cluster (corps : name, flavor et storage optionnels)

Paramètres de chemin : {clusterName} est le nom du cluster ; {backupName} est le nom du snapshot.


Services — Supabase​

Gérez les instances Supabase managées : une base de données PostgreSQL avec Auth, REST, GraphQL, Realtime et Storage derrière un seul point d'accès. Voir le guide Supabase pour le contenu inclus et les détails opérationnels.

MéthodeCheminDescription
GET/api/v1/services/supabaseLister les instances Supabase
POST/api/v1/services/supabaseCréer une instance Supabase
GET/api/v1/services/supabase/{supabaseName}Lire les détails d'une instance
PUT/api/v1/services/supabase/{supabaseName}Mettre à jour le flavor, la classe de calcul, le stockage, la taille maximale des fichiers, l'accès public, la politique de sauvegarde, Studio ou les paramètres Auth
DELETE/api/v1/services/supabase/{supabaseName}Supprimer une instance, sa base de données et ses fichiers stockés
GET/api/v1/services/supabase/{supabaseName}/public-accessLire les paramètres d'accès public
PUT/api/v1/services/supabase/{supabaseName}/public-accessMettre à jour l'accès public (activation, IPs autorisées)
GET/api/v1/services/supabase/{supabaseName}/credentialsLire les identifiants (endpoint, clés API et leurs équivalents JWT historiques, nom d'utilisateur Studio, informations de connexion à la base, clés S3 de Storage ; mots de passe renvoyés une seule fois)
POST/api/v1/services/supabase/{supabaseName}/credentials/resetRéinitialiser les mots de passe Studio et base de données (réarme la révélation unique) ; les clés API ne sont jamais tournées
GET/api/v1/services/supabase/flavorsLister les flavors de base de données disponibles par classe de calcul (vCPU, mémoire, tarification)
GET/api/v1/services/supabase/versionsLister les versions PostgreSQL supportées

Paramètres de chemin : {supabaseName} est le nom de l'instance (1–40 caractères, alphanumérique minuscule et tirets, commençant par une lettre).

Empreinte fixe des composants

Auth, REST, GraphQL, Realtime, Storage et la passerelle API s'exécutent avec une empreinte fixe de 1 350 mCPU et 1 152 Mio de mémoire, facturée aux tarifs de la classe de calcul de l'instance en plus du prix de la base de données (componentsCpuMilli, componentsMemoryMiB et componentsPricePerHour dans la réponse des flavors). Tant que Studio est activé, Studio et le service de métadonnées de la base ajoutent studioComponentsCpuMilli, studioComponentsMemoryMiB et studioComponentsPricePerHour, ainsi qu'un volume de studioVolumeMiB sur la classe de stockage de l'instance. Les prix des flavors sont ceux de votre organisation. Seuls le flavor et la classe de calcul de la base, ainsi que les tailles de stockage de la base et des fichiers, sont modifiables par le client. Le stockage ne peut qu'augmenter ; la classe de stockage (standard ou performance) est fixée à la création et s'applique aux deux volumes. La classe de calcul peut être modifiée après création.

Mot de passe à révélation unique

GET .../credentials renvoie les champs studioPassword et databasePassword uniquement lors du premier appel après la création ou une réinitialisation. Les lectures suivantes les omettent mais renvoient secretsRevealed: true. Les clés API publiable et secrète sont toujours renvoyées et ne sont jamais tournées par une réinitialisation des identifiants — leur rotation casserait immédiatement tous les clients déjà connectés. Appelez POST .../credentials/reset pour obtenir de nouveaux mots de passe Studio et base de données ; l'instance redémarre ses composants pour prendre en compte le nouveau mot de passe, ce qui prend environ une à deux minutes.

Politique de sauvegarde

Les requêtes de création et de mise à jour acceptent un objet backup optionnel pour configurer les snapshots planifiés des volumes de la base de données et du stockage de fichiers, pris ensemble :

ChampTypeDéfautDescription
enabledbooleantrueExécuter les snapshots planifiés.
schedulestring0 2 * * *Expression cron à cinq champs en UTC.

Le stockage des snapshots est facturé comme stockage de sauvegarde, à l'identique des autres bases de données. Les snapshots manuels restent disponibles quel que soit ce paramètre.

Paramètres Auth et taille maximale des fichiers

Les requêtes de création et de mise à jour acceptent un objet auth optionnel : siteUrl, redirectUrls (jusqu'à 20 URL ou motifs), signupDisabled (true par défaut à la création ; l'omettre lors d'une mise à jour conserve la valeur actuelle), smtp (host, port, username, password, senderEmail, senderName) et providers (provider, clientId, secret). smtp.password et le secret de chaque fournisseur sont en écriture seule : les réponses renvoient à la place passwordConfigured et secretConfigured ; les omettre lors d'une mise à jour conserve la valeur enregistrée ; un smtp.password vide supprime le mot de passe, et retirer un fournisseur supprime son secret. Sans smtp, Auth n'envoie aucun e-mail et confirme automatiquement les nouveaux comptes par e-mail. fileStorage.maxFileSizeMiB fixe la taille maximale d'un envoi accepté par l'API Storage (50 par défaut, 5120 au maximum). Voir Authentification.


Services — Sauvegardes Supabase​

MéthodeCheminDescription
GET/api/v1/services/supabase/{supabaseName}/backupsLister les snapshots d'une instance
POST/api/v1/services/supabase/{supabaseName}/backupsCréer un snapshot à la demande (corps : name)
GET/api/v1/services/supabase/{supabaseName}/backups/{backupName}Lire les détails d'un snapshot
DELETE/api/v1/services/supabase/{supabaseName}/backups/{backupName}Supprimer un snapshot
POST/api/v1/services/supabase/{supabaseName}/backups/{backupName}/restoreRestaurer un snapshot dans une nouvelle instance qui conserve les clés API de l'instance source (corps : name, flavor, storage et fileStorage optionnels)

Paramètres de chemin : {supabaseName} est le nom de l'instance ; {backupName} est le nom du snapshot.

La restauration crée toujours une nouvelle instance

Une restauration n'écrase jamais l'instance source. Les champs omis dans la requête de restauration héritent de la configuration de l'instance source, et les tailles storage/fileStorage doivent être au moins aussi grandes que celles de la source — jamais plus petites.


Services — Keycloak​

Gérez les fournisseurs d'identité Keycloak managés. Chaque instance stocke ses données dans un service PostgreSQL du projet. Voir le guide Keycloak pour les détails opérationnels.

MéthodeCheminDescription
GET/api/v1/services/keycloakLister les instances Keycloak
POST/api/v1/services/keycloakCréer une instance sur un service PostgreSQL existant (database.existing) ou nouveau (database.create)
GET/api/v1/services/keycloak/{keycloakName}Obtenir les détails, les URL et les dépendances d'une instance
PUT/api/v1/services/keycloak/{keycloakName}Modifier le nombre d'instances, le flavor, la classe de calcul ou la liste d'accès à la console d'administration
DELETE/api/v1/services/keycloak/{keycloakName}Supprimer une instance et sa base dédiée ; ?deleteDatabaseService=true supprime aussi un service PostgreSQL créé avec elle et utilisé par rien d'autre
GET/api/v1/services/keycloak/{keycloakName}/public-accessObtenir l'URL publique et la liste d'accès à la console d'administration
PUT/api/v1/services/keycloak/{keycloakName}/public-accessModifier la liste d'accès à la console d'administration (adminAllowedIPs)
GET/api/v1/services/keycloak/{keycloakName}/credentialsObtenir l'URL de la console et le nom de l'administrateur ; le mot de passe n'est renvoyé qu'une fois
POST/api/v1/services/keycloak/{keycloakName}/credentials/resetDéfinir un nouveau mot de passe administrateur et le renvoyer une fois
GET/api/v1/services/keycloak/flavorsLister les flavors par classe de calcul (vCPU, mémoire, prix d'une instance)
GET/api/v1/services/keycloak/versionsLister les versions de Keycloak prises en charge

Paramètres de chemin : {keycloakName} est le nom de l'instance (1 à 40 caractères, minuscules, chiffres et tirets, commençant par une lettre).

Dépendances entre services

Supprimer un service PostgreSQL utilisé par une instance Keycloak renvoie 409 CONFLICT avec un tableau dependents listant les services qui l'utilisent. Supprimez d'abord ces services.


Services — WordPress​

Gérez les instances WordPress avec contenu persistant, une base dédiée sur un service MariaDB et HTTPS automatique. Voir le guide WordPress pour les détails opérationnels.

MéthodeCheminDescription
GET/api/v1/services/wordpressLister les instances WordPress
POST/api/v1/services/wordpressCréer une instance WordPress sur un service MariaDB existant ou nouveau
GET/api/v1/services/wordpress/{wordpressName}Lire les détails d'une instance
PUT/api/v1/services/wordpress/{wordpressName}Mettre à jour le flavor, la classe de calcul, le stockage, la politique de sauvegarde, la version ou le domaine personnalisé
DELETE/api/v1/services/wordpress/{wordpressName}Supprimer une instance WordPress et sa base dédiée
POST/api/v1/services/wordpress/{wordpressName}/startDémarrer une instance arrêtée
POST/api/v1/services/wordpress/{wordpressName}/stopArrêter une instance en cours d'exécution
POST/api/v1/services/wordpress/{wordpressName}/restartRedémarrer l'instance
GET/api/v1/services/wordpress/{wordpressName}/credentialsLire l'URL d'administration et le nom d'utilisateur (mot de passe renvoyé une seule fois)
POST/api/v1/services/wordpress/{wordpressName}/credentials/resetRéinitialiser le mot de passe administrateur et le renvoyer une fois
GET/api/v1/services/wordpress/flavorsLister les flavors disponibles par classe de calcul
GET/api/v1/services/wordpress/versionsLister les versions WordPress supportées

Paramètres de chemin : {wordpressName} est le nom de l'instance (1 à 40 caractères, minuscules, chiffres et tirets, commençant par une lettre).

Dépendances entre services

Supprimer un service MariaDB utilisé par une instance WordPress renvoie 409 CONFLICT avec un tableau dependents. Supprimez d'abord l'instance WordPress, ou passez ?deleteDatabaseService=true lors de la suppression de WordPress si le service MariaDB a été créé avec et n'a aucun autre dépendant.


Services — Sauvegardes WordPress​

MéthodeCheminDescription
GET/api/v1/services/wordpress/{wordpressName}/backupsLister les sauvegardes complètes
POST/api/v1/services/wordpress/{wordpressName}/backupsCréer une sauvegarde complète (site brièvement hors ligne)
DELETE/api/v1/services/wordpress/{wordpressName}/backups/{backupId}Supprimer une sauvegarde
POST/api/v1/services/wordpress/{wordpressName}/backups/{backupId}/restoreRestaurer dans une nouvelle instance (corps : name, database, flavor et storage optionnels)

Paramètres de chemin : {wordpressName} est le nom de l'instance ; {backupId} est l'UUID de la sauvegarde.


Connexions​

Connectez vos conteneurs et jobs à des services. Les connexions injectent automatiquement les variables d'environnement dans le workload source.

MéthodeCheminDescription
GET/api/v1/connectionsLister les connexions du projet
POST/api/v1/connectionsConnecter un conteneur à un service existant
POST/api/v1/connections/with-serviceCréer un service et le connecter en une seule requête orchestrée
GET/api/v1/connections/{connectionId}Lire les détails d'une connexion
DELETE/api/v1/connections/{connectionId}Supprimer une connexion
GET/api/v1/connections/{connectionId}/variablesLire les variables d'environnement injectées par cette connexion

Paramètres de chemin : {connectionId} est un UUID.

Niveaux d'accès

Les connexions acceptent un champ accessLevel : full (par défaut), readwrite ou readonly. Utilisez readwrite pour les workloads nécessitant un accès lecture/écriture standard sans privilèges administratifs, et readonly pour les workloads de reporting ou d'analyse.

Connexions OpenSearch

Lors de la connexion à un service OpenSearch, la requête de création exige un tableau indexPatterns (1–32 motifs, ex. ["products-*"]). Chaque connexion reçoit un utilisateur limité à ces motifs d'index. readonly autorise la lecture et la recherche ; readwrite ajoute l'écriture, la création d'indices et la gestion des mappings ; full accorde toutes les opérations sur les indices correspondants, sans administration du cluster ni de la sécurité. Le champ indexPatterns est renvoyé dans la réponse de détail de la connexion. Le raccourci de création avec service (POST /api/v1/connections/with-service) ne supporte pas OpenSearch — créez le cluster d'abord, puis connectez-le.

Connexions Supabase

Supabase n'a pas d'utilisateur de base de données propre à chaque connexion : le niveau d'accès sélectionne lesquels des identifiants de l'instance sont injectés. readonly injecte SUPABASE_URL et SUPABASE_PUBLISHABLE_KEY. readwrite et full injectent en plus SUPABASE_SECRET_KEY et DATABASE_URL, une chaîne de connexion PostgreSQL directe qui contourne la sécurité au niveau des lignes. La clé secrète administre aussi les utilisateurs Auth et les buckets Storage : readwrite et full donnent donc le contrôle de tout le projet. readonly n'est pas plus restrictif que vos politiques de sécurité au niveau des lignes. Baisser le niveau retire les variables injectées, mais n'invalide pas une clé secrète qu'un workload a déjà lue.


Jobs​

Tâches ponctuelles. Les jobs sont immuables après création.

MéthodeCheminDescription
GET/api/v1/jobsLister les jobs (filtre optionnel status : pending, running, succeeded, failed, suspended)
POST/api/v1/jobsCréer un job ponctuel
GET/api/v1/jobs/{job}Lire les détails d'un job
DELETE/api/v1/jobs/{job}Supprimer un job et ses ressources
GET/api/v1/jobs/{job}/statusLire le statut d'un job

Paramètres de chemin : {job} est le nom du job.

Champ group

La requête de création accepte un champ optionnel group (string, 63 caractères max). Les jobs partageant le même groupe sont affichés ensemble dans l'interface. Le groupe est fixé à la création et renvoyé dans la réponse de détail du job.

Montages de volumes partagés

Les jobs supportent sharedVolumeMounts dans le corps de la requête de création. Voir Volumes.

TTL après succès

ttlSecondsAfterFinished dans options contrôle combien de temps un job réussi est conservé avant que SailOps le supprime avec sa configuration et ses connexions. Un job en échec n'est jamais supprimé automatiquement. Valeur par défaut : 3600 (1 heure).

Timeout d'exécution

activeDeadlineSeconds dans options limite la durée maximale d'une exécution avant que Kubernetes ne l'arrête. Le champ est nullable : envoyez null lors d'une mise à jour de CronJob pour supprimer un timeout précédemment défini.


CronJobs​

Tâches planifiées récurrentes. Les cronjobs supportent les mises à jour et peuvent être suspendus/repris.

MéthodeCheminDescription
GET/api/v1/cronjobsLister les cronjobs (filtre optionnel status : active, suspended)
POST/api/v1/cronjobsCréer un cronjob planifié
GET/api/v1/cronjobs/{cronjob}Lire les détails d'un cronjob
PUT/api/v1/cronjobs/{cronjob}Mettre à jour le planning, le fuseau horaire, le conteneur ou les options
DELETE/api/v1/cronjobs/{cronjob}Supprimer un cronjob
POST/api/v1/cronjobs/{cronjob}/runDéclencher une exécution immédiate ; retourne l'exécution créée (name, status) pour suivi via /executions
POST/api/v1/cronjobs/{cronjob}/suspendSuspendre les exécutions planifiées
POST/api/v1/cronjobs/{cronjob}/resumeReprendre les exécutions suspendues
GET/api/v1/cronjobs/{cronjob}/configLire les variables d'environnement et fichiers montés
PUT/api/v1/cronjobs/{cronjob}/configMettre à jour les variables d'environnement et fichiers montés
GET/api/v1/cronjobs/{cronjob}/executionsLister l'historique des exécutions (paramètre : limit, max 100)
GET/api/v1/cronjobs/{cronjob}/executions/{execution}Lire une exécution par son nom (ex. celui retourné par /run)
GET/api/v1/cronjobs/{cronjob}/statusLire le statut actuel et la prochaine exécution planifiée

Paramètres de chemin : {cronjob} est le nom du cronjob.

Champ group

La requête de création accepte un champ optionnel group (string, 63 caractères max). Les cronjobs partageant le même groupe sont affichés ensemble dans l'interface. Le groupe est fixé à la création et renvoyé dans la réponse de détail du cronjob.

Montages de volumes partagés

Les cronjobs supportent sharedVolumeMounts dans les corps de requête de création et de mise à jour. Voir Volumes.

TTL sur les exécutions de CronJob

ttlSecondsAfterFinished dans options est transmis à Kubernetes comme spec.jobTemplate.spec.ttlSecondsAfterFinished, donc chaque exécution est supprimée une fois terminée — qu'elle ait réussi ou échoué. Utilisez successfulJobsHistoryLimit et failedJobsHistoryLimit pour contrôler le nombre d'exécutions conservées.

Timeout d'exécution

activeDeadlineSeconds dans options limite la durée maximale de chaque exécution. Le champ est nullable : envoyez null dans une mise à jour PUT pour supprimer un timeout précédemment défini.


Stack​

Infrastructure as code déclarative. Voir le guide Stack Engine pour tous les détails.

MéthodeCheminDescription
POST/api/v1/stack/planDry-run — prévisualiser les changements sans les appliquer
POST/api/v1/stack/applyAppliquer une définition de stack pour créer, mettre à jour ou supprimer des ressources
GET/api/v1/stack/exportExporter l'état actuel du projet sous forme de définition de stack (paramètres : format, scope)

Volumes​

Gérez les volumes block (RWO) et partagés (RWX) persistants de votre projet. Les volumes block appartiennent aux conteneurs ; les volumes partagés sont autonomes et peuvent être montés par plusieurs workloads.

MéthodeCheminDescription
GET/api/v1/volumesLister les volumes du projet (filtre type : block ou shared)
GET/api/v1/containers/{container}/volumes/{volume}Lire un volume block (RWO), monté ou détaché
DELETE/api/v1/containers/{container}/volumes/{volume}Supprimer un volume block détaché, sa planification et tous ses snapshots (409 si encore monté)
POST/api/v1/shared-volumesCréer un volume partagé (RWX)
GET/api/v1/shared-volumes/{volume}Lire les détails, montages actifs et utilisation d'un volume partagé
PATCH/api/v1/shared-volumes/{volume}Agrandir un volume partagé (croissance uniquement)
DELETE/api/v1/shared-volumes/{volume}Supprimer un volume partagé (échoue avec 409 si encore monté)

Paramètres de chemin : {volume} est le nom logique du volume (sans le préfixe PVC sv-).


Snapshots de volumes​

Créez et consultez des snapshots ponctuels de volumes block. Les snapshots peuvent être listés et supprimés sur les volumes montés comme détachés ; la création et la restauration nécessitent que le volume soit monté.

MéthodeCheminDescription
GET/api/v1/containers/{container}/volumes/{volume}/snapshotsLister les snapshots d'un volume block
POST/api/v1/containers/{container}/volumes/{volume}/snapshotsCréer un snapshot à la demande
GET/api/v1/containers/{container}/volumes/{volume}/snapshots/{snapshot}Lire les détails d'un snapshot

Paramètres de chemin : {container} est le nom du conteneur ; {volume} est le nom du volume ; {snapshot} est l'identifiant du snapshot.

Propriétés d'un snapshot

Chaque snapshot inclut :

ChampTypeDescription
idstringIdentifiant unique du snapshot
volumeNamestringNom logique du volume auquel ce snapshot appartient
statuspending | ready | errorStatut actuel du snapshot
typemanual | scheduledSnapshot créé à la demande ou par la planification automatique
sizeBytesinteger (optionnel)Taille du snapshot en octets lorsqu'elle est disponible
createdAtdate-timeDate de création
readyAtdate-time (optionnel)Date à laquelle le snapshot est devenu prêt
createdBystring (optionnel)Identifiant de l'utilisateur ayant créé le snapshot
errorstring (optionnel)Message d'erreur si le snapshot a échoué
restorablebooleanIndique si ce snapshot peut être utilisé pour une restauration

Le endpoint POST accepte un corps JSON optionnel avec un champ description (256 caractères maximum).


Alertes​

Consulter, acquitter et résoudre les alertes d'un projet via l'API v3.

MéthodeCheminDescription
GET/api/v3/projects/{projectId}/alertsLister les alertes dans une fenêtre temporelle, les plus récentes en premier
GET/api/v3/projects/{projectId}/alerts/summaryCompter les alertes ouvertes par sévérité et les alertes non lues
PATCH/api/v3/projects/{projectId}/alerts/{alertId}Marquer une alerte comme lue ou non lue
POST/api/v3/projects/{projectId}/alerts/{alertId}/resolveRésoudre une alerte

Paramètres de chemin : {projectId} est l'UUID du projet ; {alertId} est l'UUID de l'alerte.

Paramètres de requête pour la liste des alertes

GET /api/v3/projects/{projectId}/alerts accepte les paramètres de requête optionnels suivants :

ParamètreTypeDescription
limitintegerNombre maximum d'alertes à retourner
offsetinteger (défaut 0)Nombre d'éléments à sauter
sincedate-timeDébut de la fenêtre temporelle
untildate-timeFin de la fenêtre temporelle (par défaut l'heure de la requête ; renvoyez le until de la première page pour paginer dans la même fenêtre)
severitytableau de stringsFiltrer par sévérité : INFO, WARNING, ERROR, CRITICAL
resourceTypestringFiltrer par type de ressource (ex. CONTAINER, POSTGRES, MARIADB, VALKEY, NATS, OPENSEARCH, KAFKA, SUPABASE, KEYCLOAK, WORDPRESS, AI_AGENT, GATEWAY, JOB, CRONJOB, CUSTOM, MARKETPLACE, WEBSITE, SHARED_VOLUME)
resourceNamestringFiltrer par nom de ressource
readbooleanAlertes lues uniquement, ou non lues uniquement
resolvedbooleanAlertes résolues uniquement, ou ouvertes uniquement

Le endpoint de résumé accepte since, until, resourceType et resourceName.

État de lecture

L'état de lecture est partagé à l'échelle du projet : marquer une alerte comme lue la marque comme lue pour tout le monde. Le corps du PATCH est {"read": true} ou {"read": false}.


Notifications​

Configurer où les alertes sont envoyées, par niveau de sévérité.

MéthodeCheminDescription
GET/api/v3/projects/{projectId}/notificationsLister les paramètres de notification pour toutes les sévérités
PATCH/api/v3/projects/{projectId}/notifications/{severity}Mettre à jour les canaux de notification pour une sévérité
POST/api/v3/projects/{projectId}/notifications/{severity}/testEnvoyer une notification de test via les canaux enregistrés

Paramètres de chemin : {projectId} est l'UUID du projet ; {severity} est INFO, WARNING ou CRITICAL.

Sémantique merge-patch

PATCH utilise la sémantique merge-patch : les champs omis conservent leur valeur stockée. Définissez un canal à null pour le supprimer ; fournissez un objet pour le remplacer entièrement. Les URLs des canaux sont en écriture seule et ne sont jamais renvoyées dans les réponses.

Canaux supportés

Canaux de notification : webhook, slack, teams, discord, mattermost. Le canal webhook supporte également un name personnalisé et des headers pour l'authentification.

Tester des canaux non enregistrés

Le endpoint de test accepte optionnellement un corps de requête avec des définitions de canaux pour tester des destinations non encore enregistrées. Elles ne sont pas persistées par cet appel.


Tickets de support​

Ouvrez, suivez et gérez les tickets de support de votre organisation via l'API v3.

MéthodeCheminDescription
GET/api/v3/organizations/{organizationId}/ticketsLister les tickets de support de l'organisation
POST/api/v3/organizations/{organizationId}/ticketsOuvrir un nouveau ticket de support
GET/api/v3/organizations/{organizationId}/tickets/{ticketId}Lire un ticket de support
GET/api/v3/organizations/{organizationId}/tickets/{ticketId}/messagesLister les messages d'un ticket
POST/api/v3/organizations/{organizationId}/tickets/{ticketId}/messagesRépondre à un ticket (multipart, jusqu'à 5 fichiers de 10 Mo)
POST/api/v3/organizations/{organizationId}/tickets/{ticketId}/resolveRésoudre un ticket
POST/api/v3/organizations/{organizationId}/tickets/{ticketId}/reopenRouvrir un ticket résolu ou fermé

Paramètres de chemin : {organizationId} est l'UUID de l'organisation ; {ticketId} est l'UUID du ticket.

Authentification

Les endpoints de tickets de support nécessitent un cookie de session (utilisateur connecté). Les clés API ne sont pas supportées.

Paramètres de requête pour la liste des tickets

GET .../tickets accepte les paramètres de requête optionnels suivants :

ParamètreTypeDescription
limitinteger (1–100, défaut 50)Nombre maximum de tickets par page
cursorstringCurseur renvoyé par une page précédente (nextCursor)
statusstringUniquement les tickets dans ce statut : new, open, pending, resolved, closed
Créer un ticket

Le corps de la requête POST (JSON) exige les champs suivants :

ChampTypeDescription
subjectstring (1–500 caractères)Sujet du ticket
messagestringCorps du premier message
categorystringquestion, incident ou problem
prioritystringlow, normal, high ou urgent
projectIdUUIDLe projet concerné par le ticket
resourceobject (optionnel)Ressource affectée : product (Container, Database, Cache, Gateway) et name optionnel
Répondre à un ticket

POST .../messages accepte du multipart/form-data avec un champ texte body obligatoire et un tableau files optionnel (jusqu'à 5 fichiers, 10 Mo chacun). Types de fichiers acceptés : images, PDF, texte brut, CSV.

Rouvrir un ticket

POST .../reopen accepte un corps JSON optionnel avec un champ message expliquant pourquoi le ticket est rouvert. Un ticket qui n'est ni résolu ni fermé est renvoyé tel quel.


Organisations​

Consultez, initialisez et inspectez les organisations auxquelles vous appartenez via l'API v3.

MéthodeCheminDescription
PUT/api/v3/meSynchroniser votre compte (renvoie hasMemberships et trialAvailable)
POST/api/v3/me/trialDémarrer votre essai gratuit (un par personne, requiert acceptedTermsVersion)
GET/api/v3/organization-name-suggestionSuggérer un nom d'organisation
GET/api/v3/organizationsLister les organisations accessibles, par ordre alphabétique (inclut type et createdAt)
GET/api/v3/organizations/{organizationId}Lire les détails d'une organisation (état, plan de support, facturation)
GET/api/v3/organizations/{organizationId}/billingLire les détails de facturation et le solde

Paramètres de chemin : {organizationId} est l'UUID de l'organisation.

Synchronisation du compte et essai

PUT /api/v3/me nécessite un cookie de session (pas une clé API). Appelez-le une fois par connexion pour enregistrer le compte et savoir si l'appelant appartient déjà à une organisation (hasMemberships) et s'il peut démarrer un essai gratuit (trialAvailable).

Pour démarrer un essai, appelez POST /api/v3/me/trial avec un name et un acceptedTermsVersion. Chaque personne a droit à un seul essai ; un second appel répond CONFLICT. L'organisation existe dès le retour de l'appel, mais son premier projet peut encore être en cours de provisionnement. Vérifiez state.phase — lorsqu'elle est provisioning, interrogez GET /api/v3/organizations avec phase=provisioning jusqu'à ce qu'elle passe à la phase suivante.

Paramètres de requête pour la liste des organisations

GET /api/v3/organizations accepte les paramètres de requête optionnels suivants :

ParamètreTypeDescription
limitintegerNombre maximum d'organisations à retourner
cursorstringCurseur renvoyé par une page précédente (nextCursor)
phasetableau de stringsUniquement les organisations dans ces phases : provisioning, onboarding, trial, active, restricted, blocked, archived
Réponse du détail d'une organisation

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

ChampTypeDescription
idUUIDIdentifiant de l'organisation
namestringNom de l'organisation
typePERSONAL | ENTERPRISEType d'organisation
stateobjectPhase actuelle, message, date de fin de trial et période de grâce
createdAtdate-timeDate de création
scopestableau de stringsPermissions dans cette organisation, au format collection:verb
supportLevelFREE | STARTER | BUSINESS | CUSTOMPlan de support
maxLogRetentionDaysinteger (optionnel)Profondeur maximale de l'explorateur de logs
remainingTrialCreditsinteger (optionnel)Crédit de trial restant en centimes (présent uniquement pendant la phase trial)
requirePaymentMethodbooleanIndique si un moyen de paiement est nécessaire avant de pouvoir utiliser l'organisation
billingCompletebooleanIndique si toutes les informations de facturation nécessaires sont présentes
canArchivebooleanIndique si l'organisation peut être archivée maintenant

L'objet state inclut phase, un message optionnel, un trialEndsAt optionnel (présent pendant la phase trial), et un gracePeriod optionnel avec reason (PAYMENT_FAILED ou TRIAL_EXPIRED), startedAt et un endsAt optionnel.

Réponse de facturation d'une organisation

GET /api/v3/organizations/{organizationId}/billing nécessite le scope billing:read et retourne :

ChampTypeDescription
emailstringAdresse d'envoi des factures
creditsintegerSolde du compte en centimes
addressobject (optionnel)Adresse de facturation (rue, ville, code postal, pays)
businessobject (optionnel)Détails de l'entreprise pour les organisations enterprise (nom, numéro d'immatriculation, TVA)

Projets​

Consultez et inspectez les projets d'une organisation via l'API v3.

MéthodeCheminDescription
GET/api/v3/organizations/{organizationId}/projectsLister les projets accessibles dans l'organisation, par ordre alphabétique
GET/api/v3/projects/{projectId}Lire les détails d'un projet et vos permissions

Paramètres de chemin : {organizationId} est l'UUID de l'organisation ; {projectId} est l'UUID du projet.

Paramètres de requête pour la liste des projets

GET /api/v3/organizations/{organizationId}/projects accepte les paramètres de requête optionnels suivants :

ParamètreTypeDescription
limitintegerNombre maximum de projets à retourner
cursorstringCurseur renvoyé par une page précédente (nextCursor)
phasetableau de stringsUniquement les projets dans ces phases : active, suspended, pendingDeletion
Réponse du détail d'un projet

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

ChampTypeDescription
idUUIDIdentifiant du projet
namestringNom du projet
stateobjectPhase actuelle et détails du cycle de vie
scopestableau de stringsPermissions dans ce projet, au format collection:verb
createdAtdate-timeDate de création
updatedAtdate-timeDate de dernière modification du projet ou de son cycle de vie

L'objet state inclut phase (active, suspended ou pendingDeletion). Lorsque le projet est suspended, il inclut aussi suspendedAt et suspensionReason (manual, organization ou deletion). Lorsqu'il est en pendingDeletion, un objet deletion avec scheduledAt et reason (customer_deletion_requested ou dunning_org_archived) est présent.

Le tableau scopes d'un projet ne contient que les scopes accessibles au niveau du projet. Les scopes de niveau organisation tels que organizations:write ou billing:write n'apparaissent pas, même si l'appelant les détient sur l'organisation parente.


Journal d'audit​

Consultez les modifications effectuées dans une organisation ou un projet, par qui et via quel canal.

MéthodeCheminDescription
GET/api/v3/organizations/{organizationId}/auditLister le journal d'audit de l'organisation (tous les projets)
GET/api/v3/projects/{projectId}/auditLister le journal d'audit du projet

Paramètres de chemin : {organizationId} est l'UUID de l'organisation ; {projectId} est l'UUID du projet.

Paramètres de requête

Les deux endpoints acceptent les paramètres de requête optionnels suivants :

ParamètreTypeDescription
limitintegerNombre maximum d'entrées à retourner
offsetinteger (défaut 0)Nombre d'entrées à sauter
sincedate-timeDébut de la fenêtre temporelle
untildate-timeFin de la fenêtre temporelle (par défaut l'heure de la requête ; renvoyez le until de la première page pour paginer dans la même fenêtre)
actiontableau de stringsUniquement les entrées de ces opérations (jusqu'à 50)
actorTypestringUniquement les entrées par des acteurs de ce type : user, api_key ou system
actorstringUniquement les entrées de cet acteur (identifiant d'un utilisateur ou label d'une clé)
sourcestringUniquement les entrées effectuées via ce canal : ui, mcp, public_api, internal, webhook ou cli

Le endpoint projet accepte également :

ParamètreTypeDescription
targetKindstringUniquement les entrées concernant des ressources de ce type (ex. container, api_key)
targetstringUniquement les entrées concernant la ressource portant ce nom
Réponse

Chaque entrée inclut id, occurredAt, actor (avec type, id, display), source, action, target (avec kind et id) et un message lisible. L'objet page inclut items, total, totalExact, offset, limit et le timestamp until de la fenêtre.


AI Models​

L'endpoint compatible OpenAI lui-même est servi sous /api/ai/v1 à la racine de l'hôte, pas sous cette API ; voir Models. Ces opérations le consultent et le configurent pour le projet de la clé.

MéthodeCheminDescriptionPermission
GET/api/v1/ai/modelsLister les modèles aux prix facturés à votre organisationai-models:list
GET/api/v1/ai/models/settingsLire le budget mensuel et les modèles autorisés du projetai-models:get
PUT/api/v1/ai/models/settingsRemplacer le budget mensuel (monthlyBudgetEur) et les modèles autorisés (allowedModels, vide pour tous les autoriser)ai-models:update
GET/api/v1/ai/models/usageUsage en tokens sur une période, par modèle et par clé API (paramètres de requête : from, to ; par défaut le mois en cours)ai-models:get
GET/api/v1/ai/models/usage/daysUsage en tokens, dépense, erreurs et latence par jour UTC (paramètres de requête : from, to, optionnels model et key)ai-models:get

Un modèle de allowedModels absent de GET /api/v1/ai/models est refusé avec 400. Une modification des réglages atteint l'endpoint en moins d'une minute et figure dans le journal d'audit.


Sandboxes​

Agent sandboxes — des containers créés avec le preset agent-sandbox. Démarrage, arrêt, redémarrage, suppression et logs utilisent les endpoints de containers sous /api/v1/containers/{container}. Voir Agent Sandboxes pour le guide complet.

MéthodeCheminDescriptionPermission
GET/api/v1/sandboxesLister les agent sandboxes du projetcontainers:list
POST/api/v1/sandboxesCréer un agent sandboxcontainers:update
GET/api/v1/sandboxes/{name}Obtenir les détails d'un sandboxcontainers:list
GET/api/v1/sandboxes/{name}/settingsLire le délai d'inactivité, les clés SSH et les réglages réseaucontainers:list
PUT/api/v1/sandboxes/{name}/settingsModifier les réglages (délai d'inactivité, clés SSH, isolation réseau, logiciels)containers:update
POST/api/v1/sandboxes/{name}/execExécuter une commande dans le sandboxsandboxes:exec

Paramètres de chemin : {name} est le nom du sandbox.

Détails de l'exécution

POST .../exec exécute une commande sans TTY et attend qu'elle se termine, jusqu'à timeoutSeconds (60 par défaut, 600 au maximum). Le corps de la requête accepte command (tableau de chaînes), shell (chaîne), et optionnellement cwd, env et timeoutSeconds. stdout et stderr sont capturés séparément, chacun tronqué à 1 Mio. La réponse inclut exitCode, durationMs, stdoutTruncated, stderrTruncated et timedOut. Compte comme activité pour l'arrêt d'inactivité ; enregistré dans le journal d'audit.


Agents IA​

Gérez les agents IA managés de votre projet. Voir le guide des agents IA pour tous les détails.

MéthodeCheminDescriptionPermission
GET/api/v1/ai/agentsLister les agents IA managés du projetai-agents:list
POST/api/v1/ai/agentsCréer un agent IA managéai-agents:update
GET/api/v1/ai/agents/{agentName}Lire les détails d'un agent IAai-agents:list
PUT/api/v1/ai/agents/{agentName}Modifier un agent IA (calcul, volume en croissance, fournisseur de modèles, IPs autorisées)ai-agents:update
DELETE/api/v1/ai/agents/{agentName}Supprimer un agent IA et son volume d'étatai-agents:update
POST/api/v1/ai/agents/{agentName}/startDémarrer un agent IA arrêtéai-agents:update
POST/api/v1/ai/agents/{agentName}/stopArrêter un agent IA (la facturation du volume reste)ai-agents:update
POST/api/v1/ai/agents/{agentName}/restartRedémarrer un agent IAai-agents:update
GET/api/v1/ai/agents/{agentName}/credentialsRévéler l'identifiant de l'interface (une seule fois)ai-agents:update
POST/api/v1/ai/agents/{agentName}/credentials/resetRéinitialiser l'identifiant de l'interface et redémarrer l'agentai-agents:update
PUT/api/v1/ai/agents/{agentName}/secretsDéfinir ou supprimer les secrets en écriture seule (clé API du modèle, jetons des canaux)ai-agents:update
POST/api/v1/ai/agents/{agentName}/models-bindingRelier l'agent à SailOps Models (crée ou renouvelle une clé d'API de projet)ai-agents:update + ai-models:invoke
GET/api/v1/ai/agents/flavorsLister les tailles de calcul avec les moteurs éligiblesai-agents:list
GET/api/v1/ai/agents/enginesLister les moteurs, versions et secrets attendusai-agents:list

Paramètres de chemin : {agentName} est le nom de l'agent (1 à 40 caractères, minuscules, chiffres et tirets).

Restriction en période d'essai

Les agents IA ne sont pas disponibles pendant l'essai. La création d'un agent dans une organisation en essai est refusée.

Secrets en écriture seule

PUT .../secrets définit la clé d'API du modèle et les jetons des canaux. Un champ absent conserve la valeur enregistrée ; une chaîne vide la supprime. Les valeurs ne sont jamais renvoyées par aucun endpoint.


Plans​

Aucune authentification requise.

MéthodeCheminDescriptionAuth
GET/api/v1/plansLire le catalogue public des plans de supportNon

La réponse liste chaque plan de support (FREE, STARTER, BUSINESS, CUSTOM) avec ses quotas, fonctionnalités et tarifs. Les champs de quota optionnels sont omis lorsque leur valeur est négociée par contrat plutôt que publiquement engagée. Tous les prix sont hors taxes.

Chaque plan inclut :

ChampTypeDescription
levelstringNiveau de support (FREE, STARTER, BUSINESS, CUSTOM)
namestringNom commercial du plan
availabilitystringSELF_SERVE ou CONTACT_SALES
priceCentsinteger (optionnel)Prix de base mensuel en centimes d'euro
spendRationumber (optionnel)Ratio de tarification hybride : le plan est facturé à max(prix de base, spendRatio x consommation)
logRetentionDaysinteger (optionnel)Rétention des logs en jours
metricRetentionDaysinteger (optionnel)Rétention des métriques en jours
includedLogGiBinteger (optionnel)Volume de logs inclus par mois en Gio
includedMetricSamplesMonthlyinteger (optionnel)Échantillons de métriques inclus par mois
includedMetricActiveSeriesinteger (optionnel)Séries de métriques actives incluses
includedTraceSpansMonthlyinteger (optionnel)Spans de trace inclus par mois
includedStorageGiBMonthinteger (optionnel)Stockage inclus en Gio-mois
metricSamplesRateLimitPerSecondinteger (optionnel)Limite de débit d'ingestion des échantillons de métriques
metricSamplesBillingEnforcementModestringHARD_CAP ou BILL_OVERAGE
featuresarrayListe des fonctionnalités du plan (voir ci-dessous)

Chaque objet de fonctionnalité contient :

ChampTypeDescription
keystringIdentifiant stable de la fonctionnalité (ex. sla.uptimePercent, support.responseTimeHours)
includedbooleanIndique si la fonctionnalité est incluse dans le plan
valuenumber (optionnel)Magnitude dans l'unité fixée par la clé

Pricing​

Aucune authentification requise.

MéthodeCheminDescriptionAuth
GET/api/v1/pricingLire les tarifs publics pour le calcul, les jobs, le stockage, les load balancers, les bases de données, les services managés et les websitesNon

La réponse inclut les classes de calcul GPU avec des champs supplémentaires : minCpu, minRamMiB, gpuType, gpuMode, gpuMemoryGiB, pricePerGpuHour, maxGpus, minBillSeconds, requiresPlans.

La réponse inclut aussi un objet postgresqlPgBouncer avec pricePerInstanceHour et pricePerInstanceMonth pour le tarif PgBouncer managé.

jobComputeClasses liste les classes de calcul des jobs et cronjobs : les tarifs de base par heure de CPU et de RAM, les multiplicateurs durationTiers appliqués selon la durée du job, et minBillingSeconds.

websitePlans liste le tarif par instance de chaque plan de website.

serviceFlavors liste les flavors d'OpenSearch, de Kafka, de Supabase, de Keycloak et de WordPress aux tarifs publics, sous la forme que les endpoints /api/v1/services/{service}/flavors renvoient aux tarifs de votre organisation. Les tarifs OpenSearch et Kafka sont par nœud ; ceux de Keycloak et de WordPress par instance ; une instance Supabase facture componentsPricePerHour en plus du tarif de sa base de données.

L'objet usagePricing expose les tarifs unitaires des ressources facturées à l'usage (tous les prix en euros) :

ChampSous-champDescription
websiteStoragepricePerGiBHourTarif du stockage S3 des websites par Gio-heure
sharedVolumeStoragepricePerGiBHourTarif du stockage des volumes partagés par Gio-heure
objectStoragestoragePricePerGiBMonthTarif de l'Object Storage par Gio-mois stocké
objectStoragewritePricePerMillionTarif de l'Object Storage par million de requêtes d'écriture et de listage
objectStoragereadPricePerMillionTarif de l'Object Storage par million de requêtes de lecture et HEAD
objectStoragedownloadPricePerGiBTarif de l'Object Storage par Gio téléchargé
logStorageoveragePricePerGiBMonthTarif du dépassement de stockage de logs par Gio-mois
backupStoragepricePerGiBMonthTarif du stockage de sauvegardes par Gio-mois
observabilitymetricSamplesPricePerMillionTarif des échantillons de métriques par million
observabilitytraceSpansPricePerMillionTarif des spans de trace par million
observabilitystoragePricePerGiBMonthTarif du stockage d'observabilité par Gio-mois

Ressources​

Rechercher, taguer et supprimer des ressources de tous types dans un projet. Voir Tags des ressources pour les détails.

MéthodeCheminDescription
GET/api/v1/resourcesLister les ressources avec filtres par tag et pagination
PUT/api/v1/resources/{resourceId}/tagsRemplacer tous les tags d'une ressource (nécessite revision pour le verrouillage optimiste)
DELETE/api/v1/resources/{resourceId}Supprimer une ressource et ses enfants

Paramètres de chemin : {resourceId} est l'UUID de la ressource.

Paramètres de requête pour la liste des ressources

GET /api/v1/resources accepte les paramètres de requête optionnels suivants :

ParamètreTypeDescription
tagstring (répétable)Filtrer par tag, format clé=valeur ; tous les filtres doivent correspondre
kindstringFiltrer par type de ressource (ex. CONTAINER, POSTGRES, MARIADB, VALKEY, NATS, OPENSEARCH, KAFKA, SUPABASE, KEYCLOAK, WORDPRESS, AI_AGENT, GATEWAY, JOB, CRONJOB, CUSTOM, MARKETPLACE, WEBSITE, SHARED_VOLUME)
limitinteger (1–200, défaut 100)Taille de page
cursorUUIDCurseur issu de nextCursor d'une page précédente
Tags des ressources à la création

Tous les endpoints de création (POST) acceptent un objet tags optionnel contenant jusqu'à 50 paires clé/valeur. Les tags sont définis à la création et modifiables ensuite via PUT /api/v1/resources/{resourceId}/tags.

Verrouillage optimiste pour les mises à jour de tags

PUT /api/v1/resources/{resourceId}/tags nécessite un champ revision correspondant à la révision actuelle des tags de la ressource. Une modification concurrente renvoie 409 Conflict — relisez la ressource et réessayez.

Sécurité de la suppression

DELETE /api/v1/resources/{resourceId} applique les règles de suppression propres à chaque type de ressource. Les ressources gérées par un parent et les services personnalisés ne sont pas supprimables par cet endpoint (canDelete: false dans la réponse de liste). L'API refuse de supprimer une nouvelle génération créée après une précédente consultation.


Codes d'erreur​

L'API retourne des codes d'erreur spécifiques pour identifier le problème :

  • ORGANIZATION_SETUP_REQUIRED — La configuration de l'organisation est incomplète. Complétez les informations de facturation et ajoutez un moyen de paiement.
  • ORGANIZATION_BLOCKED — L'organisation est bloquée. Résolvez le problème de facturation dans les paramètres de l'organisation. Toute facture impayée doit être réglée avant de restaurer l'accès.
  • ORGANIZATION_RESTRICTED — L'organisation est restreinte. Les modifications de ressources sont désactivées jusqu'à la résolution du problème de facturation.
  • ORGANIZATION_ARCHIVED — L'organisation est archivée. Les modifications ne sont plus autorisées.
  • ORGANIZATION_HAS_ACTIVE_PROJECTS — Impossible d'archiver une organisation tant que des projets actifs ou en cours de suppression existent.
  • PLAN_RESOURCE_LIMIT — Le plan de support de l'organisation ne permet pas la ressource demandée (ex. classe de calcul GPU restreinte à un tier supérieur).
  • SERVICE_UNAVAILABLE — Le service est temporairement indisponible ; relancez la requête. Renvoyé avec le statut HTTP 503.

Exemples pratiques​

Mettre à jour l'image d'un conteneur​

Utilisez PATCH v2 pour mettre à jour l'image et optionnellement la configuration en un seul rollout atomique :

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

Pour mettre à jour l'image avec des 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

Mettre à jour image, ressources et configuration en un appel​

PATCH v2 accepte aussi les champs optionnels computeClass, resources et config. Utile pour les pipelines CI/CD qui gèrent la configuration complète du conteneur :

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

Si le ratio CPU/RAM ne correspond pas à la classe de calcul sélectionnée, l'API retourne une erreur 400 avec un message descriptif.

Créer un conteneur avec des volumes persistants​

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
Contraintes de volumes

Les conteneurs avec des volumes persistants sont limités à 1 réplica et ne peuvent pas utiliser l'autoscaling (jusqu'à 5 volumes par conteneur). Voir le guide des Volumes Persistants pour les détails.

Créer une base de données PostgreSQL​

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

Exposer un conteneur via une route gateway​

# 1. Créer une 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. Ajouter un domaine
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. Créer une route HTTP
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

Déclencher un cronjob manuellement​

curl -X POST \
-H "X-Api-Key: $SAILOPS_API_KEY" \
https://app.sailops.io/api/public/api/v1/cronjobs/nightly-report/run

Lister et télécharger des sauvegardes​

# Lister les sauvegardes PostgreSQL
curl -H "X-Api-Key: $SAILOPS_API_KEY" \
https://app.sailops.io/api/public/api/v1/services/postgresql/my-db/backups

# Télécharger une sauvegarde PostgreSQL
curl -H "X-Api-Key: $SAILOPS_API_KEY" \
https://app.sailops.io/api/public/api/v1/services/postgresql/my-db/backups/backup-123/download

Créer un volume partagé et le monter​

# 1. Créer un volume partagé
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. Le monter sur un conteneur
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