VPC Peering

Create VPC peering

Create a VPC peering between two VPCs on the same site.

Tenant Admin can create single-tenant peerings (both VPCs belong to their tenant). Provider Admin can create multi-tenant peerings (VPCs from different tenants).

User must have authorization role with TENANT_ADMIN or PROVIDER_ADMIN suffix.

post/v2/org/{org}/nico/vpc-peering

Request body

vpc1Idstring uuid required

ID of the first VPC in the peering

vpc2Idstring uuid required

ID of the second VPC to peer with

siteIdstring uuid required

ID of the Site where the peering exists

Response

Created

idstring uuid

Unique identifier of the VPC peering

vpc1Idstring uuid

ID of the first VPC in the peering

vpc2Idstring uuid

ID of the second VPC in the peering

siteIdstring uuid

ID of the Site where the peering exists

tenantIdstring uuid

ID of the tenant that created the VPC peering.

isMultiTenantboolean

Indicates if this is a multi-tenant peering (VPCs from different tenants)

status'Pending' | 'Configuring' | 'Requested' | 'Ready' | 'Deleting' | 'Error'

Status values for VPC peering objects

createdstring date-time

Date and time when the VPC peering was created

updatedstring date-time

Date and time when the VPC peering was last updated

Example response

{
  "site": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "San Jose Central 4",
    "infrastructureProviderId": "5f2cc306-76e9-4fca-9186-950c9ef9a74e",
    "isSerialConsoleEnabled": true,
    "isOnline": false,
    "capabilities": {
      "nativeNetworking": false,
      "networkSecurityGroup": true,
      "nvLinkPartition": false,
      "flow": false,
      "imageBasedOperatingSystem": false,
      "vpcSlaac": false
    },
    "status": "Pending"
  },
  "tenant": {
    "capabilities": {
      "targetedInstanceCreation": true
    }
  }
}

Changes

Changed in 4 of the 92 revisions of this API.19

    • added the optional property site/capabilities/dpsPowerManagement to the response with the 201 status

      response-optional-property-added

    • added the optional property site/capabilities/vpcSlaac to the response with the 201 status

      response-optional-property-added

  • dfd4cab0a8b112See the full diff
    • the tenant/capabilities/targetedInstanceCreation response's property type/format changed from boolean/uuid to boolean/ for status 201

      response-property-type-changed

    • added the optional property tenant/deprecations to the response with the 201 status

      response-optional-property-added

    • response property tenant/capabilities/targetedInstanceCreation deprecated

      response-property-deprecated

    • added the optional property site to the response with the 201 status

      response-optional-property-added

    • added the optional property tenant to the response with the 201 status

      response-optional-property-added

    • added the optional property tenantId to the response with the 201 status

      response-optional-property-added

    • added the optional property vpc1 to the response with the 201 status

      response-optional-property-added

    • added the optional property vpc2 to the response with the 201 status

      response-optional-property-added