Sign in

v3

latestOpenAPI 3.0.12026-07-314655871.8 MB
Organization_Vpc

Create organization VPC peering

Creates a peering connection for an organization VPC. This requires the manage-organization-networking permissions and two VPCs to peer: one in Aiven and one in your cloud account (Azure, AWS, Google Cloud, or UpCloud).

post/organization/{organization_id}/vpc/{organization_vpc_id}/peering-connections

Path parameters

organization_idstring required

ID of an organization

organization_vpc_idstring required

Organization VPC ID

Request body

peer_azure_app_idstring

Azure app registration id in UUID4 form that is allowed to create a peering to the peer vnet

peer_azure_tenant_idstring

Azure tenant id in UUID4 form

peer_cloud_accountstring required

AWS account ID, GCP project ID, Azure subscription ID of the peered VPC, or string "upcloud" for UpCloud peering connections

peer_regionstring

The peer VPC's region on AWS. May be omitted or set to null if the peer is in the same region as the Aiven project VPC. Omit or set to null on GCP, Azure, or UpCloud.

peer_resource_groupstring

Azure resource group name of the peered VPC

peer_vpcstring required

AWS VPC ID, GCP VPC network name, Azure Virtual network name of the peered VPC, or UpCloud VPC ID

user_peer_network_cidrsstring[]

List of private IPv4 ranges to route through the peering connection

Response

Response

create_timestring required

VPC peering connection creation timestamp

messagestring

Printable result of the request

peer_azure_app_idstring required

Azure app registration id in UUID4 form that is allowed to create a peering to the peer vnet

peer_azure_tenant_idstring required

Azure tenant id in UUID4 form

peer_cloud_accountstring required

AWS account ID, GCP project ID, Azure subscription ID of the peered VPC, or string "upcloud" for UpCloud peering connections

peer_regionstring

The peer VPC's region in AWS clouds. Always null in GCP, Azure, or UpCloud clouds

peer_resource_groupstring required

Azure resource group name of the peered VPC

peer_vpcstring required

AWS VPC ID, GCP VPC network name, Azure Virtual network name of the peered VPC, or UpCloud VPC ID

peering_connection_idstring

VPC peering connection ID

state'ACTIVE' | 'APPROVED' | 'APPROVED_PEER_REQUESTED' | 'DELETED' | 'DELETED_BY_PEER' | 'DELETING' | 'ERROR' | 'INVALID_SPECIFICATION' | 'PENDING_PEER' | 'REJECTED_BY_PEER' required

Project VPC peering connection state

update_timestring required

Timestamp of last change to the VPC peering connection

user_peer_network_cidrsstring[] required

List of private IPv4 ranges to route through the peering connection

vpc_peering_connection_type'aws-tgw-vpc-attachment' | 'aws-vpc-peering-connection' | 'azure-vnet-peering' | 'do-vpc-peering' | 'google-vpc-peering' | 'upcloud-vpc-peering' required

Type of network connection from the VPC