Scheduling Destruction of a Google Cloud Key Version
Use the post /v1/cckm/google/keys/{id}/versions/{versionID}/schedule-destroy
API to schedule the destruction of a particular version of a Google Cloud key with the given ID. The version state
is set to DESTROY_SCHEDULED
and destroyTime
is set to a time 24 hours in the future. At the scheduled time, the state changes to DESTROYED
and the version's key material is deleted permanently.
Syntax
Here, {id}
represents the resource ID of the parent Google Cloud key and {versionID}
represents the resource ID of the key version on the CipherTrust Manager.
Request Parameters
Parameter | Type | Description |
---|---|---|
AUTHTOKEN | string | Authorization token. |
Example Request
Example Response
The sample output displays that a version with the ID e2f79e23-749d-4579-bef1-5777a4651e9e
of a Google Cloud key with the ID ecc73bfb-7605-4263-abb8-84fe431d35fb
is scheduled to destroy at "destroyTime": "2021-05-06T08:25:40.076753Z"
.
If you want to cancel the scheduled destruction of a key version before its destroyTime
is reached, run the /v1/cckm/google/keys/{id}/versions/{versionID}/cancel-schedule-destroy
API. Refer to Canceling Scheduled Destruction of a Google Cloud Key Version.
Response Codes
Response Code | Description |
---|---|
2xx | Success |
4xx | Client errors |
5xx | Server errors |
Refer to HTTP status codes for details.