Summary
Updates a network group
Description
Updates a network group based on given option properties.
Route
PUT /policy-manager/network-groups/:id
Roles
admin
other
readonly
apiread
Parameters
DetailsExampleSchema
| Name |
Type |
Required |
Description |
| id |
string |
yes |
ID of the network group. |
| details |
object |
yes |
Object containing the fields to be updated |
Copied to Clipboard
{
"details": {
"name": "amet in exercitation",
"description": "minim officia veniam",
"addressType": "IPv4",
"networks": [
"cupidatat aute ad",
"sit aliqua anim nostrud consequat"
]
}
}
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 of the updates to the network. |
Copied to Clipboard
{
"status": "success",
"message": "enim Duis sit dolor consectetur",
"doc": {
"id": "id aliqua minim",
"name": "ea",
"description": "Duis nulla in",
"addressType": "IPv4",
"networks": [
"laboris incididunt Ut labore eu",
"in"
],
"created": "1966-05-13T04:02:13.291Z",
"createdBy": "dolore consectetur occaecat sed nulla",
"lastUpdated": "1976-12-15T01:40:10.745Z",
"lastUpdatedBy": "fugiat"
}
}
Copied to Clipboard
{
"title": "response",
"type": "object",
"properties": {
"status": {
"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"
]
}
}
}
