Accessing Orchestrator REST API

In this recipe, we are looking at how to access and play with the Orchestrator REST API.

Getting ready

We need a browser, preferably Chrome or Firefox.

To play and explore, we also need access to the Orchestrator Control Center.

We will be using the example workflow 07.02 Access via PowerShell (Input).

How to do it...

The recipe is broken up into multiple parts for easier reading; the best way forward is to work through one after the other.

Accessing the API documentation and enable "play mode"

Note

Please note that this is a stetting that you shouldn't use in any production environments.

1. Open the Orchestrator Control Center and enter the system property com.vmware.o11n.sso.basic-authentication.enabled = true as shown in section System properties in the recipe Control Center titbits in Chapter 2, Optimizing Orchestrator Configuration.

2. Open a browser and browse to https://[Orchestrator]:8281/vco/api/docs/

3. The SwaggerUI of Orchestrator will open up.

Try it out!

Let's give...