@grow-codes/hashicorp-vault - v0.1.1
    Preparing search index...

    Interface Kv

    The KV interface shared by KvV1, KvV2 and the auto-detecting mount.

    interface Kv {
        mount: string;
        delete(path: string, options?: KvCallOptions): Promise<void>;
        deleteMetadata(path: string, options?: KvCallOptions): Promise<void>;
        deleteVersions(
            path: string,
            versions: number[],
            options?: KvCallOptions,
        ): Promise<void>;
        destroy(
            path: string,
            versions: number[],
            options?: KvCallOptions,
        ): Promise<void>;
        list(path?: string, options?: KvCallOptions): Promise<string[]>;
        patch(
            path: string,
            data: Record<string, unknown>,
            options?: KvWriteOptions,
        ): Promise<KvVersionMetadata>;
        read(path: string, options?: KvReadOptions): Promise<KvSecret>;
        readMetadata(path: string, options?: KvCallOptions): Promise<KvMetadata>;
        undelete(
            path: string,
            versions: number[],
            options?: KvCallOptions,
        ): Promise<void>;
        write(
            path: string,
            data: Record<string, unknown>,
            options?: KvWriteOptions,
        ): Promise<KvVersionMetadata | null>;
        writeMetadata(path: string, options: KvMetadataOptions): Promise<void>;
    }

    Implemented by

    Index
    mount: string

    Mount path, e.g. secret.

    • Deletes the secret (v2: soft-deletes the latest version). Missing paths are not an error.

      Parameters

      Returns Promise<void>

    • Deletes the secret with all versions and metadata. KV v2 only.

      Parameters

      Returns Promise<void>

    • Soft-deletes versions. KV v2 only.

      Parameters

      Returns Promise<void>

    • Permanently destroys versions. KV v2 only.

      Parameters

      Returns Promise<void>

    • Keys directly under a folder (sub-folders end in /); [] when there is none.

      Parameters

      Returns Promise<string[]>

    • Restores soft-deleted versions. KV v2 only.

      Parameters

      Returns Promise<void>