- API >
- Public API Resources >
- Server Pool >
- Group Server Pool Requests
Group Server Pool Requests¶
On this page
The groups/GROUP-ID/serverPool/requests
resource lets you provision
servers from the Ops Manager server pool and retrieve and cancel
provisioning requests.
Endpoints¶
Provision a Server from the Server Pool¶
Send a document that contains only the properties
array. You must specify
a value for each property in the array. You can specify multiple values for a
property if the property’s multiSelect
option is enabled. To retrieve
available properties, see Group Server Pool Properties.
You must have the Automation Admin role to POST
this endpoint.
Get All Server Provisioning Requests for the Group¶
Check the Status of Server Provisioning Request¶
REQUEST-ID
is the string specified in the id
field in the
groups/GROUP-ID/serverPool/requests
entity.
Cancel a Server Provisioning Request¶
REQUEST-ID
is the string specified in the id
field in the
groups/GROUP-ID/serverPool/requests
entity.
You must have the Automation Admin role to
use the DELETE
method with this endpoint.
Sample Entity¶
Entity Fields¶
Name | Type | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
id |
string | A unique identifier for the request. | ||||||||||
numServers |
number | The number of servers requested. | ||||||||||
created |
date | The date and time the request was issued. | ||||||||||
expires |
date | The date and time the request expires if no server is available. | ||||||||||
completeDate |
date | The date and time the request was completed. | ||||||||||
cancelDate |
date | The date and time the request was cancelled. | ||||||||||
groupId |
string | The group for which the server is requested. | ||||||||||
properties |
object of key/value pairs | The properties that identify the type of server requested. | ||||||||||
statusName |
string | The status of the request. Possible values are:
|
Links¶
Relation | Description |
---|---|
self |
Me |
http://mms.mongodb.com/serverPool |
The state of the server pool. |
http://mms.mongodb.com/serverPoolRequests |
The group’s requests for servers from the server pool. |
http://mms.mongodb.com/group |
The group the server requests belong to. |