Get a remote network

Get a remote network.

Path Parameters

• id string required

  The resource's unique identifier.

Responses

• 200
• 400
• 401
• 403
• 404
• default

---

Get the remote network by id.

application/json

• Schema
• Example (from schema)

---

Schema

• Array [
• ecmp_load_balancing string

  Possible values: [enable, disable]

  Default value: disable

• ecmp_tunnels object[]

  ecmp_tunnels is required when ecmp_load_balancing is enable

  Array [

  name string required

  ipsec_tunnel string required

  protocol object required

  bgp object

  enable boolean

  to setup bgp protocol, enable need to set as true

  summarize_mobile_user_routes boolean

  originate_default_route boolean

  do_not_export_routes boolean

  peer_ip_address string

  peer_as string

  local_ip_address string

  secret string

  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]

  Exchange Routes: exchange-v4-over-v4 stands for Exchange IPv4 routes over IPv4 peering. exchange-v4-v6-over-v4 stands for Exchange both IPv4 and IPv6 routes over IPv4 peering. exchange-v4-over-v4-v6-over-v6 stands for Exchange IPv4 routes over IPv4 peer and IPv6 route over IPv6 peer. exchange-v6-over-v6 stands for Exchange IPv6 routes over IPv6 peering.

  ]
• id string

  uuid of the resource

• ipsec_tunnel string

  ipsec_tunnel is required when ecmp_load_balancing is disable

• license_type string required

  Possible values: non-empty

  Default value: FWAAS-AGGREGATE

  New customer will only be on aggregate bandwidth licensing

• name string required

  Possible values: <= 63 characters

  Alphanumeric string begin with letter: [0-9a-zA-Z._-]

• protocol object

  bgp object

  do_not_export_routes boolean

  enable boolean

  local_ip_address string

  originate_default_route boolean

  peer_as string

  peer_ip_address string

  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]

  Exchange Routes: exchange-v4-over-v4 stands for Exchange IPv4 routes over IPv4 peering. exchange-v4-v6-over-v4 stands for Exchange both IPv4 and IPv6 routes over IPv4 peering. exchange-v4-over-v4-v6-over-v6 stands for Exchange IPv4 routes over IPv4 peer and IPv6 route over IPv6 peer. exchange-v6-over-v6 stands for Exchange IPv6 routes over IPv6 peering.

  secret string

  summarize_mobile_user_routes boolean

  bgp_peer object

  local_ip_address string

  peer_ip_address string

  secret string
• region string required

  Possible values: non-empty

• secondary_ipsec_tunnel string
• spn_name string

  spn-name is needed when license_type is FWAAS-AGGREGATE

• subnets 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"
          }
        }
      }
    ],
    "id": "abcd-1234",
    "ipsec_tunnel": "string",
    "license_type": "FWAAS-AGGREGATE",
    "name": "string",
    "protocol": {
      "bgp": {
        "do_not_export_routes": true,
        "enable": true,
        "local_ip_address": "string",
        "originate_default_route": true,
        "peer_as": "string",
        "peer_ip_address": "string",
        "peering_type": "exchange-v4-over-v4",
        "secret": "string",
        "summarize_mobile_user_routes": true
      },
      "bgp_peer": {
        "local_ip_address": "string",
        "peer_ip_address": "string",
        "secret": "string"
      }
    },
    "region": "string",
    "secondary_ipsec_tunnel": "string",
    "spn_name": "string",
    "subnets": [
      "string"
    ]
  }
]

Bad Request

application/json

• Schema
• Example (from schema)
• input_format_mismatch
• invalid_query_parameter
• missing_query_parameter
• output_format_mismatch

---

Schema

• _errors object[]

  Array [

  code string

  details object

  help string

  message string

  ]
• _request_id string

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

Input Format Mismatch

{
  "_errors": [
    {
      "code": "E003",
      "details": {},
      "message": "Input Format Mismatch: input-format=json"
    }
  ],
  "_request_id": "abcd-1234"
}

Invalid Query Parameter

{
  "_errors": [
    {
      "code": "E003",
      "details": {},
      "message": "Invalid Query Parameter: location=invalid"
    }
  ],
  "_request_id": "abcd-1234"
}

Missing Query Parameter

{
  "_errors": [
    {
      "code": "E003",
      "details": {},
      "message": "Missing Query Parameter: name"
    }
  ],
  "_request_id": "abcd-1234"
}

Output Format Mismatch

{
  "_errors": [
    {
      "code": "E003",
      "details": {},
      "message": "Output Format Mismatch: output-format=json Accept=xml"
    }
  ],
  "_request_id": "abcd-1234"
}

Unauthorized

application/json

• Schema
• Example (from schema)
• auth_not_authenticated
• invalid_credential
• key_expired
• key_too_long
• need_password_change

---

Schema

• _errors object[]

  Array [

  code string

  details object

  help string

  message string

  ]
• _request_id string

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

Not Authenticated

{
  "_errors": [
    {
      "code": "E016",
      "details": {},
      "message": "Not Authenticated"
    }
  ],
  "_request_id": "abcd-1234"
}

Invalid Credential

{
  "_errors": [
    {
      "code": "E016",
      "details": {},
      "message": "Invalid Credential"
    }
  ],
  "_request_id": "abcd-1234"
}

Key Expired

{
  "_errors": [
    {
      "code": "E016",
      "details": {},
      "message": "Key Expired"
    }
  ],
  "_request_id": "abcd-1234"
}

Key Too Long

{
  "_errors": [
    {
      "code": "E016",
      "details": {},
      "message": "Key Too Long"
    }
  ],
  "_request_id": "abcd-1234"
}

Need Password Change

{
  "_errors": [
    {
      "code": "E016",
      "details": {},
      "message": "The password needs to be changed."
    }
  ],
  "_request_id": "abcd-1234"
}

Forbidden

application/json

• Schema
• Example (from schema)
• auth_unauthorized

---

Schema

• _errors object[]

  Array [

  code string

  details object

  help string

  message string

  ]
• _request_id string

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

Unauthorized

{
  "_errors": [
    {
      "code": "E007",
      "details": {},
      "message": "Unauthorized"
    }
  ],
  "_request_id": "abcd-1234"
}

Not Found

application/json

• Schema
• Example (from schema)
• object_not_present

---

Schema

• _errors object[]

  Array [

  code string

  details object

  help string

  message string

  ]
• _request_id string

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

Object Not Present

{
  "_errors": [
    {
      "code": "E005",
      "details": {},
      "message": "Object Not Present"
    }
  ],
  "_request_id": "abcd-1234"
}

General Errors

application/json

• Schema
• Example (from schema)
• action_not_supported
• bad_xpath
• invalid_command
• malformed_command
• method_not_allowed
• session_timeout
• version_not_supported

---

Schema

• _errors object[]

  Array [

  code string

  details object

  help string

  message string

  ]
• _request_id string

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

Action Not Supported

{
  "_errors": [
    {
      "code": "E012",
      "details": {},
      "message": "Action Not Supported: move"
    }
  ],
  "_request_id": "abcd-1234"
}

Bad XPath

{
  "_errors": [
    {
      "code": "E013",
      "details": {},
      "message": "Bad XPath"
    }
  ],
  "_request_id": "abcd-1234"
}

Invalid Command

{
  "_errors": [
    {
      "code": "E003",
      "details": {},
      "message": "Invalid Command"
    }
  ],
  "_request_id": "abcd-1234"
}

Malformed Command

{
  "_errors": [
    {
      "code": "E003",
      "details": {},
      "message": "Malformed Command"
    }
  ],
  "_request_id": "abcd-1234"
}

Method Not Supported

{
  "_errors": [
    {
      "code": "E012",
      "details": {},
      "message": "Method Not Supported"
    }
  ],
  "_request_id": "abcd-1234"
}

Session Timeout

{
  "_errors": [
    {
      "code": 4,
      "details": {},
      "message": "Session Timeout"
    }
  ],
  "_request_id": "abcd-1234"
}

Version Not Supported

{
  "_errors": [
    {
      "code": "E012",
      "details": {},
      "message": "Version Not Supported"
    }
  ],
  "_request_id": "abcd-1234"
}

Loading...