Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
ON THIS PAGE
 

GET /config/remote_networks/{network_id}

SUMMARY Retrieves a deployed remote network by ID.

Retrieves a deployed remote network by ID.

Table 1: GET /config/remote_networks/{network_id} resource details:

GET /config/remote_networks/{network_id} resource details
MIME Type

application/json

Table 2: GET /config/remote_networks/{network_id} request parameter details:

GET /config/remote_networks/{network_id} request parameter details
Parameter Type Optionality Data Type MIME Type Description

network_id

path

Required

Number (Integer)

text/plain

ID that is used to retrieve a deployed 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.
Table 3: GET /config/remote_networks/{network_id} response codes:

GET /config/remote_networks/{network_id} response codes
HTTP Response Code Unique Code Description

200

The deployed remote network was successfully retrieved.

404

1002

No deployed remote network was found with the provided ID.

500

1020

An error occurred during the retrieval of the remote network.

Response Description

The associated deployed remote network object.
  • 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