Libera una clave de licencia desde una instalación de Ops Manager. Utiliza este endpoint cuando la instalación ya no necesite la clave de licencia. Ops Manager recalcula el estado de la clave de licencia y la devuelve. Ops Manager registra un evento de auditoría License released .
Importante
Después de liberar una clave de licencia, no puedes usarla de nuevo. Si liberas la única clave de licencia utilizable, tu instalación no tiene cobertura. El estado cambia a GRACE, y luego a UNLICENSED después de 90 días. Para generar una nueva clave de licencia, consulta Obtener e instalar una clave de licencia.
Roles necesarios
Para acceder a este recurso, tu clave API debe tener el rolGlobal Owner. El rol de Propietario Global es el rol más alto en Ops Manager. Solo los usuarios con este rol pueden ver y gestionar las claves de licencia.
Solicitud
Envía una solicitud de DELETE con el ID de la clave de licencia en la ruta.
URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
DELETE /admin/licenses/{artifactId}Parámetros de ruta de solicitud
La ruta de solicitud contiene el siguiente parámetro:
Parameter | Tipo | Necesidad | Descripción |
|---|---|---|---|
| string | Requerido | Identificador único de la clave de licencia a liberar. Recupera este valor del campo |
Parámetros de Solicitud Query
Este punto final acepta los siguientes parámetros de consulta:
Nombre | Tipo | Necesidad | Descripción | predeterminado |
|---|---|---|---|---|
bonito | booleano | Opcional | Indicador que muestra si el cuerpo de la respuesta está en formato pretty-print. |
|
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:
|
|
Parámetros del cuerpo de la solicitud
Este endpoint no utiliza parámetros de cuerpo de solicitud HTTP.
Respuesta
Si Ops Manager libera la clave de licencia, la respuesta contiene el estado de la clave de licencia recalculado. La respuesta contiene los siguientes campos:
Campo | Tipo | Descripción |
|---|---|---|
| Objeto | Estado agregado de la clave de licencia de la instalación de Ops Manager. Este campo está |
| string | Estado de la clave de licencia de la instalación. Ops Manager devuelve uno de |
| string | Identifica qué produjo el valor |
| booleano | Indica si el estado está |
| Objeto | Siguiente cambio programado en el estado de la clave de licencia. Este campo se |
| string | Evaluador que impulse el siguiente cambio. |
| string | Fecha y hora en que termina el estado actual. |
| string | Estado que sigue al estado actual. |
| Arreglo de objetos | Advertencias abiertas. Ops Manager abre una advertencia de renovación antes de la fecha de finalización de tu pedido. Para saber más, consulta Resumen de las Claves de Licencia de Ops Manager. |
| string | El evaluador que levantó la advertencia. |
| string | Fecha y hora en que se abrió la advertencia. |
| Arreglo de objetos | Temas que cubre la advertencia. Cada objeto contiene una fecha |
| Arreglo de objetos | La contribución de cada evaluador al valor |
| string | El evaluador que emitió el veredicto. |
| string | Indica que el evaluador calculó. |
| string | La fecha y hora en que el incumplimiento entra en vigor, como la fecha de finalización de la orden. Esta fecha es en el futuro mientras el estado está |
| string | Fecha y hora en que se abre la ventana de advertencia de renovación. Este campo es |
| Objeto | Detalles específicos del evaluador. Este campo es |
| Objeto | Siguiente cambio al estado del veredicto. El objeto contiene campos |
| Arreglo de objetos | Claves de licencia que están instaladas en la instalación de Ops Manager. |
| string | Identificador único de la clave de licencia. Utiliza este valor para liberar la clave de licencia. La interfaz del Administrador de Operaciones muestra este valor como el ID de la clave de licencia. |
| booleano | Indica si el Gestor de Operaciones puede usar la clave de licencia para la cobertura. |
| string | Fecha y hora en que MongoDB generó la clave de licencia. |
| string | Fecha y hora en que se instaló la clave de licencia. |
| string | Estado de la clave de licencia. Ops Manager devuelve uno de |
| string | Código de razón para una clave de licencia |
| string | Frase que describe por qué la clave de licencia es |
| string | Fecha y hora en que termina la cobertura de la clave de licencia. Este campo se |
| Arreglo de objetos | Concede que la clave de licencia contiene. Para una clave de licencia |
| string | Tipo de subvención, como |
| string | Identificador de la subvención. Este campo se |
| string | Fecha y hora en que empieza la subvención. |
| string | Fecha y hora en que finaliza la subvención. |
| Arreglo de objetos | Derechos que conlleva la subvención. Cada objeto utiliza los campos descritos para |
| Objeto | Derechos que están activos ahora, agrupados por tipo de derecho. Cada clave es un tipo de derecho, como |
| string | Tipo de derecho a favor. |
| string | Nombre del producto al que se aplica el derecho. Este campo se |
| booleano | Indica si el derecho está en vigor. |
| Objeto | Ventana de validez del derecho a la aplicación. El objeto contiene |
Errors
Si especificas un artifactId que no coincide con una clave de licencia instalada, el endpoint devuelve el estado HTTP 404. El campo errorCode del cuerpo de respuesta contiene ARTIFACT_NOT_FOUND, y el campo detail contiene No installed artifact with that id.
Solicitud de ejemplo
Usa curl para enviar una petición DELETE al endpoint /admin/licenses/{artifactId} :
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --include \ --request DELETE \ "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/licenses/{ARTIFACT-ID}?pretty=true"Respuesta de ejemplo
Los siguientes ejemplos muestran los encabezados de respuesta y el cuerpo de respuesta de una solicitud exitosa.
Encabezado de respuesta
Los siguientes encabezados muestran una respuesta no autorizada y una respuesta exitosa:
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-aliveHTTP/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}Respuesta del cuerpo
El siguiente ejemplo muestra el cuerpo de respuesta:
{ "enforcement": { "effectiveState": "LICENSED", "cause": "term:LICENSED", "enforced": false, "transition": { "evaluatorId": "term", "inStateUntil": "2027-06-30T00:00:00Z", "nextState": "GRACE" }, "warnings": [], "verdicts": [ { "evaluatorId": "term", "state": "LICENSED", "breachAt": "2027-06-30T00:00:00Z", "warningStart": "2027-02-28T00:00:00Z", "metadata": null, "transition": { "inStateUntil": "2027-06-30T00:00:00Z", "nextState": "GRACE" } } ] }, "licenses": [ { "artifactId": "{ARTIFACT-ID}", "usable": true, "generatedAt": "2026-10-01T12:00:00Z", "installedAt": "2026-11-04T15:30:00Z", "status": "ACTIVE", "statusCause": null, "statusReason": null, "termEnd": "2027-06-30T00:00:00Z", "grants": [ { "grantType": "contract", "grantId": "{GRANT-ID}", "startDate": "2026-07-01T00:00:00Z", "endDate": "2027-06-30T00:00:00Z", "entitlements": [] } ] } ], "activeEntitlements": {}}