Retrieve all VPC peerings

GET

https://nico-rest-api.nico.svc.cluster.local/v2/org/:org/nico/vpc-peering

GET

/v2/org/:org/nico/vpc-peering

$ curl https://nico-rest-api.nico.svc.cluster.local/v2/org/org/nico/vpc-peering \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json"

1 [
2   {
3     "id": "a3f1c2d4-5b6e-7f89-0123-456789abcdef",
4     "vpc1Id": "b1c2d3e4-f567-8901-2345-6789abcdef01",
5     "vpc1": {
6       "id": "b1c2d3e4-f567-8901-2345-6789abcdef01",
7       "name": "Prod VPC East",
8       "tenantId": "c2d3e4f5-6789-0123-4567-89abcdef0123",
9       "tenant": {
10         "id": "c2d3e4f5-6789-0123-4567-89abcdef0123",
11         "org": "acme-inc",
12         "orgDisplayName": "Acme Incorporated"
13       },
14       "networkVirtualizationType": "ETHERNET_VIRTUALIZER",
15       "status": "Ready"
16     },
17     "vpc2Id": "d3e4f567-8901-2345-6789-abcdef012345",
18     "vpc2": {
19       "id": "d3e4f567-8901-2345-6789-abcdef012345",
20       "name": "Dev VPC West",
21       "tenantId": "e4f56789-0123-4567-89ab-cdef01234567",
22       "tenant": {
23         "id": "e4f56789-0123-4567-89ab-cdef01234567",
24         "org": "acme-inc",
25         "orgDisplayName": "Acme Incorporated"
26       },
27       "networkVirtualizationType": "ETHERNET_VIRTUALIZER",
28       "status": "Ready"
29     },
30     "siteId": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
31     "site": {
32       "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
33       "name": "San Jose Central 4",
34       "infrastructureProviderId": "5f2cc306-76e9-4fca-9186-950c9ef9a74e",
35       "isSerialConsoleEnabled": true,
36       "isOnline": false,
37       "capabilities": {
38         "nativeNetworking": false,
39         "networkSecurityGroup": true,
40         "nvLinkPartition": false,
41         "flow": false,
42         "imageBasedOperatingSystem": false
43       },
44       "status": "Pending"
45     },
46     "tenantId": "c2d3e4f5-6789-0123-4567-89abcdef0123",
47     "tenant": {
48       "org": "acme-inc",
49       "orgDisplayName": "Acme Incorporated",
50       "capabilities": {
51         "targetedInstanceCreation": false
52       }
53     },
54     "isMultiTenant": true,
55     "status": "Ready",
56     "created": "2024-01-15T09:30:00Z",
57     "updated": "2024-04-10T15:45:00Z"
58   }
59 ]

Get all VPC peerings. Tenant Admin can get all peerings where the tenant owns at least one VPC. Provider Admin can get all peerings in a site. User must have authorization role with TENANT_ADMIN or PROVIDER_ADMIN suffix.

Authentication

AuthorizationBearer

export JWT_BEARER_TOKEN="<jwt-bearer-token>"
# Example org name: "acme-inc
export ORG_NAME=<org-name>
# Use the JWT bearer token in your API request auth header:
curl -v -X GET -H "Content-Type: application/json" -H "Authorization: Bearer $JWT_BEARER_TOKEN" https://nico-rest-api.nico.svc.cluster.local/v2/org/$ORG_NAME/nico/user/current

``` export JWT_BEARER_TOKEN="<jwt-bearer-token>" # Example org name: "acme-inc export ORG_NAME=<org-name> # Use the JWT bearer token in your API request auth header: curl -v -X GET -H "Content-Type: application/json" -H "Authorization: Bearer $JWT_BEARER_TOKEN" https://nico-rest-api.nico.svc.cluster.local/v2/org/$ORG_NAME/nico/user/current ```

Path parameters

orgstringRequired

Name of the Org

Query parameters

siteIdstringOptionalformat: "uuid"

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

pageNumberintegerOptional>=1Defaults to 1

Page number for pagination query

pageSizeintegerOptional1-100

Page size for pagination query

orderBystringOptional

Ordering for pagination query

isMultiTenantbooleanOptional

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

statusenumOptional

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

vpcIdstringOptionalformat: "uuid"

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

peerTenantIdstringOptionalformat: "uuid"

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

includeRelationenumOptional

Related entity to expand

Allowed values:

Response headers

Response

idstringRead-onlyformat: "uuid"

Unique identifier of the VPC peering

vpc1IdstringRead-onlyformat: "uuid"

ID of the first VPC in the peering

vpc1object

Summary of the first VPC in the peering.

vpc2IdstringRead-onlyformat: "uuid"

ID of the second VPC in the peering

vpc2object

Summary of the second VPC in the peering.

siteIdstringRead-onlyformat: "uuid"

ID of the Site where the peering exists

siteobject

Summary of the Site where the peering exists.

tenantIdstringRead-onlyformat: "uuid"

ID of the tenant that created the VPC peering.

tenantobject

Summary of the tenant that created the VPC peering.

isMultiTenantbooleanRead-only

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

statusenum

Status of the VPC peering

createddatetimeRead-only

Date and time when the VPC peering was created

updateddatetimeRead-only

Date and time when the VPC peering was last updated

Errors

400

Bad Request Error

403

Forbidden Error