---
title: "Create a ZFS scrub schedule"
method: POST
path: "/zfs/pools/scrub/schedules"
tags: ["ZFS"]
---

# Create a ZFS scrub schedule

`POST /zfs/pools/scrub/schedules`

## Request

- Base URL: `https://sylve.lan:8181/api`
- URL: `https://sylve.lan:8181/api/zfs/pools/scrub/schedules`
- Auth: API key in header `Authorization`

## Request body

- GithubComAlchemillahqSylveInternalServicesZfsPoolScrubScheduleInput
  - `cronExpr` string, required
  - `enabled` boolean
  - `poolGuid` string, required

## Response `201`

Created

- GithubComAlchemillahqSylveInternalAPIResponseGithubComAlchemillahqSylveInternalServicesZfsPoolScrubScheduleView
  - `data` GithubComAlchemillahqSylveInternalServicesZfsPoolScrubScheduleView
    - `active` boolean
    - `createdAt` string
    - `cronExpr` string
    - `enabled` boolean
    - `id` integer
    - `lastError` string
    - `lastRunAt` string
    - `lastStatus` string
    - `nextRunAt` string
    - `poolGuid` string
    - `poolName` string
    - `progressKnown` boolean
    - `progressPct` integer
    - `queuedAt` string
    - `updatedAt` string
  - `error` string
  - `message` string
  - `status` string

## Other responses

- `400`: Bad Request
- `404`: Not Found
- `409`: Conflict
- `413`: Request Entity Too Large
- `500`: Internal Server Error
- `503`: Service Unavailable

## Changes

- **2026-10-13** `3b2ab23c2629`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/alchemillahq/apis/sylve-api/changes/zfs/pools/scrub/schedules/post.md)

---

[API](https://skmtc.dev/alchemillahq/apis/sylve-api.md) - [All operations](https://skmtc.dev/alchemillahq/apis/sylve-api/llms.txt) - [OpenAPI document](https://skmtc.dev/alchemillahq/apis/sylve-api/revisions/9565cdd0abf5?raw)
