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. NOTE: this restriction applies to any and all API calls made to the Ops Manager. Serial API calls made at the same time by multiple users are also unsupported. For the purposes of this restriction, Ops Manager does not care what user makes the API call, just when the call is made.

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

Response samples

Content type
application/json
{ }

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

Response samples

Content type
application/json
{
  • "overrides": [
    ]
}

Provide a new list of overrides for the BOSH Director

This endpoint will replace the currently configured overrides for the BOSH Director. These overrides will be merged into the BOSH Director manifest. No validation is done on the data provided, other than checking that the data payload is a hash.

Only job properties of the bosh instance group and networks can be overridden.

Given the following overrides:

{
  "overrides": [
    {
      "section": "instance_groups",
      "data": {
        "director": {
          "remove_dev_tools": false
        }
      }
    },
    {
      "section": "networks",
      "data": {
        "first-network": {
          "type": "dynamic"
        }
      }
    }
  ]
}

This will result in the following director manifest:

name: p-bosh
....
networks:
- name: first-network
  type: dynamic # overridden value
  .... # other values not affected
....
instance_groups:
  0:
    name: bosh
    ....
    properties:
      ...
      director:
        .... # other values are not affected
        remove_dev_tools: false #  overridden value
Request Body schema: application/json
Array of objects (DirectorManifestOverride) [ items ]

A list of overrides that will be applied to the BOSH Director manifest.

Overrides will be applied in order, so the last override will be applied last.

Responses

Request samples

Content type
application/json
Example
{
  • "overrides": [
    ]
}

Response samples

Content type
application/json
{ }

Delete all runtime config overrides for the BOSH Director

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

Responses

Response samples

Content type
application/json
{ }

View a list of all runtime config overrides for the BOSH Director

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

Responses

Response samples