Vai al contenuto
AdiosDocumentazione
Esplora la documentazione

API di sicurezza del gateway

Configura HTTPS, CORS e WAF per un nome host controllato dal tuo team.

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/gateway_security_profileElenca i profili di sicurezza del gateway
POST/v1/gateway_security_profileCrea un profilo di sicurezza del gateway
GET/v1/gateway_security_profile/{id}Ottieni un profilo di sicurezza del gateway
PUT/v1/gateway_security_profile/{id}Aggiorna un profilo di sicurezza del gateway
DELETE/v1/gateway_security_profile/{id}Elimina un profilo di sicurezza del gateway

Elenca i profili di sicurezza del gateway

GET /v1/gateway_security_profile

Restituisce un elenco paginato di GatewaySecurityProfile

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/gateway_security_profile" \
  -H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
  -H "X-Tenant-ID: $ADIOS_TEAM_ID"

Risposta: HTTP 200

Elenco di GatewaySecurityProfile

Campi di risposta

CampoTipoDescrizione
dataarray
data[].cors_enabledboolean
data[].cors_headersstringIntestazioni delle richieste CORS separate da virgole
data[].cors_methodsstringMetodi HTTP separati da virgole
data[].cors_originsstringOrigini separate da virgole oppure *
data[].created_atinteger(timestamp Unix)
data[].deleted_atinteger(timestamp Unix)
data[].enabledboolean
data[].force_httpsboolean
data[].geo_policyobjectPolitica facoltativa per consentire o bloccare paesi a livello di host
data[].hostnamestring
data[].hsts_enabledboolean
data[].max_body_bytesintegerLimite facoltativo alla dimensione del corpo della richiesta. 0 indica il valore predefinito della piattaforma.
data[].profile_idstring
data[].team_idstring
data[].updated_atinteger(timestamp Unix)
data[].waf_custom_directivesstringDirettive Coraza originali usate quando waf_template=custom
data[].waf_modestringValori consentiti: off, monitor, block.
data[].waf_overridesobjectOverride strutturati del modello (per esempio esclusioni per percorso o attivazione e disattivazione di regole)
data[].waf_rule_exclusionsobjectElenco facoltativo di esclusioni gestite. Esempio: [{"path_prefix":"/api/monitoring","remove_rule_ids":[920420]}]
data[].waf_templatestringModello preconfigurato di regole WAF da applicare a questo host. Valori consentiti: platform_default, workload_default, api_strict, nextjs, django, wordpress, custom.
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": [
    {
      "cors_enabled": true,
      "cors_headers": "example",
      "cors_methods": "example",
      "cors_origins": "example",
      "created_at": 1791072000,
      "deleted_at": 0,
      "enabled": true,
      "force_https": true,
      "geo_policy": {},
      "hostname": "app.example.com",
      "hsts_enabled": true,
      "max_body_bytes": 0,
      "profile_id": "000000000000000000000000001",
      "team_id": "000000000000000000000000001",
      "updated_at": 1791072000,
      "waf_custom_directives": "example",
      "waf_mode": "off",
      "waf_overrides": {},
      "waf_rule_exclusions": {},
      "waf_template": "workload_default"
    }
  ],
  "pagination": {
    "page": 1,
    "per_page": 1,
    "total": 1
  }
}

Crea un profilo di sicurezza del gateway

POST /v1/gateway_security_profile

Crea un nuovo oggetto GatewaySecurityProfile

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
cors_enabledbooleanSìValore predefinito: true.
cors_headersstringNoIntestazioni delle richieste CORS separate da virgole
cors_methodsstringNoMetodi HTTP separati da virgole
cors_originsstringNoOrigini separate da virgole oppure *
enabledbooleanSìValore predefinito: true.
force_httpsbooleanSìValore predefinito: true.
geo_policyobjectNoPolitica facoltativa per consentire o bloccare paesi a livello di host
hostnamestringSì
hsts_enabledbooleanSìValore predefinito: true.
max_body_bytesintegerNoLimite facoltativo alla dimensione del corpo della richiesta. 0 indica il valore predefinito della piattaforma. Valore predefinito: 0.
team_idstringSì
waf_custom_directivesstringNoDirettive Coraza originali usate quando waf_template=custom
waf_modestringSìValori consentiti: off, monitor, block. Valore predefinito: "off".
waf_overridesobjectNoOverride strutturati del modello (per esempio esclusioni per percorso o attivazione e disattivazione di regole)
waf_rule_exclusionsobjectNoElenco facoltativo di esclusioni gestite. Esempio: [{"path_prefix":"/api/monitoring","remove_rule_ids":[920420]}]
waf_templatestringSìModello preconfigurato di regole WAF da applicare a questo host. Valori consentiti: platform_default, workload_default, api_strict, nextjs, django, wordpress, custom. Valore predefinito: "workload_default".

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/gateway_security_profile" \
  -H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
  -H "X-Tenant-ID: $ADIOS_TEAM_ID" \
  -H "Content-Type: application/json" \
  --data-binary @- <<'JSON'
{
  "cors_enabled": true,
  "enabled": true,
  "force_https": true,
  "hostname": "YOUR_HOSTNAME",
  "hsts_enabled": true,
  "max_body_bytes": 0,
  "team_id": "YOUR_TEAM_ID",
  "waf_mode": "off",
  "waf_template": "workload_default"
}
JSON

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

Risposta: HTTP 201

GatewaySecurityProfile creato

Campi di risposta

CampoTipoDescrizione
cors_enabledboolean
cors_headersstringIntestazioni delle richieste CORS separate da virgole
cors_methodsstringMetodi HTTP separati da virgole
cors_originsstringOrigini separate da virgole oppure *
created_atinteger(timestamp Unix)
deleted_atinteger(timestamp Unix)
enabledboolean
force_httpsboolean
geo_policyobjectPolitica facoltativa per consentire o bloccare paesi a livello di host
hostnamestring
hsts_enabledboolean
max_body_bytesintegerLimite facoltativo alla dimensione del corpo della richiesta. 0 indica il valore predefinito della piattaforma.
profile_idstring
team_idstring
updated_atinteger(timestamp Unix)
waf_custom_directivesstringDirettive Coraza originali usate quando waf_template=custom
waf_modestringValori consentiti: off, monitor, block.
waf_overridesobjectOverride strutturati del modello (per esempio esclusioni per percorso o attivazione e disattivazione di regole)
waf_rule_exclusionsobjectElenco facoltativo di esclusioni gestite. Esempio: [{"path_prefix":"/api/monitoring","remove_rule_ids":[920420]}]
waf_templatestringModello preconfigurato di regole WAF da applicare a questo host. Valori consentiti: platform_default, workload_default, api_strict, nextjs, django, wordpress, custom.

Esempio illustrativo; non è una risposta dal vivo:

{
  "cors_enabled": true,
  "cors_headers": "example",
  "cors_methods": "example",
  "cors_origins": "example",
  "created_at": 1791072000,
  "deleted_at": 0,
  "enabled": true,
  "force_https": true,
  "geo_policy": {},
  "hostname": "app.example.com",
  "hsts_enabled": true,
  "max_body_bytes": 0,
  "profile_id": "000000000000000000000000001",
  "team_id": "000000000000000000000000001",
  "updated_at": 1791072000,
  "waf_custom_directives": "example",
  "waf_mode": "off",
  "waf_overrides": {},
  "waf_rule_exclusions": {},
  "waf_template": "workload_default"
}

Ottieni un profilo di sicurezza del gateway

GET /v1/gateway_security_profile/{id}

Restituisce un oggetto GatewaySecurityProfile

Imposta gateway_security_profile_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/gateway_security_profile/${ADIOS_GATEWAY_SECURITY_PROFILE_ID}" \
  -H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
  -H "X-Tenant-ID: $ADIOS_TEAM_ID"

Risposta: HTTP 200

GatewaySecurityProfile

Campi di risposta

CampoTipoDescrizione
cors_enabledboolean
cors_headersstringIntestazioni delle richieste CORS separate da virgole
cors_methodsstringMetodi HTTP separati da virgole
cors_originsstringOrigini separate da virgole oppure *
created_atinteger(timestamp Unix)
deleted_atinteger(timestamp Unix)
enabledboolean
force_httpsboolean
geo_policyobjectPolitica facoltativa per consentire o bloccare paesi a livello di host
hostnamestring
hsts_enabledboolean
max_body_bytesintegerLimite facoltativo alla dimensione del corpo della richiesta. 0 indica il valore predefinito della piattaforma.
profile_idstring
team_idstring
updated_atinteger(timestamp Unix)
waf_custom_directivesstringDirettive Coraza originali usate quando waf_template=custom
waf_modestringValori consentiti: off, monitor, block.
waf_overridesobjectOverride strutturati del modello (per esempio esclusioni per percorso o attivazione e disattivazione di regole)
waf_rule_exclusionsobjectElenco facoltativo di esclusioni gestite. Esempio: [{"path_prefix":"/api/monitoring","remove_rule_ids":[920420]}]
waf_templatestringModello preconfigurato di regole WAF da applicare a questo host. Valori consentiti: platform_default, workload_default, api_strict, nextjs, django, wordpress, custom.

Esempio illustrativo; non è una risposta dal vivo:

{
  "cors_enabled": true,
  "cors_headers": "example",
  "cors_methods": "example",
  "cors_origins": "example",
  "created_at": 1791072000,
  "deleted_at": 0,
  "enabled": true,
  "force_https": true,
  "geo_policy": {},
  "hostname": "app.example.com",
  "hsts_enabled": true,
  "max_body_bytes": 0,
  "profile_id": "000000000000000000000000001",
  "team_id": "000000000000000000000000001",
  "updated_at": 1791072000,
  "waf_custom_directives": "example",
  "waf_mode": "off",
  "waf_overrides": {},
  "waf_rule_exclusions": {},
  "waf_template": "workload_default"
}

Aggiorna un profilo di sicurezza del gateway

PUT /v1/gateway_security_profile/{id}

Aggiorna un oggetto GatewaySecurityProfile esistente

Imposta gateway_security_profile_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
cors_enabledbooleanSìValore predefinito: true.
cors_headersstringNoIntestazioni delle richieste CORS separate da virgole
cors_methodsstringNoMetodi HTTP separati da virgole
cors_originsstringNoOrigini separate da virgole oppure *
enabledbooleanSìValore predefinito: true.
force_httpsbooleanSìValore predefinito: true.
geo_policyobjectNoPolitica facoltativa per consentire o bloccare paesi a livello di host
hostnamestringSì
hsts_enabledbooleanSìValore predefinito: true.
max_body_bytesintegerNoLimite facoltativo alla dimensione del corpo della richiesta. 0 indica il valore predefinito della piattaforma. Valore predefinito: 0.
team_idstringSì
waf_custom_directivesstringNoDirettive Coraza originali usate quando waf_template=custom
waf_modestringSìValori consentiti: off, monitor, block. Valore predefinito: "off".
waf_overridesobjectNoOverride strutturati del modello (per esempio esclusioni per percorso o attivazione e disattivazione di regole)
waf_rule_exclusionsobjectNoElenco facoltativo di esclusioni gestite. Esempio: [{"path_prefix":"/api/monitoring","remove_rule_ids":[920420]}]
waf_templatestringSìModello preconfigurato di regole WAF da applicare a questo host. Valori consentiti: platform_default, workload_default, api_strict, nextjs, django, wordpress, custom. Valore predefinito: "workload_default".

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/gateway_security_profile/${ADIOS_GATEWAY_SECURITY_PROFILE_ID}" \
  -H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
  -H "X-Tenant-ID: $ADIOS_TEAM_ID" \
  -H "Content-Type: application/json" \
  --data-binary @- <<'JSON'
{
  "cors_enabled": true,
  "enabled": true,
  "force_https": true,
  "hostname": "YOUR_HOSTNAME",
  "hsts_enabled": true,
  "max_body_bytes": 0,
  "team_id": "YOUR_TEAM_ID",
  "waf_mode": "off",
  "waf_template": "workload_default"
}
JSON

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

Risposta: HTTP 200

GatewaySecurityProfile aggiornato

Campi di risposta

CampoTipoDescrizione
cors_enabledboolean
cors_headersstringIntestazioni delle richieste CORS separate da virgole
cors_methodsstringMetodi HTTP separati da virgole
cors_originsstringOrigini separate da virgole oppure *
created_atinteger(timestamp Unix)
deleted_atinteger(timestamp Unix)
enabledboolean
force_httpsboolean
geo_policyobjectPolitica facoltativa per consentire o bloccare paesi a livello di host
hostnamestring
hsts_enabledboolean
max_body_bytesintegerLimite facoltativo alla dimensione del corpo della richiesta. 0 indica il valore predefinito della piattaforma.
profile_idstring
team_idstring
updated_atinteger(timestamp Unix)
waf_custom_directivesstringDirettive Coraza originali usate quando waf_template=custom
waf_modestringValori consentiti: off, monitor, block.
waf_overridesobjectOverride strutturati del modello (per esempio esclusioni per percorso o attivazione e disattivazione di regole)
waf_rule_exclusionsobjectElenco facoltativo di esclusioni gestite. Esempio: [{"path_prefix":"/api/monitoring","remove_rule_ids":[920420]}]
waf_templatestringModello preconfigurato di regole WAF da applicare a questo host. Valori consentiti: platform_default, workload_default, api_strict, nextjs, django, wordpress, custom.

Esempio illustrativo; non è una risposta dal vivo:

{
  "cors_enabled": true,
  "cors_headers": "example",
  "cors_methods": "example",
  "cors_origins": "example",
  "created_at": 1791072000,
  "deleted_at": 0,
  "enabled": true,
  "force_https": true,
  "geo_policy": {},
  "hostname": "app.example.com",
  "hsts_enabled": true,
  "max_body_bytes": 0,
  "profile_id": "000000000000000000000000001",
  "team_id": "000000000000000000000000001",
  "updated_at": 1791072000,
  "waf_custom_directives": "example",
  "waf_mode": "off",
  "waf_overrides": {},
  "waf_rule_exclusions": {},
  "waf_template": "workload_default"
}

Elimina un profilo di sicurezza del gateway

DELETE /v1/gateway_security_profile/{id}

Elimina un oggetto GatewaySecurityProfile

Imposta gateway_security_profile_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/gateway_security_profile/${ADIOS_GATEWAY_SECURITY_PROFILE_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"
}