Instances

id

string

Unique ID of the server.

srn

string

The SRN of the server.

name

string

Name of the server.

project_id

string

Project ID to which the server belongs.

tags

string[]

Tags associated with the server.

server_type

string

Type of the server.

placement_group_id

string | null

ID of the placement group the server belongs to.

status

Current status of the server.

Enum values:

unknown_status

started

stopped

paused

starting

stopping

pausing

locked

Default: unknown_status

List of volumes attached to the server.

scaleway.instance.v2alpha1.Server.PrivateNetworkInterface[]

List of filesystems attached to the server.

architecture

scaleway.instance.v2alpha1.Server.Architecture · enum

Architecture of the server.

Enum values:

unknown_architecture

x86_64

aarch64

Default: unknown_architecture

created_at

string | null · date-time

Creation timestamp of the server. (RFC 3339 format)

updated_at

string | null · date-time

Last update timestamp of the server. (RFC 3339 format)

List of private network interfaces attached to the server.

rescue_mode

boolean

Whether the server is in rescue mode.

boot_volume_id

string | null

ID of the boot volume.

status_detail

string

Detailed status information of the server.

scaleway.instance.v2alpha1.Server.PublicNetworkInterface

Encrypted RDP password for Windows servers. The encryption scheme is RSA-PKCS1-v1_5, using the public part of the SSH key supplied in windows_rdp_ssh_key_id.

Public network interface of the server.

zone

string

Zone in which the server is located.

Runtime information of this server, only available only when it is running.

POST/instance/v2alpha1/zones/{zone}/servers

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

Example Request Body

{
  "project_id": "project_id",
  "name": "name",
  "tags": [
    "string"
  ],
  "server_type": "server_type",
  "placement_group_id": "placement_group_id",
  "volumes": [
    {
      "volume_type": "unknown_volume_type",
      "volume_id": "volume_id",
      "new_volume": {
        "name": "name",
        "tags": [
          "string"
        ],
        "size": 0,
        "base_snapshot_id": "base_snapshot_id",
        "image_label": "image_label",
        "perf_iops": 0
      }
    }
  ],
  "windows_rdp_ssh_key_id": "windows_rdp_ssh_key_id",
  "public_network_interface": {
    "security_group_id": "security_group_id",
    "ips": [
      {
        "ipam_ip_id": "ipam_ip_id",
        "new_ip": {
          "type": "unknown_ip_type",
          "tags": [
            "string"
          ]
        }
      }
    ]
  }
}

json

Example Responses

{
  "id": "id",
  "srn": "srn",
  "name": "name",
  "project_id": "project_id",
  "tags": [
    "string"
  ],
  "server_type": "server_type",
  "placement_group_id": "placement_group_id",
  "status": "unknown_status",
  "volumes": [
    {
      "id": "id",
      "volume_type": "unknown_volume_type"
    }
  ],
  "filesystems": [
    {
      "id": "6170692e-7363-616c-6577-61792e636f6d",
      "status": "unknown_status"
    }
  ],
  "architecture": "unknown_architecture",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "private_network_interfaces": [
    {
      "id": "id",
      "private_network_id": "private_network_id",
      "mac_address": "mac_address",
      "status": "unknown_status",
      "ip_ids": [
        "string"
      ],
      "security_group_id": "security_group_id"
    }
  ],
  "rescue_mode": true,
  "boot_volume_id": "boot_volume_id",
  "status_detail": "status_detail",
  "windows_rdp_password": {
    "encrypted_password": "encrypted_password",
    "rdp_ssh_key_id": "rdp_ssh_key_id"
  },
  "public_network_interface": {
    "status": "unknown_status",
    "mac_address": "mac_address",
    "security_group_id": "security_group_id",
    "ips": [
      {
        "id": "id",
        "dynamic": true,
        "status": "unknown_status",
        "default": true,
        "provisioned_address": "1.2.3.4/32"
      }
    ],
    "dns": "dns"
  },
  "zone": "zone",
  "runtime_info": {
    "spot": true
  }
}

json

application/json

Get an Instance

GET

https://api.scaleway.com

/instance/v2alpha1/zones/{zone}/servers/{server_id}

Get the details of a specified Instance.

Get an Instance › 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

ID of the server to retrieve.

Get an Instance › Responses

200

id

string

Unique ID of the server.

srn

string

The SRN of the server.

name

string

Name of the server.

project_id

string

Project ID to which the server belongs.

tags

string[]

Tags associated with the server.

server_type

string

Type of the server.

placement_group_id

string | null

ID of the placement group the server belongs to.

status

Current status of the server.

Enum values:

unknown_status

started

stopped

paused

starting

stopping

pausing

locked

Default: unknown_status

List of volumes attached to the server.

scaleway.instance.v2alpha1.Server.PrivateNetworkInterface[]

List of filesystems attached to the server.

architecture

scaleway.instance.v2alpha1.Server.Architecture · enum

Architecture of the server.

Enum values:

unknown_architecture

x86_64

aarch64

Default: unknown_architecture

created_at

string | null · date-time

Creation timestamp of the server. (RFC 3339 format)

updated_at

string | null · date-time

Last update timestamp of the server. (RFC 3339 format)

List of private network interfaces attached to the server.

rescue_mode

boolean

Whether the server is in rescue mode.

boot_volume_id

string | null

ID of the boot volume.

status_detail

string

Detailed status information of the server.

scaleway.instance.v2alpha1.Server.PublicNetworkInterface

Encrypted RDP password for Windows servers. The encryption scheme is RSA-PKCS1-v1_5, using the public part of the SSH key supplied in windows_rdp_ssh_key_id.

Public network interface of the server.

zone

string

Zone in which the server is located.

scaleway.instance.v2alpha1.UpdateServerRequest.PublicNetworkInterface

Runtime information of this server, only available only when it is running.

GET/instance/v2alpha1/zones/{zone}/servers/{server_id}

curl -X GET \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/instance/v2alpha1/zones/{zone}/servers/{server_id}"

Example Responses

{
  "id": "id",
  "srn": "srn",
  "name": "name",
  "project_id": "project_id",
  "tags": [
    "string"
  ],
  "server_type": "server_type",
  "placement_group_id": "placement_group_id",
  "status": "unknown_status",
  "volumes": [
    {
      "id": "id",
      "volume_type": "unknown_volume_type"
    }
  ],
  "filesystems": [
    {
      "id": "6170692e-7363-616c-6577-61792e636f6d",
      "status": "unknown_status"
    }
  ],
  "architecture": "unknown_architecture",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "private_network_interfaces": [
    {
      "id": "id",
      "private_network_id": "private_network_id",
      "mac_address": "mac_address",
      "status": "unknown_status",
      "ip_ids": [
        "string"
      ],
      "security_group_id": "security_group_id"
    }
  ],
  "rescue_mode": true,
  "boot_volume_id": "boot_volume_id",
  "status_detail": "status_detail",
  "windows_rdp_password": {
    "encrypted_password": "encrypted_password",
    "rdp_ssh_key_id": "rdp_ssh_key_id"
  },
  "public_network_interface": {
    "status": "unknown_status",
    "mac_address": "mac_address",
    "security_group_id": "security_group_id",
    "ips": [
      {
        "id": "id",
        "dynamic": true,
        "status": "unknown_status",
        "default": true,
        "provisioned_address": "1.2.3.4/32"
      }
    ],
    "dns": "dns"
  },
  "zone": "zone",
  "runtime_info": {
    "spot": true
  }
}

json

application/json

Delete an Instance

DELETE

https://api.scaleway.com

/instance/v2alpha1/zones/{zone}/servers/{server_id}

Delete a specified Instance.

Delete an Instance › 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

ID of the server to delete.

Delete an Instance › Responses

No data returned

Update an Instance

PATCH

https://api.scaleway.com

/instance/v2alpha1/zones/{zone}/servers/{server_id}

Update the properties of a specified Instance information, such as name, rescue_mode, or tags.

Update an Instance › 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

ID of the server to update.

Update an Instance › Request Body

name

string | null

New name for the server.

tags

array | null

New tags for the server.

server_type

string | null

New server type.

placement_group_id

string | null

New placement group ID.

rescue_mode

boolean | null

New rescue mode setting.

boot_volume_id

string | null

New boot volume ID.

windows_rdp_ssh_key_id

string | null

New IAM ID of the SSH key used to encrypt the Windows Administrator password for RDP use.

protected

boolean | null

Protection status of the server.

New public network interface configuration.

Update an Instance › Responses

200

id

string

Unique ID of the server.

srn

string

The SRN of the server.

name

string

Name of the server.

project_id

string

Project ID to which the server belongs.

tags

string[]

Tags associated with the server.

server_type

string

Type of the server.

placement_group_id

string | null

ID of the placement group the server belongs to.

status

Current status of the server.

Enum values:

unknown_status

started

stopped

paused

starting

stopping

pausing

locked

Default: unknown_status

List of volumes attached to the server.

scaleway.instance.v2alpha1.Server.PrivateNetworkInterface[]

List of filesystems attached to the server.

architecture

scaleway.instance.v2alpha1.Server.Architecture · enum

Architecture of the server.

Enum values:

unknown_architecture

x86_64

aarch64

Default: unknown_architecture

created_at

string | null · date-time

Creation timestamp of the server. (RFC 3339 format)

updated_at

string | null · date-time

Last update timestamp of the server. (RFC 3339 format)

List of private network interfaces attached to the server.

rescue_mode

boolean

Whether the server is in rescue mode.

boot_volume_id

string | null

ID of the boot volume.

status_detail

string

Detailed status information of the server.

scaleway.instance.v2alpha1.Server.PublicNetworkInterface

Encrypted RDP password for Windows servers. The encryption scheme is RSA-PKCS1-v1_5, using the public part of the SSH key supplied in windows_rdp_ssh_key_id.

Public network interface of the server.

zone

string

Zone in which the server is located.

Runtime information of this server, only available only when it is running.

PATCH/instance/v2alpha1/zones/{zone}/servers/{server_id}

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

Example Request Body

{
  "name": "name",
  "tags": [],
  "server_type": "server_type",
  "placement_group_id": "placement_group_id",
  "rescue_mode": true,
  "boot_volume_id": "boot_volume_id",
  "windows_rdp_ssh_key_id": "windows_rdp_ssh_key_id",
  "protected": true,
  "public_network_interface": {
    "security_group_id": "security_group_id"
  }
}

json

Example Responses

{
  "id": "id",
  "srn": "srn",
  "name": "name",
  "project_id": "project_id",
  "tags": [
    "string"
  ],
  "server_type": "server_type",
  "placement_group_id": "placement_group_id",
  "status": "unknown_status",
  "volumes": [
    {
      "id": "id",
      "volume_type": "unknown_volume_type"
    }
  ],
  "filesystems": [
    {
      "id": "6170692e-7363-616c-6577-61792e636f6d",
      "status": "unknown_status"
    }
  ],
  "architecture": "unknown_architecture",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "private_network_interfaces": [
    {
      "id": "id",
      "private_network_id": "private_network_id",
      "mac_address": "mac_address",
      "status": "unknown_status",
      "ip_ids": [
        "string"
      ],
      "security_group_id": "security_group_id"
    }
  ],
  "rescue_mode": true,
  "boot_volume_id": "boot_volume_id",
  "status_detail": "status_detail",
  "windows_rdp_password": {
    "encrypted_password": "encrypted_password",
    "rdp_ssh_key_id": "rdp_ssh_key_id"
  },
  "public_network_interface": {
    "status": "unknown_status",
    "mac_address": "mac_address",
    "security_group_id": "security_group_id",
    "ips": [
      {
        "id": "id",
        "dynamic": true,
        "status": "unknown_status",
        "default": true,
        "provisioned_address": "1.2.3.4/32"
      }
    ],
    "dns": "dns"
  },
  "zone": "zone",
  "runtime_info": {
    "spot": true
  }
}

json

application/json

Attach a filesystem volume to an Instance

POST

https://api.scaleway.com

/instance/v2alpha1/zones/{zone}/servers/{server_id}/attach-filesystem

Attach a filesystem volume to an Instance › 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

ID of the server to attach the filesystem to.

Attach a filesystem volume to an Instance › Request Body

filesystem_id

string

ID of the filesystem to attach.

Attach a filesystem volume to an Instance › Responses

200

id

string

Unique ID of the server.

srn

string

The SRN of the server.

name

string

Name of the server.

project_id

string

Project ID to which the server belongs.

tags

string[]

Tags associated with the server.

server_type

string

Type of the server.

placement_group_id

string | null

ID of the placement group the server belongs to.

status

Current status of the server.

Enum values:

unknown_status

started

stopped

paused

starting

stopping

pausing

locked

Default: unknown_status

List of volumes attached to the server.

scaleway.instance.v2alpha1.Server.PrivateNetworkInterface[]

List of filesystems attached to the server.

architecture

scaleway.instance.v2alpha1.Server.Architecture · enum

Architecture of the server.

Enum values:

unknown_architecture

x86_64

aarch64

Default: unknown_architecture

created_at

string | null · date-time

Creation timestamp of the server. (RFC 3339 format)

updated_at

string | null · date-time

Last update timestamp of the server. (RFC 3339 format)

List of private network interfaces attached to the server.

rescue_mode

boolean

Whether the server is in rescue mode.

boot_volume_id

string | null

ID of the boot volume.

status_detail

string

Detailed status information of the server.

scaleway.instance.v2alpha1.Server.PublicNetworkInterface

Encrypted RDP password for Windows servers. The encryption scheme is RSA-PKCS1-v1_5, using the public part of the SSH key supplied in windows_rdp_ssh_key_id.

Public network interface of the server.

zone

string

Zone in which the server is located.

Runtime information of this server, only available only when it is running.

POST/instance/v2alpha1/zones/{zone}/servers/{server_id}/attach-filesystem

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

Example Request Body

{
  "filesystem_id": "filesystem_id"
}

json

Example Responses

{
  "id": "id",
  "srn": "srn",
  "name": "name",
  "project_id": "project_id",
  "tags": [
    "string"
  ],
  "server_type": "server_type",
  "placement_group_id": "placement_group_id",
  "status": "unknown_status",
  "volumes": [
    {
      "id": "id",
      "volume_type": "unknown_volume_type"
    }
  ],
  "filesystems": [
    {
      "id": "6170692e-7363-616c-6577-61792e636f6d",
      "status": "unknown_status"
    }
  ],
  "architecture": "unknown_architecture",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "private_network_interfaces": [
    {
      "id": "id",
      "private_network_id": "private_network_id",
      "mac_address": "mac_address",
      "status": "unknown_status",
      "ip_ids": [
        "string"
      ],
      "security_group_id": "security_group_id"
    }
  ],
  "rescue_mode": true,
  "boot_volume_id": "boot_volume_id",
  "status_detail": "status_detail",
  "windows_rdp_password": {
    "encrypted_password": "encrypted_password",
    "rdp_ssh_key_id": "rdp_ssh_key_id"
  },
  "public_network_interface": {
    "status": "unknown_status",
    "mac_address": "mac_address",
    "security_group_id": "security_group_id",
    "ips": [
      {
        "id": "id",
        "dynamic": true,
        "status": "unknown_status",
        "default": true,
        "provisioned_address": "1.2.3.4/32"
      }
    ],
    "dns": "dns"
  },
  "zone": "zone",
  "runtime_info": {
    "spot": true
  }
}

json

application/json

Attach an IP to an Instance

POST

https://api.scaleway.com

/instance/v2alpha1/zones/{zone}/servers/{server_id}/attach-ip

Attach an IP to an Instance › 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

ID of the server to attach the IP to.

Attach an IP to an Instance › Request Body

ip_id

string

ID of the IP to attach.

default

boolean

Whether the IP should be the default IP.

move_allowed

boolean

Whether moving the IP is allowed.

Attach an IP to an Instance › Responses

200

id

string

Unique ID of the server.

srn

string

The SRN of the server.

name

string

Name of the server.

project_id

string

Project ID to which the server belongs.

tags

string[]

Tags associated with the server.

server_type

string

Type of the server.

placement_group_id

string | null

ID of the placement group the server belongs to.

status

Current status of the server.

Enum values:

unknown_status

started

stopped

paused

starting

stopping

pausing

locked

Default: unknown_status

List of volumes attached to the server.

scaleway.instance.v2alpha1.Server.PrivateNetworkInterface[]

List of filesystems attached to the server.

architecture

scaleway.instance.v2alpha1.Server.Architecture · enum

Architecture of the server.

Enum values:

unknown_architecture

x86_64

aarch64

Default: unknown_architecture

created_at

string | null · date-time

Creation timestamp of the server. (RFC 3339 format)

updated_at

string | null · date-time

Last update timestamp of the server. (RFC 3339 format)

List of private network interfaces attached to the server.

rescue_mode

boolean

Whether the server is in rescue mode.

boot_volume_id

string | null

ID of the boot volume.

status_detail

string

Detailed status information of the server.

scaleway.instance.v2alpha1.Server.PublicNetworkInterface

Encrypted RDP password for Windows servers. The encryption scheme is RSA-PKCS1-v1_5, using the public part of the SSH key supplied in windows_rdp_ssh_key_id.

Public network interface of the server.

zone

string

Zone in which the server is located.

Runtime information of this server, only available only when it is running.

POST/instance/v2alpha1/zones/{zone}/servers/{server_id}/attach-ip

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "default": false,
    "ip_id": "string",
    "move_allowed": false
  }' \
  "https://api.scaleway.com/instance/v2alpha1/zones/{zone}/servers/{server_id}/attach-ip"

Example Request Body

{
  "ip_id": "ip_id",
  "default": true,
  "move_allowed": true
}

json

Example Responses

{
  "id": "id",
  "srn": "srn",
  "name": "name",
  "project_id": "project_id",
  "tags": [
    "string"
  ],
  "server_type": "server_type",
  "placement_group_id": "placement_group_id",
  "status": "unknown_status",
  "volumes": [
    {
      "id": "id",
      "volume_type": "unknown_volume_type"
    }
  ],
  "filesystems": [
    {
      "id": "6170692e-7363-616c-6577-61792e636f6d",
      "status": "unknown_status"
    }
  ],
  "architecture": "unknown_architecture",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "private_network_interfaces": [
    {
      "id": "id",
      "private_network_id": "private_network_id",
      "mac_address": "mac_address",
      "status": "unknown_status",
      "ip_ids": [
        "string"
      ],
      "security_group_id": "security_group_id"
    }
  ],
  "rescue_mode": true,
  "boot_volume_id": "boot_volume_id",
  "status_detail": "status_detail",
  "windows_rdp_password": {
    "encrypted_password": "encrypted_password",
    "rdp_ssh_key_id": "rdp_ssh_key_id"
  },
  "public_network_interface": {
    "status": "unknown_status",
    "mac_address": "mac_address",
    "security_group_id": "security_group_id",
    "ips": [
      {
        "id": "id",
        "dynamic": true,
        "status": "unknown_status",
        "default": true,
        "provisioned_address": "1.2.3.4/32"
      }
    ],
    "dns": "dns"
  },
  "zone": "zone",
  "runtime_info": {
    "spot": true
  }
}

json

application/json

Attach a private network interface to an Instance

POST

https://api.scaleway.com

/instance/v2alpha1/zones/{zone}/servers/{server_id}/attach-private-network-interface

Attach a private network interface to an Instance › 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

ID of the server to attach the private network interface to.

Attach a private network interface to an Instance › Request Body

private_network_interface_id

string

ID of the private network interface to attach.

Attach a private network interface to an Instance › Responses

200

id

string

Unique ID of the server.

srn

string

The SRN of the server.

name

string

Name of the server.

project_id

string

Project ID to which the server belongs.

tags

string[]

Tags associated with the server.

server_type

string

Type of the server.

placement_group_id

string | null

ID of the placement group the server belongs to.

status

Current status of the server.

Enum values:

unknown_status

started

stopped

paused

starting

stopping

pausing

locked

Default: unknown_status

List of volumes attached to the server.

scaleway.instance.v2alpha1.Server.PrivateNetworkInterface[]

List of filesystems attached to the server.

architecture

scaleway.instance.v2alpha1.Server.Architecture · enum

Architecture of the server.

Enum values:

unknown_architecture

x86_64

aarch64

Default: unknown_architecture

created_at

string | null · date-time

Creation timestamp of the server. (RFC 3339 format)

updated_at

string | null · date-time

Last update timestamp of the server. (RFC 3339 format)

List of private network interfaces attached to the server.

rescue_mode

boolean

Whether the server is in rescue mode.

boot_volume_id

string | null

ID of the boot volume.

status_detail

string

Detailed status information of the server.

scaleway.instance.v2alpha1.Server.PublicNetworkInterface

Encrypted RDP password for Windows servers. The encryption scheme is RSA-PKCS1-v1_5, using the public part of the SSH key supplied in windows_rdp_ssh_key_id.

Public network interface of the server.

zone

string

Zone in which the server is located.

Runtime information of this server, only available only when it is running.

POST/instance/v2alpha1/zones/{zone}/servers/{server_id}/attach-private-network-interface

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{"private_network_interface_id":"string"}' \
  "https://api.scaleway.com/instance/v2alpha1/zones/{zone}/servers/{server_id}/attach-private-network-interface"

Example Request Body

{
  "private_network_interface_id": "private_network_interface_id"
}

json

Example Responses

{
  "id": "id",
  "srn": "srn",
  "name": "name",
  "project_id": "project_id",
  "tags": [
    "string"
  ],
  "server_type": "server_type",
  "placement_group_id": "placement_group_id",
  "status": "unknown_status",
  "volumes": [
    {
      "id": "id",
      "volume_type": "unknown_volume_type"
    }
  ],
  "filesystems": [
    {
      "id": "6170692e-7363-616c-6577-61792e636f6d",
      "status": "unknown_status"
    }
  ],
  "architecture": "unknown_architecture",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "private_network_interfaces": [
    {
      "id": "id",
      "private_network_id": "private_network_id",
      "mac_address": "mac_address",
      "status": "unknown_status",
      "ip_ids": [
        "string"
      ],
      "security_group_id": "security_group_id"
    }
  ],
  "rescue_mode": true,
  "boot_volume_id": "boot_volume_id",
  "status_detail": "status_detail",
  "windows_rdp_password": {
    "encrypted_password": "encrypted_password",
    "rdp_ssh_key_id": "rdp_ssh_key_id"
  },
  "public_network_interface": {
    "status": "unknown_status",
    "mac_address": "mac_address",
    "security_group_id": "security_group_id",
    "ips": [
      {
        "id": "id",
        "dynamic": true,
        "status": "unknown_status",
        "default": true,
        "provisioned_address": "1.2.3.4/32"
      }
    ],
    "dns": "dns"
  },
  "zone": "zone",
  "runtime_info": {
    "spot": true
  }
}

json

application/json

Attach a volume to an Instance

POST

https://api.scaleway.com

/instance/v2alpha1/zones/{zone}/servers/{server_id}/attach-volume

Attach a l_ssd or SBS volume to an Instance.

Attach a volume to an Instance › 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

ID of the server to attach the volume to.

Attach a volume to an Instance › Request Body

volume_id

string

ID of the volume to attach.

volume_type

scaleway.instance.v2alpha1.Server.Volume.VolumeType · enum

Type of the volume.

Enum values:

unknown_volume_type

l_ssd

sbs

scratch

Default: unknown_volume_type

boot_volume

boolean

Whether the volume should be used as the boot volume.

Attach a volume to an Instance › Responses

200

id

string

Unique ID of the server.

srn

string

The SRN of the server.

name

string

Name of the server.

project_id

string

Project ID to which the server belongs.

tags

string[]

Tags associated with the server.

server_type

string

Type of the server.

placement_group_id

string | null

ID of the placement group the server belongs to.

status

Current status of the server.

Enum values:

unknown_status

started

stopped

paused

starting

stopping

pausing

locked

Default: unknown_status

List of volumes attached to the server.

scaleway.instance.v2alpha1.Server.PrivateNetworkInterface[]

List of filesystems attached to the server.

architecture

scaleway.instance.v2alpha1.Server.Architecture · enum

Architecture of the server.

Enum values:

unknown_architecture

x86_64

aarch64

Default: unknown_architecture

created_at

string | null · date-time

Creation timestamp of the server. (RFC 3339 format)

updated_at

string | null · date-time

Last update timestamp of the server. (RFC 3339 format)

List of private network interfaces attached to the server.

rescue_mode

boolean

Whether the server is in rescue mode.

boot_volume_id

string | null

ID of the boot volume.

status_detail

string

Detailed status information of the server.

scaleway.instance.v2alpha1.Server.PublicNetworkInterface

Encrypted RDP password for Windows servers. The encryption scheme is RSA-PKCS1-v1_5, using the public part of the SSH key supplied in windows_rdp_ssh_key_id.

Public network interface of the server.

zone

string

Zone in which the server is located.

Runtime information of this server, only available only when it is running.

POST/instance/v2alpha1/zones/{zone}/servers/{server_id}/attach-volume

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{"boot_volume":false,"volume_id":"string"}' \
  "https://api.scaleway.com/instance/v2alpha1/zones/{zone}/servers/{server_id}/attach-volume"

Example Request Body

{
  "volume_id": "volume_id",
  "volume_type": "unknown_volume_type",
  "boot_volume": true
}

json

Example Responses

{
  "id": "id",
  "srn": "srn",
  "name": "name",
  "project_id": "project_id",
  "tags": [
    "string"
  ],
  "server_type": "server_type",
  "placement_group_id": "placement_group_id",
  "status": "unknown_status",
  "volumes": [
    {
      "id": "id",
      "volume_type": "unknown_volume_type"
    }
  ],
  "filesystems": [
    {
      "id": "6170692e-7363-616c-6577-61792e636f6d",
      "status": "unknown_status"
    }
  ],
  "architecture": "unknown_architecture",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "private_network_interfaces": [
    {
      "id": "id",
      "private_network_id": "private_network_id",
      "mac_address": "mac_address",
      "status": "unknown_status",
      "ip_ids": [
        "string"
      ],
      "security_group_id": "security_group_id"
    }
  ],
  "rescue_mode": true,
  "boot_volume_id": "boot_volume_id",
  "status_detail": "status_detail",
  "windows_rdp_password": {
    "encrypted_password": "encrypted_password",
    "rdp_ssh_key_id": "rdp_ssh_key_id"
  },
  "public_network_interface": {
    "status": "unknown_status",
    "mac_address": "mac_address",
    "security_group_id": "security_group_id",
    "ips": [
      {
        "id": "id",
        "dynamic": true,
        "status": "unknown_status",
        "default": true,
        "provisioned_address": "1.2.3.4/32"
      }
    ],
    "dns": "dns"
  },
  "zone": "zone",
  "runtime_info": {
    "spot": true
  }
}

json

application/json

Detach a filesystem volume from an Instance

POST

https://api.scaleway.com

/instance/v2alpha1/zones/{zone}/servers/{server_id}/detach-filesystem

Detach a filesystem volume from an Instance › 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

ID of the server to detach the filesystem from.

Detach a filesystem volume from an Instance › Request Body

filesystem_id

string

ID of the filesystem to detach.

Detach a filesystem volume from an Instance › Responses

200

id

string

Unique ID of the server.

srn

string

The SRN of the server.

name

string

Name of the server.

project_id

string

Project ID to which the server belongs.

tags

string[]

Tags associated with the server.

server_type

string

Type of the server.

placement_group_id

string | null

ID of the placement group the server belongs to.

status

Current status of the server.

Enum values:

unknown_status

started

stopped

paused

starting

stopping

pausing

locked

Default: unknown_status

List of volumes attached to the server.

scaleway.instance.v2alpha1.Server.PrivateNetworkInterface[]

List of filesystems attached to the server.

architecture

scaleway.instance.v2alpha1.Server.Architecture · enum

Architecture of the server.

Enum values:

unknown_architecture

x86_64

aarch64

Default: unknown_architecture

created_at

string | null · date-time

Creation timestamp of the server. (RFC 3339 format)

updated_at

string | null · date-time

Last update timestamp of the server. (RFC 3339 format)

List of private network interfaces attached to the server.

rescue_mode

boolean

Whether the server is in rescue mode.

boot_volume_id

string | null

ID of the boot volume.

status_detail

string

Detailed status information of the server.

scaleway.instance.v2alpha1.Server.PublicNetworkInterface

Encrypted RDP password for Windows servers. The encryption scheme is RSA-PKCS1-v1_5, using the public part of the SSH key supplied in windows_rdp_ssh_key_id.

Public network interface of the server.

zone

string

Zone in which the server is located.

Runtime information of this server, only available only when it is running.

POST/instance/v2alpha1/zones/{zone}/servers/{server_id}/detach-filesystem

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

Example Request Body

{
  "filesystem_id": "filesystem_id"
}

json

Example Responses

{
  "id": "id",
  "srn": "srn",
  "name": "name",
  "project_id": "project_id",
  "tags": [
    "string"
  ],
  "server_type": "server_type",
  "placement_group_id": "placement_group_id",
  "status": "unknown_status",
  "volumes": [
    {
      "id": "id",
      "volume_type": "unknown_volume_type"
    }
  ],
  "filesystems": [
    {
      "id": "6170692e-7363-616c-6577-61792e636f6d",
      "status": "unknown_status"
    }
  ],
  "architecture": "unknown_architecture",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "private_network_interfaces": [
    {
      "id": "id",
      "private_network_id": "private_network_id",
      "mac_address": "mac_address",
      "status": "unknown_status",
      "ip_ids": [
        "string"
      ],
      "security_group_id": "security_group_id"
    }
  ],
  "rescue_mode": true,
  "boot_volume_id": "boot_volume_id",
  "status_detail": "status_detail",
  "windows_rdp_password": {
    "encrypted_password": "encrypted_password",
    "rdp_ssh_key_id": "rdp_ssh_key_id"
  },
  "public_network_interface": {
    "status": "unknown_status",
    "mac_address": "mac_address",
    "security_group_id": "security_group_id",
    "ips": [
      {
        "id": "id",
        "dynamic": true,
        "status": "unknown_status",
        "default": true,
        "provisioned_address": "1.2.3.4/32"
      }
    ],
    "dns": "dns"
  },
  "zone": "zone",
  "runtime_info": {
    "spot": true
  }
}

json

application/json

Detach an IP from an Instance

POST

https://api.scaleway.com

/instance/v2alpha1/zones/{zone}/servers/{server_id}/detach-ip

Detach an IP from an Instance › 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

ID of the server to detach the IP from.

Detach an IP from an Instance › Request Body

ip_id

string

ID of the IP to detach.

Detach an IP from an Instance › Responses

200

id

string

Unique ID of the server.

srn

string

The SRN of the server.

name

string

Name of the server.

project_id

string

Project ID to which the server belongs.

tags

string[]

Tags associated with the server.

server_type

string

Type of the server.

placement_group_id

string | null

ID of the placement group the server belongs to.

status

Current status of the server.

Enum values:

unknown_status

started

stopped

paused

starting

stopping

pausing

locked

Default: unknown_status

List of volumes attached to the server.

scaleway.instance.v2alpha1.Server.PrivateNetworkInterface[]

List of filesystems attached to the server.

architecture

scaleway.instance.v2alpha1.Server.Architecture · enum

Architecture of the server.

Enum values:

unknown_architecture

x86_64

aarch64

Default: unknown_architecture

created_at

string | null · date-time

Creation timestamp of the server. (RFC 3339 format)

updated_at

string | null · date-time

Last update timestamp of the server. (RFC 3339 format)

List of private network interfaces attached to the server.

rescue_mode

boolean

Whether the server is in rescue mode.

boot_volume_id

string | null

ID of the boot volume.

status_detail

string

Detailed status information of the server.

scaleway.instance.v2alpha1.Server.PublicNetworkInterface

Encrypted RDP password for Windows servers. The encryption scheme is RSA-PKCS1-v1_5, using the public part of the SSH key supplied in windows_rdp_ssh_key_id.

Public network interface of the server.

zone

string

Zone in which the server is located.

Runtime information of this server, only available only when it is running.

POST/instance/v2alpha1/zones/{zone}/servers/{server_id}/detach-ip

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

Example Request Body

{
  "ip_id": "ip_id"
}

json

Example Responses

{
  "id": "id",
  "srn": "srn",
  "name": "name",
  "project_id": "project_id",
  "tags": [
    "string"
  ],
  "server_type": "server_type",
  "placement_group_id": "placement_group_id",
  "status": "unknown_status",
  "volumes": [
    {
      "id": "id",
      "volume_type": "unknown_volume_type"
    }
  ],
  "filesystems": [
    {
      "id": "6170692e-7363-616c-6577-61792e636f6d",
      "status": "unknown_status"
    }
  ],
  "architecture": "unknown_architecture",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "private_network_interfaces": [
    {
      "id": "id",
      "private_network_id": "private_network_id",
      "mac_address": "mac_address",
      "status": "unknown_status",
      "ip_ids": [
        "string"
      ],
      "security_group_id": "security_group_id"
    }
  ],
  "rescue_mode": true,
  "boot_volume_id": "boot_volume_id",
  "status_detail": "status_detail",
  "windows_rdp_password": {
    "encrypted_password": "encrypted_password",
    "rdp_ssh_key_id": "rdp_ssh_key_id"
  },
  "public_network_interface": {
    "status": "unknown_status",
    "mac_address": "mac_address",
    "security_group_id": "security_group_id",
    "ips": [
      {
        "id": "id",
        "dynamic": true,
        "status": "unknown_status",
        "default": true,
        "provisioned_address": "1.2.3.4/32"
      }
    ],
    "dns": "dns"
  },
  "zone": "zone",
  "runtime_info": {
    "spot": true
  }
}

json

application/json

Detach a private network interface from an Instance

POST

https://api.scaleway.com

/instance/v2alpha1/zones/{zone}/servers/{server_id}/detach-private-network-interface

Detach a private network interface from an Instance › 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

ID of the server to detach the private network interface from.

Detach a private network interface from an Instance › Request Body

private_network_interface_id

string

ID of the private network interface to detach.

Detach a private network interface from an Instance › Responses

200

id

string

Unique ID of the server.

srn

string

The SRN of the server.

name

string

Name of the server.

project_id

string

Project ID to which the server belongs.

tags

string[]

Tags associated with the server.

server_type

string

Type of the server.

placement_group_id

string | null

ID of the placement group the server belongs to.

status

Current status of the server.

Enum values:

unknown_status

started

stopped

paused

starting

stopping

pausing

locked

Default: unknown_status

List of volumes attached to the server.

scaleway.instance.v2alpha1.Server.PrivateNetworkInterface[]

List of filesystems attached to the server.

architecture

scaleway.instance.v2alpha1.Server.Architecture · enum

Architecture of the server.

Enum values:

unknown_architecture

x86_64

aarch64

Default: unknown_architecture

created_at

string | null · date-time

Creation timestamp of the server. (RFC 3339 format)

updated_at

string | null · date-time

Last update timestamp of the server. (RFC 3339 format)

List of private network interfaces attached to the server.

rescue_mode

boolean

Whether the server is in rescue mode.

boot_volume_id

string | null

ID of the boot volume.

status_detail

string

Detailed status information of the server.

scaleway.instance.v2alpha1.Server.PublicNetworkInterface

Encrypted RDP password for Windows servers. The encryption scheme is RSA-PKCS1-v1_5, using the public part of the SSH key supplied in windows_rdp_ssh_key_id.

Public network interface of the server.

zone

string

Zone in which the server is located.

Runtime information of this server, only available only when it is running.

POST/instance/v2alpha1/zones/{zone}/servers/{server_id}/detach-private-network-interface

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{"private_network_interface_id":"string"}' \
  "https://api.scaleway.com/instance/v2alpha1/zones/{zone}/servers/{server_id}/detach-private-network-interface"

Example Request Body

{
  "private_network_interface_id": "private_network_interface_id"
}

json

Example Responses

{
  "id": "id",
  "srn": "srn",
  "name": "name",
  "project_id": "project_id",
  "tags": [
    "string"
  ],
  "server_type": "server_type",
  "placement_group_id": "placement_group_id",
  "status": "unknown_status",
  "volumes": [
    {
      "id": "id",
      "volume_type": "unknown_volume_type"
    }
  ],
  "filesystems": [
    {
      "id": "6170692e-7363-616c-6577-61792e636f6d",
      "status": "unknown_status"
    }
  ],
  "architecture": "unknown_architecture",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "private_network_interfaces": [
    {
      "id": "id",
      "private_network_id": "private_network_id",
      "mac_address": "mac_address",
      "status": "unknown_status",
      "ip_ids": [
        "string"
      ],
      "security_group_id": "security_group_id"
    }
  ],
  "rescue_mode": true,
  "boot_volume_id": "boot_volume_id",
  "status_detail": "status_detail",
  "windows_rdp_password": {
    "encrypted_password": "encrypted_password",
    "rdp_ssh_key_id": "rdp_ssh_key_id"
  },
  "public_network_interface": {
    "status": "unknown_status",
    "mac_address": "mac_address",
    "security_group_id": "security_group_id",
    "ips": [
      {
        "id": "id",
        "dynamic": true,
        "status": "unknown_status",
        "default": true,
        "provisioned_address": "1.2.3.4/32"
      }
    ],
    "dns": "dns"
  },
  "zone": "zone",
  "runtime_info": {
    "spot": true
  }
}

json

application/json

Detach a volume from an Instance

POST

https://api.scaleway.com

/instance/v2alpha1/zones/{zone}/servers/{server_id}/detach-volume

Detach a volume from an Instance › 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

ID of the server to detach the volume from.

Detach a volume from an Instance › Request Body

volume_id

string

ID of the volume to detach.

Detach a volume from an Instance › Responses

200

id

string

Unique ID of the server.

srn

string

The SRN of the server.

name

string

Name of the server.

project_id

string

Project ID to which the server belongs.

tags

string[]

Tags associated with the server.

server_type

string

Type of the server.

placement_group_id

string | null

ID of the placement group the server belongs to.

status

Current status of the server.

Enum values:

unknown_status

started

stopped

paused

starting

stopping

pausing

locked

Default: unknown_status

List of volumes attached to the server.

scaleway.instance.v2alpha1.Server.PrivateNetworkInterface[]

List of filesystems attached to the server.

architecture

scaleway.instance.v2alpha1.Server.Architecture · enum

Architecture of the server.

Enum values:

unknown_architecture

x86_64

aarch64

Default: unknown_architecture

created_at

string | null · date-time

Creation timestamp of the server. (RFC 3339 format)

updated_at

string | null · date-time

Last update timestamp of the server. (RFC 3339 format)

List of private network interfaces attached to the server.

rescue_mode

boolean

Whether the server is in rescue mode.

boot_volume_id

string | null

ID of the boot volume.

status_detail

string

Detailed status information of the server.

scaleway.instance.v2alpha1.Server.PublicNetworkInterface

Encrypted RDP password for Windows servers. The encryption scheme is RSA-PKCS1-v1_5, using the public part of the SSH key supplied in windows_rdp_ssh_key_id.

Public network interface of the server.

zone

string

Zone in which the server is located.

Runtime information of this server, only available only when it is running.

POST/instance/v2alpha1/zones/{zone}/servers/{server_id}/detach-volume

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

Example Request Body

{
  "volume_id": "volume_id"
}

json

Example Responses

{
  "id": "id",
  "srn": "srn",
  "name": "name",
  "project_id": "project_id",
  "tags": [
    "string"
  ],
  "server_type": "server_type",
  "placement_group_id": "placement_group_id",
  "status": "unknown_status",
  "volumes": [
    {
      "id": "id",
      "volume_type": "unknown_volume_type"
    }
  ],
  "filesystems": [
    {
      "id": "6170692e-7363-616c-6577-61792e636f6d",
      "status": "unknown_status"
    }
  ],
  "architecture": "unknown_architecture",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "private_network_interfaces": [
    {
      "id": "id",
      "private_network_id": "private_network_id",
      "mac_address": "mac_address",
      "status": "unknown_status",
      "ip_ids": [
        "string"
      ],
      "security_group_id": "security_group_id"
    }
  ],
  "rescue_mode": true,
  "boot_volume_id": "boot_volume_id",
  "status_detail": "status_detail",
  "windows_rdp_password": {
    "encrypted_password": "encrypted_password",
    "rdp_ssh_key_id": "rdp_ssh_key_id"
  },
  "public_network_interface": {
    "status": "unknown_status",
    "mac_address": "mac_address",
    "security_group_id": "security_group_id",
    "ips": [
      {
        "id": "id",
        "dynamic": true,
        "status": "unknown_status",
        "default": true,
        "provisioned_address": "1.2.3.4/32"
      }
    ],
    "dns": "dns"
  },
  "zone": "zone",
  "runtime_info": {
    "spot": true
  }
}

json

application/json

Pause an Instance

POST

https://api.scaleway.com

/instance/v2alpha1/zones/{zone}/servers/{server_id}/pause

Pause a running Instance.

Pause an Instance › 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

ID of the server to pause.

Pause an Instance › Request Body

Pause an Instance › Responses

200

id

string

Unique ID of the server.

srn

string

The SRN of the server.

name

string

Name of the server.

project_id

string

Project ID to which the server belongs.

tags

string[]

Tags associated with the server.

server_type

string

Type of the server.

placement_group_id

string | null

ID of the placement group the server belongs to.

status

Current status of the server.

Enum values:

unknown_status

started

stopped

paused

starting

stopping

pausing

locked

Default: unknown_status

List of volumes attached to the server.

scaleway.instance.v2alpha1.Server.PrivateNetworkInterface[]

List of filesystems attached to the server.

architecture

scaleway.instance.v2alpha1.Server.Architecture · enum

Architecture of the server.

Enum values:

unknown_architecture

x86_64

aarch64

Default: unknown_architecture

created_at

string | null · date-time

Creation timestamp of the server. (RFC 3339 format)

updated_at

string | null · date-time

Last update timestamp of the server. (RFC 3339 format)

List of private network interfaces attached to the server.

rescue_mode

boolean

Whether the server is in rescue mode.

boot_volume_id

string | null

ID of the boot volume.

status_detail

string

Detailed status information of the server.

scaleway.instance.v2alpha1.Server.PublicNetworkInterface

Encrypted RDP password for Windows servers. The encryption scheme is RSA-PKCS1-v1_5, using the public part of the SSH key supplied in windows_rdp_ssh_key_id.

Public network interface of the server.

zone

string

Zone in which the server is located.

Runtime information of this server, only available only when it is running.

POST/instance/v2alpha1/zones/{zone}/servers/{server_id}/pause

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

Example Request Body

{}

json

Example Responses

{
  "id": "id",
  "srn": "srn",
  "name": "name",
  "project_id": "project_id",
  "tags": [
    "string"
  ],
  "server_type": "server_type",
  "placement_group_id": "placement_group_id",
  "status": "unknown_status",
  "volumes": [
    {
      "id": "id",
      "volume_type": "unknown_volume_type"
    }
  ],
  "filesystems": [
    {
      "id": "6170692e-7363-616c-6577-61792e636f6d",
      "status": "unknown_status"
    }
  ],
  "architecture": "unknown_architecture",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "private_network_interfaces": [
    {
      "id": "id",
      "private_network_id": "private_network_id",
      "mac_address": "mac_address",
      "status": "unknown_status",
      "ip_ids": [
        "string"
      ],
      "security_group_id": "security_group_id"
    }
  ],
  "rescue_mode": true,
  "boot_volume_id": "boot_volume_id",
  "status_detail": "status_detail",
  "windows_rdp_password": {
    "encrypted_password": "encrypted_password",
    "rdp_ssh_key_id": "rdp_ssh_key_id"
  },
  "public_network_interface": {
    "status": "unknown_status",
    "mac_address": "mac_address",
    "security_group_id": "security_group_id",
    "ips": [
      {
        "id": "id",
        "dynamic": true,
        "status": "unknown_status",
        "default": true,
        "provisioned_address": "1.2.3.4/32"
      }
    ],
    "dns": "dns"
  },
  "zone": "zone",
  "runtime_info": {
    "spot": true
  }
}

json

application/json

Reboot an Instance

POST

https://api.scaleway.com

/instance/v2alpha1/zones/{zone}/servers/{server_id}/reboot

Reboot a running or paused Instance.

Reboot an Instance › 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

ID of the server to reboot.

Reboot an Instance › Request Body

Reboot an Instance › Responses

200

id

string

Unique ID of the server.

srn

string

The SRN of the server.

name

string

Name of the server.

project_id

string

Project ID to which the server belongs.

tags

string[]

Tags associated with the server.

server_type

string

Type of the server.

placement_group_id

string | null

ID of the placement group the server belongs to.

status

Current status of the server.

Enum values:

unknown_status

started

stopped

paused

starting

stopping

pausing

locked

Default: unknown_status

List of volumes attached to the server.

scaleway.instance.v2alpha1.Server.PrivateNetworkInterface[]

List of filesystems attached to the server.

architecture

scaleway.instance.v2alpha1.Server.Architecture · enum

Architecture of the server.

Enum values:

unknown_architecture

x86_64

aarch64

Default: unknown_architecture

created_at

string | null · date-time

Creation timestamp of the server. (RFC 3339 format)

updated_at

string | null · date-time

Last update timestamp of the server. (RFC 3339 format)

List of private network interfaces attached to the server.

rescue_mode

boolean

Whether the server is in rescue mode.

boot_volume_id

string | null

ID of the boot volume.

status_detail

string

Detailed status information of the server.

scaleway.instance.v2alpha1.Server.PublicNetworkInterface

Encrypted RDP password for Windows servers. The encryption scheme is RSA-PKCS1-v1_5, using the public part of the SSH key supplied in windows_rdp_ssh_key_id.

Public network interface of the server.

zone

string

Zone in which the server is located.

Runtime information of this server, only available only when it is running.

POST/instance/v2alpha1/zones/{zone}/servers/{server_id}/reboot

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

Example Request Body

{}

json

Example Responses

{
  "id": "id",
  "srn": "srn",
  "name": "name",
  "project_id": "project_id",
  "tags": [
    "string"
  ],
  "server_type": "server_type",
  "placement_group_id": "placement_group_id",
  "status": "unknown_status",
  "volumes": [
    {
      "id": "id",
      "volume_type": "unknown_volume_type"
    }
  ],
  "filesystems": [
    {
      "id": "6170692e-7363-616c-6577-61792e636f6d",
      "status": "unknown_status"
    }
  ],
  "architecture": "unknown_architecture",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "private_network_interfaces": [
    {
      "id": "id",
      "private_network_id": "private_network_id",
      "mac_address": "mac_address",
      "status": "unknown_status",
      "ip_ids": [
        "string"
      ],
      "security_group_id": "security_group_id"
    }
  ],
  "rescue_mode": true,
  "boot_volume_id": "boot_volume_id",
  "status_detail": "status_detail",
  "windows_rdp_password": {
    "encrypted_password": "encrypted_password",
    "rdp_ssh_key_id": "rdp_ssh_key_id"
  },
  "public_network_interface": {
    "status": "unknown_status",
    "mac_address": "mac_address",
    "security_group_id": "security_group_id",
    "ips": [
      {
        "id": "id",
        "dynamic": true,
        "status": "unknown_status",
        "default": true,
        "provisioned_address": "1.2.3.4/32"
      }
    ],
    "dns": "dns"
  },
  "zone": "zone",
  "runtime_info": {
    "spot": true
  }
}

json

application/json

Set default IP for an Instance

POST

https://api.scaleway.com

/instance/v2alpha1/zones/{zone}/servers/{server_id}/set-default-ip

Set the default IP for an Instance.

Set default IP for an Instance › 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

ID of the server to set the default IP for.

Set default IP for an Instance › Request Body

ip_id

string

ID of the IP to set as default.

Set default IP for an Instance › Responses

200

id

string

Unique ID of the server.

srn

string

The SRN of the server.

name

string

Name of the server.

project_id

string

Project ID to which the server belongs.

tags

string[]

Tags associated with the server.

server_type

string

Type of the server.

placement_group_id

string | null

ID of the placement group the server belongs to.

status

Current status of the server.

Enum values:

unknown_status

started

stopped

paused

starting

stopping

pausing

locked

Default: unknown_status

List of volumes attached to the server.

scaleway.instance.v2alpha1.Server.PrivateNetworkInterface[]

List of filesystems attached to the server.

architecture

scaleway.instance.v2alpha1.Server.Architecture · enum

Architecture of the server.

Enum values:

unknown_architecture

x86_64

aarch64

Default: unknown_architecture

created_at

string | null · date-time

Creation timestamp of the server. (RFC 3339 format)

updated_at

string | null · date-time

Last update timestamp of the server. (RFC 3339 format)

List of private network interfaces attached to the server.

rescue_mode

boolean

Whether the server is in rescue mode.

boot_volume_id

string | null

ID of the boot volume.

status_detail

string

Detailed status information of the server.

scaleway.instance.v2alpha1.Server.PublicNetworkInterface

Encrypted RDP password for Windows servers. The encryption scheme is RSA-PKCS1-v1_5, using the public part of the SSH key supplied in windows_rdp_ssh_key_id.

Public network interface of the server.

zone

string

Zone in which the server is located.

Runtime information of this server, only available only when it is running.

POST/instance/v2alpha1/zones/{zone}/servers/{server_id}/set-default-ip

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

Example Request Body

{
  "ip_id": "ip_id"
}

json

Example Responses

{
  "id": "id",
  "srn": "srn",
  "name": "name",
  "project_id": "project_id",
  "tags": [
    "string"
  ],
  "server_type": "server_type",
  "placement_group_id": "placement_group_id",
  "status": "unknown_status",
  "volumes": [
    {
      "id": "id",
      "volume_type": "unknown_volume_type"
    }
  ],
  "filesystems": [
    {
      "id": "6170692e-7363-616c-6577-61792e636f6d",
      "status": "unknown_status"
    }
  ],
  "architecture": "unknown_architecture",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "private_network_interfaces": [
    {
      "id": "id",
      "private_network_id": "private_network_id",
      "mac_address": "mac_address",
      "status": "unknown_status",
      "ip_ids": [
        "string"
      ],
      "security_group_id": "security_group_id"
    }
  ],
  "rescue_mode": true,
  "boot_volume_id": "boot_volume_id",
  "status_detail": "status_detail",
  "windows_rdp_password": {
    "encrypted_password": "encrypted_password",
    "rdp_ssh_key_id": "rdp_ssh_key_id"
  },
  "public_network_interface": {
    "status": "unknown_status",
    "mac_address": "mac_address",
    "security_group_id": "security_group_id",
    "ips": [
      {
        "id": "id",
        "dynamic": true,
        "status": "unknown_status",
        "default": true,
        "provisioned_address": "1.2.3.4/32"
      }
    ],
    "dns": "dns"
  },
  "zone": "zone",
  "runtime_info": {
    "spot": true
  }
}

json

application/json

Start an Instance

POST

https://api.scaleway.com

/instance/v2alpha1/zones/{zone}/servers/{server_id}/start

Start a stopped or paused Instance.

Start an Instance › 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

ID of the server to start.

Start an Instance › Request Body

Start an Instance › Responses

200

id

string

Unique ID of the server.

srn

string

The SRN of the server.

name

string

Name of the server.

project_id

string

Project ID to which the server belongs.

tags

string[]

Tags associated with the server.

server_type

string

Type of the server.

placement_group_id

string | null

ID of the placement group the server belongs to.

status

Current status of the server.

Enum values:

unknown_status

started

stopped

paused

starting

stopping

pausing

locked

Default: unknown_status

List of volumes attached to the server.

scaleway.instance.v2alpha1.Server.PrivateNetworkInterface[]

List of filesystems attached to the server.

architecture

scaleway.instance.v2alpha1.Server.Architecture · enum

Architecture of the server.

Enum values:

unknown_architecture

x86_64

aarch64

Default: unknown_architecture

created_at

string | null · date-time

Creation timestamp of the server. (RFC 3339 format)

updated_at

string | null · date-time

Last update timestamp of the server. (RFC 3339 format)

List of private network interfaces attached to the server.

rescue_mode

boolean

Whether the server is in rescue mode.

boot_volume_id

string | null

ID of the boot volume.

status_detail

string

Detailed status information of the server.

scaleway.instance.v2alpha1.Server.PublicNetworkInterface

Encrypted RDP password for Windows servers. The encryption scheme is RSA-PKCS1-v1_5, using the public part of the SSH key supplied in windows_rdp_ssh_key_id.

Public network interface of the server.

zone

string

Zone in which the server is located.

Runtime information of this server, only available only when it is running.

POST/instance/v2alpha1/zones/{zone}/servers/{server_id}/start

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

Example Request Body

{}

json

Example Responses

{
  "id": "id",
  "srn": "srn",
  "name": "name",
  "project_id": "project_id",
  "tags": [
    "string"
  ],
  "server_type": "server_type",
  "placement_group_id": "placement_group_id",
  "status": "unknown_status",
  "volumes": [
    {
      "id": "id",
      "volume_type": "unknown_volume_type"
    }
  ],
  "filesystems": [
    {
      "id": "6170692e-7363-616c-6577-61792e636f6d",
      "status": "unknown_status"
    }
  ],
  "architecture": "unknown_architecture",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "private_network_interfaces": [
    {
      "id": "id",
      "private_network_id": "private_network_id",
      "mac_address": "mac_address",
      "status": "unknown_status",
      "ip_ids": [
        "string"
      ],
      "security_group_id": "security_group_id"
    }
  ],
  "rescue_mode": true,
  "boot_volume_id": "boot_volume_id",
  "status_detail": "status_detail",
  "windows_rdp_password": {
    "encrypted_password": "encrypted_password",
    "rdp_ssh_key_id": "rdp_ssh_key_id"
  },
  "public_network_interface": {
    "status": "unknown_status",
    "mac_address": "mac_address",
    "security_group_id": "security_group_id",
    "ips": [
      {
        "id": "id",
        "dynamic": true,
        "status": "unknown_status",
        "default": true,
        "provisioned_address": "1.2.3.4/32"
      }
    ],
    "dns": "dns"
  },
  "zone": "zone",
  "runtime_info": {
    "spot": true
  }
}

json

application/json

Stop an Instance

POST

https://api.scaleway.com

/instance/v2alpha1/zones/{zone}/servers/{server_id}/stop

Stop a running or paused Instance.

Stop an Instance › 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

ID of the server to stop.

Stop an Instance › Request Body

Stop an Instance › Responses

200

id

string

Unique ID of the server.

srn

string

The SRN of the server.

name

string

Name of the server.

project_id

string

Project ID to which the server belongs.

tags

string[]

Tags associated with the server.

server_type

string

Type of the server.

placement_group_id

string | null

ID of the placement group the server belongs to.

status

Current status of the server.

Enum values:

unknown_status

started

stopped

paused

starting

stopping

pausing

locked

Default: unknown_status

List of volumes attached to the server.

scaleway.instance.v2alpha1.Server.PrivateNetworkInterface[]

List of filesystems attached to the server.

architecture

scaleway.instance.v2alpha1.Server.Architecture · enum

Architecture of the server.

Enum values:

unknown_architecture

x86_64

aarch64

Default: unknown_architecture

created_at

string | null · date-time

Creation timestamp of the server. (RFC 3339 format)

updated_at

string | null · date-time

Last update timestamp of the server. (RFC 3339 format)

List of private network interfaces attached to the server.

rescue_mode

boolean

Whether the server is in rescue mode.

boot_volume_id

string | null

ID of the boot volume.

status_detail

string

Detailed status information of the server.

scaleway.instance.v2alpha1.Server.PublicNetworkInterface

Encrypted RDP password for Windows servers. The encryption scheme is RSA-PKCS1-v1_5, using the public part of the SSH key supplied in windows_rdp_ssh_key_id.

Public network interface of the server.

zone

string

Zone in which the server is located.

Runtime information of this server, only available only when it is running.

POST/instance/v2alpha1/zones/{zone}/servers/{server_id}/stop

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

Example Request Body

{}

json

Example Responses

{
  "id": "id",
  "srn": "srn",
  "name": "name",
  "project_id": "project_id",
  "tags": [
    "string"
  ],
  "server_type": "server_type",
  "placement_group_id": "placement_group_id",
  "status": "unknown_status",
  "volumes": [
    {
      "id": "id",
      "volume_type": "unknown_volume_type"
    }
  ],
  "filesystems": [
    {
      "id": "6170692e-7363-616c-6577-61792e636f6d",
      "status": "unknown_status"
    }
  ],
  "architecture": "unknown_architecture",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "private_network_interfaces": [
    {
      "id": "id",
      "private_network_id": "private_network_id",
      "mac_address": "mac_address",
      "status": "unknown_status",
      "ip_ids": [
        "string"
      ],
      "security_group_id": "security_group_id"
    }
  ],
  "rescue_mode": true,
  "boot_volume_id": "boot_volume_id",
  "status_detail": "status_detail",
  "windows_rdp_password": {
    "encrypted_password": "encrypted_password",
    "rdp_ssh_key_id": "rdp_ssh_key_id"
  },
  "public_network_interface": {
    "status": "unknown_status",
    "mac_address": "mac_address",
    "security_group_id": "security_group_id",
    "ips": [
      {
        "id": "id",
        "dynamic": true,
        "status": "unknown_status",
        "default": true,
        "provisioned_address": "1.2.3.4/32"
      }
    ],
    "dns": "dns"
  },
  "zone": "zone",
  "runtime_info": {
    "spot": true
  }
}

json

application/json

Stop and delete an Instance

POST

https://api.scaleway.com

/instance/v2alpha1/zones/{zone}/servers/{server_id}/stop-and-delete

Stop and delete a running or paused Instance.

Stop and delete an Instance › 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

ID of the server to stop and delete.

Stop and delete an Instance › Request Body

delete_all_ips

boolean | null

Whether to delete all IPs attached to the server.

delete_ip_ids

array | null

List of IP IDs to delete.

delete_all_volumes

boolean | null

Whether to delete all volumes attached to the server.

delete_volume_ids

array | null

List of volume IDs to delete.

keep_all_private_nics

boolean | null

Whether to keep all private network interfaces.

delete_private_nic_ids

array | null

List of private network interface IDs to delete.

Stop and delete an Instance › Responses

200

id

string

Unique ID of the server.

srn

string

The SRN of the server.

name

string

Name of the server.

project_id

string

Project ID to which the server belongs.

tags

string[]

Tags associated with the server.

server_type

string

Type of the server.

placement_group_id

string | null

ID of the placement group the server belongs to.

status

Current status of the server.

Enum values:

unknown_status

started

stopped

paused

starting

stopping

pausing

locked

Default: unknown_status

List of volumes attached to the server.

scaleway.instance.v2alpha1.Server.PrivateNetworkInterface[]

List of filesystems attached to the server.

architecture

scaleway.instance.v2alpha1.Server.Architecture · enum

Architecture of the server.

Enum values:

unknown_architecture

x86_64

aarch64

Default: unknown_architecture

created_at

string | null · date-time

Creation timestamp of the server. (RFC 3339 format)

updated_at

string | null · date-time

Last update timestamp of the server. (RFC 3339 format)

List of private network interfaces attached to the server.

rescue_mode

boolean

Whether the server is in rescue mode.

boot_volume_id

string | null

ID of the boot volume.

status_detail

string

Detailed status information of the server.

scaleway.instance.v2alpha1.Server.PublicNetworkInterface

Encrypted RDP password for Windows servers. The encryption scheme is RSA-PKCS1-v1_5, using the public part of the SSH key supplied in windows_rdp_ssh_key_id.

Public network interface of the server.

zone

string

Zone in which the server is located.