List remote networks

GET 
/remote-networks

Retrieve a list of remote networks.

Request

Query Parameters

folder anyrequired

The folder in which the resource is defined

limit number

Default value: 200

The maximum number of results per page

offset number

Default value: 0

The offset into the list of results returned

name string

The name of the configuration resource

Responses

200

OK

application/json

Schema

Schema

data object[]
Array [
id uuidrequired
The UUID of the remote network
name stringrequired
Possible values: <= 63 characters
The name of the remote network
folder stringrequired
Default value: Remote Networks
The folder that contains the remote network
ipsec_tunnel string
ipsec_tunnel is required when ecmp_load_balancing is disable
secondary_ipsec_tunnel string
specify secondary ipsec_tunnel if needed
license_type stringrequired
Possible values: non-empty
Default value: FWAAS-AGGREGATE
New customer will only be on aggregate bandwidth licensing
connection_type string
Possible values: [prisma-access, meraki, cisco-catalyst-sdwan, velocloud, prisma-sdwan]
Default value: prisma-access
The connection type for the remote network
region stringrequired
Possible values: non-empty
subnets string[]
protocol object
setup the protocol when ecmp_load_balancing is disable
bgp object
enable boolean
Enable BGP peering?
summarize_mobile_user_routes boolean
Summarize mobile user routes?
originate_default_route boolean
Originate default route?
do_not_export_routes boolean
Do not export routes?
peer_ip_address string
Remote peer IP address
peer_as string
BGP peer ASN
local_ip_address string
Local peer IP address
secret password
BGP peering secret
peering_type string
Possible values: [exchange-v4-over-v4, exchange-v4-v6-over-v4, exchange-v4-over-v4-v6-over-v6, exchange-v6-over-v6]
Route exchange types
bgp_peer object
secondary bgp routing as bgp_peer
same_as_primary boolean
Default value: true
If true, the secondary BGP peer configuration will be the same as the primary BGP peer.
peer_ip_address string
Remote peer IP address (secondary WAN)
local_ip_address string
Local peer IP address (secondary WAN)
secret password
BGP peering secret (secondary WAN)
spn_name string
spn-name is needed when license_type is FWAAS-AGGREGATE
ecmp_load_balancing string
Possible values: [enable, disable]
Default value: disable
ecmp_tunnels object[]
Possible values: <= 4
ecmp_tunnels is required when ecmp_load_balancing is enable
Array [
name stringrequired
ipsec_tunnel stringrequired
protocol objectrequired
bgp object
enable boolean
Enable BGP peering?
summarize_mobile_user_routes boolean
Summarize mobile user routes?
originate_default_route boolean
Originate default route?
do_not_export_routes boolean
Do not export routes?
peer_ip_address string
Remote peer IP address
peer_as string
BGP peer ASN
local_ip_address string
Local peer IP address
secret password
BGP peering secret
peering_type string
Possible values: [exchange-v4-over-v4, exchange-v4-v6-over-v4, exchange-v4-over-v4-v6-over-v6, exchange-v6-over-v6]
Route exchange types
]
]
limit number

Default value: 200

offset number

Default value: 0

total number

Example (from schema)

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426655440000",
      "name": "string",
      "folder": "Remote Networks",
      "ipsec_tunnel": "string",
      "secondary_ipsec_tunnel": "string",
      "license_type": "FWAAS-AGGREGATE",
      "connection_type": "prisma-access",
      "region": "string",
      "subnets": [
        "string"
      ],
      "protocol": {
        "bgp": {
          "enable": true,
          "summarize_mobile_user_routes": true,
          "originate_default_route": true,
          "do_not_export_routes": true,
          "peer_ip_address": "string",
          "peer_as": "string",
          "local_ip_address": "string",
          "secret": "string",
          "peering_type": "exchange-v4-over-v4"
        },
        "bgp_peer": {
          "same_as_primary": true,
          "peer_ip_address": "string",
          "local_ip_address": "string",
          "secret": "string"
        }
      },
      "spn_name": "string",
      "ecmp_load_balancing": "disable",
      "ecmp_tunnels": [
        {
          "name": "string",
          "ipsec_tunnel": "string",
          "protocol": {
            "bgp": {
              "enable": true,
              "summarize_mobile_user_routes": true,
              "originate_default_route": true,
              "do_not_export_routes": true,
              "peer_ip_address": "string",
              "peer_as": "string",
              "local_ip_address": "string",
              "secret": "string",
              "peering_type": "exchange-v4-over-v4"
            }
          }
        }
      ]
    }
  ],
  "limit": 200,
  "offset": 0,
  "total": 0
}

400

Bad Request

application/json

Schema

Schema

_errors object[]
Array [
code string
message string
details object
help string
]
_request_id string

Example (from schema)

{
  "_errors": [
    {
      "code": "string",
      "message": "string",
      "details": {},
      "help": "string"
    }
  ],
  "_request_id": "string"
}

input_format_mismatch

Input Format Mismatch

{
  "_errors": [
    {
      "code": "E003",
      "message": "Input Format Mismatch: input-format=json",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

output_format_mismatch

Output Format Mismatch

{
  "_errors": [
    {
      "code": "E003",
      "message": "Output Format Mismatch: output-format=json Accept=xml",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

missing_query_parameter

Missing Query Parameter

{
  "_errors": [
    {
      "code": "E003",
      "message": "Missing Query Parameter: name",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

invalid_query_parameter

Invalid Query Parameter

{
  "_errors": [
    {
      "code": "E003",
      "message": "Invalid Query Parameter: location=invalid",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

401

Unauthorized

application/json

Schema

Schema

_errors object[]
Array [
code string
message string
details object
help string
]
_request_id string

Example (from schema)

{
  "_errors": [
    {
      "code": "string",
      "message": "string",
      "details": {},
      "help": "string"
    }
  ],
  "_request_id": "string"
}

auth_not_authenticated

Not Authenticated

{
  "_errors": [
    {
      "code": "E016",
      "message": "Not Authenticated",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

invalid_credential

Invalid Credential

{
  "_errors": [
    {
      "code": "E016",
      "message": "Invalid Credential",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

key_too_long

Key Too Long

{
  "_errors": [
    {
      "code": "E016",
      "message": "Key Too Long",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

key_expired

Key Expired

{
  "_errors": [
    {
      "code": "E016",
      "message": "Key Expired",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

need_password_change

Need Password Change

{
  "_errors": [
    {
      "code": "E016",
      "message": "The password needs to be changed.",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

403

Forbidden

application/json

Schema

Schema

_errors object[]
Array [
code string
message string
details object
help string
]
_request_id string

Example (from schema)

{
  "_errors": [
    {
      "code": "string",
      "message": "string",
      "details": {},
      "help": "string"
    }
  ],
  "_request_id": "string"
}

auth_unauthorized

Unauthorized

{
  "_errors": [
    {
      "code": "E007",
      "message": "Unauthorized",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

404

Not Found

application/json

Schema

Schema

_errors object[]
Array [
code string
message string
details object
help string
]
_request_id string

Example (from schema)

{
  "_errors": [
    {
      "code": "string",
      "message": "string",
      "details": {},
      "help": "string"
    }
  ],
  "_request_id": "string"
}

object_not_present

Object Not Present

{
  "_errors": [
    {
      "code": "E005",
      "message": "Object Not Present",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

default

General Errors

application/json

Schema

Schema

_errors object[]
Array [
code string
message string
details object
help string
]
_request_id string

Example (from schema)

{
  "_errors": [
    {
      "code": "string",
      "message": "string",
      "details": {},
      "help": "string"
    }
  ],
  "_request_id": "string"
}

version_not_supported

Version Not Supported

{
  "_errors": [
    {
      "code": "E012",
      "message": "Version Not Supported",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

method_not_allowed

Method Not Supported

{
  "_errors": [
    {
      "code": "E012",
      "message": "Method Not Supported",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

action_not_supported

Action Not Supported

{
  "_errors": [
    {
      "code": "E012",
      "message": "Action Not Supported: move",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

bad_xpath

Bad XPath

{
  "_errors": [
    {
      "code": "E013",
      "message": "Bad XPath",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

invalid_command

Invalid Command

{
  "_errors": [
    {
      "code": "E003",
      "message": "Invalid Command",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

malformed_command

Malformed Command

{
  "_errors": [
    {
      "code": "E003",
      "message": "Malformed Command",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

session_timeout

Session Timeout

{
  "_errors": [
    {
      "code": "4",
      "message": "Session Timeout",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

Loading...