Administrative requests retrieve or update administrative objects such as organizations, users, and VDCs.

API-URL is a URL of the form https://vcloud.example.com/api.

id is a unique identifier in the form of a UUID, as defined by RFC 4122.

Important

Request URLs are always available in Link elements contained by the representation of the object on which they operate. URL forms shown here are for reference purposes only. Although URLs have a well-known syntax and a well-understood interpretation, a client should treat vCloud API request URLs as opaque strings. The rules that govern how the server constructs these strings might change in future releases.

This summary may not cover all requests in this category. For the complete list of requests, along with detailed information about input and output types, see the Operations lists in the schema reference.

Summary of Administrative Requests

Operation

Request

Request Body

Response

Retrieve an administrative view of an organization.

GET API-URL/admin/org/id

None

AdminOrg

Create an organization.

POST API-URL/admin/orgs

AdminOrg

AdminOrg

Enable an organization.

POST API-URL/admin/org/id/action/enable

None

204 No Content

Disable an organization.

POST API-URL/admin/org/id/action/disable

None

204 No Content

Update an organization.

PUT API-URL/admin/org/id

AdminOrg

AdminOrg

Create an Edge Gateway.

POST API-URL/admin/vdc/id/edgeGateways

EdgeGateway

EdgeGateway

Retrieve an Edge Gateway.

GET API-URL/admin/edgeGateway/id

None

EdgeGateway

Update Edge Gateway services.

POST API-URL/admin/edgeGateway/id/action/configureServices

EdgeGatewayServiceConfiguration

Task

Reapply Edge Gateway Services

POST API-URL/admin/edgeGateway/id/action/reapplyServices

None

204 No Content

Redeploy an Edge Gateway

POST API-URL/admin/edgeGateway/id/action/redeploy

None

204 No Content

Delete an Edge Gateway.

DELETE API-URL/admin/edgeGateway/id

None

Task

Create an organization VDC network.

POST API-URL/admin/vdc/id/networks

OrgVdcNetwork

Task

Update an organization VDC network.

PUT API-URL/admin/network/id

OrgVdcNetwork

Task

Retrieve a list of networks in this organization VDC.

GET API-URL/admin/vdc/id/networks

None

QueryResultRecords

Delete an organization VDC network.

DELETE API-URL/admin/network/id

None

Task

Synchronize syslog server settings for a vApp network.

POST API-URL/admin/network/id/action/syncSyslogServerSettings

None

Task

Synchronize syslog server settings for an Edge Gateway.

POST API-URL/admin/edgeGateway/id/action/syncSyslogServerSettings

None

Task

Reset a network.

POST API-URL/admin/network/id/action/reset

None

Task

Retrieve the admin view of a provider VDC.

GET API-URL/admin/providervdc/id

None

ProviderVdc

List the organization VDCs supported by a provider VDC.

GET API-URL/admin/providervdc/id/vdcReferences

None

VdcReferences

Create an organization VDC.

POST API-URL/admin/org/id/vdcs

AdminVdc

AdminVdc

Enable an organization VDC.

POST API-URL/admin/vdc/id/action/enable

None

204 No Content

Disable an organization VDC.

POST API-URL/admin/vdc/id/action/disable

None

204 No Content

Delete an organization VDC.

DELETE API-URL/admin/vdc/id

None

Task

Change the name or description of an existing organization VDC. [NEW]

PUT API-URL/admin/vdc/id

Vdc

Task

Create an organization VDC from a template. [NEW]

POST API-URL/admin/org/id/action/instantiate

InstantiateVdcTemplateParams

Task

Create a catalog.

POST API-URL/admin/org/id/catalogs

AdminCatalog

AdminCatalog

Share a catalog with all organizations in your cloud.

POST API-URL/admin/catalog/id/action/publish

PublishCatalogParams

204 No Content

Update catalog properties.

PUT API-URL/admin/catalog/id

AdminCatalog

AdminCatalog

Delete a catalog.

DELETE API-URL/admin/catalog/id

None

204 No Content

Update the owner of a catalog.

PUT API-URL/admin/catalog/id/owner

Owner

204 No Content

Create or import a user.

POST API-URL/admin/org/id/users

User

User

Update user properties.

PUT API-URL/admin/user/id

User

User

Retrieve a list of rights granted to a user.

GET API-URL/admin/user/id/grantedRights

None

References

Delete a user.

DELETE API-URL/admin/user/id

None

204 No Content

Transfer ownership of a user's vApps, media, and catalogs to the caller.

POST API-URL/admin/user/id/action/takeOwnership

None

204 No Content

Import a group.

POST API-URL/admin/org/id/groups

Group

Group

Delete a group.

DELETE API-URL/admin/group/id

None

204 No Content

Update group properties.

PUT API-URL/admin/group/id

Group

Group

Create a role.

POST API-URL/admin/roles

Role

Role

Update role properties.

PUT API-URL/admin/role/id

Role

Role

Delete a role.

DELETE API-URL/admin/role/id

None

204 No Content

Retrieve a list of tasks owned by organization id.

GET API-URL/tasksList/id

None

TasksList

Retrieve a task.

GET API-URL/task/id

None

Task

Cancel a task.

POST API-URL/task/id/action/cancel

None

204 No Content