Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Method

URL

Meaning

GET

<rooturl>:<port>/<entity>

List all entitys based on certain criteria

GET

<rooturl>:<port>/<entity>/<identifier>

Get details of a given entity

GET

<rooturl>:<port>/<entity>/<identifier>/<relation1>/<identifier>/<relaltion2>/<identifier>/...

Traversal through entity relationship to get to another related entity.

POST

<rooturl>:<port>/<entity>

Create an entity

POST

<rooturl>:<port>/<entity>/<identifier>/<opName>

Apply an operation against the given entity

PUT

<rooturl>:<port>/<entity>/<identifier>

Update the given entity

DELETE

<rooturl>:<port>/<entity>/<identifier>

Delete the given entity

Where
<rooturl>: API server web app root url.
<port> : API server web app port.
<entity> : CloudStack entity class, which will be explained below in Object Model section.
<identifier> : Unique identifier for an entity instance, can be uuid, or any other attribute that can uniquely identify a resource.
<opName> : Supported operation name for an entity.