BgpRoutesRequestParameters (schema)

BGP Routes request parameters

Name Description Type Notes

count Number of routes to retrieve

Number of routes to return in response.
Not used when routes are requested in CSV format.
int Minimum: 1
Default: "1000"

cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string

enforcement_point_path Enforcement point path

String Path of the enforcement point.
When not specified, routes from all enforcement-points are returned.
This property is required for retrieving routes in CSV format.
string

included_fields Comma separated list of fields that should be included in query result string

page_size Maximum number of results to return in this page (server may return fewer) integer Minimum: 0
Maximum: 1000
Default: "1000"

sort_ascending boolean

sort_by Field by which records are sorted string

Name	Description	Type	Notes
count	Number of routes to retrieve Number of routes to return in response. Not used when routes are requested in CSV format.	int	Minimum: 1 Default: "1000"
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
enforcement_point_path	Enforcement point path String Path of the enforcement point. When not specified, routes from all enforcement-points are returned. This property is required for retrieving routes in CSV format.	string
included_fields	Comma separated list of fields that should be included in query result	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string