Method: projects.deviceSessions.cancel
Stay organized with collections
Save and categorize content based on your preferences.
POST /v1/projects/{projectId}/deviceSessions/{device_session_id}:cancel 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://testing.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 empty.
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.
IAM Permissions
Requires the following IAM permission on the name resource:
cloudtestservice.devicesession.cancel
For more information, see the IAM documentation.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-07-25 UTC.
[null,null,["Last updated 2024-07-25 UTC."],[],[],null,["# Method: projects.deviceSessions.cancel\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [IAM Permissions](#body.aspect_1)\n- [Try it!](#try-it)\n\nPOST /v1/projects/{projectId}/deviceSessions/{device_session_id}:cancel 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.\n\n### HTTP request\n\n`POST https://testing.googleapis.com/v1/{name=projects/*/deviceSessions/*}:cancel`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|--------|-------------------------------------------------------------------------------------------------------|\n| `name` | `string` Required. Name of the DeviceSession, e.g. \"projects/{projectId}/deviceSessions/{session_id}\" |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body is empty.\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/cloud-platform`\n\nFor more information, see the [Authentication Overview](https://cloud.google.com/docs/authentication/).\n\n### IAM Permissions\n\nRequires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource:\n\n- `cloudtestservice.devicesession.cancel`\n\nFor more information, see the [IAM documentation](https://cloud.google.com/iam/docs)."]]
