/ /

Update Global App Settings

Updates the global application settings for an Ops Manager installation. Include only the settings you want to change. Ops Manager leaves all other settings unchanged.

Required Roles

To successfully call this endpoint, your API key must have the Global Owner role.

Request

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

PATCH /admin/settings

Request Path Parameters

This endpoint doesn't use HTTP request path parameters.

Request Query Parameters

Name	Type	Necessity	Description	Default
pretty	boolean	Optional	Flag indicating whether the response body is in a prettyprint format.	`false`
envelope	boolean	Optional	Flag that indicates whether to wrap the response in an envelope. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. For endpoints that return one result, the response body includes: `status`: HTTP response code `content`: Expected response body	`false`

Request Body Parameters

Field	Type	Necessity	Description
`dbProperties`	object	Required	Key-value pairs of global app settings to update or add. Settings not included in the request remain unchanged. To remove a setting, set its value to `null`.

Important

Ops Manager rejects any request that includes mms.app.upgradeMode, regardless of value. These requests return a 400 error with the INVALID_SETTINGS_EXCEPTION error code.

Validation runs against the merged set of existing and submitted settings, not just the submitted properties. A request can fail on a field you didn't include if that field is a dependency of a setting you submitted and isn't already configured. For example, submitting {"mms.emailDaoClass": "SIMPLE_MAILER"} fails with detail: "mms.mail.hostname must not be blank" if mms.mail.hostname has no existing value.

Response

Field	Type	Description
`restartRequired`	boolean	Indicates whether you must restart Ops Manager for the updated settings to take effect.

Example Request

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --header "Accept: application/json" \
     --header "Content-Type: application/json" \
     --include \
     --request PATCH \
     "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/settings?pretty=true" \
     --data '{
       "dbProperties": {
         "mms.centralUrl": "https://ops-manager.example.com"
       }
     }'

Example Response

Response Header

HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=ISO-8859-1
Date: {dateInUnixFormat}
WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false
Content-Length: {requestLengthInBytes}
Connection: keep-alive

HTTP/1.1 200 OK
Vary: Accept-Encoding
Content-Type: application/json
Strict-Transport-Security: max-age=300
Date: {dateInUnixFormat}
Connection: keep-alive
Content-Length: {requestLengthInBytes}
X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}

Response Body

1 {
2   "restartRequired": false
3 }

Back

Get Settings

Backup Administration