Update Configuration of One Monitored Host

On this page

Resource

Request Path Parameters
Request Query Parameters
Request Body Parameters
Response
Example Request
Example Response
Response Header
Response Body

Note

Groups and projects are synonymous terms. Your {PROJECT-ID} is the same as your project id. For existing groups, your group/project id remains the same. This page uses the more familiar term group when referring to descriptions. The endpoint remains as stated in the document.

Update the configuration of a monitored MongoDB process.

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

Resource

PATCH /groups/{PROJECT-ID}/hosts/{HOST-ID}

Request Path Parameters

Parameter	Type	Necessity	Description
PROJECT-ID	string	Required	Unique identifier of the project that owns this MongoDB process.
HOST-ID	string	Required	Unique identifier of the host for the MongoDB process.

Request Query Parameters

The following query parameters are optional:

Name

Type

Necessity

Description

Default

pretty

boolean

Optional

Flag indicating whether the response body should be in a prettyprint format.

false

envelope

boolean

Optional

Flag that indicates whether or not 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:

Name	Description
`status`	HTTP response code
`content`	Expected response body

false

Request Body Parameters

Parameter	Type	Necessity	Description
alertsEnabled	boolean	Optional	Set to `true` if alerts should be enabled for this MongoDB process.
authMechanismName	string	Optional	Specify which authentication mechanism should be used to connect to this MongoDB process. Possible values are: `MONGODB_CR` (This covers SCRAM-SHA-1, SCRAM-SHA-256, and MONGODB-CR.) `GSSAPI` `PLAIN` `MONGODB_X509` `NONE`
logsEnabled	boolean	Optional	Set to `true` if Ops Manager should collect logs for this MongoDB process.
password	string	Conditional	Password for connecting to this MongoDB process. Specify if `"authMechanismName" : "MONGODB_CR"` or `"authMechanismName" : "SCRAM_SHA_1"`. However, it will never be exposed when a host entity is returned.
profilerEnabled	boolean	Optional	Set to `true` if Ops Manager collects profile information from this MongoDB process.
sslEnabled	boolean	Conditional	Set to `true` if TLS/SSL should be enabled for this MongoDB process. Set to `true` if `"authMechanismName" : "MONGODB_X509"`.
username	string	Conditional	Username needed to connect to this MongoDB process. Specify if `"authMechanismName" : "MONGODB_CR"` or `"authMechanismName" : "SCRAM_SHA_1"`.

If authMechanismName is NONE then any existing values for username and password are cleared. If authMechanismName is SCRAM-SHA-1, then you must provide both the username and password.

Response

Name	Type	Description
aliases	array of strings	Array of alternate hostname and port combinations that Ops Manager discovered for the MongoDB process. These combinations can include hostnames, FQDNs, IPv4 addresses, and IPv6 addresses.
alertsEnabled	boolean	`true` if this MongoDB process has alerts enabled.
authMechanismName	string	Authentication mechanism used to connect to this MongoDB process. This displays only one of the following values: `MONGODB_CR` (This covers SCRAM-SHA-1, SCRAM-SHA-256, and MONGODB-CR.) `GSSAPI` `PLAIN` `MONGODB_X509` `NONE`
clusterId	string	Unique identifier of the cluster to which the MongoDB process belongs.
created	date	Date Ops Manager created or first discovered this MongoDB process.
groupId	string	Unique identifier of the group that owns this host.
hasStartupWarnings	boolean	`true` if this MongoDB process had startup warnings.
hidden	boolean	`true` if host is displayed in the Ops Manager UI. Hosts set to `true` are omitted from API responses.
hiddenSecondary	boolean	`true` if this host is a hidden secondary.
hostEnabled	boolean	`true` if the MongoDB process currently enabled.
hostname	string	Primary hostname as Ops Manager can best determine. This can be a hostname, an FQDN, an IPv4 address, or an IPv6 address.
id	string	Unique identifier.
ipAddress	string	IPv4 or IPv6 address associated with the `hostname` of this MongoDB process. Additional accessible IPv4 or IPv6 addresses may be displayed in the `aliases` array.
journalingEnabled	boolean	`true` if journaling is enabled for this MongoDB process.
lastDataSizeBytes	number	Uncompressed size of the host's databases on disk in bytes excluding indexes. `lastDataSizeBytes` does not include the data in the local database.
lastIndexSizeBytes	number	Uncompressed size of the host's database indexes on disk in bytes. This number does not include the size of the index for the local database.
lastPing	date	Timestamp in ISO 8601 date and time format in UTC when the last ping for this MongoDB process was received.
lastRestart	date	Timestamp in ISO 8601 date and time format in UTC when this process last restarted. If the MongoDB process has never been restarted, the `lastRestart` field is omitted.
links	array	Array that includes one or more links to sub-resources and/or related resources. The relations between URLs are explained in the Web Linking Specification. At minimum, a `links` array contains one link called `self`.
logsEnabled	boolean	`true` if Ops Manager is collecting logs for this MongoDB process.
lowUlimit	boolean	`true` if this MongoDB process's host has a low `ulimit` setting.
port	number	Port on which the MongoDB process listens.
profilerEnabled	boolean	`true` if Ops Manager collects profile information from this MongoDB process.
replicaSetName	string	Name of the replica set this process belongs to. Only present if this process is part of a replica set.
replicaStateName	string	Current state of this MongoDB process within a replica set. Only present if this process is part of a replica set. See Replica Set Member States for possible values.
shardName	string	Name of the shard to which this process belongs. Only present if the process is part of a sharded cluster.
secondaryDelaySecs	number	Number of seconds this replica set member's data trails the primary. If this value is set to `0`, the member is not configured as a delayed member. For additional details on secondary delays, see Delayed Replica Set Members
sslEnabled	boolean	`true` if TLS/SSL and is enabled for this MongoDB process.
systemInfo	object	Object that contains RAM and CPU information for this MongoDB process' server as reported by the operating system or container.
systemInfo.memSizeMB	number	Amount of RAM in megabytes.
systemInfo.numCores	number	Number of CPU cores.
typeName	string	Type for this MongoDB process. Possible values are: `STANDALONE` `REPLICA_PRIMARY` `REPLICA_SECONDARY` `REPLICA_ARBITER` `RECOVERING` `SHARD_MONGOS` `SHARD_CONFIG` `SHARD_STANDALONE` `SHARD_PRIMARY` `SHARD_SECONDARY` `NO_DATA` The type for new hosts added to Ops Manager will be `NO_DATA` until the Monitoring receives its first ping.
uptimeMsec	number	Number of milliseconds since this process last restarted.
version	string	Version of MongoDB running for this process.

Example Request

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
 --header "Accept: application/json" \
 --header "Content-Type: application/json" \
 --include \
 --request PATCH "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/groups/{PROJECT-ID}/hosts/{HOST-ID}?pretty=true" \
 --data '
   {
     "sslEnabled": true,
     "username": "mongodb",
     "password": "M0ng0DB!:)"
   }'

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   "alertsEnabled" : true,
3   "authMechanismName" : "SCRAM-SHA-1",
4   "clusterId" : "{CLUSTER-ID}",
5   "created" : "2024-04-22T19:56:50Z",
6   "groupId" : "{PROJECT-ID}",
7   "hasStartupWarnings" : false,
8   "hidden" : false,
9   "hostEnabled" : true,
10   "hostname" : "server1.example.com",
11   "id" : "{HOST-ID}",
12   "ipAddress": "10.1.0.10",
13   "journalingEnabled" : false,
14   "lastDataSizeBytes" : 470208719,
15   "lastIndexSizeBytes" : 110420592,
16   "lastPing" : "2024-08-15T17:57:12Z",
17   "links" : [  ],
18   "logsEnabled" : false,
19   "lowUlimit" : false,
20   "muninEnabled" : false,
21   "port" : 26000,
22   "profilerEnabled" : false,
23   "replicaSetName": "rs1",
24   "replicaStateName" : "SECONDARY",
25   "sslEnabled" : true,
26   "systemInfo" : {
27     "memSizeMB" : 65536,
28     "numCores" : 16
29   },
30   "typeName": "REPLICA_SECONDARY",
31   "uptimeMsec": 489182394,
32   "username" : "mongodb",
33   "version" : "4.4.0"
34 }

Note

Although Ops Manager returns muninEnabled in the response, Munin is unsupported as of Ops Manager 4.4.

Back

Begin Monitoring

Stop Monitoring

1	{
2	"alertsEnabled" : true,
3	"authMechanismName" : "SCRAM-SHA-1",
4	"clusterId" : "{CLUSTER-ID}",
5	"created" : "2024-04-22T19:56:50Z",
6	"groupId" : "{PROJECT-ID}",
7	"hasStartupWarnings" : false,
8	"hidden" : false,
9	"hostEnabled" : true,
10	"hostname" : "server1.example.com",
11	"id" : "{HOST-ID}",
12	"ipAddress": "10.1.0.10",
13	"journalingEnabled" : false,
14	"lastDataSizeBytes" : 470208719,
15	"lastIndexSizeBytes" : 110420592,
16	"lastPing" : "2024-08-15T17:57:12Z",
17	"links" : [ ],
18	"logsEnabled" : false,
19	"lowUlimit" : false,
20	"muninEnabled" : false,
21	"port" : 26000,
22	"profilerEnabled" : false,
23	"replicaSetName": "rs1",
24	"replicaStateName" : "SECONDARY",
25	"sslEnabled" : true,
26	"systemInfo" : {
27	"memSizeMB" : 65536,
28	"numCores" : 16
29	},
30	"typeName": "REPLICA_SECONDARY",
31	"uptimeMsec": 489182394,
32	"username" : "mongodb",
33	"version" : "4.4.0"
34	}