instance_network_interface_update

Update network interface
put/v1/network-interfaces/{interface}

Path Parameters

interface

Query Parameters

instance

project

Request Body

Parameters for updating an InstanceNetworkInterface

Note that modifying IP addresses for an interface is not yet supported, a new interface must be created instead.

Object
description
name

Names must begin with a lower case ASCII letter, be composed exclusively of lowercase ASCII, uppercase ASCII, numbers, and '-', and may not end with a '-'. Names cannot be a UUID, but they may contain a UUID. They can be at most 63 characters long.

primary

Make a secondary interface the instance's primary interface.

If applied to a secondary interface, that interface will become the primary on the next reboot of the instance. Note that this may have implications for routing between instances, as the new primary interface will be on a distinct subnet from the previous primary interface.

Note that this can only be used to select a new primary interface for an instance. Requests to change the primary interface into a secondary will return an error.

transit_ips

A set of additional networks that this interface may send and receive traffic on.

Responses

Object
description

human-readable free-form text about a resource

id

unique, immutable, system-controlled identifier for each resource

instance_id

The Instance to which the interface belongs.

ip

The IP address assigned to this interface.

mac

The MAC address assigned to this interface.

A Media Access Control address, in EUI-48 format

name

unique, mutable, user-controlled identifier for each resource

Names must begin with a lower case ASCII letter, be composed exclusively of lowercase ASCII, uppercase ASCII, numbers, and '-', and may not end with a '-'. Names cannot be a UUID, but they may contain a UUID. They can be at most 63 characters long.

primary

True if this interface is the primary for the instance to which it's attached.

subnet_id

The subnet to which the interface belongs.

time_created

timestamp when this resource was created

time_modified

timestamp when this resource was last modified

transit_ips

A set of additional networks that this interface may send and receive traffic on.

vpc_id

The VPC to which the interface belongs.