API de rutas de la puerta de enlace

Dirige un nombre de host verificado a una carga de trabajo, un flujo de trabajo, una URL o un bucket de objetos. Configura el identificador que corresponda a target_kind.

Usa Autenticación de la API para las solicitudes protegidas. Los ejemplos usan tus propios IDs de recursos y un token temporal; las respuestas de ejemplo guardadas son sintéticas.

Método	Ruta	Operación
GET	/v1/gateway_route	Listar rutas del gateway
POST	/v1/gateway_route	Crear ruta de entrada
GET	/v1/gateway_route/{id}	Obtener la ruta de entrada
PUT	/v1/gateway_route/{id}	Actualizar ruta del gateway
DELETE	/v1/gateway_route/{id}	Borrar la ruta de entrada

Listar rutas del gateway

GET /v1/gateway_route

Devuelve una lista paginada de GatewayRoute

Autenticación: token bearer y la cabecera de equipo que se muestra a continuación.

Parámetros

Nombre	Ubicación	Obligatorio	Descripción
X-Tenant-ID	cabecera	sí	ID del equipo activo. Debe coincidir con el tenant vinculado al token de diagnóstico.
page	consulta	no	Número de página
per_page	consulta	no	Elementos por página

Ejemplo de solicitud

Configura ADIOS_API_URL=https://api.adios.dev. Para las solicitudes protegidas, configura ADIOS_ACCESS_TOKEN y ADIOS_TEAM_ID como en el inicio rápido. Configura las variables adicionales ADIOS_* a partir de los resultados de tus propios 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"

Respuesta: HTTP 200

Lista de GatewayRoute

Campos de respuesta

Campo	Tipo	Descripción
data	array
data[].auth_policy	object	Política de autenticación de usuarios del gateway. Es la autenticación de la aplicación, no la de la API ni la administración.
data[].created_at	integer	(marca de tiempo Unix)
data[].deleted_at	integer	(marca de tiempo Unix)
data[].enabled	boolean
data[].exposure	string	Valores permitidos: public, auth, private.
data[].geo_policy	object	Política opcional de países permitidos o bloqueados
data[].hostname	string
data[].object_bucket_id	string
data[].path_prefix	string
data[].priority	integer
data[].rewrite_to	string	Ruta de reescritura opcional aplicada antes de pasar por el proxy (por ejemplo, /v1)
data[].route_id	string
data[].security_policy	object	Ajuste opcional de seguridad HTTP específico de la ruta
data[].strip_prefix	boolean
data[].target_kind	string	Valores permitidos: workload, workflow, url, object_storage.
data[].target_url	string	URL absoluta utilizada cuando target_kind=url
data[].team_id	string
data[].traffic_policy	object	Política opcional de tráfico regional específica de la ruta para seleccionar el destino del gateway
data[].trigger_name	string
data[].updated_at	integer	(marca de tiempo Unix)
data[].workflow_id	string
data[].workload_id	string
pagination	object
pagination.page	integer	Número de página actual
pagination.per_page	integer	Número de elementos por página
pagination.total	integer	Número total de elementos

Ejemplo ilustrativo; no es una respuesta 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
  }
}

Crear ruta de entrada

POST /v1/gateway_route

Crea un nuevo GatewayRoute

Esta solicitud modifica datos o inicia una acción. Revisa el destino y el cuerpo antes de enviarla.

Campos de la solicitud (el cuerpo contiene un ejemplo editable):

Campo	Tipo	Obligatorio	Descripción
auth_policy	object	no	Política de autenticación de usuarios del gateway. Es la autenticación de la aplicación, no la de la API ni la administración.
enabled	boolean	sí	Valor predeterminado: true.
exposure	string	sí	Valores permitidos: public, auth, private. Valor predeterminado: "public".
geo_policy	object	no	Política opcional de países permitidos o bloqueados
hostname	string	sí
object_bucket_id	string	no
path_prefix	string	sí	Valor predeterminado: "/".
priority	integer	sí	Valor predeterminado: 0.
rewrite_to	string	no	Ruta de reescritura opcional aplicada antes de pasar por el proxy (por ejemplo, /v1)
security_policy	object	no	Ajuste opcional de seguridad HTTP específico de la ruta
strip_prefix	boolean	sí	Valor predeterminado: false.
target_kind	string	sí	Valores permitidos: workload, workflow, url, object_storage. Valor predeterminado: "workload".
target_url	string	no	URL absoluta utilizada cuando target_kind=url
team_id	string	sí
traffic_policy	object	no	Política opcional de tráfico regional específica de la ruta para seleccionar el destino del gateway
trigger_name	string	no
workflow_id	string	no
workload_id	string	no

Autenticación: token bearer y la cabecera de equipo que se muestra a continuación.

Parámetros

Nombre	Ubicación	Obligatorio	Descripción
X-Tenant-ID	cabecera	sí	ID del equipo activo. Debe coincidir con el tenant vinculado al token de diagnóstico.

Ejemplo de solicitud

Configura ADIOS_API_URL=https://api.adios.dev. Para las solicitudes protegidas, configura ADIOS_ACCESS_TOKEN y ADIOS_TEAM_ID como en el inicio rápido. Configura las variables adicionales ADIOS_* a partir de los resultados de tus propios recursos.

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

Reemplaza los marcadores YOUR_* del cuerpo antes de enviar la solicitud. El heredoc entrecomillado conserva el JSON literal.

Respuesta: HTTP 201

GatewayRoute creado

Campos de respuesta

Campo	Tipo	Descripción
auth_policy	object	Política de autenticación de usuarios del gateway. Es la autenticación de la aplicación, no la de la API ni la administración.
created_at	integer	(marca de tiempo Unix)
deleted_at	integer	(marca de tiempo Unix)
enabled	boolean
exposure	string	Valores permitidos: public, auth, private.
geo_policy	object	Política opcional de países permitidos o bloqueados
hostname	string
object_bucket_id	string
path_prefix	string
priority	integer
rewrite_to	string	Ruta de reescritura opcional aplicada antes de pasar por el proxy (por ejemplo, /v1)
route_id	string
security_policy	object	Ajuste opcional de seguridad HTTP específico de la ruta
strip_prefix	boolean
target_kind	string	Valores permitidos: workload, workflow, url, object_storage.
target_url	string	URL absoluta utilizada cuando target_kind=url
team_id	string
traffic_policy	object	Política opcional de tráfico regional específica de la ruta para seleccionar el destino del gateway
trigger_name	string
updated_at	integer	(marca de tiempo Unix)
workflow_id	string
workload_id	string

Ejemplo ilustrativo; no es una respuesta 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"
}

Obtener la ruta de entrada

GET /v1/gateway_route/{id}

Devuelve un único GatewayRoute

Configura gateway_route_id usando IDs de tus propias respuestas de la API.

Autenticación: token bearer y la cabecera de equipo que se muestra a continuación.

Parámetros

Nombre	Ubicación	Obligatorio	Descripción
id	ruta	sí	Identificador del recurso obtenido de los resultados de la API de tu equipo.
X-Tenant-ID	cabecera	sí	ID del equipo activo. Debe coincidir con el tenant vinculado al token de diagnóstico.

Ejemplo de solicitud

Configura ADIOS_API_URL=https://api.adios.dev. Para las solicitudes protegidas, configura ADIOS_ACCESS_TOKEN y ADIOS_TEAM_ID como en el inicio rápido. Configura las variables adicionales ADIOS_* a partir de los resultados de tus propios recursos.

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"

Respuesta: HTTP 200

GatewayRoute

Campos de respuesta

Campo	Tipo	Descripción
auth_policy	object	Política de autenticación de usuarios del gateway. Es la autenticación de la aplicación, no la de la API ni la administración.
created_at	integer	(marca de tiempo Unix)
deleted_at	integer	(marca de tiempo Unix)
enabled	boolean
exposure	string	Valores permitidos: public, auth, private.
geo_policy	object	Política opcional de países permitidos o bloqueados
hostname	string
object_bucket_id	string
path_prefix	string
priority	integer
rewrite_to	string	Ruta de reescritura opcional aplicada antes de pasar por el proxy (por ejemplo, /v1)
route_id	string
security_policy	object	Ajuste opcional de seguridad HTTP específico de la ruta
strip_prefix	boolean
target_kind	string	Valores permitidos: workload, workflow, url, object_storage.
target_url	string	URL absoluta utilizada cuando target_kind=url
team_id	string
traffic_policy	object	Política opcional de tráfico regional específica de la ruta para seleccionar el destino del gateway
trigger_name	string
updated_at	integer	(marca de tiempo Unix)
workflow_id	string
workload_id	string

Ejemplo ilustrativo; no es una respuesta 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"
}

Actualizar ruta del gateway

PUT /v1/gateway_route/{id}

Actualiza un GatewayRoute existente

Configura gateway_route_id usando IDs de tus propias respuestas de la API.

Esta solicitud modifica datos o inicia una acción. Revisa el destino y el cuerpo antes de enviarla.

Campos de la solicitud (el cuerpo contiene un ejemplo editable):

Campo	Tipo	Obligatorio	Descripción
auth_policy	object	no	Política de autenticación de usuarios del gateway. Es la autenticación de la aplicación, no la de la API ni la administración.
enabled	boolean	sí	Valor predeterminado: true.
exposure	string	sí	Valores permitidos: public, auth, private. Valor predeterminado: "public".
geo_policy	object	no	Política opcional de países permitidos o bloqueados
hostname	string	sí
object_bucket_id	string	no
path_prefix	string	sí	Valor predeterminado: "/".
priority	integer	sí	Valor predeterminado: 0.
rewrite_to	string	no	Ruta de reescritura opcional aplicada antes de pasar por el proxy (por ejemplo, /v1)
security_policy	object	no	Ajuste opcional de seguridad HTTP específico de la ruta
strip_prefix	boolean	sí	Valor predeterminado: false.
target_kind	string	sí	Valores permitidos: workload, workflow, url, object_storage. Valor predeterminado: "workload".
target_url	string	no	URL absoluta utilizada cuando target_kind=url
team_id	string	sí
traffic_policy	object	no	Política opcional de tráfico regional específica de la ruta para seleccionar el destino del gateway
trigger_name	string	no
workflow_id	string	no
workload_id	string	no

Autenticación: token bearer y la cabecera de equipo que se muestra a continuación.

Parámetros

Nombre	Ubicación	Obligatorio	Descripción
id	ruta	sí	Identificador del recurso obtenido de los resultados de la API de tu equipo.
X-Tenant-ID	cabecera	sí	ID del equipo activo. Debe coincidir con el tenant vinculado al token de diagnóstico.

Ejemplo de solicitud

Configura ADIOS_API_URL=https://api.adios.dev. Para las solicitudes protegidas, configura ADIOS_ACCESS_TOKEN y ADIOS_TEAM_ID como en el inicio rápido. Configura las variables adicionales ADIOS_* a partir de los resultados de tus propios recursos.

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

Reemplaza los marcadores YOUR_* del cuerpo antes de enviar la solicitud. El heredoc entrecomillado conserva el JSON literal.

Respuesta: HTTP 200

GatewayRoute actualizado

Campos de respuesta

Campo	Tipo	Descripción
auth_policy	object	Política de autenticación de usuarios del gateway. Es la autenticación de la aplicación, no la de la API ni la administración.
created_at	integer	(marca de tiempo Unix)
deleted_at	integer	(marca de tiempo Unix)
enabled	boolean
exposure	string	Valores permitidos: public, auth, private.
geo_policy	object	Política opcional de países permitidos o bloqueados
hostname	string
object_bucket_id	string
path_prefix	string
priority	integer
rewrite_to	string	Ruta de reescritura opcional aplicada antes de pasar por el proxy (por ejemplo, /v1)
route_id	string
security_policy	object	Ajuste opcional de seguridad HTTP específico de la ruta
strip_prefix	boolean
target_kind	string	Valores permitidos: workload, workflow, url, object_storage.
target_url	string	URL absoluta utilizada cuando target_kind=url
team_id	string
traffic_policy	object	Política opcional de tráfico regional específica de la ruta para seleccionar el destino del gateway
trigger_name	string
updated_at	integer	(marca de tiempo Unix)
workflow_id	string
workload_id	string

Ejemplo ilustrativo; no es una respuesta 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"
}

Borrar la ruta de entrada

DELETE /v1/gateway_route/{id}

Elimina un GatewayRoute

Configura gateway_route_id usando IDs de tus propias respuestas de la API.

Esta solicitud modifica datos o inicia una acción. Revisa el destino y el cuerpo antes de enviarla.

Autenticación: token bearer y la cabecera de equipo que se muestra a continuación.

Parámetros

Nombre	Ubicación	Obligatorio	Descripción
id	ruta	sí	Identificador del recurso obtenido de los resultados de la API de tu equipo.
X-Tenant-ID	cabecera	sí	ID del equipo activo. Debe coincidir con el tenant vinculado al token de diagnóstico.

Ejemplo de solicitud

Configura ADIOS_API_URL=https://api.adios.dev. Para las solicitudes protegidas, configura ADIOS_ACCESS_TOKEN y ADIOS_TEAM_ID como en el inicio rápido. Configura las variables adicionales ADIOS_* a partir de los resultados de tus propios recursos.

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"

Respuesta: HTTP 200

Recurso eliminado.

Campos de respuesta

Campo	Tipo	Descripción
message	string

Ejemplo ilustrativo; no es una respuesta real:

{
  "message": "Deleted successfully"
}