REST API Concepts

The Cloudshare REST API allows client applications to perform a subset of the actions that can be done on the web UI application. The client will be able to check the status of its environments, to create environments and take snapshots of them. It will also be able to issue invitations to users to access environments.

Environment A group of machines (VMs), storage, networking, infrastructure software (such as OS, DB)
Machine (VM) A single VM entity within an environment
Template A pre-configured VM that can be added to an environment
Blueprint A template of environments, software used to create environments
License Permission to use an environment.
Project A company or enterprise activity consisting of Blueprints to which users can be invited
Snapshot The state of an environment and applications running on it, at a particular time; this includes the running state of each machine in the environment.
End User A user of an environment.
Vendor The ‘owner’ of a campaign/environment
Campaign A company or enterprise activity consisting of Blueprints to which users can be invited. (v1)
Resource billing packages. (v1)
Usage package A contractual specification of the amount of running time the environment can be used by users. (v1)
Customer A user of an environment, invited by a vendor. (v1)

Changes from V1

V1 V2
Campaign Project
Usage package Environment policy
Prototype Blueprint
Customer End user
Machine vm