Type: object

Type: array
No Additional Items

Tuple Validation

Parameter 1: filters

filters

Type: array Default: []

List of filters for query results. See API documentation for "Query Methods" for more guidance.

No Additional Items

Each item of this array must be:

Type: object

Examples:

[
        [
            "name",
            "=",
            "bob"
        ]
    ]

Parameter 2: options

options

Type: object

Default:

{ "relationships": true, "extend": null, "extend_fk": [], "extend_context": null, "prefix": null, "extra": {}, "order_by": [], "select": [], "count": false, "get": false, "offset": 0, "limit": 0, "force_sql_filters": false }

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

Relationships

Type: boolean Default: true

Extend

Default: null

Type: string

Type: null

Extend Fk

Type: array of string Default: []
No Additional Items

Each item of this array must be:

Type: string

Extend Context

Default: null

Any of

Option 1
Option 2

Type: string

Type: null

Prefix

Default: null

Any of

Option 1
Option 2

Type: string

Type: null

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

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

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

Result

Any of

Type: array of object
No Additional Items

Each item of this array must be:

CertificateQueryResultItem

Type: object
No Additional Properties

Id

Type: integer

Type

Type: integer

Option 1
Option 2

Type: object

Type: null

Add To Trusted Store

Type: boolean

Root Path

Type: string

Must be at least 1 characters long

Certificate Path

Any of

Option 1
Option 2

Type: string

Must be at least 1 characters long

Type: null

Privatekey Path

Any of

Option 1
Option 2

Type: string

Must be at least 1 characters long

Type: null

Csr Path

Any of

Option 1
Option 2

Type: string

Must be at least 1 characters long

Type: null

Cert Type

Type: string

Must be at least 1 characters long

Cert Type Existing

Type: boolean

Cert Type Csr

Type: boolean

Chain List

Type: array of string
No Additional Items

Each item of this array must be:

Type: string

Key Length

Any of

Option 1
Option 2

Type: integer

Type: null

Key Type

Any of

Option 1
Option 2

Option 1
Option 2

Type: array of string
No Additional Items

Option 1
Option 2

Type: integer

Type: null

Extensions

Type: object

Digest Algorithm

Any of

Option 1
Option 2

Type: string

Type: null

Lifetime

Any of

Option 1
Option 2

Type: integer

Type: null

From

Any of

Option 1
Option 2

Type: string

Type: null

Until

Any of

Option 1
Option 2

Type: string

Type: null

Serial

Any of

Option 1
Option 2

Type: integer

Type: null

Chain

Any of

Option 1
Option 2

Type: boolean

Type: null

Fingerprint

Any of

Option 1
Option 2

Type: string

Type: null

Expired

Any of

Option 1
Option 2

Type: boolean

Type: null

Parsed

Type: boolean

CertificateQueryResultItem

Type: object
No Additional Properties

Id

Type: integer

Type

Type: integer

Option 1
Option 2

Type: object

Type: null

Add To Trusted Store

Type: boolean

Root Path

Type: string

Must be at least 1 characters long

Certificate Path

Any of

Option 1
Option 2

Type: string

Must be at least 1 characters long

Type: null

Privatekey Path

Any of

Option 1
Option 2

Type: string

Must be at least 1 characters long

Type: null

Csr Path

Any of

Option 1
Option 2

Type: string

Must be at least 1 characters long

Type: null

Cert Type

Type: string

Must be at least 1 characters long

Cert Type Existing

Type: boolean

Cert Type Csr

Type: boolean

Chain List

Type: array of string
No Additional Items

Each item of this array must be:

Type: string

Key Length

Any of

Option 1
Option 2

Type: integer

Type: null

Key Type

Any of

Option 1
Option 2

Option 1
Option 2

Type: array of string
No Additional Items

Option 1
Option 2

Type: integer

Type: null

Extensions

Type: object

Digest Algorithm

Any of

Option 1
Option 2

Type: string

Type: null

Lifetime

Any of

Option 1
Option 2

Type: integer

Type: null

From

Any of

Option 1
Option 2

Type: string

Type: null

Until

Any of

Option 1
Option 2

Type: string

Type: null

Serial

Any of

Option 1
Option 2

Type: integer

Type: null

Chain

Any of

Option 1
Option 2

Type: boolean

Type: null

Fingerprint

Any of

Option 1
Option 2

Type: string

Type: null

Expired

Any of

Option 1
Option 2

Type: boolean

Type: null

Parsed

Type: boolean

Type: integer

Call parameters

Tuple Validation

Parameter 1: filters

filters

Each item of this array must be:

Parameter 2: options

options

relationships

Relationships

extend

Extend

Any of

extend_fk

Extend Fk

Each item of this array must be:

extend_context

Extend Context

Any of

prefix

Prefix

Any of

extra

Extra

order_by

Order By

Each item of this array must be:

select

Select

Each item of this array must be:

Any of

Each item of this array must be:

count

Count

get

Get

offset

Offset

limit

Limit

force_sql_filters

Force Sql Filters

Return value

Result

Any of

Each item of this array must be:

CertificateQueryResultItem

id

Id

type

Type

name

Name

certificate

Certificate

Any of

privatekey

Privatekey

Any of

CSR

Csr

Any of

acme_uri

Acme Uri

Any of

domains_authenticators

Domains Authenticators

Any of

renew_days

Renew Days

Any of

acme

Acme

Any of

add_to_trusted_store

Add To Trusted Store

root_path

Root Path

certificate_path

Certificate Path

Any of