v1

latestOpenAPI 3.0.02026-07-141,4077,1665.2 MB

Fleet Automation

Get a schedule by ID

Retrieve detailed information about a specific schedule using its unique identifier.

This endpoint returns comprehensive information about a schedule, including:

Schedule metadata (ID, name, creation/update timestamps)
Filter query for selecting target hosts
Recurrence rule defining when deployments are triggered
Version strategy for package upgrades
Current status (active or inactive)

get/api/unstable/fleet/schedules/{id}

Path parameters

idstring required

The unique identifier of the schedule to retrieve.

Response

Example response

{
  "data": {
    "attributes": {
      "created_at_unix": 1699999999,
      "created_by": "user@example.com",
      "name": "Weekly Production Agent Updates",
      "query": "env:prod AND service:web",
      "rule": {
        "days_of_week": [
          "Mon",
          "Wed",
          "Fri"
        ],
        "maintenance_window_duration": 1200,
        "start_maintenance_window": "02:00",
        "timezone": "America/New_York"
      },
      "status": "active",
      "updated_at_unix": 1699999999,
      "updated_by": "user@example.com"
    },
    "id": "abc-def-ghi-123",
    "type": "schedule"
  }
}