List all BGP Prefixes within the specified IP Prefix. BGP Prefixes are used to control which specific subnets are advertised to the Internet. It is possible to advertise subnets more specific than an IP Prefix by creating more specific BGP Prefixes.
/accounts/{account_identifier}/addressing/prefixes/{prefix_identifier}/bgp/prefixes
get
IP Address Management BGP Prefixes
ip-address-management-prefixes-list-bgp-prefixes
nullnull[
{
"in": "path",
"name": "account_identifier",
"required": true,
"schema": {
"description": "Identifier",
"example": "023e105f4ecef8ad9ca31a8372d0c353",
"maxLength": 32,
"readOnly": true,
"type": "string"
}
},
{
"in": "path",
"name": "prefix_identifier",
"required": true,
"schema": {
"description": "Identifier",
"example": "023e105f4ecef8ad9ca31a8372d0c353",
"maxLength": 32,
"readOnly": true,
"type": "string"
}
}
]null{
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"allOf": [
{
"properties": {
"errors": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"messages": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"result": {
"anyOf": [
{
"type": "object"
},
{
"items": {},
"type": "array"
},
{
"type": "string"
}
]
},
"success": {
"description": "Whether the API call was successful",
"enum": [
true
],
"example": true,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
},
{
"properties": {
"result": {
"items": {},
"nullable": true,
"type": "array"
},
"result_info": {
"properties": {
"count": {
"description": "Total number of results for the requested service",
"example": 1,
"type": "number"
},
"page": {
"description": "Current page within paginated list of results",
"example": 1,
"type": "number"
},
"per_page": {
"description": "Number of results per page of results",
"example": 20,
"type": "number"
},
"total_count": {
"description": "Total results available without any search parameters",
"example": 2000,
"type": "number"
}
},
"type": "object"
}
}
}
],
"type": "object"
},
{
"properties": {
"result": {
"items": {
"properties": {
"asn": {
"description": "Autonomous System Number (ASN) the prefix will be advertised under.",
"example": 209242,
"nullable": true,
"type": "integer"
},
"bgp_signal_opts": {
"properties": {
"enabled": {
"description": "Whether control of advertisement of the prefix to the Internet is enabled to be performed via BGP signal",
"example": false,
"type": "boolean"
},
"modified_at": {
"description": "Last time BGP signaling control was toggled. This field is null if BGP signaling has never been enabled.",
"example": "2014-01-01T05:20:00.12345Z",
"format": "date-time",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"cidr": {
"description": "IP Prefix in Classless Inter-Domain Routing format.",
"example": "192.0.2.0/24",
"type": "string"
},
"created_at": {
"example": "2014-01-01T05:20:00.12345Z",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"id": {
"description": "Identifier",
"example": "023e105f4ecef8ad9ca31a8372d0c353",
"maxLength": 32,
"readOnly": true,
"type": "string"
},
"modified_at": {
"example": "2014-01-01T05:20:00.12345Z",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"on_demand": {
"properties": {
"advertised": {
"description": "Prefix advertisement status to the Internet. This field is only not 'null' if on demand is enabled.",
"example": true,
"nullable": true,
"type": "boolean"
},
"advertised_modified_at": {
"description": "Last time the advertisement status was changed. This field is only not 'null' if on demand is enabled.",
"example": "2014-01-01T05:20:00.12345Z",
"format": "date-time",
"nullable": true,
"type": "string"
},
"on_demand_enabled": {
"description": "Whether advertisement of the prefix to the Internet may be dynamically enabled or disabled.",
"example": true,
"type": "boolean"
},
"on_demand_locked": {
"description": "Whether advertisement status of the prefix is locked, meaning it cannot be changed.",
"example": false,
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
}
}
}
]
}
}
},
"description": "List BGP Prefixes response"
},
"4xx": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"allOf": [
{
"allOf": [
{
"properties": {
"errors": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"messages": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"result": {
"anyOf": [
{
"type": "object"
},
{
"items": {},
"type": "array"
},
{
"type": "string"
}
]
},
"success": {
"description": "Whether the API call was successful",
"enum": [
true
],
"example": true,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
},
{
"properties": {
"result": {
"items": {},
"nullable": true,
"type": "array"
},
"result_info": {
"properties": {
"count": {
"description": "Total number of results for the requested service",
"example": 1,
"type": "number"
},
"page": {
"description": "Current page within paginated list of results",
"example": 1,
"type": "number"
},
"per_page": {
"description": "Number of results per page of results",
"example": 20,
"type": "number"
},
"total_count": {
"description": "Total results available without any search parameters",
"example": 2000,
"type": "number"
}
},
"type": "object"
}
}
}
],
"type": "object"
},
{
"properties": {
"result": {
"items": {
"properties": {
"asn": {
"description": "Autonomous System Number (ASN) the prefix will be advertised under.",
"example": 209242,
"nullable": true,
"type": "integer"
},
"bgp_signal_opts": {
"properties": {
"enabled": {
"description": "Whether control of advertisement of the prefix to the Internet is enabled to be performed via BGP signal",
"example": false,
"type": "boolean"
},
"modified_at": {
"description": "Last time BGP signaling control was toggled. This field is null if BGP signaling has never been enabled.",
"example": "2014-01-01T05:20:00.12345Z",
"format": "date-time",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"cidr": {
"description": "IP Prefix in Classless Inter-Domain Routing format.",
"example": "192.0.2.0/24",
"type": "string"
},
"created_at": {
"example": "2014-01-01T05:20:00.12345Z",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"id": {
"description": "Identifier",
"example": "023e105f4ecef8ad9ca31a8372d0c353",
"maxLength": 32,
"readOnly": true,
"type": "string"
},
"modified_at": {
"example": "2014-01-01T05:20:00.12345Z",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"on_demand": {
"properties": {
"advertised": {
"description": "Prefix advertisement status to the Internet. This field is only not 'null' if on demand is enabled.",
"example": true,
"nullable": true,
"type": "boolean"
},
"advertised_modified_at": {
"description": "Last time the advertisement status was changed. This field is only not 'null' if on demand is enabled.",
"example": "2014-01-01T05:20:00.12345Z",
"format": "date-time",
"nullable": true,
"type": "string"
},
"on_demand_enabled": {
"description": "Whether advertisement of the prefix to the Internet may be dynamically enabled or disabled.",
"example": true,
"type": "boolean"
},
"on_demand_locked": {
"description": "Whether advertisement status of the prefix is locked, meaning it cannot be changed.",
"example": false,
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
}
}
}
]
},
{
"properties": {
"errors": {
"allOf": [
{
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
}
],
"example": [
{
"code": 7003,
"message": "No route for the URI"
}
],
"minLength": 1
},
"messages": {
"allOf": [
{
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
}
],
"example": []
},
"result": {
"enum": [
null
],
"nullable": true,
"type": "object"
},
"success": {
"description": "Whether the API call was successful",
"enum": [
false
],
"example": false,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
}
]
}
}
},
"description": "List BGP Prefixes response failure"
}
}[
{
"api_email": [],
"api_key": []
}
]