ON THIS PAGE
GET /config/remote_networks
SUMMARY Retrieves a list of deployed remote networks.
Retrieves the list of deployed remote networks
MIME Type |
---|
application/json |
Parameter | Type | Optionality | Data Type | MIME Type | Description |
---|---|---|---|---|---|
Range |
header |
Optional |
String |
text/plain |
Optional - Use this parameter to restrict the number of elements that are returned in the list to a specified range. The list is indexed starting at zero. |
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. |
filter |
query |
Optional |
String |
text/plain |
Optional - This parameter is used to restrict the elements in a list base on the contents of various fields. |
HTTP Response Code | Unique Code | Description |
---|---|---|
200 |
The deployed remote networks list was successfully retrieved. |
|
500 |
1020 |
An internal server error was occurred during the retrieval of the list of deployed remote networks. |
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" } ]