Retrieve all Interfaces

GET

https://nico-rest-api.nico.svc.cluster.local/v2/org/:org/nico/instance/:instanceId/interface

GET

/v2/org/:org/nico/instance/:instanceId/interface

$ curl https://nico-rest-api.nico.svc.cluster.local/v2/org/org/nico/instance/instanceId/interface \
>      -H "Authorization: Bearer <token>"

1 [
2   {
3     "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
4     "instanceId": "64d2028c-ae87-4069-a624-66089d957ef9",
5     "subnetId": "1f232bf0-7b90-456e-b9b0-38d9fea4171a",
6     "isPhysical": true,
7     "virtualFunctionId": null,
8     "macAddress": "2F-FC-34-AE-9C-2A",
9     "ipAddresses": [
10       "200.32.11.190"
11     ],
12     "status": "Pending",
13     "created": "2019-08-24T14:15:22Z",
14     "updated": "2019-08-24T14:15:22Z"
15   },
16   {
17     "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
18     "instanceId": "d57b373a-5a59-4fa4-b080-50e9a1095aeb",
19     "vpcPrefixId": "26be5f71-3d51-487b-a940-6513c7725cfd",
20     "isPhysical": true,
21     "virtualFunctionId": null,
22     "macAddress": "2F-FC-34-AE-9C-2A",
23     "ipAddresses": [
24       "200.32.11.190"
25     ],
26     "status": "Pending",
27     "created": "2019-08-24T14:15:22Z",
28     "updated": "2019-08-24T14:15:22Z"
29   }
30 ]

Get all Interfaces for an Instance

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

instanceIdstringRequired

ID of the Instance

Query parameters

statusstringOptional

Filter Interfaces by Status

includeRelationenumOptional

Related entity to expand

Allowed values:

pageNumberintegerOptional>=1Defaults to 1

Page number for pagination query

pageSizeintegerOptional1-100

Page size for pagination query

orderByenumOptional

Ordering for pagination query

Response headers

Response

idstringformat: "uuid">=1 character

Unique UUID v4 identifier for the Interface

instanceIdstringformat: "uuid"

ID of the associated Instance

subnetIdstring or nullformat: "uuid"

ID of the associated Subnet

vpcPrefixIdstring or nullformat: "uuid"

ID of the VPC Prefix explicitly selected by the caller

vpcIdstringformat: "uuid"

ID of the VPC from which the Controller selects a prefix

ipFamilieslist of enums

Address families requested for Controller prefix selection

isPhysicalboolean

Indicates whether the network is bound on a physical Interface

devicestring or null

Name of the device to use

deviceInstanceinteger or null

Index of the device, used to identify which interface card to attache the Partition to

virtualFunctionIdinteger or null

Must be specified if isPhysical is false

macAddressstring or null

MAC address of the Interface

ipAddresseslist of strings

A list of IPv4 or IPv6 addresses

requestedIpAddressstring or null

Explicitly requested IP address for the interface. This is only used with an explicit vpcPrefixId and is not valid with subnetId or VPC-selected interfaces. The least-significant host bit must be 1.

inlineRoutingProfileobject or null

Inline interface-local routing profile options. Only valid for VPC-backed interfaces.

statusenum

Status of the Interface

createddatetimeRead-only

Date/time when the Interface was created

updateddatetimeRead-only

Date/time when the Interface was last updated

Errors

403

Forbidden Error