Server Actions

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 · date-time

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

created_at

string · date-time

Creation date of the server. (RFC 3339 format)

status

string · 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.

Array of IPs attached to the server.

domain

string

Domain of the server.

boot_type

string · 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.

object

Configuration of the installation.

ping_status

string · enum

Status of server ping.

Enum values:

ping_status_unknown

ping_status_up

ping_status_down

Default: ping_status_unknown

Options enabled on the server.

object

Configuration of rescue boot.

protected

boolean

If enabled, the server can not be deleted.

object

Optional configuration data passed to cloud-init.

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

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}/reboot"

Example Request Body

{
  "boot_type": "unknown_boot_type",
  "ssh_key_ids": [
    "string"
  ]
}

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"
            ]
          }
        ]
      }
    }
  },
  "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

Start an Elastic Metal server

POST

https://api.scaleway.com

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

Start the server associated with the ID.

Start 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 start.

Start an Elastic Metal server › Request Body

boot_type

string · enum

The type of boot.

Enum values:

unknown_boot_type

normal

rescue

Default: unknown_boot_type

ssh_key_ids

string[]

Additional SSH public key IDs to configure on rescue image.

Start an Elastic Metal server › Responses

200

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 · date-time

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

created_at

string · date-time

Creation date of the server. (RFC 3339 format)

status

string · 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.

Array of IPs attached to the server.

domain

string

Domain of the server.

boot_type

string · 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.

object

Configuration of the installation.

ping_status

string · enum

Status of server ping.

Enum values:

ping_status_unknown

ping_status_up

ping_status_down

Default: ping_status_unknown

Options enabled on the server.

object

Configuration of rescue boot.

protected

boolean

If enabled, the server can not be deleted.

object

Optional configuration data passed to cloud-init.

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

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}/start"

Example Request Body

{
  "boot_type": "unknown_boot_type",
  "ssh_key_ids": [
    "string"
  ]
}

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"
            ]
          }
        ]
      }
    }
  },
  "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

Stop an Elastic Metal server

POST

https://api.scaleway.com

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

Stop the server associated with the ID. The server remains allocated to your account and all data remains on the local storage of the server.

Stop 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 stop.

Stop an Elastic Metal server › Request Body

Stop an Elastic Metal server › Responses

200

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 · date-time

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

created_at

string · date-time

Creation date of the server. (RFC 3339 format)

status

string · 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.

Array of IPs attached to the server.

domain

string

Domain of the server.

boot_type

string · 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.

object

Configuration of the installation.

ping_status

string · enum

Status of server ping.

Enum values:

ping_status_unknown

ping_status_up

ping_status_down

Default: ping_status_unknown

Options enabled on the server.

object

Configuration of rescue boot.

protected

boolean

If enabled, the server can not be deleted.

object

Optional configuration data passed to cloud-init.

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

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}/stop"

Example Request Body

{}

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"
            ]
          }
        ]
      }
    }
  },
  "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

Servers BMC Access

Reboot an Elastic Metal server

POST

https://api.scaleway.com

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

Reboot the Elastic Metal server associated with the ID, use the boot_type rescue to reboot the server in rescue mode.

Reboot 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 reboot.

Reboot an Elastic Metal server › Request Body

boot_type

string · enum

The type of boot.

Enum values:

unknown_boot_type

normal

rescue

Default: unknown_boot_type

ssh_key_ids

string[]

Additional SSH public key IDs to configure on rescue image.

Reboot an Elastic Metal server › Responses

200

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 · date-time

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

created_at

string · date-time

Creation date of the server. (RFC 3339 format)

status

string · 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.

Array of IPs attached to the server.

domain

string

Domain of the server.

boot_type

string · 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.

object

Configuration of the installation.

ping_status

string · enum

Status of server ping.

Enum values:

ping_status_unknown

ping_status_up

ping_status_down

Default: ping_status_unknown

Options enabled on the server.

object

Configuration of rescue boot.

protected

boolean

If enabled, the server can not be deleted.

object

Optional configuration data passed to cloud-init.

Start an Elastic Metal server

POST

https://api.scaleway.com

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

Start the server associated with the ID.

Start 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 start.

Start an Elastic Metal server › Request Body

boot_type

string · enum

The type of boot.

Enum values:

unknown_boot_type

normal

rescue

Default: unknown_boot_type

ssh_key_ids

string[]

Additional SSH public key IDs to configure on rescue image.

Start an Elastic Metal server › Responses

200

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 · date-time

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

created_at

string · date-time

Creation date of the server. (RFC 3339 format)

status

string · 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.

Array of IPs attached to the server.

domain

string

Domain of the server.

boot_type

string · 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.

object

Configuration of the installation.

ping_status

string · enum

Status of server ping.

Enum values:

ping_status_unknown

ping_status_up

ping_status_down

Default: ping_status_unknown

Options enabled on the server.

object

Configuration of rescue boot.

protected

boolean

If enabled, the server can not be deleted.

object

Optional configuration data passed to cloud-init.

Stop an Elastic Metal server

POST

https://api.scaleway.com

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

Stop the server associated with the ID. The server remains allocated to your account and all data remains on the local storage of the server.

Stop 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 stop.

Stop an Elastic Metal server › Request Body

Stop an Elastic Metal server › Responses

200

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 · date-time

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

created_at

string · date-time

Creation date of the server. (RFC 3339 format)

status

string · 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.

Array of IPs attached to the server.

domain

string

Domain of the server.

boot_type

string · 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.

object

Configuration of the installation.

ping_status

string · enum

Status of server ping.

Enum values:

ping_status_unknown

ping_status_up

ping_status_down

Default: ping_status_unknown