ON THIS PAGE
POST /staged_config/remote_networks/{network_id}
SUMMARY Updates an existing staged remote network.
Updates an existing staged remote network.
| MIME Type |
|---|
application/json |
| Parameter | Type | Optionality | Data Type | MIME Type | Description |
|---|---|---|---|---|---|
network_id |
path |
Required |
Number (Integer) |
text/plain |
ID that is used to update a staged remote network. |
fields |
header |
Optional |
String |
text/plain |
Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets and multiple fields in the same object are separated by commas. |
| Parameter | Data Type | MIME Type | Description | Sample |
|---|---|---|---|---|
network |
Object |
application/json |
The updated remote network object. |
{ "cidrs": [ "String" ], "description": "String", "group": "String", "id": 42, "name": "String" } |
| HTTP Response Code | Unique Code | Description |
|---|---|---|
200 |
The staged remote network was successfully updated. |
|
404 |
1002 |
No staged remote network was found for the provided network ID. |
409 |
1008 |
The remote network name already exists in the selected group. |
422 |
1005 |
A request parameter is invalid. |
500 |
1020 |
An error occurred during the uopdate of the remote network. |
Response Description
- id - Long - The ID of the remote network.
- name - String - The name of the remote network.
- description - String - The description of the remote network.
- group - String - The group the remote network belongs to.
- cidrs - Array of <String> - A list of all the CIDR ranges that belong to the remote network.
Response Sample
{
"cidrs": [
"String"
],
"description": "String",
"group": "String",
"id": 42,
"name": "String"
}