Sign in

v57

latestOpenAPI 3.1.0Apache-2.0raw.githubusercontent.com2026-08-012143051018.3 KB
Instance

Retrieve all Interfaces

Get all Interfaces for an Instance

Org must have a Tenant entity. User must have authorization role with TENANT_ADMIN suffix.

get/v2/org/{org}/nico/instance/{instanceId}/interface

Query parameters

statusstring

Filter Interfaces by Status

includeRelation'Instance' | 'Subnet'

Related entity to expand

pageNumberinteger
Example:1

Page number for pagination query

pageSizeinteger
Example:20

Page size for pagination query

orderBy'STATUS_ASC' | 'STATUS_DESC' | 'CREATED_ASC' | 'CREATED_DESC' | 'UPDATED_ASC' | 'UPDATED_DESC'

Ordering for pagination query

Response

OK

idstring uuid

Unique UUID v4 identifier for the Interface

instanceIdstring uuid

ID of the associated Instance

subnetIdstring uuid nullable

ID of the associated Subnet

vpcPrefixIdstring uuid nullable

ID of the VPC Prefix explicitly selected by the caller

vpcIdstring uuid

ID of the VPC from which the Controller selects a prefix

ipFamiliesIPFamily[]

Address families requested for Controller prefix selection

isPhysicalboolean

Indicates whether the network is bound on a physical Interface

devicestring nullable

Name of the device to use

deviceInstanceinteger nullable

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

virtualFunctionIdinteger nullable

Must be specified if isPhysical is false

macAddressstring nullable

MAC address of the Interface

ipAddressesstring[]

A list of IPv4 or IPv6 addresses

requestedIpAddressstring nullable

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.

status'Pending' | 'Provisioning' | 'Ready' | 'Deleting' | 'Error'

Status values for Interface objects

createdstring date-time

Date/time when the Interface was created

updatedstring date-time

Date/time when the Interface was last updated

Example response

[
  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "instanceId": "64d2028c-ae87-4069-a624-66089d957ef9",
    "subnetId": "1f232bf0-7b90-456e-b9b0-38d9fea4171a",
    "isPhysical": true,
    "virtualFunctionId": null,
    "macAddress": "2F-FC-34-AE-9C-2A",
    "ipAddresses": [
      "200.32.11.190"
    ],
    "status": "Pending",
    "created": "2019-08-24T14:15:22Z",
    "updated": "2019-08-24T14:15:22Z"
  }
]