Summary
Creates a network group.
Description
Creates a new network group.
Route
POST /policy-manager/network-groups
Roles
admin
other
readonly
apiread
Parameters
DetailsExampleSchema
Name |
Type |
Required |
Description |
details |
object |
yes |
Details of network group to be created |
Copied to Clipboard
{
"details": {
"name": "consectetur aliquip",
"description": "mollit",
"addressType": "Mixed",
"networks": [
"Lorem minim",
"nisi qui sed",
"tempor exercitation",
"tempor",
"pariatur ut Lorem in culpa"
]
}
}
Copied to Clipboard
{
"type": "object",
"properties": {
"details": {
"title": "details",
"type": "object",
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"addressType": {
"enum": [
"IPv4",
"IPv6",
"Mixed"
]
},
"networks": {
"type": "array",
"items": {
"title": "networkId",
"type": "string"
}
}
},
"required": [
"name"
]
}
},
"required": [
"details"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
Name |
Type |
Description |
response |
object |
Response object with the document that was created. |
Copied to Clipboard
{
"status": "success",
"message": "magna nostrud",
"doc": {
"id": "nulla nostrud eu",
"name": "est elit",
"description": "ea fugiat aute cillum esse",
"addressType": "IPv6",
"networks": [
"ex Excepteur est sunt",
"id deserunt",
"tempor dolore enim Ut fugiat"
],
"created": "1948-09-25T16:50:04.498Z",
"createdBy": "magna amet",
"lastUpdated": "2009-09-04T12:31:11.236Z",
"lastUpdatedBy": "ipsum eu aliquip"
}
}
Copied to Clipboard
{
"title": "response",
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"success",
"failure"
]
},
"message": {
"type": "string"
},
"doc": {
"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"
]
}
}
}