Premiers pas avec l’API
API et automatisation
Automatisez les déploiements, le réseau et la facturation avec l’API Serverside.com. Commencez par un workflow ou explorez la référence des points de terminaison.
Utilisez ces pages pour gérer Serverside.com depuis des scripts et des intégrations. Pour les instructions dans la console cloud, ouvrez la documentation.
Commencer avec l’API
Workflows d’automatisation
- Déployer un serveur : clés SSH, cloud-init et progression du déploiement.
- Alimentation et accès distant : commandes d’alimentation, sessions console et supports virtuels.
- Scripts iPXE personnalisés : configurez un workflow de démarrage personnalisé.
- Gérer les adresses IP : attribution des adresses et DNS inverse.
- Configurer les réseaux virtuels : création de réseaux et rattachement des serveurs.
Référence des points de terminaison
https://api.serverside.com
Les requêtes transmettent une clé API d’organisation comme jeton Bearer dans l’en-tête Authorization (Authentification). Un appel réussi renvoie success, data et, pour une liste paginée, pagination ; un échec renvoie un statut HTTP et l’enveloppe d’erreur, dont le code indique le problème (Conventions API).
La référence répertorie uniquement les opérations qu’une clé peut appeler. Les membres, rôles, invitations, clés API, notifications, votre profil et les tickets de support se gèrent dans la console cloud ; leurs points de terminaison renvoient 401 à une clé (Opérations inaccessibles à une clé).
Chaque page de point de terminaison répertorie les paramètres et champs, nomme la permission requise lorsqu’elle est vérifiée et fournit un exemple de corps pour chaque statut possible, erreurs comprises. La requête est fournie en cURL, Node.js, Python, Go, PHP, Ruby, Java, C# et PowerShell ; Try it l’envoie à l’API réelle avec la clé que vous collez.
La référence est générée à partir du document OpenAPI client de l’API, qui décrit les opérations accessibles à une clé API d’organisation. Téléchargez-le en JSON pour générer un client ou l’importer dans un outil API.
Groupes de points de terminaison
| Domaine | Groupe | Contenu |
|---|---|---|
| Bare metal | Serveurs | Lister, créer en facturation horaire, renommer, verrouiller et supprimer des serveurs ; état, abonnement et réseaux virtuels de chacun |
| Alimentation | Commandes d’alimentation, réinitialisation BMC, mesures PSU, thermiques et électriques | |
| Opérations | Images système et applications, déploiements, tests matériels et leur annulation | |
| Accès distant | Sessions console et supports virtuels | |
| Démarrage et iPXE | Script iPXE personnalisé et mode de démarrage | |
| ISO du service | ISO montables par un serveur et ISO montées | |
| Réseau | Ports, segments, résultats d’analyse de sécurité | |
| Bande passante | Transfert quotidien comparé au quota mensuel et historique des débits | |
| Activité | Journal d’audit d’un serveur | |
| Réseau | Réseaux virtuels | Création des réseaux, tags VLAN, rattachement et détachement des serveurs |
| Blocs d’IP | Liste des blocs et de leurs adresses, ajout ou restitution d’un bloc | |
| Adresses IP | Attribution, réservation et libération des adresses ; DNS inverse IPv4 | |
| Analyses de sécurité | Résultats, cibles et nouvelles analyses | |
| Facturation | Commandes | Passer et consulter des commandes |
| Abonnements | État du renouvellement et résiliation | |
| Factures | Consultation, paiement et téléchargement des factures | |
| Usage | Frais de la période en cours | |
| Crédit et Moyens de paiement | Crédit du compte et cartes enregistrées | |
| Catalogue | Offres | Offres bare metal et blocs d’IP avec prix et stocks |
| Régions | Datacenters où commander des services, avec leurs codes | |
| Organisation | Droits | Limites et fonctionnalités activées pour l’organisation, dont la facturation horaire |
| Clés SSH | Clés publiques à installer sur les nouveaux serveurs | |
| Activité | Journal d’audit de l’organisation | |
| Ressources | Bibliothèque ISO | Téléversement et suppression des ISO montées par les supports virtuels |
canadien et 
néerlandais
