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.
{
"force_latest_variables": false,
"ignore_warnings": false,
"deploy_products": [
"string"
],
"errands": {},
"rotate_certs": {
"non_configurable_leaf": false
}
}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.
When true, bypass warnings from ignorable verifiers. (Optional)
Apply changes only for the specified products. Will always apply changes for the BOSH Director. Can either be an array of product guids or a string with the value "all" or "none".
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"
Options for rotating certificates during Apply Changes.
OK
{
"install": {
"id": "number"
}
}install
Setup is not completed or bad request
{
"errors": {
"errors": [
"string"
]
}
}Unauthorized
{
"errors": {
"errors": [
"string"
]
}
}Forbidden
{
"errors": {
"errors": [
"string"
]
}
}Unprocessable Content
{
"errors": [
"string"
],
"warnings": [
"string"
],
"deployment_errors": {
"products": [
{
"identifier": "string",
"complete": false,
"network": {
"assigned": false
},
"availability_zone": {
"assigned": false
},
"stemcells": [
{
"assigned": false,
"required_stemcell_version": "string",
"required_stemcell_os": "string"
}
],
"properties": [
{
"name": "string",
"type": "string",
"errors": [
"string"
],
"records": [
{
"index": "number",
"errors": [
{
"name": "string",
"type": "string",
"errors": [
"string"
]
}
]
}
]
}
],
"resources": {
"jobs": [
{
"identifier": "string",
"guid": "string",
"error": [
"string"
]
}
]
},
"verifiers": [
{
"type": "string",
"ignorable": false,
"errors": [
"string"
]
}
]
}
]
}
}errors
warnings
deployment_errors
curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '}' https://{api_host}/api/v0/installations