Schedule Destroy Crypto Key Version

POST

/vault/v1/workspaces/{workspace}/engines/qibdo/cryptoKeys/{cryptokey}/versions/{id}:scheduleDestroy

const url = 'https://example.com/vault/v1/workspaces/example/engines/qibdo/cryptoKeys/example/versions/example:scheduleDestroy';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: '{"workspace":"example","cryptokey":"example","id":"example"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://example.com/vault/v1/workspaces/example/engines/qibdo/cryptoKeys/example/versions/example:scheduleDestroy \
  --header 'Content-Type: application/json' \
  --data '{ "workspace": "example", "cryptokey": "example", "id": "example" }'

AIP-136 custom method on the version. Schedules permanent destruction of key material; the engine purges the version after the grace window elapses.

Parameters

Path Parameters

workspace

required

string

The workspace the crypto key belongs to.

cryptokey

required

string

The parent crypto key.

required

string

The version id (UUID) to schedule for destruction.

Request Body^required

application/json

Request payload for Schedule Destroy Qibdo Crypto Key Version

Carries the input fields required to schedule destroy qibdo crypto key version.

object

workspace

required

The workspace the crypto key belongs to.

string

cryptokey

required

The parent crypto key.

string

required

The version id (UUID) to schedule for destruction.

string

Example ^generated

{
  "workspace": "example",
  "cryptokey": "example",
  "id": "example"
}

Responses

200

application/json

Vault Operation

An acknowledgment of a mutation request, carrying tracking metadata, errors, and warnings. Follows GCP’s Operations pattern (AIP-151).

object

Operation ID

Unique identifier for this operation.

stringOutput only

resource_id

Resource ID

The ID of the resource affected by this operation. May be empty for vault-level lifecycle operations such as snapshot.

stringOutput only

resource_type

Resource Type

The type of resource (e.g., “com.qibdo.cloud.vault:secret”).

stringOutput only

operation_type

Operation Type

The kind of mutation that was requested.

string format: enum Output only

Allowed values: VAULT_OPERATION_TYPE_UNSPECIFIED VAULT_OPERATION_TYPE_CREATE VAULT_OPERATION_TYPE_UPDATE VAULT_OPERATION_TYPE_DELETE VAULT_OPERATION_TYPE_ADD_VERSION VAULT_OPERATION_TYPE_DISABLE_VERSION VAULT_OPERATION_TYPE_DESTROY_VERSION VAULT_OPERATION_TYPE_SCHEDULE_DESTROY_VERSION VAULT_OPERATION_TYPE_ROTATE VAULT_OPERATION_TYPE_ENCRYPT VAULT_OPERATION_TYPE_DECRYPT VAULT_OPERATION_TYPE_SIGN VAULT_OPERATION_TYPE_VERIFY VAULT_OPERATION_TYPE_HMAC VAULT_OPERATION_TYPE_RE_ENCRYPT VAULT_OPERATION_TYPE_GENERATE_DATA_ENCRYPTION_KEY VAULT_OPERATION_TYPE_GENERATE_RANDOM_BYTES VAULT_OPERATION_TYPE_ISSUE VAULT_OPERATION_TYPE_REVOKE VAULT_OPERATION_TYPE_RENEW VAULT_OPERATION_TYPE_BULK_REVOKE VAULT_OPERATION_TYPE_SNAPSHOT VAULT_OPERATION_TYPE_RESTORE VAULT_OPERATION_TYPE_ROOT_KEY_ROTATION VAULT_OPERATION_TYPE_WRAP VAULT_OPERATION_TYPE_UNWRAP VAULT_OPERATION_TYPE_ROTATE_SECRET_ID VAULT_OPERATION_TYPE_AUTHENTICATE VAULT_OPERATION_TYPE_REGISTER_DATABASE_ROLE VAULT_OPERATION_TYPE_UPDATE_DATABASE_ROLE VAULT_OPERATION_TYPE_DELETE_DATABASE_ROLE VAULT_OPERATION_TYPE_REGISTER_PKI_ROLE VAULT_OPERATION_TYPE_UPDATE_PKI_ROLE VAULT_OPERATION_TYPE_DELETE_PKI_ROLE VAULT_OPERATION_TYPE_AUTHORIZE

status

Status

Current lifecycle state of the operation.

string format: enum Output only

Allowed values: VAULT_OPERATION_STATUS_UNSPECIFIED VAULT_OPERATION_STATUS_PENDING VAULT_OPERATION_STATUS_RUNNING VAULT_OPERATION_STATUS_DONE VAULT_OPERATION_STATUS_ERROR

insert_time

Insert Time

When the operation was first created.

string format: date-time Output only

start_time

Start Time

When the operation started executing.

string format: date-time Output only

end_time

End Time

When the operation completed (either successfully or with errors).

string format: date-time Output only

errors

Errors

Business rule errors encountered during the operation.

Array<object>Output only

Operation Error

A structured error returned inside an operation when a business rule fails.

object

code

Error Code

Numeric identifier following the S_SSS_EEE convention.

integer format: uint32 Output only

description

Description

Human-readable explanation of the error.

stringOutput only

reason

Reason

Machine-readable error identifier in UPPER_SNAKE form — the same dispatch key google.rpc.ErrorInfo.reason carries on the synchronous error plane.

stringOutput only

warnings

Warnings

Non-fatal notices about the operation.

Array<object>Output only

Operation Warning

A non-fatal notice attached to an operation. The operation still completed; the warning surfaces unsupported features or capability gaps in the underlying engine.

object

code

Warning Code

Numeric identifier following the S_SSS_EEE convention.

integer format: uint32 Output only

description

Description

Human-readable explanation of the warning.

stringOutput only

progress

Progress

Percentage of completion (0-100).

integer format: int32 Output only

scope_type

Scope Type

The category of scope the operation ran in or was triggered from. VAULT_SCOPE_TYPE_UNSPECIFIED when the operation is not scoped.

string format: enum Output only

Allowed values: VAULT_SCOPE_TYPE_UNSPECIFIED VAULT_SCOPE_TYPE_PLATFORM VAULT_SCOPE_TYPE_ORGANISATION VAULT_SCOPE_TYPE_WORKSPACE VAULT_SCOPE_TYPE_GROUP

scope_id

Scope ID

The resource this operation was scoped to — for example, when scope_type is VAULT_SCOPE_TYPE_WORKSPACE this is the workspace id. Empty for VAULT_SCOPE_TYPE_PLATFORM, which has no scoped resource, and when unscoped.

stringOutput only

principal_id

Principal ID

Who performed or triggered the operation, whether a person or a machine account. Always populated: platform-driven work records the reserved system principal, so every audit record names an actor.

stringOutput only

trace_id

Trace ID

W3C trace id, for correlating this operation with the traces and log lines of the request that caused it. Empty when the operation ran with no trace context — a scheduled or event-driven action rather than a request.

stringOutput only

Example

{
  "operation_type": "VAULT_OPERATION_TYPE_UNSPECIFIED",
  "status": "VAULT_OPERATION_STATUS_UNSPECIFIED",
  "scope_type": "VAULT_SCOPE_TYPE_UNSPECIFIED"
}

default

Default error response

application/json

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.

object

code

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

integer format: int32

message

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

string

details

A list of messages that carry the error details. There is a common set of message types for APIs to use.

Array<object>

Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.

object

@type

The type of the serialized message.

string

key

additional properties

any

Example ^generated

{
  "code": 1,
  "message": "example",
  "details": [
    {
      "@type": "example"
    }
  ]
}

Schedule Destroy Crypto Key Version

Parameters

Path Parameters

Request Body required

Example generated

Responses

200

Example

default

Example generated

Request Body^required

Example ^generated

Example ^generated