Create Crypto Key
const url = 'https://example.com/vault/v1/workspaces/example/engines/qibdo/cryptoKeys';const options = { method: 'POST', headers: {'Content-Type': 'application/json'}, body: '{"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"}]}'};
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 \ --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
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ”The workspace to create the crypto key in.
Query Parameters
Section titled “Query Parameters ”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
Section titled “Request Body required ”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
The unique identifier of the crypto key (UUID)
The workspace this crypto key belongs to (UUID, weak reference to taxonomy)
Human-readable name of the crypto key, unique within the workspace (3–256 chars, lowercase alphanumerics plus / - _).
Intended use of the crypto key (encrypt/decrypt, sign/verify, MAC, wrap).
Cryptographic algorithm of the key. Must be compatible with the purpose.
Where key material is protected: in software (default) or in an HSM.
Lowest version number still allowed to decrypt (>= 1).
Optional automatic rotation period; null means no auto-rotation.
User-defined tags (key/value pairs) attached to the crypto key.
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
Tag Key
Tag key (1–63 chars, lowercase letters/digits/dashes/underscores).
Tag Value
Tag value (free-form, up to 255 chars).
Tag Type
Whether the tag is system-managed or user-defined.
Tag Description
Optional description.
Timestamp when the crypto key metadata was created (server-managed).
Timestamp when the crypto key metadata was last updated (server-managed).
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.
Responses
Section titled “ Responses ”OK
Vault Operation
Tracks the result of a vault command (secret, crypto key, lease, certificate authority, certificate, access policy, or vault-level lifecycle action).
object
Operation ID
Unique identifier of the operation.
Workspace ID
The workspace in whose namespace the operation was executed.
Resource ID
ID of the affected resource (nullable for vault-level lifecycle ops such as snapshot).
Resource Type
URN of the affected resource type (e.g., “com.qibdo.cloud.vault:secret”).
Operation Type
The action performed (CREATE, ROTATE, REVOKE, ENCRYPT, …).
Status
The operation status (PENDING, RUNNING, DONE, FAILED).
Insert Time
When the operation was created.
Start Time
When execution started (nullable).
End Time
When execution completed (nullable).
Progress
Progress percentage (0–100).
Warnings
Non-fatal notices emitted during the operation.
Vault Warning
A non-fatal notice emitted by a vault operation. The operation still completed; the warning surfaces unsupported features or capability gaps in the underlying engine.
Warning codes follow the S_SSS_EEE convention:
- Millions digit: service (9 = vault)
- Thousands: group
- Units: specific warning
object
Warning Code
Numeric identifier of the warning type.
Description
Human-readable explanation of what was ignored or degraded.
Example generated
{}default
Section titled “default ”Default error response
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
The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
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.
A list of messages that carry the error details. There is a common set of message types for APIs to use.
Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.
object
The type of the serialized message.
Example generated
{ "code": 1, "message": "example", "details": [ { "@type": "example" } ]}