pool.snapshot.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: string
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:

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.

PoolSnapshotEntry

Type: object
No Additional Properties

Id

Type: string

Full snapshot identifier including dataset and snapshot name.

Properties

Type: object

Object mapping ZFS property names to their values and metadata.

Each additional property must conform to the following schema

PoolSnapshotEntryPropertyFields

Type: object
No Additional Properties

Value

Type: string

Current effective value of the ZFS property as a string.

Rawvalue

Type: string

Raw string value of the ZFS property as stored.

Source

Type: enum (of string)

Source of the property value.

  • NONE: Property is not set
  • DEFAULT: Using ZFS default value
  • LOCAL: Set locally on this snapshot
  • TEMPORARY: Temporary override value
  • INHERITED: Inherited from parent dataset
  • RECEIVED: Set by ZFS receive operation
Must be one of:
  • "NONE"
  • "DEFAULT"
  • "LOCAL"
  • "TEMPORARY"
  • "INHERITED"
  • "RECEIVED"

Parsed

Type: object

Property value parsed into the appropriate type (string, boolean, integer, etc.).

Pool

Type: string

Name of the ZFS pool containing this snapshot.

Name

Type: string

Full name of the snapshot including dataset path.

Type

Type: const

Type identifier indicating this is a ZFS snapshot.

Must be one of:
  • "SNAPSHOT"
Specific value: "SNAPSHOT"

Snapshot Name

Type: string

Just the snapshot name portion without the dataset path.

Dataset

Type: string

Name of the dataset this snapshot was taken from.

Createtxg

Type: string

Transaction group ID when the snapshot was created.

Holds

Type: object

Returned when options.extra.holds is set.

 No Additional Properties

Truenas

Type: integer

Present if a hold has been placed on the snapshot.

Retention


Returned when options.extra.retention is set.


PoolSnapshotRetentionPST

Type: object
No Additional Properties

Datetime

Type: stringFormat: date-time

Timestamp when the snapshot will be eligible for removal.

Source

Type: const

Indicates retention is managed by a periodic snapshot task.

Must be one of:
  • "periodic_snapshot_task"
Specific value: "periodic_snapshot_task"

Periodic Snapshot Task Id

Type: integer

ID of the periodic snapshot task managing this retention.

PoolSnapshotRetentionProperty

Type: object
No Additional Properties

Datetime

Type: stringFormat: date-time

Timestamp when the snapshot will be eligible for removal.

Source

Type: const

Indicates retention is managed by ZFS properties.

Must be one of:
  • "property"
Specific value: "property"
Type: null


Required roles: SNAPSHOT_READ