Get a BGP address family profile

GET /bgp-address-family-profiles/:id

Get an existing BGP address family profile.

Request

Path Parameters

id uuidrequired

The UUID of the configuration resource

Responses

application/json

Schema
Example (from schema)

Schema

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

ipv4

ipv4 objectrequired

unicast object

enable boolean

Enable?

soft_reconfig_with_stored_info boolean

Soft reconfiguration of peer with stored routes?

add_path object

tx_all_paths boolean

Advertise all paths to peer?

tx_bestpath_per_AS boolean

Advertise the bestpath per each neighboring AS?

as_override boolean

Override ASNs in outbound updates if AS-Path equals Remote-AS?

route_reflector_client boolean

Route reflector client?

default_originate boolean

Originate default route?

default_originate_map string

Default originate route map

allowas_in object

oneOf

origin
occurrence

origin objectrequired

occurrence integerrequired

Possible values: >= 1 and <= 10

Default value: 1

Number of times the firewalls own AS can be in an AS_PATH

maximum_prefix object

num_prefixes integer

Possible values: >= 1 and <= 4294967295

Maximum number of prefixes

threshold integer

Possible values: >= 1 and <= 100

Threshold percentage of the maximum number of prefixes

action object

oneOf

warning_only
restart

warning_only objectrequired

restart objectrequired

interval integer

Possible values: >= 1 and <= 65535

Restart interval

next_hop object

oneOf

self
self_force

self objectrequired

remove_private_AS object

oneOf

all
replace_AS

all objectrequired

send_community object

oneOf

all
both
extended
large
standard

all objectrequired

orf object

orf_prefix_list string

Possible values: [none, both, receive, send]

ORF prefix list

multicast object

enable boolean

Enable?

soft_reconfig_with_stored_info boolean

Soft reconfiguration of peer with stored routes?

add_path object

tx_all_paths boolean

Advertise all paths to peer?

tx_bestpath_per_AS boolean

Advertise the bestpath per each neighboring AS?

as_override boolean

Override ASNs in outbound updates if AS-Path equals Remote-AS?

route_reflector_client boolean

Route reflector client?

default_originate boolean

Originate default route?

default_originate_map string

Default originate route map

allowas_in object

oneOf

origin
occurrence

origin objectrequired

occurrence integerrequired

Possible values: >= 1 and <= 10

Default value: 1

Number of times the firewalls own AS can be in an AS_PATH

maximum_prefix object

num_prefixes integer

Possible values: >= 1 and <= 4294967295

Maximum number of prefixes

threshold integer

Possible values: >= 1 and <= 100

Threshold percentage of the maximum number of prefixes

action object

oneOf

warning_only
restart

warning_only objectrequired

restart objectrequired

interval integer

Possible values: >= 1 and <= 65535

Restart interval

next_hop object

oneOf

self
self_force

self objectrequired

remove_private_AS object

oneOf

all
replace_AS

all objectrequired

send_community object

oneOf

all
both
extended
large
standard

all objectrequired

orf object

orf_prefix_list string

Possible values: [none, both, receive, send]

ORF prefix list

{
  "id": "123e4567-e89b-12d3-a456-426655440000",
  "name": "string",
  "ipv4": {
    "ipv4": {
      "unicast": {
        "enable": true,
        "soft_reconfig_with_stored_info": true,
        "add_path": {
          "tx_all_paths": true,
          "tx_bestpath_per_AS": true
        },
        "as_override": true,
        "route_reflector_client": true,
        "default_originate": true,
        "default_originate_map": "string",
        "maximum_prefix": {
          "num_prefixes": 0,
          "threshold": 0
        },
        "orf": {
          "orf_prefix_list": "none"
        }
      },
      "multicast": {
        "enable": true,
        "soft_reconfig_with_stored_info": true,
        "add_path": {
          "tx_all_paths": true,
          "tx_bestpath_per_AS": true
        },
        "as_override": true,
        "route_reflector_client": true,
        "default_originate": true,
        "default_originate_map": "string",
        "maximum_prefix": {
          "num_prefixes": 0,
          "threshold": 0
        },
        "orf": {
          "orf_prefix_list": "none"
        }
      }
    }
  }
}

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 address family profile

/bgp-address-family-profiles/:id

Request​

Path Parameters

Responses​

Request

Responses