Get a BGP route map

GET 
/bgp-route-maps/:id

Get an existing BGP route map.

Request

Path Parameters

id uuidrequired

The UUID of the configuration resource

Responses

200

OK

application/json

Schema

Schema

oneOf

folder

folder stringrequired

Possible values: <= 64 characters, Value must match regular expression ^[a-zA-Z\d-_\. ]+$

The folder in which the resource is defined

snippet

snippet stringrequired

Possible values: <= 64 characters, Value must match regular expression ^[a-zA-Z\d-_\. ]+$

The snippet in which the resource is defined

device

device stringrequired

Possible values: <= 64 characters, Value must match regular expression ^[a-zA-Z\d-_\. ]+$

The device in which the resource is defined

id string

UUID of the resource

name stringrequired
description string
route_map object[]
Array [
name integer
Possible values: >= 1 and <= 65535
Sequence number
description string
Description
action string
Possible values: [permit, deny]
Action
match object
as_path_access_list string
AS path access list
interface string
Interface
regular_community string
Regular community
origin string
Origin
large_community string
Large community
tag integer
Possible values: >= 1 and <= 4294967295
Tag
extended_community string
Extended community
local_preference integer
Possible values: <= 4294967295
metric integer
Possible values: <= 4294967295
Metric
peer string
Possible values: [local, none]
Peer
ipv4 object
address object
access_list string
Access list
prefix_list string
Prefix list
next_hop object
access_list string
Access list
prefix_list string
Prefix list
route_source object
access_list string
Access list
prefix_list string
Prefix list
set object
atomic_aggregate boolean
Enable BGP atomic aggregate?
local_preference integer
Possible values: <= 4294967295
Local preference
tag integer
Possible values: <= 4294967295
Tag
metric object
action string
Possible values: [set, add, substract]
Metric action
value integer
Possible values: <= 4294967295
Metric value
weight integer
Possible values: <= 4294967295
Weight
origin string
Possible values: [none, egp, igp, incomplete]
Origin
remove_regular_community string
Remove regular community name
remove_large_community string
Remove large community name
originator_id string
Originator ID
aggregator object
as integer
Possible values: >= 1 and <= 4294967295
Aggregator AS
router_id string
Router ID
ipv4 object
source_address string
Source address
next_hop string
Next hop
aspath_exclude integer[]
aspath_prepend integer[]
regular_community string[]
Possible values: [none, blackhole, no-peer, graceful-shutdown, accept-own, local-as, route-filter-v4, route-filter-v6, no-advertise, no-export, internet]
overwrite_regular_community boolean
Overwrite regular community?
large_community string[]
overwrite_large_community boolean
Overwrite large community?
]

Example (from schema)

{
  "id": "123e4567-e89b-12d3-a456-426655440000",
  "name": "string",
  "description": "string",
  "route_map": [
    {
      "name": 0,
      "description": "string",
      "action": "permit",
      "match": {
        "as_path_access_list": "string",
        "interface": "string",
        "regular_community": "string",
        "origin": "string",
        "large_community": "string",
        "tag": 0,
        "extended_community": "string",
        "local_preference": 0,
        "metric": 0,
        "peer": "local",
        "ipv4": {
          "address": {
            "access_list": "string",
            "prefix_list": "string"
          },
          "next_hop": {
            "access_list": "string",
            "prefix_list": "string"
          },
          "route_source": {
            "access_list": "string",
            "prefix_list": "string"
          }
        }
      },
      "set": {
        "atomic_aggregate": true,
        "local_preference": 0,
        "tag": 0,
        "metric": {
          "action": "set",
          "value": 0
        },
        "weight": 0,
        "origin": "none",
        "remove_regular_community": "string",
        "remove_large_community": "string",
        "originator_id": "string",
        "aggregator": {
          "as": 0,
          "router_id": "string"
        },
        "ipv4": {
          "source_address": "string",
          "next_hop": "string"
        },
        "aspath_exclude": [
          0
        ],
        "aspath_prepend": [
          0
        ],
        "regular_community": [
          "none"
        ],
        "overwrite_regular_community": true,
        "large_community": [
          "string"
        ],
        "overwrite_large_community": true
      }
    }
  ]
}

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...