API > servers > dryout

Description

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

https://api.cameyo.com/servers/[server-id]/dryout?action=[action]&clientId=...&clientSecret=...

Optional parameters

•action can be one of the following, or omitted for "restartsvc":

o"restartsvc" (default): Cameyo service gets restarted when reaching zero active sessions.

o"stop" (cloud only): server instance gets powered-off when reaching zero active sessions.

o"delete" (cloud only): server instance gets deleted when reaching zero active sessions.

Return codes

200: success.

400: invalid parameters.

403: authentication failed or insufficient permissions.

404: an item with this id does not exist.