This version of the documentation is archived and no longer supported. It will be removed on 01 March 2021. To learn how to upgrade your version of MongoDB Ops Manager, refer to the upgrade documentation.
You were redirected from a different version of the documentation. Click here to go back.

Group Server Pool

Server Pools deprecated as of Ops Manager 4.0

As of Ops Manager 4.0, server pools are deprecated and disabled by default.


Groups and projects are synonymous terms. Your {GROUP-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.

The groups/{GROUP-ID}/serverPool resource returns the state of Ops Manager server pool. It is the root resource of the group’s serverPool resource set and is a resource subset of groups.

For detailed information on Server pools, see Provision Servers for the Server Pool.

For a list of all resources in the server pool resource set, see Server Pool.

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


GET /groups/{GROUP-ID}/serverPool

Request Parameters

Request Path Parameters

This endpoint does not use HTTP request path parameters.

Request Query Parameters

This endpoint may use any of the HTTP request query parameters available to all Ops Manager API resources. These are all optional.

Name Type Description Default
pretty boolean Indicates whether the response body should be in a prettyprint format. false
envelope boolean

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
envelope Expected response body

Request Body Parameters

This endpoint does not use HTTP request body parameters.


Name Type Description
enabled boolean If true, the server pool is enabled.
Relation Description
self Me
https://{opsManagerHost}:{port}/serverPoolServers The servers in the pool.
https://{opsManagerHost}:{port}/serverPoolProperties The properties used to identify servers in the server pool.
https://{opsManagerHost}:{port}/serverPoolRequests All requests for servers from the server pool.

Example Request

curl -i -u "username:apiKey" --digest "https://{opsManagerHost}:{port}/api/public/v1.0/groups/56a49b06a2a9c39a1b/serverPool"

Example Response

HTTP/1.1 200 OK
  "enabled" : true,
  "links" : []