Documentación completa de API REST para administrar servidores VPS, dominios, DNS, copias de seguridad y más.
La API de VPS.org le permite administrar mediante programación todos los aspectos de su infraestructura de alojamiento VPS, incluidos servidores, dominios, registros DNS, copias de seguridad e instantáneas.
Todas las solicitudes de API requieren autenticación mediante un token de portador. Puede generar su token de API desde la configuración de su cuenta en 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);Cada token lleva sus propios permisos, como servers:list o dns:*. Una solicitud que necesita un permiso que el token no tiene se rechaza con 403 y un campo de permiso_requerido nombrando el permiso que falta. Referencia de permisos
Las solicitudes autenticadas están limitadas a 1.000 por hora por cuenta. Las solicitudes no autenticadas están limitadas a 100 por hora por dirección IP. Una solicitud sobre el límite recibe 429 con un encabezado Retry-After que da el número de segundos para esperar. No se envían encabezados de límite de tasa en respuestas exitosas.
Los puntos finales de la lista devuelven un objeto con el conteo, siguiente, anterior y resultados, 25 elementos por página. Pase la página para moverse entre páginas, o siga la siguiente URL hasta que sea nulo. La lista de servidores también acepta page_size, hasta 100.
{
"count": 84,
"next": "https://admin.vps.org/api/v1/backups/?page=2",
"previous": null,
"results": [ ... ]
}La API utiliza códigos de estado HTTP estándar para indicar éxito o fracaso:
| Código de estado | Descripción |
|---|---|
200 |
Éxito - Solicitud completada exitosamente |
201 |
Creado - Recurso creado exitosamente |
400 |
Solicitud incorrecta: parámetros no válidos o solicitud mal formada |
202, 204 |
Aceptado y en cola (202), o eliminado sin cuerpo de respuesta (204) |
402 |
Pago requerido: no hay método de pago en el archivo, facturas impagadas, o una tarjeta rechazada pre-autorización |
403 |
Prohibido: el token no está disponible, no es válido o está caducado, o carece del permiso requerido. La autenticación fallida también devuelve 403, no 401. |
404 |
No encontrado - El recurso no existe |
409 |
Conflicto: por ejemplo, una redimensionamiento ya en curso, no suficiente capacidad, o un despliegue ya en ejecución |
429 |
Demasiadas solicitudes: límite de velocidad excedido |
500 |
Error interno del servidor: algo salió mal de nuestra parte |
503 |
Servicio no disponible: un problema temporal. Reintentar, honrar a Retry-After cuando se envía. |
Los cuerpos de error son JSON. La mayoría tienen un campo de detalle o un campo de error, a veces con un mensaje; los errores de validación listan los problemas por nombre de campo.
Explore nuestra documentación de API por categoría:
Crear, inspeccionar, encender, cambiar el tamaño y eliminar servidores, restablecer la contraseña raíz, establecer DNS inverso, ejecutar comandos y administrar claves SSH.
Ver documentaciónEnumere las copias de seguridad de su servidor, inicie una nueva copia de seguridad y restaure un servidor desde una copia de seguridad.
Ver documentaciónTome instantáneas etiquetadas de un servidor, enumere y borre.
Ver documentaciónConsulta los planes VPS disponibles y su información de precios. Obtén detalles sobre recursos, precios y disponibilidad.
Ver documentaciónLista los sistemas operativos y versiones que puede instalar, como Ubuntu, Debian, Rocky Linux, CentOS Stream, Fedora y Alpine.
Ver documentaciónCompruebe la disponibilidad, registre y renueve dominios, y establezca servidores de nombres y renovación automática.
Ver documentaciónCree zonas DNS y cree, actualice y elimine sus registros A, A, CNAME, MX, TXT, SRV, CAA y otros.
Ver documentaciónListar las ubicaciones disponibles para la implementación del servidor.
Ver documentaciónRecupera el perfil de la cuenta y la información del token de la API. Identifique a qué cuenta pertenece un token y compruebe sus permisos.
Ver documentaciónTire de su saldo de afiliados, referencias, comisiones y pagos en su propio informe, cambiar la configuración de pagos y solicitar pagos.
Ver documentaciónLa API también tiene puntos finales para implementaciones de aplicaciones (/api/v1/deploy-configs/ y /api/v1/distributions/). No se describen en estas páginas todavía; la referencia interactiva lista cada punto final, generado desde la API en vivo.
Abrir la referencia interactiva de APISi tiene preguntas o necesita ayuda con la API, no dude en comunicarse con nosotros: