Fix This Page
You were redirected from a different version of the documentation. Click here to go back.

Server Pool


The serverPool resource returns the state of Ops Manager server pool and provides access to the root of the server pool API resources.

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

For a list of all server pool API resources, see Server Pool.

Base URL: {opsManagerHost}:{port}


GET /api/public/v1.0/serverPool

Necessary Roles

You must have the Global Read Only role to use this endpoint.

Request Parameters

Request Path Parameters

This endpoint does not use HTTP request path parameters.

Request Query Parameters

This endpoint does not use HTTP request query parameters.

Request Body Parameters

This endpoint does not use HTTP request body parameters.

Response Elements

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 -X GET -u "{username}:{apiKey}" --digest "https://{opsManagerHost}:{port}/api/public/v1.0/serverPool"

Example Response

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