Scaleway logo
Dedibox Phoenix API
Dedibox Phoenix API

Install

Download schema

Cancels the current (running) server installation

POST
https://api.scaleway.com
/dedibox/v1/zones/{zone}/servers/{server_id}/cancel-install

Cancels the current server installation associated with the given server ID.

Cancels the current (running) server installation › path Parameters

zone
​string · enum · required

The zone you want to target

Enum values:
fr-par-1
fr-par-2
nl-ams-1
server_id
​integer · uint64 · required

Server ID of the server to cancel install.

Cancels the current (running) server installation › Responses

No data returned

Get a specific server installation status

GET
https://api.scaleway.com
/dedibox/v1/zones/{zone}/servers/{server_id}/install

Get the server installation status associated with the given server ID.

Get a specific server installation status › path Parameters

zone
​string · enum · required

The zone you want to target

Enum values:
fr-par-1
fr-par-2
nl-ams-1
server_id
​integer · uint64 · required

Server ID of the server to install.

Get a specific server installation status › Responses

200
scaleway.dedibox.v1.Server.Install
os_id
​integer · uint64
hostname
​string
ssh_key_ids
​string[]
Enum values:
unknown
booting
setting_up_raid
partitioning
formatting
installing
configuring
configuring_bootloader
Default: unknown

Install a baremetal server

POST
https://api.scaleway.com
/dedibox/v1/zones/{zone}/servers/{server_id}/install

Install an OS on the server associated with the given ID.

Install a baremetal server › path Parameters

zone
​string · enum · required

The zone you want to target

Enum values:
fr-par-1
fr-par-2
nl-ams-1
server_id
​integer · uint64 · required

Server ID to install.

Install a baremetal server › Request Body

os_id
​integer · uint64

OS ID to install on the server.

hostname
​string

Hostname of the server.

user_login
​string | null

User to install on the server.

user_password
​string | null

User password to install on the server.

panel_password
​string | null

Panel password to install on the server.

root_password
​string | null

Root password to install on the server.

Partitions to install on the server.

ssh_key_ids
​string[]

SSH key IDs authorized on the server.

license_offer_id
​integer | null · uint64

Offer ID of license to install on server.

ip_id
​integer | null · uint64

IP to link at the license to install on server.

Install a baremetal server › Responses

200
scaleway.dedibox.v1.Server.Install
os_id
​integer · uint64
hostname
​string
ssh_key_ids
​string[]
Enum values:
unknown
booting
setting_up_raid
partitioning
formatting
installing
configuring
configuring_bootloader
Default: unknown

Get server default partitioning

GET
https://api.scaleway.com
/dedibox/v1/zones/{zone}/servers/{server_id}/partitioning/{os_id}

Get the server default partitioning schema associated with the given server ID and OS ID.

Get server default partitioning › path Parameters

zone
​string · enum · required

The zone you want to target

Enum values:
fr-par-1
fr-par-2
nl-ams-1
server_id
​integer · uint64 · required

ID of the server.

os_id
​integer · uint64 · required

OS ID of the default partitioning.

Get server default partitioning › Responses

ServicesBMC Management