Create Crypto Key

POST

/vault/v1/workspaces/{workspace}/engines/qibdo/cryptoKeys

curl --request POST \
  --url https://example.com/vault/v1/workspaces/example/engines/qibdo/cryptoKeys \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "purpose": "CRYPTO_KEY_PURPOSE_UNSPECIFIED", "algorithm": "CRYPTO_ALGORITHM_UNSPECIFIED", "protection_level": "PROTECTION_LEVEL_UNSPECIFIED", "minimum_decryptable_version": "example", "rotation_period": "example", "tags": [ { "key": "example", "value": "example", "type": "VAULT_TAG_TYPE_UNSPECIFIED", "description": "example" } ] }'

Creates a new crypto key under a workspace and provisions the initial key version (v1) in the engine. Name is unique within the workspace.

Parameters

Path Parameters

workspace

required

string

The workspace to create the crypto key in.

Query Parameters

location_id

string

Optional weak reference to a topology Location where the crypto key resides. Defaults to the global location when omitted; immutable after creation. Only the global location is available in this release.

Request Body ^required

Media type application/json

QibdoCryptoKey resource: a workspace-scoped, versioned cryptographic key managed by the Qibdo vault engine. The relational database stores key metadata only; key material lives exclusively in the engine.

object

id

The unique identifier of the crypto key (UUID)

stringOutput only

workspace_id

The workspace this crypto key belongs to (UUID, weak reference to taxonomy)

stringOutput only

name

required

Human-readable name of the crypto key, unique within the workspace (3–256 chars, lowercase alphanumerics plus / - _).

string

purpose

required

Intended use of the crypto key (encrypt/decrypt, sign/verify, MAC, wrap).

string format: enum

Allowed values: CRYPTO_KEY_PURPOSE_UNSPECIFIED CRYPTO_KEY_PURPOSE_ENCRYPT_DECRYPT CRYPTO_KEY_PURPOSE_SIGN_VERIFY CRYPTO_KEY_PURPOSE_MAC CRYPTO_KEY_PURPOSE_WRAP

algorithm

required

Cryptographic algorithm of the key. Must be compatible with the purpose.

string format: enum

Allowed values: CRYPTO_ALGORITHM_UNSPECIFIED CRYPTO_ALGORITHM_AES_256_GCM CRYPTO_ALGORITHM_CHACHA20_POLY1305 CRYPTO_ALGORITHM_RSA_2048 CRYPTO_ALGORITHM_RSA_3072 CRYPTO_ALGORITHM_RSA_4096 CRYPTO_ALGORITHM_EC_P256 CRYPTO_ALGORITHM_EC_P384 CRYPTO_ALGORITHM_EC_P521 CRYPTO_ALGORITHM_ED25519 CRYPTO_ALGORITHM_HMAC_SHA256 CRYPTO_ALGORITHM_HMAC_SHA384 CRYPTO_ALGORITHM_HMAC_SHA512

protection_level

Where key material is protected: in software (default) or in an HSM.

string format: enum

Allowed values: PROTECTION_LEVEL_UNSPECIFIED PROTECTION_LEVEL_SOFTWARE PROTECTION_LEVEL_HSM

minimum_decryptable_version

Lowest version number still allowed to decrypt (>= 1).

string

rotation_period

Optional automatic rotation period; null means no auto-rotation.

string

/^-?(?:0|[1-9][0-9]{0,11})(?:\.[0-9]{1,9})?s$/

tags

User-defined tags (key/value pairs) attached to the crypto key.

Array<object>

Vault Tag

A key-value pair used to label and categorize vault resources such as secrets, crypto keys, leases, certificate authorities, certificates, and access policies.

object

key

required

Tag Key

Tag key (1–63 chars, lowercase letters/digits/dashes/underscores).

string

value

required

Tag Value

Tag value (free-form, up to 255 chars).

string

type

Tag Type

Whether the tag is system-managed or user-defined.

string format: enum

Allowed values: VAULT_TAG_TYPE_UNSPECIFIED VAULT_TAG_TYPE_SYSTEM VAULT_TAG_TYPE_USER

description

Tag Description

Optional description.

string

create_time

Timestamp when the crypto key metadata was created (server-managed).

string format: date-time Output only

update_time

Timestamp when the crypto key metadata was last updated (server-managed).

string format: date-time Output only

location_id

Weak reference to a topology Location: where this resource resides. Defaults to the global location when omitted at creation and is immutable thereafter. Only the global location is available in this release.

stringOutput only

Responses

200

OK

Media type application/json

Vault Operation

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

object

id

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

Media type 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"
    }
  ]
}