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

List Secrets

GET
/vault/v1/workspaces/{workspace}/engines/{engine}/secrets
 
curl --request GET \
  --url https://example.com/vault/v1/workspaces/example/engines/example/secrets

Returns a paginated list of secrets within a workspace.

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
workspace
required
string

The workspace whose secrets will be listed.

engine
required
string

Query Parameters

Section titled “Query Parameters ”
page_size
integer format: int32

The maximum number of secrets to return. The service may return fewer than this value. If unspecified, at most 20 secrets will be returned. The maximum value is 100; values above 100 will be coerced to 100.

page_token
string

A page token, received from a previous ListSecrets call.

filter
string

AIP-160 filter expression. Partial matches (:, a quoted wildcard, contains/startsWith/endsWith) ignore capitalisation; = and the relational operators are exact. Filterable fields: create_time, engine, id, location_id, name, tags.key, tags.type, tags.value, update_time, workspace_id.

order_by
string

AIP-132 order_by expression. Sortable fields: create_time, engine, name, update_time.

skip
string

AIP-158 offset mode: number of resources to skip from the start of the filtered, sorted set. Use EITHER skip (offset paging) OR page_token (cursor paging) — never both in the same request. Supplying both is an invalid request. Default 0 (no skip).

Responses

Section titled “ Responses ”

200

Section titled “200 ”

OK

Media type application/json

Response payload from List Secrets

Carries the output produced by listing secrets.

object
secrets

The page of secrets.

Array<object>

Secret resource: a workspace-scoped, versioned container of opaque secret material persisted by a 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. Writable on create and on update.

An update REPLACES the whole set rather than merging into it: send the tags you want the secret to end up with, not just the ones you are adding. At most 64 tags per secret.

Omitting the field leaves the existing tags untouched. To CLEAR them, send an empty list AND name the field in update_mask — an empty list on its own is indistinguishable from omission on the wire, so it is treated as “not supplied” and changes nothing.

Array<object>

Vault Tag

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

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 Output only
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 secret metadata was created (server-managed).

string format: date-time Output only
update_time

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.

string
engine

The provider holding this secret. Server-assigned and immutable: a secret cannot move between providers, so this is set once, when it is created.

It is always populated on a response, which is what lets a caller list across every provider and still know which one holds each row.

string format: enum Output only
Allowed values: VAULT_ENGINE_UNSPECIFIED VAULT_ENGINE_QIBDO VAULT_ENGINE_AWS VAULT_ENGINE_GCP VAULT_ENGINE_AZURE
next_page_token

Opaque token for the next page; empty when no more results.

string
total_size

Exact count of resources matching the request’s filter and scope (both pagination modes).

string
Example 
{
  "secrets": [
    {
      "tags": [
        {
          "type": "VAULT_TAG_TYPE_UNSPECIFIED"
        }
      ],
      "engine": "VAULT_ENGINE_UNSPECIFIED"
    }
  ]
}

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