You must log in to the server and establish a session before you can begin to use the VCPS APIs.


The following information must be present in the file:
  • Key username as HCB_REST_API_USERNAME
  • Key password as HCB_REST_API_PASSWORD in encrypted form


  1. The following POST request will be sent to the server:
    The user name and password is sent in the body of the request:
    curl --location --request POST "https://{{server_ip}}:9443/api/v1/session" \
      --header "Content-Type: application/json" \
      --data "{
  2. A successful call will create a session and return the session ID.

What to do next

Save the session ID as you will need to provide the ID when you call the other VCPS APIs.