Tous les points de terminaison renvoient application/json. Les erreurs suivent la RFC 7807 (Problem+JSON). Chaque réponse porte un en-tête X-Request-Id pour la corrélation avec le journal d'audit côté serveur.
| Method | Path | Permission | Objet |
|---|---|---|---|
| GET | /v1/health | public | Contrôle de santé non authentifié. |
| GET | /v1/me | any | Informations de votre compte et métadonnées de la clé. |
| GET | /v1/products | read:products | Liste de tous les produits listés publiquement avec leurs prix. |
| GET | /v1/products/{id} | read:products | Détails du produit incluant les options de configuration. |
| POST | /v1/orders | write:orders | Passer une commande. Idempotency-Key obligatoire. |
| GET | /v1/orders/{id} | read:orders | Statut d'une de vos commandes. |
| GET | /v1/services | read:services | Liste de vos services (paginée). |
| GET | /v1/services/{id} | read:services | Détails de l'un de vos services. |
| GET | /v1/services/{id}/credentials | read:credentials | Identifiants du service (permission distincte, journalisé en audit). |
| POST | /v1/services/{id}/actions | write:services | Action de service : start, stop, reboot, cancel (en fin de période de facturation), cancel_revoke. |
| GET | /v1/services/{id}/metrics | read:services | Métriques serveur d'un service vous appartenant (CPU, mémoire, réseau). |
| GET | /v1/services/{id}/ddos/profiles | read:ddos | Profils Advanced DDoS Protection disponibles. |
| GET | /v1/services/{id}/ddos/rules | read:ddos | Règles actuelles de l'IP protégée attribuée. |
| POST | /v1/services/{id}/ddos/rules | write:ddos | Ajouter une règle de protection. Idempotency-Key obligatoire. |
| DELETE | /v1/services/{id}/ddos/rules/{rule_id} | write:ddos | Supprimer une de vos règles. Idempotency-Key obligatoire. |
| GET | /v1/services/{id}/ddos/attacks | read:ddos | Attaques détectées sur l'IP protégée (Remote DDoS Protection). |
| GET | /v1/services/{id}/ddos/attacks/{attack_id} | read:ddos | Détails d'une attaque : trafic et répartitions. |
| GET | /v1/billing/balance | read:billing | Solde de crédit. |
| GET | /v1/billing/invoices | read:billing | Liste de vos factures (paginée). |
| GET | /v1/billing/invoices/{id}/pdf | read:billing | PDF de la facture. |
| GET | /v1/webhooks | read:webhooks | URL de webhook actuelle. |
| PUT | /v1/webhooks | write:webhooks | Définir ou retirer l'URL du webhook. |
Règles Advanced DDoS Protection
Ces points d'accès nécessitent un service Advanced DDoS Protection appartenant à votre compte. La lecture est possible avec le statut active ou suspended ; les modifications exigent le statut active. Activez explicitement read:ddos pour la lecture et write:ddos pour les modifications sur votre clé API. Les clés existantes ne reçoivent aucun nouveau droit automatiquement. La gestion des tunnels et de la liste blanche n'est pas disponible.
Choisissez app_code dans le catalogue des profils. port doit être un entier de 1 à 65535 ; pour icmp, omettez-le ou envoyez 0. L'objet facultatif extra_ports associe les libellés exacts du profil à des ports entiers ; les libellés omis conservent les valeurs par défaut du profil. Le serveur détermine les protocoles : n'envoyez pas protocol. Un champ ou libellé inconnu entraîne HTTP 400.
GET /v1/services/{id}/ddos/profiles
{
"data": [{
"app_code": "rust",
"name": "Rust",
"default_port": 28015,
"protocol": "UDP",
"extra_ports": [
{"name": "Query", "port": 28016, "protocol": "UDP"},
{"name": "RCON", "port": 28016, "protocol": "TCP"},
{"name": "RustPlus", "port": 28082, "protocol": "TCP"}
]
}],
"meta": {"service_id": 1234, "protection_ip": "192.0.2.10", "max_rules": 1000}
}
POST /v1/services/{id}/ddos/rules
{
"app_code": "rust",
"port": 28015,
"extra_ports": {"Query": 28016, "RCON": 28016, "RustPlus": 28082}
}
POST renvoie HTTP 201 avec la règle créée dans data. GET renvoie les règles et meta avec service_id, protection_ip et max_rules. DELETE utilise un corps vide et renvoie HTTP 200 comme ci-dessous. POST et DELETE exigent tous deux Idempotency-Key.
GET /v1/services/{id}/ddos/rules
{
"data": [{
"id": "example-rule-id",
"app_code": "rust",
"port": 28015,
"protocol": "UDP",
"extra_ports": [
{"name": "Query", "port": 28016, "protocol": "UDP"},
{"name": "RCON", "port": 28016, "protocol": "TCP"},
{"name": "RustPlus", "port": 28082, "protocol": "TCP"}
]
}],
"meta": {"service_id": 1234, "protection_ip": "192.0.2.10", "max_rules": 1000}
}
DELETE /v1/services/{id}/ddos/rules/{rule_id}
{"data": {"id": "example-rule-id", "deleted": true}}
Le panel et l'API partagent des fenêtres UTC fixes : 10 tentatives d'écriture par minute et par compte, 5 par minute et par IP protégée, 200 par jour UTC et par compte. Les tentatives admises mais invalides ou échouées sont comptées ; les répétitions idempotentes réussies ne le sont pas. Les lectures DDoS de l'API partagent 30 requêtes par minute et par compte. Maximum : 1000 règles par IP protégée.
HTTP 404 : service inconnu ou appartenant à autrui, ou règle absente, appartenant à autrui ou système. HTTP 409 : service autre qu'Advanced DDoS Protection (not_supported_for_product), service inactif, conflit de port ou modification simultanée. HTTP 429 : limite atteinte, respectez Retry-After. HTTP 502 : le service de protection n'a pas pu terminer la requête. La règle système block est masquée et ne peut pas être supprimée. HTTP 503 : les limites de requêtes sont temporairement indisponibles, respectez Retry-After.
Rapports d'attaques DDoS
Ces points d'accès nécessitent un service Remote DDoS Protection appartenant à votre compte, avec le statut active ou suspended, ainsi que la permission read:ddos, à activer explicitement. La liste présente les attaques DDoS détectées sur l'adresse IP protégée du service, de la plus récente à la plus ancienne.
Paramètres de requête : from et to, sous forme de date (YYYY-MM-DD) ou de date et heure ISO 8601 avec fuseau horaire (par défaut : les 30 derniers jours), limit de 1 à 100 (par défaut 25) et offset de 0 à 9999 (par défaut 0). La période ne remonte jamais à plus de 90 jours ni avant l'attribution de l'adresse IP protégée à ce service ; meta.from et meta.to indiquent la période réellement utilisée.
GET /v1/services/{id}/ddos/attacks?from=2026-10-10
{
"data": [{
"id": "3f6c1a2e-9b47-4d8a-b5e2-7c0d9e4a1f63",
"type": "ddos_attack",
"started_at": "2026-11-07T18:34:06Z",
"ended_at": null,
"detected_bps": 20938227712,
"detected_pps": 1998848,
"source_ip_count": 341,
"target_ip": "203.0.113.111",
"details_available": true
}],
"paging": {"limit": 25, "offset": 0, "total": 1, "truncated": false},
"meta": {"service_id": 5678, "protected_ip": "203.0.113.111", "from": "2026-10-10T00:00:00Z", "to": "2026-11-09T11:10:16Z", "retention_days": 90}
}
Chaque attaque comporte id (UUID), type (ddos_attack, ou blackhole si l'IP cible a été temporairement bloquée par routage nul), started_at, ended_at (peut valoir null), detected_bps, detected_pps, source_ip_count, target_ip et details_available. detected_bps et detected_pps indiquent le débit au moment de la détection ; le filtrage avait déjà commencé, ils peuvent donc être inférieurs au pic indiqué dans les détails. paging contient limit, offset, total et truncated (true si la période compte plus de 500 attaques), meta contient service_id, protected_ip, from, to et retention_days (90). Les listes sont mises en cache pendant 60 secondes.
GET /v1/services/{id}/ddos/attacks/{attack_id}
{
"data": {
"id": "3f6c1a2e-9b47-4d8a-b5e2-7c0d9e4a1f63",
"type": "ddos_attack",
"started_at": "2026-11-07T18:34:06Z",
"ended_at": null,
"detected_bps": 20938227712,
"detected_pps": 1998848,
"source_ip_count": 341,
"target_ip": "203.0.113.111",
"details_available": true,
"peak_bps": 20938227712,
"peak_pps": 1998848,
"total_bytes": 104809201664,
"total_packets": 81887232,
"interval_seconds": 1,
"traffic": [{"time": "2026-11-07T18:34:06Z", "bps": 20938227712, "pps": 1998848}],
"protocols": [{"protocol": "UDP", "avg_bps": 695618765, "avg_pps": 65645, "bytes": 104342814720, "packets": 78774272, "bps_percent": 99.56, "pps_percent": 96.2}],
"destination_ports": [{"port": 58675, "protocol": "UDP", "avg_bps": 695556506, "avg_pps": 65481, "bps_percent": 99.55, "pps_percent": 95.96}],
"source_ports": [{"port": 53, "protocol": "UDP", "avg_bps": 41896312, "avg_pps": 3511, "bps_percent": 5.996, "pps_percent": 5.15}],
"source_countries": [{"country": "MX", "avg_bps": 96051528, "avg_pps": 8656}],
"source_ips": [{"ip": "198.51.100.7", "avg_bps": 46162248, "avg_pps": 4151, "bps_percent": 6.61, "pps_percent": 6.08}],
"packet_sizes": [{"range": "1400-1499", "avg_bps": 374806938, "percent": 54.076}]
},
"meta": {"service_id": 5678, "cached": false}
}
Les détails reprennent tous les champs de la liste ainsi que peak_bps, peak_pps, total_bytes, total_packets et interval_seconds. traffic liste le trafic d'attaque entrant par intervalle ({time, bps, pps}) tel que le réseau de filtrage l'a observé, d'environ 10 minutes avant à environ 10 minutes après la détection. Les répartitions protocols, destination_ports, source_ports, source_countries, source_ips et packet_sizes contiennent généralement les 5 entrées principales : avg_bps et avg_pps sont des moyennes sur la fenêtre de mesure, bps_percent et pps_percent des parts. protocols contient en plus bytes et packets, packet_sizes contient range, avg_bps et percent. Les détails sont mis en cache jusqu'à 15 minutes.
HTTP 400 validation_failed : valeur invalide ou paramètre de requête inconnu. HTTP 404 : service inconnu ou appartenant à autrui, identifiant d'attaque inconnu ou attaque visant une autre adresse IP. HTTP 409 not_supported_for_product : il ne s'agit pas d'un service Remote DDoS Protection (par exemple Advanced DDoS Protection ou un serveur). HTTP 409 service_not_active : le service n'est ni active ni suspended. HTTP 409 protection_not_ready : la protection est encore en cours de mise en place.
Métriques serveur
Ce point d'accès nécessite un service actif appartenant à votre compte et la permission read:services. Les Edge Unlimited Traffic VPS fournissent les mesures du CPU, de la mémoire et du réseau entrant et sortant (bit/s et paquets/s), ainsi que le trafic sortant par jour et depuis le début du mois. Les VPS Unlimited Traffic classiques en Europe, en Allemagne, en France, dans l'est du Canada, au Royaume-Uni et en Pologne fournissent uniquement les mesures du réseau entrant et sortant en bit/s.
Paramètre de requête range : 1h, 6h, 24h, 7d ou 14d (par défaut 1h). L'intervalle entre deux points dépend de la période : pour les Edge Unlimited Traffic VPS, environ 15 secondes (1h), 20 secondes (6h), 2 minutes (24h), 10 minutes (7d) et 20 minutes (14d) ; pour les VPS Unlimited Traffic classiques, 5 minutes jusqu'à 24h, 30 minutes pour 7d et 2 heures pour 14d. step_seconds indique l'intervalle de la réponse.
GET /v1/services/{id}/metrics?range=24h
{
"data": {
"service_id": 1234,
"range": "24h",
"step_seconds": 120,
"available": ["cpu_percent", "memory_percent", "network_in_bps", "network_out_bps", "network_in_pps", "network_out_pps"],
"summary": {
"cpu_percent": {"avg": 3.1, "max": 41.7, "last": 2.9},
"network_in_bps": {"avg": 64012.5, "max": 912345.0, "last": 60026.2}
},
"points": [
{"time": "2026-11-08T11:12:00Z", "cpu_percent": 3.254, "memory_percent": 43.001, "network_in_bps": 68515.425, "network_out_bps": 650.767, "network_in_pps": 119.992, "network_out_pps": 0.775},
{"time": "2026-11-08T11:14:00Z", "cpu_percent": 3.118, "memory_percent": 43.004, "network_in_bps": 66120.871, "network_out_bps": 702.134, "network_in_pps": 115.317, "network_out_pps": 0.825}
],
"traffic": {
"month_to_date_out_bytes": 111844510,
"daily": [{"date": "2026-11-09", "out_bytes": 10485760, "final": false}],
"as_of": "2026-11-09T11:00:01Z",
"unit": "bytes",
"direction": "outbound"
}
},
"meta": {"generated_at": "2026-11-09T11:12:30Z", "cached": false, "measured_at": "server_network_interface"}
}
Les valeurs sont mesurées sur l'interface réseau du serveur et montrent donc le trafic qui a réellement atteint le serveur. La mémoire nécessite l'agent invité dans le serveur. Les valeurs non mesurables valent null ; available liste les métriques disposant de valeurs mesurées, et summary donne pour chacune avg, max et last. traffic contient le trafic sortant en octets par jour et depuis le début du mois (final vaut true dès qu'une journée est terminée) et vaut null pour les produits sans compteur de trafic. Les réponses sont mises en cache de 30 secondes (1h) à 10 minutes (14d) ; meta.cached indique si la réponse provient du cache.
HTTP 400 validation_failed : autre valeur de range ou paramètre de requête inconnu. HTTP 404 : service inconnu ou appartenant à autrui. HTTP 409 not_supported_for_product : aucune métrique disponible pour ce service (autres produits et emplacements). HTTP 409 service_not_active : le service n'est pas actif.
Pour les métriques serveur et les rapports d'attaques, les limites de débit générales s'appliquent. En outre, les récupérations qui ne peuvent pas être servies depuis le cache sont limitées à 20 par minute et par compte pour ces trois points d'accès réunis ; au-delà, vous recevez HTTP 429 avec Retry-After. HTTP 502 monitoring_unavailable ou reports_unavailable : la source de données est temporairement indisponible, réessayez plus tard. HTTP 503 temporarily_unavailable avec Retry-After : une requête parallèle prépare actuellement les mêmes données.
Non disponible via l'API : rapports d'attaques pour Advanced DDoS Protection et pour les serveurs tels que les Edge Unlimited Traffic VPS ; statistiques du trafic propre ou rejeté par IP protégée ; CPU et mémoire des VPS Unlimited Traffic classiques ; livraison des webhooks et export CSV.
Idempotence
POST /v1/orders et POST /v1/services/{id}/actions exigent un en-tête Idempotency-Key (1 à 80 caractères pris dans [A-Za-z0-9_.-]). La clé d'idempotence est liée à la méthode, au chemin et au corps. Si vous répétez la même requête avec la même clé dans un délai d'une heure, vous recevez la réponse mémorisée ; passé ce délai, vous obtenez un 410 avec reason replay_stale et devez envoyer une nouvelle clé. La même clé utilisée avec un autre corps ou sur un autre point de terminaison est rejetée avec un 409 idempotency_conflict.
Limitation de débit
Limites par défaut : 60 requêtes par minute (plus une rafale de 20) et 5 000 par jour pour chaque clé, 120 par minute pour chaque compte (toutes clés confondues) et 600 par minute pour chaque adresse IP source. En cas de dépassement, vous recevez une réponse HTTP 429 avec un en-tête Retry-After. Les en-têtes de réponse X-RateLimit-Remaining et X-RateLimit-Reset indiquent l'état actuel de la limite par clé.

