Bulk Revoke Leases By Prefix
const url = 'https://example.com/vault/v1/workspaces/example/engines/qibdo/leases:bulkRevokeByPrefix';const options = { method: 'POST', headers: {'Content-Type': 'application/json'}, body: '{"workspace":"example","engine_lease_id_prefix":"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/leases:bulkRevokeByPrefix \ --header 'Content-Type: application/json' \ --data '{ "workspace": "example", "engine_lease_id_prefix": "example" }'Incident-response RPC. Revokes every active lease whose engine_lease_id
begins with the given prefix in a single call. Idempotent — a second call
with the same prefix is a no-op.
Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ”The workspace whose leases are subject to bulk revocation.
Request Body required
Section titled “Request Body required ”Request payload for Bulk Revoke Qibdo Leases By Prefix
Carries the input fields required to bulk revoke qibdo leases by prefix.
object
The workspace whose leases are subject to bulk revocation.
The prefix every targeted lease’s engine_lease_id must begin with.
For example, database/creds/<role-name>/ revokes every credential
currently outstanding for that database role.
Example generated
{ "workspace": "example", "engine_lease_id_prefix": "example"}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" } ]}