app.image.get_instance

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

Please see query method documentation for options.

Type: object

Call parameters

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

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

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

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

• Option 1
• Option 2

Type: string

Type: array
No Additional Items

Each item of this array must be:

Type: object

Example:

[
    "username",
    "Authentication.status"
]

count

Count

Type: boolean Default: false

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

get

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

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

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

Force Sql Filters

Type: boolean Default: false

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

Return value

AppImageEntry

Type: object
No Additional Properties

id Required

Id

Type: string

Unique identifier for the container image (usually SHA256 hash).

Must be at least 1 characters long

repo_tags Required

Repo Tags

Type: array of string

Array of repository tags associated with this image.

No Additional Items

Each item of this array must be:

Type: string

repo_digests Required

Repo Digests

Type: array of string

Array of repository digests (content-addressable identifiers) for this image.

No Additional Items

Each item of this array must be:

Type: string

size Required

Size

Type: integer

Size of the container image in bytes.

dangling Required

Dangling

Type: boolean

Whether this is a dangling image (no tags or references).

update_available Required

Update Available

Type: boolean

Whether a newer version of this image is available for download.

created Required

Created

Timestamp when the container image was created (ISO format) or null if not available.

Any of

• Option 1
• Option 2

Type: string

Type: null

author Required

Author

Author or maintainer of the container image or null if not specified.

Any of

• Option 1
• Option 2

Type: string

Type: null

comment Required

Comment

Comment or description provided by the image author or null if not provided.

Any of

• Option 1
• Option 2

Type: string

Type: null

parsed_repo_tags

Parsed Repo Tags

Default: null

Parsed repository tag information or null if not available.

Any of

• Option 1
• Option 2

Type: array of object
No Additional Items

Each item of this array must be:

AppImageParsedRepoTags

Type: object
No Additional Properties

reference Required

Reference

Type: string

Full reference to the container image (registry/repository:tag).

image Required

Image

Type: string

Container image name without registry or tag.

tag Required

Tag

Type: string

Image tag (version) or digest identifier.

registry Required

Registry

Type: string

Container registry hostname (e.g., docker.io, quay.io).

complete_tag Required

Complete Tag

Type: string

Complete image reference including registry, image name, and tag.

reference_is_digest Required

Reference Is Digest

Type: boolean

Whether the reference uses a digest hash instead of a tag name.

Type: null

Required roles: APPS_READ