Aller au contenu principal

Référence des endpoints

Toutes les opérations de la nouvelle API SailOps, organisées par domaine.

URL de base : https://app.sailops.io

Les requêtes s'authentifient par cookie de session ou par clé d'API — voir la vue d'ensemble. Les paramètres et schémas de chaque opération sont dans la référence interactive.


Organisations​

Les organisations et leur cycle de vie.

MéthodeCheminDescription
PUT/api/v3/meSynchroniser votre compte
POST/api/v3/me/trialDémarrer votre essai gratuit
GET/api/v3/organization-name-suggestionSuggérer un nom d'organisation
POST/api/v3/organizationsCréer une organisation (requiert acceptedTermsVersion)
GET/api/v3/organizationsLister les organisations dont vous êtes membre
GET/api/v3/organizations/{organizationId}Récupérer une organisation
DELETE/api/v3/organizations/{organizationId}Archiver une organisation
GET/api/v3/organizations/{organizationId}/billingRécupérer les informations de facturation d'une organisation
PATCH/api/v3/organizations/{organizationId}/billingModifier les informations de facturation d'une organisation
GET/api/v3/organizations/{organizationId}/planLire le plan de support d'une organisation
PUT/api/v3/organizations/{organizationId}/planChanger le plan de support d'une organisation
POST/api/v3/organizations/{organizationId}/plan/customDemander un plan négocié
GET/api/v3/organizations/{organizationId}/termsLire le statut des conditions générales de service de l'organisation
POST/api/v3/organizations/{organizationId}/terms/{version}/acceptAccepter une version des conditions générales de service
POST/api/v3/organizations/{organizationId}/terms/{version}/refuseRefuser la prochaine version des conditions générales de service

syncMe enregistre votre compte à la connexion et renvoie ce dont la console a besoin pour décider où vous diriger : hasMemberships (si vous appartenez à au moins une organisation) et trialAvailable (si vous pouvez encore démarrer un essai gratuit). Appelez-le une fois par connexion.

startTrial crée une organisation d'essai dont vous êtes propriétaire, sous le nom de votre choix, et la renvoie. Chaque personne a droit à un seul essai ; un second appel répond CONFLICT, même une fois le premier essai terminé. startTrial et createOrganization requièrent tous deux acceptedTermsVersion — la version des conditions générales de service en vigueur.

suggestOrganizationName renvoie un nom que vous pouvez donner à une nouvelle organisation. Chaque appel en suggère un différent ; il n'est pas réservé.

Une organisation listée porte les scopes que vous détenez dessus — ce que le tableau de bord montre ou masque est lu dans cette liste, et non déduit de votre rôle. Elle porte aussi member (si vous détenez un rôle dans cette organisation ou dans l'un de ses projets), role (votre rôle au niveau de l'organisation, absent pour les membres de projet uniquement), projectCount (les projets que vous pouvez voir) et initialTrialCredit (le crédit d'essai initial de l'organisation, en centimes — présent uniquement pendant la phase d'essai).

Le plan détermine la taille maximale des workloads, la durée de conservation des logs (maxLogRetentionDays) et la profondeur d'historique des métriques de ressources (maxMetricRetentionDays). Le changement prend effet immédiatement pour ce que le plan débloque ; la facturation change à partir de la prochaine facture. Un plan négocié (CUSTOM) ne peut être ni adopté ni quitté en libre-service — utilisez l'endpoint /plan/custom pour en informer notre équipe commerciale, qui s'en chargera.

Les endpoints de conditions par organisation indiquent où en est l'organisation vis-à-vis de la version en vigueur et de toute version à venir, l'historique de chaque décision passée, et un champ canDecide qui indique si l'appelant peut accepter ou refuser au nom de l'organisation. Seuls les propriétaires de l'organisation peuvent décider ; détenir le scope terms:update seul ne suffit pas. Consulter nécessite terms:get.


Projets​

Les projets et leur cycle de vie.

MéthodeCheminDescription
GET/api/v3/organizations/{organizationId}/projectsLister les projets d'une organisation
POST/api/v3/organizations/{organizationId}/projectsCréer un projet
PUT/api/v3/organizations/{organizationId}/projects/orderDéfinir l'ordre des projets d'une organisation
GET/api/v3/projects/{projectId}Récupérer un projet
DELETE/api/v3/projects/{projectId}Supprimer un projet
POST/api/v3/projects/{projectId}/restoreRestaurer un projet programmé pour suppression
GET/api/v3/locationsLister les localisations où créer un projet

Chaque projet porte une position — la place que l'organisation lui a donnée dans son propre classement. Le listing renvoie les projets par position croissante.

La création d'un projet répond 202 avec le projet en phase provisioning et un en-tête Location nommant l'opération à suivre. Le projet est prêt quand cette opération réussit, et failed si elle échoue. La localisation (fournisseur et région) est permanente — elle ne peut pas être changée après la création du projet.

La suppression programme le retrait du projet après un délai de grâce, arrête ses workloads et répond 202. Le projet doit être vide — supprimez d'abord ses ressources, sinon l'appel répond 409 en nommant ce qui reste. Ajouter force=true supprime le projet immédiatement : pas de délai de grâce et pas de retour en arrière. La restauration annule une suppression programmée ; le projet revient en suspended et ses workloads reprennent peu après. La restauration n'est jamais possible après une suppression forcée. Les deux retournent un Location à suivre.

Le listing accepte un filtre phase : provisioning, active, failed, suspended ou pendingDeletion.

setProjectOrder remplace l'ordre complet : projectIds liste tous les projets de l'organisation, du premier au dernier. La liste doit nommer exactement les projets actuels, chacun une fois ; sinon l'appel répond 409. Nécessite le scope projects/order:update (rôles MAINTAINER et OWNER). Accessible par session ou clé d'API.


Opérations​

La progression d'une mutation asynchrone.

Les mutations qui atteignent un cluster — créer un projet, en supprimer un, en restaurer un — répondent 202 et nomment l'opération à suivre dans leur en-tête Location. Interrogez-le jusqu'à ce que status soit terminal (succeeded, failed ou superseded), puis arrêtez.

MéthodeCheminDescription
GET/api/v3/projects/{projectId}/operations/{operationId}Lire la progression d'une mutation asynchrone

attemptCount et nextAttemptAt permettent au client d'afficher « nouvelle tentative dans 30 s » plutôt que de paraître figé pendant un backoff. Une opération superseded a été absorbée par une requête ultérieure sur la même ressource ; supersededBy nomme celle qui s'exécutera.

Les opérations terminées sont conservées 90 jours, puis supprimées. Enregistrez le résultat de votre côté si vous en avez besoin plus longtemps.


Membres​

Qui a accès à une organisation ou à un projet, et avec quel rôle.

Un rôle sur une organisation porte sur tous ses projets. Un rôle sur un projet porte sur ce projet seul et ne dit rien de l'organisation — les deux s'accordent, se modifient et se révoquent séparément, d'où chaque opération en double ci-dessous.

MéthodeCheminDescription
GET/api/v3/organizations/{organizationId}/membersLister les membres d'une organisation
POST/api/v3/organizations/{organizationId}/membersAjouter un membre à une organisation
PUT/api/v3/organizations/{organizationId}/members/{memberId}Changer le rôle d'un membre d'organisation
DELETE/api/v3/organizations/{organizationId}/members/{memberId}Retirer un membre d'une organisation
GET/api/v3/projects/{projectId}/membersLister les membres d'un projet
POST/api/v3/projects/{projectId}/membersAjouter un membre à un projet
PUT/api/v3/projects/{projectId}/members/{memberId}Changer le rôle d'un membre de projet
DELETE/api/v3/projects/{projectId}/members/{memberId}Retirer un membre d'un projet

L'ajout d'un membre crée toujours une invitation, que l'adresse ait déjà un compte SailOps ou non — la personne rejoint l'organisation une fois qu'elle l'accepte.


Invitations​

Un accès proposé à une adresse qui ne l'a pas encore accepté.

MéthodeCheminDescription
GET/api/v3/invite/{token}Lire une invitation depuis son lien
GET/api/v3/me/invitationsLister les invitations qui vous ont été envoyées
POST/api/v3/me/invitations/{invitationId}/acceptAccepter une invitation
POST/api/v3/me/invitations/{invitationId}/declineDécliner une invitation
GET/api/v3/organizations/{organizationId}/invitationsLister les invitations d'une organisation
DELETE/api/v3/organizations/{organizationId}/invitations/{invitationId}Révoquer une invitation d'organisation
GET/api/v3/projects/{projectId}/invitationsLister les invitations d'un projet
DELETE/api/v3/projects/{projectId}/invitations/{invitationId}Révoquer une invitation de projet

GET /api/v3/invite/{token} est ce qu'ouvre le lien d'invitation. Il nomme l'organisation et le rôle proposé, pour que la page s'affiche avant la connexion.

Le status d'une invitation est pending, declined ou expired. Décliner marque l'invitation pour que l'organisation voie le refus ; révoquer (les endpoints DELETE) supprime l'invitation immédiatement. L'ajout d'un membre crée toujours une invitation, que l'adresse ait déjà un compte SailOps ou non — la personne rejoint l'organisation une fois qu'elle l'accepte.


Clés d'API​

Les clés pour les scripts et la CI, bornées par le sujet auquel elles appartiennent.

Une clé appartient à l'un de trois sujets — vous, une organisation ou un projet — et ce qu'elle atteint découle de ce sujet. Le secret n'est renvoyé qu'une fois, par l'appel de création, et jamais ensuite. Voir le guide des clés d'API.

Quand vous créez ou modifiez une clé, vous choisissez les scopes qu'elle détient, bornés par ce que vous détenez vous-même. Omettez scopes pour l'ensemble par défaut, soit l'expansion DEVELOPER pour les clés d'organisation et de projet, soit votre propre accès pour une clé personnelle. La réponse indique ce que la clé a effectivement reçu.

Clés personnelles​

MéthodeCheminDescription
GET/api/v3/me/apikeysLister vos clés d'API personnelles
POST/api/v3/me/apikeysCréer une clé d'API personnelle
PATCH/api/v3/me/apikeys/{label}Modifier une clé d'API personnelle
DELETE/api/v3/me/apikeys/{label}Supprimer une clé d'API personnelle

Une clé personnelle agit en votre nom : elle atteint ce que vous atteignez au moment de chaque requête. Si vous perdez un rôle, la clé le perd avec vous. Elle ne porte jamais l'administration de la plateforme.

Clés d'organisation​

MéthodeCheminDescription
GET/api/v3/organizations/{organizationId}/apikeysLister les clés d'API d'une organisation
POST/api/v3/organizations/{organizationId}/apikeysCréer une clé d'API d'organisation
PATCH/api/v3/organizations/{organizationId}/apikeys/{label}Modifier une clé d'API d'organisation
DELETE/api/v3/organizations/{organizationId}/apikeys/{label}Supprimer une clé d'API d'organisation

Une clé d'organisation atteint tous les projets de l'organisation. Elle n'a pas de porteur : elle conserve ce que vous lui donnez même si votre propre accès change par la suite.

Clés de projet​

MéthodeCheminDescription
GET/api/v3/projects/{projectId}/apikeysLister les clés d'API d'un projet
POST/api/v3/projects/{projectId}/apikeysCréer une clé d'API de projet
PATCH/api/v3/projects/{projectId}/apikeys/{label}Modifier une clé d'API de projet
DELETE/api/v3/projects/{projectId}/apikeys/{label}Supprimer une clé d'API de projet

Une clé de projet n'atteint que le projet dans lequel elle a été créée. Ce qui relève de l'organisation reste hors de sa portée, quels que soient les scopes choisis.


Permissions​

Le catalogue des permissions qu'une clé peut détenir, et les presets depuis lesquels elle peut démarrer.

MéthodeCheminDescription
GET/api/v3/scopesLister les permissions qu'une clé peut recevoir

Chaque entrée nomme une permission, décrit ce qu'elle permet, indique si une opération l'accepte aujourd'hui, et liste les opérations qu'elle ouvre. Une permission pas encore servie peut tout de même être donnée à une clé — elle entre en vigueur dès que l'opération correspondante arrive, sans devoir recréer la clé.

La réponse contient aussi des presets — des ensembles de permissions prêts à l'emploi depuis lesquels une clé peut démarrer. Chaque preset a un nom stable (ex : DEVELOPER, READ_ONLY), un libellé, une description et la liste complète des scopes qu'il contient. Un preset est un point de départ, pas un lien : ce que la clé détient est l'ensemble écrit lors de sa création, un preset redéfini par la suite ne touche aucune clé existante.


Centre d'Alertes​

L'API unifiée d'investigation d'incidents et de configuration des alertes. Tous les endpoints utilisent la famille de scopes alert-center/. Les endpoints d'organisation lisent à travers tous les projets autorisés ; les endpoints de projet sont limités à un projet.

Ressources​

MéthodeCheminDescription
GET/api/v3/organizations/{organizationId}/alert-center/resourcesLister les ressources du centre d'alertes
GET/api/v3/projects/{projectId}/alert-center/resourcesLister les ressources du centre d'alertes

Renvoie les ressources auxquelles vous avez accès avec leurs identifiants immuables et noms de projet, pour utilisation dans les filtres de ressources.

Incidents​

MéthodeCheminDescription
GET/api/v3/organizations/{organizationId}/alert-center/incidentsLister les incidents de l'organisation
GET/api/v3/projects/{projectId}/alert-center/incidentsLister les incidents du projet
GET/api/v3/projects/{projectId}/alert-center/incidents/{incidentId}Récupérer les détails d'un incident
POST/api/v3/projects/{projectId}/alert-center/incidents/{incidentId}/acknowledgeAcquitter un incident
PUT/api/v3/projects/{projectId}/alert-center/incidents/{incidentId}/readMarquer un incident lu ou non lu

Le listing renvoie les incidents triés par sévérité puis par date de début la plus récente. La vue par défaut est attention ; les vues disponibles sont attention, acknowledged, unknown, history, executions et all. Filtrez par resourceId, severity, resourceType, resourceName, suspended et search. Utilisez since et until pour les bornes temporelles ; réutilisez le until de la première page sur les pages suivantes pour conserver un point de coupure stable.

Récupérer un incident renvoie ses preuves, les 500 derniers événements de chronologie et les 100 dernières livraisons de notification. L'état de lecture est personnel ; l'acquittement est partagé. Un identifiant d'alerte historique peut aussi identifier son incident.

Acquitter enregistre la prise de responsabilité sans modifier la condition observée. Marquer lu ou non lu est personnel et n'acquitte ni ne résout jamais.

Résumé​

MéthodeCheminDescription
GET/api/v3/organizations/{organizationId}/alert-center/summaryRécupérer les comptes d'incidents de l'organisation
GET/api/v3/projects/{projectId}/alert-center/summaryRécupérer les comptes d'incidents du projet

Renvoie les comptes par condition et acquittement, avec le compte personnel de non lus de l'appelant et un drapeau canConfigure. Les filtres de ressources s'appliquent à chaque compte.

Règles (Seuils)​

MéthodeCheminDescription
GET/api/v3/organizations/{organizationId}/alert-center/rulesLister les règles de l'organisation
PUT/api/v3/organizations/{organizationId}/alert-center/rules/{ruleKey}Modifier une règle d'organisation
DELETE/api/v3/organizations/{organizationId}/alert-center/rules/{ruleKey}Réinitialiser une règle d'organisation aux valeurs héritées
POST/api/v3/organizations/{organizationId}/alert-center/rules/{ruleKey}/activateActiver les notifications pour une règle d'organisation
GET/api/v3/projects/{projectId}/alert-center/rulesLister les règles du projet
PUT/api/v3/projects/{projectId}/alert-center/rules/{ruleKey}Modifier une règle de projet
DELETE/api/v3/projects/{projectId}/alert-center/rules/{ruleKey}Réinitialiser une règle de projet aux valeurs héritées
POST/api/v3/projects/{projectId}/alert-center/rules/{ruleKey}/activateActiver les notifications pour une règle de projet

Les règles renvoient les seuils effectifs, les valeurs héritées et l'éligibilité aux notifications. Passez resourceId pour lire les règles d'une ressource au lieu des valeurs par défaut de la portée. La mise à jour remplace la surcharge en utilisant une révision pour la concurrence ; la suppression restaure les paramètres du parent. L'activation nécessite sept jours d'observation, des mesures complètes et une destination activée.

Destinations (Canaux de Notification)​

MéthodeCheminDescription
GET/api/v3/organizations/{organizationId}/alert-center/destinationsLister les destinations de l'organisation
POST/api/v3/organizations/{organizationId}/alert-center/destinationsCréer une destination d'organisation
PUT/api/v3/organizations/{organizationId}/alert-center/destinations/{destinationId}Modifier une destination d'organisation
DELETE/api/v3/organizations/{organizationId}/alert-center/destinations/{destinationId}Supprimer une destination d'organisation
POST/api/v3/organizations/{organizationId}/alert-center/destinations/{destinationId}/testTester une destination d'organisation
GET/api/v3/projects/{projectId}/alert-center/destinationsLister les destinations du projet
POST/api/v3/projects/{projectId}/alert-center/destinationsCréer une destination de projet
PUT/api/v3/projects/{projectId}/alert-center/destinations/{destinationId}Modifier une destination de projet
DELETE/api/v3/projects/{projectId}/alert-center/destinations/{destinationId}Supprimer une destination de projet
POST/api/v3/projects/{projectId}/alert-center/destinations/{destinationId}/testTester une destination de projet

Les destinations nommées portent un canal (slack, teams, discord, mattermost, webhook), un groupe de livraison (primary ou backup), des sévérités activées et une URL HTTPS en écriture seule. Le test renvoie accepted, failed ou uncertain. Toutes les mutations utilisent des révisions pour le contrôle de concurrence.

Abonnements (Email)​

MéthodeCheminDescription
GET/api/v3/organizations/{organizationId}/alert-center/subscriptionRécupérer votre abonnement email d'organisation
PUT/api/v3/organizations/{organizationId}/alert-center/subscriptionModifier votre abonnement email d'organisation
GET/api/v3/projects/{projectId}/alert-center/subscriptionRécupérer votre abonnement email de projet
PUT/api/v3/projects/{projectId}/alert-center/subscriptionModifier votre abonnement email de projet

Abonnement email personnel pour les notifications d'alertes. L'activation nécessite un email vérifié. Requiert une identité de membre — les clés d'API n'ont pas d'état d'abonnement personnel.

Fenêtres de Maintenance​

MéthodeCheminDescription
GET/api/v3/organizations/{organizationId}/alert-center/maintenancesLister les fenêtres de maintenance de l'organisation
POST/api/v3/organizations/{organizationId}/alert-center/maintenancesCréer une fenêtre de maintenance d'organisation
DELETE/api/v3/organizations/{organizationId}/alert-center/maintenances/{maintenanceId}Annuler une fenêtre de maintenance d'organisation
GET/api/v3/projects/{projectId}/alert-center/maintenancesLister les fenêtres de maintenance du projet
POST/api/v3/projects/{projectId}/alert-center/maintenancesCréer une fenêtre de maintenance de projet
DELETE/api/v3/projects/{projectId}/alert-center/maintenances/{maintenanceId}Annuler une fenêtre de maintenance de projet

Les fenêtres de maintenance mettent en pause la livraison des notifications tandis que l'observation continue. Fournissez une raison, une heure de début et de fin. Optionnellement, limitez à une ressource avec resourceId. Le listing renvoie par défaut les fenêtres actives et à venir ; activez includeHistory pour inclure les fenêtres terminées et annulées.

Voir Canaux d'alerte pour la configuration des destinations et Vue d'ensemble des alertes pour les concepts.


Alertes (Legacy)​

Les endpoints d'alertes au niveau projet d'origine. Ils restent disponibles pour la rétrocompatibilité.

MéthodeCheminDescription
GET/api/v3/organizations/{organizationId}/alertsLister les alertes de tous les projets
GET/api/v3/organizations/{organizationId}/alerts/summaryRésumer les alertes de tous les projets
GET/api/v3/projects/{projectId}/alertsLister les alertes d'un projet
GET/api/v3/projects/{projectId}/alerts/summaryRésumer les alertes d'un projet

Le listing accepte diagnosticOnly, executionName et executionUid pour restreindre les résultats aux alertes portant un diagnostic de workload. Les endpoints d'organisation requièrent à la fois alerts:list et monitoring:list.

Notifications (Legacy)​

MéthodeCheminDescription
GET/api/v3/projects/{projectId}/notificationsLister où sont envoyées les alertes
PATCH/api/v3/projects/{projectId}/notifications/{severity}Changer où sont envoyées les alertes d'une sévérité
POST/api/v3/projects/{projectId}/notifications/{severity}/testEnvoyer une notification de test

Utilisez les endpoints de destinations du Centre d'Alertes pour le modèle de notification actuel.


Surveillance​

Les logs, événements, métriques et traces de tous les projets d'une organisation, en un seul endroit.

Toutes les opérations ici lisent à travers les projets et requièrent le scope monitoring:list. Accessibles par session ou clé d'API.

MéthodeCheminDescription
GET/api/v3/organizations/{organizationId}/logsRechercher les logs de tous les projets
GET/api/v3/organizations/{organizationId}/logs.txtTélécharger les logs de tous les projets
GET/api/v3/organizations/{organizationId}/eventsLister ce qui est arrivé aux ressources de tous les projets
GET/api/v3/organizations/{organizationId}/metricsLire l'utilisation des ressources de tous les projets
GET/api/v3/organizations/{organizationId}/tracesLister les traces de tous les projets
GET/api/v3/organizations/{organizationId}/observability/connectionsLister les workloads qui envoient de la télémétrie

Tous les endpoints acceptent projectId pour restreindre les résultats à un projet, et les paramètres de fenêtre temporelle since et until. Une réponse dont le champ partial est vrai signifie qu'au moins un projet n'a pas pu être atteint ; skipped nomme les projets omis.

La recherche de logs renvoie les lignes les plus récentes en premier, filtrables par type de workload, nom de workload, instance, container, niveau, stream et recherche textuelle. L'export de logs (logs.txt) diffuse les mêmes lignes en texte brut, les plus anciennes en premier, sans pagination — une fenêtre large est un long téléchargement.

Les événements sont ce que la plateforme a fait aux containers, jobs et cronjobs. Ils sont conservés environ une heure.

Les métriques renvoient une série par workload et par métrique (CPU, mémoire, stockage, instances en cours d'exécution) sur une fenêtre temporelle. stepSeconds définit l'intervalle entre deux points ; il est élargi quand la fenêtre produirait trop de points.

Les traces listent les traces rapportées par les workloads de l'organisation. available est faux quand l'organisation n'envoie pas encore de traces.

Les connexions d'observabilité listent chaque workload avec son état de configuration OpenTelemetry, l'endpoint d'envoi et les variables à configurer.


Audit​

Ce qui a été modifié dans une organisation et ses projets, par qui, et par quel moyen.

MéthodeCheminDescription
GET/api/v3/me/auditLister votre propre journal d'audit
GET/api/v3/organizations/{organizationId}/auditLister le journal d'audit de l'organisation
GET/api/v3/projects/{projectId}/auditLister le journal d'audit du projet

Votre journal personnel (/me/audit) renvoie ce qui a été fait avec vos identifiants, dans toutes les organisations auxquelles vous appartenez. Une clé d'API personnelle agit en votre nom : ce qu'elle a fait apparaît à côté de ce que vous avez fait depuis un navigateur — actorType distingue les deux.

Les trois acceptent since, until, actorType, source et action pour restreindre la fenêtre. Les listings d'organisation et de projet acceptent aussi actor, operationId, resourceType et resourceName. Les valeurs possibles de source sont ui, mcp, bosco, public_api, internal, webhook et cli.

Un changement appliqué en arrière-plan (comme la création ou la suppression d'un projet) produit deux entrées d'audit : une quand la requête est acceptée, et une quand l'opération se termine. L'action de la seconde entrée est le nom de l'opération suffixé .applied ou .failed. Les deux entrées portent le même operationId — l'identifiant du header Location — et filtrer par operationId renvoie la paire. Dans la console, cliquez sur l'icône de lien à côté d'une entrée pour afficher son opération.


Tickets de support​

Les questions et incidents remontés au support SailOps.

MéthodeCheminDescription
GET/api/v3/organizations/{organizationId}/ticketsLister les tickets de support
POST/api/v3/organizations/{organizationId}/ticketsOuvrir un ticket de support
GET/api/v3/organizations/{organizationId}/tickets/{ticketId}Récupérer 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
POST/api/v3/organizations/{organizationId}/tickets/{ticketId}/resolveRésoudre un ticket
POST/api/v3/organizations/{organizationId}/tickets/{ticketId}/reopenRouvrir un ticket

La liste des tickets inclut un horodatage lastSupportReplyAt sur chaque ticket auquel l'équipe support a répondu. Utilisez-le pour détecter les réponses non lues côté client.

Un ticket porte aussi :

  • firstResponseAt — la date de la première réponse d'un agent du support. La réponse automatique de Sonny ne compte pas.
  • aiState — l'état de la première réponse automatique : pending ou diagnosing (Sonny analyse la demande), answered (Sonny a publié sa réponse automatique unique), handedOff (Sonny s'est effacé sans répondre). Absent quand le ticket ne reçoit pas de réponse automatique. Dans tous les cas, un agent du support prend le relais.

Ce à quoi votre plan de support donne droit est décrit dans Obtenir de l'aide.


Facturation​

Ce qu'une organisation est facturée, et ce qu'elle a consommé pour l'être.

Consommation​

Combien de chaque ressource mesurée une organisation a consommé sur une fenêtre donnée.

MéthodeCheminDescription
GET/api/v3/organizations/{organizationId}/logUsageRécupérer la consommation de stockage de logs
GET/api/v3/organizations/{organizationId}/observabilityUsageRécupérer la consommation d'observabilité managée
GET/api/v3/organizations/{organizationId}/backupUsageRécupérer la consommation de stockage de sauvegardes

Les trois acceptent from et to (requis, date-times alignées à l'heure) pour définir la fenêtre. observabilityUsage accepte aussi hourlyLimit pour limiter le nombre d'entrées horaires retournées.

Coûts​

Faits de coûts pré-agrégés, filtrables par projet, type de workload et type de ressource.

MéthodeCheminDescription
GET/api/v3/organizations/{organizationId}/costsRécupérer les coûts d'une organisation
GET/api/v3/projects/{projectId}/costsRécupérer les coûts d'un projet
POST/api/v3/organizations/{organizationId}/costs.csvExporter les coûts d'une organisation en CSV

from, to et granularity (day ou month) contrôlent la fenêtre et la taille des buckets. L'export CSV accepte aussi format (localized ou rfc4180) et des tableaux d'exclusions (excludeProjects, excludeWorkloadKinds, excludeWorkloadIds, excludeResourceTypes).

Les réponses de coûts incluent un booléen optionnel objectStorageIncomplete, présent lorsque les mesures d'utilisation de l'Object Storage sont incomplètes. Les coûts n'incluent que l'utilisation reçue jusqu'à présent et restent provisoires tant que toutes les mesures ne sont pas arrivées.

Factures​

MéthodeCheminDescription
GET/api/v3/organizations/{organizationId}/invoicesLister les factures
GET/api/v3/organizations/{organizationId}/invoices/{invoiceId}/pdfTélécharger une facture en PDF

Seules les factures finalisées sont retournées — les brouillons, annulées et irrécouvrables sont absentes. La liste accepte les filtres state (READY, OVERDUE, PAID), search, issuedFrom et issuedTo, et supporte la pagination par curseur.

Moyens de paiement​

MéthodeCheminDescription
GET/api/v3/organizations/{organizationId}/paymentMethodsLister les moyens de paiement
PATCH/api/v3/organizations/{organizationId}/paymentMethods/{paymentMethodId}Définir un moyen de paiement par défaut
DELETE/api/v3/organizations/{organizationId}/paymentMethods/{paymentMethodId}Retirer un moyen de paiement
POST/api/v3/organizations/{organizationId}/setupIntentCommencer l'ajout d'un moyen de paiement
POST/api/v3/organizations/{organizationId}/confirmSetupFinaliser l'ajout d'un moyen de paiement
POST/api/v3/organizations/{organizationId}/portalSessionOuvrir le portail de facturation

L'ajout d'un moyen de paiement se fait en deux étapes : setupIntent renvoie un secret client pour que le navigateur collecte les informations de carte ou de mandat, puis confirmSetup enregistre le résultat. Le moyen de paiement par défaut ne peut pas être supprimé — il faut d'abord en désigner un autre.


Peerings​

Liens réseau privés entre deux projets de la même organisation.

Un peering ouvre un accès unidirectionnel depuis un workload (ou tous les workloads) d'un projet vers un service et un port spécifiques dans un autre. Les deux projets doivent appartenir à la même organisation. L'appelant doit détenir peerings:update sur le projet source et sur le projet cible — ouvrir un accès dans un projet est une modification de ce projet, quel que soit le demandeur. La révocation est asymétrique : chaque côté peut fermer un lien.

La création et la révocation répondent dès que la ligne est durable ; la politique réseau suit dans un cycle de réconciliation, et status indique où le peering en est.

MéthodeCheminDescription
GET/api/v3/organizations/{organizationId}/peeringsLister les peerings de l'organisation
DELETE/api/v3/organizations/{organizationId}/peerings/{peeringId}Révoquer un peering
POST/api/v3/projects/{projectId}/peeringsOuvrir un peering
GET/api/v3/projects/{projectId}/peeringCandidatesLister ce qu'un projet peut peerer depuis et vers

Le listing n'affiche par défaut que les peerings actifs — les terminaux (révoqués, invalidés, en échec) apparaissent quand includeTerminal est activé. sourceProjectId, targetProjectId et status affinent la page.

listPeeringCandidates répond des deux côtés du formulaire de création pour un projet : les sources depuis le registre de produits (une source n'a pas besoin de Service — un cron job suffit) et les cibles depuis le cluster (seuls les Services disent quelles adresses et quels ports existent).

Voir Project Peerings pour les concepts, statuts et guide d'utilisation.


Juridique​

Les conditions générales de service, consultables sans authentification.

MéthodeCheminDescription
GET/api/v3/legal/termsLister les versions des conditions générales de service
GET/api/v3/legal/terms/{version}Lire une version des conditions générales de service
GET/api/v3/legal/terms/{version}/pdfTélécharger une version des conditions générales de service

Ces endpoints sont publics et ne nécessitent ni session ni clé d'API. Le texte Markdown renvoyé par getTerms est la version française faisant foi par défaut ; passez lang=en pour la traduction anglaise de courtoisie. Le PDF est disponible dans les deux langues.


Registry credentials​

Les identifiants qu'un projet utilise pour récupérer des images depuis des registres privés.

Un projet détient un identifiant par registre. Le nom d'hôte est canonicalisé à l'enregistrement (ghcr.io, https://ghcr.io/v2/ et GHCR.IO pointent tous vers la même entrée) et ne peut pas être modifié après création — supprimez l'identifiant et ajoutez-en un autre pour un registre différent.

Les mutations stockent l'identifiant et répondent immédiatement. Le pull secret apparaît dans le projet en quelques secondes ; status suit la progression : PENDING (stocké, pas encore utilisable), ACTIVE (dans le projet), FAILED (impossible à installer, nouvelle tentative en cours) ou REMOVING (en cours de suppression). Les mots de passe ne sont jamais renvoyés.

MéthodeCheminDescription
GET/api/v3/projects/{projectId}/registryCredentialsLister les identifiants de registre d'un projet
POST/api/v3/projects/{projectId}/registryCredentialsAjouter un identifiant de registre à un projet
PUT/api/v3/projects/{projectId}/registryCredentials/{credentialId}Remplacer un identifiant de registre
DELETE/api/v3/projects/{projectId}/registryCredentials/{credentialId}Supprimer un identifiant de registre
POST/api/v3/projects/{projectId}/registryCredentials/{credentialId}/testTester un identifiant de registre détenu par le projet
POST/api/v3/projects/{projectId}/registryCredentials/testTester un identifiant de registre sans le stocker

Les deux endpoints de test s'authentifient auprès du registre et rapportent le résultat, y compris la détection du fournisseur et la vérification des scopes pour les tokens GitHub et GitLab. Ils sont limités en débit par organisation.

Le test d'un identifiant enregistré (/{credentialId}/test) utilise le mot de passe sauvegardé — rien n'a besoin d'être saisi à nouveau. Le test autonome (/test) prend l'identifiant complet dans le corps de la requête.

Les deux acceptent un champ image optionnel. Lorsqu'il est fourni, le registre est aussi interrogé pour le manifeste de l'image, ce qui prouve que l'identifiant peut la récupérer — sur n'importe quel registre, alors que sans image seuls les tokens GitHub et GitLab peuvent voir leurs permissions inspectées.

Voir Docker Registry pour le guide d'utilisation et la configuration spécifique à chaque fournisseur.


Fournisseurs DNS​

Les registrars par lesquels un projet publie ses enregistrements DNS.

Un fournisseur DNS stocke les identifiants d'un registrar supporté et, une fois installé, exécute un contrôleur qui synchronise les enregistrements DNS du projet avec ses gateways et ses sites web. Le contrôleur apparaît dans la minute suivant la création ; status indique où il en est (PENDING, ACTIVE, FAILED, REMOVING), et sync porte ce qu'il rapporte de sa propre synchronisation — santé, code d'erreur, dates de dernière synchronisation et nombre d'enregistrements gérés — échantillonné périodiquement et publié avec l'instant de la prise.

Les identifiants sont scellés au repos et jamais renvoyés. La réponse porte settings à la place : la moitié non secrète de la configuration (région, endpoint, proxy Cloudflare).

Un projet détient un fournisseur par nom. Ni le nom ni le type ne peuvent changer après création — supprimez le fournisseur et ajoutez-en un autre.

MéthodeCheminDescription
GET/api/v3/projects/{projectId}/dnsProvidersLister les fournisseurs DNS d'un projet
POST/api/v3/projects/{projectId}/dnsProvidersAjouter un fournisseur DNS à un projet
PUT/api/v3/projects/{projectId}/dnsProviders/{providerId}Remplacer les identifiants et les zones d'un fournisseur DNS
DELETE/api/v3/projects/{projectId}/dnsProviders/{providerId}Supprimer un fournisseur DNS

La création répond 201 avec le fournisseur en statut PENDING. La mise à jour (PUT) remplace les identifiants et le filtre de domaines optionnel ; elle réinitialise sync car ce que le précédent contrôleur rapportait ne s'applique plus. La suppression répond 200 avec le fournisseur en statut REMOVING ; le contrôleur et ses identifiants quittent le projet dans la minute, après quoi ses enregistrements ne sont plus mis à jour. Les enregistrements déjà publiés chez le registrar restent en l'état. Le fournisseur reste listé, et son nom réservé, tant que son contrôleur n'a pas disparu.

Le tableau domains restreint les zones que le fournisseur gère. Omettez-le (ou laissez-le vide) pour lui permettre de gérer toutes les zones accessibles par ses identifiants.

Types de fournisseurs supportés : CLOUDFLARE, OVH, AWS, AZURE, GANDI, GODADDY, DIGITAL_OCEAN, IONOS, SCALEWAY. Chaque type a sa propre forme d'identifiants, envoyée en union discriminée par type dans le champ credentials. Voir la référence interactive pour le schéma complet de chacun.

Voir DNS Providers pour le guide d'utilisation et la configuration spécifique à chaque fournisseur.


Valkey​

Les instances Valkey d'un projet.

Une instance est adressée par son nom — le nom est unique par projet et ne peut pas être changé après création. Chaque écriture répond 202 et nomme une opération à suivre dans son en-tête Location, car chaque écriture atteint un membre du cluster. L'instance est prête quand l'opération réussit.

MéthodeCheminDescription
GET/api/v3/projects/{projectId}/valkeyLister les instances Valkey d'un projet
POST/api/v3/projects/{projectId}/valkeyCréer une instance Valkey
GET/api/v3/projects/{projectId}/valkey/{name}Récupérer une instance Valkey
PUT/api/v3/projects/{projectId}/valkey/{name}Remplacer la configuration d'une instance Valkey
DELETE/api/v3/projects/{projectId}/valkey/{name}Supprimer une instance Valkey
GET/api/v3/projects/{projectId}/valkey/{name}/metricsLire ce que fait une instance Valkey
GET/api/v3/projects/{projectId}/valkey/{name}/adminCredentialsLire les identifiants de l'interface d'administration
POST/api/v3/projects/{projectId}/valkey/{name}/adminCredentials/rotateRenouveler les identifiants de l'interface d'administration

La création répond 202 avec l'instance en phase pending. L'en-tête Location nomme l'opération à suivre ; l'instance accepte les connexions quand cette opération réussit, et passe à failed si elle échoue.

Le remplacement envoie la configuration complète : ce que vous envoyez est ce que l'instance devient, et un champ omis reprend sa valeur par défaut. Deux choses ne peuvent pas changer — la version est fixée à la création, et le stockage peut augmenter mais jamais diminuer. Omettez auth.password pour conserver l'actuel ; envoyez-en un nouveau pour le renouveler.

La suppression détruit l'instance et ses données sans restauration possible. Tant que quelque chose y est connecté, l'appel répond 409 en nommant ce qui est connecté — supprimez d'abord ces connexions.

Le listing n'est pas paginé — un projet contient une poignée d'instances. state est lu quand vous le demandez : il indique ce que la plateforme observe à cet instant. Les phases sont pending, running, stopped, degraded, failed et deleting.

Les métriques renvoient une fenêtre de mesures : processeur et mémoire de chaque shard, et ce que le moteur rapporte — connexions, opérations, keyspace, persistence. Un point dont observed est faux ne porte pas de mesure et ne doit pas être lu comme un zéro. Paramètres : since, until et stepSeconds (élargi quand la fenêtre produirait trop de points).

Les identifiants d'administration renvoient l'utilisateur et le mot de passe de l'interface web Valkey Admin, disponibles tant que admin.enabled est vrai. Le renouvellement les remplace ; les précédents cessent de fonctionner une fois l'opération réussie.

Tous les endpoints Valkey utilisent la famille de scopes valkey:list, valkey:update ou valkey:delete. Accessibles par session ou clé d'API.

Voir Vue d'ensemble du cache pour les concepts et Configuration du cache pour les options.


MariaDB​

Les instances MariaDB d'un projet, leurs utilisateurs et leurs schémas.

Une instance est adressée par son nom — le nom est unique par projet et ne peut pas être changé après création. Chaque écriture répond 202 et nomme une opération à suivre dans son en-tête Location, car chaque écriture atteint un membre du cluster. L'instance est prête quand l'opération réussit.

MéthodeCheminDescription
GET/api/v3/projects/{projectId}/mariadbLister les instances MariaDB d'un projet
POST/api/v3/projects/{projectId}/mariadbCréer une instance MariaDB
GET/api/v3/projects/{projectId}/mariadb/{name}Récupérer une instance MariaDB
PUT/api/v3/projects/{projectId}/mariadb/{name}Remplacer la configuration d'une instance MariaDB
DELETE/api/v3/projects/{projectId}/mariadb/{name}Supprimer une instance MariaDB
GET/api/v3/projects/{projectId}/mariadb/{name}/usersLister les utilisateurs d'une instance MariaDB
POST/api/v3/projects/{projectId}/mariadb/{name}/usersAjouter un utilisateur à une instance MariaDB
DELETE/api/v3/projects/{projectId}/mariadb/{name}/users/{userName}Retirer un utilisateur d'une instance MariaDB
POST/api/v3/projects/{projectId}/mariadb/{name}/users/{userName}/resetPasswordRéinitialiser le mot de passe d'un utilisateur MariaDB
GET/api/v3/projects/{projectId}/mariadb/{name}/schemasLister les schémas d'une instance MariaDB
POST/api/v3/projects/{projectId}/mariadb/{name}/schemasAjouter un schéma à une instance MariaDB
DELETE/api/v3/projects/{projectId}/mariadb/{name}/schemas/{schemaName}Supprimer un schéma d'une instance MariaDB
GET/api/v3/projects/{projectId}/mariadb/{name}/backupsLister les sauvegardes d'une instance MariaDB
POST/api/v3/projects/{projectId}/mariadb/{name}/backupsPrendre une sauvegarde d'une instance MariaDB
GET/api/v3/projects/{projectId}/mariadb/{name}/backups/{backupId}Récupérer une sauvegarde d'une instance MariaDB
POST/api/v3/projects/{projectId}/mariadb/{name}/backups/{backupId}/downloadObtenir un lien de téléchargement d'une sauvegarde
POST/api/v3/projects/{projectId}/mariadb/{name}/backups/{backupId}/encryptedDownloadTélécharger une sauvegarde, chiffrée
POST/api/v3/projects/{projectId}/mariadb/{name}/restoreRestaurer une instance MariaDB depuis une sauvegarde
GET/api/v3/projects/{projectId}/mariadb/{name}/logsLire les logs d'une instance MariaDB
GET/api/v3/projects/{projectId}/mariadb/{name}/metricsLire ce que fait une instance MariaDB

La création répond 202 avec l'instance en phase pending. Au moins un utilisateur et un schéma sont requis à la création — une instance sans utilisateur est une base à laquelle personne ne peut se connecter. Par la suite, les utilisateurs et les schémas s'ajoutent et se retirent par leurs propres opérations, et un remplacement de la configuration ne les mentionne pas.

Le remplacement envoie la configuration complète : ce que vous envoyez est ce que l'instance devient, et un champ omis reprend sa valeur par défaut. Deux choses ne peuvent pas changer — la version est fixée à la création, et le stockage peut augmenter mais jamais diminuer.

La suppression détruit l'instance, tous ses schémas et toutes ses sauvegardes. Tant que quelque chose y est connecté, l'appel répond 409 en nommant ce qui est connecté — supprimez d'abord ces connexions.

Le listing n'est pas paginé — un projet contient une poignée d'instances. state est lu quand vous le demandez : il indique ce que la plateforme observe à cet instant. Les phases sont pending, running, stopped, degraded, failed et deleting.

Les utilisateurs peuvent se connecter et détiennent des privilèges par schéma. Les mots de passe ne sont jamais renvoyés ; réinitialisez-en un pour définir un nouveau mot de passe. Un grant nommant un schéma que l'instance ne possède pas est refusé. Un utilisateur créé par un autre service du projet porte readOnly: true et managedBy (kind et nom de ce service) ; le supprimer ou réinitialiser son mot de passe répond CONFLICT.

Les schémas portent le jeu de caractères et la collation fixés à la création. Supprimer un schéma détruit toutes ses tables — c'est la seule opération sur une instance qui perd des données sans détruire l'instance. Un schéma géré par un autre service porte readOnly: true et managedBy ; le supprimer répond CONFLICT.

Les sauvegardes sont conservées aussi longtemps que backup.retentionDays l'indique, et toutes les sauvegardes d'une instance sont détruites avec elle. Le téléchargement simple renvoie un lien présigné ; le téléchargement chiffré diffuse un ZIP chiffré en AES-256 avec le mot de passe que vous envoyez.

La restauration remplace le contenu de l'instance par celui de la sauvegarde. Tout ce qui a été écrit depuis cette sauvegarde est perdu.

Les logs renvoient des lignes de log dans une fenêtre temporelle. Ils peuvent contenir du texte de requête, c'est pourquoi leur lecture nécessite le scope mariadb/logs:list plutôt que mariadb:list.

Les métriques renvoient une fenêtre de mesures : processeur, mémoire et disque des nœuds, et ce que le moteur rapporte — connexions, requêtes, le buffer pool InnoDB, le réseau et la réplication. Un point dont observed est faux ne porte pas de mesure et ne doit pas être lu comme un zéro. Paramètres : since, until et stepSeconds (élargi quand la fenêtre produirait trop de points).

Tous les endpoints MariaDB utilisent la famille de scopes mariadb:list, mariadb:update, mariadb:delete ou mariadb/logs:list. Accessibles par session ou clé d'API.

Voir Vue d'ensemble de MariaDB pour les concepts et Configuration des bases de données pour les options.


Kafka​

Les clusters Kafka d'un projet, leurs topics et leurs utilisateurs.

Un cluster est adressé par son nom — le nom est unique par projet et ne peut pas être changé après création. Chaque écriture répond 202 et nomme une opération à suivre dans son en-tête Location, car chaque écriture atteint un membre du cluster. Le cluster est prêt quand l'opération réussit.

MéthodeCheminDescription
GET/api/v3/projects/{projectId}/kafkaLister les clusters Kafka d'un projet
POST/api/v3/projects/{projectId}/kafkaCréer un cluster Kafka
GET/api/v3/projects/{projectId}/kafka/{name}Récupérer un cluster Kafka
PUT/api/v3/projects/{projectId}/kafka/{name}Remplacer la configuration d'un cluster Kafka
DELETE/api/v3/projects/{projectId}/kafka/{name}Supprimer un cluster Kafka
GET/api/v3/projects/{projectId}/kafka/{name}/topicsLister les topics d'un cluster Kafka
POST/api/v3/projects/{projectId}/kafka/{name}/topicsAjouter un topic à un cluster Kafka
PUT/api/v3/projects/{projectId}/kafka/{name}/topics/{topicName}Remplacer la configuration d'un topic
DELETE/api/v3/projects/{projectId}/kafka/{name}/topics/{topicName}Supprimer un topic d'un cluster Kafka
GET/api/v3/projects/{projectId}/kafka/{name}/usersLister les utilisateurs d'un cluster Kafka
POST/api/v3/projects/{projectId}/kafka/{name}/usersAjouter un utilisateur à un cluster Kafka
PUT/api/v3/projects/{projectId}/kafka/{name}/users/{userName}Modifier les droits d'un utilisateur Kafka
DELETE/api/v3/projects/{projectId}/kafka/{name}/users/{userName}Retirer un utilisateur d'un cluster Kafka
POST/api/v3/projects/{projectId}/kafka/{name}/users/{userName}/resetPasswordRéinitialiser le mot de passe d'un utilisateur Kafka
GET/api/v3/projects/{projectId}/kafka/{name}/uiCredentialsLire les identifiants de l'interface Kafka UI
POST/api/v3/projects/{projectId}/kafka/{name}/uiCredentials/rotateRenouveler les identifiants de l'interface Kafka UI
GET/api/v3/projects/{projectId}/kafka/{name}/metricsLire ce que fait un cluster Kafka

La création répond 202 avec le cluster en phase pending. Les topics et les utilisateurs s'ajoutent par leurs propres opérations, et celles-ci peuvent être envoyées immédiatement — elles attendent que le cluster soit en service. Le nom est ce par quoi le cluster est adressé ensuite et ne peut pas être changé.

Le remplacement envoie la configuration complète : ce que vous envoyez est ce que le cluster devient, et un champ omis reprend sa valeur par défaut. La version, le nombre de nœuds et la classe de stockage sont fixés à la création. Le processeur, la mémoire et le stockage peuvent augmenter mais jamais diminuer — un flavor plus petit ou un disque plus petit est refusé. Un changement de flavor ou de classe de calcul redémarre les nœuds un par un.

La suppression détruit le cluster, tous ses topics et tous ses messages. Kafka ne conserve aucune sauvegarde. Tant que quelque chose y est connecté, l'appel répond 409 en nommant ce qui est connecté — supprimez d'abord ces connexions.

Le listing n'est pas paginé. state est lu quand vous le demandez : il indique ce que la plateforme observe à cet instant. Les phases sont pending, running, stopped, degraded, failed et deleting.

Les topics sont créés par l'API ; un topic créé directement sur les brokers n'apparaît pas. Les partitions peuvent augmenter mais jamais diminuer. Le facteur de réplication est fixé à la création. Un nom qui ne diffère d'un topic existant que par . et _ est refusé, comme Kafka le refuse. Les noms commençant par __ appartiennent à Kafka et sont refusés. Supprimer un topic détruit tous ses messages.

Les utilisateurs s'authentifient avec SCRAM-SHA-512 sous le username que la réponse porte, qui est dérivé du nom, pas le nom lui-même. Les niveaux d'accès sont readonly, readwrite et full, appliqués à tous les topics et consumer groups. Les mots de passe ne sont jamais renvoyés ; réinitialisez-en un pour définir un nouveau mot de passe. Les noms commençant par connection- sont réservés.

Les identifiants UI renvoient l'utilisateur et le mot de passe de l'interface web Kafka UI, disponibles tant que ui.enabled est vrai. Le renouvellement les remplace ; les précédents cessent de fonctionner une fois l'opération réussie.

Les métriques renvoient une fenêtre de mesures : processeur, mémoire, disque et nombre de nœuds en service. Un point dont observed est faux ne porte pas de mesure et ne doit pas être lu comme un zéro. Paramètres : since, until et stepSeconds (élargi quand la fenêtre produirait trop de points).

Tous les endpoints Kafka utilisent la famille de scopes kafka:list, kafka:update ou kafka:delete. Accessibles par session ou clé d'API.

Voir Apache Kafka pour les concepts.


Pas encore ici​

Les conteneurs, sites web, jobs, PostgreSQL, gateways et le Stack Engine sont servis par l'API publique, inchangée et toujours supportée. La création, l'archivage, la facturation et le changement de plan d'une organisation, ainsi que le cycle de vie des projets (création, suppression, restauration), ne sont plus servis par l'API v1. Les ressources restantes migrent ici une par une ; cette page grandit à mesure.