# pool.snapshottask.get_instance

Returns instance matching id. If id is not found, Validation error is raised.

Please see query method documentation for options.

Type: object

##

Type: array
No Additional Items

#### Tuple Validation

##### Parameter 1: id

#### id

Type: integer

##### Parameter 2: options

#### options

Type: object Default: {}

Query options customize the results returned by a query method. More complete documentation with examples are covered in the "Query methods" section of the TrueNAS API documentation.

No Additional Properties

##

#### Extra

Type: object Default: {}

Extra options are defined on a per-endpoint basis and are described in the documentation for the associated query method.

##

#### Order By

Type: array of string Default: []

An array of field names describing the manner in which query results should be ordered. The field names may also have one of more of the following special prefixes: `-` (reverse sort direction), `nulls_first:` (place any null values at the head of the results list), `nulls_last:` (place any null values at the tail of the results list).

No Additional Items

##### Each item of this array must be:

Type: string
Example:

    [
        "size",
        "-devname",
        "nulls_first:-expiretime"
    ]

##

#### Select

Type: array Default: []

An array of field names specifying the exact fields to include in the query return. The dot character `.` may be used to explicitly select only subkeys of the query result.

No Additional Items

##### Each item of this array must be:

## Any of

Type: string
Type: array
No Additional Items

##### Each item of this array must be:

Type: object
Example:

    [
        "username",
        "Authentication.status"
    ]

##

#### Count

Type: boolean Default: false

Return a numeric value representing the number of items that match the specified `query-filters`.

##

#### Get

Type: boolean Default: false

Return the JSON object of the first result matching the specified `query-filters`. The query fails if there specified `query-filters` return no results.

##

#### Offset

Type: integer Default: 0

This specifies the beginning offset of the results array. When combined with the `limit` query-option it may be used to implement pagination of large results arrays. WARNING: some query methods provide volatile results and the onus is on the developer to understand whether pagination is appropriate for a particular query API method.

##

#### Limit

Type: integer Default: 0

This specifies the maximum number of results matching the specified `query-filters` to return. When combined wtih the `offset` query-option it may be used to implement pagination of large results arrays.

WARNING: Some query methods provide volatile results and the onus is on the developer to understand whether pagination is appropriate for a particular query API method.

##

#### Force Sql Filters

Type: boolean Default: false

Force use of SQL for result filtering to reduce response time. May not work for all methods.

##

#### PeriodicSnapshotTaskEntry

Type: object
No Additional Properties

##

#### Dataset

Type: string

The dataset to take snapshots of.

##

#### Recursive

Type: boolean Default: false

Whether to recursively snapshot child datasets.

##

#### Lifetime Value

Type: integer Default: 2

Number of time units to retain snapshots. `lifetime_unit` gives the time unit.

##

#### Lifetime Unit

Type: enum (of string) Default: "WEEK"

Unit of time for snapshot retention.

##### Must be one of:

- "HOUR"
- "DAY"
- "WEEK"
- "MONTH"
- "YEAR"

##

#### Enabled

Type: boolean Default: true

Whether this periodic snapshot task is enabled.

##

#### Exclude

Type: array of string Default: []

Array of dataset patterns to exclude from recursive snapshots.

No Additional Items

##### Each item of this array must be:

Type: string

##

#### Naming Schema

Type: string Default: "auto-%Y-%m-%d_%H-%M"

Naming pattern for generated snapshots using strftime format.

##

#### Allow Empty

Type: boolean Default: true

Whether to take snapshots even if no data has changed.

##

#### PoolSnapshotTaskCron

Type: object

Cron schedule for when snapshots should be taken.

No Additional Properties

##

#### Minute

Type: string Default: "00"

Minute when snapshots should be taken (cron format).

##

#### Hour

Type: string Default: "*"

"00" - "23"

##

#### Dom

Type: string Default: "*"

"1" - "31"

##

#### Month

Type: string Default: "*"

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

##

#### Dow

Type: string Default: "*"

"1" (Monday) - "7" (Sunday)

##

#### Begin

Type: string Default: "00:00"

Start time of the window when snapshots can be taken.

Examples:

    "00:00"

    "06:30"

    "18:00"

    "23:00"

##

#### End

Type: string Default: "23:59"

End time of the window when snapshots can be taken.

Examples:

    "00:00"

    "06:30"

    "18:00"

    "23:00"

##

#### Id

Type: integer

Unique identifier for the periodic snapshot task.

##

#### State

Type: object

Detailed state information for the task.

##

#### Vmware Sync

Type: boolean

Whether VMware VMs are synced before taking snapshots.

Required roles: SNAPSHOT_TASK_READ