/vcd
v1 Endpoints
REST Endpoint |
Description |
GraphQL Query | CDM Availability |
|---|---|---|---|
| GET /vcd/cluster | Retrieve summary information for all vCD cluster objects. | query vcdClusters | Available |
| POST /vcd/cluster | Create a vCD Cluster object by providing the address of the vCD Cluster and the credentials for an account on the vCD Cluster that has administrator privileges. This request initiates an asynchronous job to connect with the vCD Cluster and retrieve the required metadata. | mutation addVcdInstances | Available |
| GET /vcd/cluster/request/{id} | Retrieve the details of a specified asynchronous job for a vCD Cluster. | Available | |
| GET /vcd/cluster/{id} | Retrieve detailed information for a vCD Cluster object. | query vcdClusters -> vcdClusterSummary | Available |
| PATCH /vcd/cluster/{id} | Modify the hostname and credentials of a specified vCD Cluster object. | mutation updateVcdInstances | Available |
| DELETE /vcd/cluster/{id} | Start an asynchronous job to remove a vCD Cluster object. | mutation deleteVcdInstances | Restricted |
| POST /vcd/cluster/{id}/refresh | Start an asynchronous job to refresh the metadata for a specified vCD Cluster object. | mutation refreshVcdInstances | Available |
| GET /vcd/cluster/{id}/vimserver | Retrieves the VimServer representation of the vCenter Servers that are attached to a specified vCD Cluster object. | query vcdVimServer | Available |
| GET /vcd/hierarchy/{id} | Retrieve details for the specified object in the vCD hierarchy. | Available | |
| GET /vcd/hierarchy/{id}/children | Retrieve the list of immediate descendant objects for the specified parent. | Available | |
| GET /vcd/hierarchy/{id}/descendants | Retrieve the list of descendant objects for the specified parent. | Available | |
| GET /vcd/vapp | Retrieve summary information for all vCD vApp objects. | query vcdVapps | Available |
| GET /vcd/vapp/request/{id} | Retrieve the details of a specified asynchronous job for a vApp. | Available | |
| GET /vcd/vapp/snapshot/{id} | Retrieve detailed information about a specified snapshot for a vApp object. | mutation deleteVappSnapshots | Available |
| DELETE /vcd/vapp/snapshot/{id} | Designate a vApp snapshot as expired and available for garbage collection. The snapshot must be an on-demand snapshot or a snapshot from a vApp that is not assigned to an SLA Domain. | Restricted | |
| POST /vcd/vapp/snapshot/{id}/download | Provides a method for retrieving a snapshot that is not available locally, from an archival location. | Available | |
| POST /vcd/vapp/snapshot/{snapshot_id}/export | Export the specified vApp snapshot into a new vApp or an existing vApp. | mutation createVappExport | Available |
| GET /vcd/vapp/snapshot/{snapshot_id}/export/options | Retrieve summary information for the vApp networks that are available for network connections from the virtual machines in the exported vApp snapshot. The summary also specifies the default vApp network for each virtual machine network connection. | query vappSnapshotExportOptions | Available |
| POST /vcd/vapp/snapshot/{snapshot_id}/instant_recover | Use Instant Recovery to recover specified vApp virtual machines. | mutation createVappsInstantRecovery | Available |
| GET /vcd/vapp/snapshot/{snapshot_id}/instant_recover/options | Retrieve the available vApp network connections and the default vApp network connection for the virtual machines in a vApp snapshot. Use this information to configure an Instant Recovery of specified virtual machines in the vApp snapshot. | query vappSnapshotInstantRecoveryOptions | Available |
| POST /vcd/vapp/snapshot/{snapshot_id}/{location_id}/download | Initiates a job to download a snapshot from the specified location when the snapshot does not exist locally. The specified location has to be a replication target connected to this Rubrik cluster. If an SLA Domain is not provided, the snapshot will be retained forever. | Available | |
| POST /vcd/vapp/template/snapshot/{snapshot_id}/export | Export a vApp template snapashot to a catalog. Use the options endpoint to confirm that exporting to the catalog defaults or the original organization vDC storage profile is possible. | mutation createVappExport | Available |
| GET /vcd/vapp/template/snapshot/{snapshot_id}/export/options | Retrieve the available choices vApp template storage profile and organization vDC choices in case of exporting to either original organization vDC defaults of the target catalog. In case advanced option of manually deciding org vdc is preferred, this also provides available storage profile choices. | query vappSnapshotExportOptions | Available |
| GET /vcd/vapp/{id} | Retrieve detailed information for a specified vApp. | query vcdVapp | Available |
| PATCH /vcd/vapp/{id} | Make changes to the parameters of a specified vApp object. | mutation updateVcdVapp | Available |
| GET /vcd/vapp/{id}/missed_snapshot | Retrieve the timestamp for each missed snapshot for a specified vApp. | query missedSnapshotGroupByConnection | Available |
| GET /vcd/vapp/{id}/search | Aggregated search for a file through snapshots of all virtual machines that are presently part of the vApp. Specify the file using a full path prefix or a filename prefix. | query searchVappFiles | Available |
| GET /vcd/vapp/{id}/snapshot | Retrieve summary information for each of the snapshot objects of a specified vApp object. | query snapshotGroupBySummary | Available |
| POST /vcd/vapp/{id}/snapshot | Start an asynchronous job to create an on-demand snapshot for a specified vApp object. | mutation createVappSnapshots | Available |
| DELETE /vcd/vapp/{id}/snapshot | Delete all snapshots for a specified vApp object. | mutation deleteVappSnapshots | Restricted |