Skip to content

PluginSecretsAPI

Since Plugin API: 1.1.0

Encrypted, Plugin-scoped string storage. The OS credential service unlocks its vault.

Signature

interface PluginSecretsAPI {
status(): Promise<"ready" | "locked">;
has(key: string): Promise<boolean>;
get(key: string): Promise<string | null>;
set(key: string, value: string): Promise<void>;
delete(key: string): Promise<void>;
}

Members

Name Type Required Description
status () => Promise<"ready" &#124; "locked"> yes -
has (key: string) => Promise<boolean> yes -
get (key: string) => Promise<string &#124; null> yes -
set (key: string, value: string) => Promise<void> yes -
delete (key: string) => Promise<void> yes -

This article includes AI-assisted content.

Documentation is licensed under CC BY 4.0. Phoundry names and marks remain reserved.