16.3. Resources and Collections

A collection is a set of resources of the same type. The API provides both top-level collections and sub-collections. An example of a top-level collection is the volume collection which contains all bricks in the environment. An example of a sub-collection is the volume.bricks collection which contains resources for CPUs attached to a cluster.

The interface for interacting with collections provides methods for adding resources (add), getting resources (get), and listing resources (list).

A resource in a RESTful API is an object with a fixed interface that also contains a set of attributes that are relevant to the specific type of resource being represented. The interface for interacting with resources provides methods for updating ( update) and deleting (delete) resources. Additionally, some resources support actions specific to the resource type. One example of this is the approve method of Host resources.