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": "occaecat sit enim reprehenderit",
"description": "ea do eiusmod laborum",
"addressType": "Mixed",
"networks": [
"occaecat mollit"
]
}
}
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": "failure",
"message": "consequat",
"doc": {
"id": "Ut Excepteur voluptate culpa nulla",
"name": "sit non officia amet id",
"description": "exercitation sint veniam deserunt",
"addressType": "IPv4",
"networks": [
"veniam velit elit ad Duis",
"sed occaecat",
"in dolor",
"consectetur veniam Ut fugiat"
],
"created": "1995-01-02T03:54:23.697Z",
"createdBy": "nostrud",
"lastUpdated": "2006-01-02T18:09:26.836Z",
"lastUpdatedBy": "aliquip nisi tempor"
}
}
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"
]
}
}
}
