Method: projects.deviceSessions.cancel

Cancel a DeviceSession. This RPC changes the DeviceSession to state FINISHED and terminates all connections. Canceled sessions are not deleted and can be retrieved or listed by the user until they expire based on the 28 day deletion policy.

HTTP request

POST https://devicestreaming.googleapis.com/v1/{name=projects/*/deviceSessions/*}:cancel

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. Name of the DeviceSession, e.g. "projects/{projectId}/deviceSessions/{session_id}"

Request body

The request body must be empty.

Response body

If successful, the response body is an empty JSON object.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.