vCloud API extensibility requests allow you to develop extension to vCloud Director.

API-URL is a URL of the form https://vcloud.example.com/api.

id is a unique identifier in the form of a UUID, as defined by RFC 4122.

Important

Request URLs are always available in Link elements contained by the representation of the object on which they operate. URL forms shown here are for reference purposes only. Although URLs have a well-known syntax and a well-understood interpretation, a client should treat vCloud API request URLs as opaque strings. The rules that govern how the server constructs these strings might change in future releases.

This summary may not cover all requests in this category. For the complete list of requests, along with detailed information about input and output types, see the Operations lists in the schema reference.

Summary of vCloud API Extensibility Requests

Operation

Request

Request Body

Response

Register an extension service with vCloud Director

POST API-URL/admin/extension/service

Service

Service

Retrieve a list of registered extension services.

GET API-URL/admin/extension/service

None

ExtensionServices

Update a registered extension service.

PUT API-URL/admin/extension/service/id

Service

Service

Delete a registered extension service.

DELETE API-URL/admin/extension/service/id

None

204 No Content

Register extension service links with vCloud Director objects.

POST API-URL/admin/extension/service/id/links

ServiceLink

ServiceLink

Create resource class definitions for a registered extension service.

POST API-URL/admin/extension/service/id/resourceClasses

ResourceClass

ResourceClass

Associate actions with a resource class.

POSTAPI-URL/admin/extension/service/resourceClass/id/resourceClassActions

ResourceClassAction

ResourceClassAction

Create an ACL rule for a resource class.

POSTAPI-URL/admin/extension/service/resourceClassAction/id/aclRules

AclRule

AclRule

Associate a right with an extension service.

POSTAPI-URL/admin/extension/service/id/rights

Right

RightRight

Update a right associated with an extension service.

PUTAPI-URL/admin/right/id

Right

Right

Delete rights no longer associated with a role or ACL rule after the associated extension service has been deleted.

POSTAPI-URL/admin/extension/service/action/clearUnusedRights

None

204 No Content

List the access rights for a specific combination of user and entity

POSTAPI-URL/admin/user/id/entityRights

EntityReferences

UserEntityRights

Create a Task object in the organization/id

POSTAPI-URL/tasksList/id

Task

Task

Update a Task object

PUTAPI-URL/task/id

Task

Task

Post an extension service event to the system.

POSTAPI-URL/admin/org/id/events

Event

204 No Content

Initiate the upload of a localization bundle for an extension service.

POSTAPI-URL/admin/extension/service/id/localizationBundles

BundleUploadParams

BundleUploadSocket

Create API definitions for a registered extension service.

POST API-URL/admin/extension/service/id/definitions

ApiDefinition

ApiDefinition

Create file descriptors for a registered extension service.

POSTAPI-URL/admin/extension/service/definition/id/files

FileDescriptor

FileDescriptor