Πλήρης τεκμηρίωση REST API για τη διαχείριση διακομιστών VPS, τομέων, DNS, αντιγράφων ασφαλείας και άλλων.
Το API VPS.org σάς επιτρέπει να διαχειρίζεστε μέσω προγραμματισμού όλες τις πτυχές της υποδομής φιλοξενίας VPS, συμπεριλαμβανομένων των διακομιστών, των τομέων, των εγγραφών DNS, των αντιγράφων ασφαλείας και των στιγμιότυπων.
Όλα τα αιτήματα API απαιτούν έλεγχο ταυτότητας χρησιμοποιώντας ένα διακριτικό φορέα. Μπορείτε να δημιουργήσετε το διακριτικό API σας από τις ρυθμίσεις του λογαριασμού σας στη διεύθυνση 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);
Κάθε μάρκα φέρει τις δικές του άδειες, όπως οι διακομιστές:list ή dns:*. Ένα αίτημα που χρειάζεται άδεια το σύμβολο δεν έχει απορρίπτεται με 403 και ένα πεδίο που απαιτείται_απαιτείται_αποστολή που αναφέρει την άδεια που λείπει. Αναφορά αδειών
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.
Λίστα τελικών σημείων επιστρέφει ένα αντικείμενο με αριθμό, επόμενο, προηγούμενο και αποτελέσματα, 25 αντικείμενα ανά σελίδα. Περάστε σελίδα για να μετακινήσετε μεταξύ των σελίδων, ή ακολουθήστε την επόμενη URL μέχρι να είναι άκυρη. Η λίστα διακομιστών δέχεται επίσης σελίδα_μέγεθος, έως 100.
{
"count": 84,
"next": "https://admin.vps.org/api/v1/backups/?page=2",
"previous": null,
"results": [ ... ]
}
Το API χρησιμοποιεί τυπικούς κωδικούς κατάστασης HTTP για να υποδείξει την επιτυχία ή την αποτυχία:
| Κωδικός κατάστασης | Description |
|---|---|
200 |
Επιτυχία - Το αίτημα ολοκληρώθηκε με επιτυχία |
201 |
Δημιουργήθηκε - Ο πόρος δημιουργήθηκε με επιτυχία. |
400 |
Λανθασμένο αίτημα - Μη έγκυρες παράμετροι ή λανθασμένη μορφή αιτήματος |
202, 204 |
Αποδεκτό και σε σειρά αναμονής (202) ή διαγράφεται χωρίς σώμα απόκρισης (204) |
402 |
Απαιτούμενη πληρωμή: δεν υπάρχει μέθοδος πληρωμής στο αρχείο, απλήρωτα τιμολόγια ή μια μειωμένη κάρτα προεγκρίθηκε |
403 |
Forbidden: the token is missing, invalid or expired, or lacks the required permission. Failed authentication also returns 403, not 401. |
404 |
Δεν βρέθηκε - Ο πόρος δεν υπάρχει |
409 |
Σύγκρουση: για παράδειγμα, μια αλλαγή μεγέθους ήδη σε εξέλιξη, δεν είναι αρκετή ικανότητα, ή μια ανάπτυξη που ήδη εκτελείται |
429 |
Πάρα πολλά αιτήματα - Υπέρβαση ορίου ρυθμού |
500 |
Εσωτερικό σφάλμα διακομιστή - Κάτι πήγε στραβά από την πλευρά μας |
503 |
Υπηρεσία Μη διαθέσιμο: ένα προσωρινό πρόβλημα. Αναπροσπαθήστε, τιμήζοντας Retry-Μετά από την αποστολή. |
Τα σώματα λάθους είναι JSON. Οι περισσότεροι έχουν ένα πεδίο λεπτομέρειας ή ένα πεδίο σφάλματος, μερικές φορές με ένα μήνυμα? σφάλματα επικύρωσης παρατίθενται τα προβλήματα με όνομα πεδίου.
Περιηγηθείτε στην τεκμηρίωση του API μας ανά κατηγορία:
Δημιουργία, επιθεώρηση, ισχύς, αλλαγή μεγέθους και διαγραφή διακομιστών, επαναφορά του κωδικού πρόσβασης ρίζας, ρύθμιση του αντιστροφής DNS, εντολές εκτέλεσης, και διαχείριση των πλήκτρων SSH.
Προβολή τεκμηρίωσηςΛίστα των αντιγράφων ασφαλείας του διακομιστή σας, ξεκινήστε ένα νέο αντίγραφο ασφαλείας, και αποκαταστήστε έναν διακομιστή από ένα αντίγραφο ασφαλείας.
Προβολή τεκμηρίωσηςΠάρτε στιγμιότυπα από έναν διακομιστή, να τις απαριθμήσετε και να τις διαγράψετε.
Προβολή τεκμηρίωσηςΑνακτήστε τα διαθέσιμα προγράμματα VPS και πληροφορίες τιμολόγησης. Λάβετε λεπτομέρειες σχετικά με τους πόρους, τις τιμές και τη διαθεσιμότητα.
Προβολή τεκμηρίωσηςΛίστα των λειτουργικών συστημάτων και εκδόσεων που μπορείτε να εγκαταστήσετε, όπως Ubuntu, Debian, Rocky Linux, CentOS Stream, Fedora και Alpine.
Προβολή τεκμηρίωσηςΕλέγξτε τη διαθεσιμότητα, την εγγραφή και την ανανέωση τομέων, και να θέσει nameservers και την αυτόματη ανανέωση.
Προβολή τεκμηρίωσηςΔημιουργήστε ζώνες DNS και δημιουργήστε, ενημερώστε και διαγράψτε τα A, A, CNAME, MX, TXT, SRV, CAA και άλλα αρχεία τους.
Προβολή τεκμηρίωσηςΚατάλογος των διαθέσιμων θέσεων για την ανάπτυξη του εξυπηρετητή.
Προβολή τεκμηρίωσηςΑνακτήστε το προφίλ λογαριασμού και API συμβολικές πληροφορίες. Προσδιορίστε σε ποιον λογαριασμό ανήκει ένα σύμβολο και ελέγξτε τις άδειές του.
Προβολή τεκμηρίωσηςΤο API έχει επίσης τελικά σημεία για τις εφαρμογές (/api/v1/decude-configs/ και /api/v1/αναθεωρήσεις/).
Άνοιγμα της διαδραστικής αναφοράς APIΕάν έχετε ερωτήσεις ή χρειάζεστε βοήθεια με το API, μη διστάσετε να επικοινωνήσετε μαζί μας: