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.

Crear una única clave API global

Cree una clave API global para Ops Manager.

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

POST /admin/apiKeys

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

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

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

Debes proporcionar todos los parámetros del cuerpo de la solicitud.

Nombre
Tipo
Necesidad
Descripción

desc

string

Requerido

Descripción de la clave API global. Debe tener entre 1 y 250 caracteres de longitud.

roles

arreglo de string

Requerido

Lista de roles que la clave de API global necesita tener. Si se proporciona el arreglo roles:

  • Proporciona al menos un rol

  • Asegúrate de que todos los roles sean válidos.

Las funciones globales aceptadas por defecto incluyen:

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

Clave privada sin redactar para esta clave global de 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:

Nota

El usuario que realiza la solicitud puede formatearse como {PUBLIC-KEY}:{PRIVATE-KEY}.

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/admin/apiKeys?pretty=true" \ --data '{ "desc" : "New API key for Global Testing", "roles" : [ "GLOBAL_READ_ONLY", "GLOBAL_USER_ADMIN" ] }'
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" : "New API key for Global Testing", "id" : "5d669ce780eef52a42cf0e1e", "links" : [ { "href" : "https://<OpsManagerHost>:<Port>/api/public/v1.0/orgs/null/apiKeys/5d669ce780eef52a42cf0e1e", "rel" : "self" } ], "privateKey" : "8d080e57-5fd6-495c-9388-fe348ed1796f", "publicKey" : "cfswjfck", "roles" : [ { "roleName" : "GLOBAL_READ_ONLY" }, { "roleName" : "GLOBAL_USER_ADMIN" } ]}