ArchAstro.V1.Agents.Schedules (archastro v0.2.0)

Copy Markdown

Schedule API resource.

Summary

Functions

get(client, agent, schedule)

Retrieve a schedule

Returns a single schedule belonging to the specified agent. Use this endpoint to fetch the current state, next run time, and configuration of an individual schedule.

Requires an app-scoped API key. Both the agent and the schedule must belong to the app identified by the key. Returns 404 if the schedule does not exist or belongs to a different agent.

The requested agent schedule.

list(client, agent, params \\ %ArchAstro.Types.Operations.GetApiV1AgentsAgentSchedules.Params{})

List schedules for an agent

Returns all schedules belonging to the specified agent in any status. Use the status parameter to narrow results to a single lifecycle state.

Requires an app-scoped API key. The agent must belong to the app identified by the key.

Successful response