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étodo | Ruta | Operación |
|---|---|---|
GET | /v1/domain | Listar dominios |
POST | /v1/domain | Crear dominio |
GET | /v1/domain/{id} | Obtener dominio |
PUT | /v1/domain/{id} | Actualizar dominio |
DELETE | /v1/domain/{id} | Eliminar el dominio |
POST | /v1/domain/{id}/verify | Verificar 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
| 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/domain" \
-H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
-H "X-Tenant-ID: $ADIOS_TEAM_ID"
Respuesta: HTTP 200
Lista de Domain
Campos de respuesta
| Campo | Tipo | Descripción |
|---|---|---|
data | array | |
data[].created_at | integer | (marca de tiempo Unix) |
data[].deleted_at | integer | (marca de tiempo Unix) |
data[].domain_id | string | |
data[].hostname | string | 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 |
data[].redirect_to | string | URL o nombre de host opcional al que redirigir (por ejemplo, https://www.adios.dev) |
data[].scope | string | Alcance 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[].status | string | Estado de verificación del dominio. Valores permitidos: pending, verified. |
data[].team_id | string | |
data[].updated_at | integer | (marca de tiempo Unix) |
data[].verification_hostname | string | Nombre DNS que debe configurarse como CNAME para verificar la propiedad |
data[].verification_parent_id | string | Registro verificado del dominio padre del que este nombre de host heredó la verificación; vacío para la verificación DNS directa |
data[].verification_value | string | Valor CNAME esperado para verificar la propiedad |
data[].verified_at | integer | (marca de tiempo Unix) |
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": [
{
"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):
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
hostname | string | sí | 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_to | string | no | URL o nombre de host opcional al que redirigir (por ejemplo, https://www.adios.dev) |
scope | string | no | Alcance 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. |
status | string | no | Estado de verificación del dominio. Valores permitidos: pending, verified. Valor predeterminado: "pending". |
team_id | string | sí | |
verification_hostname | string | no | Nombre DNS que debe configurarse como CNAME para verificar la propiedad |
verification_parent_id | string | no | Registro verificado del dominio padre del que este nombre de host heredó la verificación; vacío para la verificación DNS directa |
verification_value | string | no | Valor CNAME esperado para verificar la propiedad |
verified_at | integer | no | (marca de tiempo Unix) Valor predeterminado: 0. |
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/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
| Campo | Tipo | Descripción |
|---|---|---|
created_at | integer | (marca de tiempo Unix) |
deleted_at | integer | (marca de tiempo Unix) |
domain_id | string | |
hostname | string | 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_to | string | URL o nombre de host opcional al que redirigir (por ejemplo, https://www.adios.dev) |
scope | string | Alcance 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. |
status | string | Estado de verificación del dominio. Valores permitidos: pending, verified. |
team_id | string | |
updated_at | integer | (marca de tiempo Unix) |
verification_hostname | string | Nombre DNS que debe configurarse como CNAME para verificar la propiedad |
verification_parent_id | string | Registro verificado del dominio padre del que este nombre de host heredó la verificación; vacío para la verificación DNS directa |
verification_value | string | Valor CNAME esperado para verificar la propiedad |
verified_at | integer | (marca de tiempo Unix) |
workload_id | string |
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
| 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/domain/${ADIOS_DOMAIN_ID}" \
-H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
-H "X-Tenant-ID: $ADIOS_TEAM_ID"
Respuesta: HTTP 200
Dominio
Campos de respuesta
| Campo | Tipo | Descripción |
|---|---|---|
created_at | integer | (marca de tiempo Unix) |
deleted_at | integer | (marca de tiempo Unix) |
domain_id | string | |
hostname | string | 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_to | string | URL o nombre de host opcional al que redirigir (por ejemplo, https://www.adios.dev) |
scope | string | Alcance 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. |
status | string | Estado de verificación del dominio. Valores permitidos: pending, verified. |
team_id | string | |
updated_at | integer | (marca de tiempo Unix) |
verification_hostname | string | Nombre DNS que debe configurarse como CNAME para verificar la propiedad |
verification_parent_id | string | Registro verificado del dominio padre del que este nombre de host heredó la verificación; vacío para la verificación DNS directa |
verification_value | string | Valor CNAME esperado para verificar la propiedad |
verified_at | integer | (marca de tiempo Unix) |
workload_id | string |
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):
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
hostname | string | sí | 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_to | string | no | URL o nombre de host opcional al que redirigir (por ejemplo, https://www.adios.dev) |
scope | string | no | Alcance 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. |
status | string | no | Estado de verificación del dominio. Valores permitidos: pending, verified. Valor predeterminado: "pending". |
team_id | string | sí | |
verification_hostname | string | no | Nombre DNS que debe configurarse como CNAME para verificar la propiedad |
verification_parent_id | string | no | Registro verificado del dominio padre del que este nombre de host heredó la verificación; vacío para la verificación DNS directa |
verification_value | string | no | Valor CNAME esperado para verificar la propiedad |
verified_at | integer | no | (marca de tiempo Unix) Valor predeterminado: 0. |
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/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
| Campo | Tipo | Descripción |
|---|---|---|
created_at | integer | (marca de tiempo Unix) |
deleted_at | integer | (marca de tiempo Unix) |
domain_id | string | |
hostname | string | 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_to | string | URL o nombre de host opcional al que redirigir (por ejemplo, https://www.adios.dev) |
scope | string | Alcance 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. |
status | string | Estado de verificación del dominio. Valores permitidos: pending, verified. |
team_id | string | |
updated_at | integer | (marca de tiempo Unix) |
verification_hostname | string | Nombre DNS que debe configurarse como CNAME para verificar la propiedad |
verification_parent_id | string | Registro verificado del dominio padre del que este nombre de host heredó la verificación; vacío para la verificación DNS directa |
verification_value | string | Valor CNAME esperado para verificar la propiedad |
verified_at | integer | (marca de tiempo Unix) |
workload_id | string |
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
| 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/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
| Campo | Tipo | Descripción |
|---|---|---|
message | string |
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
| 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 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.