Skip to main content

List BGP route maps

GET 
/bgp-route-maps

Retrieve a list of BGP route maps.

Request​

Query Parameters

    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

    folder string

    The folder in which the resource is defined

    snippet string

    The snippet in which the resource is defined

    device string

    The device in which the resource is defined

Responses​

OK

Schema
    data object[]
  • Array [
    • 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?

  • ]
  • ]
    • limit number

    Default value: 200

    offset number

    Default value: 0

    total number
Loading...