Instances
Instances are computing units providing resources to run your applications on. Scaleway offers various Instance types including CPU Instances and GPU Instances. Note: Instances can be referenced as "servers" in API endpoints.
List all Instances
path Parameters
zoneThe zone you want to target
query Parameters
project_idProject ID to filter servers.
page_tokenToken for pagination.
page_sizeNumber of servers to return per page.
order_byOrder of the returned servers.
server_idsList of server IDs to filter.
nameName to filter servers.
server_typeServer type to filter.
tagsTags to filter servers.
security_group_idsSecurity group IDs to filter servers.
placement_group_idsPlacement group IDs to filter servers.
private_network_idsPrivate Network IDs to filter servers.
mac_addressesMAC addresses to filter servers.
List all Instances › Responses
List of servers.
next_page_tokenToken for the next page.
total_countTotal number of servers.
Create an Instance
Create a new Instance of a specified server_type.
path Parameters
zoneThe zone you want to target
Create an Instance › Request Body
project_idProject ID for the server.
nameName of the server.
tagsTags to associate with the server.
server_typeType of the server.
placement_group_idID of the placement group the server belongs to.
Volumes to attach to the server.
windows_rdp_ssh_key_idIAM ID of the SSH key used to encrypt the Windows Administrator password for RDP use.
Public network interface configuration.
Create an Instance › Responses
idUnique ID of the server.
nameName of the server.
project_idProject ID to which the server belongs.
tagsTags associated with the server.
server_typeType of the server.
placement_group_idID of the placement group the server belongs to.
statusCurrent status of the server.
List of volumes attached to the server.
List of filesystems attached to the server.
architectureArchitecture of the server.
created_atCreation timestamp of the server. (RFC 3339 format)
updated_atLast update timestamp of the server. (RFC 3339 format)
List of private network interfaces attached to the server.
rescue_modeWhether the server is in rescue mode.
boot_volume_idID of the boot volume.
status_detailDetailed status information of the server.
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.
zoneZone in which the server is located.
Get an Instance
Get the details of a specified Instance.
path Parameters
zoneThe zone you want to target
server_idID of the server to retrieve.
Get an Instance › Responses
idUnique ID of the server.
nameName of the server.
project_idProject ID to which the server belongs.
tagsTags associated with the server.
server_typeType of the server.
placement_group_idID of the placement group the server belongs to.
statusCurrent status of the server.
List of volumes attached to the server.
List of filesystems attached to the server.
architectureArchitecture of the server.
created_atCreation timestamp of the server. (RFC 3339 format)
updated_atLast update timestamp of the server. (RFC 3339 format)
List of private network interfaces attached to the server.
rescue_modeWhether the server is in rescue mode.
boot_volume_idID of the boot volume.
status_detailDetailed status information of the server.
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.
zoneZone in which the server is located.
Update an Instance
Update the properties of a specified Instance information, such as name, rescue_mode, or tags.
path Parameters
zoneThe zone you want to target
server_idID of the server to update.
Update an Instance › Request Body
nameNew name for the server.
tagsNew tags for the server.
server_typeNew server type.
placement_group_idNew placement group ID.
rescue_modeNew rescue mode setting.
boot_volume_idNew boot volume ID.
windows_rdp_ssh_key_idNew IAM ID of the SSH key used to encrypt the Windows Administrator password for RDP use.
protectedProtection status of the server.
New public network interface configuration.
Update an Instance › Responses
idUnique ID of the server.
nameName of the server.
project_idProject ID to which the server belongs.
tagsTags associated with the server.
server_typeType of the server.
placement_group_idID of the placement group the server belongs to.
statusCurrent status of the server.
List of volumes attached to the server.
List of filesystems attached to the server.
architectureArchitecture of the server.
created_atCreation timestamp of the server. (RFC 3339 format)
updated_atLast update timestamp of the server. (RFC 3339 format)
List of private network interfaces attached to the server.
rescue_modeWhether the server is in rescue mode.
boot_volume_idID of the boot volume.
status_detailDetailed status information of the server.
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.
zoneZone in which the server is located.
Attach a filesystem volume to an Instance
path Parameters
zoneThe zone you want to target
server_idID of the server to attach the filesystem to.
Attach a filesystem volume to an Instance › Request Body
filesystem_idID of the filesystem to attach.
Attach a filesystem volume to an Instance › Responses
idUnique ID of the server.
nameName of the server.
project_idProject ID to which the server belongs.
tagsTags associated with the server.
server_typeType of the server.
placement_group_idID of the placement group the server belongs to.
statusCurrent status of the server.
List of volumes attached to the server.
List of filesystems attached to the server.
architectureArchitecture of the server.
created_atCreation timestamp of the server. (RFC 3339 format)
updated_atLast update timestamp of the server. (RFC 3339 format)
List of private network interfaces attached to the server.
rescue_modeWhether the server is in rescue mode.
boot_volume_idID of the boot volume.
status_detailDetailed status information of the server.
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.
zoneZone in which the server is located.
Attach an IP to an Instance
path Parameters
zoneThe zone you want to target
server_idID of the server to attach the IP to.
Attach an IP to an Instance › Request Body
ip_idID of the IP to attach.
defaultWhether the IP should be the default IP.
move_allowedWhether moving the IP is allowed.
Attach an IP to an Instance › Responses
idUnique ID of the server.
nameName of the server.
project_idProject ID to which the server belongs.
tagsTags associated with the server.
server_typeType of the server.
placement_group_idID of the placement group the server belongs to.
statusCurrent status of the server.
List of volumes attached to the server.
List of filesystems attached to the server.
architectureArchitecture of the server.
created_atCreation timestamp of the server. (RFC 3339 format)
updated_atLast update timestamp of the server. (RFC 3339 format)
List of private network interfaces attached to the server.
rescue_modeWhether the server is in rescue mode.
boot_volume_idID of the boot volume.
status_detailDetailed status information of the server.
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.
zoneZone in which the server is located.
Attach a private network interface to an Instance
path Parameters
zoneThe zone you want to target
server_idID of the server to attach the private network interface to.
Attach a private network interface to an Instance › Request Body
private_network_interface_idID of the private network interface to attach.
Attach a private network interface to an Instance › Responses
idUnique ID of the server.
nameName of the server.
project_idProject ID to which the server belongs.
tagsTags associated with the server.
server_typeType of the server.
placement_group_idID of the placement group the server belongs to.
statusCurrent status of the server.
List of volumes attached to the server.
List of filesystems attached to the server.
architectureArchitecture of the server.
created_atCreation timestamp of the server. (RFC 3339 format)
updated_atLast update timestamp of the server. (RFC 3339 format)
List of private network interfaces attached to the server.
rescue_modeWhether the server is in rescue mode.
boot_volume_idID of the boot volume.
status_detailDetailed status information of the server.
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.
zoneZone in which the server is located.
Attach a volume to an Instance
Attach a l_ssd or SBS volume to an Instance.
path Parameters
zoneThe zone you want to target
server_idID of the server to attach the volume to.
Attach a volume to an Instance › Request Body
volume_idID of the volume to attach.
volume_typeType of the volume.
boot_volumeWhether the volume should be used as the boot volume.
Attach a volume to an Instance › Responses
idUnique ID of the server.
nameName of the server.
project_idProject ID to which the server belongs.
tagsTags associated with the server.
server_typeType of the server.
placement_group_idID of the placement group the server belongs to.
statusCurrent status of the server.
List of volumes attached to the server.
List of filesystems attached to the server.
architectureArchitecture of the server.
created_atCreation timestamp of the server. (RFC 3339 format)
updated_atLast update timestamp of the server. (RFC 3339 format)
List of private network interfaces attached to the server.
rescue_modeWhether the server is in rescue mode.
boot_volume_idID of the boot volume.
status_detailDetailed status information of the server.
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.
zoneZone in which the server is located.
Detach a filesystem volume from an Instance
path Parameters
zoneThe zone you want to target
server_idID of the server to detach the filesystem from.
Detach a filesystem volume from an Instance › Request Body
filesystem_idID of the filesystem to detach.
Detach a filesystem volume from an Instance › Responses
idUnique ID of the server.
nameName of the server.
project_idProject ID to which the server belongs.
tagsTags associated with the server.
server_typeType of the server.
placement_group_idID of the placement group the server belongs to.
statusCurrent status of the server.
List of volumes attached to the server.
List of filesystems attached to the server.
architectureArchitecture of the server.
created_atCreation timestamp of the server. (RFC 3339 format)
updated_atLast update timestamp of the server. (RFC 3339 format)
List of private network interfaces attached to the server.
rescue_modeWhether the server is in rescue mode.
boot_volume_idID of the boot volume.
status_detailDetailed status information of the server.
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.
zoneZone in which the server is located.
Detach an IP from an Instance
path Parameters
zoneThe zone you want to target
server_idID of the server to detach the IP from.
Detach an IP from an Instance › Responses
idUnique ID of the server.
nameName of the server.
project_idProject ID to which the server belongs.
tagsTags associated with the server.
server_typeType of the server.
placement_group_idID of the placement group the server belongs to.
statusCurrent status of the server.
List of volumes attached to the server.
List of filesystems attached to the server.
architectureArchitecture of the server.
created_atCreation timestamp of the server. (RFC 3339 format)
updated_atLast update timestamp of the server. (RFC 3339 format)
List of private network interfaces attached to the server.
rescue_modeWhether the server is in rescue mode.
boot_volume_idID of the boot volume.
status_detailDetailed status information of the server.
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.
zoneZone in which the server is located.
Detach a private network interface from an Instance
path Parameters
zoneThe zone you want to target
server_idID of the server to detach the private network interface from.
Detach a private network interface from an Instance › Request Body
private_network_interface_idID of the private network interface to detach.
Detach a private network interface from an Instance › Responses
idUnique ID of the server.
nameName of the server.
project_idProject ID to which the server belongs.
tagsTags associated with the server.
server_typeType of the server.
placement_group_idID of the placement group the server belongs to.
statusCurrent status of the server.
List of volumes attached to the server.
List of filesystems attached to the server.
architectureArchitecture of the server.
created_atCreation timestamp of the server. (RFC 3339 format)
updated_atLast update timestamp of the server. (RFC 3339 format)
List of private network interfaces attached to the server.
rescue_modeWhether the server is in rescue mode.
boot_volume_idID of the boot volume.
status_detailDetailed status information of the server.
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.
zoneZone in which the server is located.
Detach a volume from an Instance
path Parameters
zoneThe zone you want to target
server_idID of the server to detach the volume from.
Detach a volume from an Instance › Responses
idUnique ID of the server.
nameName of the server.
project_idProject ID to which the server belongs.
tagsTags associated with the server.
server_typeType of the server.
placement_group_idID of the placement group the server belongs to.
statusCurrent status of the server.
List of volumes attached to the server.
List of filesystems attached to the server.
architectureArchitecture of the server.
created_atCreation timestamp of the server. (RFC 3339 format)
updated_atLast update timestamp of the server. (RFC 3339 format)
List of private network interfaces attached to the server.
rescue_modeWhether the server is in rescue mode.
boot_volume_idID of the boot volume.
status_detailDetailed status information of the server.
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.
zoneZone in which the server is located.
Pause an Instance
Pause a running Instance.
path Parameters
zoneThe zone you want to target
server_idID of the server to pause.
Pause an Instance › Responses
idUnique ID of the server.
nameName of the server.
project_idProject ID to which the server belongs.
tagsTags associated with the server.
server_typeType of the server.
placement_group_idID of the placement group the server belongs to.
statusCurrent status of the server.
List of volumes attached to the server.
List of filesystems attached to the server.
architectureArchitecture of the server.
created_atCreation timestamp of the server. (RFC 3339 format)
updated_atLast update timestamp of the server. (RFC 3339 format)
List of private network interfaces attached to the server.
rescue_modeWhether the server is in rescue mode.
boot_volume_idID of the boot volume.
status_detailDetailed status information of the server.
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.
zoneZone in which the server is located.
Reboot an Instance
Reboot a running or paused Instance.
path Parameters
zoneThe zone you want to target
server_idID of the server to reboot.
Reboot an Instance › Responses
idUnique ID of the server.
nameName of the server.
project_idProject ID to which the server belongs.
tagsTags associated with the server.
server_typeType of the server.
placement_group_idID of the placement group the server belongs to.
statusCurrent status of the server.
List of volumes attached to the server.
List of filesystems attached to the server.
architectureArchitecture of the server.
created_atCreation timestamp of the server. (RFC 3339 format)
updated_atLast update timestamp of the server. (RFC 3339 format)
List of private network interfaces attached to the server.
rescue_modeWhether the server is in rescue mode.
boot_volume_idID of the boot volume.
status_detailDetailed status information of the server.
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.
zoneZone in which the server is located.
Set default IP for an Instance
Set the default IP for an Instance.
path Parameters
zoneThe zone you want to target
server_idID of the server to set the default IP for.
Set default IP for an Instance › Responses
idUnique ID of the server.
nameName of the server.
project_idProject ID to which the server belongs.
tagsTags associated with the server.
server_typeType of the server.
placement_group_idID of the placement group the server belongs to.
statusCurrent status of the server.
List of volumes attached to the server.
List of filesystems attached to the server.
architectureArchitecture of the server.
created_atCreation timestamp of the server. (RFC 3339 format)
updated_atLast update timestamp of the server. (RFC 3339 format)
List of private network interfaces attached to the server.
rescue_modeWhether the server is in rescue mode.
boot_volume_idID of the boot volume.
status_detailDetailed status information of the server.
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.
zoneZone in which the server is located.
Start an Instance
Start a stopped or paused Instance.
path Parameters
zoneThe zone you want to target
server_idID of the server to start.
Start an Instance › Responses
idUnique ID of the server.
nameName of the server.
project_idProject ID to which the server belongs.
tagsTags associated with the server.
server_typeType of the server.
placement_group_idID of the placement group the server belongs to.
statusCurrent status of the server.
List of volumes attached to the server.
List of filesystems attached to the server.
architectureArchitecture of the server.
created_atCreation timestamp of the server. (RFC 3339 format)
updated_atLast update timestamp of the server. (RFC 3339 format)
List of private network interfaces attached to the server.
rescue_modeWhether the server is in rescue mode.
boot_volume_idID of the boot volume.
status_detailDetailed status information of the server.
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.
zoneZone in which the server is located.
Stop an Instance
Stop a running or paused Instance.
path Parameters
zoneThe zone you want to target
server_idID of the server to stop.
Stop an Instance › Responses
idUnique ID of the server.
nameName of the server.
project_idProject ID to which the server belongs.
tagsTags associated with the server.
server_typeType of the server.
placement_group_idID of the placement group the server belongs to.
statusCurrent status of the server.
List of volumes attached to the server.
List of filesystems attached to the server.
architectureArchitecture of the server.
created_atCreation timestamp of the server. (RFC 3339 format)
updated_atLast update timestamp of the server. (RFC 3339 format)
List of private network interfaces attached to the server.
rescue_modeWhether the server is in rescue mode.
boot_volume_idID of the boot volume.
status_detailDetailed status information of the server.
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.
zoneZone in which the server is located.
Stop and delete an Instance
Stop and delete a running or paused Instance.
path Parameters
zoneThe zone you want to target
server_idID of the server to stop and delete.
Stop and delete an Instance › Request Body
delete_all_ipsWhether to delete all IPs attached to the server.
delete_ip_idsList of IP IDs to delete.
delete_all_volumesWhether to delete all volumes attached to the server.
delete_volume_idsList of volume IDs to delete.
keep_all_private_nicsWhether to keep all private network interfaces.
delete_private_nic_idsList of private network interface IDs to delete.
Stop and delete an Instance › Responses
idUnique ID of the server.
nameName of the server.
project_idProject ID to which the server belongs.
tagsTags associated with the server.
server_typeType of the server.
placement_group_idID of the placement group the server belongs to.
statusCurrent status of the server.
List of volumes attached to the server.
List of filesystems attached to the server.
architectureArchitecture of the server.
created_atCreation timestamp of the server. (RFC 3339 format)
updated_atLast update timestamp of the server. (RFC 3339 format)
List of private network interfaces attached to the server.
rescue_modeWhether the server is in rescue mode.
boot_volume_idID of the boot volume.
status_detailDetailed status information of the server.
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.
zoneZone in which the server is located.