- API >
- Public API Resources >
- Automation >
- Automation Status
Automation Status¶
On this page
Overview¶
The Public API provides the automationStatus
endpoint to let you see
whether each MongoDB process is up-to-date with the current
automation configuration. The
endpoint returns the goalVersion
field to report the current version
of the automation configuration and the lastGoalVersionAchieved
fields to
report the versions of the configuration running on each server.
Base URL: {opsManagerHost}:{port}
¶
Syntax¶
Request Parameters¶
Request Path Parameters¶
Parameter | Required/Optional | Description |
---|---|---|
GROUP-ID |
Required. | The unique identifier for the group. |
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 |
---|---|---|
goalVersion |
number | The version of the most recently submitted automation configuration. If there is a conflict in submissions of automation configurations, this field lists the winning configuration. |
processes |
array | The group’s deployed MongoDB instances. |
processes.hostname |
string | The fully qualified domain name (retrieved by issuing hostname -f )
of the server on which the MongoDB process and Automation Agent are
hosted. |
processes.name |
string | The process name as specified in the automation configuration. |
processes.lastGoalVersionAchieved |
number | The last version of the automation configuration with which this
process had deployed as configured. If the processes.lastGoalVersionAchieved
number is not equal to the goalVersion number, the process has
not yet deployed according to the current configuration. |
processes.plan |
array | Describes how a process that is not yet up-to-date with the configuration will achieve the goal state. |