Create VPC

POST

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

POST

/v2/org/:org/nico/vpc

$ curl -X POST https://nico-rest-api.nico.svc.cluster.local/v2/org/org/nico/vpc \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "name": "spark-vpc",
>   "siteId": "72771e6a-6f5e-4de4-a5b9-1266c4197811",
>   "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
>   "description": "Virtual network for machines executing Spark jobs",
>   "networkVirtualizationType": "ETHERNET_VIRTUALIZER",
>   "vni": 12001,
>   "nvLinkLogicalPartitionId": "dd887330-dbd3-45ce-b400-c42fc8e47315",
>   "labels": {
>     "region": "us-west-1",
>     "env": "dev"
>   }
> }'

1 {
2   "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
3   "name": "spark-vpc",
4   "description": "Virtual network for machines executing Spark jobs",
5   "org": "xskkpgqpeakn",
6   "tenantId": "34f5c98e-f430-457b-a812-92637d0c6fd0",
7   "siteId": "72771e6a-6f5e-4de4-a5b9-1266c4197811",
8   "controllerVpcId": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
9   "networkVirtualizationType": "ETHERNET_VIRTUALIZER",
10   "requestedVni": 12001,
11   "vni": 12001,
12   "nvLinkLogicalPartitionId": "dd887330-dbd3-45ce-b400-c42fc8e47315",
13   "labels": {
14     "region": "us-west-1",
15     "env": "dev"
16   },
17   "status": "Pending",
18   "statusHistory": [
19     {
20       "status": "Pending",
21       "message": "Request received, pending processing",
22       "created": "2019-08-24T14:15:22Z",
23       "updated": "2019-08-24T14:15:22Z"
24     }
25   ],
26   "created": "2019-08-24T14:15:22Z",
27   "updated": "2019-08-24T14:15:22Z"
28 }

Create a VPC for the org.

Org must have a Tenant entity. User must have authorization role with TENANT_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

Request

namestringRequired2-256 characters

Name of the VPC

siteIdstringRequiredformat: "uuid"

ID of the Site where the VPC should be created

idstringOptionalformat: "uuid"

Optional user-specified UUID for the VPC

descriptionstring or nullOptional

Optional description for the VPC

networkVirtualizationTypeenumOptional

Network virtualization type of the VPC. If no value is specified, then defaults to FNN if Site has native networking enabled, or ETHERNET_VIRTUALIZER if native networking is disabled. Flat VPCs hold instances on zero-DPU hosts (or hosts with their DPU in NIC mode) and are never auto-selected — FLAT must be specified explicitly.

routingProfilestring or nullOptional3-64 characters

Specify routing profile for the VPC. Only supported when networkVirtualizationType is set to FNN, or when networkVirtualizationType is omitted and Site has Native Networking enabled. Requires Tenant to have elevated privilege. Current accepted values are privileged-internal, internal, and external.

networkSecurityGroupIdstring or nullOptional

ID of the Network Security Group to attach to the VPC

vniinteger or nullOptional1-65535

Explicitly requested VNI for the VPC

nvLinkLogicalPartitionIdstring or nullOptionalformat: "uuid"

ID of the default NVLink Logical Partition that GPUs for all Instances in the VPC will attach to

labelsmap from strings to stringsOptional

String key-value pairs describing VPC labels. Up to 10 key-value pairs can be specified

Response

Created

idstringRead-onlyformat: "uuid"

ID of the VPC

namestring2-256 characters

Name of the VPC

descriptionstring or null

Description of the VPC, can be empty

orgstringRead-only

Organization the VPC belongs to

tenantIdstringRead-onlyformat: "uuid"

ID of the Tenant the VPC belongs to

siteIdstringformat: "uuid"

ID of the Site the VPC belongs to

controllerVpcIdstring or nullformat: "uuid"

Legacy attribute, contains the same value as ID

networkVirtualizationTypeenum

Network virtualization type of the VPC. Flat VPCs hold instances on zero-DPU hosts (or hosts with their DPU in NIC mode); their interfaces are bound to underlay (HostInband) network segments and NICo does not drive their data plane.

routingProfilestring or null3-64 characters

Routing profile type for the VPC. Populated when Site has Native Networking enabled and network virtualization type is FNN.

requestedVniinteger or nullRead-only1-65535

Explicitly requested VNI for the VPC if one was requested at creation time

vniinteger or nullRead-only1-65535

Active VNI assigned to the VPC

networkSecurityGroupIdstring or null

ID of the Network Security Group attached to the VPC

networkSecurityGroupPropagationDetailsobject

Propagation details for the attached Network Security Group

nvLinkLogicalPartitionIdstring or nullformat: "uuid"

ID of the default NVLink Logical Partition that GPUs for all Instances in the VPC will attach to

labelsmap from strings to strings

String key-value pairs describing VPC labels

statusenum

Status of the VPC

statusHistorylist of objectsRead-only

History of status changes for the VPC

createddatetimeRead-only

Date/time when VPC was created

updateddatetimeRead-only

Date/time when VPC was last updated

Errors

400

Bad Request Error

403

Forbidden Error