Skip to main content
GET
/
bgp
/
policy
/
{policyId}
Retrieve a BGP Policy
curl --request GET \
  --url https://api.altostrat.io/bgp/policy/{policyId} \
  --header 'Authorization: Bearer <token>'
{
  "id": "9b1d3e6a-5c3a-4f1e-9a0a-2b2a1e1d8e8b",
  "name": "Block Known Threats",
  "enabled": true,
  "default": false,
  "lists": [
    "9b1e3e6a-5c3a-4f1e-9a0a-2b2a1e1d8e8c"
  ],
  "site_count": 3,
  "updated_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
policyId
string<uuid>
required

The unique identifier of the BGP policy.

Response

The requested BGP policy.

​
id
string<uuid>
Example:

"9b1d3e6a-5c3a-4f1e-9a0a-2b2a1e1d8e8b"

​
name
string
Example:

"Block Known Threats"

​
enabled
boolean
Example:

true

​
default
boolean

True if this is the default policy for the account.

Example:

false

​
lists
string<uuid>[]

A list of BGP IP reputation list IDs included in this policy.

Example:
["9b1e3e6a-5c3a-4f1e-9a0a-2b2a1e1d8e8c"]
​
site_count
integer

The number of sites currently using this policy.

Example:

3

​
updated_at
string<date-time>
​
created_at
string<date-time>