certificate.query

Type: object

Call parameters

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"
    ]
]

[
    [
        "OR",
        [
            [
                [
                    "name",
                    "=",
                    "bob"
                ]
            ],
            [
                [
                    "name",
                    "=",
                    "larry"
                ]
            ]
        ]
    ]
]

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

Relationships

Type: boolean Default: true

extend

Extend

Default: null

Any of

• Option 1
• Option 2

Type: string

Type: null

extend_fk

Extend Fk

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

Each item of this array must be:

Type: string

extend_context

Extend Context

Default: null

Any of

• Option 1
• Option 2

Type: string

Type: null

prefix

Prefix

Default: null

Any of

• Option 1
• Option 2

Type: string

Type: null

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

Return value

Result

Any of

• Option 1
• CertificateQueryResultItem
• Option 3

Type: array of object
No Additional Items

Each item of this array must be:

CertificateQueryResultItem

Type: object
No Additional Properties

id

Id

Type: integer

type

Type

Type: integer

name

Name

Type: string

Must be at least 1 characters long

certificate

Certificate

Any of

• Option 1
• Option 2

Type: string

Type: null

privatekey

Privatekey

Any of

• Option 1
• Option 2

Type: string

Type: null

CSR

Csr

Any of

• Option 1
• Option 2

Type: string

Type: null

acme_uri

Acme Uri

Any of

• Option 1
• Option 2

Type: string

Type: null

domains_authenticators

Domains Authenticators

Any of

• Option 1
• Option 2

Type: object

Type: null

renew_days

Renew Days

Any of

• Option 1
• Option 2

Type: integer

Type: null

acme

Acme

Any of

• Option 1
• Option 2

Type: object

Type: null

add_to_trusted_store

Add To Trusted Store

Type: boolean

root_path

Root Path

Type: string

Must be at least 1 characters long

certificate_path

Certificate Path

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

privatekey_path

Privatekey Path

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

csr_path

Csr Path

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

cert_type

Cert Type

Type: string

Must be at least 1 characters long

cert_type_existing

Cert Type Existing

Type: boolean

cert_type_CSR

Cert Type Csr

Type: boolean

chain_list

Chain List

Type: array of string
No Additional Items

Each item of this array must be:

Type: string

key_length

Key Length

Any of

• Option 1
• Option 2

Type: integer

Type: null

key_type

Key Type

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

country

Country

Any of

• Option 1
• Option 2

Type: string

Type: null

state

State

Any of

• Option 1
• Option 2

Type: string

Type: null

city

City

Any of

• Option 1
• Option 2

Type: string

Type: null

organization

Organization

Any of

• Option 1
• Option 2

Type: string

Type: null

organizational_unit

Organizational Unit

Any of

• Option 1
• Option 2

Type: string

Type: null

common

Common

Any of

• Option 1
• Option 2

Type: string

Type: null

san

San

Any of

• Option 1
• Option 2

Type: array of string
No Additional Items

Each item of this array must be:

Type: string

Type: null

email

Email

Any of

• Option 1
• Option 2

Type: string

Type: null

DN

Dn

Any of

• Option 1
• Option 2

Type: string

Type: null

subject_name_hash

Subject Name Hash

Any of

• Option 1
• Option 2

Type: integer

Type: null

extensions

Extensions

Type: object

digest_algorithm

Digest Algorithm

Any of

• Option 1
• Option 2

Type: string

Type: null

lifetime

Lifetime

Any of

• Option 1
• Option 2

Type: integer

Type: null

from

From

Any of

• Option 1
• Option 2

Type: string

Type: null

until

Until

Any of

• Option 1
• Option 2

Type: string

Type: null

serial

Serial

Any of

• Option 1
• Option 2

Type: integer

Type: null

chain

Chain

Any of

• Option 1
• Option 2

Type: boolean

Type: null

fingerprint

Fingerprint

Any of

• Option 1
• Option 2

Type: string

Type: null

expired

Expired

Any of

• Option 1
• Option 2

Type: boolean

Type: null

parsed

Parsed

Type: boolean

CertificateQueryResultItem

Type: object
No Additional Properties

id

Id

Type: integer

type

Type

Type: integer

name

Name

Type: string

Must be at least 1 characters long

certificate

Certificate

Any of

• Option 1
• Option 2

Type: string

Type: null

privatekey

Privatekey

Any of

• Option 1
• Option 2

Type: string

Type: null

CSR

Csr

Any of

• Option 1
• Option 2

Type: string

Type: null

acme_uri

Acme Uri

Any of

• Option 1
• Option 2

Type: string

Type: null

domains_authenticators

Domains Authenticators

Any of

• Option 1
• Option 2

Type: object

Type: null

renew_days

Renew Days

Any of

• Option 1
• Option 2

Type: integer

Type: null

acme

Acme

Any of

• Option 1
• Option 2

Type: object

Type: null

add_to_trusted_store

Add To Trusted Store

Type: boolean

root_path

Root Path

Type: string

Must be at least 1 characters long

certificate_path

Certificate Path

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

privatekey_path

Privatekey Path

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

csr_path

Csr Path

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

cert_type

Cert Type

Type: string

Must be at least 1 characters long

cert_type_existing

Cert Type Existing

Type: boolean

cert_type_CSR

Cert Type Csr

Type: boolean

chain_list

Chain List

Type: array of string
No Additional Items

Each item of this array must be:

Type: string

key_length

Key Length

Any of

• Option 1
• Option 2

Type: integer

Type: null

key_type

Key Type

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

country

Country

Any of

• Option 1
• Option 2

Type: string

Type: null

state

State

Any of

• Option 1
• Option 2

Type: string

Type: null

city

City

Any of

• Option 1
• Option 2

Type: string

Type: null

organization

Organization

Any of

• Option 1
• Option 2

Type: string

Type: null

organizational_unit

Organizational Unit

Any of

• Option 1
• Option 2

Type: string

Type: null

common

Common

Any of

• Option 1
• Option 2

Type: string

Type: null

san

San

Any of

• Option 1
• Option 2

Type: array of string
No Additional Items

Each item of this array must be:

Type: string

Type: null

email

Email

Any of

• Option 1
• Option 2

Type: string

Type: null

DN

Dn

Any of

• Option 1
• Option 2

Type: string

Type: null

subject_name_hash

Subject Name Hash

Any of

• Option 1
• Option 2

Type: integer

Type: null

extensions

Extensions

Type: object

digest_algorithm

Digest Algorithm

Any of

• Option 1
• Option 2

Type: string

Type: null

lifetime

Lifetime

Any of

• Option 1
• Option 2

Type: integer

Type: null

from

From

Any of

• Option 1
• Option 2

Type: string

Type: null

until

Until

Any of

• Option 1
• Option 2

Type: string

Type: null

serial

Serial

Any of

• Option 1
• Option 2

Type: integer

Type: null

chain

Chain

Any of

• Option 1
• Option 2

Type: boolean

Type: null

fingerprint

Fingerprint

Any of

• Option 1
• Option 2

Type: string

Type: null

expired

Expired

Any of

• Option 1
• Option 2

Type: boolean

Type: null

parsed

Parsed

Type: boolean

Type: integer

Required roles: CERTIFICATE_READ