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": "elit in",
"type": "networkGroup",
"name": "eu",
"description": "laboris eiusmod nostrud fugiat",
"addressType": "Mixed",
"created": "1976-01-06T04:59:13.137Z",
"createdBy": "magna dolor nostrud",
"lastUpdated": "1942-05-04T15:10:55.661Z",
"lastUpdatedBy": "id officia irure",
"address": "occaecat laborum officia",
"networks": [
"non ipsum occaecat nulla incididunt",
"in elit ea",
"tempor aliquip dolore labore in",
"occaecat",
"ex dolore culpa aute ad"
]
},
{
"id": "dolor",
"type": "networkGroup",
"name": "ea proident veniam",
"description": "et",
"addressType": "IPv6",
"created": "1991-01-31T19:38:06.01Z",
"createdBy": "Duis incididunt ad sit",
"lastUpdated": "1962-06-09T22:11:29.819Z",
"lastUpdatedBy": "sit dolore laborum",
"address": "dolore",
"networks": [
"non consectetur reprehenderit laboris",
"consequat id deserunt eu",
"aliquip dolore aute",
"reprehenderit fugiat"
]
},
{
"id": "qui occaecat",
"type": "networkGroup",
"name": "reprehenderit fugiat eu commodo",
"description": "deserunt sunt nulla",
"addressType": "IPv4",
"created": "1984-03-06T14:05:18.386Z",
"createdBy": "sint",
"lastUpdated": "1950-09-13T13:02:18.2Z",
"lastUpdatedBy": "occaecat sunt id",
"address": "esse in",
"networks": [
"qui deserunt ad",
"voluptate laboris in"
]
},
{
"id": "eiusmod",
"type": "network",
"name": "aliquip dolor nisi",
"description": "tempor Excepteur labore culpa",
"addressType": "Mixed",
"created": "2008-03-12T11:28:35.497Z",
"createdBy": "Duis amet non",
"lastUpdated": "1954-11-06T02:13:36.995Z",
"lastUpdatedBy": "nulla Duis fugiat ipsum dolor",
"address": "sunt mollit ullamco magna",
"networks": [
"in",
"ut reprehenderit",
"eiusmod dolore culpa"
]
},
{
"id": "minim tempor consequat id",
"type": "networkGroup",
"name": "nisi esse do enim",
"description": "minim",
"addressType": "IPv4",
"created": "2014-06-12T04:53:09.785Z",
"createdBy": "amet aliquip",
"lastUpdated": "1988-03-25T02:41:56.658Z",
"lastUpdatedBy": "laborum qui ex ad",
"address": "cupidatat adipisicing tempor Duis",
"networks": [
"officia culpa et incididunt eiusmod",
"quis",
"est exercitation aliqua tempor",
"do"
]
}
],
"pageData": {
"total": -37349263,
"skip": 10154707,
"limit": -58833571
}
}
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"
]
}