@archastro/sdk
    Preparing search index...
    Index

    Constructors

    Methods

    Constructors

    Methods

    • Delete an agent environment variable Permanently deletes the specified environment variable from the agent. This action is irreversible; the stored value is destroyed and cannot be recovered. The authenticated user must have access to the agent's parent app. Pass the app scope via the app parameter when calling with an API key that is scoped to a specific app. Returns 204 No Content on success.

      Parameters

      • envVar: string

        Environment variable ID (anv_...) of the variable to delete.

      Returns Promise<void>

      Empty response. Returns HTTP 204 No Content on successful deletion.

    • Retrieve an agent environment variable Returns the environment variable identified by env_var. The stored value is always masked in the response; only the last four characters are visible. There is no endpoint that returns the plaintext value after creation. The authenticated user must have access to the agent's parent app. Pass the app scope via the app parameter when calling with an API key that is scoped to a specific app.

      Parameters

      • envVar: string

        Environment variable ID (anv_...) to retrieve.

      Returns Promise<AgentEnvVarMasked>

      The requested environment variable with its value masked.

    • Update an agent environment variable Updates the value or description of an existing environment variable. Only fields provided in the request are changed; omitted fields retain their current values. The variable key cannot be changed after creation. The updated value is stored securely and, like creation, the plaintext is never returned; the response contains the masked representation. The authenticated user must have access to the agent's parent app. Pass the app scope via the app parameter when calling with an API key that is scoped to a specific app.

      Parameters

      • envVar: string

        Environment variable ID (anv_...) to update.

      • input: { description?: string; value?: string }

        Request body.

        • Optionaldescription?: string

          Updated human-readable note describing what the variable is used for.

        • Optionalvalue?: string

          New plaintext secret value. The value is encrypted at rest and never returned in full.

      Returns Promise<AgentEnvVarMasked>

      The updated environment variable with its value masked.