Sign in
VPC Peering

Retrieve all VPC peerings

Get all VPC peerings. Tenant Admin can get all peerings where the tenant owns at least one VPC. Provider Admin can retrieve all multi-Tenant VPC Peerings. It should be noted that only Provider Admins can create multi-Tenant Peerings. User must have authorization role with TENANT_ADMIN or PROVIDER_ADMIN suffix.

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

Query parameters

siteIdstring uuid

Optional Site ID filter. If provided, caller must have access to the specified Site.

pageNumberinteger

One-indexed page number.

Page number for pagination query

pageSizeinteger
Example:20

Page size for pagination query

orderBystring

Ordering for pagination query

isMultiTenantboolean

Optional filter by peering tenancy type (single-tenant or multi-tenant).

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

Optional filter by peering status. Repeat the parameter to match multiple statuses.

vpcIdstring uuid

Optional filter by VPC ID involved in the peering as either vpc1 or vpc2. Repeat the parameter to match multiple VPCs.

peerTenantIdstring uuid

Optional filter by tenant ID of a VPC involved in the peering. Repeat the parameter to match multiple tenants.

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 5 of the 90 revisions of this API.1113

  • 9c78a8936b341See the full diff
    • ○

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

      response-optional-property-added

  • a482c2d8f5e21See the full diff
    • ○

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

      response-optional-property-added

  • c459c6587dee1See the full diff
    • ●

      for the query request parameter pageNumber, the max was set to 21474836.00

      request-parameter-max-set

  • dfd4cab0a8b112See the full diff
    • ▲

      the items/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 items/tenant/deprecations to the response with the 200 status

      response-optional-property-added

    • ○

      response property items/tenant/capabilities/targetedInstanceCreation deprecated

      response-property-deprecated

  • 69a13b7149889See the full diff
    • ○

      added the new optional query request parameter peerTenantId

      new-optional-request-parameter

    • ○

      added the new optional query request parameter status

      new-optional-request-parameter

    • ○

      added the new optional query request parameter vpcId

      new-optional-request-parameter

    • ○

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

      request-parameter-enum-value-added

    • ○

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

      response-optional-property-added

    • ○

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

      response-optional-property-added

    • ○

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

      response-optional-property-added

    • ○

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

      response-optional-property-added

    • ○

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

      response-optional-property-added