ArchAstro. V1. Agents. AgentEnvVars
(archastro v0.2.0)
Copy Markdown
AgentAgentEnvVar API resource.
Summary
Functions
@spec create( ArchAstro.Client.t(), String.t(), ArchAstro.Types.Operations.PostApiV1AgentsAgentAgentEnvVars.Input.t() ) :: {:ok, ArchAstro.Types.AgentEnvVarMasked.t()} | {:error, ArchAstro.Error.reason()}
Create an agent environment variable
Creates a new environment variable for the specified agent. The variable is
stored securely and the plaintext value is never returned after creation;
subsequent reads return a masked representation showing only the last four
characters.
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. Each key must be unique within the agent; attempting to
create a duplicate key returns a validation error.
The newly created environment variable with its value masked.
@spec list(ArchAstro.Client.t(), String.t()) :: {:ok, ArchAstro.Types.AgentEnvVarMaskedList.t()} | {:error, ArchAstro.Error.reason()}
List an agent's environment variables
Returns all environment variables defined for the specified agent. Variable values are always masked in the response; only the last four characters are visible. To inspect a specific variable, use the retrieve endpoint.
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. Results are returned in an unordered flat list.
List of environment variables for the agent, with values masked.