CreateSecretBody

Request body for creating a Secret.

Definition

TypeScript
interface CreateSecretBody {
  workspaceId: string;
  name: string;
  value: string;
  metadata?: Record<string, unknown> | undefined;
}

Fields

FieldTypeNotes
workspaceIdstringrequired — Workspace to create the secret in.
namestringrequired — Secret name, unique within the workspace.
valuestringrequired — Plaintext secret value. Encrypted at rest (AES-256-GCM); never returned by the API.
metadataRecord<string, unknown> | undefinedoptional — Optional non-secret metadata.