List Crypto Key Versions
const url = 'https://example.com/vault/alpha/workspaces/example/engines/example/cryptoKeys/example/versions';const options = {method: 'GET'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://example.com/vault/alpha/workspaces/example/engines/example/cryptoKeys/example/versionsPaginated metadata listing. Honours AIP-160 filter (e.g. state="ENABLED")
and AIP-132 order_by (e.g. version_number desc).
Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ”The workspace the crypto key belongs to.
The crypto key whose versions will be listed.
Query Parameters
Section titled “Query Parameters ”Maximum number of versions to return per page. The service may return fewer than this value. If unspecified, at most 20 versions will be returned. The maximum value is 100; values above 100 will be coerced to 100.
Opaque page token returned by a previous list call.
AIP-160 filter expression.
Partial matches (:, a quoted wildcard, contains/startsWith/endsWith) ignore capitalisation; = and the relational operators are exact.
Filterable fields: create_time, cryptokey_id, engine, id, state, update_time, version_number, workspace_id.
AIP-132 order_by expression. Sortable fields: create_time, engine, state, update_time, version_number.
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 ”OK
Response payload from List Crypto Key Versions
Carries the output produced by listing crypto key versions.
object
The page of crypto key versions (metadata only).
CryptoKeyVersion: an immutable version of a CryptoKey’s material. Key material is never persisted in the relational database; only metadata round-trips.
object
The unique identifier of this version (UUID)
The parent crypto key that owns this version (UUID)
The workspace that owns this version (UUID, denormalised from the parent crypto key).
Monotonically-increasing version number (1, 2, 3, …)
Current lifecycle state of this version.
For DESTROY_SCHEDULED versions, the timestamp when the engine will permanently destroy material.
Timestamp when this version was created (server-managed).
Timestamp when this version’s state last changed (server-managed).
Opaque token for the next page.
Exact count of resources matching the request’s filter and scope (both pagination modes).
Example
{ "versions": [ { "state": "CRYPTO_KEY_VERSION_STATE_UNSPECIFIED", "engine": "VAULT_ENGINE_UNSPECIFIED" } ]}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" } ]}