- API >
- Public API Resources >
- Server Pool >
- Group Server Pool Servers
Group Server Pool Servers¶
On this page
The groups/GROUP-ID/serverPool/servers
resource lets you retrieve servers
from the Ops Manager server pool for use by the group’s MongoDB
processes. The resource also lets you terminate servers and return them to the
pool.
For a list of all server pool API resources, see Server Pool. For information on the server pool, see Provision Servers for the Server Pool.
Endpoints¶
Get All Servers Bound to the Group¶
Get a Server by ID¶
SERVER-ID
is the string specified in the id
field in the
groups/GROUP-ID/serverPool/servers
entity.
Get a Server by Hostname¶
HOSTNAME
is the string specified in the hostname
field in the
groups/GROUP-ID/serverPool/servers
entity.
Terminate a Server¶
SERVER-ID
is the string specified in the id
field in the
groups/GROUP-ID/serverPool/servers
entity.
You must have the Automation Admin role to use this endpoint.
Sample Entity¶
Entity Fields¶
Name | Type | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id |
string | A unique identifier for the server. | ||||||||||||
hostname |
string | The hostname that identifies the server. | ||||||||||||
properties |
object of key/value pairs | The custom properties assigned to the server. Administrators control which properties to expose to end users. If properties are exposed, users must select property values when requesting servers. For more information, see Servers Request Options. | ||||||||||||
created |
date | The date the server was added to the server pool. | ||||||||||||
recycled |
date | The date the server was returned to the pool. | ||||||||||||
statusName |
string | The server’s availability. Possible values are:
|
||||||||||||
boundGroupId |
string | The ID of the group where this server is in use. |
Links¶
Relation | Description |
---|---|
self |
Me |