Skip to content
Console
On this page

Enable a secret version

Enables a disabled secret version.

Enables a disabled secret version.

  • Path POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/secrets/secret/secret_versions/secret-version:enable
  • Scope secrets:write
  • Effect write — a successful call changes state.
  • Collection secret_versions
  • Validate-only validate_only=true runs every check and writes nothing

Request

FieldTypeWhat it is
namestringThe name of the secret version to enable. Required.
etagstringEnable only if the current etag matches.
validate_onlyboolValidate without changing anything.

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 -X POST "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/secrets/secret/secret_versions/secret-version:enable" \
  -H "Authorization: Bearer $SYLPHX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'