Skip to content
qibdo qibdo
v1
API version
  • v1
Theme
Book a demo

Create Secret

POST
/vault/v1/workspaces/{workspace}/engines/qibdo/secrets
 
curl --request POST \
  --url https://example.com/vault/v1/workspaces/example/engines/qibdo/secrets \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "rotation_period": "example", "tags": [ { "key": "example", "value": "example", "type": "VAULT_TAG_TYPE_UNSPECIFIED", "description": "example" } ] }'

Creates a new secret under a workspace. Name is unique within the workspace. Returns an operation describing the create.

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
workspace
required
string

The workspace to create the secret in.

Query Parameters

Section titled “Query Parameters ”
location_id
string

Optional weak reference to a topology Location where the secret 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 ”
Media type application/json

QibdoSecret resource — a workspace-scoped, versioned container of opaque secret material persisted by the Qibdo vault engine. Metadata is stored in the relational database; payload bytes live exclusively in the vault.

object
id

The unique identifier of the secret (UUID)

stringOutput only
workspace_id

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

stringOutput only
name
required

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

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 secret.

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
created

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

string format: date-time Output only
updated

Timestamp when the secret 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

Section titled “ Responses ”

200

Section titled “200 ”

OK

Media type application/json

Vault Operation

Tracks the result of a vault command (secret, crypto key, lease, certificate authority, certificate, access policy, or vault-level lifecycle action).

object
id

Operation ID

Unique identifier of the operation.

stringOutput only
workspace_id

Workspace ID

The workspace in whose namespace the operation was executed.

stringOutput only
resource_id

Resource ID

ID of the affected resource (nullable for vault-level lifecycle ops such as snapshot).

stringOutput only
resource_type

Resource Type

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

stringOutput only
operation_type

Operation Type

The action performed (CREATE, ROTATE, REVOKE, ENCRYPT, …).

stringOutput only
status

Status

The operation status (PENDING, RUNNING, DONE, FAILED).

stringOutput only
insert_time

Insert Time

When the operation was created.

string format: date-time Output only
start_time

Start Time

When execution started (nullable).

string format: date-time Output only
end_time

End Time

When execution completed (nullable).

string format: date-time Output only
progress

Progress

Progress percentage (0–100).

integer format: int32 Output only
warnings

Warnings

Non-fatal notices emitted during the operation.

Array<object>Output only

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
code

Warning Code

Numeric identifier of the warning type.

integer format: uint32 Output only
description

Description

Human-readable explanation of what was ignored or degraded.

stringOutput only
Example generated
{}

default

Section titled “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"
    }
  ]
}