Triggering An Apply Change

Transmits pending changes to BOSH.

Submitting a POST request to this endpoint is equivalent to triggering the Apply Changes button in the GUI.

When deploy_products is an array of product guids ["my-guid", "another-guid"], it will deploy the director tile and all passed-in products. If there are any tiles being deployed, which are dependent on tiles with staged changes not being deployed, there will be validation errors and the deploy will not occur.

Request

URI

POST

https://{opsmanager-installation}//api/v0/installations

COPY

Request Body

PostInstallations of type(s) application/json

Optional

{
    "force_latest_variables": false,
    "ignore_warnings": false,
    "deploy_products": "string",
    "errands": {}
}

boolean

force_latest_variables

Optional

When true, the BOSH deploy will use the --force-latest-variables CLI flag. This will force any certificates or other BOSH variables to use their latest version even when a stemcell is not being upgraded for the deployment.

boolean

ignore_warnings

Optional

When true, bypass warnings from ignorable verifiers. (Optional)

string

deploy_products

Optional

Apply changes only for the specified products. Will always apply changes for the BOSH Director.

Possible values are : all, none, <collection of product guids>,

object

errands

Optional

Hash of products with their enabled errands. (Optional)

Post Deploy errands support the following states:

true
false
"default"

Pre Delete errands support the following states:

true
false
"default"

Responses

200

Returns Install of type(s) application/json

{
    "install": {
        "id": "number"
    }
}

install

Optional

install

422

Unprocessible Entity

Returns InstallationsErrorResponse of type(s) application/json

{
    "errors": [
        "string"
    ],
    "deployment_errors": {
        "products": [
            {
                "identifier": "string",
                "complete": false,
                "network": {
                    "assigned": false
                },
                "availability_zones": {
                    "assigned": false
                },
                "stemcells": [
                    {
                        "assigned": false,
                        "required_stemcell_version": "string",
                        "required_stemcell_os": "string"
                    }
                ],
                "properties": [
                    {}
                ],
                "resources": {
                    "jobs": [
                        {
                            "identifier": "string",
                            "guid": "string",
                            "error": [
                                "string"
                            ]
                        }
                    ]
                },
                "verifiers": [
                    {
                        "type": "string",
                        "ignorable": false,
                        "errors": [
                            "string"
                        ]
                    }
                ]
            }
        ]
    }
}

array of string

errors

Optional

errors

deployment_errors

Optional

deployment_errors

On This Page

Description

Request

Request Body

Response