InstanceSecretField

Definition of a secret expected by an instance's bundle, with the stored value's fingerprint when one has been set.

Bundles declare the secrets they consume in their app.secrets manifest. Each field describes one expected secret. The sha256 fingerprint is null when no value has been stored, and the lowercase hex SHA-256 of the stored value otherwise -- use it to render set/unset state and to dirty-check edits client-side. Secret values themselves are never returned by the API.

type InstanceSecretField {
  name: String!
  required: Boolean!
  title: String
  description: String
  sha256: String
}

Fields

InstanceSecretField.name ● String! non-null scalar {#name}

The secret's key name (typically an environment variable name like DATABASE_PASSWORD). Use this name when calling setInstanceSecret.

InstanceSecretField.required ● Boolean! non-null scalar {#required}

Whether this secret must be set before the instance can be deployed.

InstanceSecretField.title ● String scalar {#title}

Human-readable display name shown in the UI.

InstanceSecretField.description ● String scalar {#description}

Explanation of what this secret is used for.

InstanceSecretField.sha256 ● String scalar {#sha-256}

Lowercase hex SHA-256 of the stored value, or null when no value has been set. Use null vs non-null to detect whether the secret is set.

Member Of

Instance object