VPS.org API

Documentación da API REST

Documentación da API de VPS.org

Documentación completa da API REST para xestionar servidores VPS, dominios, DNS, copias de seguridade e moito máis.

URL base https://admin.vps.org/api/v1
Autenticación Token do portador
Versión v1.0
Formato JSON

Primeiros pasos

A API de VPS.org permíteche xestionar mediante programación todos os aspectos da túa infraestrutura de aloxamento VPS, incluíndo servidores, dominios, rexistros DNS, copias de seguridade e instantáneas.

Autenticación

Todas as solicitudes da API requiren autenticación mediante un token de portador. Podes xerar o teu token da API desde a configuración da túa conta en admin.vps.org/account/developers/.

cURL
Python
JavaScript
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);

Limitación de taxa

As solicitudes á API están limitadas a 300 solicitudes por cada 5 minutos e por token da API. A información sobre o límite de velocidade inclúese nas cabeceiras de resposta:

Xestión de erros

A API usa códigos de estado HTTP estándar para indicar o éxito ou o fallo:

Código de estado Descrición
200 Éxito - Solicitude completada correctamente
201 Creado - Recurso creado correctamente
400 Solicitude incorrecta: parámetros non válidos ou solicitude con formato incorrecto
401 Non autorizado: token de autenticación non válido ou falta
403 Prohibido - Permisos insuficientes
404 Non atopado - Recurso non existe
429 Demasiadas solicitudes: superouse o límite de taxa
500 Erro interno do servidor: algo fallou da nosa parte

Categorías da API

Explora a nosa documentación da API por categoría:

API de servidores 9 puntos finais

Crea, xestiona e controla servidores VPS. Inclúe a xestión de enerxía, o cambio de tamaño, a reinstalación e a recuperación de información do servidor.

Ver documentación
API de copias de seguridade 3 puntos finais

Xestiona copias de seguridade automatizadas e manuais para os teus servidores. Enumera, crea, restaura e elimina copias de seguridade do servidor.

Ver documentación
API de instantáneas 4 puntos finais

Crea e xestiona instantáneas do servidor para obter puntos de restauración rápidos. Perfecto para probas e reversións rápidas.

Ver documentación
API de plans 2 puntos finais

Recuperar información sobre os plans VPS e os prezos dispoñibles. Obter detalles sobre recursos, prezos e dispoñibilidade.

Ver documentación
API de sistemas operativos 2 puntos finais

Lista os sistemas operativos e as imaxes dispoñibles para a implementación de servidores. Inclúe Ubuntu, Debian, CentOS e moitos máis.

Ver documentación
API de dominios 6 puntos finais

Busca, comproba a dispoñibilidade, rexistra e xestiona nomes de dominio. Xestión completa do ciclo de vida do dominio a través da API.

Ver documentación
API de DNS 4 puntos finais

Xestiona zonas e rexistros DNS mediante programación. Crea, actualiza e elimina tipos de rexistros A, AAAA, CNAME, MX, TXT e outros.

Ver documentación
API de localizacións 1 punto final

Lista as localizacións de centros de datos dispoñibles para a implementación de servidores. Escolle entre varias rexións de todo o mundo.

Ver documentación

Necesitas axuda?

Se tes algunha dúbida ou necesitas axuda coa API, non dubides en contactar con: