GET /domains

Listar domínios autorizados e estados. Contrato v1 · disponível em produção e homologação · operação getDomains. Guia funcional · Índice · Schemas · Testar em sandbox.

Autenticação e efeito

Permissão: domains:read. Sessão humana ou chave de servidor limitada ao proprietário e aos aplicativos autorizados. OAuth/MCP ainda não estão disponíveis. Uma chave de exemplo deve incluir somente esta permissão e as leituras necessárias ao seu fluxo, restrita a app_loja; emita-a na área autenticada de desenvolvedores.

Disponível em produção e homologação; sujeito às capacidades do app e à configuração do provedor. OAuth só será aceito após B1b. Campos desconhecidos rejeitados. Consulte os ADRs para regras semânticas além do JSON Schema.

Consulta não altera o recurso. Downloads revalidam autorização e têm prazo/estado conforme o guia.

Parâmetros

Nome	Local	Obrigatório	Tipo e restrições
appId	query	sim	AppId; {“type”:“string”,“maxLength”:200,“minLength”:1,“pattern”:“^[A-Za-z0-9][A-Za-z0-9._~-]*$”}
limit	query	não	integer; {“type”:“integer”,“minimum”:1,“maximum”:100,“default”:50}
cursor	query	não	Cursor; {“type”:“string”,“maxLength”:2048,“pattern”:“^c1\.[A-Za-z0-9_-]+\.[A-Za-z0-9_-]+$”}
detached	query	não	false / true / all; {“enum”:[“false”,“true”,“all”],“default”:“false”}

Paginação por cursor assinado; preserve credencial, concessão, filtros, ordem e limite. Cursor expira em 15 minutos. A lista mutável não fornece snapshot. Use pagination.nextCursor até hasMore=false.

Corpo e semântica

Sem corpo. Envie os parâmetros na URL e os headers indicados.

Omitir campos opcionais usa o default documentado ou preserva o valor em PATCH. null só é aceito nos campos cujo schema permite null, com efeito de limpar/desvincular indicado no guia. Arrays enviados substituem a coleção quando o endpoint define atualização completa; não implicam merge. Identificadores/owner/app de um recurso existente não são transferidos por PATCH. Herança de templates/UTMs segue o guia, sem alterar links anteriores por cópia automática.

cURL

AGILINK_API_KEY deve ficar no servidor. Os placeholders abaixo são fictícios. Preserve Idempotency-Key e payload ao repetir uma intenção após timeout.

curl --request GET 'https://api.staging.agilink.io/v1/domains?appId=app_loja' \
  --header 'Authorization: Bearer <credencial>'

JavaScript / TypeScript

// Node.js 22+. Defina AGILINK_API_KEY no ambiente do servidor.
const response = await fetch('https://api.staging.agilink.io/v1/domains?appId=app_loja', {
  method: 'GET',
  headers: {
  "Authorization": `Bearer ${process.env.AGILINK_API_KEY}`
},
  redirect: 'error', signal: AbortSignal.timeout(30000)
});
if (!response.ok) throw new Error('HTTP '+response.status+' requestId='+response.headers.get('X-Request-Id'));
const result = await response.json();
console.log(result);

Python

# Python 3.10+; pip install requests
import os
import requests
headers = {
  "Authorization": "Bearer " + os.environ["AGILINK_API_KEY"]
}
response = requests.request(
    'GET', 'https://api.staging.agilink.io/v1/domains?appId=app_loja',
    headers=headers,
    timeout=30, allow_redirects=False)
if not 200 <= response.status_code < 300:
    raise RuntimeError(f'HTTP {response.status_code}; requestId={response.headers.get("X-Request-Id")}')
result = response.json()
print(result)

Response 200

Sucesso. Exemplo fictício.

Header	Significado	Exemplo
X-Request-Id	Identificador gerado pelo servidor, inclusive para falhas e replays.	conforme resposta
Cache-Control	Respostas administrativas não podem ser armazenadas.	no-store, no-transform

{
  "data": [
    {
      "id": "domain_loja",
      "appId": "app_loja",
      "hostname": "go.example.com",
      "mode": "external",
      "ownership": "unverified",
      "dns": "pending",
      "https": "pending",
      "links": "pending",
      "detached": false,
      "removalState": null,
      "canManageDns": false,
      "zoneName": "example.com",
      "nameservers": [],
      "challenge": null,
      "connectionRecords": [],
      "nativeConfig": {},
      "revision": "20000000-0000-4000-8000-000000000001",
      "createdAt": "2026-10-19T20:00:00Z",
      "updatedAt": "2026-10-19T20:00:00Z",
      "publication": {
        "status": "pending",
        "desiredRevision": "20000000-0000-4000-8000-000000000001",
        "confirmedRevision": null,
        "updatedAt": "2026-10-19T20:00:00Z"
      },
      "lastCheckedAt": null,
      "lastError": null
    }
  ],
  "pagination": {
    "hasMore": false,
    "nextCursor": null
  },
  "meta": {
    "requestId": "req_00000000000040008000000000000001"
  }
}

Campo	Tipo	Obrigatório	Significado e limites
data	array	sim	Resultado tipado da operação. Até 100 itens
data[].id	string	sim	Identificador estável do recurso. Até 500 caracteres
data[].appId	AppId	sim	Aplicativo proprietário; precisa estar autorizado.
data[].hostname	Domain	sim	Valor tipado; formato e restrições completos no schema abaixo.
data[].mode	platform / managed / external / legacy	sim	Valor tipado; formato e restrições completos no schema abaixo.
data[].ownership	string	sim	Valor tipado; formato e restrições completos no schema abaixo. Até 30 caracteres
data[].dns	string	sim	Valor tipado; formato e restrições completos no schema abaixo. Até 30 caracteres
data[].https	string	sim	Valor tipado; formato e restrições completos no schema abaixo. Até 30 caracteres
data[].links	string	sim	Valor tipado; formato e restrições completos no schema abaixo. Até 30 caracteres
data[].detached	boolean	sim	Valor tipado; formato e restrições completos no schema abaixo.
data[].removalState	string ou null	não	Valor tipado; formato e restrições completos no schema abaixo.
data[].canManageDns	boolean	sim	Valor tipado; formato e restrições completos no schema abaixo.
data[].zoneName	string	não	Valor tipado; formato e restrições completos no schema abaixo. Até 253 caracteres
data[].nameservers	array	não	Valor tipado; formato e restrições completos no schema abaixo. Até 100 itens
data[].challenge	object ou null	não	Valor tipado; formato e restrições completos no schema abaixo.
data[].connectionRecords	array	não	Valor tipado; formato e restrições completos no schema abaixo. Até 100 itens
data[].nativeConfig	object	não	Valor tipado; formato e restrições completos no schema abaixo.
data[].revision	Revision	sim	Revisão forte para If-Match; muda ao editar.
data[].createdAt	DateTime	sim	Instante de criação com fuso.
data[].updatedAt	DateTime	sim	Instante da última alteração.
data[].publication	Publication	sim	Confirmação eventual da projeção pública.
data[].publication.status	pending / synced / failed	sim	Estado atual; consulte as transições no guia do recurso.
data[].publication.desiredRevision	Revision	sim	Valor tipado; formato e restrições completos no schema abaixo.
data[].publication.confirmedRevision	Revision ou null	sim	Valor tipado; formato e restrições completos no schema abaixo.
data[].publication.updatedAt	DateTime	sim	Instante da última alteração.
data[].lastCheckedAt	number ou null	não	Valor tipado; formato e restrições completos no schema abaixo.
data[].lastError	string ou null	não	Valor tipado; formato e restrições completos no schema abaixo.
pagination	Pagination	sim	Continuação da lista; não é snapshot.
pagination.nextCursor	Cursor ou null	sim	Cursor assinado; conserve filtros, credencial e limite.
pagination.hasMore	boolean	sim	Indica se há continuação.
meta	Meta	sim	Correlação e informações da resposta.
meta.requestId	RequestId	sim	Identificador de correlação gerado pelo servidor.

Falhas, revisão e repetição

Respeite Retry-After quando existir. Leituras podem ser repetidas após falhas transitórias. Não faça retry automático ilimitado.

Status	Significado
400	Cabeçalho, query, cursor ou JSON inválido.
401	Credencial inválida, expirada ou revogada.
403	Operação sem permissão ou capacidade desabilitada.
404	Recurso inexistente ou fora dos aplicativos autorizados.
422	JSON bem formado com dados de domínio inválidos.
429	Quota excedida. Respeitar Retry-After.
500	Falha interna. Use requestId para diagnóstico.
503	Dependência indisponível; resultado da mutação pode ser incerto.

Exemplo 401

{
  "error": {
    "code": "unauthenticated",
    "message": "Credencial inválida, expirada ou revogada.",
    "requestId": "req_00000000000040008000000000000001",
    "documentationUrl": "https://docs.agilink.io/api/errors/#unauthenticated"
  }
}

Exemplo 403

{
  "error": {
    "code": "insufficient_permission",
    "message": "Operação sem permissão ou capacidade desabilitada.",
    "requestId": "req_00000000000040008000000000000001",
    "documentationUrl": "https://docs.agilink.io/api/errors/#insufficient-permission"
  }
}

Exemplo 429

{
  "error": {
    "code": "rate_limited",
    "message": "Quota excedida. Respeitar Retry-After.",
    "requestId": "req_00000000000040008000000000000001",
    "documentationUrl": "https://docs.agilink.io/api/errors/#rate-limited"
  }
}

Schema completo e próximos passos

Schema de request

{
  "description": "Sem corpo"
}

Schema de response

{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/DomainResource"
      },
      "maxItems": 100
    },
    "pagination": {
      "$ref": "#/components/schemas/Pagination"
    },
    "meta": {
      "$ref": "#/components/schemas/Meta"
    }
  },
  "required": [
    "data",
    "pagination",
    "meta"
  ]
}

Convenções e limites · Erros · Receitas completas · Guia funcional.