# pool.scrub.create

Create a scrub task for a pool.

threshold refers to the minimum amount of time in days has to be passed before a scrub can run again.

Type: object

##

Type: array
No Additional Items

#### Tuple Validation

##### Parameter 1: data

#### data

Type: object

Configuration for the new scrub schedule.

No Additional Properties

##

#### Pool

Type: integer

ID of the pool to scrub.

Value must be strictly greater than `0`

##

#### Threshold

Type: integer Default: 35

Days before a scrub is due when a scrub should automatically start.

Value must be greater or equal to `0`

##

#### Description

Type: string Default: ""

Description or notes for this scrub schedule.

##

#### PoolScrubCron

Type: object

Cron schedule for when scrubs should run.

No Additional Properties

##

#### Minute

Type: string Default: "00"

Minute when the scrub should run (cron format).

##

#### Hour

Type: string Default: "00"

Hour when the scrub should run (cron format).

##

#### Dom

Type: string Default: "*"

"1" - "31"

##

#### Month

Type: string Default: "*"

"1" (January) - "12" (December)

##

#### Dow

Type: string Default: "7"

Day of week when the scrub should run (cron format, 7=Sunday).

##

#### Enabled

Type: boolean Default: true

Whether this scrub schedule is enabled.

##

#### PoolScrubEntry

Type: object

The newly created scrub schedule configuration.

No Additional Properties

##

#### Pool

Type: integer

ID of the pool to scrub.

Value must be strictly greater than `0`

##

#### Threshold

Type: integer Default: 35

Days before a scrub is due when a scrub should automatically start.

Value must be greater or equal to `0`

##

#### Description

Type: string Default: ""

Description or notes for this scrub schedule.

##

#### PoolScrubCron

Type: object

Cron schedule for when scrubs should run.

No Additional Properties

##

#### Minute

Type: string Default: "00"

Minute when the scrub should run (cron format).

##

#### Hour

Type: string Default: "00"

Hour when the scrub should run (cron format).

##

#### Dom

Type: string Default: "*"

"1" - "31"

##

#### Month

Type: string Default: "*"

"1" (January) - "12" (December)

##

#### Dow

Type: string Default: "7"

Day of week when the scrub should run (cron format, 7=Sunday).

##

#### Enabled

Type: boolean Default: true

Whether this scrub schedule is enabled.

##

#### Id

Type: integer

Unique identifier for the scrub schedule.

##

#### Pool Name

Type: string

Name of the pool being scrubbed.

Required roles: POOL_SCRUB_WRITE