VPS.org Documentazione API

Iniziare

L'API di VPS.org ti consente di gestire in modo programmatico tutti gli aspetti della tua infrastruttura di hosting VPS, inclusi server, domini, record DNS, backup e snapshot.

Autenticazione

Tutte le richieste API richiedono l'autenticazione tramite un token Bearer. Puoi generare il tuo token API dalle impostazioni del tuo account all'indirizzo 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);

Ogni token ha i propri permessi, come server:list o dns:*. Una richiesta che necessita di un permesso che il token non ha viene rifiutata con 403 e un campo required_permission che nomina il permesso mancante. Riferimento per le autorizzazioni

Limitazione della velocità

Le richieste autenticate sono limitate a 1.000 all'ora per conto. Le richieste non autenticate sono limitate a 100 all'ora per indirizzo IP. Una richiesta oltre il limite riceve 429 con un'intestazione Retry-After che dà il numero di secondi da attendere. Le intestazioni non sono inviate sulle risposte di successo.

Paginazione

Gli endpoints della lista restituiscono un oggetto con conteggio, successivo, precedente e risultato, 25 elementi per pagina. Passare la pagina per spostarsi tra le pagine, o seguire l'URL successivo fino a che non sia nullo. L'elenco dei server accetta anche page_size, fino a 100.

{
  "count": 84,
  "next": "https://admin.vps.org/api/v1/backups/?page=2",
  "previous": null,
  "results": [ ... ]
}

Gestione degli errori

L'API utilizza codici di stato HTTP standard per indicare il successo o il fallimento:

I corpi di errore sono JSON. La maggior parte ha un campo di dettaglio o un campo di errore, a volte con un messaggio; errori di convalida elencano i problemi per nome campo.

Categorie API

Sfoglia la nostra documentazione API per categoria:

Altri punti finali

L'API ha anche endpoint per le implementazioni delle app (/api/v1/deploy-configs/ e /api/v1/dislocations/) e non sono ancora descritti in queste pagine; il riferimento interattivo elenca ogni endpoint, generato dall'API dal vivo.

Hai bisogno di aiuto?

Se hai domande o hai bisogno di assistenza con l'API, non esitare a contattarci:

• Ticket di supporto: Apri un ticket di supporto
• E-mail: hello@vps.org
• Documentazione: Documentazione completa