Private NICs

Download schema

A Private NIC is the network interface that connects an Instance to a Private Network. An Instance can have multiple private NICs at the same time, but each NIC must belong to a different Private Network.

List all private NICs

GET

https://api.scaleway.com

/instance/v1/zones/{zone}/servers/{server_id}/private_nics

List all private NICs of a specified Instance. Some private NICs, such as those in deleting, detaching, or in error state are not listed. We strongly recommend migrating to v2alpha1 to retrieve all private NICs.

List all private NICs › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

fr-par-3

nl-ams-1

nl-ams-2

nl-ams-3

pl-waw-1

pl-waw-2

server_id

string · required

Instance to which the private NIC is attached.

List all private NICs › query Parameters

tags

string

Private NIC tags.

per_page

integer · uint32

A positive integer lower or equal to 100 to select the number of items to return.

page

integer · int32

A positive integer to choose the page to return.

List all private NICs › Responses

200

scaleway.instance.v1.ListPrivateNICsResponse

scaleway.instance.v1.PrivateNIC[]

total_count

integer · uint64

Create a private NIC connecting an Instance to a Private Network

POST

https://api.scaleway.com

/instance/v1/zones/{zone}/servers/{server_id}/private_nics

Create a private NIC connecting an Instance to a Private Network. Some private NICs, such as those in deleting, detaching, or in error state are not listed in v1. Therefore, you may encounter quota limits errors when creating a new private NIC, even if your visible count is below the threshold. We strongly recommend migrating to v2alpha1 to see all private NICs.

Create a private NIC connecting an Instance to a Private Network › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

fr-par-3

nl-ams-1

nl-ams-2

nl-ams-3

pl-waw-1

pl-waw-2

server_id

string · required

UUID of the Instance the private NIC will be attached to.

Create a private NIC connecting an Instance to a Private Network › Request Body

private_network_id

string · required

UUID of the private network where the private NIC will be attached.

tags

string[]

Private NIC tags.

ipam_ip_ids

string[]

UUID of IPAM ips, to be attached to the instance in the requested private network. (UUID format)

Create a private NIC connecting an Instance to a Private Network › Responses

scaleway.instance.v1.CreatePrivateNICResponse

scaleway.instance.v1.PrivateNIC

POST/instance/v1/zones/{zone}/servers/{server_id}/private_nics

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{"private_network_id":"string"}' \
  "https://api.scaleway.com/instance/v1/zones/{zone}/servers/{server_id}/private_nics"

Example Request Body

{
  "private_network_id": "private_network_id",
  "tags": [
    "string"
  ],
  "ipam_ip_ids": [
    "6170692e-7363-616c-6577-61792e636f6d"
  ]
}

json

Example Responses

{
  "private_nic": {
    "id": "id",
    "server_id": "server_id",
    "private_network_id": "private_network_id",
    "mac_address": "mac_address",
    "state": "available",
    "tags": [
      "string"
    ],
    "creation_date": "2022-03-22T12:34:56.123456Z",
    "zone": "zone",
    "ipam_ip_ids": [
      "6170692e-7363-616c-6577-61792e636f6d"
    ]
  }
}

json

application/json

Get a private NIC

GET

https://api.scaleway.com

/instance/v1/zones/{zone}/servers/{server_id}/private_nics/{private_nic_id}

Get private NIC properties.

Get a private NIC › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

fr-par-3

nl-ams-1

nl-ams-2

nl-ams-3

pl-waw-1

pl-waw-2

server_id

string · required

Instance to which the private NIC is attached.

private_nic_id

string · required

Private NIC unique ID.

Get a private NIC › Responses

200

scaleway.instance.v1.GetPrivateNICResponse

scaleway.instance.v1.PrivateNIC

Delete a private NIC

DELETE

https://api.scaleway.com

/instance/v1/zones/{zone}/servers/{server_id}/private_nics/{private_nic_id}

Delete a private NIC › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

fr-par-3

nl-ams-1

nl-ams-2

nl-ams-3

pl-waw-1

pl-waw-2

server_id

string · required

Instance to which the private NIC is attached.

private_nic_id

string · required

Private NIC unique ID.

Delete a private NIC › Responses

No data returned

Update a private NIC

PATCH

https://api.scaleway.com

/instance/v1/zones/{zone}/servers/{server_id}/private_nics/{private_nic_id}

Update one or more parameter(s) of a specified private NIC.

Update a private NIC › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

fr-par-3

nl-ams-1

nl-ams-2

nl-ams-3

pl-waw-1

pl-waw-2

server_id

string · required

UUID of the Instance the private NIC will be attached to.

private_nic_id

string · required

Private NIC unique ID.

Update a private NIC › Request Body

tags

array | null

Tags used to select private NIC/s.

Update a private NIC › Responses

200

scaleway.instance.v1.PrivateNIC

id

string

Private NIC unique ID.

server_id

string

Instance to which the private NIC is attached.

private_network_id

string

Private Network the private NIC is attached to.

mac_address

string

Private NIC MAC address.

state

scaleway.instance.v1.PrivateNIC.State · enum

Private NIC state.

Enum values:

available

syncing

syncing_error

Default: available

tags

string[]

Private NIC tags.

creation_date

string | null · date-time

Private NIC creation date. (RFC 3339 format)

zone

string

The zone in which the Private NIC is located.

ipam_ip_ids

string[]

The list of IPAM IPs associated with this private NIC. (UUID format)

Placement Groups Other endpoints