Instaclustr Logo
Powered by Redocly

VPC Peering

Operations related to VPC Peering.

List all VPC peering connections

Lists the details for all VPC peering connections for the specified Cluster Data Centre.

SecurityBasic Authentication
Request
path Parameters
clusterDataCentreId
required
string <uuid>

ID of the Cluster Data Centre

Example: aabc665c-8916-40ae-978c-96d39a3a1364
Responses
202

List retrieved successfully.

400

Bad Request

401

Not Authorized

403

Forbidden

404

Resource not found

415

Unsupported media type: returned when the payload is in an unsupported format.

429

Too many requests: returned when more than 35 requests per second are being received by your user.

504

A timeout occurred. Perhaps the Provider was slow in responding to the VPC peering request.

get/provisioning/v1/vpc-peering/{clusterDataCentreId}
Request samples 
Response samples 
application/json
[
  • {
    }
]
Create VPC Peering Request
Creates a new VPC peering connection request for the given Cluster Data Centre. This is only available for clusters hosted with either the AWS or GCP provider.


SecurityBasic Authentication 
Request 
path Parameters
clusterDataCentreId
required
string <uuid> 
ID of the Cluster Data Centre


 
 Example:  aabc665c-8916-40ae-978c-96d39a3a1364
Request Body schema: application/json
One of:
peerAccountId
required
string
The account ID of the owner of the accepter VPC


 
peerVpcId
required
string
ID of the VPC with which you are creating the peering connection


 
peerSubnet
string
The subnet for the peering VPC, mutually exclusive with peerSubnets. Please note, this is a deprecated field, and the peerSubnets field should be used instead.


 
peerSubnets
Array of strings  unique 
The subnets for the peering VPC, mutually exclusive with peerSubnet


 
peerRegion
string
Region code for the accepter VPC, if the accepter VPC is located in a region other than the region in which you make the request.

Defaults to the region of the Cluster Data Centre.


 Enum: "GovCloud" "US_GOV_EAST_1" "US_EAST_1" "US_EAST_2" "US_WEST_1" "US_WEST_2" "EU_WEST_1" "EU_WEST_2" "EU_WEST_3" "EU_CENTRAL_1" "EU_CENTRAL_2" "EU_NORTH_1" "EU_SOUTH_1" "EU_SOUTH_2" "AP_EAST_1" "AP_SOUTH_1" "AP_SOUTH_2" "AP_SOUTHEAST_1" "AP_SOUTHEAST_2" "AP_SOUTHEAST_3" "AP_SOUTHEAST_4" "AP_NORTHEAST_1" "AP_NORTHEAST_2" "AP_NORTHEAST_3" "SA_EAST_1" "CN_NORTH_1" "CN_NORTHWEST_1" "CA_CENTRAL_1" "CA_WEST_1" "ME_CENTRAL_1" "ME_SOUTH_1" "AF_SOUTH_1" "US_ISO_EAST_1" "US_ISOB_EAST_1" "US_ISO_WEST_1" "IL_CENTRAL_1"  
addNetworkToFirewallRules
boolean
Whether to add the VPC peer network to the cluster firewall allowed addresses

Defaults to false.


 
object
 
Responses 
202
VPC peering connection request successfully created.


400
Bad Request


401
Not Authorized


403
Forbidden


404
Resource not found


415
Unsupported media type: returned when the payload is in an unsupported format.


422
Subnet provided conflicts with Cluster Data Centre's subnet


429
Too many requests: returned when more than 35 requests per second are being received by your user.


504
A timeout occurred. Perhaps the Provider was slow in responding to the VPC peering request.


post/provisioning/v1/vpc-peering/{clusterDataCentreId}
Request samples 
application/json
{
  • "peerAccountId": "123888456789",
  • "peerVpcId": "vpc-aabb1122",
  • "peerSubnet": "10.7.0.0/16",
  • "peerSubnets": [
    ],
  • "peerRegion": "US_WEST_2",
  • "addNetworkToFirewallRules": true,
  • "validationMessages": {
    }
}
Response samples 
application/json
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
Get VPC peering connection info
Fetches the details for a given VPC peering connection.


SecurityBasic Authentication 
Request 
path Parameters
clusterDataCentreId
required
string <uuid> 
ID of the Cluster Data Centre


 
 Example:  aabc665c-8916-40ae-978c-96d39a3a1364
vpcPeeringConnectionId
required
string <uuid> 
ID of the VPC Peering Connection


 
 Example:  068c447e-8475-49b2-974b-ca1c91702ed4
Responses 
202
VPC peering connection info retrieved successfully.


400
Bad Request


401
Not Authorized


403
Forbidden


404
Resource not found


415
Unsupported media type: returned when the payload is in an unsupported format.


429
Too many requests: returned when more than 35 requests per second are being received by your user.


504
A timeout occurred. Perhaps the Provider was slow in responding to the VPC peering request.


get/provisioning/v1/vpc-peering/{clusterDataCentreId}/{vpcPeeringConnectionId}
Request samples 
Response samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "aws_vpc_connection_id": "pcx-ff12abc1",
  • "clusterDataCentre": "aabc665c-8916-40ae-978c-96d39a3a1364",
  • "vpcId": "vpc-aa770abc",
  • "peerVpcId": "vpc-aabb1122",
  • "peerAccountId": "123888456789",
  • "peerSubnet": {
    },
  • "peerRegion": "US_WEST_2",
  • "peerSubnets": [
    ]
}
Update VPC peering connection info
Updates the peering networks for a given VPC peering connection. Modifying fields apart from the peerSubnets field will result in a 415 response. This is only available for clusters hosted with the AWS provider


SecurityBasic Authentication 
Request 
path Parameters
clusterDataCentreId
required
string <uuid> 
ID of the Cluster Data Centre


 
 Example:  aabc665c-8916-40ae-978c-96d39a3a1364
vpcPeeringConnectionId
required
string <uuid> 
 
Request Body schema: application/json
id
string <uuid> 
ID of the VPC peering connection


 
aws_vpc_connection_id
string
ID of VPC peering connection on AWS


 
clusterDataCentre
string <uuid> 
ID of the Cluster Data Centre


 
vpcId
string
AWS VPC ID for the Cluster Data Centre


 
peerVpcId
string
ID of the VPC with which you are creating the peering connection


 
peerAccountId
string
The account ID of the owner of the accepter VPC


 
object (CidrSchema) 
 
peerRegion
string
Region code for the accepter VPC, if the accepter VPC is located in a region other than the region in which you make the request.


 Enum: "GovCloud" "US_GOV_EAST_1" "US_EAST_1" "US_EAST_2" "US_WEST_1" "US_WEST_2" "EU_WEST_1" "EU_WEST_2" "EU_WEST_3" "EU_CENTRAL_1" "EU_CENTRAL_2" "EU_NORTH_1" "EU_SOUTH_1" "EU_SOUTH_2" "AP_EAST_1" "AP_SOUTH_1" "AP_SOUTH_2" "AP_SOUTHEAST_1" "AP_SOUTHEAST_2" "AP_SOUTHEAST_3" "AP_SOUTHEAST_4" "AP_NORTHEAST_1" "AP_NORTHEAST_2" "AP_NORTHEAST_3" "SA_EAST_1" "CN_NORTH_1" "CN_NORTHWEST_1" "CA_CENTRAL_1" "CA_WEST_1" "ME_CENTRAL_1" "ME_SOUTH_1" "AF_SOUTH_1" "US_ISO_EAST_1" "US_ISOB_EAST_1" "US_ISO_WEST_1" "IL_CENTRAL_1"  
object (CidrSetSchema) 
The subnets for the peering VPC, mutually exclusive with peerSubnet


 
Responses 
202
VPC peering connection info retrieved successfully.


400
Bad Request


401
Not Authorized


403
Forbidden


404
Resource not found


415
Unsupported media type: returned when the payload is in an unsupported format.


422
Subnet provided conflicts with Cluster Data Centre's subnet


429
Too many requests: returned when more than 35 requests per second are being received by your user.


504
A timeout occurred. Perhaps the Provider was slow in responding to the VPC peering request.


put/provisioning/v1/vpc-peering/{clusterDataCentreId}/{vpcPeeringConnectionId}
Request samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "aws_vpc_connection_id": "pcx-ff12abc1",
  • "clusterDataCentre": "aabc665c-8916-40ae-978c-96d39a3a1364",
  • "vpcId": "vpc-aa770abc",
  • "peerVpcId": "vpc-aabb1122",
  • "peerAccountId": "123888456789",
  • "peerSubnet": {
    },
  • "peerRegion": "US_WEST_2",
  • "peerSubnets": [
    ]
}
Response samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "aws_vpc_connection_id": "pcx-ff12abc1",
  • "clusterDataCentre": "aabc665c-8916-40ae-978c-96d39a3a1364",
  • "vpcId": "vpc-aa770abc",
  • "peerVpcId": "vpc-aabb1122",
  • "peerAccountId": "123888456789",
  • "peerSubnet": {
    },
  • "peerRegion": "US_WEST_2",
  • "peerSubnets": [
    ]
}
Delete VPC Peering Connection
Deletes the given VPC peering request/connection for the given Cluster Data Centre.


SecurityBasic Authentication 
Request 
path Parameters
clusterDataCentreId
required
string <uuid> 
ID of the Cluster Data Centre


 
 Example:  aabc665c-8916-40ae-978c-96d39a3a1364
vpcPeeringConnectionId
required
string <uuid> 
ID of the VPC Peering Connection to delete


 
 Example:  068c447e-8475-49b2-974b-ca1c91702ed4
Responses 
202
Delete operation successful.


400
Bad Request


401
Not Authorized


403
Forbidden


404
Resource not found


415
Unsupported media type: returned when the payload is in an unsupported format.


429
Too many requests: returned when more than 35 requests per second are being received by your user.


504
A timeout occurred. Perhaps the Provider was slow in responding to the VPC peering request.


delete/provisioning/v1/vpc-peering/{clusterDataCentreId}/{vpcPeeringConnectionId}
Request samples 
Response samples 
application/json
{
  • "status": 0,
  • "message": "string",
  • "errorDetails": { },
  • "code": 0,
  • "link": "string"
}
➔ Next to Authentication & Rate Limit