Fleet Automation

Get a schedule by ID

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

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

Request

Path parameters

idstring required

The unique identifier of the schedule to retrieve.

Response

OK

Example response

{
  "data": {
    "attributes": {
      "created_at": "2023-11-14T22:13:19Z",
      "created_by": "user@example.com",
      "name": "Weekly Production Agent Updates",
      "next_run": "2025-01-06T02:00:00Z",
      "query": "env:prod AND service:web",
      "rule": {
        "days_of_week": [
          "Mon",
          "Wed",
          "Fri"
        ],
        "interval": 1,
        "maintenance_window_duration": 120,
        "start_maintenance_window": "0200",
        "timezone": "America/New_York"
      },
      "status": "active",
      "updated_at": "2023-11-14T22:13:19Z",
      "updated_by": "user@example.com"
    },
    "id": "abc-def-ghi-123",
    "type": "schedule"
  }
}

Changes

Changes to this operation have not been checked yet.