For AI agents: a documentation index is available at https://www.mongodb.com/docs/llms.txt — markdown versions of all pages are available by appending .md to any URL path.

Toggle Telemetry Status

Enable or disable telemetry collection for your Ops Manager installation.

Important

Starting in Ops Manager 9.0.2 and 8.0.28, this endpoint turns product usage telemetry on or off. Turning it off requires an active telemetry exemption on the installed license key. Ops Manager checks the license key on every request. To learn how to request an exemption, see Telemetry Exemption.

This endpoint requires an API key that has the Global Owner role.

Base URL: https://{OPSMANAGER-HOST}:{PORT}/api/private/v1.0/telemetry

PATCH /collection/status

This endpoint doesn't use HTTP request path parameters.

This endpoint doesn't use HTTP request query parameters.

Name
Type
Necessity
Description

enabled

boolean

required

Set to true to enable telemetry, or false to disable telemetry. Starting in Ops Manager 9.0.2 and 8.0.28, false turns off product usage telemetry: Ops Manager stops collecting and sending it, and next_job becomes null. Setting false requires an active telemetry exemption on the installed license key. To learn how to request an exemption, see Telemetry Exemption

This endpoint returns an empty JSON object.

curl --user "{publicApiKey}:{privateApiKey}" --digest \ --header "Accept: application/json" \ --header "Content-Type: application/json" \ --include \ --request PATCH "https://<OpsManagerHost>:<Port>/api/private/v1.0/telemetry/collection/status" \ --data '{"enabled": false}'
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 400 Bad RequestContent-Type: application/json;charset=ISO-8859-1Date: {dateInUnixFormat}X-MongoDB-Service-Version: gitHash={gitHash};versionString={ApplicationVersion}Content-Length: {requestLengthInBytes}
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}
{}

This section applies to Ops Manager 9.0.2, 8.0.28, and later.

If you disable product usage telemetry without an active telemetry exemption on the installed license key, the endpoint returns a 403 error and makes no change. The error body reads:

{ "details": "Product usage collection requires a license telemetry exemption", "error": "Forbidden" }

The Retrieve Telemetry Data endpoint still reports "enabled": true. With an active exemption, the request succeeds and returns an empty JSON object ({}).