HELPER VPS

API VPS: automatizza i server cloud con JSON REST

Un'API per server cloud con cui gestisci dal codice tutto, dalla creazione all'eliminazione dei server

  • JSON REST API
  • Autenticazione con chiave API (Bearer)
  • 300 richieste al minuto

Un'API VPS è un modo programmatico per fare il lavoro che faresti nel pannello di controllo, come creare, avviare, fermare ed eliminare server, con richieste HTTP. L'API del server cloud HELPER VPS è gratuita per tutti i membri; dopo il primo pagamento, crea una chiave API e connettiti subito.

  • REST API

    Tutti i clienti

    Gratis

    Fatturato mensilmente

    • JSON REST
    • Chiave API (Bearer)
    • 300 al minuto
    • Gratis

Per vedere subito esempi di richieste e formato delle risposte Documentazione API

Cosa puoi automatizzare con l'API VPS?

L'API VPS dà il meglio quando crei ed elimini spesso server o gestisci più server insieme. Ecco le quattro automazioni più comuni.

Pannello o API VPS: quando usare cosa?

Il pannello di controllo e l'API lavorano con lo stesso account e gli stessi server. Per gestire uno o due server manualmente, il pannello di controllo è comodo; per lavori ripetitivi o molti server, l'API è più veloce.

Pannello

Gestione con clic nell'interfaccia

Ideale per

  • Quando crei un server per la prima volta
  • Quando gestisci tu uno o due server
  • Reinstallazione del sistema operativo e registrazione delle chiavi SSH
  • Quando devi rivedere la password root

VPS API

Gestione con richieste dal codice

Ideale per

  • Ambienti di test in cui crei ed elimini spesso server
  • Automazione di pipeline di deploy e script
  • Quando leggi insieme lo stato di più server
  • Quando la colleghi al tuo pannello di gestione o al tuo bot

Come si collega l'API per server cloud?

Sono necessari tre passaggi. Primo, effettua il primo pagamento e, una volta confermato, crea una chiave nella pagina delle chiavi API. Poi, inserisci la chiave nell'intestazione Authorization di ogni richiesta utilizzando lo schema Bearer. Infine, invia richieste al percorso desiderato dopo l'indirizzo base https://helpervps.com/api/v1 e i risultati tornano come JSON.

All'inizio conviene chiamare GET /catalog. Restituisce in una volta tipi e dimensioni di server disponibili, codici delle regioni, codici di sistemi operativi e app con un clic e prezzi di backup automatico, disco extra e protezione DDoS. I codici plan, location e image ricevuti qui si inseriscono così come sono nella richiesta di creazione del server.

Per creare un server, invia i valori plan, location, image e label come JSON a POST /servers. Puoi anche includere l'ID di una chiave SSH che hai aggiunto e le opzioni backups, extra_disk_gb e ddos_protection. Paghi anticipatamente per il periodo scelto e la risposta contiene l'ID del server, lo stato e la password root, quindi salvali subito in un posto sicuro.

Quali operazioni puoi fare con l'API VPS?

L'API VPS gestisce l'intero ciclo di vita del server. Con GET /catalog leggi il catalogo, con POST /servers crei server, con GET /servers leggi l'elenco dei tuoi server e con GET /servers/{id} i dati di un singolo server. La risposta contiene nome del server, stato, indirizzi IPv4 e IPv6, canone mensile, opzioni scelte e prossima data di addebito.

L'alimentazione si gestisce con le richieste POST /servers/{id}/start, stop e reboot per accendere, spegnere e riavviare. POST /servers/{id}/renew paga subito un mese per rinnovare senza attendere la data di addebito, mentre DELETE /servers/{id} elimina il server. Se una richiesta non è compatibile con lo stato attuale del server, te lo segnala con il codice wrong_state, così lo script decide facilmente cosa fare dopo.

Gli errori tornano in JSON con il codice di stato e un valore error. I motivi sono distinti da codici, come unauthorized se la chiave non è valida, not_enough_balance se il saldo non basta, limit se l'account ha raggiunto il numero massimo di server e rate_limited con troppe richieste, quindi il programma gestisce facilmente ogni caso. L'elenco completo e gli esempi di risposta sono nella documentazione API.

Quanto costa l'API VPS?

L'API VPS è gratuita per tutti i membri. I server e le opzioni creati con l'API vengono pagati agli stessi prezzi dei server creati nel pannello di controllo.

HELPER VPS in numeri

Scegli tra 40 regioni, 12 sistemi operativi e 10 app con un clic in un account e paga subito. I numeri qui sotto si basano su ciò che è in vendita ora.

Strumenti di automazione da usare con l'API VPS

Qualsiasi strumento in grado di inviare richieste HTTP si collega all'API VPS. Da una riga di curl a script Python e Node.js fino alle pipeline di deploy, si usa allo stesso modo.

  • Terraform
  • Python
  • Node.js
  • GitLab CI
  • Docker

Perché scegliere l'API di HELPER VPS

Domande frequenti sull'API VPS

Risposte su collegamento, autenticazione e limiti di richieste dell'API VPS

L'API VPS è gratuita?

Sì, l'API VPS è gratuita per tutti i membri. L'emissione di chiavi API e l'invio di richieste sono gratuiti, e i server e le opzioni creati con l'API vengono pagati agli stessi prezzi di quelli creati nel pannello di controllo. Qualsiasi membro che ha effettuato il primo pagamento può creare subito una chiave nella pagina delle chiavi API.

Dove si crea la chiave API?

Dopo aver effettuato il primo pagamento, la pagina delle chiavi API (/api-key) si apre e puoi creare chiavi lì. Inserisci la chiave nell'intestazione Authorization di ogni richiesta utilizzando lo schema Bearer. La chiave sblocca l'intero account, quindi non inserirla nei repository di codice; conservala in variabili d'ambiente o in un archivio di segreti.

Quali operazioni posso fare via API?

Puoi leggere il catalogo (GET /catalog), leggere l'elenco dei server e i dati di un singolo server (GET /servers, GET /servers/{id}), creare server (POST /servers), accendere, spegnere e riavviare (start, stop, reboot), rinnovare per un mese (renew) ed eliminare (DELETE /servers/{id}). Esempi di richieste e formato delle risposte sono nella documentazione API.

Qual è il limite di richieste?

Con una chiave invii fino a 300 richieste al minuto. Superando il limite torna il codice di stato 429 con l'errore rate_limited, quindi basta fare in modo che lo script attenda un attimo e invii di nuovo. Le automazioni quotidiane, come verifica dell'elenco dei server e gestione dell'alimentazione, funzionano con margine entro questo limite. Non ci sono costi in base al numero di richieste.

Come viene addebitato il costo se creo un server via API?

Quando una richiesta POST /servers ha successo, il pagamento per il periodo di fatturazione scelto viene elaborato e il server viene creato. Il pagamento per un server che non riesce a creare viene restituito al credito del tuo account.

Come ricevo la password root via API?

La risposta alla richiesta di creazione del server contiene una volta il valore root_password. Salvalo in un posto sicuro appena ricevi la risposta. Puoi rivederlo anche nel pannello per 7 giorni e, inviando anche il numero di una chiave SSH, accedi subito con la chiave senza password. Con il valore ipv4 della risposta avvii subito l'accesso SSH, comodo da collegare agli script di deploy.

Posso inserire una chiave SSH via API?

Sì, inserendo nella richiesta di creazione del server il numero di una chiave SSH registrata nel valore ssh_key_id, quella chiave viene inserita nel nuovo server. Basta registrare la chiave una volta nella schermata Chiavi SSH del pannello; l'impronta è mostrata come con ssh-keygen, così capisci subito quale chiave è. Il numero della chiave lo imposti una volta e lo riusi.

Con quali linguaggi o strumenti posso usarla?

Con qualsiasi linguaggio o strumento in grado di inviare richieste HTTP. Provi subito con curl e la chiami con lo stesso indirizzo e le stesse intestazioni da requests di Python, fetch di Node.js, i passaggi di script di GitLab CI e la funzione di richiesta HTTP di Terraform. Tutte le risposte sono in JSON, quindi i risultati sono facili da leggere.

Come capisco se c'è un errore?

Gli errori tornano con un codice di stato diverso da 2xx e un JSON con il valore error. I motivi sono distinti, come unauthorized se la chiave è sbagliata, bad_request se manca un valore, not_enough_balance se il saldo non basta e wrong_state se la richiesta non è compatibile con lo stato del server, così il programma gestisce ogni caso.

I server creati via API compaiono anche nel pannello?

Sì, API e pannello gestiscono lo stesso account e gli stessi server. I server creati via API compaiono così come sono nell'elenco del pannello, dove puoi reinstallare il sistema operativo o controllare la password. Il limite di 10 server per account vale per entrambe le modalità. Anche mescolando lavoro manuale e lavoro dal codice, stato e date di addebito risultano sempre uguali.

Guide all'API VPS

Guide utili da leggere quando colleghi l'API per la prima volta

L'API VPS è gratuita per tutti i membri e puoi creare una chiave API dopo aver effettuato il primo pagamento. I server e le opzioni creati con l'API vengono pagati agli stessi prezzi del listino e si rinnovano automaticamente allo stesso importo in ogni data di fatturazione.

Limite di richieste: 300 al minuto per chiave API | 10 server per account | Se il pagamento fallisce: server sospeso, poi eliminato dopo 3 giorni | Il tempo rimanente sui server eliminati non viene rimborsato. I rimborsi vanno al credito del tuo account.