ArchAstro.V1.AgentEnvVars (archastro v0.2.0)

Copy Markdown

AgentEnvVar API resource.

Summary

Functions

Delete an agent environment variable

Retrieve an agent environment variable

Update an agent environment variable

Functions

delete(client, env_var)

@spec delete(ArchAstro.Client.t(), String.t()) ::
  {:ok, :ok} | {:error, ArchAstro.Error.reason()}

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.

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

get(client, env_var)

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.

The requested environment variable with its value masked.

update(client, env_var, input)

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.

The updated environment variable with its value masked.