VPS.org API Documentazione

Primi passi

L'API VPS.org vi permette di gestisce programmaticamente tutti l'aspetti di a vostra infrastruttura di hosting VPS, cumpresi servitori, duminii, registri DNS, copie di salvezza è snapshots.

Autentificazione

Tutte e richieste API richiedenu l'autentificazione cù un token Bearer. Pudete generà u vostru token API da i paràmetri di u vostru contu à 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 porta i so propi permessi, comu servers:list o dns:*. Una dumanda ca hà bisognu di un permessu ca u token nun hà, hè rifiutata cu 403 e un campu required_permission chi nomina u permessu mancante. Riferimentu di permessi

Limitazione di velocità

Li dumande autenticate sunnu limitati a 1000 à l'ora pi ogni contu. Li dumande nun autenticate sunnu limitati a 100 à l'ora pi ogni indirizzu IP. Una dumanda supra lu limiti riciviria 429 cu n'intestazione Retry-After ca dà u numaru di siconni pi aspittari. Nudda intestazione di limiti di velocità veni mandata pi risposti riesciuti.

Paginazioni

L'ultimi punti di lista riturnanu un oggettu cu cuntu, prossimu, pricidenti e risultati, 25 elementi pi pagina. Passa la pagina pi spustassi tra li pagini, o segui l'URL succissivu nzinu a chi è nullu. La lista di servituri accetta puru page_size, nzinu a 100.

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

Gestione di l'errori

L'API usa codici di statutu HTTP standard per indicà u successu o u fallimentu:

Li corpi di l'errori sunnu JSON. La maggiuranza di i cosi hannu un campu di dittagghi o un campu d'errori, a li voti cu nu messaggiu; l'errori di validazzioni listanu i prubblemi pi nomu di campu.

Categorie API

Sfoglia a nostra documentazione API per categuria:

Più punti finali

L'API à puru punti finali pi l'applicazzioni (/api/v1/deploy-configs/ e /api/v1/deployments/). Nun sunnu ancora discritti nta sti pagini; lu rifirimentu ntirattivìu lista ogni puntu finali, generatu di l'API live.

Bisognu d'aiutu ?

Sè avete dumande o avete bisognu d'aiutu cù l'API, ùn esitate micca à cuntattà:

• Biglietti di Supportu: Apri un bigliettu di supportu
• E-mail: hello@vps.org
• Documentazione: Documentazione cumpleta