Overview of the vRealize Suite Lifecycle Manager REST API

As a VMware vRealize^® Suite Lifecycle Manager™ user or customer, you can perform vRealize Suite Lifecycle Manager functions programmatically by using REST API service calls. The API follows the REST style and is available to all licensed users.

About the API Reference

APIs are installed with vRealize Suite Lifecycle Manager. The Swagger docs are available at the following URLs.

• For the vRealize Suite Lifecycle Manager APIs, go to https://$vRLCM/api/swagger-ui.html
• For the Content Management APIs, go to https://$vRLCM/lcm/cms/api/swagger-ui.html

$vRLCM denotes an instance of vRealize Suite Lifecycle Manager.

The vRealize Suite Lifecycle Manager Swagger docs are also publicly available at https://developer.vmware.com/apis/1190.

Note: VMware provides customers with a 12 month End-of-Life notice for any breaking changes to public APIs. To review API changes, see the release notes included with the vRealize Suite Documentation.

How Developers Use the APIs

To make API service calls, you use a browser application or an HTTP client application to send requests and review responses. The following open-source applications are commonly used:

• cURL. http://curl.haxx.se
• jq parser. https://stedolan.github.io/jq/
• Postman application. https://www.getpostman.com/

To learn how to use the APIs, you can start by performing the steps outlined in the following use cases:

• Installing and Importing Products Using vRealize Suite Lifecycle Manager APIs
• Managing SDDC Content Using Content Management APIs

All use cases include curl commands in request examples. To use the commands, ensure that the jq command-line JSON processor is installed with curl. The jq parser ensures that responses are formatted for optimum readability. For information about jq installation, see https://stedolan.github.io/jq/.

Postman collections for vRealize Suite Lifecycle Manager are provided as samples with the API reference at https://developer.vmware.com/samples/3711/postman-samples-for-vrealize-suite-lifecycle-manager.

Authentication

You access vRealize Suite Lifecycle Manager APIs as a local user, for example user@local. Local authentication uses a basic Authorization request header.

curl -H "Authorization: Basic <token>" -k https://<vRSLCM_hostname>/lcm/lcops/api/settings/systemsettings

Where:

• vRSLCM_hostname is the hostname or IP address of the vRealize Suite Lifecycle Manager server that manages the VMware Identity Manager cluster.
• token is the Base64 encoded value of "username:password", with username admin@local and the password for admin@local. To encode to Base64 format, you can use a web application such as https://www.base64encode.org/.

The following request example shows how to make a call with a token that is the encoded value of admin@local:ThisIsPassword.

curl -H "Authorization: Basic YWRtaW5AbG9jYWw6VGhpc0lzUGFzc3dvcmQ=" -k https://vrlcm.vrack.local/lcm/lcops/api/settings/systemsettings