vRealize Automation Endpoint Configuration Service API

Endpoint Configuration Service API Specification

What Is the Endpoint Configuration Service?

You can use the endpoint configuration service REST API to create, read, update and delete endpoint types, endpoint categories, and endpoints.

Typical Use Cases

Typical use cases for the endpoint configuration service are:

  • A vRA Administrator or a Solution User creates an endpoint category.
  • The vRA administrator registers a new endpoint type with the endpoint configuration service.
  • The IaaS administrator creates, updates or deletes an endpoint through the UI. vRA then calls the endpoint configuration service to create, update or delete endpoint information.

Key Concepts

Endpoint Category Operations

Before creating an endpoint type, an endpoint category should be registered with endpoint configuration service. Examples of endpoint categories include Virtual, Physical, IPAM, and so on. An application can call the POST /api/categories API to create endpoint categories as required.

When an endpoint category is created, the endpoint configuration service creates the endpoint category in the Postgres database.

Endpoint Type

A value that represents the type of an endpoint. A service provider creates an endpoint type within a specified category. For example, a provider of an IPAM service could create an endpoint type called "MyIPAMapp" within the IPAM endpoint category.

If a customer wants to use a new endpoint, the customer must follow a two step process:

  1. Add a new endpoint type, through the endpoint configuration service.
  2. Add a new endpoint instance of that endpoint type.

Endpoint Type Operations

Before creating an endpoint, the endpoint type and schema should be registered with the endpoint configuration service. When an endpoint type is created, the endpoint configuration service creates an endpoint type category in a Postgres database.

An endpoint type schema is stored only in the Postgres database. However, endpoint type information is stored in both the Postgres database and in the InterfaceTypes table on the SQL server.

How the Endpoint Configuration Service Works

When an administrator creates an endpoint instance, the UI calls the endpoint service with endpoint data. The endpoint service performs the following steps:

  • Validates the data against the schema.
  • Gets the IaaS repository endpoint from the component registry.
  • Saves the new endpoint data to the Postgres database.
  • Calls the repository service to save the data.
  • Returns SUCCESS to the endpoint UI.

The logic for update and delete is same as for create.

User Roles and Permissions

Different user roles have different permissions for working with endpoints.

Endpoint Type Operations and Endpoint Type Categories

The following user roles have permission for the following:

  • GET - IaaS Administrators, vRA Administrators, Solution Users.

  • PUT/POST/DELETE - vRA Administrators, Solution Users.

Endpoint Operations
  • GET (global endpoint, without secure data) - IaaS Administrators, Solution Users.
  • GET (any endpoint, secure data) - Solution Users.
  • PUT/POST/DELETE - Solution Users.
  • PUT/POST/DELETE - IaaS Administrators, Solution Users.

Handling Credentials

In vRA 7.0, credential information is stored separately from the management endpoint information. So, when creating an infrastructure endpoint, the customer must specify the credential information separately, making endpoint creation a two-step process. With the vRA 7.1 endpoint configuration service, the endpoint information is specified along with the credential information. The UI displays all the information in a single place, and the endpoint data is stored together at a single place as well.

Password information must be encrypted when saved to the database. To specify that a field needs to be encrypted, the corresponding field must be marked as securestring in the database schema. When saving endpoint information, the endpoint service goes through all the fields of type securestring and encrypts the field data, before saving it to the database. This ensures that passwords are not saved as plain text in the database.

When retrieving endpoint information from the endpoint service, by default, all the fields that use securestring are set to empty. Only specific APIs return fields marked with securestring. Only solution users can retrieve secure fields.

Creating New Endpoint Types

To consume a new endpoint that belongs to a new endpoint type, a service provider must:

  1. Add a new endpoint type, through the endpoint configuration service.
  2. Add a new endpoint instance of that endpoint type.

For step 1, the customer (service provider) must also define a new schema for the endpoint type. The schema should indicate all the permissible fields and their corresponding values for the endpoint type. The endpoint object used for creating the endpoint should confirm to the schema of the endpoint type that the endpoint belongs to.

Additional Information

For more detailed information on using the the API, refer to the vRA Programming Guide.

 

Related Documentation

Related SDKs

Related Sample Code

  • vRealize Automation API Samples for Postman

    Contributor nsb24

    vRealize Automation API Samples for Postman Overview The vRealize Automation REST API provides consumers and administrators access to all services in its service catalog that support the vRealize Auto ...
    vRealize Automation POSTMAN Collection
    Download

    1 Favorite

    0 Comments

    Updated 1 month ago

  • vRealize Automation - Catalog Service

    Contributor VMware

    vRealize Automation - Catalog Service The catalog service REST API is designed to be used by the consumers of the service catalog; for example, an end user who wants to request a catalog item would be ...
    api_vra_catalog vRealize Automation api_vra_composition POSTMAN Collection
    Download

    1 Favorite

    0 Comments

    Updated 4 months ago

  • vRealize Automation - NSX Integration

    Contributor VMware

    vRealize Automation - NSX Integration NSX integration in vRealize Automation can help creating and configuring existing networks, on-demand NAT networks and on-demand routed networks, creating load ba ...
    vRealize Automation api_vra_network POSTMAN Collection
    Download

    0 Comments

    Updated 4 months ago

  • vRealize Automation - Composition Service

    Contributor VMware

    vRealize Automation - Composition Service The composition service allows vRA services to register application components, which the composition service manages so that they can be used in composite bl ...
    vRealize Automation api_vra_composition POSTMAN Collection
    Download

    0 Comments

    Updated 4 months ago

  • vRealize Automation - Identity Service

    Contributor VMware

    vRealize Automation - Identity Service Identity service manages tenants, business groups (formerly named subtenants), groups (both Single-Sign-On and Custom groups), users and identity stores. It also ...
    vRealize Automation api_vra_identity POSTMAN Collection
    Download

    0 Comments

    Updated 4 months ago

  • VMware vRealize Automation Plugin

    Contributor kr1s

    Jenkins vRealize Automation Plugin The vRealize Automation Jenkins plugin enables Jenkins to provision vRealize Automation 7 Blueprints. Requirements Jenkins 1.58+ Java 8 to compile plugin or Java 7 ...
    vRealize Automation Java
    Download

    3 Favorites

    1 Comment

    Updated 8 months ago

  • vRealize Automation - Component Registry

    Contributor VMware

    vRealize Automation - Component Registry Component Registry manages all services (including out-of-the-box services and services from third party solution providers) and serves as the central view for ...
    api_vra_component_registry vRealize Automation POSTMAN Collection
    Download

    0 Comments

    Updated 4 months ago

  • vRealize Automation - Management Service API

    Contributor VMware

    vRealize Automation - Management Service API You can use the reclamation service to query the VMs in an installation for non-usage and, if they are not in use, mark them as eligible for reclamation. ...
    vRealize Automation api_vra_management POSTMAN Collection
    Download

    0 Comments

    Updated 4 months ago

  • vRealize Automation - Content Management Service

    Contributor VMware

    vRealize Automation - Content Management Service You can use the content management service REST API to import and export content, such as blueprints, software components, and other artifacts, from vR ...
    vRealize Automation api_vra_content_management api_vra_composition POSTMAN Collection
    Download

    0 Comments

    Updated 4 months ago

  • vRealize Automation - Event Broker

    Contributor VMware

    vRealize Automation - Event Broker The event broker provides features for managing subscriptions, event topics, events, and messages. Available Use Case Get event topics Registers or updates an Even ...
    vRealize Automation api_vra_event_broker POSTMAN Collection
    Download

    0 Comments

    Updated 4 months ago

  • Extend Disk vRealize Automation Workflow

    Contributor robertshaw

    This VMware Orchestrator workflow package will extend the C drive of a virtual disk in vRealize Automation from a vCenter (vSphere) machine template blueprint. The workflow receives a payload of prope ...
    vRealize Orchestrator Plug-in SDK vRealize Automation vRO Package
    Download

    1 Favorite

    0 Comments

    Updated 1 year ago

  • vRealize Automation - Branding

    Contributor VMware

    vRealize Automation - Branding The Branding service enables the user to customize the VRA UI header and footer. The configurable properties include logo image, company name, product name, background c ...
    api_vra_branding vRealize Automation POSTMAN Collection
    Download

    0 Comments

    Updated 4 months ago

  • vRealize Automation - Properties Service

    Contributor VMware

    vRealize Automation - Properties Service The property service provides APIs to manage property definitions and property groups. Available Use Cases Manage property definitions Manage property groups ...
    api_vra_properties vRealize Automation POSTMAN Collection
    Download

    0 Comments

    Updated 4 months ago

  • vRealize Automation - Approval Service

    Contributor VMware

    vRealize Automation - Approval Service The approval service provides features for managing and tracking the human approval tasks associated with a service process/artifact in a provider realm. It also ...
    api_vra_approval vRealize Automation POSTMAN Collection
    Download

    0 Comments

    Updated 4 months ago

  • vRealize Automation - WorkItem Service

    Contributor VMware

    vRealize Automation - WorkItem Service The work item service provides a standard way for services to present work items to users. It manages the life-cycle of a work item and passes events back to the ...
    api_vra_approval api_vra_workitem vRealize Automation POSTMAN Collection
    Download

    0 Comments

    Updated 4 months ago

  • Project Bosphorus

    Contributor prydin

    Project Bosphorus Background This project is aimed at providing a custom portal framework for vRealize Automation (vRA) along with a reference implementation. It is intended for advanced users/develop ...
    vRealize Automation Java
    Download

    1 Comment

    Updated 1 year ago

  • vRealize Automation Reference Application

    Contributor hmichaud

    vRealize Automation Reference Application Overview This is a sample project that demonstrates how to create a simple self-service portal for vRealize Automation using only RESTful APIs. You are encour ...
    vRealize Automation JavaScript
    Download

    2 Favorites

    4 Comments

    Updated 1 year ago

  • vRA and Ansible Example Integration

    Contributor vm2cloud

    vRealize Automation vRO Package
    Download

    0 Comments

    Updated 3 years ago

  • vRA 7 and above prepare_vra_template.ps1

    Contributor virtualgcoburn

    Powershell script designed to deploy the needed agents on your windows template. This mimics the prepare_vra_template.sh file for linux and will deploy java, bootstrap and gugent agents from the vRA a ...
    vRealize Automation PowerShell
    Download

    1 Comment

    Updated 1 year ago

  • chef-client example of a bootstrap install on Ubuntu 16.04

    Contributor jjasghar

    A basic example to install the chef-client via the install.sh from Chef Software. This should be noted that this only requires wget and bash, so this can work for CentOS, RHEL, debian, Ubuntu, and the ...
    vRealize Automation vRA Blueprint
    Download

    0 Comments

    Updated 2 years ago

;