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": "et",
"description": "ipsum",
"addressType": "IPv4",
"networks": [
"ad deserunt ipsum qui",
"aute consequat velit Duis elit",
"ea aliquip dolore sit",
"veniam Lorem pariatur reprehenderit"
]
}
}
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": "pariatur",
"doc": {
"id": "fugiat veniam adipisicing et",
"name": "ex reprehenderit nulla do magna",
"description": "sunt anim consequat",
"addressType": "Mixed",
"networks": [
"ut et cillum tempor dolore",
"nulla eu laborum officia",
"in"
],
"created": "1954-08-28T18:50:07.982Z",
"createdBy": "in ullamco esse laborum",
"lastUpdated": "1996-03-21T08:22:05.852Z",
"lastUpdatedBy": "dolor qui elit"
}
}
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"
]
}
}
}
