API ReferenceTenant

Retrieve VPC routing profiles for current Tenant

View as Markdown

Retrieve the current Tenant’s default VPC routing profile and the profiles it may explicitly select at the specified Site.

User must have authorization role with TENANT_ADMIN suffix. Alternative profiles are returned only when TargetedInstanceCreation is effective for this Tenant at the Site.

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 ```

Path parameters

orgstringRequired
Name of the Org

Query parameters

siteIdstringRequiredformat: "uuid"
ID of the Site where the VPC will be created

Response

OK
defaultRoutingProfilestring
Routing profile applied by Core when a VPC omits routingProfile
permittedRoutingProfileslist of strings

Site-configured routing profiles the Tenant may choose at this Site. Choosing defaultRoutingProfile inherits it by omitting routingProfile; other returned values can be sent explicitly when creating a VPC.

Errors

400
Bad Request Error
403
Forbidden Error
404
Not Found Error
504
Gateway Timeout Error