@runloop/api-client - v2.0.0
    Preparing search index...

    Class Secrets

    Hierarchy

    • APIResource
      • Secrets
    Index

    Constructors

    Properties

    _client: Runloop

    Methods

    • Create a new Secret with a name and value. The Secret will be encrypted at rest and made available as an environment variable in Devboxes. Creation rejects an existing name within the account on a best-effort basis; concurrent creates may produce duplicates.

      Parameters

      Returns APIPromise<SecretView>

    • Retrieve a Secret by name. If several match, the greatest ID is selected. The secret value is not included for security.

      Parameters

      • name: string
      • Optionaloptions: RequestOptions<unknown>

      Returns APIPromise<SecretView>

    • Update the value of an existing Secret by name. If several Secrets in the account have this name, only the one with the greatest ID at lookup is updated and returned. Older matches are unchanged. A concurrent create may become the latest match. The new value will be encrypted at rest.

      Parameters

      Returns APIPromise<SecretView>

    • Delete an existing Secret by name. If several Secrets in the account have this name, every selected match is deleted and the one with the greatest selected ID is returned. Deletions are not atomic across matches: a failure may leave some matches deleted. A concurrent create may survive. This action is irreversible.

      Parameters

      • name: string
      • Optionalbody: SecretDeleteParams | null
      • Optionaloptions: RequestOptions<unknown>

      Returns APIPromise<SecretView>

    • Retrieve a Secret by ID. The secret value is not included for security.

      Parameters

      • id: string
      • Optionaloptions: RequestOptions<unknown>

      Returns APIPromise<SecretView>