Update a BGP route map

PUT /bgp-route-maps/:id

Update an existing BGP route map.

Request

Path Parameters

id uuidrequired

The UUID of the configuration resource

application/json

Body

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

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?

]

Responses

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"
}

Missing Body

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

Invalid Object

{
  "_errors": [
    {
      "code": "E003",
      "message": "Invalid Object",
      "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"
}

Conflict

application/json

Schema
Example (from schema)
object_not_unique
name_not_unique
reference_not_zero

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 Unique

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

Name Not Unique

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

Reference Not Zero

{
  "_errors": [
    {
      "code": "E009",
      "message": "Reference Not Zero",
      "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"
}

Update a BGP route map

/bgp-route-maps/:id

Request​

Path Parameters

Body

Responses​

Request

Responses