Täydellinen REST API -dokumentaatio VPS-palvelimien, verkkotunnusten, DNS:n, varmuuskopioiden ja muiden hallintaan.
VPS.org-rajapinnan avulla voit ohjelmallisesti hallita kaikkia VPS-hosting-infrastruktuurisi osa-alueita, mukaan lukien palvelimet, verkkotunnukset, DNS-tietueet, varmuuskopiot ja tilannevedokset.
Kaikki API-pyynnöt vaativat todennuksen Bearer-tunnuksella. Voit luoda API-tunnuksesi tilisi asetuksista osoitteessa 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);Jokaisessa rahakkeessa on omat oikeutensa, kuten palvelimet:lista tai dns:*. Pyyntö, joka edellyttää lupaa, jota ei ole, evätään 403:lla ja puuttuvan luvan nimeävällä vaaditulla_lupakenttällä. Luvat viitteinä
Authenticated requests are limited to 1,000 per hour per account. Unauthenticated requests are limited to 100 per hour per IP address. A request over the limit receives 429 with a Retry-After header giving the number of seconds to wait. No rate limit headers are sent on successful responses.
Luettele päätetapahtumat ja palauta kohde laskemalla, seuraavaksi, aiemmin ja tulokset 25 kohdetta sivulla. Siirry sivulle sivujen välillä tai seuraa seuraavaa URL-osoitetta, kunnes se on nolla. Palvelinluettelo hyväksyy myös sivujen koon, jopa 100.
{
"count": 84,
"next": "https://admin.vps.org/api/v1/backups/?page=2",
"previous": null,
"results": [ ... ]
}API käyttää HTTP-statuskoodeja onnistumisen tai epäonnistumisen osoittamiseen:
| Tilakoodi | Tavaran kuvaus |
|---|---|
200 |
Onnistui - Pyyntö suoritettu onnistuneesti |
201 |
Luotu - Resurssi luotu onnistuneesti |
400 |
Virheellinen pyyntö - Virheelliset parametrit tai väärin muotoiltu pyyntö |
202, 204 |
Hyväksyttiin ja jonotettiin (202) tai poistettiin ilman vastetta (204) |
402 |
Maksu vaaditaan: ei maksutapaa tiedostossa, maksamattomia laskuja tai kortin ennakkolupa evätään |
403 |
Kielletty: postimerkki puuttuu, on virheellinen tai vanhentunut tai puuttuu vaadittava lupa. Myös tunnistautuminen epäonnistui, 403, ei 401. |
404 |
Ei löydy - Resurssia ei ole olemassa |
409 |
Ristiriita: esimerkiksi käynnissä oleva muutos, liian vähän kapasiteettia tai jo käynnissä oleva käyttöönotto |
429 |
Liikaa pyyntöjä - Määräraja ylitetty |
500 |
Sisäinen palvelinvirhe - Jotain meni pieleen meidän päässämme |
503 |
Palvelua ei ole saatavilla: väliaikainen ongelma. Yritä uudelleen, kunnioita Retri-Fortia, kun se lähetetään. |
Virheelimet ovat JSON. Useimmilla on yksityiskohtakenttä tai virhekenttä, joskus viestillä; validointivirheet listaavat ongelmat kentännimellä.
Selaa API-dokumentaatiotamme luokittain:
Luo, tarkasta, käynnistä, kokoa ja poista palvelimet, nollaa pääsalasana, aseta käänteisen DNS:n, suorita komennot ja hallitse SSH-näppäimiä.
Katso dokumentaatioLuettele palvelimen varmuuskopiot, käynnistä uusi varmuuskopio ja palauta palvelimen varmuuskopiosta.
Katso dokumentaatioOta palvelimesta merkittyjä kuvia, luettele ne ja poista ne.
Katso dokumentaatioHae saatavilla olevia VPS-paketteja ja hinnoittelutietoja. Hanki tietoja resursseista, hinnoittelusta ja saatavuudesta.
Katso dokumentaatioLuettele käyttöjärjestelmät ja versiot, jotka voit asentaa, kuten Ubuntu, Debian, Rocky Linux, CentOS Stream, Fedora ja Alppi.
Katso dokumentaatioTarkista saatavuus, rekisteröi ja uusi verkkotunnuksia, aseta nimipalvelimia ja automaattiuudistuksia.
Katso dokumentaatioLuo DNS-vyöhykkeet ja luo, päivitä ja poista niiden A, AAA, CNAME, MX, TXT, SRV, CAA ja muut levyt.
Katso dokumentaatioLuettele palvelimen käyttöön käytettävissä olevat paikat.
Katso dokumentaatioHae tiliprofiili ja API-token tiedot. Tunnista, mihin tiliin merkki kuuluu, ja tarkista sen käyttöoikeudet.
Katso dokumentaatioVedä affiliate-saldosi, siirtosi, palkkiosi ja voittosi omaan raportointiisi, muuta voittoasetuksia ja pyydä maksuja.
Katso dokumentaatioAPI:llä on myös päätetapahtumia sovellusten käyttöönotolle (/api/v1/deploy-configs/ ja/api/v1/deployments/). Niitä ei ole vielä kuvattu näillä sivuilla, vaan interaktiiviset viitetiedot luetellaan jokaisen päätetapahtuman, joka on syntynyt live-rajapintaan perustuvasta rajapinta-alueesta.
Avaa interaktiivinen API-viiteJos sinulla on kysyttävää tai tarvitset apua API:n kanssa, ota rohkeasti yhteyttä: