Navigation

Server Pool

Note

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.

Overview

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: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

Syntax

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 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 Flag indicating whether the response body should be in a prettyprint format. false
envelope boolean

Flag indicating 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, response body includes:

status HTTP response code
envelope The expected response body

For endpoints that return a list of results, the results object is an envelope. Ops Manager adds the status field to the response body.

 

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.
links  
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.

Examples

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" : [ ... ]
}