API de domínios

Adicione um nome de host que você possui, configure o CNAME de verificação retornado pela API e envie a requisição Verificar domínio.

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/domain	Listar domínios
POST	/v1/domain	Criar domínio
GET	/v1/domain/{id}	Obter domínio
PUT	/v1/domain/{id}	Atualizar domínio
DELETE	/v1/domain/{id}	Apagar o domínio
POST	/v1/domain/{id}/verify	Verificar domínio

Listar domínios

GET /v1/domain

Retorna uma lista paginada de Domain

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

Resposta: HTTP 200

Lista de Domain

Campos de resposta

Campo	Tipo	Descrição
data	array
data[].created_at	inteiro	(Timestamp Unix)
data[].deleted_at	inteiro	(Timestamp Unix)
data[].domain_id	string
data[].hostname	string	Nome de host personalizado pertencente ao usuário; os espaços de nomes adios.dev e adios.run são reservados para rotas gerenciadas pela plataforma
data[].redirect_to	string	URL ou nome de host opcional para redirecionamento (por exemplo, https://www.adios.dev)
data[].scope	string	Escopo autorizado de nomes de host: exact permite apenas o nome de host; subtree permite também nomes de host descendentes. Novos domínios registráveis usam subtree por padrão, novos subdomínios usam exact e os registros existentes permanecem subtree para compatibilidade com versões anteriores. Valores permitidos: exact, subtree.
data[].status	string	Status de verificação do domínio. Valores permitidos: pending, verified.
data[].team_id	string
data[].updated_at	inteiro	(Timestamp Unix)
data[].verification_hostname	string	Nome DNS que deve ser configurado como CNAME para verificar a propriedade
data[].verification_parent_id	string	Registro verificado do domínio pai do qual este nome de host herdou a verificação; vazio para verificação DNS direta
data[].verification_value	string	Valor CNAME esperado para verificar a propriedade
data[].verified_at	inteiro	(Timestamp Unix)
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": [
    {
      "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
  }
}

Criar domínio

POST /v1/domain

Cria um novo objeto Domain

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
hostname	string	sim	Nome de host personalizado pertencente ao usuário; os espaços de nomes adios.dev e adios.run são reservados para rotas gerenciadas pela plataforma
redirect_to	string	não	URL ou nome de host opcional para redirecionamento (por exemplo, https://www.adios.dev)
scope	string	não	Escopo autorizado de nomes de host: exact permite apenas o nome de host; subtree permite também nomes de host descendentes. Novos domínios registráveis usam subtree por padrão, novos subdomínios usam exact e os registros existentes permanecem subtree para compatibilidade com versões anteriores. Valores permitidos: exact, subtree.
status	string	não	Status de verificação do domínio. Valores permitidos: pending, verified. Padrão: "pending".
team_id	string	sim
verification_hostname	string	não	Nome DNS que deve ser configurado como CNAME para verificar a propriedade
verification_parent_id	string	não	Registro verificado do domínio pai do qual este nome de host herdou a verificação; vazio para verificação DNS direta
verification_value	string	não	Valor CNAME esperado para verificar a propriedade
verified_at	inteiro	não	(Timestamp Unix) Padrão: 0.
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

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

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

Resposta: HTTP 201

Domain criado

Campos de resposta

Campo	Tipo	Descrição
created_at	inteiro	(Timestamp Unix)
deleted_at	inteiro	(Timestamp Unix)
domain_id	string
hostname	string	Nome de host personalizado pertencente ao usuário; os espaços de nomes adios.dev e adios.run são reservados para rotas gerenciadas pela plataforma
redirect_to	string	URL ou nome de host opcional para redirecionamento (por exemplo, https://www.adios.dev)
scope	string	Escopo autorizado de nomes de host: exact permite apenas o nome de host; subtree permite também nomes de host descendentes. Novos domínios registráveis usam subtree por padrão, novos subdomínios usam exact e os registros existentes permanecem subtree para compatibilidade com versões anteriores. Valores permitidos: exact, subtree.
status	string	Status de verificação do domínio. Valores permitidos: pending, verified.
team_id	string
updated_at	inteiro	(Timestamp Unix)
verification_hostname	string	Nome DNS que deve ser configurado como CNAME para verificar a propriedade
verification_parent_id	string	Registro verificado do domínio pai do qual este nome de host herdou a verificação; vazio para verificação DNS direta
verification_value	string	Valor CNAME esperado para verificar a propriedade
verified_at	inteiro	(Timestamp Unix)
workload_id	string

Exemplo ilustrativo; não é uma resposta 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"
}

Obter domínio

GET /v1/domain/{id}

Retorna um objeto Domain

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

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

Resposta: HTTP 200

Domain

Campos de resposta

Campo	Tipo	Descrição
created_at	inteiro	(Timestamp Unix)
deleted_at	inteiro	(Timestamp Unix)
domain_id	string
hostname	string	Nome de host personalizado pertencente ao usuário; os espaços de nomes adios.dev e adios.run são reservados para rotas gerenciadas pela plataforma
redirect_to	string	URL ou nome de host opcional para redirecionamento (por exemplo, https://www.adios.dev)
scope	string	Escopo autorizado de nomes de host: exact permite apenas o nome de host; subtree permite também nomes de host descendentes. Novos domínios registráveis usam subtree por padrão, novos subdomínios usam exact e os registros existentes permanecem subtree para compatibilidade com versões anteriores. Valores permitidos: exact, subtree.
status	string	Status de verificação do domínio. Valores permitidos: pending, verified.
team_id	string
updated_at	inteiro	(Timestamp Unix)
verification_hostname	string	Nome DNS que deve ser configurado como CNAME para verificar a propriedade
verification_parent_id	string	Registro verificado do domínio pai do qual este nome de host herdou a verificação; vazio para verificação DNS direta
verification_value	string	Valor CNAME esperado para verificar a propriedade
verified_at	inteiro	(Timestamp Unix)
workload_id	string

Exemplo ilustrativo; não é uma resposta 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"
}

Atualizar domínio

PUT /v1/domain/{id}

Atualiza um objeto Domain existente

Defina domain_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
hostname	string	sim	Nome de host personalizado pertencente ao usuário; os espaços de nomes adios.dev e adios.run são reservados para rotas gerenciadas pela plataforma
redirect_to	string	não	URL ou nome de host opcional para redirecionamento (por exemplo, https://www.adios.dev)
scope	string	não	Escopo autorizado de nomes de host: exact permite apenas o nome de host; subtree permite também nomes de host descendentes. Novos domínios registráveis usam subtree por padrão, novos subdomínios usam exact e os registros existentes permanecem subtree para compatibilidade com versões anteriores. Valores permitidos: exact, subtree.
status	string	não	Status de verificação do domínio. Valores permitidos: pending, verified. Padrão: "pending".
team_id	string	sim
verification_hostname	string	não	Nome DNS que deve ser configurado como CNAME para verificar a propriedade
verification_parent_id	string	não	Registro verificado do domínio pai do qual este nome de host herdou a verificação; vazio para verificação DNS direta
verification_value	string	não	Valor CNAME esperado para verificar a propriedade
verified_at	inteiro	não	(Timestamp Unix) Padrão: 0.
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

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

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

Resposta: HTTP 200

Domain atualizado

Campos de resposta

Campo	Tipo	Descrição
created_at	inteiro	(Timestamp Unix)
deleted_at	inteiro	(Timestamp Unix)
domain_id	string
hostname	string	Nome de host personalizado pertencente ao usuário; os espaços de nomes adios.dev e adios.run são reservados para rotas gerenciadas pela plataforma
redirect_to	string	URL ou nome de host opcional para redirecionamento (por exemplo, https://www.adios.dev)
scope	string	Escopo autorizado de nomes de host: exact permite apenas o nome de host; subtree permite também nomes de host descendentes. Novos domínios registráveis usam subtree por padrão, novos subdomínios usam exact e os registros existentes permanecem subtree para compatibilidade com versões anteriores. Valores permitidos: exact, subtree.
status	string	Status de verificação do domínio. Valores permitidos: pending, verified.
team_id	string
updated_at	inteiro	(Timestamp Unix)
verification_hostname	string	Nome DNS que deve ser configurado como CNAME para verificar a propriedade
verification_parent_id	string	Registro verificado do domínio pai do qual este nome de host herdou a verificação; vazio para verificação DNS direta
verification_value	string	Valor CNAME esperado para verificar a propriedade
verified_at	inteiro	(Timestamp Unix)
workload_id	string

Exemplo ilustrativo; não é uma resposta 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"
}

Apagar o domínio

DELETE /v1/domain/{id}

Exclui um objeto Domain

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

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 DELETE "$ADIOS_API_URL/v1/domain/${ADIOS_DOMAIN_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"
}

Verificar domínio

POST /v1/domain/{id}/verify

Verifique o CNAME de propriedade fornecido na criação do domínio. Configure o DNS antes de enviar esta requisição.

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

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 POST "$ADIOS_API_URL/v1/domain/${ADIOS_DOMAIN_ID}/verify" \
  -H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
  -H "X-Tenant-ID: $ADIOS_TEAM_ID"

Resposta: HTTP 200

Resposta bem sucedida. Inspecione o estado retornado para operações que iniciam trabalho assíncrono.

Um esquema completo de corpo-resposta não é publicado para esta operação personalizada. Inspecione o conteúdo e o status retornados; nenhuma carga útil é assumida aqui.