Ένα token, δημιουργημένο στον πίνακα πελάτη
Αποστέλλεται ως bearer token. Περιορίστε το σε μόνο ανάγνωση ή σε μία μόνο υπηρεσία αν θέλετε· τα tokens είναι ανεξάρτητα από τον κωδικό πρόσβασής σας και η ανάκληση ενός από αυτά δεν σας αποσυνδέει ποτέ.
Ένα token, και ό,τι μπορεί να κάνει το panel
JSON μέσω HTTPS. Δεν απαιτείται SDK, ούτε ξεχωριστός λογαριασμός προγραμματιστή, ούτε endpoint που υπάρχει στον πίνακα αλλά όχι εδώ.
Δημιουργία διακομιστή
curl -X POST https://api.vpsoffshore.com/v1/servers \
-H "Authorization: Bearer $TOKEN" \
-d '{"plan":"reef","image":"debian-13"}'Επιστρέφει αμέσως ένα build id. Το μηχάνημα απαντά μέσω SSH περίπου εξήντα δευτερόλεπτα αργότερα, και η διεύθυνση δρομολογείται πριν σταλούν τα διαπιστευτήρια.
20 τελικά σημεία
Τα πάντα, σε πέντε ομάδες
Βασικό URL https://api.vpsoffshore.com/v1. Έχει έκδοση μέσα στη διαδρομή· η v1 θα συνεχίσει να λειτουργεί όταν υπάρχει η v2, και η ημερομηνία διακοπής της θα ανακοινωθεί έναν χρόνο νωρίτερα.
Διακομιστές
GET
/servers
Κάθε υπηρεσία στον λογαριασμό, με κατάσταση, πακέτο και διευθύνσεις.
POST
/servers
Δημιουργήστε ένα. Επιστρέφει άμεσα ένα build id· ο διακομιστής είναι προσβάσιμος περίπου ένα λεπτό αργότερα.
GET
/servers/{id}
Μία υπηρεσία, συμπεριλαμβανομένης της χρήσης πόρων σε πραγματικό χρόνο την τελευταία ώρα.
PATCH
/servers/{id}
Αλλάξτε το πακέτο. Αλλάζει μέγεθος χωρίς επανεγκατάσταση όπου το επιτρέπει ο δίσκος.
DELETE
/servers/{id}
Καταστρέψτε το. Οι δίσκοι διατηρούνται για 14 ημέρες, και στη συνέχεια διαγράφονται πριν από την επανέκδοση.
POST
/servers/{id}/actions
reboot · shutdown · start · rebuild · rescue · reset-password.
Αποθηκευτικός χώρος
GET
/servers/{id}/snapshots
Στιγμιότυπα για μία υπηρεσία, με τα νεότερα πρώτα.
POST
/servers/{id}/snapshots
Λάβετε ένα. Είναι thin, άρα είναι γρήγορο και δεν διπλασιάζει τη χρήση δίσκου σας.
POST
/snapshots/{id}/restore
Επαναφορά στη θέση της, ή σε διαφορετική υπηρεσία του ίδιου πακέτου ή μεγαλύτερου.
DELETE
/snapshots/{id}
Αφαιρέστε ένα snapshot.
Δικτύωση
GET
/servers/{id}/addresses
Διευθύνσεις δρομολογημένες σε μια υπηρεσία, v4 και v6.
POST
/servers/{id}/addresses
Ζητήστε επιπλέον διεύθυνση, ή ένα /29.
PUT
/addresses/{ip}/rdns
Ορίστε reverse DNS. Ισχύει μέσα σε ένα λεπτό, όχι στην επόμενη ανανέωση ζώνης.
GET
/servers/{id}/bandwidth
Μετρητές μεταφοράς. Ενημερωτικοί — δεν υπάρχει όριο προς υπέρβαση.
Κατάλογος
GET
/plans
Κάθε πακέτο με τις προδιαγραφές και την τιμή του. Η ίδια πηγή από την οποία αποδίδεται αυτός ο ιστότοπος.
GET
/images
Διαθέσιμες εικόνες και ISO, συμπεριλαμβανομένων αυτών που ανεβάσατε.
POST
/images
Ανεβάστε ένα ISO μέσω URL. Εκκινεί με συνδεδεμένη κονσόλα.
Χρεώσεις
GET
/invoices
Τιμολόγια, εξοφλημένα και εκκρεμή, με το νόμισμα και τη συναλλαγή στην αλυσίδα.
POST
/invoices/{id}/pay
Εκδώστε διεύθυνση πληρωμής για ένα από τα 8 αποδεκτά νομίσματα.
GET
/credits
Πιστώσεις SLA που εφαρμόστηκαν, με το περιστατικό που παρήγαγε καθεμία.
Οτιδήποτε μπορεί να κάνει ο πίνακας πελάτη υπάρχει εδώ, και τίποτα εδώ δεν λείπει από τον πίνακα πελάτη. Όταν τα δύο διαφωνούν, πρόκειται για σφάλμα — ενημερώστε μας από τον πίνακα και διορθώνεται αντί να καταγράφεται ως αναμενόμενη συμπεριφορά.
Πώς συμπεριφέρεται
Τέσσερις αποφάσεις που θα παρατηρήσετε μέσα σε μία ώρα
Ένα API κρίνεται από τις κακές διαδρομές του, όχι από τις καλές. Τρία από τα τέσσερα παρακάτω αφορούν το τι συμβαίνει όταν κάτι πάει στραβά.
JSON είσοδος, JSON έξοδος, χωρίς ανάγκη για SDK
Απλό HTTPS χωρίς προσαρμοσμένο envelope, χωρίς εναλλακτική λύση XML και χωρίς τελετουργικό υπογραφής. Αν το curl μπορεί να το κάνει, έχετε client. Επίσημες βιβλιοθήκες υπάρχουν για Go, Python και TypeScript και καμία τους δεν είναι απαραίτητη.
Όρια ρυθμού που δεν θα ξεπεράσετε κατά λάθος
600 αιτήματα ανά λεπτό ανά token, 60 για κλήσεις δημιουργίας. Κάθε απόκριση φέρει το εναπομένον όριο σε μια κεφαλίδα, και η υπέρβασή του επιστρέφει 429 με τον αριθμό δευτερολέπτων αναμονής — ποτέ σιωπηλή απόρριψη.
Σφάλματα που λένε τι πρέπει να κάνετε
Ένα σφάλμα 4xx φέρει έναν αναγνώσιμο από μηχανή κωδικό, μια ανθρώπινη πρόταση, και το πεδίο που ευθύνεται. Προτιμούμε να επιστρέφουμε ένα μεγάλο σφάλμα παρά ένα σύντομο που πρέπει να μαντέψετε.
Τα δύο πράγματα που γράφετε μία φορά
Έλεγχος ταυτότητας, και πώς μοιάζει ένα σφάλμα
Αξίζει να διαβάσετε και τα δύο πριν γράψετε την πρώτη κλήση, και όχι μετά την πρώτη αποτυχία.
Έλεγχος ταυτότητας
curl https://api.vpsoffshore.com/v1/servers \
-H "Authorization: Bearer $TOKEN"Τα tokens δημιουργούνται στον πίνακα πελάτη και μπορούν να περιοριστούν σε λειτουργία μόνο ανάγνωσης ή σε μία υπηρεσία. Είναι ανεξάρτητα από τον κωδικό πρόσβασής σας, και η ανάκληση ενός δεν σας αποσυνδέει από πουθενά.
Διαβάστε το όριο ρυθμού
X-RateLimit-Remaining: 574
X-RateLimit-Reset: 41Σε κάθε απόκριση, όχι μόνο σε αυτή που αποτυγχάνει. Η υπέρβαση του ορίου επιστρέφει 429 με τα δευτερόλεπτα αναμονής, ποτέ σιωπηρή απόρριψη και ποτέ συντομευμένη απόκριση.
Ένα σφάλμα σας υποδεικνύει το πεδίο
{"error":"plan_unknown",
"message":"No plan named 'reff'. Did you mean 'reef'?",
"field":"plan"}Ένας κωδικός αναγνώσιμος από μηχανή, μια πρόταση κατανοητή από άνθρωπο, και το πεδίο που ευθύνεται. Τα μεγάλα μηνύματα σφάλματος κοστίζουν λιγότερο από τα σύντομα που πρέπει να μαντέψετε.
Ελέγξτε την κατάσταση μιας διαμόρφωσης
curl https://api.vpsoffshore.com/v1/servers/$ID \
-H "Authorization: Bearer $TOKEN" | jq .stateΠηγαίνει building → running. Δεν υπάρχει webhook που πρέπει να καταχωρίσετε πριν μπορέσετε να δημιουργήσετε οτιδήποτε, και η δειγματοληψία μία φορά το δευτερόλεπτο είναι εντός του ορίου.
Δεν χρειάζεται καμία αίτηση
Το token βρίσκεται στον πίνακα πελάτη, και ο πίνακας πελάτη έρχεται μαζί με τον πρώτο διακομιστή
Κανένας λογαριασμός προγραμματιστή, καμία έγκριση, κανένα sandbox που συμπεριφέρεται διαφορετικά από το production.