---
title: "Retrieve all Interfaces"
method: GET
path: "/v2/org/{org}/nico/instance/{instanceId}/interface"
tags: ["Instance"]
---

# Retrieve all Interfaces

`GET /v2/org/{org}/nico/instance/{instanceId}/interface`

Get all Interfaces for an Instance

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

## Query parameters

- `status` string
- `includeRelation` 'Instance' | 'Subnet'
- `pageNumber` integer — One-indexed page number.
- `pageSize` integer
- `orderBy` 'STATUS_ASC' | 'STATUS_DESC' | 'CREATED_ASC' | 'CREATED_DESC' | 'UPDATED_ASC' | 'UPDATED_DESC'

## Response `200`

OK

- Interface[]
  - `id` string, uuid — Unique UUID v4 identifier for the Interface
  - `instanceId` string, uuid — ID of the associated Instance
  - `subnetId` string, uuid, nullable — ID of the associated Subnet
  - `vpcPrefixId` string, uuid, nullable — ID of the VPC Prefix explicitly selected by the caller
  - `vpcId` string, uuid — ID of the VPC from which the Controller selects a prefix
  - `ipFamilies` IPFamily[] — Address families requested for Controller prefix selection
  - `isPhysical` boolean — Indicates whether the network is bound on a physical Interface
  - `device` string, nullable — Name of the device to use
  - `deviceInstance` integer, nullable — Index of the device, used to identify which interface card to attache the Partition to
  - `virtualFunctionId` integer, nullable — Must be specified if isPhysical is false
  - `macAddress` string, nullable — MAC address of the Interface
  - `ipAddresses` string[] — A list of IPv4 or IPv6 addresses
  - `requestedIpAddress` string, 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.
  - `inlineRoutingProfile` InterfaceInlineRoutingProfile — Interface-local routing profile options that narrow the owning VPC's routing profile.
    - `allowedAnycastPrefixes` string[] — CIDR prefixes this interface is allowed to announce as anycast routes.
  - `status` 'Pending' | 'Provisioning' | 'Ready' | 'Deleting' | 'Error' — Status values for Interface objects
  - `created` string, date-time — Date/time when the Interface was created
  - `updated` string, date-time — Date/time when the Interface was last updated

## Other responses

- `403` — Error response when user is not authorized to call an endpoint or retrieve/modify objects

---

[API](https://skmtc.dev/nvidia/apis/nvidia-infra-controller-rest-api.md) · [All operations](https://skmtc.dev/nvidia/apis/nvidia-infra-controller-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/nvidia/nvidia-infra-controller-rest-api/revisions/2096eb1db2c1/schema)