Listar claves de API

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

Muestra todas las claves API del proyecto. El alcance del proyecto viene definido por el parámetro de ruta ID, y la organización se deriva de dicho proyecto.

Parámetros de path

ID string Requerido

ID del proyecto

Parámetros de query

incluir_inactivo string

Incluir claves inactivas

Respuestas

406

application/json

application/json aplicación/vnd.agent-engine-2026-09-20-preview+json

Versión de API no compatible o con formato incorrecto, operación no disponible en el contrato publicado seleccionado o representación inaceptable (incluidos parámetros de tipo de medio no compatibles o SSE excluidos). Los fallos de autenticación, autorización y límite de velocidad existentes tienen prioridad.
Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
- badRequestDetail Objeto
  
  Detalles de validación opcionales definidos por el esquema de error estándar; los errores de negociación de la API no emiten este campo.
  
  Ocultad el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
  
  Campos arreglo[objeto]
  
  Campos con errores de validación.
  
  Ocultar campos atributos Mostrar los atributos de los campos Objeto
  
  Un campo y su fallo de validación.
  
  Descripción string Requerido
  
  Fallo en la validación legible para humanos.
  
  Campo string Requerido
  
  Nombre o ruta del campo de solicitud no válido.
- detalle string Requerido
  
  Detalles de errores legibles para humanos.
- Error entero Requerido
  
  HTTP status code.
- errorCode string Requerido
  
  Código de error legible por máquina.
- Parámetros array[string]
  
  Nombres de los parámetros de la solicitud asociados con el error; se omiten cuando no corresponde ninguno.
- motivo string Requerido
  
  Frase que indica el motivo del estado HTTP.
Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
- badRequestDetail Objeto
  
  Detalles de validación opcionales definidos por el esquema de error estándar; los errores de negociación de la API no emiten este campo.
  
  Ocultad el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
  
  Campos arreglo[objeto]
  
  Campos con errores de validación.
  
  Ocultar campos atributos Mostrar los atributos de los campos Objeto
  
  Un campo y su fallo de validación.
  
  Descripción string Requerido
  
  Fallo en la validación legible para humanos.
  
  Campo string Requerido
  
  Nombre o ruta del campo de solicitud no válido.
- detalle string Requerido
  
  Detalles de errores legibles para humanos.
- Error entero Requerido
  
  HTTP status code.
- errorCode string Requerido
  
  Código de error legible por máquina.
- Parámetros array[string]
  
  Nombres de los parámetros de la solicitud asociados con el error; se omiten cuando no corresponde ninguno.
- motivo string Requerido
  
  Frase que indica el motivo del estado HTTP.
200

aplicación/vnd.agent-engine-2026-09-20-preview+json

aplicación/vnd.agent-engine-2026-09-20-preview+json application/json

OK
Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
- count entero
- claves arreglo[objeto]
  
  Ocultar atributos de claves Mostrar atributos de las claves Objeto
  
  created_at string
  
  creado_por string
  
  ¿Quién o qué creó este token?
  
  Descripción string
  
  Descripción legible por humanos
  
  expira_en string
  
  ID string
  
  está_activo booleano
  
  último_usado_en string
  
  Seguimiento del uso
  
  org_id string
  
  Organización a la que pertenece este token
  
  project_id string
  
  Proyecto al que pertenece este token
  
  revoked_at string
  
  revocado_por string
  
  token_prefix string
  
  Prefijo de búsqueda delimitado para identificación (p. ej., "agp_live_sk_")
  
  user_id string
  
  Usuario que posee este token
- éxito booleano
Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
- count entero
- claves arreglo[objeto]
  
  Ocultar atributos de claves Mostrar atributos de las claves Objeto
  
  created_at string
  
  creado_por string
  
  ¿Quién o qué creó este token?
  
  Descripción string
  
  Descripción legible por humanos
  
  expira_en string
  
  ID string
  
  está_activo booleano
  
  último_usado_en string
  
  Seguimiento del uso
  
  org_id string
  
  Organización a la que pertenece este token
  
  project_id string
  
  Proyecto al que pertenece este token
  
  revoked_at string
  
  revocado_por string
  
  token_prefix string
  
  Prefijo de búsqueda delimitado para identificación (p. ej., "agp_live_sk_")
  
  user_id string
  
  Usuario que posee este token
- éxito booleano
401

application/json

application/json aplicación/vnd.agent-engine-2026-09-20-preview+json

No autorizado
Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
- Código string
- Error string
- éxito booleano
Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
- Código string
- Error string
- éxito booleano
500

application/json

application/json aplicación/vnd.agent-engine-2026-09-20-preview+json

Error interno del servidor
Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
- Código string
- Error string
- éxito booleano
Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
- Código string
- Error string
- éxito booleano

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

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

Ejemplos de respuesta (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"
}

Ejemplos de respuesta (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"
}

Ejemplos de respuesta (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
}

Ejemplos de respuesta (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
}

Ejemplos de respuesta (401)

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

Ejemplos de respuesta (401)

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

Ejemplos de respuesta (500)

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

Ejemplos de respuesta (500)

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