Servers

Download schema

Elastic Metal allow you to order dedicated servers on-demand, like cloud Instances. A server refers to physical server used to provide the service.

Create multiple Elastic Metal servers

POST

https://api.scaleway.com

/baremetal/v1/zones/{zone}/batch-create-servers

Create multiple new Elastic Metal servers. Once the servers are created, proceed with the installation of an OS.

Create multiple Elastic Metal servers › 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

Create multiple Elastic Metal servers › Request Body

scaleway.baremetal.v1.CreateServerRequest

Configuration wanted for the servers to create.

scaleway.baremetal.v1.BatchCreateServersRequest.ServerConfig[]

List of servers to create.

Create multiple Elastic Metal servers › Responses

200

scaleway.baremetal.v1.BatchCreateServersResponse

scaleway.baremetal.v1.Server[]

POST/baremetal/v1/zones/{zone}/batch-create-servers

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{}' \
  "https://api.scaleway.com/baremetal/v1/zones/{zone}/batch-create-servers"

Example Request Body

{
  "common_configuration": {
    "zone": "fr-par-1",
    "offer_id": "offer_id",
    "organization_id": "organization_id",
    "project_id": "project_id",
    "name": "name",
    "description": "description",
    "tags": [
      "string"
    ],
    "install": {
      "os_id": "os_id",
      "hostname": "hostname",
      "ssh_key_ids": [
        "string"
      ],
      "user": "user",
      "password": "password",
      "service_user": "service_user",
      "service_password": "service_password",
      "partitioning_schema": {
        "disks": [
          {
            "device": "device",
            "partitions": [
              {
                "label": "unknown_partition_label",
                "number": 0,
                "size": 0,
                "use_all_available_space": true
              }
            ]
          }
        ],
        "raids": [
          {
            "name": "name",
            "level": "unknown_raid_level",
            "devices": [
              "string"
            ]
          }
        ],
        "filesystems": [
          {
            "device": "device",
            "format": "unknown_format",
            "mountpoint": "mountpoint"
          }
        ],
        "zfs": {
          "pools": [
            {
              "name": "name",
              "type": "unknown_type",
              "devices": [
                "string"
              ],
              "options": [
                "string"
              ],
              "filesystem_options": [
                "string"
              ]
            }
          ]
        }
      },
      "network_boot_url": "network_boot_url",
      "network_boot_persistent": true
    },
    "option_ids": [
      "string"
    ],
    "protected": true,
    "user_data": {
      "value": "value"
    }
  },
  "servers": [
    {
      "hostname": "hostname",
      "description": "description",
      "tags": [
        "string"
      ]
    }
  ]
}

json

Example Responses

{
  "servers": [
    {
      "id": "id",
      "organization_id": "organization_id",
      "project_id": "project_id",
      "name": "name",
      "description": "description",
      "updated_at": "2022-03-22T12:34:56.123456Z",
      "created_at": "2022-03-22T12:34:56.123456Z",
      "status": "unknown",
      "offer_id": "offer_id",
      "offer_name": "offer_name",
      "tags": [
        "string"
      ],
      "ips": [
        {
          "id": "id",
          "address": "1.2.3.4",
          "reverse": "reverse",
          "version": "IPv4",
          "reverse_status": "unknown",
          "reverse_status_message": "reverse_status_message"
        }
      ],
      "domain": "domain",
      "boot_type": "unknown_boot_type",
      "zone": "zone",
      "install": {
        "os_id": "os_id",
        "hostname": "hostname",
        "ssh_key_ids": [
          "string"
        ],
        "status": "unknown",
        "user": "user",
        "service_user": "service_user",
        "service_url": "service_url",
        "partitioning_schema": {
          "disks": [
            {
              "device": "device",
              "partitions": [
                {
                  "label": "unknown_partition_label",
                  "number": 0,
                  "size": 0,
                  "use_all_available_space": true
                }
              ]
            }
          ],
          "raids": [
            {
              "name": "name",
              "level": "unknown_raid_level",
              "devices": [
                "string"
              ]
            }
          ],
          "filesystems": [
            {
              "device": "device",
              "format": "unknown_format",
              "mountpoint": "mountpoint"
            }
          ],
          "zfs": {
            "pools": [
              {
                "name": "name",
                "type": "unknown_type",
                "devices": [
                  "string"
                ],
                "options": [
                  "string"
                ],
                "filesystem_options": [
                  "string"
                ]
              }
            ]
          }
        },
        "network_boot_url": "network_boot_url",
        "network_boot_persistent": true
      },
      "ping_status": "ping_status_unknown",
      "options": [
        {
          "id": "id",
          "name": "name",
          "status": "option_status_unknown",
          "manageable": true,
          "expires_at": "2022-03-22T12:34:56.123456Z",
          "license": {
            "os_id": "os_id"
          },
          "public_bandwidth": {
            "bandwidth_in_bps": 0
          },
          "private_network": {
            "bandwidth_in_bps": 0
          },
          "remote_access": {},
          "certification": {}
        }
      ],
      "rescue_server": {
        "user": "user",
        "password": "password"
      },
      "protected": true,
      "user_data": {
        "value": "value"
      }
    }
  ]
}

json

application/json

List Elastic Metal servers for an Organization

GET

https://api.scaleway.com

/baremetal/v1/zones/{zone}/servers

List Elastic Metal servers for a specific Organization.

List Elastic Metal servers for an Organization › 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 Elastic Metal servers for an Organization › query Parameters

page

integer · int32

Page number.

page_size

integer · uint32

Number of servers per page.

order_by

scaleway.baremetal.v1.ListServersRequest.OrderBy · enum

Order of the servers.

Enum values:

created_at_asc

created_at_desc

Default: created_at_asc

tags

string[]

Tags to filter for.

status

string[]

Status to filter for.

name

string

Names to filter for.

organization_id

string

Organization ID to filter for.

project_id

string

Project ID to filter for.

option_id

string

Option ID to filter for.

List Elastic Metal servers for an Organization › Responses

200

scaleway.baremetal.v1.ListServersResponse

total_count

integer · uint32

Total count of matching servers.

scaleway.baremetal.v1.Server[]

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

GET/baremetal/v1/zones/{zone}/servers

curl -X GET \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/baremetal/v1/zones/{zone}/servers"

Example Responses

{
  "total_count": 0,
  "servers": [
    {
      "id": "id",
      "organization_id": "organization_id",
      "project_id": "project_id",
      "name": "name",
      "description": "description",
      "updated_at": "2022-03-22T12:34:56.123456Z",
      "created_at": "2022-03-22T12:34:56.123456Z",
      "status": "unknown",
      "offer_id": "offer_id",
      "offer_name": "offer_name",
      "tags": [
        "string"
      ],
      "ips": [
        {
          "id": "id",
          "address": "1.2.3.4",
          "reverse": "reverse",
          "version": "IPv4",
          "reverse_status": "unknown",
          "reverse_status_message": "reverse_status_message"
        }
      ],
      "domain": "domain",
      "boot_type": "unknown_boot_type",
      "zone": "zone",
      "install": {
        "os_id": "os_id",
        "hostname": "hostname",
        "ssh_key_ids": [
          "string"
        ],
        "status": "unknown",
        "user": "user",
        "service_user": "service_user",
        "service_url": "service_url",
        "partitioning_schema": {
          "disks": [
            {
              "device": "device",
              "partitions": [
                {
                  "label": "unknown_partition_label",
                  "number": 0,
                  "size": 0,
                  "use_all_available_space": true
                }
              ]
            }
          ],
          "raids": [
            {
              "name": "name",
              "level": "unknown_raid_level",
              "devices": [
                "string"
              ]
            }
          ],
          "filesystems": [
            {
              "device": "device",
              "format": "unknown_format",
              "mountpoint": "mountpoint"
            }
          ],
          "zfs": {
            "pools": [
              {
                "name": "name",
                "type": "unknown_type",
                "devices": [
                  "string"
                ],
                "options": [
                  "string"
                ],
                "filesystem_options": [
                  "string"
                ]
              }
            ]
          }
        },
        "network_boot_url": "network_boot_url",
        "network_boot_persistent": true
      },
      "ping_status": "ping_status_unknown",
      "options": [
        {
          "id": "id",
          "name": "name",
          "status": "option_status_unknown",
          "manageable": true,
          "expires_at": "2022-03-22T12:34:56.123456Z",
          "license": {
            "os_id": "os_id"
          },
          "public_bandwidth": {
            "bandwidth_in_bps": 0
          },
          "private_network": {
            "bandwidth_in_bps": 0
          },
          "remote_access": {},
          "certification": {}
        }
      ],
      "rescue_server": {
        "user": "user",
        "password": "password"
      },
      "protected": true,
      "user_data": {
        "value": "value"
      }
    }
  ]
}

json

application/json

Create an Elastic Metal server

POST

https://api.scaleway.com

/baremetal/v1/zones/{zone}/servers

Create a new Elastic Metal server. Once the server is created, proceed with the installation of an OS.

Create an Elastic Metal server › 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

Create an Elastic Metal server › Request Body

offer_id

string · required

Offer ID of the new server.

name

string · required

Name of the server (≠hostname).

description

string · required

Description associated with the server, max 255 characters.

project_id

string | null

Project ID with which the server will be created.

tags

string[]

Tags to associate to the server.

scaleway.baremetal.v1.CreateServerRequest.Install

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

option_ids

string[]

IDs of options to enable on server.

protected

boolean

If enabled, the server can not be deleted.

google.protobuf.BytesValue

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

Create an Elastic Metal server › Responses

200

scaleway.baremetal.v1.Server

id

string

ID of the server.

organization_id

string

Organization ID the server is attached to.

project_id

string

Project ID the server is attached to.

name

string

Name of the server.

description

string

Description of the server.

updated_at

string | null · date-time

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

created_at

string | null · date-time

Creation date of the server. (RFC 3339 format)

status

scaleway.baremetal.v1.Server.Status · enum

Status of the server.

Enum values:

unknown

delivering

ready

stopping

stopped

starting

error

deleting

Default: unknown

offer_id

string

Offer ID of the server.

offer_name

string

Offer name of the server.

tags

string[]

Array of custom tags attached to the server.

scaleway.baremetal.v1.IP[]

Array of IPs attached to the server.

domain

string

Domain of the server.

boot_type

scaleway.baremetal.v1.Server.BootType · enum

Boot type of the server.

Enum values:

unknown_boot_type

normal

rescue

Default: unknown_boot_type

zone

string

Zone in which is the server located.

scaleway.baremetal.v1.Server.Install

Configuration of the installation.

ping_status

scaleway.baremetal.v1.Server.PingStatus · enum

Status of server ping.

Enum values:

ping_status_unknown

ping_status_up

ping_status_down

Default: ping_status_unknown

scaleway.baremetal.v1.Server.Option[]

Options enabled on the server.

scaleway.baremetal.v1.Server.RescueServer

Configuration of rescue boot.

protected

boolean

If enabled, the server can not be deleted.

google.protobuf.BytesValue

Optional configuration data passed to cloud-init.

POST/baremetal/v1/zones/{zone}/servers

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "description": "string",
    "name": "string",
    "offer_id": "string",
    "protected": false
  }' \
  "https://api.scaleway.com/baremetal/v1/zones/{zone}/servers"

Example Request Body

{
  "offer_id": "offer_id",
  "organization_id": "organization_id",
  "project_id": "project_id",
  "name": "name",
  "description": "description",
  "tags": [
    "string"
  ],
  "install": {
    "os_id": "os_id",
    "hostname": "hostname",
    "ssh_key_ids": [
      "string"
    ],
    "user": "user",
    "password": "password",
    "service_user": "service_user",
    "service_password": "service_password",
    "partitioning_schema": {
      "disks": [
        {
          "device": "device",
          "partitions": [
            {
              "label": "unknown_partition_label",
              "number": 0,
              "size": 0,
              "use_all_available_space": true
            }
          ]
        }
      ],
      "raids": [
        {
          "name": "name",
          "level": "unknown_raid_level",
          "devices": [
            "string"
          ]
        }
      ],
      "filesystems": [
        {
          "device": "device",
          "format": "unknown_format",
          "mountpoint": "mountpoint"
        }
      ],
      "zfs": {
        "pools": [
          {
            "name": "name",
            "type": "unknown_type",
            "devices": [
              "string"
            ],
            "options": [
              "string"
            ],
            "filesystem_options": [
              "string"
            ]
          }
        ]
      }
    },
    "network_boot_url": "network_boot_url",
    "network_boot_persistent": true
  },
  "option_ids": [
    "string"
  ],
  "protected": true,
  "user_data": {
    "value": "value"
  }
}

json

Example Responses

{
  "id": "id",
  "organization_id": "organization_id",
  "project_id": "project_id",
  "name": "name",
  "description": "description",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "status": "unknown",
  "offer_id": "offer_id",
  "offer_name": "offer_name",
  "tags": [
    "string"
  ],
  "ips": [
    {
      "id": "id",
      "address": "1.2.3.4",
      "reverse": "reverse",
      "version": "IPv4",
      "reverse_status": "unknown",
      "reverse_status_message": "reverse_status_message"
    }
  ],
  "domain": "domain",
  "boot_type": "unknown_boot_type",
  "zone": "zone",
  "install": {
    "os_id": "os_id",
    "hostname": "hostname",
    "ssh_key_ids": [
      "string"
    ],
    "status": "unknown",
    "user": "user",
    "service_user": "service_user",
    "service_url": "service_url",
    "partitioning_schema": {
      "disks": [
        {
          "device": "device",
          "partitions": [
            {
              "label": "unknown_partition_label",
              "number": 0,
              "size": 0,
              "use_all_available_space": true
            }
          ]
        }
      ],
      "raids": [
        {
          "name": "name",
          "level": "unknown_raid_level",
          "devices": [
            "string"
          ]
        }
      ],
      "filesystems": [
        {
          "device": "device",
          "format": "unknown_format",
          "mountpoint": "mountpoint"
        }
      ],
      "zfs": {
        "pools": [
          {
            "name": "name",
            "type": "unknown_type",
            "devices": [
              "string"
            ],
            "options": [
              "string"
            ],
            "filesystem_options": [
              "string"
            ]
          }
        ]
      }
    },
    "network_boot_url": "network_boot_url",
    "network_boot_persistent": true
  },
  "ping_status": "ping_status_unknown",
  "options": [
    {
      "id": "id",
      "name": "name",
      "status": "option_status_unknown",
      "manageable": true,
      "expires_at": "2022-03-22T12:34:56.123456Z",
      "license": {
        "os_id": "os_id"
      },
      "public_bandwidth": {
        "bandwidth_in_bps": 0
      },
      "private_network": {
        "bandwidth_in_bps": 0
      },
      "remote_access": {},
      "certification": {}
    }
  ],
  "rescue_server": {
    "user": "user",
    "password": "password"
  },
  "protected": true,
  "user_data": {
    "value": "value"
  }
}

json

application/json

Get a specific Elastic Metal server

GET

https://api.scaleway.com

/baremetal/v1/zones/{zone}/servers/{server_id}

Get full details of an existing Elastic Metal server associated with the ID.

Get a specific Elastic Metal server › 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

server_id

string · required

ID of the server.

Get a specific Elastic Metal server › Responses

200

scaleway.baremetal.v1.Server

id

string

ID of the server.

organization_id

string

Organization ID the server is attached to.

project_id

string

Project ID the server is attached to.

name

string

Name of the server.

description

string

Description of the server.

updated_at

string | null · date-time

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

created_at

string | null · date-time

Creation date of the server. (RFC 3339 format)

status

scaleway.baremetal.v1.Server.Status · enum

Status of the server.

Enum values:

unknown

delivering

ready

stopping

stopped

starting

error

deleting

Default: unknown

offer_id

string

Offer ID of the server.

offer_name

string

Offer name of the server.

tags

string[]

Array of custom tags attached to the server.

scaleway.baremetal.v1.IP[]

Array of IPs attached to the server.

domain

string

Domain of the server.

boot_type

scaleway.baremetal.v1.Server.BootType · enum

Boot type of the server.

Enum values:

unknown_boot_type

normal

rescue

Default: unknown_boot_type

zone

string

Zone in which is the server located.

scaleway.baremetal.v1.Server.Install

Configuration of the installation.

ping_status

scaleway.baremetal.v1.Server.PingStatus · enum

Status of server ping.

Enum values:

ping_status_unknown

ping_status_up

ping_status_down

Default: ping_status_unknown

scaleway.baremetal.v1.Server.Option[]

Options enabled on the server.

scaleway.baremetal.v1.Server.RescueServer

Configuration of rescue boot.

protected

boolean

If enabled, the server can not be deleted.

google.protobuf.BytesValue

Optional configuration data passed to cloud-init.

GET/baremetal/v1/zones/{zone}/servers/{server_id}

curl -X GET \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/baremetal/v1/zones/{zone}/servers/{server_id}"

Example Responses

{
  "id": "id",
  "organization_id": "organization_id",
  "project_id": "project_id",
  "name": "name",
  "description": "description",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "status": "unknown",
  "offer_id": "offer_id",
  "offer_name": "offer_name",
  "tags": [
    "string"
  ],
  "ips": [
    {
      "id": "id",
      "address": "1.2.3.4",
      "reverse": "reverse",
      "version": "IPv4",
      "reverse_status": "unknown",
      "reverse_status_message": "reverse_status_message"
    }
  ],
  "domain": "domain",
  "boot_type": "unknown_boot_type",
  "zone": "zone",
  "install": {
    "os_id": "os_id",
    "hostname": "hostname",
    "ssh_key_ids": [
      "string"
    ],
    "status": "unknown",
    "user": "user",
    "service_user": "service_user",
    "service_url": "service_url",
    "partitioning_schema": {
      "disks": [
        {
          "device": "device",
          "partitions": [
            {
              "label": "unknown_partition_label",
              "number": 0,
              "size": 0,
              "use_all_available_space": true
            }
          ]
        }
      ],
      "raids": [
        {
          "name": "name",
          "level": "unknown_raid_level",
          "devices": [
            "string"
          ]
        }
      ],
      "filesystems": [
        {
          "device": "device",
          "format": "unknown_format",
          "mountpoint": "mountpoint"
        }
      ],
      "zfs": {
        "pools": [
          {
            "name": "name",
            "type": "unknown_type",
            "devices": [
              "string"
            ],
            "options": [
              "string"
            ],
            "filesystem_options": [
              "string"
            ]
          }
        ]
      }
    },
    "network_boot_url": "network_boot_url",
    "network_boot_persistent": true
  },
  "ping_status": "ping_status_unknown",
  "options": [
    {
      "id": "id",
      "name": "name",
      "status": "option_status_unknown",
      "manageable": true,
      "expires_at": "2022-03-22T12:34:56.123456Z",
      "license": {
        "os_id": "os_id"
      },
      "public_bandwidth": {
        "bandwidth_in_bps": 0
      },
      "private_network": {
        "bandwidth_in_bps": 0
      },
      "remote_access": {},
      "certification": {}
    }
  ],
  "rescue_server": {
    "user": "user",
    "password": "password"
  },
  "protected": true,
  "user_data": {
    "value": "value"
  }
}

json

application/json

Update an Elastic Metal server

PATCH

https://api.scaleway.com

/baremetal/v1/zones/{zone}/servers/{server_id}

Update the server associated with the ID. You can update parameters such as the server's name, tags, description and protection flag. Any parameters left null in the request body are not updated.

Update an Elastic Metal server › 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

server_id

string · required

ID of the server to update.

Update an Elastic Metal server › Request Body

name

string | null

Name of the server (≠hostname), not updated if null.

description

string | null

Description associated with the server, max 255 characters, not updated if null.

tags

array | null

Tags associated with the server, not updated if null.

protected

boolean | null

If enabled, the server can not be deleted.

google.protobuf.BytesValue

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

Update an Elastic Metal server › Responses

200

scaleway.baremetal.v1.Server

id

string

ID of the server.

organization_id

string

Organization ID the server is attached to.

project_id

string

Project ID the server is attached to.

name

string

Name of the server.

description

string

Description of the server.

updated_at

string | null · date-time

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

created_at

string | null · date-time

Creation date of the server. (RFC 3339 format)

status

scaleway.baremetal.v1.Server.Status · enum

Status of the server.

Enum values:

unknown

delivering

ready

stopping

stopped

starting

error

deleting

Default: unknown

offer_id

string

Offer ID of the server.

offer_name

string

Offer name of the server.

tags

string[]

Array of custom tags attached to the server.

scaleway.baremetal.v1.IP[]

Array of IPs attached to the server.

domain

string

Domain of the server.

boot_type

scaleway.baremetal.v1.Server.BootType · enum

Boot type of the server.

Enum values:

unknown_boot_type

normal

rescue

Default: unknown_boot_type

zone

string

Zone in which is the server located.

scaleway.baremetal.v1.Server.Install

Configuration of the installation.

ping_status

scaleway.baremetal.v1.Server.PingStatus · enum

Status of server ping.

Enum values:

ping_status_unknown

ping_status_up

ping_status_down

Default: ping_status_unknown

scaleway.baremetal.v1.Server.Option[]

Options enabled on the server.

scaleway.baremetal.v1.Server.RescueServer

Configuration of rescue boot.

protected

boolean

If enabled, the server can not be deleted.

google.protobuf.BytesValue

Optional configuration data passed to cloud-init.

PATCH/baremetal/v1/zones/{zone}/servers/{server_id}

curl -X PATCH \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{}' \
  "https://api.scaleway.com/baremetal/v1/zones/{zone}/servers/{server_id}"

Example Request Body

{
  "name": "name",
  "description": "description",
  "tags": [],
  "protected": true,
  "user_data": {
    "value": "value"
  }
}

json

Example Responses

{
  "id": "id",
  "organization_id": "organization_id",
  "project_id": "project_id",
  "name": "name",
  "description": "description",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "status": "unknown",
  "offer_id": "offer_id",
  "offer_name": "offer_name",
  "tags": [
    "string"
  ],
  "ips": [
    {
      "id": "id",
      "address": "1.2.3.4",
      "reverse": "reverse",
      "version": "IPv4",
      "reverse_status": "unknown",
      "reverse_status_message": "reverse_status_message"
    }
  ],
  "domain": "domain",
  "boot_type": "unknown_boot_type",
  "zone": "zone",
  "install": {
    "os_id": "os_id",
    "hostname": "hostname",
    "ssh_key_ids": [
      "string"
    ],
    "status": "unknown",
    "user": "user",
    "service_user": "service_user",
    "service_url": "service_url",
    "partitioning_schema": {
      "disks": [
        {
          "device": "device",
          "partitions": [
            {
              "label": "unknown_partition_label",
              "number": 0,
              "size": 0,
              "use_all_available_space": true
            }
          ]
        }
      ],
      "raids": [
        {
          "name": "name",
          "level": "unknown_raid_level",
          "devices": [
            "string"
          ]
        }
      ],
      "filesystems": [
        {
          "device": "device",
          "format": "unknown_format",
          "mountpoint": "mountpoint"
        }
      ],
      "zfs": {
        "pools": [
          {
            "name": "name",
            "type": "unknown_type",
            "devices": [
              "string"
            ],
            "options": [
              "string"
            ],
            "filesystem_options": [
              "string"
            ]
          }
        ]
      }
    },
    "network_boot_url": "network_boot_url",
    "network_boot_persistent": true
  },
  "ping_status": "ping_status_unknown",
  "options": [
    {
      "id": "id",
      "name": "name",
      "status": "option_status_unknown",
      "manageable": true,
      "expires_at": "2022-03-22T12:34:56.123456Z",
      "license": {
        "os_id": "os_id"
      },
      "public_bandwidth": {
        "bandwidth_in_bps": 0
      },
      "private_network": {
        "bandwidth_in_bps": 0
      },
      "remote_access": {},
      "certification": {}
    }
  ],
  "rescue_server": {
    "user": "user",
    "password": "password"
  },
  "protected": true,
  "user_data": {
    "value": "value"
  }
}

json

application/json

Delete an Elastic Metal server

DELETE

https://api.scaleway.com

/baremetal/v1/zones/{zone}/servers/{server_id}

Delete the server associated with the ID.

Delete an Elastic Metal server › 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

server_id

string · required

ID of the server to delete.

Delete an Elastic Metal server › Responses

200

scaleway.baremetal.v1.Server

id

string

ID of the server.

organization_id

string

Organization ID the server is attached to.

project_id

string

Project ID the server is attached to.

name

string

Name of the server.

description

string

Description of the server.

updated_at

string | null · date-time

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

created_at

string | null · date-time

Creation date of the server. (RFC 3339 format)

status

scaleway.baremetal.v1.Server.Status · enum

Status of the server.

Enum values:

unknown

delivering

ready

stopping

stopped

starting

error

deleting

Default: unknown

offer_id

string

Offer ID of the server.

offer_name

string

Offer name of the server.

tags

string[]

Array of custom tags attached to the server.

scaleway.baremetal.v1.IP[]

Array of IPs attached to the server.

domain

string

Domain of the server.

boot_type

scaleway.baremetal.v1.Server.BootType · enum

Boot type of the server.

Enum values:

unknown_boot_type

normal

rescue

Default: unknown_boot_type

zone

string

Zone in which is the server located.

scaleway.baremetal.v1.Server.Install

Configuration of the installation.

ping_status

scaleway.baremetal.v1.Server.PingStatus · enum

Status of server ping.

Enum values:

ping_status_unknown

ping_status_up

ping_status_down

Default: ping_status_unknown

scaleway.baremetal.v1.Server.Option[]

Options enabled on the server.

scaleway.baremetal.v1.Server.RescueServer

Configuration of rescue boot.

protected

boolean

If enabled, the server can not be deleted.

google.protobuf.BytesValue

Optional configuration data passed to cloud-init.

DELETE/baremetal/v1/zones/{zone}/servers/{server_id}

curl -X DELETE \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/baremetal/v1/zones/{zone}/servers/{server_id}"

Example Responses

{
  "id": "id",
  "organization_id": "organization_id",
  "project_id": "project_id",
  "name": "name",
  "description": "description",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "status": "unknown",
  "offer_id": "offer_id",
  "offer_name": "offer_name",
  "tags": [
    "string"
  ],
  "ips": [
    {
      "id": "id",
      "address": "1.2.3.4",
      "reverse": "reverse",
      "version": "IPv4",
      "reverse_status": "unknown",
      "reverse_status_message": "reverse_status_message"
    }
  ],
  "domain": "domain",
  "boot_type": "unknown_boot_type",
  "zone": "zone",
  "install": {
    "os_id": "os_id",
    "hostname": "hostname",
    "ssh_key_ids": [
      "string"
    ],
    "status": "unknown",
    "user": "user",
    "service_user": "service_user",
    "service_url": "service_url",
    "partitioning_schema": {
      "disks": [
        {
          "device": "device",
          "partitions": [
            {
              "label": "unknown_partition_label",
              "number": 0,
              "size": 0,
              "use_all_available_space": true
            }
          ]
        }
      ],
      "raids": [
        {
          "name": "name",
          "level": "unknown_raid_level",
          "devices": [
            "string"
          ]
        }
      ],
      "filesystems": [
        {
          "device": "device",
          "format": "unknown_format",
          "mountpoint": "mountpoint"
        }
      ],
      "zfs": {
        "pools": [
          {
            "name": "name",
            "type": "unknown_type",
            "devices": [
              "string"
            ],
            "options": [
              "string"
            ],
            "filesystem_options": [
              "string"
            ]
          }
        ]
      }
    },
    "network_boot_url": "network_boot_url",
    "network_boot_persistent": true
  },
  "ping_status": "ping_status_unknown",
  "options": [
    {
      "id": "id",
      "name": "name",
      "status": "option_status_unknown",
      "manageable": true,
      "expires_at": "2022-03-22T12:34:56.123456Z",
      "license": {
        "os_id": "os_id"
      },
      "public_bandwidth": {
        "bandwidth_in_bps": 0
      },
      "private_network": {
        "bandwidth_in_bps": 0
      },
      "remote_access": {},
      "certification": {}
    }
  ],
  "rescue_server": {
    "user": "user",
    "password": "password"
  },
  "protected": true,
  "user_data": {
    "value": "value"
  }
}

json

application/json

List server events

GET

https://api.scaleway.com

/baremetal/v1/zones/{zone}/servers/{server_id}/events

List event (i.e. start/stop/reboot) associated to the server ID.

List server events › 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

server_id

string · required

ID of the server events searched.

List server events › query Parameters

page

integer · int32

Page number.

page_size

integer · uint32

Number of server events per page.

order_by

scaleway.baremetal.v1.ListServerEventsRequest.OrderBy · enum

Order of the server events.

Enum values:

created_at_asc

created_at_desc

Default: created_at_asc

List server events › Responses

200

scaleway.baremetal.v1.ListServerEventsResponse

total_count

integer · uint32

Total count of matching events.

scaleway.baremetal.v1.ServerEvent[]

Server events that match filters.

Install an Elastic Metal server

POST

https://api.scaleway.com

/baremetal/v1/zones/{zone}/servers/{server_id}/install

Install an Operating System (OS) on the Elastic Metal server with a specific ID.

Install an Elastic Metal server › 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

server_id

string · required

Server ID to install.

Install an Elastic Metal server › Request Body

os_id

string · required

ID of the OS to installation on the server.

hostname

string · required

Hostname of the server.

ssh_key_ids

string[] · required

SSH key IDs authorized on the server.

user

string | null

User used for the installation.

password

string | null

Password used for the installation.

service_user

string | null

User used for the service to install.

service_password

string | null

Password used for the service to install.

scaleway.baremetal.v1.Schema

Partitioning schema.

network_boot_url

string | null

URL of the network service to which the server should forward its boot request.

network_boot_persistent

boolean | null

Defines whether the network boot forwarding should be applied at every reboot or only once.

Install an Elastic Metal server › Responses

200

scaleway.baremetal.v1.Server

id

string

ID of the server.

organization_id

string

Organization ID the server is attached to.

project_id

string

Project ID the server is attached to.

name

string

Name of the server.

description

string

Description of the server.

updated_at

string | null · date-time

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

created_at

string | null · date-time

Creation date of the server. (RFC 3339 format)

status

scaleway.baremetal.v1.Server.Status · enum

Status of the server.

Enum values:

unknown

delivering

ready

stopping

stopped

starting

error

deleting

Default: unknown

offer_id

string

Offer ID of the server.

offer_name

string

Offer name of the server.

tags

string[]

Array of custom tags attached to the server.

scaleway.baremetal.v1.IP[]

Array of IPs attached to the server.

domain

string

Domain of the server.

boot_type

scaleway.baremetal.v1.Server.BootType · enum

Boot type of the server.

Enum values:

unknown_boot_type

normal

rescue

Default: unknown_boot_type

zone

string

Zone in which is the server located.

scaleway.baremetal.v1.Server.Install

Configuration of the installation.

ping_status

scaleway.baremetal.v1.Server.PingStatus · enum

Status of server ping.

Enum values:

ping_status_unknown

ping_status_up

ping_status_down

Default: ping_status_unknown

scaleway.baremetal.v1.Server.Option[]

Options enabled on the server.

scaleway.baremetal.v1.Server.RescueServer

Configuration of rescue boot.

protected

boolean

If enabled, the server can not be deleted.

google.protobuf.BytesValue

Optional configuration data passed to cloud-init.

POST/baremetal/v1/zones/{zone}/servers/{server_id}/install

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "hostname": "string",
    "os_id": "string",
    "ssh_key_ids": [
        "string"
    ]
  }' \
  "https://api.scaleway.com/baremetal/v1/zones/{zone}/servers/{server_id}/install"

Example Request Body

{
  "os_id": "os_id",
  "hostname": "hostname",
  "ssh_key_ids": [
    "string"
  ],
  "user": "user",
  "password": "password",
  "service_user": "service_user",
  "service_password": "service_password",
  "partitioning_schema": {
    "disks": [
      {
        "device": "device",
        "partitions": [
          {
            "label": "unknown_partition_label",
            "number": 0,
            "size": 0,
            "use_all_available_space": true
          }
        ]
      }
    ],
    "raids": [
      {
        "name": "name",
        "level": "unknown_raid_level",
        "devices": [
          "string"
        ]
      }
    ],
    "filesystems": [
      {
        "device": "device",
        "format": "unknown_format",
        "mountpoint": "mountpoint"
      }
    ],
    "zfs": {
      "pools": [
        {
          "name": "name",
          "type": "unknown_type",
          "devices": [
            "string"
          ],
          "options": [
            "string"
          ],
          "filesystem_options": [
            "string"
          ]
        }
      ]
    }
  },
  "user_data": {
    "name": "name",
    "content_type": "content_type",
    "content": "content"
  },
  "network_boot_url": "network_boot_url",
  "network_boot_persistent": true
}

json

Example Responses

{
  "id": "id",
  "organization_id": "organization_id",
  "project_id": "project_id",
  "name": "name",
  "description": "description",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "status": "unknown",
  "offer_id": "offer_id",
  "offer_name": "offer_name",
  "tags": [
    "string"
  ],
  "ips": [
    {
      "id": "id",
      "address": "1.2.3.4",
      "reverse": "reverse",
      "version": "IPv4",
      "reverse_status": "unknown",
      "reverse_status_message": "reverse_status_message"
    }
  ],
  "domain": "domain",
  "boot_type": "unknown_boot_type",
  "zone": "zone",
  "install": {
    "os_id": "os_id",
    "hostname": "hostname",
    "ssh_key_ids": [
      "string"
    ],
    "status": "unknown",
    "user": "user",
    "service_user": "service_user",
    "service_url": "service_url",
    "partitioning_schema": {
      "disks": [
        {
          "device": "device",
          "partitions": [
            {
              "label": "unknown_partition_label",
              "number": 0,
              "size": 0,
              "use_all_available_space": true
            }
          ]
        }
      ],
      "raids": [
        {
          "name": "name",
          "level": "unknown_raid_level",
          "devices": [
            "string"
          ]
        }
      ],
      "filesystems": [
        {
          "device": "device",
          "format": "unknown_format",
          "mountpoint": "mountpoint"
        }
      ],
      "zfs": {
        "pools": [
          {
            "name": "name",
            "type": "unknown_type",
            "devices": [
              "string"
            ],
            "options": [
              "string"
            ],
            "filesystem_options": [
              "string"
            ]
          }
        ]
      }
    },
    "network_boot_url": "network_boot_url",
    "network_boot_persistent": true
  },
  "ping_status": "ping_status_unknown",
  "options": [
    {
      "id": "id",
      "name": "name",
      "status": "option_status_unknown",
      "manageable": true,
      "expires_at": "2022-03-22T12:34:56.123456Z",
      "license": {
        "os_id": "os_id"
      },
      "public_bandwidth": {
        "bandwidth_in_bps": 0
      },
      "private_network": {
        "bandwidth_in_bps": 0
      },
      "remote_access": {},
      "certification": {}
    }
  ],
  "rescue_server": {
    "user": "user",
    "password": "password"
  },
  "protected": true,
  "user_data": {
    "value": "value"
  }
}

json

application/json

Update IP

PATCH

https://api.scaleway.com

/baremetal/v1/zones/{zone}/servers/{server_id}/ips/{ip_id}

Configure the IP address associated with the server ID and IP ID. You can use this method to set a reverse DNS for an IP address.

Update IP › 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

server_id

string · required

ID of the server.

ip_id

string · required

ID of the IP to update.

Update IP › Request Body

reverse

string | null

New reverse IP to update, not updated if null.

Update IP › Responses

200

scaleway.baremetal.v1.IP

id

string

ID of the IP.

address

string

Address of the IP. (IP address)

reverse

string

Reverse IP value.

version

scaleway.baremetal.v1.IP.Version · enum

Version of IP (v4 or v6).

Enum values:

IPv4

IPv6

Default: IPv4

reverse_status

scaleway.baremetal.v1.IP.ReverseStatus · enum

Status of the reverse.

Enum values:

unknown

pending

active

error

Default: unknown

reverse_status_message

string

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

Return server metrics

GET

https://api.scaleway.com

/baremetal/v1/zones/{zone}/servers/{server_id}/metrics

Get the ping status of the server associated with the ID.

Return server metrics › 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

server_id

string · required

Server ID to get the metrics.

Return server metrics › Responses

200

scaleway.baremetal.v1.GetServerMetricsResponse

scaleway.std.TimeSeries

Timeseries object representing pings on the server.

Migrate server offer

POST

https://api.scaleway.com

/baremetal/v1/zones/{zone}/servers/{server_id}/migrate-offer-monthly

Migrate server with hourly offer to monthly offer.

Migrate server offer › 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

server_id

string · required

ID of the server.

Migrate server offer › Responses

200

scaleway.baremetal.v1.Server

id

string

ID of the server.

organization_id

string

Organization ID the server is attached to.

project_id

string

Project ID the server is attached to.

name

string

Name of the server.

description

string

Description of the server.

updated_at

string | null · date-time

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

created_at

string | null · date-time

Creation date of the server. (RFC 3339 format)

status

scaleway.baremetal.v1.Server.Status · enum

Status of the server.

Enum values:

unknown

delivering

ready

stopping

stopped

starting

error

deleting

Default: unknown

offer_id

string

Offer ID of the server.

offer_name

string

Offer name of the server.

tags

string[]

Array of custom tags attached to the server.

scaleway.baremetal.v1.IP[]

Array of IPs attached to the server.

domain

string

Domain of the server.

boot_type

scaleway.baremetal.v1.Server.BootType · enum

Boot type of the server.

Enum values:

unknown_boot_type

normal

rescue

Default: unknown_boot_type

zone

string

Zone in which is the server located.

scaleway.baremetal.v1.Server.Install

Configuration of the installation.

ping_status

scaleway.baremetal.v1.Server.PingStatus · enum

Status of server ping.

Enum values:

ping_status_unknown

ping_status_up

ping_status_down

Default: ping_status_unknown

scaleway.baremetal.v1.Server.Option[]

Options enabled on the server.

scaleway.baremetal.v1.Server.RescueServer

Configuration of rescue boot.

protected

boolean

If enabled, the server can not be deleted.

google.protobuf.BytesValue

Optional configuration data passed to cloud-init.

POST/baremetal/v1/zones/{zone}/servers/{server_id}/migrate-offer-monthly

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/baremetal/v1/zones/{zone}/servers/{server_id}/migrate-offer-monthly"

Example Responses

{
  "id": "id",
  "organization_id": "organization_id",
  "project_id": "project_id",
  "name": "name",
  "description": "description",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "status": "unknown",
  "offer_id": "offer_id",
  "offer_name": "offer_name",
  "tags": [
    "string"
  ],
  "ips": [
    {
      "id": "id",
      "address": "1.2.3.4",
      "reverse": "reverse",
      "version": "IPv4",
      "reverse_status": "unknown",
      "reverse_status_message": "reverse_status_message"
    }
  ],
  "domain": "domain",
  "boot_type": "unknown_boot_type",
  "zone": "zone",
  "install": {
    "os_id": "os_id",
    "hostname": "hostname",
    "ssh_key_ids": [
      "string"
    ],
    "status": "unknown",
    "user": "user",
    "service_user": "service_user",
    "service_url": "service_url",
    "partitioning_schema": {
      "disks": [
        {
          "device": "device",
          "partitions": [
            {
              "label": "unknown_partition_label",
              "number": 0,
              "size": 0,
              "use_all_available_space": true
            }
          ]
        }
      ],
      "raids": [
        {
          "name": "name",
          "level": "unknown_raid_level",
          "devices": [
            "string"
          ]
        }
      ],
      "filesystems": [
        {
          "device": "device",
          "format": "unknown_format",
          "mountpoint": "mountpoint"
        }
      ],
      "zfs": {
        "pools": [
          {
            "name": "name",
            "type": "unknown_type",
            "devices": [
              "string"
            ],
            "options": [
              "string"
            ],
            "filesystem_options": [
              "string"
            ]
          }
        ]
      }
    },
    "network_boot_url": "network_boot_url",
    "network_boot_persistent": true
  },
  "ping_status": "ping_status_unknown",
  "options": [
    {
      "id": "id",
      "name": "name",
      "status": "option_status_unknown",
      "manageable": true,
      "expires_at": "2022-03-22T12:34:56.123456Z",
      "license": {
        "os_id": "os_id"
      },
      "public_bandwidth": {
        "bandwidth_in_bps": 0
      },
      "private_network": {
        "bandwidth_in_bps": 0
      },
      "remote_access": {},
      "certification": {}
    }
  ],
  "rescue_server": {
    "user": "user",
    "password": "password"
  },
  "protected": true,
  "user_data": {
    "value": "value"
  }
}

json

application/json

Add server option

POST

https://api.scaleway.com

/baremetal/v1/zones/{zone}/servers/{server_id}/options/{option_id}

Add an option, such as Private Networks, to a specific server.

Add server 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

server_id

string · required

ID of the server.

option_id

string · required

ID of the option to add.

Add server option › Request Body

expires_at

string | null · date-time

Auto expire the option after this date. (RFC 3339 format)

Add server option › Responses

200

scaleway.baremetal.v1.Server

id

string

ID of the server.

organization_id

string

Organization ID the server is attached to.

project_id

string

Project ID the server is attached to.

name

string

Name of the server.

description

string

Description of the server.

updated_at

string | null · date-time

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

created_at

string | null · date-time

Creation date of the server. (RFC 3339 format)

status

scaleway.baremetal.v1.Server.Status · enum

Status of the server.

Enum values:

unknown

delivering

ready

stopping

stopped

starting

error

deleting

Default: unknown

offer_id

string

Offer ID of the server.

offer_name

string

Offer name of the server.

tags

string[]

Array of custom tags attached to the server.

scaleway.baremetal.v1.IP[]

Array of IPs attached to the server.

domain

string

Domain of the server.

boot_type

scaleway.baremetal.v1.Server.BootType · enum

Boot type of the server.

Enum values:

unknown_boot_type

normal

rescue

Default: unknown_boot_type

zone

string

Zone in which is the server located.

scaleway.baremetal.v1.Server.Install

Configuration of the installation.

ping_status

scaleway.baremetal.v1.Server.PingStatus · enum

Status of server ping.

Enum values:

ping_status_unknown

ping_status_up

ping_status_down

Default: ping_status_unknown

scaleway.baremetal.v1.Server.Option[]

Options enabled on the server.

scaleway.baremetal.v1.Server.RescueServer

Configuration of rescue boot.

protected

boolean

If enabled, the server can not be deleted.

google.protobuf.BytesValue

Optional configuration data passed to cloud-init.

POST/baremetal/v1/zones/{zone}/servers/{server_id}/options/{option_id}

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{}' \
  "https://api.scaleway.com/baremetal/v1/zones/{zone}/servers/{server_id}/options/{option_id}"

Example Request Body

{
  "expires_at": "2022-03-22T12:34:56.123456Z"
}

json

Example Responses

{
  "id": "id",
  "organization_id": "organization_id",
  "project_id": "project_id",
  "name": "name",
  "description": "description",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "status": "unknown",
  "offer_id": "offer_id",
  "offer_name": "offer_name",
  "tags": [
    "string"
  ],
  "ips": [
    {
      "id": "id",
      "address": "1.2.3.4",
      "reverse": "reverse",
      "version": "IPv4",
      "reverse_status": "unknown",
      "reverse_status_message": "reverse_status_message"
    }
  ],
  "domain": "domain",
  "boot_type": "unknown_boot_type",
  "zone": "zone",
  "install": {
    "os_id": "os_id",
    "hostname": "hostname",
    "ssh_key_ids": [
      "string"
    ],
    "status": "unknown",
    "user": "user",
    "service_user": "service_user",
    "service_url": "service_url",
    "partitioning_schema": {
      "disks": [
        {
          "device": "device",
          "partitions": [
            {
              "label": "unknown_partition_label",
              "number": 0,
              "size": 0,
              "use_all_available_space": true
            }
          ]
        }
      ],
      "raids": [
        {
          "name": "name",
          "level": "unknown_raid_level",
          "devices": [
            "string"
          ]
        }
      ],
      "filesystems": [
        {
          "device": "device",
          "format": "unknown_format",
          "mountpoint": "mountpoint"
        }
      ],
      "zfs": {
        "pools": [
          {
            "name": "name",
            "type": "unknown_type",
            "devices": [
              "string"
            ],
            "options": [
              "string"
            ],
            "filesystem_options": [
              "string"
            ]
          }
        ]
      }
    },
    "network_boot_url": "network_boot_url",
    "network_boot_persistent": true
  },
  "ping_status": "ping_status_unknown",
  "options": [
    {
      "id": "id",
      "name": "name",
      "status": "option_status_unknown",
      "manageable": true,
      "expires_at": "2022-03-22T12:34:56.123456Z",
      "license": {
        "os_id": "os_id"
      },
      "public_bandwidth": {
        "bandwidth_in_bps": 0
      },
      "private_network": {
        "bandwidth_in_bps": 0
      },
      "remote_access": {},
      "certification": {}
    }
  ],
  "rescue_server": {
    "user": "user",
    "password": "password"
  },
  "protected": true,
  "user_data": {
    "value": "value"
  }
}

json

application/json

Delete server option

DELETE

https://api.scaleway.com

/baremetal/v1/zones/{zone}/servers/{server_id}/options/{option_id}

Delete an option from a specific server.

Delete server 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

server_id

string · required

ID of the server.

option_id

string · required

ID of the option to delete.

Delete server option › Responses

200

scaleway.baremetal.v1.Server

id

string

ID of the server.

organization_id

string

Organization ID the server is attached to.

project_id

string

Project ID the server is attached to.

name

string

Name of the server.

description

string

Description of the server.

updated_at

string | null · date-time

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

created_at

string | null · date-time

Creation date of the server. (RFC 3339 format)

status

scaleway.baremetal.v1.Server.Status · enum

Status of the server.

Enum values:

unknown

delivering

ready

stopping

stopped

starting

error

deleting

Default: unknown

offer_id

string

Offer ID of the server.

offer_name

string

Offer name of the server.

tags

string[]

Array of custom tags attached to the server.

scaleway.baremetal.v1.IP[]

Array of IPs attached to the server.

domain

string

Domain of the server.

boot_type

scaleway.baremetal.v1.Server.BootType · enum

Boot type of the server.

Enum values:

unknown_boot_type

normal

rescue

Default: unknown_boot_type

zone

string

Zone in which is the server located.

scaleway.baremetal.v1.Server.Install

Configuration of the installation.

ping_status

scaleway.baremetal.v1.Server.PingStatus · enum

Status of server ping.

Enum values:

ping_status_unknown

ping_status_up

ping_status_down

Default: ping_status_unknown

scaleway.baremetal.v1.Server.Option[]

Options enabled on the server.

scaleway.baremetal.v1.Server.RescueServer

Configuration of rescue boot.

protected

boolean

If enabled, the server can not be deleted.

google.protobuf.BytesValue

Optional configuration data passed to cloud-init.

DELETE/baremetal/v1/zones/{zone}/servers/{server_id}/options/{option_id}

curl -X DELETE \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/baremetal/v1/zones/{zone}/servers/{server_id}/options/{option_id}"

Example Responses

{
  "id": "id",
  "organization_id": "organization_id",
  "project_id": "project_id",
  "name": "name",
  "description": "description",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "status": "unknown",
  "offer_id": "offer_id",
  "offer_name": "offer_name",
  "tags": [
    "string"
  ],
  "ips": [
    {
      "id": "id",
      "address": "1.2.3.4",
      "reverse": "reverse",
      "version": "IPv4",
      "reverse_status": "unknown",
      "reverse_status_message": "reverse_status_message"
    }
  ],
  "domain": "domain",
  "boot_type": "unknown_boot_type",
  "zone": "zone",
  "install": {
    "os_id": "os_id",
    "hostname": "hostname",
    "ssh_key_ids": [
      "string"
    ],
    "status": "unknown",
    "user": "user",
    "service_user": "service_user",
    "service_url": "service_url",
    "partitioning_schema": {
      "disks": [
        {
          "device": "device",
          "partitions": [
            {
              "label": "unknown_partition_label",
              "number": 0,
              "size": 0,
              "use_all_available_space": true
            }
          ]
        }
      ],
      "raids": [
        {
          "name": "name",
          "level": "unknown_raid_level",
          "devices": [
            "string"
          ]
        }
      ],
      "filesystems": [
        {
          "device": "device",
          "format": "unknown_format",
          "mountpoint": "mountpoint"
        }
      ],
      "zfs": {
        "pools": [
          {
            "name": "name",
            "type": "unknown_type",
            "devices": [
              "string"
            ],
            "options": [
              "string"
            ],
            "filesystem_options": [
              "string"
            ]
          }
        ]
      }
    },
    "network_boot_url": "network_boot_url",
    "network_boot_persistent": true
  },
  "ping_status": "ping_status_unknown",
  "options": [
    {
      "id": "id",
      "name": "name",
      "status": "option_status_unknown",
      "manageable": true,
      "expires_at": "2022-03-22T12:34:56.123456Z",
      "license": {
        "os_id": "os_id"
      },
      "public_bandwidth": {
        "bandwidth_in_bps": 0
      },
      "private_network": {
        "bandwidth_in_bps": 0
      },
      "remote_access": {},
      "certification": {}
    }
  ],
  "rescue_server": {
    "user": "user",
    "password": "password"
  },
  "protected": true,
  "user_data": {
    "value": "value"
  }
}

json

application/json

Server Actions