API de rotas de gateway

Direcione um nome de host verificado para um workload, workflow, URL ou bucket de objetos. Defina o identificador correspondente a target_kind.

Usar Autenticação da API para pedidos protegidos. Exemplos usam seus próprios IDs de recursos e um token temporário; exemplos de resposta salvos são sintéticos.

Método	Caminho	Operação
`GET`	`/v1/gateway_route`	Listar as rotas de gateway
`POST`	`/v1/gateway_route`	Criar rota de gateway
`GET`	`/v1/gateway_route/{id}`	Obter rota do gateway
`PUT`	`/v1/gateway_route/{id}`	Atualizar rota de gateway
`DELETE`	`/v1/gateway_route/{id}`	Excluir rota de gateway

Listar as rotas de gateway

GET /v1/gateway_route

Retorna uma lista paginada de GatewayRoute

Autenticação: token bearer e o cabeçalho de equipe mostrado abaixo.

Parâmetros

Nome	Localização	Obrigatório	Descrição
`X-Tenant-ID`	cabeçalho	sim	ID da equipe ativa. Deve corresponder ao tenant vinculado a um token de diagnóstico.
`page`	consulta	não	Número da página
`per_page`	consulta	não	Itens por página

Exemplo de requisição

Defina ADIOS_API_URL=https://api.adios.dev. Para requisições protegidas, defina ADIOS_ACCESS_TOKEN e ADIOS_TEAM_ID como na início rápido. Defina quaisquer variáveis adicionais ADIOS_* variáveis dos seus próprios resultados de recursos.

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"

Resposta: HTTP 200

Lista de GatewayRoute

Campos de resposta

Campo	Tipo	Descrição
`data`	array
`data[].auth_policy`	objeto	Política de autenticação de usuários no gateway. Aplica-se ao acesso ao aplicativo, não à autenticação da API ou administração.
`data[].created_at`	inteiro	(Timestamp Unix)
`data[].deleted_at`	inteiro	(Timestamp Unix)
`data[].enabled`	booleano
`data[].exposure`	string	Valores permitidos: public, auth, private.
`data[].geo_policy`	objeto	Política opcional de permissão ou bloqueio por país
`data[].hostname`	string
`data[].object_bucket_id`	string
`data[].path_prefix`	string
`data[].priority`	inteiro
`data[].rewrite_to`	string	Caminho de reescrita opcional aplicado antes do proxy (por exemplo /v1)
`data[].route_id`	string
`data[].security_policy`	objeto	Configuração de segurança HTTP opcional que substitui a configuração padrão no nível da rota
`data[].strip_prefix`	booleano
`data[].target_kind`	string	Valores permitidos: workload, workflow, url, object_storage.
`data[].target_url`	string	URL absoluta usada quando target_kind=url
`data[].team_id`	string
`data[].traffic_policy`	objeto	Política opcional de tráfego regional no nível da rota para selecionar o destino do gateway
`data[].trigger_name`	string
`data[].updated_at`	inteiro	(Timestamp Unix)
`data[].workflow_id`	string
`data[].workload_id`	string
`pagination`	objeto
`pagination.page`	inteiro	Número da página atual
`pagination.per_page`	inteiro	Número de itens por página
`pagination.total`	inteiro	Número total de itens

Exemplo ilustrativo; não é uma resposta real:

{
  "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
  }
}

Criar rota de gateway

POST /v1/gateway_route

Cria um novo objeto GatewayRoute

Esta requisição altera dados ou inicia uma ação. Confira o destino e o corpo antes de enviá-la.

Campos da requisição (o corpo contém um exemplo editável):

Campo	Tipo	Obrigatório	Descrição
`auth_policy`	objeto	não	Política de autenticação de usuários no gateway. Aplica-se ao acesso ao aplicativo, não à autenticação da API ou administração.
`enabled`	booleano	sim	Padrão: `true`.
`exposure`	string	sim	Valores permitidos: public, auth, private. Padrão: `"public"`.
`geo_policy`	objeto	não	Política opcional de permissão ou bloqueio por país
`hostname`	string	sim
`object_bucket_id`	string	não
`path_prefix`	string	sim	Padrão: `"/"`.
`priority`	inteiro	sim	Padrão: `0`.
`rewrite_to`	string	não	Caminho de reescrita opcional aplicado antes do proxy (por exemplo /v1)
`security_policy`	objeto	não	Configuração de segurança HTTP opcional que substitui a configuração padrão no nível da rota
`strip_prefix`	booleano	sim	Padrão: `false`.
`target_kind`	string	sim	Valores permitidos: workload, workflow, url, object_storage. Padrão: `"workload"`.
`target_url`	string	não	URL absoluta usada quando target_kind=url
`team_id`	string	sim
`traffic_policy`	objeto	não	Política opcional de tráfego regional no nível da rota para selecionar o destino do gateway
`trigger_name`	string	não
`workflow_id`	string	não
`workload_id`	string	não

Autenticação: token bearer e o cabeçalho de equipe mostrado abaixo.

Parâmetros

Nome	Localização	Obrigatório	Descrição
`X-Tenant-ID`	cabeçalho	sim	ID da equipe ativa. Deve corresponder ao tenant vinculado a um token de diagnóstico.

Exemplo de requisição

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

Substitua YOUR_* no corpo antes de enviar. O heredoc com delimitador entre aspas mantém o JSON literal.

Resposta: HTTP 201

GatewayRoute criado

Campos de resposta

Campo	Tipo	Descrição
`auth_policy`	objeto	Política de autenticação de usuários no gateway. Aplica-se ao acesso ao aplicativo, não à autenticação da API ou administração.
`created_at`	inteiro	(Timestamp Unix)
`deleted_at`	inteiro	(Timestamp Unix)
`enabled`	booleano
`exposure`	string	Valores permitidos: public, auth, private.
`geo_policy`	objeto	Política opcional de permissão ou bloqueio por país
`hostname`	string
`object_bucket_id`	string
`path_prefix`	string
`priority`	inteiro
`rewrite_to`	string	Caminho de reescrita opcional aplicado antes do proxy (por exemplo /v1)
`route_id`	string
`security_policy`	objeto	Configuração de segurança HTTP opcional que substitui a configuração padrão no nível da rota
`strip_prefix`	booleano
`target_kind`	string	Valores permitidos: workload, workflow, url, object_storage.
`target_url`	string	URL absoluta usada quando target_kind=url
`team_id`	string
`traffic_policy`	objeto	Política opcional de tráfego regional no nível da rota para selecionar o destino do gateway
`trigger_name`	string
`updated_at`	inteiro	(Timestamp Unix)
`workflow_id`	string
`workload_id`	string

Exemplo ilustrativo; não é uma resposta real:

{
  "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"
}

Obter rota do gateway

GET /v1/gateway_route/{id}

Retorna um objeto GatewayRoute

Defina gateway_route_id usando IDs das suas próprias respostas da API.

Autenticação: token bearer e o cabeçalho de equipe mostrado abaixo.

Parâmetros

Nome	Localização	Obrigatório	Descrição
`id`	caminho	sim	Identificador de recurso dos resultados da API da sua equipe.
`X-Tenant-ID`	cabeçalho	sim	ID da equipe ativa. Deve corresponder ao tenant vinculado a um token de diagnóstico.

Exemplo de requisição

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"

Resposta: HTTP 200

GatewayRoute

Campos de resposta

Campo	Tipo	Descrição
`auth_policy`	objeto	Política de autenticação de usuários no gateway. Aplica-se ao acesso ao aplicativo, não à autenticação da API ou administração.
`created_at`	inteiro	(Timestamp Unix)
`deleted_at`	inteiro	(Timestamp Unix)
`enabled`	booleano
`exposure`	string	Valores permitidos: public, auth, private.
`geo_policy`	objeto	Política opcional de permissão ou bloqueio por país
`hostname`	string
`object_bucket_id`	string
`path_prefix`	string
`priority`	inteiro
`rewrite_to`	string	Caminho de reescrita opcional aplicado antes do proxy (por exemplo /v1)
`route_id`	string
`security_policy`	objeto	Configuração de segurança HTTP opcional que substitui a configuração padrão no nível da rota
`strip_prefix`	booleano
`target_kind`	string	Valores permitidos: workload, workflow, url, object_storage.
`target_url`	string	URL absoluta usada quando target_kind=url
`team_id`	string
`traffic_policy`	objeto	Política opcional de tráfego regional no nível da rota para selecionar o destino do gateway
`trigger_name`	string
`updated_at`	inteiro	(Timestamp Unix)
`workflow_id`	string
`workload_id`	string

Exemplo ilustrativo; não é uma resposta real:

{
  "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"
}

Atualizar rota de gateway

PUT /v1/gateway_route/{id}

Atualiza um objeto GatewayRoute existente

Defina gateway_route_id usando IDs das suas próprias respostas da API.

Esta requisição altera dados ou inicia uma ação. Confira o destino e o corpo antes de enviá-la.

Campos da requisição (o corpo contém um exemplo editável):

Campo	Tipo	Obrigatório	Descrição
`auth_policy`	objeto	não	Política de autenticação de usuários no gateway. Aplica-se ao acesso ao aplicativo, não à autenticação da API ou administração.
`enabled`	booleano	sim	Padrão: `true`.
`exposure`	string	sim	Valores permitidos: public, auth, private. Padrão: `"public"`.
`geo_policy`	objeto	não	Política opcional de permissão ou bloqueio por país
`hostname`	string	sim
`object_bucket_id`	string	não
`path_prefix`	string	sim	Padrão: `"/"`.
`priority`	inteiro	sim	Padrão: `0`.
`rewrite_to`	string	não	Caminho de reescrita opcional aplicado antes do proxy (por exemplo /v1)
`security_policy`	objeto	não	Configuração de segurança HTTP opcional que substitui a configuração padrão no nível da rota
`strip_prefix`	booleano	sim	Padrão: `false`.
`target_kind`	string	sim	Valores permitidos: workload, workflow, url, object_storage. Padrão: `"workload"`.
`target_url`	string	não	URL absoluta usada quando target_kind=url
`team_id`	string	sim
`traffic_policy`	objeto	não	Política opcional de tráfego regional no nível da rota para selecionar o destino do gateway
`trigger_name`	string	não
`workflow_id`	string	não
`workload_id`	string	não

Autenticação: token bearer e o cabeçalho de equipe mostrado abaixo.

Parâmetros

Nome	Localização	Obrigatório	Descrição
`id`	caminho	sim	Identificador de recurso dos resultados da API da sua equipe.
`X-Tenant-ID`	cabeçalho	sim	ID da equipe ativa. Deve corresponder ao tenant vinculado a um token de diagnóstico.

Exemplo de requisição

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

Substitua YOUR_* no corpo antes de enviar. O heredoc com delimitador entre aspas mantém o JSON literal.

Resposta: HTTP 200

GatewayRoute atualizado

Campos de resposta

Campo	Tipo	Descrição
`auth_policy`	objeto	Política de autenticação de usuários no gateway. Aplica-se ao acesso ao aplicativo, não à autenticação da API ou administração.
`created_at`	inteiro	(Timestamp Unix)
`deleted_at`	inteiro	(Timestamp Unix)
`enabled`	booleano
`exposure`	string	Valores permitidos: public, auth, private.
`geo_policy`	objeto	Política opcional de permissão ou bloqueio por país
`hostname`	string
`object_bucket_id`	string
`path_prefix`	string
`priority`	inteiro
`rewrite_to`	string	Caminho de reescrita opcional aplicado antes do proxy (por exemplo /v1)
`route_id`	string
`security_policy`	objeto	Configuração de segurança HTTP opcional que substitui a configuração padrão no nível da rota
`strip_prefix`	booleano
`target_kind`	string	Valores permitidos: workload, workflow, url, object_storage.
`target_url`	string	URL absoluta usada quando target_kind=url
`team_id`	string
`traffic_policy`	objeto	Política opcional de tráfego regional no nível da rota para selecionar o destino do gateway
`trigger_name`	string
`updated_at`	inteiro	(Timestamp Unix)
`workflow_id`	string
`workload_id`	string

Exemplo ilustrativo; não é uma resposta real:

{
  "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"
}

Excluir rota de gateway

DELETE /v1/gateway_route/{id}

Exclui um objeto GatewayRoute

Defina gateway_route_id usando IDs das suas próprias respostas da API.

Esta requisição altera dados ou inicia uma ação. Confira o destino e o corpo antes de enviá-la.

Autenticação: token bearer e o cabeçalho de equipe mostrado abaixo.

Parâmetros

Nome	Localização	Obrigatório	Descrição
`id`	caminho	sim	Identificador de recurso dos resultados da API da sua equipe.
`X-Tenant-ID`	cabeçalho	sim	ID da equipe ativa. Deve corresponder ao tenant vinculado a um token de diagnóstico.

Exemplo de requisição

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"

Resposta: HTTP 200

O recurso foi apagado.

Campos de resposta

Campo	Tipo	Descrição
`message`	string

Exemplo ilustrativo; não é uma resposta real:

{
  "message": "Deleted successfully"
}