Private Network Interfaces

Download schema

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

List private network interfaces

GET

https://api.scaleway.com

/instance/v2alpha1/zones/{zone}/private-network-interfaces

List all private network interfaces.

List private network interfaces › 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

List private network interfaces › query Parameters

project_id

string · required

Filter by Project ID.

page_token

string

Token for pagination.

page_size

integer · uint32

Number of items to return per page.

order_by

string · enum

Field to order results by.

Enum values:

created_at_desc

created_at_asc

updated_at_desc

updated_at_asc

Default: created_at_desc

server_ids

string[]

Filter by server IDs.

private_network_ids

string[]

Filter by Private Network IDs.

tags

string[]

Filter by tags.

List private network interfaces › Responses

200

scaleway.instance.v2alpha1.ListPrivateNetworkInterfacesResponse

scaleway.instance.v2alpha1.PrivateNetworkInterfaceSummary[]

List of private network interfaces.

next_page_token

string

Token for the next page.

total_count

integer · uint64

Total number of items.

Create a private network interface

POST

https://api.scaleway.com

/instance/v2alpha1/zones/{zone}/private-network-interfaces

Create a private network interface linked to a Private Network. It can be attached to an Instance.

Create a private network interface › 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

Create a private network interface › Request Body

private_network_id

string

ID of the Private Network to attach to.

project_id

string

Project ID for the private network interface.

server_id

string

ID of the Instance to attach the interface to.

ip_ids

string[]

List of IP IDs to attach to the interface.

tags

string[]

Tags to assign to the private network interface.

Create a private network interface › Responses

200

scaleway.instance.v2alpha1.PrivateNetworkInterface

id

string

Unique ID of the private network interface.

private_network_id

string

ID of the Private Network this interface is attached to.

project_id

string

Project ID the private network interface belongs to.

server_id

string

ID of the Instance this interface is attached to.

mac_address

string

MAC address of the private network interface.

status

string · enum

Current status of the private network interface.

Enum values:

unknown_status

available

attaching

detaching

syncing

Default: unknown_status

ip_ids

string[]

List of IP IDs attached to this interface.

tags

string[]

Tags associated with the private network interface.

created_at

string · date-time

Creation timestamp of the private network interface. (RFC 3339 format)

updated_at

string · date-time

Last update timestamp of the private network interface. (RFC 3339 format)

POST/instance/v2alpha1/zones/{zone}/private-network-interfaces

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{"private_network_id":"string","project_id":"string"}' \
  "https://api.scaleway.com/instance/v2alpha1/zones/{zone}/private-network-interfaces"

Example Request Body

{
  "private_network_id": "private_network_id",
  "project_id": "project_id",
  "server_id": "server_id",
  "ip_ids": [
    "string"
  ],
  "tags": [
    "string"
  ]
}

json

Example Responses

{
  "id": "id",
  "private_network_id": "private_network_id",
  "project_id": "project_id",
  "server_id": "server_id",
  "mac_address": "mac_address",
  "status": "unknown_status",
  "ip_ids": [
    "string"
  ],
  "tags": [
    "string"
  ],
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z"
}

json

application/json

Get a private network interface

GET

https://api.scaleway.com

/instance/v2alpha1/zones/{zone}/private-network-interfaces/{private_network_interface_id}

Get details of a specified private network interface.

Get a private network interface › 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

private_network_interface_id

string · required

ID of the private network interface to retrieve.

Get a private network interface › Responses

200

scaleway.instance.v2alpha1.PrivateNetworkInterface

id

string

Unique ID of the private network interface.

private_network_id

string

ID of the Private Network this interface is attached to.

project_id

string

Project ID the private network interface belongs to.

server_id

string

ID of the Instance this interface is attached to.

mac_address

string

MAC address of the private network interface.

status

string · enum

Current status of the private network interface.

Enum values:

unknown_status

available

attaching

detaching

syncing

Default: unknown_status

ip_ids

string[]

List of IP IDs attached to this interface.

tags

string[]

Tags associated with the private network interface.

created_at

string · date-time

Creation timestamp of the private network interface. (RFC 3339 format)

updated_at

string · date-time

Last update timestamp of the private network interface. (RFC 3339 format)

Delete a private network interface

DELETE

https://api.scaleway.com

/instance/v2alpha1/zones/{zone}/private-network-interfaces/{private_network_interface_id}

Delete a specified private network interface.

Delete a private network interface › 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

private_network_interface_id

string · required

ID of the private network interface to delete.

Delete a private network interface › Responses

No data returned

Update a private network interface

PATCH

https://api.scaleway.com

/instance/v2alpha1/zones/{zone}/private-network-interfaces/{private_network_interface_id}

Update the properties of a specified private network interface.

Update a private network interface › 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

private_network_interface_id

string · required

ID of the private network interface to update.

Update a private network interface › Request Body

tags

string[]

New tags to assign to the private network interface.

Update a private network interface › Responses

200

scaleway.instance.v2alpha1.PrivateNetworkInterface

id

string

Unique ID of the private network interface.

private_network_id

string

ID of the Private Network this interface is attached to.

project_id

string

Project ID the private network interface belongs to.

server_id

string

ID of the Instance this interface is attached to.

mac_address

string

MAC address of the private network interface.

status

string · enum

Current status of the private network interface.

Enum values:

unknown_status

available

attaching

detaching

syncing

Default: unknown_status

ip_ids

string[]

List of IP IDs attached to this interface.

tags

string[]

Tags associated with the private network interface.

created_at

string · date-time

Creation timestamp of the private network interface. (RFC 3339 format)

updated_at

string · date-time

Last update timestamp of the private network interface. (RFC 3339 format)

Instance Types Placement Groups

List private network interfaces

GET

https://api.scaleway.com

/instance/v2alpha1/zones/{zone}/private-network-interfaces

List all private network interfaces.

List private network interfaces › 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

List private network interfaces › query Parameters

project_id

string · required

Filter by Project ID.

page_token

string

Token for pagination.

page_size

integer · uint32

Number of items to return per page.

order_by

string · enum

Field to order results by.

Enum values:

created_at_desc

created_at_asc

updated_at_desc

updated_at_asc

Default: created_at_desc

server_ids

string[]

Filter by server IDs.

private_network_ids

string[]

Filter by Private Network IDs.

tags

string[]

Filter by tags.

List private network interfaces › Responses

200

scaleway.instance.v2alpha1.ListPrivateNetworkInterfacesResponse

scaleway.instance.v2alpha1.PrivateNetworkInterfaceSummary[]

List of private network interfaces.

next_page_token

string

Token for the next page.

total_count

integer · uint64

Total number of items.

Create a private network interface

POST

https://api.scaleway.com

/instance/v2alpha1/zones/{zone}/private-network-interfaces

Create a private network interface linked to a Private Network. It can be attached to an Instance.

Create a private network interface › 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

Create a private network interface › Request Body

private_network_id

string

ID of the Private Network to attach to.

project_id

string

Project ID for the private network interface.

server_id

string

ID of the Instance to attach the interface to.

ip_ids

string[]

List of IP IDs to attach to the interface.

tags

string[]

Tags to assign to the private network interface.

Create a private network interface › Responses

200

scaleway.instance.v2alpha1.PrivateNetworkInterface

id

string

Unique ID of the private network interface.

private_network_id

string

ID of the Private Network this interface is attached to.

project_id

string

Project ID the private network interface belongs to.

server_id

string

ID of the Instance this interface is attached to.

mac_address

string

MAC address of the private network interface.

status

string · enum

Current status of the private network interface.

Enum values:

unknown_status

available

attaching

detaching

syncing

Default: unknown_status

ip_ids

string[]

List of IP IDs attached to this interface.

tags

string[]

Tags associated with the private network interface.

created_at

string · date-time

Creation timestamp of the private network interface. (RFC 3339 format)

updated_at

string · date-time

Last update timestamp of the private network interface. (RFC 3339 format)

Get a private network interface

GET

https://api.scaleway.com

/instance/v2alpha1/zones/{zone}/private-network-interfaces/{private_network_interface_id}

Get details of a specified private network interface.

Get a private network interface › 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

private_network_interface_id

string · required

ID of the private network interface to retrieve.

Get a private network interface › Responses

200

scaleway.instance.v2alpha1.PrivateNetworkInterface

id

string

Unique ID of the private network interface.

private_network_id

string

ID of the Private Network this interface is attached to.

project_id

string

Project ID the private network interface belongs to.

server_id

string

ID of the Instance this interface is attached to.

mac_address

string

MAC address of the private network interface.

status

string · enum

Current status of the private network interface.

Enum values:

unknown_status

available

attaching

detaching

syncing

Default: unknown_status

ip_ids

string[]

List of IP IDs attached to this interface.

tags

string[]

Tags associated with the private network interface.

created_at

string · date-time

Creation timestamp of the private network interface. (RFC 3339 format)

updated_at

string · date-time

Last update timestamp of the private network interface. (RFC 3339 format)

Delete a private network interface

DELETE

https://api.scaleway.com

/instance/v2alpha1/zones/{zone}/private-network-interfaces/{private_network_interface_id}

Delete a specified private network interface.

Delete a private network interface › 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

private_network_interface_id

string · required

ID of the private network interface to delete.

Delete a private network interface › Responses

No data returned

Update a private network interface

PATCH

https://api.scaleway.com

/instance/v2alpha1/zones/{zone}/private-network-interfaces/{private_network_interface_id}

Update the properties of a specified private network interface.

Update a private network interface › 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

private_network_interface_id

string · required

ID of the private network interface to update.

Update a private network interface › Request Body

tags

string[]

New tags to assign to the private network interface.

Update a private network interface › Responses

200

scaleway.instance.v2alpha1.PrivateNetworkInterface

id

string

Unique ID of the private network interface.

private_network_id

string

ID of the Private Network this interface is attached to.

project_id

string

Project ID the private network interface belongs to.

server_id

string

ID of the Instance this interface is attached to.

mac_address

string

MAC address of the private network interface.

status

string · enum

Current status of the private network interface.

Enum values:

unknown_status

available

attaching

detaching

syncing

Default: unknown_status

ip_ids

string[]

List of IP IDs attached to this interface.

tags

string[]

Tags associated with the private network interface.

created_at

string · date-time

Creation timestamp of the private network interface. (RFC 3339 format)

updated_at

string · date-time

Last update timestamp of the private network interface. (RFC 3339 format)