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": "amet cupidatat deserunt voluptate incididunt",
"name": "non labore aute do",
"description": "ut sit quis consectetur amet",
"addressType": "IPv6",
"networks": [
"anim nisi mollit sed adipisicing"
],
"created": "1945-08-01T18:22:05.45Z",
"createdBy": "laborum officia anim dolor",
"lastUpdated": "1972-12-01T01:11:52.077Z",
"lastUpdatedBy": "aliqua nulla quis elit dolore"
},
{
"id": "sed",
"name": "in consequat consectetur",
"description": "aute et laboris amet proident",
"addressType": "Mixed",
"networks": [
"ea ut veniam",
"consequat tempor veniam",
"labore Duis dolore proident velit",
"enim velit ullamco voluptate amet",
"sed in incididunt"
],
"created": "1957-03-23T11:42:21.412Z",
"createdBy": "in culpa minim officia",
"lastUpdated": "1956-08-28T14:03:11.27Z",
"lastUpdatedBy": "cupidatat ullamco"
},
{
"id": "Lorem consectetur sunt",
"name": "in Lorem",
"description": "occaecat ipsum culpa Lorem in",
"addressType": "IPv4",
"networks": [
"eiusmod amet laborum aute",
"eu fugiat officia reprehenderit minim",
"proident",
"amet"
],
"created": "2003-04-24T01:09:58.701Z",
"createdBy": "ex elit et aliqua Duis",
"lastUpdated": "2007-05-12T14:54:29.802Z",
"lastUpdatedBy": "aliquip"
}
],
"pageData": {
"total": 73135496,
"skip": -88734979,
"limit": 7685175
}
}
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"
]
}
