VMware Cloud Director API Admin Operations
VMware Cloud Director API Admin Operations
Admin Operations
Admin Operations (243)
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, description storage profiles and distributed catalog settings of a catalog. | 0.9 |
DELETE /admin/catalog/{id} | Delete a catalog. | |
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}/extension | Displays a list of Selector Extensions that are associated with a selector. | 16.0 |
POST /admin/catalog/{id}/extension | Creates a Selector Extension. | 16.0 |
GET /admin/catalog/{id}/extension/{selectorExtensionId} | Retrieves a Selector Extension. | 16.0 |
PUT /admin/catalog/{id}/extension/{selectorExtensionId} | Updates a Selector Extension. | 16.0 |
DELETE /admin/catalog/{id}/extension/{selectorExtensionId} | Deletes a Selector Extension. | 16.0 |
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/catalogs/extension | Displays a list of Selector Extensions that are associated with a selector. | 16.0 |
POST /admin/catalogs/extension | Creates a Selector Extension. | 16.0 |
GET /admin/catalogs/extension/{selectorExtensionId} | Retrieves a Selector Extension. | 16.0 |
PUT /admin/catalogs/extension/{selectorExtensionId} | Updates a Selector Extension. | 16.0 |
DELETE /admin/catalogs/extension/{selectorExtensionId} | Deletes a Selector Extension. | 16.0 |
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/configureSyslogServerSettings | Configure Syslog server settings for the org vdc edge gateway | 5.11 |
POST /admin/edgeGateway/{id}/action/convertToAdvancedGateway | Mark a gateway as an advanced gateway. | 27.0 |
POST /admin/edgeGateway/{id}/action/disableDistributedRouting | Disable distributed routing for a gateway | 29.0 |
POST /admin/edgeGateway/{id}/action/enableDistributedRouting | Enable distributed routing for a gateway | 29.0 |
POST /admin/edgeGateway/{id}/action/modifyFormFactor | Modify edgeGateway form factor. | 11.0 |
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 |
PUT /admin/edgeGateway/{id}/action/updateProperties | Update just the properties of an edge gateway (such as name, HA, IP Allocations, etc). | |
POST /admin/edgeGateway/{id}/action/upgradeConfig | Upgrades the edge gateway appliance size. | 5.1 |
GET /admin/edgeGateway/{id}/metadata | Retrieve metadata associated with the gateway. | 35.0 |
POST /admin/edgeGateway/{id}/metadata | Sets all the metadata for the specified gateway. | 35.0 |
GET /admin/edgeGateway/{id}/metadata/{domain}/{key} | Retrieve the value of the specified key in the specified domain from gateway metadata. | 35.0 |
PUT /admin/edgeGateway/{id}/metadata/{domain}/{key} | Set the value for the specified metadata key in the specified domain to the value provided, overwriting any existing value. | 35.0 |
DELETE /admin/edgeGateway/{id}/metadata/{domain}/{key} | Delete the specified key in the specified domain and its value from gateway metadata. | 35.0 |
GET /admin/edgeGateway/{id}/metadata/{key} | Retrieve the value of the specified key from gateway metadata. | 35.0 |
PUT /admin/edgeGateway/{id}/metadata/{key} | Set the value for the specified metadata key to the value provided, overwriting any existing value. | 35.0 |
DELETE /admin/edgeGateway/{id}/metadata/{key} | Delete the specified key and its value from gateway metadata. | 35.0 |
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/convertToDistributedInterface | Convert org vdc network to a distributed interface This operation is valid for internal org vdc routed networks that are subinterfaces or internal. |
29.0 |
POST /admin/network/{id}/action/convertToInternalInterface | Convert org vdc network to an interface This operation is valid for internal org vdc routed networks that are subinterfaces |
27.0 |
POST /admin/network/{id}/action/convertToSubInterface | Convert org vdc network to an sub interface This operation is valid for internal org vdc routed networks |
27.0 |
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. | 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 |
GET /admin/org/{id}/associations | Retrieves the complete list of Organizations associated with this organization | 29.0 |
POST /admin/org/{id}/associations | Adds a new member to this organization's associations | 29.0 |
PUT /admin/org/{id}/associations | Replaces the organization's current list of association members with the specified list of members If the list is empty, all existing members will be deleted. |
29.0 |
GET /admin/org/{id}/associations/localAssociationData | Gets the associaiton data for a given local org. | |
POST /admin/org/{id}/associations/localAssociationData/action/regenerateKeyPair | Regenerates an org's key pair for associations | |
GET /admin/org/{id}/associations/{remoteSiteId}/{remoteOrgId} | Retrieves a specific member from the organization's associations as identified by identifier included in the request | 29.0 |
PUT /admin/org/{id}/associations/{remoteSiteId}/{remoteOrgId} | Update an organization association | 29.0 |
DELETE /admin/org/{id}/associations/{remoteSiteId}/{remoteOrgId} | Removes the specified member from this organization's associations. | 29.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 |
GET /admin/org/{id}/extension | Displays a list of Selector Extensions that are associated with a selector. | 16.0 |
POST /admin/org/{id}/extension | Creates a Selector Extension. | 16.0 |
GET /admin/org/{id}/extension/{selectorExtensionId} | Retrieves a Selector Extension. | 16.0 |
PUT /admin/org/{id}/extension/{selectorExtensionId} | Updates a Selector Extension. | 16.0 |
DELETE /admin/org/{id}/extension/{selectorExtensionId} | Deletes a Selector Extension. | 16.0 |
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 |
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 |
GET /admin/org/{id}/settings/oauth | Retrieve organization OAuth settings. | |
PUT /admin/org/{id}/settings/oauth | Update organization OAuth settings. | |
DELETE /admin/org/{id}/settings/oauth | Remove OAuth settings from an organization. | 32.0 |
POST /admin/org/{id}/settings/oauth/openIdProviderConfig | Reads an OpenID configuring from a well-known endpoint and responds with the raw information from the IDP as well as VCD's interpretation of that information. | 36.0 |
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 |
POST /admin/org/{id}/settings/vAppLeaseSettings/action/expireVAppsRuntimeLease | ||
POST /admin/org/{id}/settings/vAppLeaseSettings/action/expireVAppsStorageLease | ||
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}/settings/vAppTemplateLeaseSettings/action/expireVAppTemplatesStorageLease | ||
POST /admin/org/{id}/users | Create or import a user. | 0.9 |
POST /admin/org/{id}/vdcsparams | Creates an organization vDC. | 5.1 |
GET /admin/org/{orgId}/right/{id} | Retrieves right in the context of an organization | |
DELETE /admin/org/{orgId}/right/{id} | Unlink a right from an organization | |
GET /admin/org/{orgId}/rights | Retrieve rights for an organization | |
POST /admin/org/{orgId}/rights | Add rights to an organization | |
PUT /admin/org/{orgId}/rights | Modify rights for an organization | |
DELETE /admin/org/{orgId}/rights | Remove all rights from an organization | |
GET /admin/org/{orgId}/role/{id} | Retrieve a role. | 0.9 |
PUT /admin/org/{orgId}/role/{id} | Update a role. | 0.9 |
DELETE /admin/org/{orgId}/role/{id} | Delete a role. | 0.9 |
POST /admin/org/{orgId}/roles | Creates a role or optionally creates a role template along with role instances based on the template for a sys-admin client at API version < 27 | 0.9 |
GET /admin/org/{orgId}/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 |
POST /admin/orgs | Create an organization. | 0.9 |
GET /admin/orgs/extension | Displays a list of Selector Extensions that are associated with a selector. | 16.0 |
POST /admin/orgs/extension | Creates a Selector Extension. | 16.0 |
GET /admin/orgs/extension/{selectorExtensionId} | Retrieves a Selector Extension. | 16.0 |