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.

Actualizar una API Key Global

Actualiza los valores de una clave Global API desde Ops Manager utilizando el identificador único para esa Clave.

Para encontrar una clave de API global específica, obtenga la lista de claves de API globales y, a continuación, busque el {API-KEY-ID} que necesita.

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

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

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

Todos los parámetros de ruta de la solicitud son obligatorios.

Nombre
Tipo
Descripción

API-KEY-ID

string

Identificador único para la clave Global API que se desea actualizar.

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

Deberás proporcionar uno o ambos de los dos parámetros de cuerpo.

Nombre
Tipo
Necesidad
Descripción

desc

string

Condicional

Descripción de la clave. Este parámetro es opcional; sin embargo, la solicitud debe contener un parámetro desc o un parámetro roles. Si se proporciona desc, debe tener entre 1 y 250 caracteres.

roles

arreglo de string

Condicional

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

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:

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" \ --request PATCH "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/apiKeys/{API-KEY-ID}?pretty=true" \ --data '{ "desc" : "Updated API key description for test purposes" }'
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}
{ "created": "2019-09-04T15:37:40Z", "desc": "Updated API key description for test purposes", "globalRoles": ["GLOBAL_READ_ONLY"], "groupRoles": [], "numGroups": 0, "orgRoles": [], "orgRolesString": "", "privateKey": "********-****-****-cfe60e9f1f72", "userId": "5d6fda44ff4ab7133648a852", "username": "dczverfw"}