Stay organized with collectionsSave and categorize content based on your preferences.
Cancels an unfinished device wipe. This operation can be used to cancel device wipe in the gap between the wipe operation returning success and the device being wiped. This operation is possible when the device is in a "pending wipe" state. The device enters the "pending wipe" state when a wipe device command is issued, but has not yet been sent to the device. The cancel wipe will fail if the wipe command has already been issued to the device.
HTTP request
POST https://cloudidentity.googleapis.com/v1/{name=devices/*}:cancelWipe
Required.Resource nameof the Device in format:devices/{device}, where device is the unique ID assigned to the Device.
Request body
The request body contains data with the following structure:
JSON representation
{"customer":string}
Fields
customer
string
Optional.Resource nameof the customer. If you're using this API for your own organization, usecustomers/my_customerIf you're using this API to manage another organization, usecustomers/{customer}, where customer is the customer to whom the device belongs.
Response body
If successful, the response body contains an instance ofOperation.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-06 UTC."],[[["\u003cp\u003eThis operation cancels an unfinished device wipe if the device is in a "pending wipe" state, meaning a wipe command has been issued but not yet sent to the device.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003ePOST\u003c/code\u003e request to \u003ccode\u003ehttps://cloudidentity.googleapis.com/v1/{name=devices/*}:cancelWipe\u003c/code\u003e is used, where \u003ccode\u003ename\u003c/code\u003e is the unique device ID.\u003c/p\u003e\n"],["\u003cp\u003eThe request body includes an optional \u003ccode\u003ecustomer\u003c/code\u003e field to specify the customer resource, using \u003ccode\u003ecustomers/my_customer\u003c/code\u003e for the user's own organization.\u003c/p\u003e\n"],["\u003cp\u003eA successful operation returns an instance of \u003ccode\u003eOperation\u003c/code\u003e, and one of the OAuth scopes \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-identity.devices\u003c/code\u003e or \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-identity\u003c/code\u003e is required for authorization.\u003c/p\u003e\n"]]],[],null,["# Method: devices.cancelWipe\n\nCancels an unfinished device wipe. This operation can be used to cancel device wipe in the gap between the wipe operation returning success and the device being wiped. This operation is possible when the device is in a \"pending wipe\" state. The device enters the \"pending wipe\" state when a wipe device command is issued, but has not yet been sent to the device. The cancel wipe will fail if the wipe command has already been issued to the device.\n\n### HTTP request\n\n`POST https://cloudidentity.googleapis.com/v1/{name=devices/*}:cancelWipe`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n### Request body\n\nThe request body contains data with the following structure:\n\n### Response body\n\nIf successful, the response body contains an instance of [Operation](/identity/docs/reference/rest/Shared.Types/Operation).\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/cloud-identity.devices`\n- `https://www.googleapis.com/auth/cloud-identity`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]
