ON THIS PAGE
GET /staged_config/remote_networks/{network_id}
SUMMARY Retrieves a staged remote network by ID.
Retrieves a staged remote network by ID.
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 retrieve a staged remote network. |
fields |
query |
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. |
HTTP Response Code | Unique Code | Description |
---|---|---|
200 |
The staged remote network was successfully retrieved. |
|
404 |
1002 |
No staged remote network was found with the provided ID. |
500 |
1020 |
An error occurred during the retrieval 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" }