API ReferenceVPC Peering

Retrieve all VPC peerings

View as Markdown

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 FORGE_TENANT_ADMIN or FORGE_PROVIDER_ADMIN role.

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://carbide-rest-api.carbide.svc.cluster.local/v2/org/$ORG_NAME/carbide/user/current ```

Path parameters

orgstringRequired

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).

includeRelationenumOptional
Related entity to expand
Allowed values:

Response headers

X-Paginationstring
Pagination result in JSON format

Response

OK
idstringRead-onlyformat: "uuid"
Unique identifier of the VPC peering
vpc1IdstringRead-onlyformat: "uuid"
ID of the first VPC in the peering
vpc2IdstringRead-onlyformat: "uuid"
ID of the second VPC in the peering
siteIdstringRead-onlyformat: "uuid"
ID of the Site where the peering exists
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