vCloud Director REST API Admin Operations

Admin Operations


Admin Operations (160)

Operation Description Since
GET /admin/ Retrieve an administrative view of a cloud. 0.9
GET /admin/catalog/{id} Retrieve a catalog. 0.9
PUT /admin/catalog/{id} Update the name or description of a catalog. 0.9
DELETE /admin/catalog/{id} Delete a catalog. 0.9
POST /admin/catalog/{id}/action/publish Publish a catalog. 1.0
POST /admin/catalog/{id}/action/publishToExternalOrganizations Publish a catalog to external orgs. 5.5
POST /admin/catalog/{id}/action/subscribeToExternalCatalog Subscribe to an external catalog. 5.5
GET /admin/catalog/{id}/metadata Retrieve metadata associated with the catalog. 1.5
POST /admin/catalog/{id}/metadata Merge the metadata provided in the request with existing metadata. 1.5
GET /admin/catalog/{id}/metadata/{domain}/{key} Retrieve the value of the specified key in the specified domain from catalog metadata. 5.1
PUT /admin/catalog/{id}/metadata/{domain}/{key} Set the value for the specified metadata key in the specified domain to the value provided, overwriting any existing value. 5.1
DELETE /admin/catalog/{id}/metadata/{domain}/{key} Delete the specified key in the specified domain and its value from catalog metadata. 5.1
GET /admin/catalog/{id}/metadata/{key} Retrieve the value of the specified key from catalog metadata. 1.5
PUT /admin/catalog/{id}/metadata/{key} Set the value for the specified metadata key to the value provided, overwriting any existing value. 1.5
DELETE /admin/catalog/{id}/metadata/{key} Delete the specified key and its value from catalog metadata. 1.5
GET /admin/catalog/{id}/owner Retrieve the owner of a catalog. 1.5
PUT /admin/catalog/{id}/owner Update the owner of a catalog. 1.5
GET /admin/edgeGateway/{id} Retrieve an edge gateway 5.1
PUT /admin/edgeGateway/{id} Update an edge gateway 5.1
DELETE /admin/edgeGateway/{id} Delete an edge gateway. 5.1
POST /admin/edgeGateway/{id}/action/configureServices Update edgeGateway configuration. 5.1
POST /admin/edgeGateway/{id}/action/reapplyServices Reapply services on an edgeGateway. 5.1
POST /admin/edgeGateway/{id}/action/redeploy Redeploy edgeGateway. 5.1
POST /admin/edgeGateway/{id}/action/syncSyslogServerSettings Synchronize syslog server settings on an edgeGateway. 5.1
POST /admin/edgeGateway/{id}/action/upgradeConfig Upgrade edgeGateway configuration from compact to full. 5.1
GET /admin/event/{id} Returns event with specified ID. 5.6
GET /admin/group/{id} Retrieve a group. 0.9
PUT /admin/group/{id} Update the name or description of a group. 0.9
DELETE /admin/group/{id} Deletes a group. 0.9
GET /admin/groups/query Retrieves a list of groups for organization the org admin belongs to by using REST API general QueryHandler; If filter is provided it will be applied to the corresponding result set. 1.5
GET /admin/network/{id} Retrieve an administrative view of a network. 0.9
PUT /admin/network/{id} Update an organization network. 5.1
DELETE /admin/network/{id} Delete a network. 0.9
POST /admin/network/{id}/action/reset Reset networking services on a network. 1.5
POST /admin/network/{id}/action/syncSyslogServerSettings Synchronize syslog server settings for a network. 1.5
GET /admin/network/{id}/allocatedAddresses Retrieve the list of IP addresses allocated to the network. 5.1
GET /admin/network/{id}/metadata Retrieve metadata associated with the network. 1.5
POST /admin/network/{id}/metadata Merge the metadata provided in the request with existing metadata. 1.5
GET /admin/network/{id}/metadata/{domain}/{key} Retrieve the value of the specified key in the specified domain from network metadata. 5.1
PUT /admin/network/{id}/metadata/{domain}/{key} Set the value for the specified metadata key in the specified domain to the value provided, overwriting any existing value. 5.1
DELETE /admin/network/{id}/metadata/{domain}/{key} Delete the specified key in the specified domain and its value from network metadata. 5.1
GET /admin/network/{id}/metadata/{key} Retrieve the value of the specified key from network metadata. 1.5
PUT /admin/network/{id}/metadata/{key} Set the value for the specified metadata key to the value provided, overwriting any existing value. 1.5
DELETE /admin/network/{id}/metadata/{key} Delete the specified key and its value from network metadata. 1.5
GET /admin/org/{id} Retrieve an administrative view of an organization. 0.9
PUT /admin/org/{id} Update an organization network. 0.9
DELETE /admin/org/{id} Delete an organization. 0.9
POST /admin/org/{id}/action/disable Disable an organization. 1.0
POST /admin/org/{id}/action/enable Enable an organization. 1.0
POST /admin/org/{id}/catalogs Create a catalog. 0.9
POST /admin/org/{id}/events Post an external event to the system. 5.1
POST /admin/org/{id}/groups Import a group from the LDAP directory service. 0.9
GET /admin/org/{id}/metadata Retrieve metadata associated with the organization. 1.5
POST /admin/org/{id}/metadata Merge the metadata provided in the request with existing metadata. 1.5
GET /admin/org/{id}/metadata/{domain}/{key} Retrieve the value of the specified key in the specified domain from organization metadata . 5.1
PUT /admin/org/{id}/metadata/{domain}/{key} Set the value for the specified metadata key in the specified domain to the value provided, overwriting any existing value. 5.1
DELETE /admin/org/{id}/metadata/{domain}/{key} Delete the specified key in the specified domain and its value from organization metadata. 5.1
GET /admin/org/{id}/metadata/{key} Retrieve the value of the specified key from organization metadata. 1.5
PUT /admin/org/{id}/metadata/{key} Set the value for the specified metadata key to the value provided, overwriting any existing value. 1.5
DELETE /admin/org/{id}/metadata/{key} Delete the specified key and its value from organization metadata. 1.5
POST /admin/org/{id}/networks Create an organization network. 0.9
GET /admin/org/{id}/settings Retrieve settings for this organization.
PUT /admin/org/{id}/settings Updates settings for this organization.
GET /admin/org/{id}/settings/email Retrieve organization email settings. 1.5
PUT /admin/org/{id}/settings/email Update organization email settings. 1.5
GET /admin/org/{id}/settings/federation Retrieve other organization settings. 1.5
PUT /admin/org/{id}/settings/federation Update other organization settings. 1.5
POST /admin/org/{id}/settings/federation/action/regenerateFederationCertificate Regenerates the certificates used to establish trust between an organization and its identity provider 5.6
GET /admin/org/{id}/settings/general Retrieve other organization settings. 1.5
PUT /admin/org/{id}/settings/general Update other organization settings. 1.5
GET /admin/org/{id}/settings/guestPersonalizationSettings Retrieve organization defaults for guest personalization settings. 5.1
PUT /admin/org/{id}/settings/guestPersonalizationSettings Update organization defaults for guest personalization settings. 5.1
GET /admin/org/{id}/settings/ldap Retrieve organization LDAP settings. 1.5
PUT /admin/org/{id}/settings/ldap Update organization LDAP settings. 1.5
POST /admin/org/{id}/settings/ldap/action/resetLdapCertificate Resets organization LDAP SSL certificate. 5.1
POST /admin/org/{id}/settings/ldap/action/resetLdapKeyStore Resets organization LDAP keystore. 5.1
POST /admin/org/{id}/settings/ldap/action/resetLdapSspiKeytab Resets organization LDAP SSPI keytab. 5.1
POST /admin/org/{id}/settings/ldap/action/updateLdapCertificate Updates organization LDAP SSL certificate. 5.1
POST /admin/org/{id}/settings/ldap/action/updateLdapKeyStore Updates organization LDAP keystore. 5.1
POST /admin/org/{id}/settings/ldap/action/updateLdapSspiKeytab Updates organization LDAP SSPI keytab. 5.1
GET /admin/org/{id}/settings/operationLimitsSettings Retrieve organization defaults for guest personalization settings. 5.1
PUT /admin/org/{id}/settings/operationLimitsSettings Update organization operation limits settings.
GET /admin/org/{id}/settings/passwordPolicy Retrieve organization password policy settings. 1.5
PUT /admin/org/{id}/settings/passwordPolicy Update organization password policy settings. 1.5
GET /admin/org/{id}/settings/vAppLeaseSettings Retrieve organization vApp lease settings. 1.5
PUT /admin/org/{id}/settings/vAppLeaseSettings Update organization vApp lease settings. 1.5
GET /admin/org/{id}/settings/vAppTemplateLeaseSettings Retrieve organization vApp template lease settings. 1.5
PUT /admin/org/{id}/settings/vAppTemplateLeaseSettings Update organization vApp template lease settings. 1.5
POST /admin/org/{id}/users Create or import a user. 0.9
POST /admin/org/{id}/vdcs Create an organization VDC. 0.9
POST /admin/org/{id}/vdcsparams Creates an organization vDC. 5.1
POST /admin/orgs Create an organization. 0.9
GET /admin/orgs/query Retrieves a list of organizations by using REST API general QueryHandler; If filter is provided it will be applied to the corresponding result set. 1.5
GET /admin/providervdc/{id} Retrieve a provider vDC. 0.9
GET /admin/providervdc/{id}/metadata Retrieve metadata associated with the provider vDC. 1.5
POST /admin/providervdc/{id}/metadata Merge the metadata provided in the request with existing metadata. 1.5
GET /admin/providervdc/{id}/metadata/{domain}/{key} Retrieve the value of the specified key in the specified domain from provider vDC metadata. 5.1
PUT /admin/providervdc/{id}/metadata/{domain}/{key} Set the value for the specified metadata key in the specified domain to the value provided, overwriting any existing value. 5.1
DELETE /admin/providervdc/{id}/metadata/{domain}/{key} Delete the specified key in the specified domain and its value from provider vDC metadata. 5.1
GET /admin/providervdc/{id}/metadata/{key} Retrieve the value of the specified key from provider vDC metadata. 1.5
PUT /admin/providervdc/{id}/metadata/{key} Set the value for the specified metadata key to the value provided, overwriting any existing value. 1.5
DELETE /admin/providervdc/{id}/metadata/{key} Delete the specified key and its value from provider vDC metadata. 1.5
GET /admin/providervdc/{id}/vdcReferences Retrieve a list of organization vDCs supported by a given provider vDC. 1.0
GET /admin/pvdcStorageProfile/{id} Retrieve provider vDC storage profile details.
GET /admin/pvdcStorageProfile/{id}/metadata Retrieve metadata associated with the Provider VDC Storage Profile. 5.1
POST /admin/pvdcStorageProfile/{id}/metadata Merge the metadata provided in the request with existing metadata.
GET /admin/pvdcStorageProfile/{id}/metadata/{domain}/{key} Retrieve the value of the specified key from Provider VDC Storage Profile metadata. 5.1
PUT /admin/pvdcStorageProfile/{id}/metadata/{domain}/{key} Set the value for the specified metadata key to the value provided, overwriting any existing value.
DELETE /admin/pvdcStorageProfile/{id}/metadata/{domain}/{key} Delete the specified key and its value from Provider VDC Storage Profile metadata.
GET /admin/pvdcStorageProfile/{id}/metadata/{key} Retrieve the value of the specified key from Provider VDC Storage Profile metadata.
PUT /admin/pvdcStorageProfile/{id}/metadata/{key} Set the value for the specified metadata key to the value provided, overwriting any existing value.
DELETE /admin/pvdcStorageProfile/{id}/metadata/{key} Delete the specified key and its value from Provider VDC Storage Profile metadata.
GET /admin/right/{id} Retrieves a right. 0.9
PUT /admin/right/{id} Updates a right. 5.1
DELETE /admin/right/{id} Deletes a right. 5.1
GET /admin/rights/query Retrieves a list of rights in the cloud by using REST API general QueryHandler; If filter is provided it will be applied to the corresponding result set. 1.5
GET /admin/role/{id} Retrieve a role. 0.9
PUT /admin/role/{id} Update a role. 0.9
DELETE /admin/role/{id} Delete a role. 0.9
POST /admin/roles Creates a role. 0.9
GET /admin/roles/query Retrieves a list of roles in the cloud by using REST API general QueryHandler; If filter is provided it will be applied to the corresponding result set. 1.5
GET /admin/strandedUsers/query Retrieves a list of stranded users by using REST API general QueryHandler. 1.5
GET /admin/user/{id} Retrieve a user. 0.9
PUT /admin/user/{id} Update a user. 0.9
DELETE /admin/user/{id} Delete a user. 0.9
POST /admin/user/{id}/action/takeOwnership Transfer ownership of this user's vApps, media, and catalogs to the caller. 5.6
POST /admin/user/{id}/action/unlock Unlock a user. 1.5
POST /admin/user/{id}/entityRights Queries user privileges on a set of entities 5.1
GET /admin/user/{id}/grantedRights Queries user granted privileges 5.1
GET /admin/users/query Retrieves a list of users for organization the org admin belongs to by using REST API general QueryHandler; If filter is provided it will be applied to the corresponding result set. 1.5
GET /admin/vdc/{id} Retrieve the admin view of an organization vDC. 0.9
PUT /admin/vdc/{id} Modify an organization vDC. 0.9
DELETE /admin/vdc/{id} Delete an organization vDC. 0.9
POST /admin/vdc/{id}/action/disable Disable an organization vDC. 1.0
POST /admin/vdc/{id}/action/enable Enable an organization vDC. 1.0
POST /admin/vdc/{id}/action/registerVApp Create a vApp based on a set of .vmx files and resource mappings 5.5
GET /admin/vdc/{id}/edgeGateways List all gateways for this Org vDC. 5.1
POST /admin/vdc/{id}/edgeGateways Create an edge gateway. 5.1
GET /admin/vdc/{id}/metadata Retrieve metadata associated with the virtual datacenter. 1.5
POST /admin/vdc/{id}/metadata Merge the metadata provided in the request with existing metadata. 1.5
GET /admin/vdc/{id}/metadata/{domain}/{key} Retrieve the value of the specified key in the specified domain from virtual datacenter metadata. 5.1
PUT /admin/vdc/{id}/metadata/{domain}/{key} Set the value for the specified metadata key in the specified domain to the value provided, overwriting any existing value. 5.1
DELETE /admin/vdc/{id}/metadata/{domain}/{key} Delete the specified key in the specified domain and its value from virtual datacenter metadata. 5.1
GET /admin/vdc/{id}/metadata/{key} Retrieve the value of the specified key from virtual datacenter metadata. 1.5
PUT /admin/vdc/{id}/metadata/{key} Set the value for the specified metadata key to the value provided, overwriting any existing value. 1.5
DELETE /admin/vdc/{id}/metadata/{key} Delete the specified key and its value from virtual datacenter metadata. 1.5
GET /admin/vdc/{id}/networks List all networks for this Org vDC. 5.1
POST /admin/vdc/{id}/networks Create an Org vDC network. 5.1
POST /admin/vdc/{id}/vdcStorageProfiles Add or remove virtual datacenter storage classes.
GET /admin/vdcStorageProfile/{id} Returns the representation of a vDC storage profile
PUT /admin/vdcStorageProfile/{id} Updates a single storage profile with user supplied data
GET /admin/vdcStorageProfile/{id}/metadata Retrieve metadata associated with the vDC storage profile.
POST /admin/vdcStorageProfile/{id}/metadata Merge the metadata provided in the request with existing metadata.
GET /admin/vdcStorageProfile/{id}/metadata/{domain}/{key} Retrieve the value of the specified key from vDC storage profile metadata.
PUT /admin/vdcStorageProfile/{id}/metadata/{domain}/{key} Set the value for the specified metadata key to the value provided, overwriting any existing value.
DELETE /admin/vdcStorageProfile/{id}/metadata/{domain}/{key} Delete the specified key and its value from vDC storage profile metadata.
GET /admin/vdcStorageProfile/{id}/metadata/{key} Retrieve the value of the specified key from vDC storage profile metadata.
PUT /admin/vdcStorageProfile/{id}/metadata/{key} Set the value for the specified metadata key to the value provided, overwriting any existing value.
DELETE /admin/vdcStorageProfile/{id}/metadata/{key} Delete the specified key and its value from vDC storage profile metadata.
GET /admin/vdcs/query Retrieves a list of vdcs in the organization; If filter is provided it will be applied to the corresponding result set. 1.5