Schema
Type:
object
The body of the "get network" http response message.
Containers
Type:
object
Contains endpoints attached to the network.
All schema constraints and annotations
{
"additionalProperties": {
"$ref": "#/components/schemas/EndpointResource"
},
"description": "Contains endpoints attached to the network.\n",
"example": {
"19a4d5d687db25203351ed79d478946f861258f018fe384f229f2efa4b23513c": {
"EndpointID": "628cadb8bcb92de107b2a1e516cbffe463e321f548feb37697cce00ad694f21a",
"IPv4Address": "172.19.0.2/16",
"IPv6Address": "",
"MacAddress": "02:42:ac:13:00:02",
"Name": "test"
}
},
"type": "object",
"x-omitempty": false
}Services
Type:
object
List of services using the network. This field is only present for
swarm scope networks, and omitted for local scope networks.
All schema constraints and annotations
{
"additionalProperties": {
"x-go-type": {
"hints": {
"nullable": false
},
"type": "ServiceInfo"
}
},
"description": "List of services using the network. This field is only present for\nswarm scope networks, and omitted for local scope networks.\n",
"type": "object",
"x-omitempty": true
}Status
Schema:
NetworkStatus
provides runtime information about the network such as the number of allocated IPs.
All schema constraints and annotations
{
"$ref": "#/components/schemas/NetworkStatus",
"description": "provides runtime information about the network such as the number of allocated IPs.\n"
}All constraints apply
Schema:
Network
All schema constraints and annotations
{
"allOf": [
{
"$ref": "#/components/schemas/Network"
}
],
"description": "The body of the \"get network\" http response message.",
"properties": {
"Containers": {
"additionalProperties": {
"$ref": "#/components/schemas/EndpointResource"
},
"description": "Contains endpoints attached to the network.\n",
"example": {
"19a4d5d687db25203351ed79d478946f861258f018fe384f229f2efa4b23513c": {
"EndpointID": "628cadb8bcb92de107b2a1e516cbffe463e321f548feb37697cce00ad694f21a",
"IPv4Address": "172.19.0.2/16",
"IPv6Address": "",
"MacAddress": "02:42:ac:13:00:02",
"Name": "test"
}
},
"type": "object",
"x-omitempty": false
},
"Services": {
"additionalProperties": {
"x-go-type": {
"hints": {
"nullable": false
},
"type": "ServiceInfo"
}
},
"description": "List of services using the network. This field is only present for\nswarm scope networks, and omitted for local scope networks.\n",
"type": "object",
"x-omitempty": true
},
"Status": {
"$ref": "#/components/schemas/NetworkStatus",
"description": "provides runtime information about the network such as the number of allocated IPs.\n"
}
},
"type": "object",
"x-go-name": "Inspect"
}