create routingPolicy

POST 
/projects/:projectId/zones/:zoneName/routingpolicies

Create a new Routing Policy

Request

Path Parameters

projectId stringrequired

Project Identifier

zoneName stringrequired

Zone name

application/json

Body

required

name stringrequired

Possible values: <= 40 characters, Value must match regular expression [A-Za-z0-9-]

Unique resource name. This attribute can not be updated.

description string

Resource description

tags

object

Tags associated with the resource

property name* string

rules

object[]

required

List of rules of the routing policy.

Array [

name stringrequired

Name of the routing policy rule. Must be unique within routing policy.

description string

Description of the routing policy rule.

matchCommunityTags string[]

Possible values: <= 10

List of Community Tags to match.

matchAllCommunityTags boolean

Match only if all Community Tags are present.

matchExtCommunityVpns

object[]

Possible values: <= 99

List of VPN whose extended communities must be matched.

Array [

vpnName stringrequired

VPN name. This attribute can not be updated.

vnRole VPNRoleEnum (string)required

Possible values: [any-to-any, client, server]

VN role in the VPN.

]

matchAllExtCommunityVpns boolean

Match only if all extended communities are present.

matchProtocols RoutingPolicyProtocolsEnum (string)[]

Possible values: [bgpaas, bgp-bb, direct, static-interface-route, static-network-route], <= 9

List of protocols to match.

matchExactSubnetIps string[]

Possible values: <= 10

List of subnets to match (exact match only)

matchOrlongerSubnetIps string[]

Possible values: <= 10

List of subnets to match (exact match or longer subnets)

matchLongerSubnetIps string[]

Possible values: <= 10

Subnet to match list (longer subnets only)

setCommunityTags string[]

Possible values: <= 10

List of Community Tags to set on the routes (this will replace the original list of Community Tags on the routes). NB: some Community Tags are protected and could be rejected.

addCommunityTags string[]

Possible values: <= 10

List of Community Tags to add on the routes. NB: some Community Tags are protected and could be rejected.

removeCommunityTags string[]

Possible values: <= 10

List of Community Tags to remove from the routes (does not apply to the Community Tags added by the same rule).

setExtCommunityVpns

object[]

Possible values: <= 99

List of VPN whose extended communities must be set on the routes.

Array [

vpnName stringrequired

VPN name. This attribute can not be updated.

vnRole VPNRoleEnum (string)required

Possible values: [any-to-any, client, server]

VN role in the VPN.

]

addExtCommunityVpns

object[]

Possible values: <= 99

List of VPN whose extended communities must be added to the routes.

Array [

vpnName stringrequired

VPN name. This attribute can not be updated.

vnRole VPNRoleEnum (string)required

Possible values: [any-to-any, client, server]

VN role in the VPN.

]

removeExtCommunityVpns

object[]

Possible values: <= 99

List of VPN whose extended communities must be removed from the routes list.

Array [

vpnName stringrequired

VPN name. This attribute can not be updated.

vnRole VPNRoleEnum (string)required

Possible values: [any-to-any, client, server]

VN role in the VPN.

]

expandAutonomousSystems string[]

Possible values: <= 99

List of Autonomous Systems (2 or 4 bytes) to add at the beginning of the Autonomous System path list (AS append).

setLocalPreference int32

Possible values: <= 100000

Local preference to set.

setMed int32

Possible values: <= 100000

MED to set

action ActionEnum (string)

Possible values: [reject, next, accept]

Action on the flow

]

Responses

201

Created

application/json

Schema

Schema

name stringrequired

Possible values: <= 40 characters, Value must match regular expression [A-Za-z0-9-]

Unique resource name. This attribute can not be updated.

description string

Resource description

tags

object

Tags associated with the resource

property name* string

rules

object[]

required

List of rules of the routing policy.

Array [

name stringrequired

Name of the routing policy rule. Must be unique within routing policy.

description string

Description of the routing policy rule.

matchCommunityTags string[]

Possible values: <= 10

List of Community Tags to match.

matchAllCommunityTags boolean

Match only if all Community Tags are present.

matchExtCommunityVpns

object[]

Possible values: <= 99

List of VPN whose extended communities must be matched.

Array [

vpnName stringrequired

VPN name. This attribute can not be updated.

vnRole VPNRoleEnum (string)required

Possible values: [any-to-any, client, server]

VN role in the VPN.

]

matchAllExtCommunityVpns boolean

Match only if all extended communities are present.

matchProtocols RoutingPolicyProtocolsEnum (string)[]

Possible values: [bgpaas, bgp-bb, direct, static-interface-route, static-network-route], <= 9

List of protocols to match.

matchExactSubnetIps string[]

Possible values: <= 10

List of subnets to match (exact match only)

matchOrlongerSubnetIps string[]

Possible values: <= 10

List of subnets to match (exact match or longer subnets)

matchLongerSubnetIps string[]

Possible values: <= 10

Subnet to match list (longer subnets only)

setCommunityTags string[]

Possible values: <= 10

List of Community Tags to set on the routes (this will replace the original list of Community Tags on the routes). NB: some Community Tags are protected and could be rejected.

addCommunityTags string[]

Possible values: <= 10

List of Community Tags to add on the routes. NB: some Community Tags are protected and could be rejected.

removeCommunityTags string[]

Possible values: <= 10

List of Community Tags to remove from the routes (does not apply to the Community Tags added by the same rule).

setExtCommunityVpns

object[]

Possible values: <= 99

List of VPN whose extended communities must be set on the routes.

Array [

vpnName stringrequired

VPN name. This attribute can not be updated.

vnRole VPNRoleEnum (string)required

Possible values: [any-to-any, client, server]

VN role in the VPN.

]

addExtCommunityVpns

object[]

Possible values: <= 99

List of VPN whose extended communities must be added to the routes.

Array [

vpnName stringrequired

VPN name. This attribute can not be updated.

vnRole VPNRoleEnum (string)required

Possible values: [any-to-any, client, server]

VN role in the VPN.

]

removeExtCommunityVpns

object[]

Possible values: <= 99

List of VPN whose extended communities must be removed from the routes list.

Array [

vpnName stringrequired

VPN name. This attribute can not be updated.

vnRole VPNRoleEnum (string)required

Possible values: [any-to-any, client, server]

VN role in the VPN.

]

expandAutonomousSystems string[]

Possible values: <= 99

List of Autonomous Systems (2 or 4 bytes) to add at the beginning of the Autonomous System path list (AS append).

setLocalPreference int32

Possible values: <= 100000

Local preference to set.

setMed int32

Possible values: <= 100000

MED to set

action ActionEnum (string)

Possible values: [reject, next, accept]

Action on the flow

]

Example (from schema)

{
  "name": "string",
  "description": "string",
  "tags": {},
  "rules": [
    {
      "name": "string",
      "description": "string",
      "matchCommunityTags": [
        "string"
      ],
      "matchAllCommunityTags": true,
      "matchExtCommunityVpns": [
        {
          "vpnName": "string",
          "vnRole": "any-to-any"
        }
      ],
      "matchAllExtCommunityVpns": true,
      "matchProtocols": [
        "bgpaas"
      ],
      "matchExactSubnetIps": [
        "string"
      ],
      "matchOrlongerSubnetIps": [
        "0"
      ],
      "matchLongerSubnetIps": [
        "string"
      ],
      "setCommunityTags": [
        "string"
      ],
      "addCommunityTags": [
        "string"
      ],
      "removeCommunityTags": [
        "string"
      ],
      "setExtCommunityVpns": [
        {
          "vpnName": "string",
          "vnRole": "any-to-any"
        }
      ],
      "addExtCommunityVpns": [
        {
          "vpnName": "string",
          "vnRole": "any-to-any"
        }
      ],
      "removeExtCommunityVpns": [
        {
          "vpnName": "string",
          "vnRole": "any-to-any"
        }
      ],
      "expandAutonomousSystems": [
        "string"
      ],
      "setLocalPreference": 0,
      "setMed": 0,
      "action": "reject"
    }
  ]
}

400

Bad Request

Request is not valid

application/json

Schema

Schema

code int32required

An integer coding the error type. This is given to caller so he can translate them if required.

message stringrequired

A short localized string that describes the error.

description string

(optional) A long localized error description if needed. It can contain precise information about which parameter is missing, or what are the identifier acceptable values.

Example (from schema)

{
  "code": 0,
  "message": "string",
  "description": "string"
}

401

Unauthorized

Credentials are missing

application/json

Schema

Schema

code int32required

An integer coding the error type. This is given to caller so he can translate them if required.

message stringrequired

A short localized string that describes the error.

description string

(optional) A long localized error description if needed. It can contain precise information about which parameter is missing, or what are the identifier acceptable values.

Example (from schema)

{
  "code": 0,
  "message": "string",
  "description": "string"
}

403

Forbidden

Valid credentials but not enough privileges to perform the operation

application/json

Schema

Schema

code int32required

An integer coding the error type. This is given to caller so he can translate them if required.

message stringrequired

A short localized string that describes the error.

description string

(optional) A long localized error description if needed. It can contain precise information about which parameter is missing, or what are the identifier acceptable values.

Example (from schema)

{
  "code": 0,
  "message": "string",
  "description": "string"
}

404

Not Found

Unknown resource or service

application/json

Schema

Schema

code int32required

An integer coding the error type. This is given to caller so he can translate them if required.

message stringrequired

A short localized string that describes the error.

description string

(optional) A long localized error description if needed. It can contain precise information about which parameter is missing, or what are the identifier acceptable values.

Example (from schema)

{
  "code": 0,
  "message": "string",
  "description": "string"
}

405

Method Not Allowed

Operation is not valid according to the state of the resource

application/json

Schema

Schema

code int32required

An integer coding the error type. This is given to caller so he can translate them if required.

message stringrequired

A short localized string that describes the error.

description string

(optional) A long localized error description if needed. It can contain precise information about which parameter is missing, or what are the identifier acceptable values.

Example (from schema)

{
  "code": 0,
  "message": "string",
  "description": "string"
}

500

Internal Server Error

Unexpected error, please contact support

application/json

Schema

Schema

code int32required

An integer coding the error type. This is given to caller so he can translate them if required.

message stringrequired

A short localized string that describes the error.

description string

(optional) A long localized error description if needed. It can contain precise information about which parameter is missing, or what are the identifier acceptable values.

Example (from schema)

{
  "code": 0,
  "message": "string",
  "description": "string"
}

503

Service Unavailable

Service probably in maintenance. Please retry later.

application/json

Schema

Schema

code int32required

An integer coding the error type. This is given to caller so he can translate them if required.

message stringrequired

A short localized string that describes the error.

description string

(optional) A long localized error description if needed. It can contain precise information about which parameter is missing, or what are the identifier acceptable values.

Example (from schema)

{
  "code": 0,
  "message": "string",
  "description": "string"
}

Loading...