Scaleway logo
Dedibox Phoenix API

List baremetal servers for project

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

List baremetal servers for project › path Parameters

zone
​string · enum · required

The zone you want to target

Enum values:
fr-par-1
fr-par-2
nl-ams-1

List baremetal servers for project › query Parameters

page
​integer · uint32

Page number.

page_size
​integer · uint32

Number of server per page.

order_by
​scaleway.dedibox.v1.ListServersRequest.OrderBy · enum

Order of the servers.

Enum values:
created_at_asc
created_at_desc
Default: created_at_asc
project_id
​string

Filter servers by project ID.

search
​string

Filter servers by hostname.

List baremetal servers for project › Responses

200
total_count
​integer · uint32

Total count of matching servers.

Servers that match filters.


Create a baremetal server

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

Create a new baremetal server. The order return you a service ID to follow the provisioning status you could call GetService.

Create 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

Create a baremetal server › Request Body

server_option_ids
​integer[] · required

Server option IDs of the new server.

offer_id
​integer · uint64

Offer ID of the new server.

project_id
​string

Project ID of the new server.

datacenter_name
​string | null

Datacenter name of the new server.

Create a baremetal server › Responses

200
id
​integer · uint64

ID of the service.

resource_id
​integer | null · uint64

Resource ID of the service.

provisioning_status
​scaleway.dedibox.v1.Service.ProvisioningStatus · enum

Provisioning status of the service.

Enum values:
unknown
delivering
ready
error
expiring
expired
Default: unknown

Offer of the service.

created_at
​string | null · date-time

Creation date of the service. (RFC 3339 format)

delivered_at
​string | null · date-time

Delivery date of the service. (RFC 3339 format)

terminated_at
​string | null · date-time

Terminatation date of the service. (RFC 3339 format)

expires_at
​string | null · date-time

Expiration date of the service. (RFC 3339 format)

type
​scaleway.dedibox.v1.Service.Type · enum

Service type, either order or service.

Enum values:
unknown_type
service
order
Default: unknown_type

Get a specific baremetal server

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

Get the server associated with the given ID.

Get a specific 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

ID of the server.

Get a specific baremetal server › Responses

200
id
​integer · uint64

ID of the server.

organization_id
​string

Organization ID the server is attached to.

project_id
​string

Project ID the server is attached to.

hostname
​string

Hostname of the server.

rebooted_at
​string | null · date-time

Date of last reboot of the server. (RFC 3339 format)

created_at
​string | null · date-time

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

updated_at
​string | null · date-time

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

expired_at
​string | null · date-time

Date of release of the server. (RFC 3339 format)

Offer of the server.

status
​scaleway.dedibox.v1.Server.Status · enum

Status of the server.

Enum values:
unknown
delivering
installing
ready
stopped
error
locked
rescue
Default: unknown

Location of the server.

abuse_contact
​string

Abuse contact of the server.

OS installed on the server.

Network interfaces of the server.

zone
​string

The zone in which is the server.

Options subscribe on the server.

Service level of the server.

has_bmc
​boolean

Boolean if the server has a BMC.

​scaleway.dedibox.v1.OS

Rescue OS of the server.

tags
​string[]

Array of customs tags attached to the server.

is_outsourced
​boolean

Whether the server is outsourced or not.

ipv6_slaac
​boolean

Whether or not you can enable/disable the IPv6.

qinq
​boolean

Whether the server is compatible with QinQ.

is_rpnv2_member
​boolean

Whether or not the server is already part of an rpnv2 group.

is_hds
​boolean

Whether or not the server is HDS.


Delete a baremetal server

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

Delete the server associated with the given ID.

Delete 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 delete.

Delete a baremetal server › Responses

No data returned

Update a baremetal server

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

Update the server associated with the given ID.

Update 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 update.

Update a baremetal server › Request Body

hostname
​string | null

Hostname of the server to update.

enable_ipv6
​boolean | null

Flag to enable or not the IPv6 of server.

Update a baremetal server › Responses

200
id
​integer · uint64

ID of the server.

organization_id
​string

Organization ID the server is attached to.

project_id
​string

Project ID the server is attached to.

hostname
​string

Hostname of the server.

rebooted_at
​string | null · date-time

Date of last reboot of the server. (RFC 3339 format)

created_at
​string | null · date-time

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

updated_at
​string | null · date-time

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

expired_at
​string | null · date-time

Date of release of the server. (RFC 3339 format)

Offer of the server.

status
​scaleway.dedibox.v1.Server.Status · enum

Status of the server.

Enum values:
unknown
delivering
installing
ready
stopped
error
locked
rescue
Default: unknown

Location of the server.

abuse_contact
​string

Abuse contact of the server.

OS installed on the server.

Network interfaces of the server.

zone
​string

The zone in which is the server.

Options subscribe on the server.

Service level of the server.

has_bmc
​boolean

Boolean if the server has a BMC.

​scaleway.dedibox.v1.OS

Rescue OS of the server.

tags
​string[]

Array of customs tags attached to the server.

is_outsourced
​boolean

Whether the server is outsourced or not.

ipv6_slaac
​boolean

Whether or not you can enable/disable the IPv6.

qinq
​boolean

Whether the server is compatible with QinQ.

is_rpnv2_member
​boolean

Whether or not the server is already part of an rpnv2 group.

is_hds
​boolean

Whether or not the server is HDS.


List server disks

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

List disks associated to the given server ID.

List server disks › 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 disks.

List server disks › query Parameters

page
​integer · uint32

Page number.

page_size
​integer · uint32

Number of server disk per page.

Order of the server disks.

Enum values:
created_at_asc
created_at_desc
Default: created_at_asc

List server disks › Responses

200
total_count
​integer · uint32

Total count of matching server disks.

Server disks that match filters.


List server events

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

List events associated to the given 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
server_id
​integer · uint64 · required

Server ID of the server events.

List server events › query Parameters

page
​integer · uint32

Page number.

page_size
​integer · uint32

Number of server event per page.

Order of the server events.

Enum values:
created_at_asc
created_at_desc
Default: created_at_asc

List server events › Responses

200
total_count
​integer · uint32

Total count of matching server events.

Server events that match filters.


Reboot a baremetal server

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

Reboot the server associated with the given ID, use boot param to reboot in rescue.

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

Reboot a baremetal server › Request Body

Reboot a baremetal server › Responses

No data returned

Start a baremetal server

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

Start the server associated with the given ID.

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

Start a baremetal server › Request Body

Start a baremetal server › Responses

No data returned

Stop a baremetal server

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

Stop the server associated with the given ID.

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

Stop a baremetal server › Request Body

Stop a baremetal server › Responses

No data returned

List subscribable server options

GET
https://api.scaleway.com
/dedibox/v1/zones/{zone}/servers/{server_id}/subscribable-server-options

List subscribable options associated to the given server ID.

List subscribable server options › 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 subscribable server options.

List subscribable server options › query Parameters

page
​integer · uint32

Page number.

page_size
​integer · uint32

Number of subscribable server option per page.

List subscribable server options › Responses

200
total_count
​integer · uint32

Total count of matching subscribable server options.

​scaleway.dedibox.v1.Offer[]

Server options that match filters.


Subscribe server option

PATCH
https://api.scaleway.com
/dedibox/v1/zones/{zone}/servers/{server_id}/subscribe-server-option

Subscribe option for the given server ID.

Subscribe 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
server_id
​integer · uint64 · required

Server ID to subscribe server option.

Subscribe server option › Request Body

option_id
​integer · uint64

Option ID to subscribe.

Subscribe server option › Responses

200
id
​integer · uint64

ID of the service.

resource_id
​integer | null · uint64

Resource ID of the service.

provisioning_status
​scaleway.dedibox.v1.Service.ProvisioningStatus · enum

Provisioning status of the service.

Enum values:
unknown
delivering
ready
error
expiring
expired
Default: unknown

Offer of the service.

created_at
​string | null · date-time

Creation date of the service. (RFC 3339 format)

delivered_at
​string | null · date-time

Delivery date of the service. (RFC 3339 format)

terminated_at
​string | null · date-time

Terminatation date of the service. (RFC 3339 format)

expires_at
​string | null · date-time

Expiration date of the service. (RFC 3339 format)

type
​scaleway.dedibox.v1.Service.Type · enum

Service type, either order or service.

Enum values:
unknown_type
service
order
Default: unknown_type

Subscribe storage server option

POST
https://api.scaleway.com
/dedibox/v1/zones/{zone}/servers/{server_id}/subscribe-storage-options

Subscribe storage option for the given server ID.

Subscribe storage 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
server_id
​integer · uint64 · required

Server ID of the storage options to subscribe.

Subscribe storage server option › Request Body

options_ids
​integer[] · required

Option IDs of the storage options to subscribe.

Subscribe storage server option › Responses

200