Browsing requests provide read-only access to a cloud and the objects it contains.

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 vCloud API Browsing Requests

Operation

Request

Request Body

Response

Show login URL and list of supported API versions

GET API-URL/versions

None

SupportedVersions

Log in

POST API-URL/sessions

None

Session

Log out

DELETE API-URL/session

None

200 OK

Log in [DEPRECATED]

POST API-URL/login

None

OrgList

Log out [DEPRECATED]

POST API-URL/login

None

200 OK

Retrieve a list of entry points for browsing operations

GET API-URL/session

None

200 OK

Retrieve a list of organizations to which you have access

GET API-URL/org/

None

OrgList

Retrieve the contents of an organization

GET API-URL/org/id

None

Org

Retrieve properties of a network

GET API-URL/network/id

None

OrgNetwork

Retrieve the contents of a catalog

GET API-URL/catalog/id

None

Catalog

Retrieve properties of a catalog item

GET API-URL/catalogItem/id

None

CatalogItem

Retrieve the contents of a VDC

GET API-URL/vdc/id

None

Vdc

Retrieve properties of a media image

GET API-URL/media/id

None

Media

Retrieve a vApp template

GET API-URL/vAppTemplate/vappTemplate-id

None

VAppTemplate

Retrieve properties of a vApp

GET API-URL/vApp/vapp-id

None

VApp

Retrieve properties of a virtual machine

GET API-URL/vApp/vm-id

None

Vm

Retrieve metadata for an object such as an organization, network, vApp, virtual machine, media image, or independent disk.

GET API-URL/object/id/metadata

None

Metadata

Retrieve a list of IP addresses allocated to a network.

GET API-URL/network/id/allocatedAddresses

None

AllocatedIpAddresses