Tanzu Ops Manager API Reference (2.10)

Download OpenAPI specification:Download

Parallel Calls

This API does not support parallel API calls.

Parallel calls, even though unsuccessul, will not return an error code.

How to Authenticate

You must pass a token to each API endpoint. To get a token, and curl an API endpoint using that token, follow these instructions:

Installing uaac

  • From a command line with Ruby installed, install the cf-uaac gem:

    gem install cf-uaac

Obtaining a uaac token

  • Target your Tanzu Ops Manager IP:

    > uaac target https://YOUR_OPSMAN_IP/uaa

  • Log in to your Tanzu 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

Using uaac curl

  • uaac now has your token and you can now use uaac curl:

    > uaac curl <ENDPOINT>

    > uaac curl -X POST -H "Content-type: application/json" <ENDPOINT> -d '<JSON BODY>'

Using regular curl

  • Use uaac context and get the access_token:

    curl -H "Authorization: Bearer UAA_ACCESS_TOKEN" <ENDPOINT>

Advanced Manifest Configuration

Advanced manifest configuration allows the user to set any property on the instance groups and networks sections of the Bosh Director manifest, even if Tanzu Ops Manager does not provide support for that property.

Advanced mode required.

Delete all manifest overrides for the BOSH Director

This endpoint will delete all of the currently configured overrides for the BOSH Director.

Responses

200

0K

403

Forbidden

delete /api/v0/staged/director/overrides
/api/v0/staged/director/overrides

Response samples

Content type
application/json
Copy
Expand all Collapse all
{ }

View a list of all manifest overrides for the BOSH Director

This endpoint will list the currently configured overrides for the BOSH Director. Overrides will be applied in order, so the last override will be applied last.

Responses

200

0K

403

Forbidden

get /api/v0/staged/director/overrides
/api/v0/staged/director/overrides

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "overrides":
    [
    ]
}

Provide a new list of overrides for the BOSH Director

This endpoint will replace the currently configured overrides for the BOSH Director. These ove