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": "consectetur proident Lorem sit",
"name": "in dolore",
"description": "dolore",
"addressType": "IPv4",
"networks": [
"nulla exercitation laboris",
"nostrud exercitation",
"veniam laborum",
"qui id dolor",
"laborum tempor"
],
"created": "1956-10-05T10:11:47.172Z",
"createdBy": "cillum fugiat",
"lastUpdated": "1973-01-30T12:56:11.595Z",
"lastUpdatedBy": "irure"
},
{
"id": "Duis",
"name": "veniam do laborum irure",
"description": "aute sed mollit sunt",
"addressType": "IPv4",
"networks": [
"ad",
"fugiat",
"nostrud",
"eiusmod magna ipsum",
"quis officia"
],
"created": "1960-06-14T11:02:39.686Z",
"createdBy": "sint commodo ut enim eiusmod",
"lastUpdated": "1960-12-10T23:45:43.904Z",
"lastUpdatedBy": "ut pariatur Duis elit"
},
{
"id": "ea officia",
"name": "deserunt quis velit sit",
"description": "voluptate et nisi in",
"addressType": "IPv6",
"networks": [
"sint consequat",
"laborum id reprehenderit",
"consequat",
"nisi nostrud voluptate aute",
"commodo deserunt Duis Ut laboris"
],
"created": "1945-05-06T22:35:53.195Z",
"createdBy": "sed",
"lastUpdated": "2014-10-02T00:53:17.621Z",
"lastUpdatedBy": "dolore in"
},
{
"id": "sed",
"name": "incididunt do enim aliquip",
"description": "id anim Lorem",
"addressType": "IPv4",
"networks": [
"Excepteur labore",
"cillum Duis ad dolore sunt",
"deserunt pariatur"
],
"created": "1954-07-12T16:02:34.922Z",
"createdBy": "consectetur fugiat esse ut culpa",
"lastUpdated": "1971-06-15T17:49:21.792Z",
"lastUpdatedBy": "esse est tempor"
},
{
"id": "sunt aliqua minim non",
"name": "eiusmod ut voluptate",
"description": "elit adipisicing commodo",
"addressType": "IPv6",
"networks": [
"pariatur",
"in aliquip nisi ullamco"
],
"created": "1967-06-25T20:52:09.289Z",
"createdBy": "in pariatur",
"lastUpdated": "2020-04-04T20:07:27.655Z",
"lastUpdatedBy": "in sed velit Duis"
}
],
"pageData": {
"total": -75743690,
"skip": 26413994,
"limit": -97253526
}
}
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"
]
}