VPS.org API

Documentación de API REST

API de instantáneas

Tome instantáneas etiquetadas de un servidor, enumere y elimine las que ya no necesita.

Puntos finales 4
Ruta base /api/v1/snapshots
CONSEGUIR /api/v1/snapshots/

Listar todas las instantáneas

Devuelve las instantáneas de su cuenta, la más reciente primero, 25 por página.

Permiso requerido: snapshots:list

Ejemplo de solicitud

cURL
Python
JavaScript
curl -X GET "https://admin.vps.org/api/v1/snapshots/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
import requests

url = "https://admin.vps.org/api/v1/snapshots/"
headers = {"Authorization": "Bearer YOUR_API_TOKEN"}

response = requests.get(url, headers=headers)
for snapshot in response.json()["results"]:
    print(snapshot["uuid"], snapshot["label"], snapshot["ready"])
const response = await fetch('https://admin.vps.org/api/v1/snapshots/', {
  headers: { 'Authorization': 'Bearer YOUR_API_TOKEN' }
});

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

Ejemplo de respuesta

{
  "count": 1,
  "next": null,
  "previous": null,
  "results": [
    {
      "uuid": "3f9a1c0e5b7d4e2f8a6c1b3d5e7f9a0b",
      "label": "before-upgrade",
      "server_hostname": "web-01",
      "ready": true,
      "deleting": false,
      "created_at": "2026-09-14T18:30:00.000000Z",
      "size_gb": 3.4
    }
  ]
}

Campos de respuesta

Campo Tipo Descripción
uuid string Identificador de la instantánea (32 caracteres hexadecimal, sin guiones)
label string Etiqueta dada cuando se creó la instantánea
server_hostname string Nombre de host del servidor del que se tomó la instantánea, o nulo si ese servidor ya no existe
ready boolean Verdadero una vez que la instantánea ha terminado
deleting boolean Verdadero mientras se está eliminando
created_at datetime Tiempo de creación (ISO 8601, UTC)
size_gb number Tamaño comprimido en gigabytes
CONSEGUIR /api/v1/snapshots/{uuid}/

Obtener una instantánea

Devuelve un objeto de instantánea con los campos anteriores. Utilícelo para hacer encuestas listas después de crear una instantánea.

curl -X GET "https://admin.vps.org/api/v1/snapshots/3f9a1c0e5b7d4e2f8a6c1b3d5e7f9a0b/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
POST /api/v1/servers/{uuid}/snapshot/

Crear una instantánea

Encola una instantánea de un servidor desplegado y devuelve el uuid de la nueva instantánea. La instantánea se lista de inmediato con el conjunto listo para false.

Permiso requerido: servers:snapshot

Parámetros del cuerpo de la solicitud

Parámetro Tipo Requerido Descripción
action string Sí Debe ser una instantánea.
snapshot_label string Sí Una etiqueta para reconocer la instantánea por
cURL
Python
curl -X POST "https://admin.vps.org/api/v1/servers/8c4f2a1e-5b3d-4e6f-9a7b-1c2d3e4f5a6b/snapshot/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"action": "snapshot", "snapshot_label": "before-upgrade"}'
import requests

server_uuid = "8c4f2a1e-5b3d-4e6f-9a7b-1c2d3e4f5a6b"
url = f"https://admin.vps.org/api/v1/servers/{server_uuid}/snapshot/"
headers = {"Authorization": "Bearer YOUR_API_TOKEN"}
data = {"action": "snapshot", "snapshot_label": "before-upgrade"}

response = requests.post(url, headers=headers, json=data)
print(response.json()["snapshot_uuid"])

Ejemplo de respuesta

{
  "message": "Snapshot queued successfully",
  "snapshot_uuid": "3f9a1c0e5b7d4e2f8a6c1b3d5e7f9a0b"
}

Códigos de estado de respuesta

200 La acción estaba en fila
400 acción o snapshot_label falta, o el servidor no se ha desplegado todavía
402 No hay ningún método de pago en el archivo, o facturas impagadas
404 No encontrado, o pertenece a otra cuenta
BORRAR /api/v1/snapshots/{uuid}/

Eliminar una instantánea

Encola la instantánea para la eliminación permanente. Eliminar es cierto hasta que se haya ido.

Permiso requerido: snapshots:delete

curl -X DELETE "https://admin.vps.org/api/v1/snapshots/3f9a1c0e5b7d4e2f8a6c1b3d5e7f9a0b/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "message": "Snapshot deletion queued"
}

Códigos de estado de respuesta

202 Aceptada: la solicitud estaba en cola
404 No encontrado, o pertenece a otra cuenta

Notas