VMware Cloud Foundation Operations Orchestrator API

REST Resources

This API supports a Representational State Transfer (REST) model for accessing a set of resources through a fixed set of operations.

Authorizing requests

Every request made using the VCF Operations Orchestrator REST API must be authorized by an authenticated user.

Depending on whether you configure VCF Operations Orchestrator with vCenter Single Sign-On or oauth2.0, the authentication scheme for the VCF Operations Orchestrator REST API is different.

Single Sign-On Authentication

If VCF Operations Orchestrator is configured with the vCenter Single Sign-On (SSO) server, you need a principal holder-of-key (HoK) token to access system objects in VCF Operations Orchestrator through the REST API.

The HoK token is passed as a request Authorization header element. The value must be gzip, base64
encoded string.

Oauth2.0 Authentication

If VCF Operations Orchestrator is configured with VIDM you need an oauth bearer access token to access system objects in VCF Operations Orchestrator through the REST API.

The oauth bearer token is passed as request Authorization header element. The value must be Bearer {token}.

Data Model

All endpoints act on a common set of data. The data can be represented with difference media (i.e. \"MIME\") types, depending on the endpoint that consumes and/or produces the data. The data can be described by an XML Schema, which definitively describes the XML representation of the data, but is also useful for describing the other formats of the data, such as JSON.

This document describes the data using terms based on this schema. Data can be grouped by namespace, with a schema document describing the elements and types of the namespace. In general, types define the structure of the data and elements are instances of a type. For example, elements are usually produced by (or consumed by) a REST endpoint, and the structure of each element is described by its type.

To be able to test the service bellow you need to enable basic authentication over sso.
This happens by adding the following property to vmo.properties configuration file:

com.vmware.o11n.sso.basic-authentication.enabled = true