This version of the documentation is archived and no longer supported. 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

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: {opsManagerHost}:{port}


GET /api/public/v1.0/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
pageNum integer Page number (1-based). 1
itemsPerPage integer Maximum number of items to return, up to a maximum of 100. 100
pretty boolean Display response in human-readable format. false

Get the State of the Server Pool

GET /api/public/v1.0/groups/GROUP-ID/serverPool

Sample Entity

  "enabled": true,
  "links": [ ... ]

Entity Fields

Name Type Description
enabled boolean If true, the server pool is enabled.


Get the State of the Server Pool


curl -i -u "username:apiKey" --digest "https://<ops-manager-host>/api/public/v1.0/groups/56a49b06a2a9c39a1b/serverPool"


HTTP/1.1 200 OK

  "enabled" : true,
  "links" : [ ... ]