Sign in
VPC Peering

Retrieve a VPC peering

Get details of a VPC peering by ID.

Tenant Admin can get a peering if at least one VPC belongs to their tenant. Provider Admin can get a peering if it is in a site provided by their org.

User must have authorization role with TENANT_ADMIN or PROVIDER_ADMIN suffix.

get/v2/org/{org}/nico/vpc-peering/{id}

Query parameters

includeRelation'Vpc1' | 'Vpc2' | 'Site' | 'Tenant'

Related entity to expand

Response

OK

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 93 revisions of this API.110

  • 9c78a8936b341See the full diff
    • ○

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

      response-optional-property-added

  • a482c2d8f5e21See the full diff
    • ○

      added the optional property site/capabilities/vpcSlaac to the response with the 200 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 200

      response-property-type-changed

    • ○

      added the optional property tenant/deprecations to the response with the 200 status

      response-optional-property-added

    • ○

      response property tenant/capabilities/targetedInstanceCreation deprecated

      response-property-deprecated

  • 69a13b7149886See the full diff
    • ○

      added the new enum value Tenant to the query request parameter includeRelation

      request-parameter-enum-value-added

    • ○

      added the optional property site to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property tenant to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property tenantId to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property vpc1 to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property vpc2 to the response with the 200 status

      response-optional-property-added