VPS.org API Documentation

Commencer

L'API de VPS.org vous permet de gérer par programmation tous les aspects de votre infrastructure d'hébergement VPS, y compris les serveurs, les domaines, les enregistrements DNS, les sauvegardes et les instantanés.

Authentification

Toutes les requêtes API nécessitent une authentification par jeton Bearer. Vous pouvez générer votre jeton API dans les paramètres de votre compte. admin.vps.org/account/developers/.

curl -X GET https://admin.vps.org/api/v1/servers/ \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

import requests

url = "https://admin.vps.org/api/v1/servers/"
headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json"
}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch('https://admin.vps.org/api/v1/servers/', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_API_TOKEN',
    'Content-Type': 'application/json'
  }
});

const data = await response.json();
console.log(data);

Chaque jeton porte ses propres permissions, telles que servers:list ou dns:*. Une requête qui a besoin d'une autorisation que le jeton n'a pas est refusée avec 403 et un champ required_permission nommant la permission manquante. Référence des autorisations

limitation de débit

Les demandes authentifiées sont limitées à 1 000 par heure par compte. Les demandes non authentifiées sont limitées à 100 par heure par adresse IP. Une demande dépassant la limite reçoit 429 avec un en-tête Retry-Après donnant le nombre de secondes à attendre. Aucun en-tête de limite de taux n'est envoyé sur les réponses réussies.

Pagination

Les paramètres de liste renvoient un objet avec le nombre, le suivant, le précédent et les résultats, 25 éléments par page. Passez la page pour déplacer entre les pages, ou suivez l'URL suivante jusqu'à ce qu'elle soit nulle. La liste des serveurs accepte également page_size, jusqu'à 100.

{
  "count": 84,
  "next": "https://admin.vps.org/api/v1/backups/?page=2",
  "previous": null,
  "results": [ ... ]
}

Gestion des erreurs

L'API utilise les codes d'état HTTP standard pour indiquer le succès ou l'échec :

Les corps d'erreur sont JSON. La plupart ont un champ de détail ou un champ d'erreur, parfois avec un message; erreurs de validation listent les problèmes par nom de champ.

Catégories d'API

Consultez notre documentation API par catégorie :

Autres points de fin

L'API a également des paramètres pour les déploiements d'applications (/api/v1/deploy-configs/ et /api/v1/deployments/). Ils ne sont pas encore décrits sur ces pages; la référence interactive liste tous les paramètres, générés à partir de l'API en direct.

Besoin d'aide ?

Si vous avez des questions ou besoin d'aide concernant l'API, n'hésitez pas à nous contacter :

• Tickets d'assistance : Ouvrir un ticket d'assistance
• E-mail: hello@vps.org
• Documentation: Documentation complète