CloudShare API
CloudShare's API Documentation
Overview
API Concepts
Using the REST API
Projects
Blueprints
GET /api/v3/projects/ID/blueprints
GET /api/v3/projects/ID/blueprints/ID
Policies
GET /api/v3/projects/ID/policies
Projects
GET /api/v3/projects
GET /api/v3/projects/FILTER
GET /api/v3/projects/ID
Training
Class
DELETE /api/v3/class/actions/DeleteAllEnvironments
DELETE /api/v3/class/ID
GET /api/v3/class
GET /api/v3/class/actions/countries
GET /api/v3/class/actions/customfields
GET /Api/v3/Class/actions/getdetailed
GET /api/v3/class/actions/instructors
GET /api/v3/class/ID
POST /api/v3/class
POST /api/v3/class/actions/sendinvitations
POST /api/v3/class/disablesponsoredlink
POST /api/v3/Class/ID/Students/actions/ResumeEnvironmentForStudent
POST /api/v3/class/sponsoredlink
PUT /api/v3/class/actions/SuspendAllEnvironments
PUT /api/v3/class/ID
Students
DELETE /api/v3/class/ID/students/ID
GET /api/v3/class/ID/students
GET /api/v3/class/ID/students/ID
POST /api/v3/class/ID/students
PUT /api/v3/class/ID/students/ID
Instructors
DELETE /api/v3/instructors/ID
GET /api/v3/instructors/class
POST /api/v3/instructors
Utilities
Ping
GET /api/v3/ping
Regions
GET /api/v3/regions
TimeZones
GET /api/v3/timezones
Environments
Environments
GET /api/v3/envs
GET /api/v3/envs/actions/getenvresources
GET /api/v3/envs/actions/getextended
GET /api/v3/envs/actions/getextendedbymachinevanity
GET /api/v3/envs/actions/getextendedbytoken
GET /api/v3/envs/actions/getmultipleenvsresources
PUT /api/v3/envs/actions/extend
PUT /api/v3/envs/actions/postponeinactivity
PUT /api/v3/envs/actions/resume
PUT /api/v3/envs/actions/revert
PUT /api/v3/envs/actions/suspend
GET /api/v3/envs/ID
DELETE /api/v3/envs/ID
POST /api/v3/envs
PUT /api/v3/envs
VMs
DELETE /api/v3/vms/ID
GET /api/v3/vms/actions/checkexecutionstatus
GET /api/v3/vms/actions/getremoteaccessfile
POST /api/v3/vms/actions/executepath
PUT /api/v3/vms/actions/editvmhardware
PUT /api/v3/vms/actions/reboot
PUT /api/v3/vms/actions/revert
CloudFolders
GET /api/v3/cloudfolders/actions/getall
PUT /api/v3/cloudfolders/actions/mount
PUT /api/v3/cloudfolders/actions/regeneratecloudfolderspassword
PUT /api/v3/cloudfolders/actions/unmount
Templates
GET /api/v3/templates
Snapshots
GET /api/v3/snapshots/ID
GET /api/v3/snapshots/actions/getforenv
PUT /api/v3/snapshots/actions/markdefault
POST /api/v3/snapshots/actions/takesnapshot
Permalinks
POST /api/v3/permalinks
GET /api/v3/permalinks
Users
Invitations
OPTIONS /api/v3/invitations
POST /api/v3/invitations/actions/inviteprojectmember
POST /api/v3/invitations/actions/invitetopoc
POST /api/../inviteanonymousenduser (deprecated)
POST /api/../InviteEndUser (deprecated)
POST /api/../inviteenduserandassignprojectmember (deprecated)
SponsoredLinks
OPTIONS /api/v3/sponsoredlinks
POST /api/v3/sponsoredlinks
Teams
GET /api/v3/teams
Users
GET /api/v3/users/actions/getloginurl
POST /api/v3/users/actions/GetReplacingUsersOptions
POST /api/v3/users/actions/RemoveUserRole
Integrations
Webhooks
GET /api/v3/webhooks
GET /api/v3/webhooks/{id}
POST /api/v3/webhooks
DELETE /api/v3/webhooks/{id}
Public Clouds
Public Cloud Environments
GET api/v3/externalclouds/ervins/environmentId
Public Clouds Virtual Machines
GET api/v3/externalCloudsVms/environmentId
|
Back to CloudShare
Ping
Testing API credentials
Action
Description
GET /api/v3/ping
Tests API v3 credentials