/ /

Get Import Deployment Requests

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.

Retrieve all import deployment requests for a project. This endpoint returns a list of all import deployment requests that have been created for the specified project, including their current status and history.

Important

This feature is available starting in Ops Manager 8.0.13.

Required Roles

This endpoint requires the Project Automation Admin role.

Endpoint

Base URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

GET /automation/importDeployment/{PROJECT-ID}

Request

Path Parameters

Name	Type	Necessity	Description
PROJECT-ID	string	Required	Unique identifier of the project.

Query Parameters

The following query parameters are optional:

Name

Type

Necessity

Description

Default

pretty

boolean

Optional

Flag indicating whether the response body should be in a prettyprint format.

false

envelope

boolean

Optional

Flag that indicates 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 envelope=true in the query.

For endpoints that return one result, the response body includes:

Name	Description
`status`	HTTP response code
`content`	Expected response body

false

Body Parameters

This endpoint doesn't use HTTP request body parameters.

Response

Name	Type	Necessity	Description
results	array	Always	Array of import deployment request objects.
results[n].id	string	Always	Unique identifier of the import deployment request.
results[n].groupId	string	Always	Project identifier.
results[n].userId	string	Always	User who created the import request.
results[n].state	string	Always	Current state of the import. Possible values: `PENDING`, `AWAIT_SEED_HOST_CONNECTED`, `AWAIT_HOSTS_DISCOVERED`, `AWAIT_AUTOMATION_IMPORTED`, `AWAIT_GOAL_STATE`, `SUCCESS`, `FAILED`, `CANCELLED`.
results[n].transitionsHistory	array	Always	History of state transitions for this import request.
results[n].transitionsHistory[n].state	string	Always	The state that was transitioned to.
results[n].transitionsHistory[n].transitionedAt	string	Always	ISO 8601 timestamp when the transition occurred.

Example Request

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/automation/importDeployment/{PROJECT-ID}?pretty=true"

Example Response

Response Header

HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=ISO-8859-1
Date: {dateInUnixFormat}
WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false
Content-Length: {requestLengthInBytes}
Connection: keep-alive

HTTP/1.1 200 OK
Vary: Accept-Encoding
Content-Type: application/json
Strict-Transport-Security: max-age=300
Date: {dateInUnixFormat}
Connection: keep-alive
Content-Length: {requestLengthInBytes}
X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}

Response Body

{
  "results": [
    {
      "id": "507f1f77bcf86cd799439011",
      "groupId": "507f1f77bcf86cd799439012",
      "userId": "507f1f77bcf86cd799439013",
      "state": "SUCCESS",
      "transitionsHistory": [
        {
          "state": "PENDING",
          "transitionedAt": "2025-10-20T10:00:00.000Z"
        },
        {
          "state": "AWAIT_SEED_HOST_CONNECTED",
          "transitionedAt": "2025-10-20T10:02:00.000Z"
        },
        {
          "state": "SUCCESS",
          "transitionedAt": "2025-10-20T10:15:00.000Z"
        }
      ]
    }
  ]
}

Back

Create Import Deployment Request

Get Import Deployment Request Status