Disconnect

POST 
/workstations/:workstation_id/remote/disconnect

Disconnect from a remote desktop.

Request

Path Parameters

workstation_id uidrequired

The UID associated to a Workstation. Learn more

application/json

Body

required

protocol RemoteProtocol (string)required

The protocol to use for remote connection.

Possible values: [rfb, vnc]

Responses

200

Remote disconnection successful

application/json

Schema

Schema

disconnected boolean

Indicates whether the remote connection was successfully disconnected.

protocol RemoteProtocol (string)

The protocol to use for remote connection.

Possible values: [rfb, vnc]

Example (from schema)

{
  "disconnected": true,
  "protocol": "rfb"
}

400

Invalid Request Format - check API documentation for proper syntax.

application/json

Schema

Schema

error string
message string

Example (from schema)

{
  "error": "string",
  "message": "string"
}

401

Unauthorized - missing or invalid API key.

application/json

Schema

Schema

error string
message string

Example (from schema)

{
  "error": "string",
  "message": "string"
}

402

Payment Required - you have run out of trial credits or your payment method has expired. Please add payment details to your account.

application/json

Schema

Schema

error string
message string

Example (from schema)

{
  "error": "string",
  "message": "string"
}

422

Unprocessable Entity - cannot find requested asset associated with your API key.

application/json

Schema

Schema

error string
message string

Example (from schema)

{
  "error": "string",
  "message": "string"
}

429

Too Many Requests - you have exceeded the rate limit for your account. Please wait before making additional requests.

application/json

Schema

Schema

error string
message string

Example (from schema)

{
  "error": "string",
  "message": "string"
}

500

Internal Server Error - please retry your request.

application/json

Schema

Schema

error string
message string

Example (from schema)

{
  "error": "string",
  "message": "string"
}

503

Service Unavailable - our servers have dropped the request due to high load - please retry.

application/json

Schema

Schema

error string
message string

Example (from schema)

{
  "error": "string",
  "message": "string"
}

Loading...