Skip to content
Console
On this page

Get a secret binding

Gets a secret binding.

Gets a secret binding.

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

Request

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

Response

FieldTypeWhat it is
namestringorgs/{org}/projects/{project}/envs/{env}/secret_bindings/{secret_binding}.
uidstringscb_<cell><ulid>. Output only.
metaResourceMetaResource metadata.
specSecretBindingSpecDesired state. Required.
statusSecretBindingStatusObserved state. 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.

SecretBindingSpec

FieldTypeWhat it is
secretstringThe Secret to deliver, in the same environment. Required.
versionstringA pinned version; unset delivers the Secret's latest enabled version.
workloadstringThe name of the Resource that consumes the value, for example a Hosting service. Required.
env_varEnvVarDeliveryAs an environment variable. One of the delivery group.
fileFileDeliveryAs a file. One of the delivery group.
egressEgressInjectionBy egress injection into outgoing requests. One of the delivery group.

SecretBindingStatus

FieldTypeWhat it is
observed_generationint64The generation this status was computed from. Output only.
conditionsCondition[]Ready, Reconciling, Stalled. Output only.
resolved_versionstringThe version the binding delivers now. Output only.

EnvVarDelivery

FieldTypeWhat it is
variablestringThe variable name, for example DATABASE_PASSWORD. Required.

FileDelivery

FieldTypeWhat it is
pathstringThe absolute path, for example /run/secrets/tls.key. Required.

EgressInjection

FieldTypeWhat it is
hostsstring[]The hosts the value may be sent to, for example api.example.com. Required.
headerstringThe request header to set, for example Authorization. Required.
header_templatestringThe header value, with {value} standing for the Secret, for example Bearer {value}; default {value}.

Condition

FieldTypeWhat it is
typestringThe condition type, for example Ready.
statusConditionStatusWhether the condition holds. One of true, false, unknown.
observed_generationint64The generation this observation was made against.
reasonstringA machine-readable UpperCamelCase reason.
messagestringA customer-safe human-readable message.
severitySeverityHow severe a FALSE condition is. One of info, warning, error.
transition_timetimestampWhen status last changed.

Errors

Every error arrives in the body Errors describes.

Examples

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