Vue d'ensemble de l'API publique
Automatisez et intégrez SailOps grâce à une API REST entièrement programmable.
L'API publique SailOps vous donne le contrôle programmatique de toutes les ressources de votre projet : conteneurs, bases de données, gateways, jobs et plus encore. Utilisez-la pour automatiser les déploiements, construire des outils internes, intégrer des pipelines CI/CD ou gérer l'infrastructure de manière déclarative avec le Stack Engine.
URL de base
https://app.sailops.io/api/public/api/v1
Toutes les requêtes passent par HTTPS.
Authentification
L'API utilise une clé envoyée dans l'en-tête X-Api-Key :
curl -H "X-Api-Key: $SAILOPS_API_KEY" \
https://app.sailops.io/api/public/api/v1/containers
Seules les clés d'API de projet sont acceptées. Une clé d'organisation ou personnelle reçoit une erreur FORBIDDEN avec le message « This API key does not belong to a project. » Utilisez l'API (new) pour les clés à sujet plus large.
Chaque clé de projet est rattachée à un projet. Elle ne donne accès qu'aux ressources de ce projet.
Pour créer une clé de projet, ouvrez Project Settings > API Keys. Consultez le guide API Keys pour les étapes détaillées.
Stockez la clé dans un gestionnaire de secrets ou dans les secrets CI/CD. Ne la commitez jamais dans le code source et ne l'exposez pas côté navigateur.
Endpoints non authentifiés
Deux endpoints ne requièrent pas de clé :
GET /api/v1/planspour le catalogue public des plans de supportGET /api/v1/pricingpour les informations de pricing publiques
Exemple rapide
Lister les conteneurs du projet :
curl -H "X-Api-Key: $SAILOPS_API_KEY" \
https://app.sailops.io/api/public/api/v1/containers
Déployer une nouvelle image en CI/CD :
curl -X PUT \
-H "X-Api-Key: $SAILOPS_API_KEY" \
-H "Content-Type: application/json" \
-d '{"computeClass": "standard", "image": "ghcr.io/myorg/api:v2.0.0", "resources": {"cpu": 500, "memory": 512}}' \
https://app.sailops.io/api/public/api/v1/containers/my-api
Limitation de débit
Des limites de débit standard s'appliquent à toutes les requêtes authentifiées. Si vous dépassez la limite, l'API renvoie une réponse 429 Too Many Requests. Utilisez un backoff exponentiel lors des nouvelles tentatives.
Erreurs
Toutes les erreurs suivent un format JSON cohérent :
{
"code": "NOT_FOUND",
"traceId": "01HXYZ123456789",
"message": "Container 'my-api' not found"
}
Pour les erreurs de validation, un tableau validations fournit les détails par champ :
{
"code": "REQUEST_VALIDATION",
"traceId": "01HXYZ123456789",
"message": "Request validation failed",
"validations": [
{
"path": "$.body.name",
"code": "PATTERN",
"pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$"
}
]
}
Codes d'erreur
| Code | Statut HTTP | Description |
|---|---|---|
UNAUTHORIZED | 401 | Clé API manquante ou invalide |
FORBIDDEN | 403 | La clé API n'a pas les permissions pour cette ressource |
EXPIRED_AUTHENTICATION | 401 | La clé API a expiré |
REQUEST_VALIDATION | 400 | Un ou plusieurs champs ont échoué à la validation — consultez validations |
METHOD_NOT_ALLOWED | 405 | Méthode HTTP non autorisée pour ce chemin |
NOT_FOUND | 404 | La ressource demandée n'existe pas |
CONFLICT | 409 | La requête entre en conflit avec l'état actuel de la ressource |
ORGANIZATION_ARCHIVED | 403 | L'organisation est archivée. Les modifications ne sont plus autorisées. |
ORGANIZATION_HAS_ACTIVE_PROJECTS | 409 | Impossible d'archiver une organisation tant que des projets actifs ou en attente de suppression existent. |
PROJECT_PENDING_DELETION | 403 | Le projet est planifié pour suppression. Restaurez le projet pour effectuer des modifications. |
INTERNAL | 500 | Erreur interne du serveur — incluez le traceId lorsque vous contactez le support |
Ressources disponibles
L'API publique expose toute la surface de la plateforme SailOps :
| Catégorie | Ressources |
|---|---|
| Conteneurs | Créer, mettre à jour, démarrer, arrêter, redémarrer, configurer et lire les logs |
| Websites | Créer, mettre à jour, démarrer, arrêter et supprimer des sites statiques ou PHP |
| Gateways & Routes | Gérer les load balancers, domaines et routage HTTP/TCP/gRPC/TLS |
| Services | Provisionner et dimensionner PostgreSQL, MariaDB, Valkey et NATS |
| Connexions | Connecter des conteneurs à des services avec injection automatique de variables |
| Jobs | Exécuter des tâches batch ponctuelles |
| CronJobs | Planifier des tâches récurrentes avec des expressions cron |
| Stack Engine | Appliquer des stacks YAML déclaratives pour l'infrastructure-as-code |
| Plans | Consulter le catalogue public des plans de support (sans authentification) |
| Pricing | Interroger les tarifs actuels de calcul et stockage (sans authentification) |
Consultez la référence des endpoints pour la liste complète des 91 endpoints, ou le guide Stack Engine pour la gestion déclarative de l'infrastructure.
Serveur MCP
Le serveur MCP SailOps expose la même API sous forme d'outils pour les assistants IA. Connectez Claude, Cursor ou tout client compatible MCP pour gérer votre infrastructure en langage naturel.
Sujets liés
- API Keys — Créer et gérer les clés API
- Intégration CI/CD — Guides de déploiement GitHub Actions et GitLab CI
- Référence des endpoints — Liste complète des endpoints
- Stack Engine — Infrastructure-as-code déclarative
- Serveur MCP — Intégration avec les assistants IA