CreateSchedule | Proto Fleet Documentation

{
  "name": "example",
  "action": 0,
  "action_config": {
    "mode": 0
  },
  "schedule_type": 0,
  "recurrence": {
    "_day_of_month": {
      "day_of_month": 42
    },
    "frequency": 0,
    "interval": 42,
    "days_of_week": [
      0
    ]
  },
  "start_date": "example",
  "start_time": "example",
  "end_time": "example",
  "end_date": "example",
  "timezone": "example",
  "targets": [
    {
      "target_type": 0,
      "target_id": "example"
    }
  ]
}

{
  "schedule": {
    "id": 42,
    "name": "example",
    "action": 0,
    "action_config": {
      "mode": 0
    },
    "schedule_type": 0,
    "recurrence": {
      "_day_of_month": {
        "day_of_month": 42
      },
      "frequency": 0,
      "interval": 42,
      "days_of_week": [
        0
      ]
    },
    "start_date": "example",
    "start_time": "example",
    "end_time": "example",
    "end_date": "example",
    "timezone": "example",
    "status": 0,
    "priority": 42,
    "created_by": 42,
    "created_at": {
      "seconds": 42,
      "nanos": 42
    },
    "updated_at": {
      "seconds": 42,
      "nanos": 42
    },
    "last_run_at": {
      "seconds": 42,
      "nanos": 42
    },
    "next_run_at": {
      "seconds": 42,
      "nanos": 42
    },
    "targets": [
      {
        "target_type": 0,
        "target_id": "example"
      }
    ],
    "created_by_username": "example"
  }
}

Creates a new schedule

CreateScheduleRequest

Request

This endpoint expects an object.

namestring

Schedule name (required, 1-100 characters)

actionenum

Action to perform (required)

Allowed values:

action_configobject

Power target configuration (required when action is SET_POWER_TARGET)

schedule_typeenum

Schedule type (required)

Allowed values:

recurrenceobject

Recurrence configuration (required when schedule_type is RECURRING)

start_datestring

Start date in YYYY-MM-DD format (required)

start_timestring

Start time in HH:MM format (required)

end_timestring

End time in HH:MM format (for power target time windows)

end_datestring

End date in YYYY-MM-DD format (if set, schedule ends on this date; if absent, runs indefinitely)

timezonestring

IANA timezone string (required, e.g. “America/Chicago”)

targetslist of objects

Targets for this schedule (racks and/or miners)

CreateScheduleResponse

Response

This endpoint returns an object.

scheduleobject

Full schedule entity