Skip to content
View as Markdown

SecretService

Section titled “SecretService”

Service for managing project-scoped secrets.

Constructors

Section titled “Constructors”

Constructor

Section titled “Constructor”
new SecretService(api: AxiosInstance): SecretService;

Parameters:

  • api AxiosInstance

Returns:

  • SecretService

Methods

Section titled “Methods”

delete()

Section titled “delete()”
delete(name: string): Promise<void>;

Parameters:

  • name string

Returns:

  • Promise<void>

get()

Section titled “get()”
get(name: string): Promise<SecretMeta>;

Gets one secret’s metadata (never its value).

Parameters:

  • name string

Returns:

  • Promise<SecretMeta>

iter()

Section titled “iter()”
iter(options: ListSecretsOptions = {}): AsyncIterable<Secret>;

Parameters:

  • options ListSecretsOptions = {}

Returns:

  • AsyncIterable<Secret>

list()

Section titled “list()”
list(options: ListSecretsOptions = {}): Promise<ListResult<Secret>>;

Lists secret metadata for the project (never values).

Parameters:

  • options ListSecretsOptions = {}

Returns:

  • Promise<ListResult<Secret>>

set()

Section titled “set()”
set(name: string, value: string, options: SetSecretOptions): Promise<SecretMeta>;

Creates or updates a secret’s value + metadata.

Parameters:

  • name string
  • value string
  • options SetSecretOptions

Returns:

  • Promise<SecretMeta>

ListSecretsOptions

Section titled “ListSecretsOptions”

Properties:

  • cursor? string
  • limit? number

Secret

Section titled “Secret”
type Secret = SecretDto

Secret metadata (never the value).

SetSecretOptions

Section titled “SetSecretOptions”

Options for creating/updating a secret.

Properties:

  • allowedDomains string[] - The hosts where this secret’s value may be sent (exact or *. wildcard), or ["*"] for any verified host. "*" lets the value reach any HTTPS host, including one a compromised sandbox controls.
  • description? string
  • ifNotExists? boolean

SecretDto

Section titled “SecretDto”

Properties:

  • name string
  • allowed_domains string[]
  • description string | null
  • created_at string | null
  • updated_at string | null

SecretMeta

Section titled “SecretMeta”
type SecretMeta = SecretDto

GET /secrets/{name} detail row — the same SDK shape as the list row.