Summary
Gets all network groups
Description
Returns all available network group documents.
Route
GET /policy-manager/network-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"
},
"name": {
"type": "string"
},
"description": {
"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": "Ut commodo sit elit minim",
"name": "ad ut ipsum nulla in",
"description": "et",
"addressType": "IPv6",
"networks": [
"esse Excepteur id fugiat ut"
],
"created": "1960-06-02T18:36:37.123Z",
"createdBy": "ad non et Excepteur dolore",
"lastUpdated": "1952-06-06T11:32:37.27Z",
"lastUpdatedBy": "cillum"
},
{
"id": "magna cupidatat velit ut",
"name": "labore dolore consectetur Excepteur",
"description": "sed labore",
"addressType": "Mixed",
"networks": [
"cillum magna Duis dolor irure",
"laborum nisi Lorem nulla"
],
"created": "1989-02-19T08:23:21.132Z",
"createdBy": "velit non tempor ullamco id",
"lastUpdated": "1978-12-08T02:15:01.782Z",
"lastUpdatedBy": "dolore consectetur veniam elit"
}
],
"pageData": {
"total": 67675328,
"skip": -42090350,
"limit": 10121965
}
}
Copied to Clipboard
{
"title": "response",
"type": "object",
"properties": {
"results": {
"type": "array",
"items": {
"title": "networkGroup",
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"addressType": {
"enum": [
"IPv4",
"IPv6",
"Mixed"
]
},
"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",
"name",
"description",
"addressType",
"networks",
"created",
"createdBy",
"lastUpdated",
"lastUpdatedBy"
]
}
},
"pageData": {
"type": "object",
"properties": {
"total": {
"type": "integer"
},
"skip": {
"type": "integer"
},
"limit": {
"type": "integer"
}
},
"required": [
"total",
"skip",
"limit"
]
}
},
"required": [
"results",
"pageData"
]
}
