Para agentes de IA: hay un índice de documentación disponible en https://www.mongodb.com/es/docs/llms.txt — versiones en markdown de todas las páginas están disponibles agregando .md a cualquier ruta URL.

Obtén una clave de API

URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

GET /orgs/{ORG-ID}/apiKeys/{API-KEY-ID}
Nombre
Tipo
Descripción

ORG-ID

string

El identificador único de la organización cuyas claves API deseas recuperar. Use el endpoint /orgs para recuperar todas las organizaciones a las que el usuario autenticado tenga acceso.

API-KEY-ID

string

Identificador único para la clave de API que desea recuperar. Solicite el endpoint /orgs/{ORG-ID}/apiKeys para recuperar todas las claves API de la organización especificada a la que el usuario autenticado tiene acceso.

Los siguientes parámetros de query son opcionales:

Nombre
Tipo
Descripción
predeterminado

Num. de pág.

entero

Número de página (basado en índice a partir de 1).

1

elementosPorPágina

entero

Número de elementos a devolver por página, hasta un máximo de 500.

100

bonito

booleano

Indica si el cuerpo de la respuesta debe estar en un formato prettyprint.

false

envelope

booleano

Indica si se debe o no envolver la respuesta en un sobre.

Algunos clientes API no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para corregir esto, establezca "envelope" : true en la query.

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

  • status: Código de respuesta HTTP

  • content: Cuerpo de respuesta esperado

Para los endpoints que devuelven una lista de resultados, el objeto results es un sobre. Ops Manager agrega el campo status al cuerpo de la respuesta.

Ninguno

Este endpoint no utiliza parámetros de cuerpo de solicitud HTTP.

Si configuras el elemento de query envelope en true, la respuesta estará envuelta en el objeto content.

La respuesta HTTP retorna un documento JSON que incluye los siguientes objetos:

Nombre
Tipo
Descripción

id

string

Identificador único para la clave API

links

string

Un arreglo de documentos, que representa un vínculo a uno o más subrecursos o recursos relacionados, como la paginación de listas. Consulte Vinculación para obtener más información.

desc

string

Descripción de la clave API

privateKey

string

Clave privada redactada para la clave API

publicKey

string

llave pública para la clave API

roles

objeto arreglo

Roles que tiene la clave API

roles.{ENTITY-ID}

string

El {ENTITY-ID} representa la Organización o Proyecto a la que aplica este rol. Los valores posibles son: orgId o groupId.

roles.roleName

string

El nombre del rol. El recurso users devuelve todos los roles que el usuario tiene, ya sea en MongoDB Atlas u Ops Manager. Los valores posibles son:

  • Roles de la organización

  • Roles del proyecto

    Grupos y proyectos son términos sinónimos.

    • GROUP_OWNER

    • GROUP_READ_ONLY

    • GROUP_DATA_ACCESS_ADMIN

    • GROUP_DATA_ACCESS_READ_WRITE

    • GROUP_DATA_ACCESS_READ_ONLY

    • GROUP_AUTOMATION_ADMIN

    • GROUP_BACKUP_ADMIN

    • GROUP_MONITORING_ADMIN

    • GROUP_OWNER

    • GROUP_USER_ADMIN

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --header "Content-Type: application/json" \ --include \ --request POST "https://<OpsManagerHost>:<Port>/api/public/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}?pretty=true"
HTTP/1.1 401 UnauthorizedContent-Type: application/json;charset=ISO-8859-1Date: {dateInUnixFormat}WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=falseContent-Length: {requestLengthInBytes}Connection: keep-alive
HTTP/1.1 200 OKVary: Accept-EncodingContent-Type: application/jsonStrict-Transport-Security: max-age=300Date: {dateInUnixFormat}Connection: keep-aliveContent-Length: {requestLengthInBytes}X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}
{ "desc" : "Test Docs Service User", "id" : "5c47503880eef5662e1cce8d", "links" : [ { "href" : "https://<OpsManagerHost>:<Port>/api/public/v1.0/orgs/5980cfc70b6d98229d82e3f6/apiKeys/5c47503880eef5662e1cce8d", "rel" : "self" } ], "privateKey" : "********-****-****-db2c132ca78d", "publicKey" : "ewmaqvdo", "roles" : [ { "orgId" : "5980cfc70b6d97029d82e3f6", "roleName" : "ORG_MEMBER" }, { "groupId" : "{PROJECT-ID}", "roleName" : "GROUP_READ_ONLY" }, { "groupId" : "{PROJECT-ID}", "roleName" : "GROUP_OWNER" } ]}