docker.network.query¶
Query all docker networks
Type: object
No Additional Properties
Type: array
No Additional Items
No Additional Items
No Additional Properties
No Additional Items
No Additional Items
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: objectDefault:
{
"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
Type: boolean Default: trueExtend
Default: null Type: string
Type: null
Extend Context
Default: null Type: string
Type: null
Prefix
Default: null Type: string
Type: null
Extra
Type: object Default: {}Order By
Type: array of string Default: []No Additional Items
Each item of this array must be:
Type: string
Select
Type: array Default: []No Additional Items
Each item of this array must be:
Type: string
Type: array
No Additional Items
No Additional Items
Each item of this array must be:
Type: object
Count
Type: boolean Default: falseGet
Type: boolean Default: falseOffset
Type: integer Default: 0Limit
Type: integer Default: 0Force Sql Filters
Type: boolean Default: falseResult
Type: array of object
No Additional Items
No Additional Properties
No Additional Items
Each item of this array must be:
DockerNetworkQueryResultItem
Type: objectNo Additional Properties
Ipam
Type: object
Type: null
Labels
Type: object
Type: null
Created
Type: string
Must be at least 1 characters long
Type: null
Driver
Type: string
Must be at least 1 characters long
Type: null
Id
Type: string
Must be at least 1 characters long
Type: null
Name
Type: string
Must be at least 1 characters long
Type: null
Scope
Type: string
Must be at least 1 characters long
Type: null
Short Id
Type: string
Must be at least 1 characters long
Type: null
DockerNetworkQueryResultItem
Type: objectNo Additional Properties
Ipam
Type: object
Type: null
Labels
Type: object
Type: null
Created
Type: string
Must be at least 1 characters long
Type: null
Driver
Type: string
Must be at least 1 characters long
Type: null
Id
Type: string
Must be at least 1 characters long
Type: null
Name
Type: string
Must be at least 1 characters long
Type: null
Scope
Type: string
Must be at least 1 characters long
Type: null
Short Id
Type: string
Must be at least 1 characters long
Type: null
Type: integer
Required roles: DOCKER_READ