API

Cos'è?

L'API ti permette di gestire i tuoi servizi da script, pipeline di deploy e strumenti esterni, senza passare dall'interfaccia. È pensata soprattutto per automatizzare i record DNS: rinnovo dei certificati, pubblicazione di un sito, aggiornamenti massivi.

Per usarla ti serve una chiave: vedi Chiavi API per crearla e gestirla.

Indirizzo di base

Tutte le chiamate partono da:

https://console.icbs.it/api/v1

Se accedi alla console da un dominio dedicato, usa quello: le chiamate e le chiavi sono le stesse, cambia solo l'indirizzo.

Chiamate disponibili

Chiave

Chiamata	Metodo	Permesso
Verificare la chiave	GET	nessuno

Domini

Chiamata	Metodo	Permesso
Elenco dei domini	GET	Domini — lettura
Dettaglio di un dominio	GET	Domini — lettura
Verificare la disponibilità	GET	Domini — lettura
Listino prezzi	GET	Domini — lettura
Domini in scadenza	GET	Domini — lettura
Preventivo di rinnovo	GET	Domini — lettura
Rinnovare un dominio	POST	nessuno
Modificare le impostazioni	PATCH	Domini — modifica
Dati dell'intestatario	GET	Domini — lettura
Modificare l'intestatario	PATCH	Domini — modifica
Nameserver	GET	Domini — lettura
Modificare i nameserver	PATCH	Domini — modifica
Child nameserver	GET	Domini — lettura
Creare o modificare un child nameserver	PUT	Domini — modifica
Eliminare un child nameserver	DELETE	Domini — modifica

DNS

Chiamata	Metodo	Permesso
Elenco dei record	GET	DNS — lettura
Creare un record	POST	DNS — scrittura
Modificare un record	PATCH	DNS — scrittura
Eliminare un record	DELETE	DNS — scrittura
Creare la zona	POST	DNS — scrittura
Eliminare la zona	DELETE	DNS — eliminazione zona
Elenco dei template	GET	DNS — lettura
Applicare un template	POST	DNS — scrittura
Esportare la zona

Hosting

Chiamata	Metodo	Permesso
Elenco dei siti	GET	Hosting — lettura
Dettaglio di un sito	GET	Hosting — lettura
Statistiche di traffico	GET	Hosting — lettura

Email

Chiamata	Metodo	Permesso
Elenco dei domini	GET	Email — lettura
Elenco delle caselle	GET	Email — lettura
Creare una casella	POST	Email — scrittura
Modificare una casella	PATCH	Email — scrittura
Eliminare una casella	DELETE	Email — scrittura
Elenco degli inoltri	GET	Email — lettura
Creare un inoltro	POST	Email — scrittura
Modificare un inoltro

FTP

Chiamata	Metodo	Permesso
Elenco dei domini	GET	FTP — lettura
Elenco degli utenti	GET	FTP — lettura

Database

Chiamata	Metodo	Permesso
Elenco dei domini	GET	MySQL — lettura
Elenco dei database	GET	MySQL — lettura

Backup e monitoraggio

Chiamata	Metodo	Permesso
Elenco dei backup	GET	Backup — lettura
Elenco dei controlli	GET	Monitoraggio — lettura
Dettaglio di un controllo	GET	Monitoraggio — lettura
Creare un controllo	POST	Monitoraggio — scrittura
Modificare un controllo	PATCH	Monitoraggio — scrittura
Eliminare un controllo	DELETE	Monitoraggio — scrittura

Gruppi

Chiamata	Metodo	Permesso
Elenco dei gruppi	GET	Gruppi — lettura
Creare un gruppo	POST	Gruppi — scrittura
Modificare un gruppo	PATCH	Gruppi — scrittura
Eliminare un gruppo	DELETE	Gruppi — scrittura

Ordini

Chiamata	Metodo	Permesso
Stato di un ordine	GET	Domini — lettura

Vedi Autenticazione per come inviare la chiave e come interpretare gli errori.

Cosa l'API non fa

L'elenco qui sopra è la fonte di riferimento su cosa è disponibile: se un'operazione non compare in quella tabella, non esiste via API.

Una chiave non può mai fare più di chi l'ha creata. Se il tuo utente perde i permessi di modifica, le chiavi che hai generato passano automaticamente in sola lettura.

Specifica OpenAPI

La descrizione completa e sempre aggiornata è pubblicata in formato OpenAPI 3.1 all'indirizzo https://console.icbs.it/api-v1-openapi.yaml.

Il file è pubblico e non richiede autenticazione: descrive le chiamate, non contiene dati. Puoi importarlo in:

• Postman — Import → Link, incolla l'indirizzo: ottieni una collezione pronta con tutte le chiamate.
• Insomnia — Import From → URL.
• Swagger Editor (editor.swagger.io) — File → Import URL, per la documentazione navigabile.
• Generatori di client — qualsiasi strumento compatibile OpenAPI 3.1 genera il client per il tuo linguaggio.

Nella specifica l'indirizzo del server usa una variabile hostname: impostala con l'indirizzo della tua console prima di eseguire le chiamate.