Summary
Gets all networks and network groups
Description
Returns all available networks and network group documents.
Route
GET /policy-manager/networks-and-groups
Roles
admin
other
readonly
apiread
Parameters
DetailsExampleSchema
| Name |
Type |
Required |
Description |
| query |
object |
yes |
Optional query parameters |
Copied to Clipboard
{
"query": {
"limit": 10,
"sort": "name",
"skip": 10
}
}
Copied to Clipboard
{
"type": "object",
"properties": {
"query": {
"title": "query",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"address": {
"type": "string"
},
"addressType": {
"type": "string"
},
"limit": {
"type": "integer"
},
"sort": {
"type": "string"
},
"skip": {
"type": "integer"
},
"order": {
"type": "integer"
}
},
"type": "object",
"examples": [
{
"limit": 10,
"sort": "name",
"skip": 10
}
]
}
},
"required": [
"query"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
| Name |
Type |
Description |
| response |
object |
All network documents. |
Copied to Clipboard
{
"results": [
{
"id": "ea laborum dolor",
"type": "network",
"name": "culpa",
"description": "dolore eu tempor",
"addressType": "Mixed",
"created": "1960-05-19T19:04:24.974Z",
"createdBy": "fugiat",
"lastUpdated": "1968-01-19T00:41:52.767Z",
"lastUpdatedBy": "anim",
"address": "deserunt officia cupidatat sint",
"networks": [
"Duis incididunt aute ad ipsum"
]
},
{
"id": "deserunt",
"type": "networkGroup",
"name": "irure reprehenderit Ut mollit",
"description": "id elit ea cupidatat",
"addressType": "IPv6",
"created": "1969-07-10T11:04:54.395Z",
"createdBy": "eiusmod velit aute anim",
"lastUpdated": "1948-11-20T19:10:07.66Z",
"lastUpdatedBy": "laboris",
"address": "dolore non",
"networks": [
"eiusmod",
"anim occaecat adipisicing",
"laboris reprehenderit exercitation fugiat"
]
}
],
"pageData": {
"total": 40994266,
"skip": -80160287,
"limit": 58290921
}
}
Copied to Clipboard
{
"title": "response",
"type": "object",
"properties": {
"results": {
"type": "array",
"items": {
"title": "networkGroup",
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": [
"network",
"networkGroup"
]
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"addressType": {
"enum": [
"IPv4",
"IPv6",
"Mixed"
]
},
"address": {
"type": "string"
},
"networks": {
"type": "array",
"items": {
"title": "networkId",
"type": "string"
}
},
"created": {
"type": "string",
"format": "date-time"
},
"createdBy": {
"type": "string"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"lastUpdatedBy": {
"type": "string"
}
},
"required": [
"id",
"type",
"name",
"description",
"addressType",
"created",
"createdBy",
"lastUpdated",
"lastUpdatedBy"
]
}
},
"pageData": {
"type": "object",
"properties": {
"total": {
"type": "integer"
},
"skip": {
"type": "integer"
},
"limit": {
"type": "integer"
}
},
"required": [
"total",
"skip",
"limit"
]
}
},
"required": [
"results",
"pageData"
]
}
