app.get_instance¶
Returns instance matching id. If id is not found, Validation error is raised.
Please see query method documentation for options.
No Additional Items
Tuple Validation
Parameter 1: id
id
Type: stringParameter 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. 
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). 
Each item of this array must be:
[
    "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. 
Each item of this array must be:
No Additional Items
Each item of this array must be:
[
    "username",
    "Authentication.status"
]
Count
Type: boolean Default: falseReturn a numeric value representing the number of items that match the specified query-filters. 
Get
Type: boolean Default: falseReturn 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: 0This 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: 0This 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: falseAppEntry
Type: objectNo Additional Properties
Name
Type: stringMust be at least 1 characters long
Id
Type: stringMust be at least 1 characters long
State
Type: enum (of string)Must be one of:
- "CRASHED"
- "DEPLOYING"
- "RUNNING"
- "STOPPED"
- "STOPPING"
Upgrade Available
Type: booleanLatest Version
Must be at least 1 characters long
Image Updates Available
Type: booleanCustom App
Type: booleanMigrated
Type: booleanHuman Version
Type: stringMust be at least 1 characters long
Version
Type: stringMust be at least 1 characters long
Metadata
Type: objectAppActiveWorkloads
Type: objectNo Additional Properties
Containers
Type: integerUsed Ports
Type: array of objectNo Additional Items
Each item of this array must be:
UsedPorts
Type: objectNo Additional Properties
Container Port
Type: integerProtocol
Type: stringHost Ports
Type: array of objectNo Additional Items
Each item of this array must be:
HostPorts
Type: objectNo Additional Properties
Host Port
Type: integerHost Ip
Type: stringContainer Details
Type: array of objectNo Additional Items
Each item of this array must be:
AppContainerDetails
Type: objectNo Additional Properties
Id
Type: stringService Name
Type: stringImage
Type: stringPort Config
Type: array of objectNo Additional Items
Each item of this array must be:
UsedPorts
Type: objectNo Additional Properties
Container Port
Type: integerProtocol
Type: stringHost Ports
Type: arrayNo Additional Items
Each item of this array must be:
State
Type: enum (of string)Must be one of:
- "crashed"
- "created"
- "exited"
- "running"
- "starting"
Volume Mounts
Type: array of objectNo Additional Items
Each item of this array must be:
AppVolumes
Type: objectNo Additional Properties
Source
Type: stringDestination
Type: stringMode
Type: stringType
Type: stringVolumes
Type: array of objectNo Additional Items
Each item of this array must be:
AppVolumes
Type: objectNo Additional Properties
Source
Type: stringDestination
Type: stringMode
Type: stringType
Type: stringImages
Type: array of stringNo Additional Items
Each item of this array must be:
Must be at least 1 characters long
Networks
Type: array of objectNo Additional Items
Each item of this array must be:
AppNetworks
Type: objectName
Type: stringId
Type: stringLabels
Type: objectAdditional Properties of any type are allowed.
Type: objectNotes
Portals
Type: objectVersion Details
Default: nullConfig
Default: nullRequired roles: APPS_READ