Schemas

The zone you want to target

(in bytes)

Instances attached to the placement group.

Map of server types.

(RFC 3339 format)

(RFC 3339 format)

The zone you want to target

(IP address)

(IP network)

(UUID format)

The zone you want to target

List of images.

List of ips.

List of placement groups.

List of security rules.

List of security groups.

List of Instances.

List of Instance types.

List of snapshots.

List of volumes.

Map of volume types.

Placement group unique ID.

Placement group name.

Placement group Organization ID.

Placement group Project ID.

Placement group tags.

Select the failure mode when the placement cannot be respected, either optional or enforced.

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

True if the policy is respected, false otherwise. In the server endpoints the value is always false as it is deprecated. In the placement group endpoints the value is correct.

Zone in which the placement group is located.

Instance UUID.

Instance name.

Defines whether the placement group policy is respected (either 1 or 0).

Private NIC unique ID.

Instance to which the private NIC is attached.

Private Network the private NIC is attached to.

Private NIC MAC address.

Private NIC state.

Private NIC tags.

Private NIC creation date. (RFC 3339 format)

The zone in which the Private NIC is located.

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

Security group unique ID.

Security group name.

Security group description.

True if SMTP is blocked on IPv4 and IPv6. This feature is read only, please open a support ticket if you need to make it configurable.

Default inbound policy.

Default outbound policy.

Security group Organization ID.

Security group Project ID.

Security group tags.

True if it is your default security group for this Project ID.

Security group creation date. (RFC 3339 format)

Security group modification date. (RFC 3339 format)

List of Instances attached to this security group.

Defines whether the security group is stateful.

The state of the security group. Set to syncing (until the changes. Are applied) when the security group is updated (e.g., rules added, modified, or deleted) or when it is attached to or detached from a server's public network interface.

Zone in which the security group is located.

(IP network)

The zone you want to target

Instance unique ID.

Instance name.

Instance Organization ID.

Instance Project ID.

List of allowed actions on the Instance.

Tags associated with the Instance.

Instance commercial type (eg. GP1-M).

Instance creation date. (RFC 3339 format)

True if a dynamic IPv4 is required.

Instance host name.

Information about the Instance image.

Defines whether the Instance protection option is activated.

Private IP address of the Instance (deprecated and always null when routed_ip_enabled is True).

Information about all the public IPs attached to the server.

The server's MAC address.

Instance modification date. (RFC 3339 format)

Instance state.

Instance location.

Instance boot type.

Instance volumes.

Instance security group.

Instance planned maintenance.

Detailed information about the Instance state.

Instance architecture.

Instance placement group.

Instance private NICs.

Zone in which the Instance is located.

UUID of the SSH RSA key that will be used to encrypt the initial admin password for OS requiring it. Mandatory for Windows OS. The public_key value of this key is used to encrypt the admin password. When set to an empty string, reset this value and admin_password_encrypted_value to an empty string so a new password may be generated.

A base64 encoded string containing the admin password encrypted with the public key pointed to by admin_password_encryption_ssh_key_id. This value is reset when admin_password_encryption_ssh_key_id is set to an empty string.

List of attached filesystems.

True if the Instance type has reached end of service.

Public DNS of the server.

(UUID format)

Unique ID of the IP address.

Instance's public IP-Address. (IP address)

Gateway's IP address. (IP address)

CIDR netmask.

IP address family (inet or inet6).

True if the IP address is dynamic.

Information about this address provisioning mode.

Tags associated with the IP.

The ip_id of an IPAM ip if the ip is created from IPAM, null if not. (UUID format)

IP address state.

Instance IPv6 IP-Address. (IPv6 address)

IPv6 IP-addresses gateway. (IPv6 address)

IPv6 IP-addresses CIDR netmask.

(RFC 3339 format)

Snapshot's volume type. Overrides the volume_type of the snapshot for this volume. If omitted, the volume type of the original volume will be used.

Instance compatible types.

Hourly price in Euro.

Alternative Instance name, if any.

Additional volume constraints.

Initial volume constraints.

Number of CPU.

Number of GPU.

Available RAM in bytes.

GPU information.

CPU architecture.

Network available for the Instance.

Capabilities.

Maximum available scratch storage. (in bytes)

Maximum supported number of scratch volumes.

The maximum bandwidth allocated to block storage access (in bytes per second).

True if this Instance type has reached end of service.

Defines whether the Instance supports block storage.

List of supported boot types.

Max number of SFS (Scaleway File Systems) that can be attached to the Instance.

GPU manufacturer.

GPU model name.

RAM of a single GPU, in bytes. (in bytes)

List of available network interfaces.

Total maximum internal bandwidth in bits per seconds.

Total maximum internet bandwidth in bits per seconds.

True if IPv6 is enabled.

Maximum internal bandwidth in bits per seconds.

Maximum internet bandwidth in bits per seconds.

Minimum volume size in bytes. (in bytes)

Maximum volume size in bytes. (in bytes)

Local SSD volumes.

Instances attached to the placement group.

UUID of the security rule to update. If no value is provided, a new rule will be created.

Action to apply when the rule matches a packet.

Protocol family this rule applies to.

Direction the rule applies to.

Range of IP addresses these rules apply to. (IP network)

Beginning of the range of ports this rule applies to (inclusive). This value will be set to null if protocol is ICMP or ANY.

End of the range of ports this rule applies to (inclusive). This value will be set to null if protocol is ICMP or ANY, or if it is equal to dest_port_from.

Position of this rule in the security group rules list. If several rules are passed with the same position, the resulting order is undefined.

Indicates if this rule is editable. Rules with the value false will be ignored.

Zone of the rule. This field is ignored.

Snapshot ID.

Snapshot name.

Snapshot Organization ID.

Snapshot Project ID.

Snapshot tags.

Snapshot volume type.

Snapshot size. (in bytes)

Snapshot state.

Volume on which the snapshot is based on.

Snapshot creation date. (RFC 3339 format)

Snapshot modification date. (RFC 3339 format)

Snapshot zone.

Reason for the failed snapshot import.

Volume ID on which the snapshot is based.

Volume name on which the snapshot is based on.

Location of the resulting resource.

Instances attached to the placement group.

Volume unique ID.

Volume name.

Volume disk size. (in bytes)

Volume type.

Volume creation date. (RFC 3339 format)

Volume modification date. (RFC 3339 format)

Volume Organization ID.

Volume Project ID.

Volume tags.

Instance attached to the volume.

Volume state.

Zone in which the volume is located.

UUID of the snapshot. (UUID format)

(in bytes)

(RFC 3339 format)

(RFC 3339 format)

The zone you want to target

UUID of the volume.

Force the Instance to boot on this volume.

Name of the volume.

Disk size of the volume, must be a multiple of 512. (in bytes)

Type of the volume.

ID of the snapshot on which this volume will be based.

Organization ID of the volume.

Project ID of the volume.

(in bytes)

UUID of the volume.

Name of the volume.

Disk size of the volume, must be a multiple of 512. (in bytes)

Type of the volume.

Project ID of the volume.

(in bytes)

(in bytes)