Skip to content
Console
Menu

Queues

Workflows

Getting Started

Authentication

KV Store

Get a secret version

Gets a secret version.

This method is not served on the public API. api.sylphx.com does not route this call: its backend is not deployed behind the public API, or does not implement the call. This page documents the contract. It is kept out of the sidebar and of search engines.

Gets a secret version.

  • Path GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/secrets/secret/secret_versions/secret-version
  • Scope secrets:read
  • Effect read — nothing is written.
  • Collection secret_versions

#Request

FieldTypeWhat it is
namestringThe name of the secret version to get. Required.

#Response

FieldTypeWhat it is
namestring…/secrets/{secret}/secret_versions/{secret_version}; the id is the version number, from 1.
uidstringscv_<cell><ulid>. Output only.
metaResourceMetaResource metadata.
payloadbytesThe value, at most 64 KiB. Write-only. Required. Never returned again.
stateSecretVersionStateThe version's lifecycle state. Output only. One of enabled, disabled, destroyed.
destroy_timetimestampWhen the value was destroyed. Output only.

#ResourceMeta

FieldTypeWhat it is
generationint64Increases by one on every change to spec. Output only.
etagstringStrong ETag (AIP-154): changes on any change to spec, status, or metadata. Send it back as If-Match or etag to make Update and Delete conditional; a mismatch fails with ABORTED / 409 ETAG_MISMATCH. Output only.
create_timetimestampWhen the Resource was created. Output only.
update_timetimestampWhen the Resource last changed. Output only.
delete_timetimestampSet while the Resource is being deleted. Output only.
labelsmap<string, string>Caller-writable, indexed labels (AIP-122 label rules).
annotationsmap<string, string>Caller-writable, unindexed annotations.
display_namestringCaller-writable human-readable name.
creatorstringThe principal that created the Resource. Output only.

#Errors

Every error arrives in the body Errors describes.

#Examples

curl "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/secrets/secret/secret_versions/secret-version" \
  -H "Authorization: Bearer $SYLPHX_API_KEY"