Listar chaves de API

OBTER /api/v1/projects/{id}/keys

Lista todas as chaves API do projeto. O escopo do projeto é realizado pelo parâmetro route id path e a organização é derivada desse projeto.

parâmetros de caminho

id string Obrigatório

ID do Projeto

parâmetros de query

include_inactive string

Incluir chaves inativas

Respostas

406

aplicação/json

aplicação/json aplicação/vnd.agent-engine-2026-09-20-preview+json

Versão de API não permitida ou malformada, uma operação indisponível no contrato publicado selecionado ou uma representação inaceitável (incluindo parâmetros de tipo de mídia não suportados ou SSE excluído). Falhas existentes de autenticação, autorização e limite de taxa têm precedência.
Ocultar atributos de resposta Mostrar atributos de resposta objeto
- badRequestDetail objeto
  
  Detalhes de validação opcionais definidos pelo esquema de erro padrão; Os erros de negociação da API não emitem este campo.
  
  Ocultar atributo ruimRequestDetail Mostrar atributo ruimRequestDetail objeto
  
  Campos array[objeto]
  
  Campos com falhas de validação.
  
  Ocultar atributos de campos Mostrar atributos dos campos objeto
  
  Um campo e sua falha de validação.
  
  Descrição string Obrigatório
  
  Falha na validação legível por humanos.
  
  Campo string Obrigatório
  
  Nome ou caminho do campo de solicitação inválido .
- detalhe string Obrigatório
  
  Detalhes de erro legíveis por humanos.
- Erro inteiro Obrigatório
  
  HTTP status code.
- Código de erro string Obrigatório
  
  Código de erro legível por máquina.
- Parâmetros array[string]
  
  Solicitar nomes de parâmetros associados ao erro; omitido quando nenhum se aplica.
- Razão string Obrigatório
  
  Frase de razão do status HTTP.
Ocultar atributos de resposta Mostrar atributos de resposta objeto
- badRequestDetail objeto
  
  Detalhes de validação opcionais definidos pelo esquema de erro padrão; Os erros de negociação da API não emitem este campo.
  
  Ocultar atributo ruimRequestDetail Mostrar atributo ruimRequestDetail objeto
  
  Campos array[objeto]
  
  Campos com falhas de validação.
  
  Ocultar atributos de campos Mostrar atributos dos campos objeto
  
  Um campo e sua falha de validação.
  
  Descrição string Obrigatório
  
  Falha na validação legível por humanos.
  
  Campo string Obrigatório
  
  Nome ou caminho do campo de solicitação inválido .
- detalhe string Obrigatório
  
  Detalhes de erro legíveis por humanos.
- Erro inteiro Obrigatório
  
  HTTP status code.
- Código de erro string Obrigatório
  
  Código de erro legível por máquina.
- Parâmetros array[string]
  
  Solicitar nomes de parâmetros associados ao erro; omitido quando nenhum se aplica.
- Razão string Obrigatório
  
  Frase de razão do status HTTP.
200

aplicação/vnd.agent-engine-2026-09-20-preview+json

aplicação/vnd.agent-engine-2026-09-20-preview+json aplicação/json

OK
Ocultar atributos de resposta Mostrar atributos de resposta objeto
- contar inteiro
- keys array[objeto]
  
  Ocultar atributos das chaves Mostrar atributos das chaves objeto
  
  created_at string
  
  created_by string
  
  Quem/o que criou este token
  
  Descrição string
  
  Descrição legível por humanos
  
  expires_at string
  
  id string
  
  is_active booleano
  
  last_used_at string
  
  Monitorar o uso
  
  org_id string
  
  Organização à qual este token pertence
  
  PROJECT_ID string
  
  Projeto ao qual este token pertence
  
  revoked_at string
  
  Revoped_by string
  
  token_prefix string
  
  Prefixo de pesquisa limitado para identificação (por exemplo, "agp_live_sk_")
  
  user_id string
  
  Usuário que possui este token
- Sucesso booleano
Ocultar atributos de resposta Mostrar atributos de resposta objeto
- contar inteiro
- keys array[objeto]
  
  Ocultar atributos das chaves Mostrar atributos das chaves objeto
  
  created_at string
  
  created_by string
  
  Quem/o que criou este token
  
  Descrição string
  
  Descrição legível por humanos
  
  expires_at string
  
  id string
  
  is_active booleano
  
  last_used_at string
  
  Monitorar o uso
  
  org_id string
  
  Organização à qual este token pertence
  
  PROJECT_ID string
  
  Projeto ao qual este token pertence
  
  revoked_at string
  
  Revoped_by string
  
  token_prefix string
  
  Prefixo de pesquisa limitado para identificação (por exemplo, "agp_live_sk_")
  
  user_id string
  
  Usuário que possui este token
- Sucesso booleano
401

aplicação/json

aplicação/json aplicação/vnd.agent-engine-2026-09-20-preview+json

Não autorizado
Ocultar atributos de resposta Mostrar atributos de resposta objeto
- código string
- Erro string
- Sucesso booleano
Ocultar atributos de resposta Mostrar atributos de resposta objeto
- código string
- Erro string
- Sucesso booleano
500

aplicação/json

aplicação/json aplicação/vnd.agent-engine-2026-09-20-preview+json

Erro interno do servidor
Ocultar atributos de resposta Mostrar atributos de resposta objeto
- código string
- Erro string
- Sucesso booleano
Ocultar atributos de resposta Mostrar atributos de resposta objeto
- código string
- Erro string
- Sucesso booleano

GET /api/v1/projects/{id}/keys

curl \
 --request GET 'https://agentengine.mongodb.com/api/v1/projects/{id}/keys' \
 --header "Authorization: $API_KEY"

Exemplos de resposta (406)

{
  "detail": "This operation is not available in API version 2026-09-20-preview.",
  "error": 406,
  "errorCode": "OPERATION_NOT_IN_API_VERSION",
  "parameters": [
    "Accept"
  ],
  "reason": "Not Acceptable"
}

{
  "detail": "This operation supports text/event-stream, which the Accept header excludes. Remove unsupported media-type parameters or accept this type with a positive q value.",
  "error": 406,
  "errorCode": "UNACCEPTABLE_MEDIA_TYPE",
  "parameters": [
    "Accept"
  ],
  "reason": "Not Acceptable"
}

{
  "detail": "The requested API version is not supported. Supported versions: 2026-09-20-preview.",
  "error": 406,
  "errorCode": "UNSUPPORTED_API_VERSION",
  "parameters": [
    "Accept"
  ],
  "reason": "Not Acceptable"
}

Exemplos de resposta (406)

{
  "detail": "This operation is not available in API version 2026-09-20-preview.",
  "error": 406,
  "errorCode": "OPERATION_NOT_IN_API_VERSION",
  "parameters": [
    "Accept"
  ],
  "reason": "Not Acceptable"
}

Exemplos de resposta (200)

{
  "count": 42,
  "keys": [
    {
      "created_at": "string",
      "created_by": "string",
      "description": "string",
      "expires_at": "string",
      "id": "string",
      "is_active": true,
      "last_used_at": "string",
      "org_id": "string",
      "project_id": "string",
      "revoked_at": "string",
      "revoked_by": "string",
      "token_prefix": "string",
      "user_id": "string"
    }
  ],
  "success": true
}

Exemplos de resposta (200)

{
  "count": 42,
  "keys": [
    {
      "created_at": "string",
      "created_by": "string",
      "description": "string",
      "expires_at": "string",
      "id": "string",
      "is_active": true,
      "last_used_at": "string",
      "org_id": "string",
      "project_id": "string",
      "revoked_at": "string",
      "revoked_by": "string",
      "token_prefix": "string",
      "user_id": "string"
    }
  ],
  "success": true
}

Exemplos de resposta (401)

{
  "code": "string",
  "error": "string",
  "success": true
}

Exemplos de resposta (401)

{
  "code": "string",
  "error": "string",
  "success": true
}

Exemplos de resposta (500)

{
  "code": "string",
  "error": "string",
  "success": true
}

Exemplos de resposta (500)

{
  "code": "string",
  "error": "string",
  "success": true
}