You use the API version and session ID to authenticate and run requests against VMware Cloud Provider Lifecycle Manager.

The API supports versioning and changes in the API do not affect earlier versions. To obtain the API version, you make an initial API request to the VMware Cloud Provider Lifecycle Manager endpoint without the need of an authentication.

You must provide the JSESSION ID in all subsequent API requests as a JSESSIONID on the Headers tab.

Procedure

  1. To obtain the API version, in your Web browser start Postman application and configure the following HTTPS request.
    Setting Value
    HTTPS request method GET
    URL https://vcp_lcm_ip_address:9443/api/about
  2. To obtain the JSESSION ID, in your Web browser start Postman application, configure an HTTPS request, and provide the credentials for the local VMware Cloud Provider Lifecycle Manager user account.
    The credentials for the local VMware Cloud Provider Lifecycle Manager user account are configured when running the VMware Cloud Provider Lifecycle Manager docker image.
    Setting Value
    HTTPS request method POST
    URL https://vcp_lcm_ip_address:9443/api/api_version/session
    Body
    {
        "username": "vcp_lcm_local_user",
        "password": "vcp_lcm_local_user_password"
    }