Todos los endpoints devuelven application/json. Los errores siguen el RFC 7807 (Problem+JSON). Toda respuesta incluye la cabecera X-Request-Id para correlacionar con el registro de auditoría del servidor.
| Method | Path | Permiso | Propósito |
|---|---|---|---|
| GET | /v1/health | public | Comprobación de salud sin autenticación. |
| GET | /v1/me | any | Información de la propia cuenta y metadatos de la clave. |
| GET | /v1/products | read:products | Listado de todos los productos públicos con sus precios. |
| GET | /v1/products/{id} | read:products | Detalles del producto, incluidas las opciones de configuración. |
| POST | /v1/orders | write:orders | Realizar un pedido. Idempotency-Key obligatorio. |
| GET | /v1/orders/{id} | read:orders | Estado de un pedido propio. |
| GET | /v1/services | read:services | Listado de los servicios propios (paginado). |
| GET | /v1/services/{id} | read:services | Detalles de un servicio propio. |
| GET | /v1/services/{id}/credentials | read:credentials | Credenciales del servicio (permiso separado, auditado). |
| POST | /v1/services/{id}/actions | write:services | Acción de servicio: start, stop, reboot, cancel (al final del periodo de facturación), cancel_revoke. |
| GET | /v1/services/{id}/metrics | read:services | Métricas del servidor de un servicio propio (CPU, memoria, red). |
| GET | /v1/services/{id}/ddos/profiles | read:ddos | Perfiles de Advanced DDoS Protection disponibles. |
| GET | /v1/services/{id}/ddos/rules | read:ddos | Reglas actuales de la IP protegida asignada. |
| POST | /v1/services/{id}/ddos/rules | write:ddos | Añadir una regla de protección. Idempotency-Key obligatorio. |
| DELETE | /v1/services/{id}/ddos/rules/{rule_id} | write:ddos | Eliminar una regla propia. Idempotency-Key obligatorio. |
| GET | /v1/services/{id}/ddos/attacks | read:ddos | Ataques detectados en la IP protegida (Remote DDoS Protection). |
| GET | /v1/services/{id}/ddos/attacks/{attack_id} | read:ddos | Detalles de un ataque: tráfico y desgloses. |
| GET | /v1/billing/balance | read:billing | Saldo disponible. |
| GET | /v1/billing/invoices | read:billing | Listado de sus facturas (paginado). |
| GET | /v1/billing/invoices/{id}/pdf | read:billing | PDF de factura. |
| GET | /v1/webhooks | read:webhooks | URL actual del webhook. |
| PUT | /v1/webhooks | write:webhooks | Configurar o eliminar la URL del webhook. |
Reglas de Advanced DDoS Protection
Estos endpoints requieren un servicio Advanced DDoS Protection que pertenezca a su cuenta. Las consultas funcionan con estado active o suspended; los cambios requieren active. Active expresamente read:ddos para consultas y write:ddos para cambios en su clave API. Las claves existentes no reciben nuevos permisos automáticamente. No se permite gestionar túneles ni listas blancas.
Seleccione app_code del catálogo de perfiles. port debe ser un entero de 1 a 65535; para icmp, omítalo o envíe 0. El objeto opcional extra_ports asigna puertos enteros a las etiquetas exactas del perfil; las etiquetas omitidas conservan los valores predeterminados. El servidor determina los protocolos, por lo que no debe enviar protocol. Los campos o etiquetas desconocidos devuelven 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 devuelve HTTP 201 con la regla creada en data. GET devuelve las reglas y meta con service_id, protection_ip y max_rules. DELETE utiliza un cuerpo vacío y devuelve HTTP 200 como se muestra abajo. POST y DELETE requieren 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}}
El panel y la API comparten intervalos UTC fijos: 10 intentos de escritura por minuto y cuenta, 5 por minuto e IP protegida y 200 por día UTC y cuenta. Cuentan los intentos admitidos que sean inválidos o fallen; las repeticiones idempotentes correctas no cuentan. Las consultas DDoS de la API comparten 30 solicitudes por minuto y cuenta. Máximo: 1000 reglas por IP protegida.
HTTP 404: servicio desconocido o ajeno, o regla ajena, inexistente o de sistema. HTTP 409: el servicio no es Advanced DDoS Protection (not_supported_for_product), servicio inactivo, conflicto de puertos o cambio simultáneo. HTTP 429: límite alcanzado, respete Retry-After. HTTP 502: el servicio de protección no pudo completar la solicitud. La regla de sistema block permanece oculta y no se puede eliminar. HTTP 503: los controles de límites no están disponibles temporalmente, respete Retry-After.
Informes de ataques DDoS
Estos endpoints requieren un servicio Remote DDoS Protection que pertenezca a su cuenta, con estado active o suspended, y el permiso read:ddos, que debe activarse expresamente. La lista muestra los ataques DDoS detectados en la dirección IP protegida del servicio, del más reciente al más antiguo.
Parámetros de consulta: from y to como fecha (YYYY-MM-DD) o como fecha y hora ISO 8601 con zona horaria (por defecto: los últimos 30 días), limit de 1 a 100 (por defecto 25) y offset de 0 a 9999 (por defecto 0). El periodo nunca abarca más de 90 días hacia atrás ni empieza antes de que la dirección IP protegida se asignara a este servicio; meta.from y meta.to muestran el periodo realmente utilizado.
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}
}
Cada ataque incluye id (UUID), type (ddos_attack, o blackhole si la IP de destino se enrutó temporalmente a nulo), started_at, ended_at (puede ser null), detected_bps, detected_pps, source_ip_count, target_ip y details_available. detected_bps y detected_pps indican la tasa en el momento de la detección; el filtrado ya había comenzado, por lo que pueden ser inferiores al pico que figura en los detalles. paging contiene limit, offset, total y truncated (true si el periodo incluye más de 500 ataques), meta contiene service_id, protected_ip, from, to y retention_days (90). Las listas se almacenan en caché durante 60 segundos.
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}
}
Los detalles incluyen todos los campos de la lista y además peak_bps, peak_pps, total_bytes, total_packets e interval_seconds. traffic enumera el tráfico de ataque entrante por intervalo ({time, bps, pps}) tal como lo vio la red de filtrado, desde unos 10 minutos antes hasta unos 10 minutos después de la detección. Los desgloses protocols, destination_ports, source_ports, source_countries, source_ips y packet_sizes suelen contener las 5 entradas principales: avg_bps y avg_pps son promedios sobre la ventana de medición, bps_percent y pps_percent son porcentajes. protocols incluye además bytes y packets, packet_sizes incluye range, avg_bps y percent. Los detalles se almacenan en caché hasta 15 minutos.
HTTP 400 validation_failed: valor no válido o parámetro de consulta desconocido. HTTP 404: servicio desconocido o ajeno, ID de ataque desconocido o ataque a otra dirección IP. HTTP 409 not_supported_for_product: no es un servicio Remote DDoS Protection (por ejemplo, Advanced DDoS Protection o un servidor). HTTP 409 service_not_active: el servicio no está en estado active ni suspended. HTTP 409 protection_not_ready: la protección todavía se está configurando.
Métricas del servidor
Este endpoint requiere un servicio activo de su cuenta y el permiso read:services. Los Edge Unlimited Traffic VPS proporcionan datos de CPU, memoria y red entrante y saliente (bit/s y paquetes/s), además del tráfico saliente por día y en lo que va de mes. Los VPS Unlimited Traffic habituales en Europa, Alemania, Francia, Canadá Este, Reino Unido y Polonia proporcionan solo datos de red entrante y saliente en bit/s.
Parámetro de consulta range: 1h, 6h, 24h, 7d o 14d (por defecto 1h). La distancia entre puntos depende del periodo: en los Edge Unlimited Traffic VPS, unos 15 segundos (1h), 20 segundos (6h), 2 minutos (24h), 10 minutos (7d) y 20 minutos (14d); en los VPS Unlimited Traffic habituales, 5 minutos hasta 24h, 30 minutos con 7d y 2 horas con 14d. step_seconds muestra la distancia de la respuesta.
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"}
}
Los valores se miden en la interfaz de red del servidor, por lo que muestran el tráfico que realmente llegó al servidor. La memoria requiere el agente invitado dentro del servidor. Los valores que no se pudieron medir son null; available enumera las métricas con valores medidos y summary muestra avg, max y last de cada una. traffic contiene el tráfico saliente en bytes por día y en lo que va de mes (final es true cuando el día ha terminado) y es null en productos sin contador de tráfico. Las respuestas se almacenan en caché de 30 segundos (1h) a 10 minutos (14d); meta.cached indica si la respuesta procede de la caché.
HTTP 400 validation_failed: otro valor de range o parámetro de consulta desconocido. HTTP 404: servicio desconocido o ajeno. HTTP 409 not_supported_for_product: no hay métricas disponibles para este servicio (otros productos y ubicaciones). HTTP 409 service_not_active: el servicio no está activo.
Para las métricas del servidor y los informes de ataques se aplican los límites de tasa generales. Además, las consultas que no pueden responderse desde la caché están limitadas a 20 por minuto y cuenta entre estos tres endpoints; por encima, recibirá HTTP 429 con Retry-After. HTTP 502 monitoring_unavailable o reports_unavailable: la fuente de datos no está disponible temporalmente, inténtelo más tarde. HTTP 503 temporarily_unavailable con Retry-After: una solicitud paralela está preparando los mismos datos.
No disponible a través de la API: informes de ataques para Advanced DDoS Protection y para servidores como los Edge Unlimited Traffic VPS; estadísticas de tráfico limpio o descartado por IP protegida; CPU y memoria de los VPS Unlimited Traffic habituales; envío de webhooks y exportación CSV.
Idempotencia
POST /v1/orders y POST /v1/services/{id}/actions requieren la cabecera Idempotency-Key (de 1 a 80 caracteres del conjunto [A-Za-z0-9_.-]). La clave queda vinculada al método, la ruta y el cuerpo. Si repite la misma petición con la misma clave en el plazo de una hora, recibirá la respuesta almacenada; pasado ese plazo, obtendrá un 410 con reason replay_stale y deberá enviar una clave nueva. La misma clave con otro cuerpo o en otro endpoint se rechaza con 409 idempotency_conflict.
Límites de tasa
Por defecto, 60 peticiones por minuto (más una ráfaga de 20) y 5.000 al día por clave, 120 por minuto por cuenta entre todas las claves y 600 por minuto por IP de origen. Si se supera un límite, recibirá HTTP 429 con la cabecera Retry-After. Las cabeceras de respuesta X-RateLimit-Remaining y X-RateLimit-Reset muestran el estado actual del límite de la clave.

