Schedules the deletion of a key version.
POST {{managementEndpoint}}/20180608/keys/:keyId/keyVersions/:keyVersionId/actions/scheduleDeletion
Schedules the deletion of the specified key version. This sets the lifecycle state of the key version
to PENDING_DELETION and then deletes it after the specified retention period ends.
As a provisioning operation, this call is subject to a Key Management limit that applies to the total number of requests across all provisioning write operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of provisioning write operations exceeds 10 requests per second for a given tenancy.
Request Body
{"timeOfDeletion"=>"<dateTime>"}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
if-match | string | For optimistic concurrency control. In the PUT or DELETE call for a | |
resource, set the if-match parameter to the value of the etag from a | |||
| previous GET or POST response for that resource. The resource will be | |||
| updated or deleted only if the etag you provide matches the resource's | |||
| current etag value. | |||
opc-request-id | string | Unique identifier for the request. If provided, the returned request ID | |
| will include this value. Otherwise, a random request ID will be | |||
| generated by the service. | |||
opc-retry-token | string | A token that uniquely identifies a request so it can be retried in case | |
| of a timeout or server error without risk of executing that same action | |||
| again. Retry tokens expire after 24 hours, but can be invalidated | |||
| before then due to conflicting operations (e.g., if a resource has been | |||
| deleted and purged from the system, then a retry of the original | |||
| creation request may be rejected). | |||
Content-Type | string | ||
Accept | string |
RESPONSES
status: OK
{"id":"\u003cstring\u003e","compartmentId":"\u003cstring\u003e","timeCreated":"\u003cdateTime\u003e","vaultId":"\u003cstring\u003e","keyId":"\u003cstring\u003e","isPrimary":"\u003cboolean\u003e","lifecycleState":"ENABLED","origin":"EXTERNAL","publicKey":"\u003cstring\u003e","replicaDetails":{"replicationId":"\u003cstring\u003e"},"restoredFromKeyVersionId":"\u003cstring\u003e","timeOfDeletion":"\u003cdateTime\u003e"}