Schemas

URL to access to the server console.

The login to use for the BMC (Baseboard Management Controller) access authentication.

The password to use for the BMC (Baseboard Management Controller) access authentication.

The date after which the BMC (Baseboard Management Controller) access will be closed. (RFC 3339 format)

Name of the CPU.

Number of CPU cores.

Number CPU threads.

Frequency of the CPU in MHz.

Benchmark of the CPU.

The zone you want to target

Offer ID of the new server.

Name of the server (≠hostname).

Description associated with the server, max 255 characters.

Project ID with which the server will be created.

Tags to associate to the server.

Object describing the configuration details of the OS installation on the server.

IDs of options to enable on server.

If enabled, the server can not be deleted.

Configuration data to pass to cloud-init such as a YAML cloud config data or a user-data script.

ID of the OS to installation on the server.

Hostname of the server.

SSH key IDs authorized on the server.

User for the installation.

Password for the installation.

Regular user that runs the service to be installed on the server.

Password used for the service to install.

Partitioning schema.

Capacity of the disk in bytes. (in bytes)

Type of the disk.

Name of the GPU.

Capacity of the vram in bytes.

Timeseries object representing pings on the server.

ID of the IP.

Address of the IP. (IP address)

Reverse IP value.

Version of IP (v4 or v6).

Status of the reverse.

A message related to the reverse status, e.g. in case of an error.

Total count of matching OS.

OS that match filters.

Total count of matching offers.

Offers that match filters.

Total count of matching options.

Options that match filters.

Total count of matching events.

Server events that match filters.

Total count of matching servers.

Array of Elastic Metal server objects matching the filters in the request.

Total count of matching settings.

Settings that match filters.

Capacity of the memory in bytes. (in bytes)

Type of the memory.

Frequency of the memory in MHz.

True if the memory is an error-correcting code memory.

Type of ECC memory.

ID of the OS.

Name of the OS.

Version of the OS.

URL of this OS's logo.

Object defining the SSH requirements to install the OS.

Object defining the username requirements to install the OS.

Object defining the password requirements to install the OS.

Object defining the username requirements to install the service.

Object defining the password requirements to install the service.

Defines if the operating system is enabled or not.

License required (check server options for pricing details).

Defines if a specific Organization is allowed to install this OS type.

Defines if custom partitioning is supported by this OS.

Defines if cloud-init is supported by this OS.

Defines the cloud-init API version used by this OS.

Zone in which is the OS is available.

ID of the offer.

Name of the offer.

Stock level.

Public bandwidth available (in bits/s) with the offer.

Maximum public bandwidth available (in bits/s) depending on available options.

Commercial range of the offer.

Price of the offer for the next 60 minutes (a server order at 11h32 will be paid until 12h32).

Monthly price of the offer, if subscribing on a monthly basis.

Disks specifications of the offer.

Defines whether the offer is currently available.

CPU specifications of the offer.

Memory specifications of the offer.

Name of the quota associated to the offer.

Persistent memory specifications of the offer.

Raid controller specifications of the offer.

Array of OS images IDs incompatible with the server.

Period of subscription for the offer.

Operation path of the service.

One time fee invoiced by Scaleway for the setup and activation of the server.

Available options for customization of the server.

Private bandwidth available in bits/s with the offer.

Defines whether the offer's bandwidth is shared or not.

Array of tags attached to the offer.

GPU specifications of the offer.

Exist only for hourly offers, to migrate to the monthly offer.

Zone in which is the offer is available.

ID of the option.

Name of the option.

If true the option is enabled and included by default in the offer. If true the option is enabled and included by default in the offer If false the option is available for the offer but not included by default.

Period of subscription for the offer.

Price of the option.

Boolean to know if option could be managed.

License option, contains the ID of the OS linked to the option.

Public_bandwidth option, contains the bandwidth_in_bps.

Private_network option, contains the bandwidth_in_bps.

Remote_access option.

Certification option.

ID of the option.

Name of the option.

Defines whether the option is manageable (could be added or removed).

License option, contains the ID of the OS linked to the option.

Public_bandwidth option, contains the bandwidth_in_bps.

Private_network option, contains the bandwidth_in_bps.

Remote_access option.

Certification option.

Capacity of the memory in bytes. (in bytes)

Type of the memory.

Frequency of the memory in MHz.

(in bytes)

ID of the server.

Organization ID the server is attached to.

Project ID the server is attached to.

Name of the server.

Description of the server.

Last modification date of the server. (RFC 3339 format)

Creation date of the server. (RFC 3339 format)

Status of the server.

Offer ID of the server.

Offer name of the server.

Array of custom tags attached to the server.

Array of IPs attached to the server.

Domain of the server.

Boot type of the server.

Zone in which is the server located.

Configuration of the installation.

Status of server ping.

Options enabled on the server.

Configuration of rescue boot.

If enabled, the server can not be deleted.

Optional configuration data passed to cloud-init.

ID of the OS.

Host defined during the server installation.

SSH public key IDs defined during server installation.

Status of the server installation.

User defined in the server installation, or the default user if none were specified.

Service user defined in the server installation, or the default user if none were specified.

Address of the installed service.

Partitioning schema.

ID of the option.

Name of the option.

Status of the option on this server.

Defines whether the option can be managed (added or removed).

Auto expiration date for compatible options. (RFC 3339 format)

License option, contains the ID of the OS linked to the option.

Public_bandwidth option, contains the bandwidth_in_bps.

Private_network option, contains the bandwidth_in_bps.

Remote_access option.

Certification option.

Rescue user name.

Rescue password.

ID of the server to which the action will be applied.

The action that will be applied to the server.

Date of last modification of the action. (RFC 3339 format)

Date of creation of the action. (RFC 3339 format)

ID of the setting.

Type of the setting.

ID of the Project ID.

Defines whether the setting is enabled.