The API provides six different REST resources. The requests or actions you want to take using an API will determine which scopes you enable. Here is a brief overview of each scope.
Cameyo has the following API REST resources:
apps
| Methods | Description |
|---|---|
| add | Publishes a new Cameyo app. Syntax: https://api.cameyo.com/apps/add?clientId=...&clientSecret=...&name=...&cmd=...&args=...&servergroup=... |
| delete | Deletes an application. Syntax: https://api.cameyo.com/apps/[app-id]/delete?clientId=...&clientSecret=... |
| disable | Disables an application. Syntax: https://api.cameyo.com/apps/[app-id]/disable?clientId=...&clientSecret=... |
| enable | Enables an application. Syntax: https://api.cameyo.com/apps/[app-id]/enable?clientId=...&clientSecret=... |
| list | Lists organization's published apps. Syntax: https://api.cameyo.com/apps/list?clientId=...&clientSecret=...&filter=... |
| play | Initiates a Cameyo HTML5 app session. Syntax: https://api.cameyo.com/apps/[app-id]/play?clientId=...&clientSecret=...&user=user-email&ip=client-ip |
| set | Sets an app's PowerTag value. Syntax: https://api.cameyo.com/apps/[app-id]/set?clientId=...&clientSecret=...&powertags=!TAG=value |
servers
| Methods | Description |
|---|---|
| add | Creates or clones a server. Syntax: https://api.cameyo.com/servers/add?clientId=...&clientSecret=...&groupId=[servergroup-id]&snapshotId=[snapshot-id] |
| delete | Deletes a server. Syntax: https://api.cameyo.com/servers/[server-id]/delete?clientId=...&clientSecret=... |
| disable | Disables a server so that it no longer serves requests. Syntax:
|
| dryout | Disables a server in dry-out mode. Dry-out mode awaits until no sessions are active and then performs a certain operation and re-enables the server. Syntax:
|
| enable | Enables a server that's been previously disabled. Syntax: https://api.cameyo.com/servers/[server-id]/enable?clientId=...&clientSecret=... |
| get | Obtains information about a specific server. Syntax:
|
| ip | Returns the IP address used by the specified server, in plain text. Example: "64.104.20.208" Syntax:
|
| reboot | Causes a running server to restart. Syntax:
|
| set | Sets a server's PowerTags value. Syntax:
|
| start | Powers on a server. Syntax:
|
| stop | Powers down a server. Syntax:
|
| svcrestart | Restarts Cameyo's backend service on the server. Syntax
|
servergroups
| Methods | Description |
|---|---|
| clone | Clones a server cluster. Syntax: https://api.cameyo.com/servers/[servergroup-id]/clone?clientId=...&clientSecret=...&name=... |
| data | Produces a CSV activity log for the server cluster. Syntax https://api.cameyo.com/servergroups/[servergroup-id]/data?clientId=...&clientSecret=...&start=...&end=... |
| delete | Deletes an empty server cluster. Fails if the cluster contains servers. Syntax: https://api.cameyo.com/servergroups/[servergroup-id]/delete?clientId=...&clientSecret=... |
| deltree | Deletes a server cluster and all of its servers. Syntax: https://api.cameyo.com/servergroups/[servergroup-id]/deltree?clientId=...&clientSecret=... |
| empty | Deletes a server cluster's clone servers, but not the cluster itself. Syntax: https://api.cameyo.com/servergroups/[servergroup-id]/empty?clientId=...&clientSecret=... |
| softempty | Deletes a server cluster's powered-off clone servers, but not the cluster itself. Similar to the empty API, but without affecting powered-on clones. Syntax: https://api.cameyo.com/servergroups/[servergroup-id]/softempty?clientId=...&clientSecret=... |
| ip | Returns a comma-separated, plain-text list of IPs used by the specified cluster's servers, for example: "64.104.20.208,64.104.20.211,64.104.20.209" Syntax: https://api.cameyo.com/servergroups/[servergroup-id]/ip?clientId=...&clientSecret=... |
| list | Returns the list of servers within a given cluster. Syntax: https://api.cameyo.com/servergroups/[servergroup-id]/list?clientId=...&clientSecret=... |
| get | Obtains information about a specific cluster. Syntax: https://api.cameyo.com/servergroups/[servergroup-id]/get?clientId=...&clientSecret=... |
| set | Sets a server cluster's PowerTags value. Syntax: https://api.cameyo.com/servergroups/[servergroup-id]/set?clientId=...&clientSecret=...&powertags=!TAG=value |
| seteach | Sets a PowerTags value for each server within the server cluster. Syntax: https://api.cameyo.com/servers/[server-id]/set?clientId=...&clientSecret=...&powertags=!TAG=value |
users
| Methods | Description |
|---|---|
| add | Adds a user to the organization's account. Syntax: https://api.cameyo.com/users/add?clientId=...&clientSecret=...&[email protected] |
| delete | Deletes a user from the organization's account. Syntax: https://api.cameyo.com/users/delete?clientId=...&clientSecret=...&[email protected] |
| get | Obtains information about a specific user. Syntax: https://api.cameyo.com/users/get?clientId=...&clientSecret=...&[email protected] |
| set | Changes properties for a specific user. Syntax: https://api.cameyo.com/users/set?clientId=...&clientSecret=...&[email protected]&powertags=!TAG=value&pwd=[password] |
| list | Lists users. Syntax: https://api.cameyo.com/users/list?clientId=...&clientSecret=...&filter=... |
| lock | Locks out a user, preventing them from being able to access their account. Syntax: https://api.cameyo.com/users/lock?clientId=...&clientSecret=...&[email protected] |
| unlock | Unlocks a locked-out user. Syntax: https://api.cameyo.com/users/unlock?clientId=...&clientSecret=...&[email protected] |
usergroups
| Methods | Description |
|---|---|
| add |
Creates a user group. |
| delete |
Obtains information about a specific user group. If the group contained users, they are moved outside of that group. |
| get |
Obtains information about a specific user group. |
| set |
Changes properties for a specific user group. |
| list |
Lists user groups. |
tokens
| Methods | Description |
|---|---|
| add | Validates session information. This API is designed to be called by Windows applications running from within Cameyo's session, in order to securely validate session information such as the user's email. Syntax: https://api.cameyo.com/tokens/[tokenId]/validate?tokenKey=...&ttl=...&userId=... |