Ir al contenido
AdiosDocumentación
Explorar la documentación

API de dominios

Añade un nombre de host que te pertenezca, configura el CNAME de verificación devuelto por la API y envía la solicitud Verificar dominio.

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étodoRutaOperación
GET/v1/domainListar dominios
POST/v1/domainCrear dominio
GET/v1/domain/{id}Obtener dominio
PUT/v1/domain/{id}Actualizar dominio
DELETE/v1/domain/{id}Eliminar el dominio
POST/v1/domain/{id}/verifyVerificar dominio

Listar dominios

GET /v1/domain

Devuelve una lista paginada de Domain

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

Parámetros

NombreUbicaciónObligatorioDescripción
X-Tenant-IDcabecerasíID del equipo activo. Debe coincidir con el tenant vinculado al token de diagnóstico.
pageconsultanoNúmero de página
per_pageconsultanoElementos 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/domain" \
  -H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
  -H "X-Tenant-ID: $ADIOS_TEAM_ID"

Respuesta: HTTP 200

Lista de Domain

Campos de respuesta

CampoTipoDescripción
dataarray
data[].created_atinteger(marca de tiempo Unix)
data[].deleted_atinteger(marca de tiempo Unix)
data[].domain_idstring
data[].hostnamestringNombre de host personalizado propiedad del usuario; los espacios de nombres adios.dev y adios.run están reservados para rutas gestionadas por la plataforma
data[].redirect_tostringURL o nombre de host opcional al que redirigir (por ejemplo, https://www.adios.dev)
data[].scopestringAlcance autorizado del nombre de host: exact permite solo ese nombre; subtree también permite los nombres descendientes. Los nuevos dominios registrables usan subtree de forma predeterminada y los nuevos subdominios, exact. Los registros existentes conservan subtree por compatibilidad con versiones anteriores. Valores permitidos: exact, subtree.
data[].statusstringEstado de verificación del dominio. Valores permitidos: pending, verified.
data[].team_idstring
data[].updated_atinteger(marca de tiempo Unix)
data[].verification_hostnamestringNombre DNS que debe configurarse como CNAME para verificar la propiedad
data[].verification_parent_idstringRegistro verificado del dominio padre del que este nombre de host heredó la verificación; vacío para la verificación DNS directa
data[].verification_valuestringValor CNAME esperado para verificar la propiedad
data[].verified_atinteger(marca de tiempo Unix)
data[].workload_idstring
paginationobject
pagination.pageintegerNúmero de página actual
pagination.per_pageintegerNúmero de elementos por página
pagination.totalintegerNúmero total de elementos

Ejemplo ilustrativo; no es una respuesta real:

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

Crear dominio

POST /v1/domain

Crea un nuevo Domain

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

CampoTipoObligatorioDescripción
hostnamestringsíNombre de host personalizado propiedad del usuario; los espacios de nombres adios.dev y adios.run están reservados para rutas gestionadas por la plataforma
redirect_tostringnoURL o nombre de host opcional al que redirigir (por ejemplo, https://www.adios.dev)
scopestringnoAlcance autorizado del nombre de host: exact permite solo ese nombre; subtree también permite los nombres descendientes. Los nuevos dominios registrables usan subtree de forma predeterminada y los nuevos subdominios, exact. Los registros existentes conservan subtree por compatibilidad con versiones anteriores. Valores permitidos: exact, subtree.
statusstringnoEstado de verificación del dominio. Valores permitidos: pending, verified. Valor predeterminado: "pending".
team_idstringsí
verification_hostnamestringnoNombre DNS que debe configurarse como CNAME para verificar la propiedad
verification_parent_idstringnoRegistro verificado del dominio padre del que este nombre de host heredó la verificación; vacío para la verificación DNS directa
verification_valuestringnoValor CNAME esperado para verificar la propiedad
verified_atintegerno(marca de tiempo Unix) Valor predeterminado: 0.
workload_idstringno

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

Parámetros

NombreUbicaciónObligatorioDescripción
X-Tenant-IDcabecerasí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/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

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

Respuesta: HTTP 201

Domain creado

Campos de respuesta

CampoTipoDescripción
created_atinteger(marca de tiempo Unix)
deleted_atinteger(marca de tiempo Unix)
domain_idstring
hostnamestringNombre de host personalizado propiedad del usuario; los espacios de nombres adios.dev y adios.run están reservados para rutas gestionadas por la plataforma
redirect_tostringURL o nombre de host opcional al que redirigir (por ejemplo, https://www.adios.dev)
scopestringAlcance autorizado del nombre de host: exact permite solo ese nombre; subtree también permite los nombres descendientes. Los nuevos dominios registrables usan subtree de forma predeterminada y los nuevos subdominios, exact. Los registros existentes conservan subtree por compatibilidad con versiones anteriores. Valores permitidos: exact, subtree.
statusstringEstado de verificación del dominio. Valores permitidos: pending, verified.
team_idstring
updated_atinteger(marca de tiempo Unix)
verification_hostnamestringNombre DNS que debe configurarse como CNAME para verificar la propiedad
verification_parent_idstringRegistro verificado del dominio padre del que este nombre de host heredó la verificación; vacío para la verificación DNS directa
verification_valuestringValor CNAME esperado para verificar la propiedad
verified_atinteger(marca de tiempo Unix)
workload_idstring

Ejemplo ilustrativo; no es una respuesta real:

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

Obtener dominio

GET /v1/domain/{id}

Devuelve un único Domain

Configura domain_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

NombreUbicaciónObligatorioDescripción
idrutasíIdentificador del recurso obtenido de los resultados de la API de tu equipo.
X-Tenant-IDcabecerasí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/domain/${ADIOS_DOMAIN_ID}" \
  -H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
  -H "X-Tenant-ID: $ADIOS_TEAM_ID"

Respuesta: HTTP 200

Dominio

Campos de respuesta

CampoTipoDescripción
created_atinteger(marca de tiempo Unix)
deleted_atinteger(marca de tiempo Unix)
domain_idstring
hostnamestringNombre de host personalizado propiedad del usuario; los espacios de nombres adios.dev y adios.run están reservados para rutas gestionadas por la plataforma
redirect_tostringURL o nombre de host opcional al que redirigir (por ejemplo, https://www.adios.dev)
scopestringAlcance autorizado del nombre de host: exact permite solo ese nombre; subtree también permite los nombres descendientes. Los nuevos dominios registrables usan subtree de forma predeterminada y los nuevos subdominios, exact. Los registros existentes conservan subtree por compatibilidad con versiones anteriores. Valores permitidos: exact, subtree.
statusstringEstado de verificación del dominio. Valores permitidos: pending, verified.
team_idstring
updated_atinteger(marca de tiempo Unix)
verification_hostnamestringNombre DNS que debe configurarse como CNAME para verificar la propiedad
verification_parent_idstringRegistro verificado del dominio padre del que este nombre de host heredó la verificación; vacío para la verificación DNS directa
verification_valuestringValor CNAME esperado para verificar la propiedad
verified_atinteger(marca de tiempo Unix)
workload_idstring

Ejemplo ilustrativo; no es una respuesta real:

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

Actualizar dominio

PUT /v1/domain/{id}

Actualiza un Domain existente

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

CampoTipoObligatorioDescripción
hostnamestringsíNombre de host personalizado propiedad del usuario; los espacios de nombres adios.dev y adios.run están reservados para rutas gestionadas por la plataforma
redirect_tostringnoURL o nombre de host opcional al que redirigir (por ejemplo, https://www.adios.dev)
scopestringnoAlcance autorizado del nombre de host: exact permite solo ese nombre; subtree también permite los nombres descendientes. Los nuevos dominios registrables usan subtree de forma predeterminada y los nuevos subdominios, exact. Los registros existentes conservan subtree por compatibilidad con versiones anteriores. Valores permitidos: exact, subtree.
statusstringnoEstado de verificación del dominio. Valores permitidos: pending, verified. Valor predeterminado: "pending".
team_idstringsí
verification_hostnamestringnoNombre DNS que debe configurarse como CNAME para verificar la propiedad
verification_parent_idstringnoRegistro verificado del dominio padre del que este nombre de host heredó la verificación; vacío para la verificación DNS directa
verification_valuestringnoValor CNAME esperado para verificar la propiedad
verified_atintegerno(marca de tiempo Unix) Valor predeterminado: 0.
workload_idstringno

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

Parámetros

NombreUbicaciónObligatorioDescripción
idrutasíIdentificador del recurso obtenido de los resultados de la API de tu equipo.
X-Tenant-IDcabecerasí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/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

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

Respuesta: HTTP 200

Domain actualizado

Campos de respuesta

CampoTipoDescripción
created_atinteger(marca de tiempo Unix)
deleted_atinteger(marca de tiempo Unix)
domain_idstring
hostnamestringNombre de host personalizado propiedad del usuario; los espacios de nombres adios.dev y adios.run están reservados para rutas gestionadas por la plataforma
redirect_tostringURL o nombre de host opcional al que redirigir (por ejemplo, https://www.adios.dev)
scopestringAlcance autorizado del nombre de host: exact permite solo ese nombre; subtree también permite los nombres descendientes. Los nuevos dominios registrables usan subtree de forma predeterminada y los nuevos subdominios, exact. Los registros existentes conservan subtree por compatibilidad con versiones anteriores. Valores permitidos: exact, subtree.
statusstringEstado de verificación del dominio. Valores permitidos: pending, verified.
team_idstring
updated_atinteger(marca de tiempo Unix)
verification_hostnamestringNombre DNS que debe configurarse como CNAME para verificar la propiedad
verification_parent_idstringRegistro verificado del dominio padre del que este nombre de host heredó la verificación; vacío para la verificación DNS directa
verification_valuestringValor CNAME esperado para verificar la propiedad
verified_atinteger(marca de tiempo Unix)
workload_idstring

Ejemplo ilustrativo; no es una respuesta real:

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

Eliminar el dominio

DELETE /v1/domain/{id}

Elimina un Domain

Configura domain_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

NombreUbicaciónObligatorioDescripción
idrutasíIdentificador del recurso obtenido de los resultados de la API de tu equipo.
X-Tenant-IDcabecerasí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/domain/${ADIOS_DOMAIN_ID}" \
  -H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
  -H "X-Tenant-ID: $ADIOS_TEAM_ID"

Respuesta: HTTP 200

Recurso eliminado.

Campos de respuesta

CampoTipoDescripción
messagestring

Ejemplo ilustrativo; no es una respuesta real:

{
  "message": "Deleted successfully"
}

Verificar dominio

POST /v1/domain/{id}/verify

Comprueba el CNAME de propiedad proporcionado al crear el dominio. Configura el DNS antes de enviar esta solicitud.

Configura domain_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

NombreUbicaciónObligatorioDescripción
idrutasíIdentificador del recurso obtenido de los resultados de la API de tu equipo.
X-Tenant-IDcabecerasí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/domain/${ADIOS_DOMAIN_ID}/verify" \
  -H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
  -H "X-Tenant-ID: $ADIOS_TEAM_ID"

Respuesta: HTTP 200

Respuesta correcta. Inspecciona el estado devuelto por las operaciones que inician trabajo asíncrono.

No se publica un esquema completo del cuerpo de respuesta para esta operación personalizada. Inspecciona el contenido y el estado devueltos; aquí no se presupone ningún payload.