List Of Apply Changes

List Of Apply Changes
List of Apply Changes

Returns a list of products deployed in each Apply Change All products which are deployed as part of an Apply Change will be listed in one of the following groups:

  • additions: newly installed products
  • updates: settings were changed or the product was upgraded
  • deletions: the product was deleted
  • unchanged: none of the above, but the product was still redeployed
Request
URI
GET
https://{opsmanager-installation}/api/v0/installations
COPY
Query Parameters
integer
page_num
Optional

(Optional) The page of results to retrieve. Leaving this unset disables pagination.

integer
per_page
Optional

(Optional) The number of Installation records to retrieve per page. If unset, it will be a server-defined default. If set without also setting 'page_num', it will be ignored.

Responses
200

OK

Returns GetInstallations of type(s) application/json 
{
    "installations": [
        {
            "id": 0,
            "user_name": "string",
            "additions": [
                {
                    "identifier": "string",
                    "label": "string",
                    "product_version": "string",
                    "change_type": "string",
                    "deployment_status": "string",
                    "deploy_order": 0,
                    "guid": "string",
                    "started_at": "string",
                    "finished_at": "string"
                }
            ],
            "deletions": [
                {
                    "identifier": "string",
                    "label": "string",
                    "product_version": "string",
                    "change_type": "string",
                    "deployment_status": "string",
                    "deploy_order": 0,
                    "guid": "string",
                    "started_at": "string",
                    "finished_at": "string"
                }
            ],
            "updates": [
                {
                    "identifier": "string",
                    "label": "string",
                    "product_version": "string",
                    "change_type": "string",
                    "deployment_status": "string",
                    "deploy_order": 0,
                    "guid": "string",
                    "started_at": "string",
                    "finished_at": "string"
                }
            ],
            "unchanged": [
                {
                    "identifier": "string",
                    "label": "string",
                    "product_version": "string",
                    "change_type": "string",
                    "deployment_status": "string",
                    "deploy_order": 0,
                    "guid": "string",
                    "started_at": "string",
                    "finished_at": "string"
                }
            ],
            "status": "string",
            "started_at": "string",
            "finished_at": "string"
        }
    ],
    "per_page": 0,
    "next_page": 0,
    "prev_page": 0
}
array of installations
installations
Required

installations

integer
per_page
Optional
Constraints: minimum: 1

This is either the value of the 'per_page' parameter in the request, or the server-defined default if the parameter was unset.

integer
next_page
Optional
Constraints: minimum: 1

This is absent if the requested page is the last page of results.

integer
prev_page
Optional
Constraints: minimum: 1

This is absent if the requested page is the first page of results.


400

Setup is not completed

Returns RequireSetupCompleted of type(s) application/json 
{
    "errors": {
        "errors": [
            "string"
        ]
    }
}

401

Unauthorized

Returns UnauthorizedResponse of type(s) application/json 
{
    "errors": {
        "errors": [
            "string"
        ]
    }
}

403

Forbidden

Returns ForbiddenResponse of type(s) application/json 
{
    "errors": {
        "errors": [
            "string"
        ]
    }
}

Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/api/v0/installations
On This Page
Apply Changes Operations
POST
Commit A Staged Installation
GET
Streaming current Apply Change log
GET
Status Of An Apply Change
GET
List Of Apply Changes
POST
Triggering An Apply Change
GET
View A list Of pending changes