Retrieve VPC routing profile

GET

https://nico-rest-api.nico.svc.cluster.local/v2/org/:org/nico/vpc/:vpcId/routing-profile

Read the VPC’s persisted routing profile, active VNI, version, and any retained allocation directly from Core. This is not the effective routing profile or evidence of DPU or fabric convergence. The ordinary VPC GET uses inventory and may lag this response.

Org must have an Infrastructure Provider entity that owns both the VPC and its Site. The VPC must belong to that Site, and the Site must be registered. User must have authorization role with PROVIDER_ADMIN suffix. Tenant administrator authorization alone is insufficient.

Inspection supports VPCs with valid pool ownership even when no named profile is stored or their virtualization type cannot support profile changes. Missing or inconsistent allocation ownership returns 412. A Site-global VNI override is not reflected in this response.

Read the VPC's persisted routing profile, active VNI, version, and any retained allocation directly from Core. This is not the effective routing profile or evidence of DPU or fabric convergence. The ordinary VPC GET uses inventory and may lag this response. Org must have an Infrastructure Provider entity that owns both the VPC and its Site. The VPC must belong to that Site, and the Site must be registered. User must have authorization role with `PROVIDER_ADMIN` suffix. Tenant administrator authorization alone is insufficient. Inspection supports VPCs with valid pool ownership even when no named profile is stored or their virtualization type cannot support profile changes. Missing or inconsistent allocation ownership returns 412. A Site-global VNI override is not reflected in this response.

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 Infrastructure Provider Org

vpcIdstringRequiredformat: "uuid"

REST ID of the VPC

Response

Authoritative persisted routing state and VNI allocations

vpcIdstringformat: "uuid"

REST ID of the VPC selected in the request, which may differ from its Site-local Core ID.

versionstring

Core VPC version observed with these allocations. Use this exact value when approving release of the observed inactive VNI; it is not a DPU-applied version.

routingProfilestring or null

Persisted profile name, or null when no named profile is stored. Known Core names are returned as the REST aliases external, internal, and privileged-internal; other names are unchanged. The name can be returned even when its Site definition is unavailable.

activeVniuint0-4294967295

Persisted active VNI verified against pool ownership. Inspection accepts nonnegative values, including zero and values outside the profile-change range; successful inspection does not imply a profile change is supported.

retainedAllocationobject or null

Allocation owned by this VPC in the other pool, or null when the valid active allocation is its only allocation. Inconsistent ownership is an error, not a null result.

Errors

400

Bad Request Error

403

Forbidden Error

404

Not Found Error

412

Precondition Failed Error

500

Internal Server Error

501

Not Implemented Error

503

Service Unavailable Error

504

Gateway Timeout Error