Scaleway logo
Instance API

scaleway.instance.v2alpha1.AddSecurityGroupRulesResponse

Updated security group.

List of rules that were added.

scaleway.instance.v2alpha1.CreateServerRequest.BookIP

Type of IP to book.

Enum values:
unknown_ip_type
zonal_ipv4
zonal_ipv6
Default: unknown_ip_type
tags
​string[]

Tags to associate with the IP.

scaleway.instance.v2alpha1.CreateServerRequest.BookIP.IPType

string · enum
Enum values:
unknown_ip_type
zonal_ipv4
zonal_ipv6
Default: unknown_ip_type

scaleway.instance.v2alpha1.CreateServerRequest.CreateVolume

name
​string

Name of the volume.

tags
​string[]

Tags to associate with the volume.

size
​integer | null · uint64

Size of the volume. (in bytes)

base_snapshot_id
​string | null

ID of the base snapshot for the volume.

image_label
​string | null

Label of the image to use for the volume.

perf_iops
​integer | null · uint32

Performance IOPS for the volume.

scaleway.instance.v2alpha1.CreateServerRequest.PublicNetworkInterface

security_group_id
​string | null

ID of the security group for the interface.

List of IPs to attach to the interface.

scaleway.instance.v2alpha1.CreateServerRequest.ServerIP

ipam_ip_id
​string | null

ID of the IPAM IP to attach.

​

Configuration for a new IP to book.

scaleway.instance.v2alpha1.CreateServerRequest.ServerVolume

Type of the volume.

Enum values:
unknown_volume_type
l_ssd
sbs
scratch
Default: unknown_volume_type
volume_id
​string | null

ID of the volume to attach.

​

Configuration for a new volume to create.

scaleway.instance.v2alpha1.CreateServerRequest.ServerVolume.VolumeType

string · enum
Enum values:
unknown_volume_type
l_ssd
sbs
scratch
Default: unknown_volume_type

scaleway.instance.v2alpha1.CreateTemplateRequest.PrivateNetworkTemplate

private_network_id
​string

ID of the private network.

scaleway.instance.v2alpha1.CreateTemplateRequest.VolumeTemplate

Type of the volume.

Enum values:
unknown_volume_type
l_ssd
sbs
scratch
Default: unknown_volume_type
name
​string

Name of the volume.

tags
​string[]

Tags associated with the volume.

size
​integer | null · uint64

Size of the volume in bytes. (in bytes)

base_snapshot_id
​string | null

ID of the base snapshot for the volume.

image_label
​string | null

Label of the image used as base for the volume.

perf_iops
​integer | null · uint32

Performance IOPS for the volume.

scaleway.instance.v2alpha1.ListPlacementGroupsRequest.OrderBy

string · enum
Enum values:
created_at_desc
created_at_asc
updated_at_desc
updated_at_asc
Default: created_at_desc

scaleway.instance.v2alpha1.ListPlacementGroupsResponse

List of placement groups.

next_page_token
​string | null

The pagination token, use it to get the next page of results.

total_count
​integer · uint64

Total number of placement groups.

scaleway.instance.v2alpha1.ListPrivateNetworkInterfacesRequest.OrderBy

string · enum
Enum values:
created_at_desc
created_at_asc
updated_at_desc
updated_at_asc
Default: created_at_desc

scaleway.instance.v2alpha1.ListPrivateNetworkInterfacesResponse

List of private network interfaces.

next_page_token
​string | null

Token for the next page.

total_count
​integer · uint64

Total number of items.

scaleway.instance.v2alpha1.ListSecurityGroupsRequest.OrderBy

string · enum
Enum values:
created_at_desc
created_at_asc
updated_at_desc
updated_at_asc
Default: created_at_desc

scaleway.instance.v2alpha1.ListSecurityGroupsResponse

List of security groups.

next_page_token
​string | null

Token for the next page.

total_count
​integer · uint64

Total number of items.

scaleway.instance.v2alpha1.ListServerCompatibleTypesResponse

next_page_token
​string | null
total_count
​integer · uint64

scaleway.instance.v2alpha1.ListServerTypesResponse

List of server types.

next_page_token
​string | null

Token for the next page.

total_count
​integer · uint64

Total number of server types.

scaleway.instance.v2alpha1.ListServersRequest.OrderBy

string · enum
Enum values:
created_at_desc
created_at_asc
updated_at_desc
updated_at_asc
Default: created_at_desc

scaleway.instance.v2alpha1.ListServersResponse

List of servers.

next_page_token
​string | null

Token for the next page.

total_count
​integer · uint64

Total number of servers.

scaleway.instance.v2alpha1.ListTemplateUserDataKeysResponse

keys
​string[]

List of user data keys associated with the template.

next_page_token
​string | null

Token for the next page.

total_count
​integer · uint64

Total number of items.

scaleway.instance.v2alpha1.ListTemplatesRequest.OrderBy

string · enum
Enum values:
created_at_desc
created_at_asc
updated_at_desc
updated_at_asc
Default: created_at_desc

scaleway.instance.v2alpha1.ListTemplatesResponse

List of template summaries.

next_page_token
​string | null

Token for the next page.

total_count
​integer · uint64

Total number of items.

scaleway.instance.v2alpha1.ListUserDataKeysResponse

keys
​string[]

List of user data keys.

next_page_token
​string | null

Token for the next page.

total_count
​integer · uint64

Total number of items.

scaleway.instance.v2alpha1.PlacementGroup

id
​string

Placement group unique ID.

srn
​string

The SRN of the placement group.

project_id
​string

Placement group Project ID.

name
​string

Placement group name.

policy_type
​scaleway.instance.v2alpha1.PlacementGroup.PolicyType · enum

Select the behavior of the placement group, either low_latency (group) or max_availability (spread).

Enum values:
unknown_policy_type
low_latency
max_availability
Default: unknown_policy_type
tags
​string[]

Placement group tags.

created_at
​string | null · date-time

Placement group creation date. (RFC 3339 format)

updated_at
​string | null · date-time

Placement group modification date. (RFC 3339 format)

zone
​string

Zone in which the placement group is located.

scaleway.instance.v2alpha1.PlacementGroup.PolicyType

string · enum
Enum values:
unknown_policy_type
low_latency
max_availability
Default: unknown_policy_type

scaleway.instance.v2alpha1.PrivateNetworkInterface

id
​string

Unique ID of the private network interface.

srn
​string

The SRN of the private network interface.

private_network_id
​string

ID of the Private Network this interface is attached to.

project_id
​string

Project ID the private network interface belongs to.

server_id
​string

ID of the Instance this interface is attached to.

mac_address
​string

MAC address of the private network interface.

Current status of the private network interface.

Enum values:
unknown_status
available
attaching
detaching
syncing
deleting
detach_error
delete_error
Default: unknown_status
ip_ids
​string[]

List of IP IDs attached to this interface.

tags
​string[]

Tags associated with the private network interface.

created_at
​string | null · date-time

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

updated_at
​string | null · date-time

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

zone
​string

Zone in which the network interface is located.

scaleway.instance.v2alpha1.PrivateNetworkInterface.Status

string · enum
Enum values:
unknown_status
available
attaching
detaching
syncing
deleting
detach_error
delete_error
Default: unknown_status

scaleway.instance.v2alpha1.PrivateNetworkInterfaceSummary

id
​string

Unique ID of the private network interface.

srn
​string

The SRN of the private network interface.

private_network_id
​string

ID of the Private Network this interface is attached to.

project_id
​string

Project ID the private network interface belongs to.

server_id
​string

ID of the Instance this interface is attached to.

mac_address
​string

MAC address of the private network interface.

Current status of the private network interface.

Enum values:
unknown_status
available
attaching
detaching
syncing
deleting
detach_error
delete_error
Default: unknown_status
ip_ids
​string[]

List of IP IDs attached to this interface.

tags
​string[]

Tags associated with the private network interface.

created_at
​string | null · date-time

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

updated_at
​string | null · date-time

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

zone
​string

Zone in which the network interface is located.

scaleway.instance.v2alpha1.ResourceCounts

servers
​integer · uint32

Number of servers.

gpu_servers
​integer · uint32

Number of GPU servers.

​object

Map of server types with their counts.

security_groups
​integer · uint32

Number of security groups.

placement_groups
​integer · uint32

Number of placement groups.

snapshots
​integer · uint32

Number of snapshots.

volumes
​integer · uint32

Number of volumes.

volumes_l_ssd
​integer · uint32

Number of local SSD volumes.

volumes_l_ssd_total_size
​integer · uint64

Total size of local SSD volumes in bytes.

volumes_scratch
​integer · uint32

Number of scratch volumes.

private_network_interfaces
​integer · uint32

Number of private network interfaces.

templates
​integer · uint32

Number of templates.

flexible_ips
​integer · uint32

Number of flexible IPs.

unused_flexible_ips
​integer · uint32

Number of flexible IPs not attached to any server.

images
​integer · uint32

Number of images.

scaleway.instance.v2alpha1.SecurityGroup

id
​string

Unique ID of the security group.

srn
​string

The SRN of the security group.

name
​string

Name of the security group.

description
​string

Description of the security group.

project_id
​string

Project ID the security group belongs to.

tags
​string[]

Tags associated with the security group.

disable_default_rules
​boolean

True if default rules are disabled.

project_default
​boolean

True if this is the default security group for the project.

inbound_default_action
​scaleway.instance.v2alpha1.SecurityGroup.Action · enum

Default action for inbound rules.

Enum values:
unknown_action
accept
drop
Default: unknown_action
outbound_default_action
​scaleway.instance.v2alpha1.SecurityGroup.Action · enum

Default action for outbound rules.

Enum values:
unknown_action
accept
drop
Default: unknown_action
stateless
​boolean

True if the security group is stateless.

created_at
​string | null · date-time

Creation timestamp of the security group. (RFC 3339 format)

updated_at
​string | null · date-time

Last update timestamp of the security group. (RFC 3339 format)

List of default rules applied to the security group.

List of custom rules applied to the security group.

zone
​string

Zone in which the security group is located.

scaleway.instance.v2alpha1.SecurityGroup.Action

string · enum
Enum values:
unknown_action
accept
drop
Default: unknown_action

scaleway.instance.v2alpha1.SecurityGroupRule

id
​string

Unique ID of the rule.

Protocol this rule applies to.

Enum values:
unknown_protocol
tcp
udp
icmp
any
Default: unknown_protocol

Direction of traffic this rule applies to.

Enum values:
unknown_direction
inbound
outbound
both
Default: unknown_direction

Action to take when the rule matches.

Enum values:
unknown_action
accept
drop
Default: unknown_action
source_ip_range
​string

Source IP range for the rule. (IP network)

destination_ip_range
​string

Destination IP range for the rule. (IP network)

Source port range for the rule.

Destination port range for the rule.

position
​integer · uint32

Position of the rule in the list.

scaleway.instance.v2alpha1.SecurityGroupRule.Action

string · enum
Enum values:
unknown_action
accept
drop
Default: unknown_action

scaleway.instance.v2alpha1.SecurityGroupRule.Direction

string · enum
Enum values:
unknown_direction
inbound
outbound
both
Default: unknown_direction

scaleway.instance.v2alpha1.SecurityGroupRule.PortRange

start
​integer · uint32

Start of the port range.

end
​integer · uint32

End of the port range.

scaleway.instance.v2alpha1.SecurityGroupRule.Protocol

string · enum
Enum values:
unknown_protocol
tcp
udp
icmp
any
Default: unknown_protocol

scaleway.instance.v2alpha1.SecurityGroupRuleConfig

Protocol for the rule.

Enum values:
unknown_protocol
tcp
udp
icmp
any
Default: unknown_protocol

Direction of traffic for the rule.

Enum values:
unknown_direction
inbound
outbound
both
Default: unknown_direction

Action to take when the rule matches.

Enum values:
unknown_action
accept
drop
Default: unknown_action
source_ip_range
​string

Source IP range for the rule. (IP network)

destination_ip_range
​string

Destination IP range for the rule. (IP network)

Source port range for the rule.

Destination port range for the rule.

position
​integer · int32

Position of this rule in the rule list, starting at 1.

scaleway.instance.v2alpha1.SecurityGroupSummary

id
​string

Unique ID of the security group.

srn
​string

The SRN of the security group.

name
​string

Name of the security group.

description
​string

Description of the security group.

project_id
​string

Project ID the security group belongs to.

tags
​string[]

Tags associated with the security group.

disable_default_rules
​boolean

True if default rules are disabled.

project_default
​boolean

True if this is the default security group for the project.

inbound_default_action
​scaleway.instance.v2alpha1.SecurityGroup.Action · enum

Default action for inbound rules.

Enum values:
unknown_action
accept
drop
Default: unknown_action
outbound_default_action
​scaleway.instance.v2alpha1.SecurityGroup.Action · enum

Default action for outbound rules.

Enum values:
unknown_action
accept
drop
Default: unknown_action
stateless
​boolean

True if the security group is stateless.

created_at
​string | null · date-time

Creation timestamp of the security group. (RFC 3339 format)

updated_at
​string | null · date-time

Last update timestamp of the security group. (RFC 3339 format)

zone
​string

Zone in which the security group is located.

scaleway.instance.v2alpha1.Server

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
​scaleway.instance.v2alpha1.Server.Status · enum

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.

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.

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.

scaleway.instance.v2alpha1.Server.Architecture

string · enum
Enum values:
unknown_architecture
x86_64
aarch64
Default: unknown_architecture

scaleway.instance.v2alpha1.Server.Filesystem

id
​string

(UUID format)

Enum values:
unknown_status
attaching
available
detaching
Default: unknown_status

scaleway.instance.v2alpha1.Server.Filesystem.Status

string · enum
Enum values:
unknown_status
attaching
available
detaching
Default: unknown_status

scaleway.instance.v2alpha1.Server.IP

id
​string
dynamic
​boolean
status
​scaleway.instance.v2alpha1.Server.IP.Status · enum
Enum values:
unknown_status
detached
attached
pending
error
Default: unknown_status
default
​boolean
provisioned_address
​string

(IP network)

scaleway.instance.v2alpha1.Server.IP.Status

string · enum
Enum values:
unknown_status
detached
attached
pending
error
Default: unknown_status

scaleway.instance.v2alpha1.Server.PrivateNetworkInterface

id
​string
private_network_id
​string
mac_address
​string
Enum values:
unknown_status
available
attaching
detaching
syncing
deleting
detach_error
delete_error
Default: unknown_status
ip_ids
​string[]
security_group_id
​string

scaleway.instance.v2alpha1.Server.PrivateNetworkInterface.Status

string · enum
Enum values:
unknown_status
available
attaching
detaching
syncing
deleting
detach_error
delete_error
Default: unknown_status

scaleway.instance.v2alpha1.Server.PublicNetworkInterface

Enum values:
unknown_status
available
syncing
Default: unknown_status
mac_address
​string
security_group_id
​string
dns
​string

scaleway.instance.v2alpha1.Server.PublicNetworkInterface.Status

string · enum
Enum values:
unknown_status
available
syncing
Default: unknown_status

scaleway.instance.v2alpha1.Server.RDPPassword

encrypted_password
​string
rdp_ssh_key_id
​string

scaleway.instance.v2alpha1.Server.RuntimeInfo

spot
​boolean

True if the Instance is running as Spot.

scaleway.instance.v2alpha1.Server.Status

string · enum
Enum values:
unknown_status
started
stopped
paused
starting
stopping
pausing
locked
Default: unknown_status

scaleway.instance.v2alpha1.Server.Volume

id
​string
volume_type
​scaleway.instance.v2alpha1.Server.Volume.VolumeType · enum
Enum values:
unknown_volume_type
l_ssd
sbs
scratch
Default: unknown_volume_type

scaleway.instance.v2alpha1.Server.Volume.VolumeType

string · enum
Enum values:
unknown_volume_type
l_ssd
sbs
scratch
Default: unknown_volume_type

scaleway.instance.v2alpha1.ServerSummary

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
​scaleway.instance.v2alpha1.Server.Status · enum

Current status of the server.

Enum values:
unknown_status
started
stopped
paused
starting
stopping
pausing
locked
Default: unknown_status
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)

rescue_mode
​boolean

Whether the server is in rescue mode.

zone
​string

Zone in which the server is located.

scaleway.instance.v2alpha1.ServerType

name
​string

Name of the server type.

vcpu_count
​integer · uint32

Number of vCPUs.

gpu_count
​integer · uint32

Number of GPUs.

memory
​integer · uint64

Amount of memory. (in bytes)

architecture
​scaleway.instance.v2alpha1.ServerType.Architecture · enum

Architecture of the server type.

Enum values:
unknown_architecture
x86_64
aarch64
Default: unknown_architecture
availability
​scaleway.instance.v2alpha1.ServerType.Availability · enum

Availability status of the server type.

Enum values:
unknown_availability
available
low_stock
out_of_stock
unavailable
Default: unknown_availability

Limits for the server type.

GPU information for the server type.

end_of_service
​boolean

Whether the server type has reached end of service.

Availability status of the server type as a spot instance.

scaleway.instance.v2alpha1.ServerType.Architecture

string · enum
Enum values:
unknown_architecture
x86_64
aarch64
Default: unknown_architecture

scaleway.instance.v2alpha1.ServerType.Availability

string · enum
Enum values:
unknown_availability
available
low_stock
out_of_stock
unavailable
Default: unknown_availability

scaleway.instance.v2alpha1.ServerType.GpuInfo

manufacturer
​string

Manufacturer of the GPU.

name
​string

Name of the GPU.

memory
​integer · uint64

Memory of the GPU. (in bytes)

scaleway.instance.v2alpha1.ServerType.Limits

private_network_count
​integer · uint32

Maximum number of Private Networks.

file_system_count
​integer · uint32

Maximum number of filesystems.

private_network_bandwidth
​integer · uint64

Maximum Private Network bandwidth.

block_bandwidth
​integer · uint64

Maximum block storage bandwidth.

internet_bandwidth
​integer · uint64

Maximum internet bandwidth.

l_ssd_size
​integer · uint64

Maximum size of local SSD. (in bytes)

scratch_size
​integer · uint64

Maximum size of scratch storage. (in bytes)

scratch_volumes_count
​integer · uint32

Maximum number of scratch volumes.

ip_count
​integer · uint32

Maximum number of IPs.

volume_count
​integer · uint32

Maximum number of volumes.

scaleway.instance.v2alpha1.ServerType.SpotInfo

availability
​scaleway.instance.v2alpha1.ServerType.Availability · enum
Enum values:
unknown_availability
available
low_stock
out_of_stock
unavailable
Default: unknown_availability

scaleway.instance.v2alpha1.Template

project_id
​string

Project ID associated with the template.

id
​string

Unique ID of the template.

srn
​string

The SRN of the template.

name
​string

Name of the template.

tags
​string[]

Tags associated with the template.

server_tags
​string[]

Tags associated with servers created from this template.

server_type
​string

Commercial type of the server defined by the template.

security_group_id
​string | null

Security group ID associated with the template.

placement_group_id
​string | null

Placement group ID associated with the template.

public_ip_v4_count
​integer · uint32

Number of IPv4 public IPs to attach to servers created from this template.

public_ip_v6_count
​integer · uint32

Number of IPv6 public IPs to attach to servers created from this template.

List of volume templates used to create volumes for servers.

List of private network associated with the template.

filesystem_ids
​string[]

List of filesystem IDs associated with the template.

created_at
​string | null · date-time

Creation timestamp of the template. (RFC 3339 format)

updated_at
​string | null · date-time

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

windows_rdp_ssh_key_id
​string | null

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

zone
​string

Zone in which the template is located.

scaleway.instance.v2alpha1.TemplateSummary

project_id
​string

Project ID associated with the template.

id
​string

Unique ID of the template.

srn
​string

The SRN of the template.

name
​string

Name of the template.

tags
​string[]

Tags associated with the template.

server_tags
​string[]

Tags associated with servers created from this template.

server_type
​string

Commercial type of the server defined by the template.

security_group_id
​string | null

Security group ID associated with the template.

placement_group_id
​string | null

Placement group ID associated with the template.

public_ip_v4_count
​integer · uint32

Number of IPv4 public IPs to attach to servers created from this template.

public_ip_v6_count
​integer · uint32

Number of IPv6 public IPs to attach to servers created from this template.

filesystem_ids
​string[]

List of Filesystem IDs associated with the template.

created_at
​string | null · date-time

Creation timestamp of the template. (RFC 3339 format)

updated_at
​string | null · date-time

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

zone
​string

Zone in which the template is located.

scaleway.instance.v2alpha1.UpdateServerRequest.PublicNetworkInterface

security_group_id
​string | null

ID of the security group for the interface.

scaleway.instance.v2alpha1.UpdateTemplateRequest.UpdatePrivateNetworks

List of updated private networks.

scaleway.instance.v2alpha1.UpdateTemplateRequest.UpdateVolumes

List of updated volume templates.

scaleway.instance.v2alpha1.UserData

key
​string

The key of the user data.

content
​string

The content of the user data.