To create a vRealize Automation endpoint, you make a POST request with a request body that includes vRealize Automation specific parameters.

As a content developer, you use the API to create a vRealize Automation endpoint.

Prerequisites

  • Verify that the appliance name and fully qualified domain name of the vRealize Suite Lifecycle Manager instance are available.
  • Verify that the URL variable is assigned.
    url='https://LCM-Hostname'
  • Verify that you have added at least one vRealize Automation endpoint.

Procedure

  1. Create an endpoint to capture vRealize Automation content. In this example, the vroServerId is from the vRealize Orchestrator endpoint that you created in Add a vRealize Orchestrator Endpoint.
    curl -X POST \
      '$url/lcm/cms/api/v1/endpoints' \
      -H 'Authorization: Basic YWRtaW5AbG9jYWw6Vk13YXJlMSE=' \
      -H 'Content-Type: application/json' \
      -d '{
        "tagNames": [
            "vra-prod-env"
        ],
        "supportCapture": true,
        "supportTest": true,
        "supportRelease": true,
        "supportOnlySourceControlledContent": false,
        "name": "vra-prod",
        "vroServerId":"7be2d7f0-bb34-4779-809f-904c328e1a7c",
        "enabled": true,
        "category": "Automation",
        "version": "7.x",
        "server": "<LCM-Hostname>",
        "userName": "<username_to_access_content_endpoint>",
        "password": "<password>",
        "tenant": "qe",
        "endpointType": "CONTENT_ENDPOINT"
    }' | jq "."
  2. Examine the response.
    {
      "requestId":"fcb8040a-e44a-48b1-8cb4-ff7f793becf6",
      "status":"IN_PROGRESS",
      "message":"Endpoint Successfully Created",
      "referenceId":"e321e9f5-37a3-497c-93c9-b579fe8ba8fd"
    }
     
  3. Assign the reference ID of the endpoint to a variable name.
    vRAEndpoint = '<referenceID>'
  4. Get information about the vRealize Automation endpoint.
    curl -X GET \
      '$url/lcm/cms/api/v1/endpoints/{$vRAEndpoint}' \
      -H 'Accept: application/json' \
      -H 'Authorization: Basic YWRtaW5AbG9jYWw6Vk13YXJlMSE=' \
      -H 'Content-Type: application/json' | jq "."
     
  5. Examine the response for information about the vRealize Automation endpoint.
    Response:
    {
        "id": "e321e9f5-37a3-497c-93c9-b579fe8ba8fd",
        "createdOn": 1573126732254,
        "lastUpdatedOn": 1573126732334,
        "tagNames": [
            "vra-prod-env"
        ],
        "supportCapture": true,
        "supportTest": true,
        "supportRelease": true,
        "supportTemplates": false,
        "supportOnlySourceControlledContent": false,
        "storeTemplates": false,
        "requestedBy": "admin@local",
        "name": "vra-prod",
        "enabled": true,
        "category": "Automation",
        "systemEndpoint": false,
        "version": "7.x",
        "server": "vRAserver.my.company.com",
        "userName": "user@my.company.local",
        "password": "example_user_password",
        "tenant": "qe",
        "vroServerId": "7be2d7f0-bb34-4779-809f-904c328e1a7c",
        "reviewRequired": false,
        "endpointType": "CONTENT_ENDPOINT",
        "userIdentity": "admin@local"
    }
     

What to do next

Use your endpoint to manage the following types of vRealize Automation content:
  • Automation-Component Profile
  • Automation-Composite Blueprint
  • Automation-Custom Form
  • Automation-Property Definition
  • Automation-Property Group
  • Automation-Resource Map
  • Automation-Resource Type
  • Automation-Resource Action
  • Automation-Software
  • Automation-Subscription
  • Automation-XaaS Blueprint