This API does not support parallel API calls.
Parallel calls, even though unsuccessul, will not return an error code.
You must pass a token to each API endpoint. To get a token, and curl an API endpoint using that token, follow these instructions:
From a command line with Ruby installed, install the cf-uaac gem:
gem install cf-uaac
Target your Ops Manager IP:
> uaac target https://YOUR_OPSMAN_IP/uaa
Log in to your Ops Manager with the Client name "opsman" and empty Client secret:
> uaac token owner get Client name: opsman Client secret: JUST_PRESS_ENTER User name: YOUR_USERNAME_HERE Password: YOUR_PASSWORD_HERE
uaac now has your token and you can now use
> uaac curl <ENDPOINT>
> uaac curl -X POST -H "Content-type: application/json" <ENDPOINT> -d '<JSON BODY>'
uaac context and get the
curl -H "Authorization: Bearer UAA_ACCESS_TOKEN" <ENDPOINT>
- "locked": true
- "locked": true
Saves installation state as though the deployment was triggered with the "Apply Changes" button, without actually deploying. This prepares the installation manifest, but does not invoke BOSH.
After commit, each product's manifest can fetched using the
If you see the commit endpoint return the following error:
This endpoint is currently disabled because one or more of the products you are trying to upgrade have credentials to migrate to credhub. See the Migrating Credentials to Credhub section of the API docs to enable this endpoint again.
This endpoint can be enabled again by following the steps described in the Migrating Credentials to Credhub section.
When true, bypass warnings from ignorable verifiers
- "ignore_warnings": true
If there is no currently running Apply Changes then it returns 200 with
an exit event of type
no install in progress.
This endpoint streams the logs of the currently running Apply Changes using the Server Sent Events format.
It starts by streaming an event named
step_info which includes
an array of JSON data with the name and descriptions of each
ordered install step. Next, it will stream all of the log which has
already happened during this Apply Changes.
Then, it will stream realtime events and logs as they happen.
Mixed in with lines of logs, it will send events for steps called
step_finished, and an exit event at the end.
step_finished events have JSON data,
that include an
id key corresponding to the JSON sent in the
exit event has JSON data which includes the exit code of the last
command from the Apply Changes.
A exit code of 0 means success, and any other exit code indicates failure.
When the Apply Changes ends, the server closes the client's connection.
Note: The example response included in this documentation has been abbreviated for the sake of brevity.