API delle route del gateway

Instrada un nome host verificato verso un carico di lavoro, un workflow, un URL o un bucket di oggetti. Imposta l’identificativo corrispondente a target_kind.

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.

Metodo	Percorso	Operazione
GET	/v1/gateway_route	Elenca le route del gateway
POST	/v1/gateway_route	Crea una route del gateway
GET	/v1/gateway_route/{id}	Ottieni una route del gateway
PUT	/v1/gateway_route/{id}	Aggiorna una route del gateway
DELETE	/v1/gateway_route/{id}	Elimina una route del gateway

Elenca le route del gateway

GET /v1/gateway_route

Restituisce un elenco paginato di GatewayRoute

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

Parametri

Nome	Posizione	Obbligatorio	Descrizione
X-Tenant-ID	header	Sì	ID del team attivo. Deve corrispondere al tenant a cui è vincolato il token diagnostico.
page	query	No	Numero di pagina
per_page	query	No	Elementi 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/gateway_route" \
  -H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
  -H "X-Tenant-ID: $ADIOS_TEAM_ID"

Risposta: HTTP 200

Elenco di GatewayRoute

Campi di risposta

Campo	Tipo	Descrizione
data	array
data[].auth_policy	object	Politica di autenticazione degli utenti del gateway. Riguarda l’autenticazione nell’app, non quella dell’API o dell’amministrazione.
data[].created_at	integer	(timestamp Unix)
data[].deleted_at	integer	(timestamp Unix)
data[].enabled	boolean
data[].exposure	string	Valori consentiti: public, auth, private.
data[].geo_policy	object	Politica facoltativa per consentire o bloccare paesi
data[].hostname	string
data[].object_bucket_id	string
data[].path_prefix	string
data[].priority	integer
data[].rewrite_to	string	Percorso di riscrittura facoltativo applicato prima dell’inoltro tramite proxy (per esempio /v1)
data[].route_id	string
data[].security_policy	object	Override facoltativo della sicurezza HTTP a livello di route
data[].strip_prefix	boolean
data[].target_kind	string	Valori consentiti: workload, workflow, url, object_storage.
data[].target_url	string	URL assoluto usato quando target_kind=url
data[].team_id	string
data[].traffic_policy	object	Politica facoltativa del traffico regionale a livello di route per la selezione della destinazione del gateway
data[].trigger_name	string
data[].updated_at	integer	(timestamp Unix)
data[].workflow_id	string
data[].workload_id	string
pagination	object
pagination.page	integer	Numero di pagina attuale
pagination.per_page	integer	Numero di elementi per pagina
pagination.total	integer	Numero totale di elementi

Esempio illustrativo; non è una risposta dal vivo:

{
  "data": [
    {
      "auth_policy": {},
      "created_at": 1791072000,
      "deleted_at": 0,
      "enabled": true,
      "exposure": "public",
      "geo_policy": {},
      "hostname": "app.example.com",
      "object_bucket_id": "000000000000000000000000001",
      "path_prefix": "/",
      "priority": 0,
      "rewrite_to": "example",
      "route_id": "000000000000000000000000001",
      "security_policy": {},
      "strip_prefix": false,
      "target_kind": "workload",
      "target_url": "example",
      "team_id": "000000000000000000000000001",
      "traffic_policy": {},
      "trigger_name": "example",
      "updated_at": 1791072000,
      "workflow_id": "example",
      "workload_id": "000000000000000000000000001"
    }
  ],
  "pagination": {
    "page": 1,
    "per_page": 1,
    "total": 1
  }
}

Crea una route del gateway

POST /v1/gateway_route

Crea un nuovo oggetto GatewayRoute

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):

Campo	Tipo	Obbligatorio	Descrizione
auth_policy	object	No	Politica di autenticazione degli utenti del gateway. Riguarda l’autenticazione nell’app, non quella dell’API o dell’amministrazione.
enabled	boolean	Sì	Valore predefinito: true.
exposure	string	Sì	Valori consentiti: public, auth, private. Valore predefinito: "public".
geo_policy	object	No	Politica facoltativa per consentire o bloccare paesi
hostname	string	Sì
object_bucket_id	string	No
path_prefix	string	Sì	Valore predefinito: "/".
priority	integer	Sì	Valore predefinito: 0.
rewrite_to	string	No	Percorso di riscrittura facoltativo applicato prima dell’inoltro tramite proxy (per esempio /v1)
security_policy	object	No	Override facoltativo della sicurezza HTTP a livello di route
strip_prefix	boolean	Sì	Valore predefinito: false.
target_kind	string	Sì	Valori consentiti: workload, workflow, url, object_storage. Valore predefinito: "workload".
target_url	string	No	URL assoluto usato quando target_kind=url
team_id	string	Sì
traffic_policy	object	No	Politica facoltativa del traffico regionale a livello di route per la selezione della destinazione del gateway
trigger_name	string	No
workflow_id	string	No
workload_id	string	No

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

Parametri

Nome	Posizione	Obbligatorio	Descrizione
X-Tenant-ID	header	Sì	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/gateway_route" \
  -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",
  "path_prefix": "/",
  "target_kind": "workload",
  "workload_id": "YOUR_WORKLOAD_ID",
  "exposure": "public",
  "priority": 0,
  "strip_prefix": false,
  "enabled": true
}
JSON

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

Risposta: HTTP 201

GatewayRoute creato

Campi di risposta

Campo	Tipo	Descrizione
auth_policy	object	Politica di autenticazione degli utenti del gateway. Riguarda l’autenticazione nell’app, non quella dell’API o dell’amministrazione.
created_at	integer	(timestamp Unix)
deleted_at	integer	(timestamp Unix)
enabled	boolean
exposure	string	Valori consentiti: public, auth, private.
geo_policy	object	Politica facoltativa per consentire o bloccare paesi
hostname	string
object_bucket_id	string
path_prefix	string
priority	integer
rewrite_to	string	Percorso di riscrittura facoltativo applicato prima dell’inoltro tramite proxy (per esempio /v1)
route_id	string
security_policy	object	Override facoltativo della sicurezza HTTP a livello di route
strip_prefix	boolean
target_kind	string	Valori consentiti: workload, workflow, url, object_storage.
target_url	string	URL assoluto usato quando target_kind=url
team_id	string
traffic_policy	object	Politica facoltativa del traffico regionale a livello di route per la selezione della destinazione del gateway
trigger_name	string
updated_at	integer	(timestamp Unix)
workflow_id	string
workload_id	string

Esempio illustrativo; non è una risposta dal vivo:

{
  "auth_policy": {},
  "created_at": 1791072000,
  "deleted_at": 0,
  "enabled": true,
  "exposure": "public",
  "geo_policy": {},
  "hostname": "app.example.com",
  "object_bucket_id": "000000000000000000000000001",
  "path_prefix": "/",
  "priority": 0,
  "rewrite_to": "example",
  "route_id": "000000000000000000000000001",
  "security_policy": {},
  "strip_prefix": false,
  "target_kind": "workload",
  "target_url": "example",
  "team_id": "000000000000000000000000001",
  "traffic_policy": {},
  "trigger_name": "example",
  "updated_at": 1791072000,
  "workflow_id": "example",
  "workload_id": "000000000000000000000000001"
}

Ottieni una route del gateway

GET /v1/gateway_route/{id}

Restituisce un oggetto GatewayRoute

Imposta gateway_route_id usando gli ID restituiti dalle tue risposte API.

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

Parametri

Nome	Posizione	Obbligatorio	Descrizione
id	path	Sì	Identificativo della risorsa ottenuto dai risultati API del tuo team.
X-Tenant-ID	header	Sì	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/gateway_route/${ADIOS_GATEWAY_ROUTE_ID}" \
  -H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
  -H "X-Tenant-ID: $ADIOS_TEAM_ID"

Risposta: HTTP 200

GatewayRoute

Campi di risposta

Campo	Tipo	Descrizione
auth_policy	object	Politica di autenticazione degli utenti del gateway. Riguarda l’autenticazione nell’app, non quella dell’API o dell’amministrazione.
created_at	integer	(timestamp Unix)
deleted_at	integer	(timestamp Unix)
enabled	boolean
exposure	string	Valori consentiti: public, auth, private.
geo_policy	object	Politica facoltativa per consentire o bloccare paesi
hostname	string
object_bucket_id	string
path_prefix	string
priority	integer
rewrite_to	string	Percorso di riscrittura facoltativo applicato prima dell’inoltro tramite proxy (per esempio /v1)
route_id	string
security_policy	object	Override facoltativo della sicurezza HTTP a livello di route
strip_prefix	boolean
target_kind	string	Valori consentiti: workload, workflow, url, object_storage.
target_url	string	URL assoluto usato quando target_kind=url
team_id	string
traffic_policy	object	Politica facoltativa del traffico regionale a livello di route per la selezione della destinazione del gateway
trigger_name	string
updated_at	integer	(timestamp Unix)
workflow_id	string
workload_id	string

Esempio illustrativo; non è una risposta dal vivo:

{
  "auth_policy": {},
  "created_at": 1791072000,
  "deleted_at": 0,
  "enabled": true,
  "exposure": "public",
  "geo_policy": {},
  "hostname": "app.example.com",
  "object_bucket_id": "000000000000000000000000001",
  "path_prefix": "/",
  "priority": 0,
  "rewrite_to": "example",
  "route_id": "000000000000000000000000001",
  "security_policy": {},
  "strip_prefix": false,
  "target_kind": "workload",
  "target_url": "example",
  "team_id": "000000000000000000000000001",
  "traffic_policy": {},
  "trigger_name": "example",
  "updated_at": 1791072000,
  "workflow_id": "example",
  "workload_id": "000000000000000000000000001"
}

Aggiorna una route del gateway

PUT /v1/gateway_route/{id}

Aggiorna un oggetto GatewayRoute esistente

Imposta gateway_route_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):

Campo	Tipo	Obbligatorio	Descrizione
auth_policy	object	No	Politica di autenticazione degli utenti del gateway. Riguarda l’autenticazione nell’app, non quella dell’API o dell’amministrazione.
enabled	boolean	Sì	Valore predefinito: true.
exposure	string	Sì	Valori consentiti: public, auth, private. Valore predefinito: "public".
geo_policy	object	No	Politica facoltativa per consentire o bloccare paesi
hostname	string	Sì
object_bucket_id	string	No
path_prefix	string	Sì	Valore predefinito: "/".
priority	integer	Sì	Valore predefinito: 0.
rewrite_to	string	No	Percorso di riscrittura facoltativo applicato prima dell’inoltro tramite proxy (per esempio /v1)
security_policy	object	No	Override facoltativo della sicurezza HTTP a livello di route
strip_prefix	boolean	Sì	Valore predefinito: false.
target_kind	string	Sì	Valori consentiti: workload, workflow, url, object_storage. Valore predefinito: "workload".
target_url	string	No	URL assoluto usato quando target_kind=url
team_id	string	Sì
traffic_policy	object	No	Politica facoltativa del traffico regionale a livello di route per la selezione della destinazione del gateway
trigger_name	string	No
workflow_id	string	No
workload_id	string	No

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

Parametri

Nome	Posizione	Obbligatorio	Descrizione
id	path	Sì	Identificativo della risorsa ottenuto dai risultati API del tuo team.
X-Tenant-ID	header	Sì	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/gateway_route/${ADIOS_GATEWAY_ROUTE_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",
  "path_prefix": "/",
  "target_kind": "workload",
  "workload_id": "YOUR_WORKLOAD_ID",
  "exposure": "public",
  "priority": 0,
  "strip_prefix": false,
  "enabled": true
}
JSON

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

Risposta: HTTP 200

GatewayRoute aggiornato

Campi di risposta

Campo	Tipo	Descrizione
auth_policy	object	Politica di autenticazione degli utenti del gateway. Riguarda l’autenticazione nell’app, non quella dell’API o dell’amministrazione.
created_at	integer	(timestamp Unix)
deleted_at	integer	(timestamp Unix)
enabled	boolean
exposure	string	Valori consentiti: public, auth, private.
geo_policy	object	Politica facoltativa per consentire o bloccare paesi
hostname	string
object_bucket_id	string
path_prefix	string
priority	integer
rewrite_to	string	Percorso di riscrittura facoltativo applicato prima dell’inoltro tramite proxy (per esempio /v1)
route_id	string
security_policy	object	Override facoltativo della sicurezza HTTP a livello di route
strip_prefix	boolean
target_kind	string	Valori consentiti: workload, workflow, url, object_storage.
target_url	string	URL assoluto usato quando target_kind=url
team_id	string
traffic_policy	object	Politica facoltativa del traffico regionale a livello di route per la selezione della destinazione del gateway
trigger_name	string
updated_at	integer	(timestamp Unix)
workflow_id	string
workload_id	string

Esempio illustrativo; non è una risposta dal vivo:

{
  "auth_policy": {},
  "created_at": 1791072000,
  "deleted_at": 0,
  "enabled": true,
  "exposure": "public",
  "geo_policy": {},
  "hostname": "app.example.com",
  "object_bucket_id": "000000000000000000000000001",
  "path_prefix": "/",
  "priority": 0,
  "rewrite_to": "example",
  "route_id": "000000000000000000000000001",
  "security_policy": {},
  "strip_prefix": false,
  "target_kind": "workload",
  "target_url": "example",
  "team_id": "000000000000000000000000001",
  "traffic_policy": {},
  "trigger_name": "example",
  "updated_at": 1791072000,
  "workflow_id": "example",
  "workload_id": "000000000000000000000000001"
}

Elimina una route del gateway

DELETE /v1/gateway_route/{id}

Elimina un oggetto GatewayRoute

Imposta gateway_route_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

Nome	Posizione	Obbligatorio	Descrizione
id	path	Sì	Identificativo della risorsa ottenuto dai risultati API del tuo team.
X-Tenant-ID	header	Sì	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/gateway_route/${ADIOS_GATEWAY_ROUTE_ID}" \
  -H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
  -H "X-Tenant-ID: $ADIOS_TEAM_ID"

Risposta: HTTP 200

Risorsa eliminata.

Campi di risposta

Campo	Tipo	Descrizione
message	string

Esempio illustrativo; non è una risposta dal vivo:

{
  "message": "Deleted successfully"
}