- API >
- Public API Resources >
- Server Pool >
- Server Pool
Server Pool¶
On this page
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: {opsManagerHost}:{port}
¶
Syntax¶
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 | Display response in human-readable format. | false |
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 |
|