- API >
- Public API Resources >
- Automation >
- Automation Status
Automation Status¶
On this page
Note
Groups and projects are synonymous terms. Your {PROJECT-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 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: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource¶
Request Parameters¶
Request Path Parameters¶
Parameter | Type | Description |
---|---|---|
PROJECT-ID | string | (Required.) The unique identifier for the project. |
Request Query Parameters¶
The following query parameters are optional:
Name | Type | Description | Default | ||||||
---|---|---|---|---|---|---|---|---|---|
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 For endpoints that return one result, the response body includes:
|
false |
Request Body Parameters¶
This endpoint does not use HTTP request body parameters.
Response¶
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 project’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 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. |