docker.network.query

Type: object

Call parameters

Type: array
No Additional Items

Tuple Validation

Parameter 1: filters

filters

Type: array Default: []
No Additional Items

Each item of this array must be:

Type: object

Parameter 2: options

options

Type: object

Default:

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

No Additional Properties

relationships

Relationships

Type: boolean Default: true

extend

Extend

Default: null

Any of

• Option 1
• Option 2

Type: string

Type: null

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.

Value must be greater or equal to 0

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.

Value must be greater or equal to 0 and lesser or equal to 10000

force_sql_filters

Force Sql Filters

Type: boolean Default: false

Return value

Result

Any of

• Option 1
• DockerNetworkEntry
• Option 3
• Option 4
• Option 5

Type: array of object
No Additional Items

Each item of this array must be:

DockerNetworkEntry

Type: object
No Additional Properties

ipam Required

Ipam

Any of

• Option 1
• Option 2

Type: object

Type: null

labels Required

Labels

Any of

• Option 1
• Option 2

Type: object

Type: null

created Required

Created

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

driver Required

Driver

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

id Required

Id

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

name Required

Name

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

scope Required

Scope

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

short_id Required

Short Id

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

DockerNetworkEntry

Type: object
No Additional Properties

ipam Required

Ipam

Any of

• Option 1
• Option 2

Type: object

Type: null

labels Required

Labels

Any of

• Option 1
• Option 2

Type: object

Type: null

created Required

Created

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

driver Required

Driver

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

id Required

Id

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

name Required

Name

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

scope Required

Scope

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

short_id Required

Short Id

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

Type: array of object
No Additional Items

Each item of this array must be:

Type: object

Type: object

Type: integer

Required roles: DOCKER_READ