find routingPolicy

GET 
/v1/projects/:projectId/zones/:zoneName/routingpolicies

Return routing policies that match all searching criteria. Criteria are project identifier and routing policy name.

Request

Path Parameters

projectId stringrequired

Project Identifier

zoneName stringrequired

Zone name

Query Parameters

name string

Name of the resource.

offset int32
Requested pagination of response. The parameter offset is the index of the first element to retrieve. Zero is the first element of the collection.
Default value: 0
limit int32
Possible values: >= 1
Requested pagination of response. The parameter limit is the maximum number of elements to retrieve (it can be greater than the actual available number of items).
Default value: 100
sort string

Possible values: <= 100 characters, Value must match regular expression -?[A-Za-z0-9]+(?:,[A-Za-z0-9]+)*

The list of field names to sort the result. Prefixing a field name with a "-" sign will indicate a descending order.

Header Parameters

Authorization string

Bearer access token authentication if you use this API through Orange Developer or Orange Developer Inside.

X-API-KEY string

Your SIU token if you use this API through Orange Developer.

X-Requester-Id string

Your SIU Id if you use this API through Orange Developer Inside.

Responses

200

Ok

Response Headers

X-Total-Count

Returns Pagination of response. The total number of items in the collection, after application of filters if any.

X-Result-Count

The actual number of items contained in the response body. Note that it can be less than the requested "limit".

application/json

Schema

Schema

Array [
namestringrequired
Unique resource name. This attribute can not be updated.
Possible values: Value must match regular expression [A-Za-z0-9-]
descriptionstring
Resource description
tags object
Tags associated with the resource
property name*string
iduuidrequired
Resource identifier.
hRefurirequired
Hypertext reference of the resource.
createdDatedate-timerequired
Creation date of the resource.
lastModifiedDatedate-timerequired
Date of the last modification of the resource.
lastRequesterIdstringrequired
Identifier of the user of the last create/update/delete operation requested on the resource.
provisioningStateBasicStateEnum (string)required
Provisioning state of the resource. Possible state:
• creating: resource creation in progress
• updating: resource update in progress
• deleting: resource deletion in progress
• active: resource created/updated successfully
• error: resource in error because the last creation/update/deletion failed
Possible values: [creating, updating, deleting, active, error]
rules object[]required
List of rules of the routing policy.
Array [
hRefstringrequired
hRef to the Routing Policy rule details.
namestringrequired
Name of the routing policy rule. Must be unique within routing policy.
descriptionstring
Description of the routing policy rule.
matchCommunityTagsstring[]
List of Community Tags to match. Possible values: community tag or 'encapsulation:udp'
Possible values: <= 10
matchAllCommunityTagsboolean
Match only if all Community Tags are present.
matchExtCommunityVpns object[]
List of VPN whose extended communities must be matched.
Possible values: <= 99
Array [
vpnNamestringrequired
VPN name. This attribute can not be updated.
vnRoleVPNRoleEnum (string)required
VN role in the VPN.
Possible values: [any-to-any, client, server]
]
matchAllExtCommunityVpnsboolean
Match only if all extended communities are present.
matchProtocolsRoutingPolicyProtocolsEnum (string)[]
List of protocols to match.
Possible values: [bgpaas, bgp-bb, direct, static-interface-route, static-network-route], <= 9
matchExactSubnetIpsstring[]
List of subnets to match (exact match only)
Possible values: <= 10
matchOrlongerSubnetIpsstring[]
List of subnets to match (exact match or longer subnets)
Possible values: <= 10
matchLongerSubnetIpsstring[]
Subnet to match list (longer subnets only)
Possible values: <= 10
setCommunityTagsstring[]
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. Possible values: community tag or ‘no-export’, ‘no-advertise’
Possible values: <= 10
addCommunityTagsstring[]
List of Community Tags to add on the routes. NB: some Community Tags are protected and could be rejected. Possible values: community tag or ‘no-export’, ‘no-advertise’
Possible values: <= 10
removeCommunityTagsstring[]
List of Community Tags to remove from the routes (does not apply to the Community Tags added by the same rule). Possible values: community tag or ‘no-export’, ‘no-advertise’
Possible values: <= 10
setExtCommunityVpns object[]
List of VPN whose extended communities must be set on the routes.
Possible values: <= 99
Array [
vpnNamestringrequired
VPN name. This attribute can not be updated.
vnRoleVPNRoleEnum (string)required
VN role in the VPN.
Possible values: [any-to-any, client, server]
]
addExtCommunityVpns object[]
List of VPN whose extended communities must be added to the routes.
Possible values: <= 99
Array [
vpnNamestringrequired
VPN name. This attribute can not be updated.
vnRoleVPNRoleEnum (string)required
VN role in the VPN.
Possible values: [any-to-any, client, server]
]
removeExtCommunityVpns object[]
List of VPN whose extended communities must be removed from the routes list.
Possible values: <= 99
Array [
vpnNamestringrequired
VPN name. This attribute can not be updated.
vnRoleVPNRoleEnum (string)required
VN role in the VPN.
Possible values: [any-to-any, client, server]
]
expandAutonomousSystemsstring[]
List of Autonomous Systems (2 or 4 bytes) to add at the beginning of the Autonomous System path list (AS append).
Possible values: <= 99
setLocalPreferenceint32
Local preference to set.
Possible values: <= 100000
setMedint32
MED to set
Possible values: <= 100000
actionActionEnum (string)
Action on the flow
Possible values: [reject, next, accept]
]
]

Example (auto)

[
  {
    "name": "string",
    "description": "string",
    "tags": {},
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "hRef": "string",
    "createdDate": "2024-07-29T15:51:28.071Z",
    "lastModifiedDate": "2024-07-29T15:51:28.071Z",
    "lastRequesterId": "string",
    "provisioningState": "creating",
    "rules": [
      {
        "hRef": "string",
        "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

codeint32required

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

messagestringrequired

A short localized string that describes the error.

descriptionstring

(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 (auto)

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

401

Unauthorized

Credentials are missing

application/json

Schema

Schema

codeint32required

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

messagestringrequired

A short localized string that describes the error.

descriptionstring

(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 (auto)

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

403

Forbidden

Valid credentials but not enough privileges to perform the operation

application/json

Schema

Schema

codeint32required

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

messagestringrequired

A short localized string that describes the error.

descriptionstring

(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 (auto)

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

404

Not Found

Unknown resource or service

application/json

Schema

Schema

codeint32required

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

messagestringrequired

A short localized string that describes the error.

descriptionstring

(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 (auto)

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

codeint32required

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

messagestringrequired

A short localized string that describes the error.

descriptionstring

(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 (auto)

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

500

Internal Server Error

Unexpected error, please contact support

application/json

Schema

Schema

codeint32required

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

messagestringrequired

A short localized string that describes the error.

descriptionstring

(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 (auto)

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

503

Service Unavailable

Service probably in maintenance. Please retry later.

application/json

Schema

Schema

codeint32required

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

messagestringrequired

A short localized string that describes the error.

descriptionstring

(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 (auto)

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

• curl
• python
• go
• nodejs
• php
• java

• CURL

curl -L '/v1/projects/:projectId/zones/:zoneName/routingpolicies' \
-H 'Accept: application/json'

Request Collapse all

Base URL

/v1

Parameters

projectId — pathrequired

zoneName — pathrequired

name — query

offset — query

limit — query

sort — query

Authorization — header

X-API-KEY — header

X-Requester-Id — header