SecretService

Service for managing project-scoped secrets.

Constructors

Constructor

new SecretService(api: AxiosInstance): SecretService;

Parameters:

• api AxiosInstance

Returns:

• SecretService

Methods

delete()

delete(name: string): Promise<void>;

Deletes a secret (idempotent). Does not affect already-running sandboxes.

Parameters:

• name string

Returns:

• Promise<void>

get()

get(name: string): Promise<SecretMeta>;

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

Parameters:

• name string

Returns:

• Promise<SecretMeta>

iter()

iter(): AsyncIterable<Secret>;

Returns:

• AsyncIterable<Secret>

list()

list(): Promise<ListResult<Secret>>;

Lists secret metadata for the project (never values).

Returns:

• Promise<ListResult<Secret>>

set()

set(name: string, value: string, options: SetSecretOptions): Promise<void>;

Creates or updates a secret's value + metadata.

Parameters:

• name string
• value string
• options SetSecretOptions

Returns:

• Promise<void>

Secret

type Secret = SecretDto

Secret metadata (never the value).

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

Properties:

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

SecretMeta

type SecretMeta = Schema<"SecretMeta">