VCF Automation OpenAPI Operations Index
All available VCF Automation OpenAPI Operations
Get the access-control list for the specified vCD entity.
Creates an access-control grant, giving the user the level of access for the vCD entity.
Get the specified access-control grant.
Updates the specified access-control grant.
Removes the specified access-control grant from the vCD entities access-control list.
Get list of audit trail events
Get a description of a theme to be applied. The response contains relative URLs to each file comprising the theme in its main flavor.
To fetch each file, build a URL from filesRoot + files[i] and GET it.
This resource is accessible without authentication.
Get a description of a theme to be applied. The response contains relative URLs to each file comprising the theme in the requested flavor.
All mandatory resources are included, even if the theme does not explicitly define such flavor(in which case the main flavor is used).
To fetch each file, build a URL from filesRoot + files[i] and GET it.
This resource is accessible without authentication.
Load a file of a theme with the given id, if it exists. This resource is accessible without authentication and without
the need to specify Accept header containing an api version.
Load a file of a theme with the given id, if it exists. This resource is accessible without authentication and without
the need to specify Accept header containing an api version.
Get a list of the certificate library items
Add an item to the certificate library
Retrieves the specified certificate library item. Note: This API also supports a former (erroneously spelt) alternate path /cetificateLibrary/{id} as a Deprecated API (deprecated-in and removed after API version 36.0)
Updates the specified certificate library item. Only the alias and description fields may be edited Note: This API also supports a former (erroneously spelt) alternate path /cetificateLibrary/{id} as a Deprecated API (deprecated-in and removed after API version 36.0)
Delete the specified certificate library item. Only items that are not in use can be deleted. Note: This API also supports a former (erroneously spelt) alternate path /cetificateLibrary/{id} as a Deprecated API (deprecated-in and removed after API version 36.0)
Get list of consumers (as references) of a particular certificate library item
Adds the specified consumer reference to a library item.
Replaces the existing consumer refs with the consumer references supplied.
Retrieves a list of Org-scoped content libraries. Results can be filtered by id, name, org, autoAttach, creationDate, and libraryType.
Creates a new Provider or Tenant Content library based on the context of the user. A library created from System org is a Provider Content Library. A library created from a tenant context is a Tenant Content Library Response is a 202 with task URL in location header
Refreshes the VCF content library to reflect the new items added directly from a Namespace using Packer flow and remove the items that no longer exist in the library backing.
Syncs a subscribed content library to the external source it is subscribed to.
Retrieves a specific content library via URN.
Update content library.
Deletes a VCF Content Library via URN.
Retrieves a list of Org-scoped items. Results can be filtered by id, name, imageIdentifier, isPublished, isSubscribed, status, creationDate, lastSuccessfulSync, contentLibrary, and org.
Creates a new content library item. Note that the item is not fully created until its files have been uploaded.
Retrieves a specific item via URN.
Updates the specified content library item. Only the name and description of the content library item can be updated.
Delete a specific content library item via URN.
Retrieves a list of files for a content library item
Attempts to migrate Defined Entity instances of a Defined Entity Type (source entity type) to another version (upgrade/downgrade) of the Defined Entity Type (target entity type). Depending on potential concurrent updates, this operation might, or might not process all instances. If you seek to migrate all instances, you have a few options:
- run this operation, or individual RDE updates multiple times, as many as required (inspecting state after each run)
- make sure not to perform any upgrade/downgrade operations on Defined Entity instances of the source entity type while the migrate task is in progress. Only those Defined Entity instances which the user has modify access to are affected by the mass migrate operation.
Essentially the mass migrate operation is a batch update operation on the Defined Entity instances of the source entity type (each instance is updated with changing the "entityType" property to the target entity type). However, the underlying update operation on each Defined Entity instance is limited in terms of functionality compared to the API update operation on a Defined Entity instance. First of all, you can only update the "entityType" property of the Defined Entity instance. Also you cannot make use of the OCC functionality when executing a mass migrate - Defined Entity instances will be updated regardless of their current state. And lastly, a PostUpdate hook, defined in the target entity type, will not be executed on the Defined Entity instances after a mass migrate operation.
The mass migrate operation may also change the entityState of the Defined Entity instances:
- If an instance is in PRE_CREATED entityState before the migration - the instance will remain in PRE_CREATED entityState after the migration
- If an instance is in RESOLUTION_ERROR entityState before the migration - the instance will move into PRE_CREATED entityState after the migration
- If an instance is in IN_DELETION entityState before the migration - the instance will remain in IN_DELETION entityState after the migration
- If an instance is in RESOLVED entityState before the migration - the migration operation will try to resolve the instance after upgrading it to the target type's version. If the instance's entity contents validate against the target version's schema, the instance will remain in RESOLVED entityState. If the instance's entity contents cannot validate against the target version's schema, the instance will either remain unchanged (migration will be rolled back) or it will move into RESOLUTION_ERROR entityState depending on the value of the "forceMigrate" property (part of the body of the request). The default behavior is to roll back the migration. Generally in this case (when the instance's entity contents are incompatible with the target version's schema), the user must then individually update each of the incompatible instances according to their business logic.
A RDE modify event is emitted for each instance which is migrated with the 'definedEntity.type' and 'definedEntity.was.type' additional properties having different values (the same RDE modify event is emitted with the Defined Entity instance update operation).
The mass migrate operation is suitable for use when there are a lot of instances of a Defined Entity type which need to be migrated and a small fraction of them is expected to be incompatible with the target entity type's schema. In all other cases, the usual update Defined Entity instance operation is more appropriate.
Gets the defined entity with the unique identifier (URN)
Update the defined entity with the unique identifier (URN). This operation can also be used to upgrade/downgrade the entity to a different version of the defined entity type it is an instance of by setting the "entityType" property.
The update operation may change the entityState of the Defined Entity. If the entity's entityState is:
- PRE_CREATED before the update - the entity will remain in PRE_CREATED entityState after the update
- RESOLUTION_ERROR before the update - the entity will move to PRE_CREATED entityState after the update
- IN_DELETION before the update - the entity will remain in IN_DELETION entityState after the update
- RESOLVED before the update - the update operation will try to validate the entity content (value after the update) against the entity type's schema (value after the update). If validation is successful the entity will remain in RESOLVED state. Otherwise, the entity will move to RESOLUTION_ERROR entityState and the operation will fail with exception.
Deletes the defined entity with the unique identifier (URN). A multi-stage entity deletion process can achieved using the PreDelete and PostDelete RDE lifecycle hooks. When deleting a defined entity the PreDelete hook is executed first and if invocation fails, deletion is aborted and entity remains unchanged. If PreDelete hook execution succeeds, the entity is moved into IN_DELETION state and PostDelete hook execution is started. If the PostDelete hook succeeds, the entity is deleted. Otherwise, it remains in IN_DELETION state. An entity can always be deleted by setting the invokeHooks parameter to 'false'.
Gets the full defined entity with the unique identifier (URN) including secure fields.
Validates the defined entity against the entity type schema. If the validation is successful, the entity will transition to a "RESOLVED" state. Otherwise, it will transition to an "ERROR" state.
Retrieves all the metadata for the entity. User can view the entries if user can view the entity.
Creates a new entry. This operation is allowed only if the user has at least a read access level to the main entity. Additionally file entries require the user to have the 'Metadata File Entry: Create/Modify' right.
Get a single metadata entry.
Update the value of a single key-value metadata entry.
Delete a single metadata entry.
Download the binary content of a file entry
Gets the collection of defined entities for the vCD-defined type with the specified id. Depending on the requested items per page, and the number of returned entities, one or more metadata summary cursor links will be returned in the headers. In order to retrieve the summaries of all the entities, clients need to fetch each separate cursor and merge the results.
Gets the collection of defined entities for the vCD-defined type with the specified vendor, nss and version. The version can act as a wildcard. If only '1' is specified as the version, all entity types with a major version of '1' will be matched (e.g. 1.0.0, 1.1.2). If '1.0' is specified, all entity types with a major version of '1' and a minor version of '0' will be included (e.g. 1.0.0, 1.0.1). If the full semver is specified, then no search will be performed. Depending on the requested items per page, and the number of returned entities, one or more metadata summary cursor links will be returned in the headers. In order to retrieve the summaries of all the entities, clients need to fetch each separate cursor and merge the results.
Gets the collection of defined entities for the vCD-defined type with the specified vendor and nss without restrictions on the version.
Gets the collection of defined entities for the vCD-defined interface with the specified vendor, nss and version. The version can act as a wildcard. If only '1' is specified as the version, all entity types with a major version of '1' will be matched (e.g. 1.0.0, 1.1.2). If '1.0' is specified, all entity types with a major version of '1' and a minor version of '0' will be included (e.g. 1.0.0, 1.0.1). If the full semver is specified, then no search will be performed. Depending on the requested items per page, and the number of returned entities, one or more metadata summary cursor links will be returned in the headers. In order to retrieve the summaries of all the entities, clients need to fetch each separate cursor and merge the results.
Gets the collection of defined entities for the vCD-defined interface with the specified id. Depending on the requested items per page, and the number of returned entities, one or more metadata summary cursor links will be returned in the headers. In order to retrieve the summaries of all the entities, clients need to fetch each separate cursor and merge the results.
Gets the collection of entity types defined in the vCD instance. Allows collection refinement through traditional FIQL-based filtering
Gets the entity type with the unique identifier (URN)
Gets the collection of interfaces defined in the vCD instance. Allows collection refinement through traditional FIQL-based filtering
Gets the interface with the unique identifier (URN)
Retrieve the Behaviors of the specified Defined Entity Type.
Retrieve a specific Behavior in the Defined Type. The Behavior must be specified by ID.
Gets the access control configuration of the entity type's behaviors
Adds an access control configuration of an entity type's behavior
Sets the access control configuration of the entity type's behaviors
Retrieve the Behaviors of the specified Defined Interface.
Retrieve a specific Behavior in the specified Defined Interface.
Invokes a static behavior defined in the specified interface. The contract of the behavior is specified in the behavior description. If an Activity behavior is invoked with an 'operationId' in the invocation metadata, then another invocation of the behavior with the same 'operationId' will be ignored within the next 1 hour.
Download the execution log from a behavior invocation
Invokes a behavior on a defined entity. The contract of the behavior is specified in the behavior description. If an Activity behavior is invoked with an 'operationId' in the invocation metadata, then another invocation of the behavior with the same 'operationId' will be ignored within the next 1 hour.
Download the execution log from a behavior invocation
Looks up a service account identified by the specified user code for processing its authorization request
Grants access to service account identified by the specified user code. Subsequent polling by the device will result in access token to be transmitted as per device code flow specification
A device's request for access on behalf of a service account, as identified by the specified user code, is denied
Get specified entity object
Get a list of groups.
Create a new group.
Get a specified group.
Modify details of the specified group.
Delete the specified group.
Get a list of users of any type that belong to the specified group.
Tests that custom LDAP settings are valid, and that the system can use them to search for a user or group
Begins the LDAP sync task
Searches LDAP for given user(s)
Searches LDAP for given group(s)
Get all the Namespace summaries of Namespaces created through Tenant Manager
Retrieves the specified namespace
Get configured notification settings.
Updates notification settings.
Get list of all orgs accessible to the user.
Get specified organization.
Updates an organization. If the managedBy field is being updated, the operation is asynchronous and a task is returned in the location header. Otherwise, the operation is synchronous.
Get all organization settings accessible to the user.
Updates the organization settings accessible to the user.
Query user preferences for the logged in user with sorting, paging, and filtering support.
Get specified user preference.
Update specified user preference
Query user preferences for a specific user
Get a preference for a specific user.
Update a preference for a specific user.
Retrieves all the Regions.
Retrieves a region with the given ID.
Get list of rights
Retrieves the requested Right by id.
Get list of Rights Categories
Retrieves the requested Rights Category by id.
Get list of roles for a tenant
Creates a new role
Get specified role
Update specified role
Delete specified role
Get list of rights (as references) contained by a particular role
Adds the list of rights (passed as references) to a role.
Replaces the existing set of rights in role with the rights (as references) supplied.
Get a list of all service accounts.
Retrieves a specific service account
Updates a service account
Deletes a service account
Revokes the token associated with given service account URN, invalidates any existing sessions.
Transfer ownership of this user's owned entities (vApps, media, etc) to the caller.
List all sessions for current user
Logs in a user
Returns the specified session for current user
Logs out the current user
Returns the specified session for the authorization token
Logs out and terminates the current session identified by credentials supplied using the Authorization header
Returns the rights associated with the current session.
Retrieves a list of Org-scoped storage classes. If no Org context is supplied then all available storage classes are retrieved. Results can be filtered by id, name, and region.
Retrieves a specific storage class via URN.
Tests a connection, including SSL handshake and hostname verification.
Retrieve tokens
Retrieves a specific token
Update a token
Delete a specific token. Use this to revoke the current token in case of a leak.
Get currently trusted certificates
Add to list of currently trusted certificates
Get the PEM-encoded certificate with the requested URN
Updates an existing trusted certificate
Revoke trusting specified certificate
Get the access-control list for the specified vCD entity type.
Creates an access-control grant, giving the user the level of access for the vCD entity type.
Get the specified access-control grant.
Updates the specified access-control grant.
Removes the specified access-control grant from the vCD entity type access-control list.
Get a list of all UI Extensions
Get a list of users.
Create a new user.
Get a specified user by id.
Modify basic details of the specified user.
Delete the specified user.
Get a list of references of groups that the user with the given id belongs to.
Adds a list of group references that the user with the given id belongs to. This endpoint allows for the group membership info to be pre-populated before a user logs in for the first time.
Modify an existing user's own password
Transfer ownership of this user's owned entities (vApps, media, etc) to the caller.
Get the list of Virtual Machine Classes
Retrieves the specified virtualMachineClass
Get the paginated list of reserved Virtual Machine Classes
Create a WebMKS ticket allowing to open a VM console in a browser.
Retrieves all zones known to Tenant Manager.
Retrieves a Zone.