Network peering

A Network Peering is a connection between two networks that join them together, enabling traffic between them using private IP addresses.

Part of the API reference collection

This page is part of the Crunchy Bridge API reference, and primarily meant to act as an exhaustive guide for technical integrations which are already in progress. To understand the basics of using the API, see API concepts and getting started.

The `Peering` API resource

Response of a network peering request.

Content type: application/json

Name	Nullable	Type	Description
`id`		`string` in EID format	Unique ID of the network peering.
`cidr4`	✔	`string`	A subnet block specifying the network's location and possible addresses in CIDR4 (IPv4) notation.
`name`	✔	`string`	Name of the underlying peering connection.
`network_id`		`string` in EID format	The ID of the associated network.
`network_identifier`		`string`	The cloud specific identifier for the network.
`peer_identifier`		`string`	The cloud specific identifier for the peered network.
`status`		`string`	The current state of the network peering.

List network peerings

List existing peerings for a network.

This endpoint's pagination may be ordered through the order_field parameter by id. Defaults to being ordered by id.

GET /networks/{network_id}/peerings

Request

Path parameters

network_id: Unique ID of the network.

Query parameters

Name	Type	Description
`cursor`	`string`	Return only items starting after this cursor ID. When paginating, pass the value of `next_cursor` from the last page into this field to get the next one. Cursor values depend on the field in `order_field`. Cursors will often be the primary IDs of object, but when ordering on another field like `name`, they'll be names (or another value) instead.
`limit`	`integer`	The maximum number of items to return on the page. Defaults to `100` with a minimum of `1` and a maximum of `200`.
`order`	`string`	The order of pagination. `asc` for ascending or `desc` for descending. Defaults to `asc`. Enum `asc`, or `desc`.
`order_field`	`string`	The name of the field on which to paginate like `id` or `name`. Supported fields are specific to each endpoint, and it's not possible to specify any arbitrary name. See the documentation for each specific list endpoint to see which fields it supports. Defaults to `id` for most resources. Enum `id`.

cURL example

curl -X GET https://api.crunchybridge.com/networks/{network_id}/peerings
    -H "Authorization: Bearer $CRUNCHY_API_KEY"

Response

Status: 200

Response of a list peerings request.

Content type: application/json

Name	Nullable	Type	Description
`peerings`		`array` of `array`	Peerings configured for a network.

Create network peering

Create a new peering for a network.

POST /networks/{network_id}/peerings

Request

Path parameters

network_id: Unique ID of the network.

Request body schema

Content type: application/json

Name	Required	Type	Description
`peer_identifier`	✔	`string`	Identifier of the network to be peered.

cURL example

curl -X POST https://api.crunchybridge.com/networks/{network_id}/peerings
    -H "Authorization: Bearer $CRUNCHY_API_KEY"

Response

Status: 201

Responds with the standard Peering API resource.

Get network peering

Get an existing peering for a network.

GET /networks/{network_id}/peerings/{peering_id}

Request

Path parameters

peering_id: Unique ID of the network peering.
network_id: Unique ID of the network.

cURL example

curl -X GET https://api.crunchybridge.com/networks/{network_id}/peerings/{peering_id}
    -H "Authorization: Bearer $CRUNCHY_API_KEY"

Response

Status: 200

Responds with the standard Peering API resource.

Destroy network peering

Delete an existing peering for a network.

DELETE /networks/{network_id}/peerings/{peering_id}

Request

Path parameters

peering_id: Unique ID of the peering.
network_id: Unique ID of the network.

cURL example

curl -X DELETE https://api.crunchybridge.com/networks/{network_id}/peerings/{peering_id}
    -H "Authorization: Bearer $CRUNCHY_API_KEY"

Response

Status: 200

Responds with the standard Peering API resource.