/ /

/ /

Crear una clave API del agente

Cloud Manager dejará de admitir la Automatización, la Copia de seguridad y la Supervisión para MongoDB 3.6 y 4.0 después del 30de agosto de 2024. Por favor actualiza tu implementación de MongoDB o migra a Atlas.

URL base: https://cloud.mongodb.com/api/public/v1.0

Resource

POST /groups/{PROJECT-ID}/agentapikeys

Este endpoint está restringido a los usuarios con la Project Owner rol.

Parámetros de ruta de solicitud

Nombre	Tipo	Descripción
PROJECT-ID	string	Identificador único del proyecto que posee la clave API del agente.

Parámetros de Solicitud Query

Los siguientes parámetros de query son opcionales:

Nombre

Tipo

Necesidad

Descripción

predeterminado

bonito

booleano

Opcional

Indicador que señala si el cuerpo de respuesta debe estar en un prettyprint formato.

false

envelope

booleano

Opcional

Bandera que indica si se debe o no envolver la respuesta en un sobre.

Algunos Los clientes API no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para solucionar este problema, configure envelope=true en la query.

Para los endpoints que devuelven un resultado, el cuerpo de la respuesta incluye:

Nombre	Descripción
`status`	Código de respuesta HTTP
`content`	Cuerpo de respuesta esperado

false

Parámetros del cuerpo de la solicitud

Nombre	Tipo	Descripción
desc	string	Etiqueta para esta clave API del agente.

Respuesta

Nombre	Tipo	Descripción
ID	string	Identificador único de esta clave API del agente.
llave	string	clave API del agente. Después de crear esta clave API del agente, las solicitudes posteriores devuelven los últimos cuatro caracteres de las claves API del agente.
desc	string	Etiqueta para esta clave API del agente. Limitado a 1,000 caracteres.
createdTime	string	Marca de tiempo en ISO 8601 formato de fecha y hora en UTC cuando se creó la clave API del agente.
createdUserId	string	Identificador único del usuario que creó esta clave API del agente.
createdIpAddr	string	Dirección IP que creó esta clave API de agente.
createdBy	string	Fuente de esta clave API del agente. Los valores aceptados son: `USER` `OLD_KEY` `PROVISIONING` `ATLAS` `PUBLIC_API`

Solicitud de ejemplo

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --header "Accept: application/json" \
     --header "Content-Type: application/json" \
     --include \
     --request POST "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/agentapikeys?pretty=true" \
     --data '
       {
         "desc": "Agent API Key for this project"
       }'

Respuesta de ejemplo

Encabezado de respuesta

HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=ISO-8859-1
Date: {dateInUnixFormat}
WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false
Content-Length: {requestLengthInBytes}
Connection: keep-alive

HTTP/1.1 200 OK
Vary: Accept-Encoding
Content-Type: application/json
Strict-Transport-Security: max-age=300
Date: {dateInUnixFormat}
Connection: keep-alive
Content-Length: {requestLengthInBytes}
X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}

Respuesta del cuerpo

{
  "_id" : "{AGENT-API-KEY-ID}",
  "createdBy" : "PUBLIC_API",
  "createdIpAddr" : "{IP-ADDRESS}",
  "createdTime" : 1520458807291,
  "createdUserId" : "{USER-ID}",
  "desc" : "Agent API Key for this project",
  "key" : "{AGENT-API-KEY}"
}

Volver

Obtener por tipo

Obtener todas las claves API