BGP

BGP lets a workspace announce its own IP prefixes (bring your own IP). Each workspace has at most one BGP configuration, which stores the workspace ASN, a BGP session password, and an optional instance that acts as the BGP endpoint. We expose configuration and prefix reads through the public API. Changes require staff access.

Fetching the BGP config and listing prefixes require workspace read permission.

All path parameters are required string IDs.

See Workspaces and scope and Pagination for the conventions these endpoints follow.

Fetch BGP configuration

GET/v1/workspaces/{wid}/bgpFetch the BGP configuration for a workspace

Returns the current BGP configuration, including the decrypted session password. Returns 404 if no BGP configuration has been created for the workspace yet.

Path parameters

Name	Type	Description
wid	string	Workspace ID

Returns 200 OK with a flat configuration object:

Field	Type	Description
id	string	BGP configuration ID
asn	integer	Autonomous system number registered to this workspace, from 1 through 4294967294
password	string	Decrypted BGP session password
instance	object or null	Instance designated as the BGP endpoint, with id and name

curl https://api.galaxygate.net/v1/workspaces/42/bgp \
  -H "Authorization: Bearer $GALAXYGATE_TOKEN" \
  -A 'curl/8.5'

List BGP prefixes

GET/v1/workspaces/{wid}/bgp/prefixesList BGP prefix announcements

Returns the prefix entries attached to the workspace BGP configuration, with pagination.

Path parameters

Name	Type	Description
wid	string	Workspace ID

The path parameter is required. All query parameters are optional.

Query parameters

Name	Type	Description
id	string[]	Filter to specific prefix IDs
prefix	string	Filter by prefix (CIDR notation, partial match)
source	string	Filter by source. Only MANUAL is currently defined
enabled	boolean	Filter to enabled or disabled prefixes

Plus the shared pagination parameters. Returns 200 OK with a paged list of prefix objects:

Field	Type	Description
id	string	Prefix entry ID
prefix	string	Network prefix in CIDR notation
source	string	MANUAL
enabled	boolean	Whether announcements are active
community	string	DEFAULT or PROTECTED