Vai al contenuto
AdiosDocumentazione
Esplora la documentazione

API dei domini

Aggiungi un nome host di tua proprietà, configura il CNAME di verifica restituito dall’API, poi invia Verifica dominio.

Usa Autenticazione API per le richieste protette. Gli esempi usano i tuoi ID di risorse e un token temporaneo; gli esempi di risposte salvate sono sintetici.

MetodoPercorsoOperazione
GET/v1/domainElenca i domini
POST/v1/domainCrea dominio
GET/v1/domain/{id}Ottieni dominio
PUT/v1/domain/{id}Aggiorna dominio
DELETE/v1/domain/{id}Elimina dominio
POST/v1/domain/{id}/verifyVerifica dominio

Elenca i domini

GET /v1/domain

Restituisce un elenco paginato di Domain

Autenticazione: token bearer e intestazione del team mostrate di seguito.

Parametri

NomePosizioneObbligatorioDescrizione
X-Tenant-IDheaderSìID del team attivo. Deve corrispondere al tenant a cui è vincolato il token diagnostico.
pagequeryNoNumero di pagina
per_pagequeryNoElementi per pagina

Esempio di richiesta

Imposta ADIOS_API_URL=https://api.adios.dev. Per le richieste protette, imposta ADIOS_ACCESS_TOKEN e ADIOS_TEAM_ID come nel guida rapida. Imposta le eventuali variabili aggiuntive ADIOS_* con i valori ottenuti dalle tue risorse.

curl --fail-with-body --request GET "$ADIOS_API_URL/v1/domain" \
  -H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
  -H "X-Tenant-ID: $ADIOS_TEAM_ID"

Risposta: HTTP 200

Elenco di Domain

Campi di risposta

CampoTipoDescrizione
dataarray
data[].created_atinteger(timestamp Unix)
data[].deleted_atinteger(timestamp Unix)
data[].domain_idstring
data[].hostnamestringNome host personalizzato di proprietà dell’utente; i namespace adios.dev e adios.run sono riservati alle route gestite dalla piattaforma
data[].redirect_tostringURL o hostname facoltativo da reindirizzare a (ad es. https://www.adios.dev)
data[].scopestringAmbito autorizzato del nome host: exact consente solo il nome host; subtree consente anche i nomi host discendenti. I nuovi domini registrabili usano subtree per impostazione predefinita, i nuovi sottodomini usano exact e i record esistenti mantengono subtree per compatibilità con le versioni precedenti. Valori consentiti: exact, subtree.
data[].statusstringStato di verifica del dominio. Valori consentiti: pending, verified.
data[].team_idstring
data[].updated_atinteger(timestamp Unix)
data[].verification_hostnamestringNome DNS da configurare come CNAME per verificare la proprietà
data[].verification_parent_idstringRegistrazione verificata del dominio padre da cui questo nome host ha ereditato la verifica; vuoto in caso di verifica DNS diretta
data[].verification_valuestringValore CNAME atteso per verificare la proprietà
data[].verified_atinteger(timestamp Unix)
data[].workload_idstring
paginationobject
pagination.pageintegerNumero di pagina attuale
pagination.per_pageintegerNumero di elementi per pagina
pagination.totalintegerNumero totale di elementi

Esempio illustrativo; non è una risposta dal vivo:

{
  "data": [
    {
      "created_at": 1791072000,
      "deleted_at": 0,
      "domain_id": "000000000000000000000000001",
      "hostname": "app.example.com",
      "redirect_to": "example",
      "scope": "exact",
      "status": "pending",
      "team_id": "000000000000000000000000001",
      "updated_at": 1791072000,
      "verification_hostname": "example",
      "verification_parent_id": "000000000000000000000000001",
      "verification_value": "example",
      "verified_at": 0,
      "workload_id": "000000000000000000000000001"
    }
  ],
  "pagination": {
    "page": 1,
    "per_page": 1,
    "total": 1
  }
}

Crea dominio

POST /v1/domain

Crea un nuovo oggetto Domain

Questa richiesta modifica dati o avvia un’azione. Controlla la destinazione e il corpo prima dell’invio.

Campi di richiesta (il corpo contiene un esempio modificabile):

CampoTipoObbligatorioDescrizione
hostnamestringSìNome host personalizzato di proprietà dell’utente; i namespace adios.dev e adios.run sono riservati alle route gestite dalla piattaforma
redirect_tostringNoURL o hostname facoltativo da reindirizzare a (ad es. https://www.adios.dev)
scopestringNoAmbito autorizzato del nome host: exact consente solo il nome host; subtree consente anche i nomi host discendenti. I nuovi domini registrabili usano subtree per impostazione predefinita, i nuovi sottodomini usano exact e i record esistenti mantengono subtree per compatibilità con le versioni precedenti. Valori consentiti: exact, subtree.
statusstringNoStato di verifica del dominio. Valori consentiti: pending, verified. Valore predefinito: "pending".
team_idstringSì
verification_hostnamestringNoNome DNS da configurare come CNAME per verificare la proprietà
verification_parent_idstringNoRegistrazione verificata del dominio padre da cui questo nome host ha ereditato la verifica; vuoto in caso di verifica DNS diretta
verification_valuestringNoValore CNAME atteso per verificare la proprietà
verified_atintegerNo(timestamp Unix) Valore predefinito: 0.
workload_idstringNo

Autenticazione: token bearer e intestazione del team mostrate di seguito.

Parametri

NomePosizioneObbligatorioDescrizione
X-Tenant-IDheaderSìID del team attivo. Deve corrispondere al tenant a cui è vincolato il token diagnostico.

Esempio di richiesta

Imposta ADIOS_API_URL=https://api.adios.dev. Per le richieste protette, imposta ADIOS_ACCESS_TOKEN e ADIOS_TEAM_ID come nel guida rapida. Imposta le eventuali variabili aggiuntive ADIOS_* con i valori ottenuti dalle tue risorse.

curl --fail-with-body --request POST "$ADIOS_API_URL/v1/domain" \
  -H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
  -H "X-Tenant-ID: $ADIOS_TEAM_ID" \
  -H "Content-Type: application/json" \
  --data-binary @- <<'JSON'
{
  "team_id": "YOUR_TEAM_ID",
  "hostname": "YOUR_HOSTNAME"
}
JSON

Sostituisci YOUR_* nel corpo prima dell’invio. L’heredoc tra virgolette mantiene il JSON letterale.

Risposta: HTTP 201

Domain creato

Campi di risposta

CampoTipoDescrizione
created_atinteger(timestamp Unix)
deleted_atinteger(timestamp Unix)
domain_idstring
hostnamestringNome host personalizzato di proprietà dell’utente; i namespace adios.dev e adios.run sono riservati alle route gestite dalla piattaforma
redirect_tostringURL o hostname facoltativo da reindirizzare a (ad es. https://www.adios.dev)
scopestringAmbito autorizzato del nome host: exact consente solo il nome host; subtree consente anche i nomi host discendenti. I nuovi domini registrabili usano subtree per impostazione predefinita, i nuovi sottodomini usano exact e i record esistenti mantengono subtree per compatibilità con le versioni precedenti. Valori consentiti: exact, subtree.
statusstringStato di verifica del dominio. Valori consentiti: pending, verified.
team_idstring
updated_atinteger(timestamp Unix)
verification_hostnamestringNome DNS da configurare come CNAME per verificare la proprietà
verification_parent_idstringRegistrazione verificata del dominio padre da cui questo nome host ha ereditato la verifica; vuoto in caso di verifica DNS diretta
verification_valuestringValore CNAME atteso per verificare la proprietà
verified_atinteger(timestamp Unix)
workload_idstring

Esempio illustrativo; non è una risposta dal vivo:

{
  "created_at": 1791072000,
  "deleted_at": 0,
  "domain_id": "000000000000000000000000001",
  "hostname": "app.example.com",
  "redirect_to": "example",
  "scope": "exact",
  "status": "pending",
  "team_id": "000000000000000000000000001",
  "updated_at": 1791072000,
  "verification_hostname": "example",
  "verification_parent_id": "000000000000000000000000001",
  "verification_value": "example",
  "verified_at": 0,
  "workload_id": "000000000000000000000000001"
}

Ottieni dominio

GET /v1/domain/{id}

Restituisce un oggetto Domain

Imposta domain_id usando gli ID restituiti dalle tue risposte API.

Autenticazione: token bearer e intestazione del team mostrate di seguito.

Parametri

NomePosizioneObbligatorioDescrizione
idpathSìIdentificativo della risorsa ottenuto dai risultati API del tuo team.
X-Tenant-IDheaderSìID del team attivo. Deve corrispondere al tenant a cui è vincolato il token diagnostico.

Esempio di richiesta

Imposta ADIOS_API_URL=https://api.adios.dev. Per le richieste protette, imposta ADIOS_ACCESS_TOKEN e ADIOS_TEAM_ID come nel guida rapida. Imposta le eventuali variabili aggiuntive ADIOS_* con i valori ottenuti dalle tue risorse.

curl --fail-with-body --request GET "$ADIOS_API_URL/v1/domain/${ADIOS_DOMAIN_ID}" \
  -H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
  -H "X-Tenant-ID: $ADIOS_TEAM_ID"

Risposta: HTTP 200

Domain

Campi di risposta

CampoTipoDescrizione
created_atinteger(timestamp Unix)
deleted_atinteger(timestamp Unix)
domain_idstring
hostnamestringNome host personalizzato di proprietà dell’utente; i namespace adios.dev e adios.run sono riservati alle route gestite dalla piattaforma
redirect_tostringURL o hostname facoltativo da reindirizzare a (ad es. https://www.adios.dev)
scopestringAmbito autorizzato del nome host: exact consente solo il nome host; subtree consente anche i nomi host discendenti. I nuovi domini registrabili usano subtree per impostazione predefinita, i nuovi sottodomini usano exact e i record esistenti mantengono subtree per compatibilità con le versioni precedenti. Valori consentiti: exact, subtree.
statusstringStato di verifica del dominio. Valori consentiti: pending, verified.
team_idstring
updated_atinteger(timestamp Unix)
verification_hostnamestringNome DNS da configurare come CNAME per verificare la proprietà
verification_parent_idstringRegistrazione verificata del dominio padre da cui questo nome host ha ereditato la verifica; vuoto in caso di verifica DNS diretta
verification_valuestringValore CNAME atteso per verificare la proprietà
verified_atinteger(timestamp Unix)
workload_idstring

Esempio illustrativo; non è una risposta dal vivo:

{
  "created_at": 1791072000,
  "deleted_at": 0,
  "domain_id": "000000000000000000000000001",
  "hostname": "app.example.com",
  "redirect_to": "example",
  "scope": "exact",
  "status": "pending",
  "team_id": "000000000000000000000000001",
  "updated_at": 1791072000,
  "verification_hostname": "example",
  "verification_parent_id": "000000000000000000000000001",
  "verification_value": "example",
  "verified_at": 0,
  "workload_id": "000000000000000000000000001"
}

Aggiorna dominio

PUT /v1/domain/{id}

Aggiorna un oggetto Domain esistente

Imposta domain_id usando gli ID restituiti dalle tue risposte API.

Questa richiesta modifica dati o avvia un’azione. Controlla la destinazione e il corpo prima dell’invio.

Campi di richiesta (il corpo contiene un esempio modificabile):

CampoTipoObbligatorioDescrizione
hostnamestringSìNome host personalizzato di proprietà dell’utente; i namespace adios.dev e adios.run sono riservati alle route gestite dalla piattaforma
redirect_tostringNoURL o hostname facoltativo da reindirizzare a (ad es. https://www.adios.dev)
scopestringNoAmbito autorizzato del nome host: exact consente solo il nome host; subtree consente anche i nomi host discendenti. I nuovi domini registrabili usano subtree per impostazione predefinita, i nuovi sottodomini usano exact e i record esistenti mantengono subtree per compatibilità con le versioni precedenti. Valori consentiti: exact, subtree.
statusstringNoStato di verifica del dominio. Valori consentiti: pending, verified. Valore predefinito: "pending".
team_idstringSì
verification_hostnamestringNoNome DNS da configurare come CNAME per verificare la proprietà
verification_parent_idstringNoRegistrazione verificata del dominio padre da cui questo nome host ha ereditato la verifica; vuoto in caso di verifica DNS diretta
verification_valuestringNoValore CNAME atteso per verificare la proprietà
verified_atintegerNo(timestamp Unix) Valore predefinito: 0.
workload_idstringNo

Autenticazione: token bearer e intestazione del team mostrate di seguito.

Parametri

NomePosizioneObbligatorioDescrizione
idpathSìIdentificativo della risorsa ottenuto dai risultati API del tuo team.
X-Tenant-IDheaderSìID del team attivo. Deve corrispondere al tenant a cui è vincolato il token diagnostico.

Esempio di richiesta

Imposta ADIOS_API_URL=https://api.adios.dev. Per le richieste protette, imposta ADIOS_ACCESS_TOKEN e ADIOS_TEAM_ID come nel guida rapida. Imposta le eventuali variabili aggiuntive ADIOS_* con i valori ottenuti dalle tue risorse.

curl --fail-with-body --request PUT "$ADIOS_API_URL/v1/domain/${ADIOS_DOMAIN_ID}" \
  -H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
  -H "X-Tenant-ID: $ADIOS_TEAM_ID" \
  -H "Content-Type: application/json" \
  --data-binary @- <<'JSON'
{
  "team_id": "YOUR_TEAM_ID",
  "hostname": "YOUR_HOSTNAME"
}
JSON

Sostituisci YOUR_* nel corpo prima dell’invio. L’heredoc tra virgolette mantiene il JSON letterale.

Risposta: HTTP 200

Domain aggiornato

Campi di risposta

CampoTipoDescrizione
created_atinteger(timestamp Unix)
deleted_atinteger(timestamp Unix)
domain_idstring
hostnamestringNome host personalizzato di proprietà dell’utente; i namespace adios.dev e adios.run sono riservati alle route gestite dalla piattaforma
redirect_tostringURL o hostname facoltativo da reindirizzare a (ad es. https://www.adios.dev)
scopestringAmbito autorizzato del nome host: exact consente solo il nome host; subtree consente anche i nomi host discendenti. I nuovi domini registrabili usano subtree per impostazione predefinita, i nuovi sottodomini usano exact e i record esistenti mantengono subtree per compatibilità con le versioni precedenti. Valori consentiti: exact, subtree.
statusstringStato di verifica del dominio. Valori consentiti: pending, verified.
team_idstring
updated_atinteger(timestamp Unix)
verification_hostnamestringNome DNS da configurare come CNAME per verificare la proprietà
verification_parent_idstringRegistrazione verificata del dominio padre da cui questo nome host ha ereditato la verifica; vuoto in caso di verifica DNS diretta
verification_valuestringValore CNAME atteso per verificare la proprietà
verified_atinteger(timestamp Unix)
workload_idstring

Esempio illustrativo; non è una risposta dal vivo:

{
  "created_at": 1791072000,
  "deleted_at": 0,
  "domain_id": "000000000000000000000000001",
  "hostname": "app.example.com",
  "redirect_to": "example",
  "scope": "exact",
  "status": "pending",
  "team_id": "000000000000000000000000001",
  "updated_at": 1791072000,
  "verification_hostname": "example",
  "verification_parent_id": "000000000000000000000000001",
  "verification_value": "example",
  "verified_at": 0,
  "workload_id": "000000000000000000000000001"
}

Elimina dominio

DELETE /v1/domain/{id}

Elimina un oggetto Domain

Imposta domain_id usando gli ID restituiti dalle tue risposte API.

Questa richiesta modifica dati o avvia un’azione. Controlla la destinazione e il corpo prima dell’invio.

Autenticazione: token bearer e intestazione del team mostrate di seguito.

Parametri

NomePosizioneObbligatorioDescrizione
idpathSìIdentificativo della risorsa ottenuto dai risultati API del tuo team.
X-Tenant-IDheaderSìID del team attivo. Deve corrispondere al tenant a cui è vincolato il token diagnostico.

Esempio di richiesta

Imposta ADIOS_API_URL=https://api.adios.dev. Per le richieste protette, imposta ADIOS_ACCESS_TOKEN e ADIOS_TEAM_ID come nel guida rapida. Imposta le eventuali variabili aggiuntive ADIOS_* con i valori ottenuti dalle tue risorse.

curl --fail-with-body --request DELETE "$ADIOS_API_URL/v1/domain/${ADIOS_DOMAIN_ID}" \
  -H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
  -H "X-Tenant-ID: $ADIOS_TEAM_ID"

Risposta: HTTP 200

Risorsa eliminata.

Campi di risposta

CampoTipoDescrizione
messagestring

Esempio illustrativo; non è una risposta dal vivo:

{
  "message": "Deleted successfully"
}

Verifica dominio

POST /v1/domain/{id}/verify

Controlla il CNAME di verifica della proprietà fornito alla creazione del dominio. Configura il DNS prima di inviare questa richiesta.

Imposta domain_id usando gli ID restituiti dalle tue risposte API.

Questa richiesta modifica dati o avvia un’azione. Controlla la destinazione e il corpo prima dell’invio.

Autenticazione: token bearer e intestazione del team mostrate di seguito.

Parametri

NomePosizioneObbligatorioDescrizione
idpathSìIdentificativo della risorsa ottenuto dai risultati API del tuo team.
X-Tenant-IDheaderSìID del team attivo. Deve corrispondere al tenant a cui è vincolato il token diagnostico.

Esempio di richiesta

Imposta ADIOS_API_URL=https://api.adios.dev. Per le richieste protette, imposta ADIOS_ACCESS_TOKEN e ADIOS_TEAM_ID come nel guida rapida. Imposta le eventuali variabili aggiuntive ADIOS_* con i valori ottenuti dalle tue risorse.

curl --fail-with-body --request POST "$ADIOS_API_URL/v1/domain/${ADIOS_DOMAIN_ID}/verify" \
  -H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
  -H "X-Tenant-ID: $ADIOS_TEAM_ID"

Risposta: HTTP 200

Risposta riuscita. Controlla lo stato restituito per le operazioni che avviano attività asincrone.

Per questa operazione personalizzata non è pubblicato uno schema completo del corpo della risposta. Controlla il contenuto e lo stato restituiti; qui non si presume alcun formato del payload.