---
title: "GET /api-keys/{keyId}"
description: "Consultar/alterar metadados e restrições permitidas — parâmetros, schemas e exemplos completos."
sidebar:
  hidden: true
---

**Consultar/alterar metadados e restrições permitidas.** Contrato v1 · disponível em produção e homologação · operação `getApiKeysKeyId`. [Guia funcional](/api/fundacao/) · [Índice](/api/operacoes/) · [Schemas](/referencia/) · [Testar em sandbox](/console/?operation=getApiKeysKeyId).

## Autenticação e efeito

Permissão: `api_keys:read`. Exige sessão humana verificada; API keys não são aceitas. OAuth/MCP ainda não estão disponíveis. Use o access token da sessão humana do proprietário, obtido pelo login do ambiente e mantido somente no processo seguro; a chave de API não substitui essa sessão.

Disponível em produção e homologação; sujeito às capacidades do app e à configuração do provedor. Exige sessão humana verificada. 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 |
| --- | --- | --- | --- |
| `keyId` | path | sim |  Revision; {"type":"string","format":"uuid"} |



## 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_HUMAN_SESSION` deve ficar no servidor. Os placeholders abaixo são fictícios. Preserve Idempotency-Key e payload ao repetir uma intenção após timeout.

```sh
curl --request GET 'https://api.staging.agilink.io/v1/api-keys/90000000-0000-4000-8000-000000000001' \
  --header 'Authorization: Bearer <credencial>'
```

## JavaScript / TypeScript

```js
// Node.js 22+. Defina AGILINK_HUMAN_SESSION no ambiente do servidor.
const response = await fetch('https://api.staging.agilink.io/v1/api-keys/90000000-0000-4000-8000-000000000001', {
  method: 'GET',
  headers: {
  "Authorization": `Bearer ${process.env.AGILINK_HUMAN_SESSION}`
},
  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
# Python 3.10+; pip install requests
import os
import requests
headers = {
  "Authorization": "Bearer " + os.environ["AGILINK_HUMAN_SESSION"]
}
response = requests.request(
    'GET', 'https://api.staging.agilink.io/v1/api-keys/90000000-0000-4000-8000-000000000001',
    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 |
| `ETag` | Revisão forte, a enviar em If-Match na alteração. | "20000000-0000-4000-8000-000000000001" |

```json
{
  "data": {
    "id": "30000000-0000-4000-8000-000000000001",
    "name": "Backend da loja",
    "prefix": "agl_test_AbCdEf",
    "appIds": [
      "app_loja"
    ],
    "permissions": [
      "apps:read",
      "links:read",
      "links:create"
    ],
    "expiresAt": "2027-01-17T20:00:00Z",
    "createdAt": "2026-10-19T20:00:00Z",
    "lastUsedAt": null,
    "revokedAt": null,
    "revision": "20000000-0000-4000-8000-000000000001"
  },
  "meta": {
    "requestId": "req_00000000000040008000000000000001"
  }
}
```

| Campo | Tipo | Obrigatório | Significado e limites |
| --- | --- | --- | --- |
| `data` | object | sim | Resultado tipado da operação.  |
| `data.id` | string | sim | Identificador estável do recurso. uuid |
| `data.name` | string | sim | Nome de exibição. Até 100 caracteres |
| `data.prefix` | string | sim | Prefixo de caminho, sem barras. Até 30 caracteres; Formato validado pelo schema |
| `data.appIds` | array | sim | Aplicativos permitidos à credencial. Até 100 itens |
| `data.permissions` | array | sim | Permissões explícitas, sem wildcard. Até 100 itens |
| `data.expiresAt` | string | sim | Fim de validade; não amplia concessões. date-time |
| `data.createdAt` | string | sim | Instante de criação com fuso. date-time |
| `data.lastUsedAt` | string ou null | sim | Valor tipado; formato e restrições completos no schema abaixo.  |
| `data.revokedAt` | string ou null | sim | Valor tipado; formato e restrições completos no schema abaixo.  |
| `data.revision` | string | sim | Revisão forte para If-Match; muda ao editar. uuid |
| `meta` | object | 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

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

### Exemplo 403

```json
{
  "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

```json
{
  "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

<details><summary>Schema de request</summary>

```json
{
  "description": "Sem corpo"
}
```

</details>

<details><summary>Schema de response</summary>

```json
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "data": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string",
          "format": "uuid"
        },
        "name": {
          "type": "string",
          "maxLength": 100,
          "minLength": 1
        },
        "prefix": {
          "type": "string",
          "maxLength": 30,
          "pattern": "^agl_(live|test)_[A-Za-z0-9_-]{4,12}$"
        },
        "appIds": {
          "type": "array",
          "items": {
            "type": "string",
            "maxLength": 500,
            "minLength": 1,
            "pattern": "^[^/\\u0000-\\u001f\\u007f]+$"
          },
          "maxItems": 100,
          "minItems": 1,
          "uniqueItems": true
        },
        "permissions": {
          "type": "array",
          "items": {
            "enum": [
              "analytics:read",
              "apps:delete",
              "apps:read",
              "apps:update",
              "assets:create",
              "assets:delete",
              "assets:read",
              "batches:create",
              "batches:read",
              "campaigns:create",
              "campaigns:delete",
              "campaigns:read",
              "campaigns:update",
              "capabilities:read",
              "dns:create",
              "dns:delete",
              "dns:read",
              "dns:update",
              "domains:create",
              "domains:delete",
              "domains:read",
              "domains:verify",
              "exports:create",
              "exports:read",
              "folders:create",
              "folders:delete",
              "folders:read",
              "folders:update",
              "identity:read",
              "imports:commit",
              "imports:create",
              "imports:read",
              "imports:validate",
              "link_history:read",
              "links:create",
              "links:delete",
              "links:preview",
              "links:read",
              "links:resync",
              "links:update",
              "links:validate",
              "native_config:read",
              "native_config:update",
              "operations:cancel",
              "operations:read",
              "qr_codes:create",
              "qr_codes:delete",
              "qr_codes:read",
              "qr_codes:update",
              "recovery_config:read",
              "recovery_config:update",
              "routing_rules:read",
              "routing_rules:update",
              "tags:create",
              "tags:delete",
              "tags:read",
              "tags:update",
              "template_bindings:read",
              "template_bindings:update",
              "templates:create",
              "templates:preview",
              "templates:publish",
              "templates:read",
              "templates:retry",
              "templates:snapshot",
              "templates:update",
              "templates:validate",
              "usage:read",
              "web_config:read",
              "web_config:update",
              "webhooks:create",
              "webhooks:delete",
              "webhooks:read",
              "webhooks:retry",
              "webhooks:rotate_secret",
              "webhooks:test",
              "webhooks:update"
            ]
          },
          "maxItems": 100,
          "minItems": 1,
          "uniqueItems": true
        },
        "expiresAt": {
          "type": "string",
          "format": "date-time"
        },
        "createdAt": {
          "type": "string",
          "format": "date-time"
        },
        "lastUsedAt": {
          "anyOf": [
            {
              "type": "string",
              "format": "date-time"
            },
            {
              "type": "null"
            }
          ]
        },
        "revokedAt": {
          "anyOf": [
            {
              "type": "string",
              "format": "date-time"
            },
            {
              "type": "null"
            }
          ]
        },
        "revision": {
          "type": "string",
          "format": "uuid"
        }
      },
      "required": [
        "id",
        "name",
        "prefix",
        "appIds",
        "permissions",
        "expiresAt",
        "createdAt",
        "lastUsedAt",
        "revokedAt",
        "revision"
      ]
    },
    "meta": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "requestId": {
          "$ref": "#/components/schemas/RequestId"
        }
      },
      "required": [
        "requestId"
      ]
    }
  },
  "required": [
    "data",
    "meta"
  ]
}
```

</details>

[Convenções e limites](/api/contratos/) · [Erros](/api/errors/) · [Receitas completas](/receitas/) · [Guia funcional](/api/fundacao/).