Get a BGP route map redistribution

GET /bgp-route-map-redistributions/:id

Get an existing BGP route map redistribution.

Request

Path Parameters

id uuidrequired

The UUID of the configuration resource

Responses

application/json

Schema
Example (from schema)

Schema

anyOf

MOD1
MOD2

oneOf

bgp
ospf
connected_static

bgp object required

oneOf

ospf
rib

ospf objectrequired

route_map object[]

Route maps

Array [

name integer

Possible values: >= 1 and <= 65535

Sequence number

action string

Possible values: [permit, deny]

Action

description string

Description

match object

as_path_access_list string

AS path access list

regular_community string

Regular community

large_community string

Large community

extended_community string

Extended community

interface string

Interface

origin string

Origin

metric integer

Possible values: <= 4294967295

Metric

tag integer

Possible values: >= 1 and <= 4294967295

Tag

local_preference integer

Possible values: >= 1 and <= 4294967295

Local preference

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

metric object

value integer

Possible values: <= 4294967295

Metric value

action string

Possible values: [set, add, subtract]

Metric action

metric_type string

Possible values: [type-1, type-2]

Metric type

tag integer

Possible values: >= 1 and <= 4294967295

Tag

]

rib objectrequired

route_map object[]

Route maps

Array [

name integer

Possible values: >= 1 and <= 65535

Sequence number

action string

Possible values: [permit, deny]

Action

description string

Description

match object

as_path_access_list string

AS path access list

regular_community string

Regular community

large_community string

Large community

extended_community string

Extended community

interface string

Interface

origin string

Origin

metric integer

Possible values: <= 4294967295

Metric

tag integer

Possible values: >= 1 and <= 4294967295

Tag

local_preference integer

Possible values: >= 1 and <= 4294967295

Local preference

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

source_address string

Source address

]

ospf object required

oneOf

bgp objectrequired

route_map object[]

Route maps

Array [

name integer

Possible values: >= 1 and <= 65535

Sequence number

action string

Possible values: [permit, deny]

Action

description string

Description

match object

interface string

Interface

metric integer

Possible values: <= 4294967295

Metric

tag integer

Possible values: >= 1 and <= 4294967295

Tag

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

set object

atomic_aggregate boolean

Enable BGP atomic aggregate?

local_preference integer

Possible values: <= 4294967295

Local preference

tag integer

Possible values: >= 1 and <= 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

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_prepend integer[]

Possible values: >= 1 and <= 65535

AS numbers

regular_community string[]

Regular communities

large_community string[]

Large communities

]

rib objectrequired

route_map object[]

Route maps

Array [

name integer

Possible values: >= 1 and <= 65535

Sequence number

action string

Possible values: [permit, deny]

Action

description string

Description

match object

interface string

Interface

metric integer

Possible values: <= 4294967295

Metric

tag integer

Possible values: >= 1 and <= 4294967295

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

set object

source_address string

Source address

]

connected_static object required

oneOf

bgp
ospf
rib

bgp objectrequired

route_map object[]

Route maps

Array [

name integer

Possible values: >= 1 and <= 65535

Sequence number

action string

Possible values: [permit, deny]

Action

description string

Description

match object

interface string

Interface

metric integer

Possible values: <= 4294967295

Metric

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

set object

atomic_aggregate boolean

Enable BGP atomic aggregate?

local_preference integer

Possible values: <= 4294967295

Local preference

tag integer

Possible values: >= 1 and <= 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

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_prepend integer[]

Possible values: >= 1 and <= 65535

AS numbers

regular_community string[]

Regular communities

large_community string[]

Large communities

]

ospf objectrequired

route_map object[]

Route maps

Array [

name integer

Possible values: >= 1 and <= 65535

Sequence number

action string

Possible values: [permit, deny]

Action

description string

Description

match object

interface string

Interface

metric integer

Possible values: <= 4294967295

Metric

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

set object

metric object

action string

Possible values: [set, add, substract]

Metric action

value integer

Possible values: <= 4294967295

Metric value

metric_type string

Possible values: [type-1, type-2]

Metric type

tag integer

Possible values: >= 1 and <= 4294967295

Tag

]

rib objectrequired

route_map object[]

Route maps

Array [

name integer

Possible values: >= 1 and <= 65535

Sequence number

action string

Possible values: [permit, deny]

Action

description string

Description

match object

interface string

Interface

metric integer

Possible values: <= 4294967295

Metric

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

set object

source_address string

Source address

]

oneOf

folder
snippet
device

folder stringrequired

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

The folder in which the resource is defined

snippet stringrequired

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

The snippet in which the resource is defined

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

Name

description string

Description

{
  "id": "123e4567-e89b-12d3-a456-426655440000",
  "name": "string",
  "description": "string"
}

Bad Request

application/json

Schema

_errors object[]

Array [

code string

message string

details object

help string

]

_request_id string

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

Input Format Mismatch

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

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

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

Invalid Query Parameter

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

Unauthorized

application/json

Schema

_errors object[]

Array [

code string

message string

details object

help string

]

_request_id string

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

Not Authenticated

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

Invalid Credential

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

Key Too Long

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

Key Expired

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

Need Password Change

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

Forbidden

application/json

Schema
Example (from schema)
auth_unauthorized

Schema

_errors object[]

Array [

code string

message string

details object

help string

]

_request_id string

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

Unauthorized

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

Not Found

application/json

Schema
Example (from schema)
object_not_present

Schema

_errors object[]

Array [

code string

message string

details object

help string

]

_request_id string

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

Object Not Present

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

General Errors

application/json

Schema

_errors object[]

Array [

code string

message string

details object

help string

]

_request_id string

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

Version Not Supported

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

Method Not Supported

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

Action Not Supported

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

Bad XPath

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

Invalid Command

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

Malformed Command

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

Session Timeout

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

Get a BGP route map redistribution

/bgp-route-map-redistributions/:id

Request​

Path Parameters

Responses​

Request

Responses