vCloud REST API Admin Operations

Admin Operations


Admin Operations (88)

Operation Description Since
GET /admin/ Retrieves the top level entity for the Admin API. 0.9
GET /admin/catalog/{id} Retrieves a catalog. 0.9
PUT /admin/catalog/{id} Modifies a catalog. 0.9
DELETE /admin/catalog/{id} Deletes a catalog. 0.9
POST /admin/catalog/{id}/action/publish Publish a catalog. 1.0
GET /admin/catalog/{id}/metadata Returns the metadata associated with the catalog. 1.5
POST /admin/catalog/{id}/metadata Merges the metadata for a catalog with the information provided. 1.5
GET /admin/catalog/{id}/metadata/{key} Returns the metadata associated with the catalog for the specified key. 1.5
PUT /admin/catalog/{id}/metadata/{key} Sets the metadata for the particular key for the catalog to the value provided. 1.5
DELETE /admin/catalog/{id}/metadata/{key} Deletes the metadata for the particular key for the catalog 1.5
GET /admin/catalog/{id}/owner Returns owner of a catalog. 1.5
PUT /admin/catalog/{id}/owner Changes owner for catalog. 1.5
GET /admin/group/{id} Retrieves a group. 0.9
PUT /admin/group/{id} Modifies 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} Gets admin representation of network. 0.9
PUT /admin/network/{id} Modifies an org network. 0.9
DELETE /admin/network/{id} Deletes a network. 0.9
POST /admin/network/{id}/action/reset Reset(undeploy & redeploy) networking services on a logical network. 1.5
POST /admin/network/{id}/action/syncSyslogServerSettings Synchronize syslog server settings of a logical network with system defaults Synchronize operation can be performed on: - routed organization network - routed/fenced vApp networks 1.5
GET /admin/network/{id}/metadata Returns the metadata associated with the network. 1.5
POST /admin/network/{id}/metadata Merges the metadata for a network with the information provided. 1.5
GET /admin/network/{id}/metadata/{key} Returns the metadata associated with the network for the specified key. 1.5
PUT /admin/network/{id}/metadata/{key} Sets the metadata for the particular key for the network to the value provided. 1.5
DELETE /admin/network/{id}/metadata/{key} Deletes the metadata for the particular key for the network 1.5
GET /admin/org/{id} Retrieves an admin view of an organization. 0.9
PUT /admin/org/{id} Modifies an admin organization. 0.9
DELETE /admin/org/{id} Deletes an admin organization. 0.9
POST /admin/org/{id}/action/disable Disables an organization. 1.0
POST /admin/org/{id}/action/enable Enables an admin organization If the organization was disabled this action enables it. 1.0
POST /admin/org/{id}/catalogs Creates a catalog in an organization. 0.9
POST /admin/org/{id}/groups Imports a group in an organization. 0.9
GET /admin/org/{id}/metadata Returns the metadata associated with the organization. 1.5
POST /admin/org/{id}/metadata Merges the metadata for a organization with the information provided. 1.5
GET /admin/org/{id}/metadata/{key} Returns the metadata associated with the organization for the specified key. 1.5
PUT /admin/org/{id}/metadata/{key} Sets the metadata for the particular key for the organization to the value provided. 1.5
DELETE /admin/org/{id}/metadata/{key} Deletes the metadata for the particular key for the organization 1.5
POST /admin/org/{id}/networks Creates a network in an organization. 0.9
GET /admin/org/{id}/settings Gets organizational settings for this organization.
PUT /admin/org/{id}/settings Updates organizational settings for this organization.
GET /admin/org/{id}/settings/email Retrieves email settings for an organization. 1.5
PUT /admin/org/{id}/settings/email Updates email policy settings for organization. 1.5
GET /admin/org/{id}/settings/general Gets general organization settings. 1.5
PUT /admin/org/{id}/settings/general Updates general organization settings. 1.5
GET /admin/org/{id}/settings/ldap Retrieves LDAP settings for an organization. 1.5
PUT /admin/org/{id}/settings/ldap Updates LDAP settings for an organization. 1.5
GET /admin/org/{id}/settings/passwordPolicy Retrieves password policy settings for an organization. 1.5
PUT /admin/org/{id}/settings/passwordPolicy Updates password policy settings for organization. 1.5
GET /admin/org/{id}/settings/vAppLeaseSettings Gets organization resource cleanup settings on the level of vApp. 1.5
PUT /admin/org/{id}/settings/vAppLeaseSettings Updates organization resource cleanup settings on the level of vApp. 1.5
GET /admin/org/{id}/settings/vAppTemplateLeaseSettings Retrieves expiration and storage policy for vApp templates in an organization. 1.5
PUT /admin/org/{id}/settings/vAppTemplateLeaseSettings Updates vApp template policy settings for organization. 1.5
POST /admin/org/{id}/users Creates or imports a user in an organization. 0.9
POST /admin/org/{id}/vdcs Creates a virtual data center in an organization. 0.9
POST /admin/orgs Creates 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} Get the representation of the Provider VDC. 0.9
GET /admin/providervdc/{id}/metadata Returns the metadata associated with the provider vDC. 1.5
POST /admin/providervdc/{id}/metadata Merges the metadata for a provider vDC with the information provided. 1.5
GET /admin/providervdc/{id}/metadata/{key} Returns the metadata associated with the vDC for the specified key. 1.5
PUT /admin/providervdc/{id}/metadata/{key} Sets the metadata for the particular key for the provider vDC to the value provided. 1.5
DELETE /admin/providervdc/{id}/metadata/{key} Deletes the metadata for the particular key for the provider vDC 1.5
GET /admin/providervdc/{id}/vdcReferences Retrieves all org vDCs for given provider vDC. 1.0
GET /admin/right/{id} Retrieves a right. 0.9
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} Retrieves a role. 0.9
PUT /admin/role/{id} Modifies a role. 0.9
DELETE /admin/role/{id} Deletes 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 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/user/{id} Retrieves a user. 0.9
PUT /admin/user/{id} Modifies a user. 0.9
DELETE /admin/user/{id} Deletes a user. 0.9
POST /admin/user/{id}/action/unlock Unlocks a user. 1.5
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} Retrieves an admin view of virtual data center. 0.9
PUT /admin/vdc/{id} Modifies a Virtual Data Center. 0.9
DELETE /admin/vdc/{id} Deletes a Virtual Data Center. 0.9
POST /admin/vdc/{id}/action/disable Disables a Virtual Data Center. 1.0
POST /admin/vdc/{id}/action/enable Enables a Virtual Data Center. 1.0
GET /admin/vdc/{id}/metadata Returns the metadata associated with the vDC. 1.5
POST /admin/vdc/{id}/metadata Merges the metadata for a vDC with the information provided. 1.5
GET /admin/vdc/{id}/metadata/{key} Returns the metadata associated with the vDC for the specified key. 1.5
PUT /admin/vdc/{id}/metadata/{key} Sets the metadata for the particular key for the vDC to the value provided. 1.5
DELETE /admin/vdc/{id}/metadata/{key} Deletes the metadata for the particular key for the vDC 1.5
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