Scaleway logo
Elastic Metal API
Elastic Metal API

Options

Download schema

Lists the optional features available for this Elastic Metal server.

List options

GET
https://api.scaleway.com
/baremetal/v1/zones/{zone}/options

List all options matching with filters.

List options › path Parameters

zone
​string · enum · required

The zone you want to target

Enum values:
fr-par-1
fr-par-2
nl-ams-1
nl-ams-2
pl-waw-2
pl-waw-3

List options › query Parameters

page
​integer · int32

Page number.

page_size
​integer · uint32

Number of options per page.

offer_id
​string

Offer ID to filter options for.

name
​string

Name to filter options for.

List options › Responses

200
scaleway.baremetal.v1.ListOptionsResponse
total_count
​integer · uint32

Total count of matching options.

Options that match filters.

Get option

GET
https://api.scaleway.com
/baremetal/v1/zones/{zone}/options/{option_id}

Return specific option for the ID.

Get option › path Parameters

zone
​string · enum · required

The zone you want to target

Enum values:
fr-par-1
fr-par-2
nl-ams-1
nl-ams-2
pl-waw-2
pl-waw-3
option_id
​string · required

ID of the option.

Get option › Responses

200
scaleway.baremetal.v1.Option
id
​string

ID of the option.

name
​string

Name of the option.

manageable
​boolean

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.

List all settings

GET
https://api.scaleway.com
/baremetal/v1/zones/{zone}/settings

Return all settings for a Project ID.

List all settings › path Parameters

zone
​string · enum · required

The zone you want to target

Enum values:
fr-par-1
fr-par-2
nl-ams-1
nl-ams-2
pl-waw-2
pl-waw-3

List all settings › query Parameters

page
​integer · int32

Page number.

page_size
​integer · uint32

Set the maximum list size.

Sort order for items in the response.

Enum values:
created_at_asc
created_at_desc
Default: created_at_asc
project_id
​string

ID of the Project. (UUID format)

List all settings › Responses

200
scaleway.baremetal.v1.ListSettingsResponse
total_count
​integer · uint32

Total count of matching settings.

Settings that match filters.

Update setting

PATCH
https://api.scaleway.com
/baremetal/v1/zones/{zone}/settings/{setting_id}

Update a setting for a Project ID (enable or disable).

Update setting › path Parameters

zone
​string · enum · required

The zone you want to target

Enum values:
fr-par-1
fr-par-2
nl-ams-1
nl-ams-2
pl-waw-2
pl-waw-3
setting_id
​string · required

ID of the setting.

Update setting › Request Body

enabled
​boolean | null

Defines whether the setting is enabled.

Update setting › Responses

200
scaleway.baremetal.v1.Setting
id
​string

ID of the setting.

Type of the setting.

Enum values:
unknown
smtp
Default: unknown
project_id
​string

ID of the Project ID.

enabled
​boolean

Defines whether the setting is enabled.

OffersOS