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.

Obtener una clave API global

Devuelva una clave Global API para Ops Manager usando el identificador único de esa Clave.

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

GET /admin/apiKeys/{API-KEY-ID}

Requiere que la clave de API que llama a este endpoint tenga el rol de Global Read Only.

Nombre
Tipo
Descripción

API-KEY-ID

string

Identificador único para la clave Global de API que desea recuperar.

Los siguientes parámetros de query son opcionales:

Nombre
Tipo
Necesidad
Descripción
predeterminado

bonito

booleano

Opcional

Indicador que muestra si el cuerpo de la respuesta está en formato pretty-print.

false

envelope

booleano

Opcional

Bandera que 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 solucionar esto, ajusta envelope=true en la query.

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

  • status: Código de respuesta HTTP

  • content: Cuerpo de respuesta esperado

false

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

Nombre
Tipo
Descripción

desc

string

Descripción de esta clave API global.

id

string

Identificador único para esta clave de API global.

links

string

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

privateKey

string

llave privada redactada para esta clave global API.

publicKey

string

Clave pública para esta clave API global.

roles

objeto arreglo

Roles que tiene esta clave API global. Este arreglo devuelve todos los roles Globales que el usuario tiene en Ops Manager.

roles.roleName

string

Nombre del rol. Este recurso devuelve todos los roles que el usuario tiene en Ops Manager. Los valores posibles son:

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --include \ --request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/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 Global API Key 1", "id" : "{API-KEY-ID}", "links" : [ { "href" : "https://<OpsManagerHost>:<Port>/api/public/v1.0/orgs/null/apiKeys/{API-KEY-ID}", "rel" : "self" } ], "privateKey" : "********-****-****-54d9792d337d", "publicKey" : "zrefxaep", "roles" : [ { "roleName" : "GLOBAL_READ_ONLY" }, { "roleName" : "GLOBAL_BILLING_ADMIN" } ]}