Other endpoints

Download schema

GET

https://api.scaleway.com

/dedibox/v1/zones/{zone}/ordered-services/{ordered_service_id}

path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

nl-ams-1

ordered_service_id

integer · uint64 · required

Responses

200

scaleway.dedibox.v1.Service

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

scaleway.dedibox.v1.Offer

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/dedibox/v1/zones/{zone}/ordered-services/{ordered_service_id}

curl -X GET \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/dedibox/v1/zones/{zone}/ordered-services/{ordered_service_id}"

Example Responses

{
  "id": 0,
  "resource_id": 0,
  "provisioning_status": "unknown",
  "offer": {
    "id": 0,
    "name": "name",
    "catalog": "all",
    "payment_frequency": "monthly",
    "pricing": {
      "currency_code": "currency_code",
      "units": 0,
      "nanos": 0
    },
    "offer_id": 0,
    "server_info": {
      "bandwidth": 0,
      "stock": "empty",
      "commercial_range": "commercial_range",
      "disks": [
        {
          "capacity": 0,
          "type": "sata"
        }
      ],
      "cpus": [
        {
          "name": "name",
          "core_count": 0,
          "thread_count": 0,
          "frequency": 0
        }
      ],
      "memories": [
        {
          "capacity": 0,
          "type": "ddr2",
          "frequency": 0,
          "is_ecc": true
        }
      ],
      "persistent_memories": [
        {
          "capacity": 0,
          "frequency": 0,
          "model": "model"
        }
      ],
      "raid_controllers": [
        {
          "model": "model",
          "raid_level": [
            "string"
          ]
        }
      ],
      "available_options": [
        null
      ],
      "rpn_version": 0,
      "connectivity": 0,
      "stock_by_datacenter": {
        "<stock_by_datacenterKey>": "empty"
      }
    },
    "service_level_info": {
      "support_ticket": true,
      "support_phone": true,
      "sales_support": true,
      "git": "git",
      "sla": 0,
      "priority_support": true,
      "high_rpn_bandwidth": true,
      "customization": true,
      "antidos": true,
      "extra_failover_quota": 0,
      "available_options": [
        null
      ]
    },
    "rpn_info": {
      "speed": 0
    },
    "san_info": {
      "size": 0,
      "ha": true,
      "device_type": "hdd"
    },
    "antidos_info": {
      "type": "minimal"
    },
    "backup_info": {
      "size": 0
    },
    "usb_storage_info": {
      "max_quota": 0,
      "size": 0
    },
    "storage_info": {
      "max_quota": 0,
      "size": 0
    },
    "license_info": {
      "bound_to_ip": true
    },
    "failover_ip_info": {},
    "failover_block_info": {},
    "bandwidth_info": {
      "speed": 0
    }
  },
  "created_at": "2022-03-22T12:34:56.123456Z",
  "delivered_at": "2022-03-22T12:34:56.123456Z",
  "terminated_at": "2022-03-22T12:34:56.123456Z",
  "expires_at": "2022-03-22T12:34:56.123456Z",
  "type": "unknown_type"
}

json

application/json

GET

https://api.scaleway.com

/dedibox/v1/zones/{zone}/servers/{server_id}/backups

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 backup.

Responses

200

scaleway.dedibox.v1.Backup

id

integer · uint64

ID of the backup.

login

string

server

string

Server of the backup.

status

scaleway.dedibox.v1.Backup.Status · enum

Status of the backup.

Enum values:

unknown_backup_status

uninitialized

inactive

ready

Default: unknown_backup_status

acl_enabled

boolean

ACL enable boolean of the backup.

autologin

boolean

Autologin boolean of the backup.

quota_space

integer · uint64

Total quota space of the backup.

quota_space_used

integer · uint64

Quota space used of the backup.

quota_files

integer · uint64

Total quota files of the backup.

quota_files_used

integer · uint64

Quota files used of the backup.

PATCH

https://api.scaleway.com

/dedibox/v1/zones/{zone}/servers/{server_id}/backups

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 backup.

Request Body

password

string | null

Password of the server backup.

autologin

boolean | null

Autologin of the server backup.

acl_enabled

boolean | null

Boolean to enable or disable ACL.

Responses

200

scaleway.dedibox.v1.Backup

id

integer · uint64

ID of the backup.

login

string

server

string

Server of the backup.

status

scaleway.dedibox.v1.Backup.Status · enum

Status of the backup.

Enum values:

unknown_backup_status

uninitialized

inactive

ready

Default: unknown_backup_status

acl_enabled

boolean

ACL enable boolean of the backup.

autologin

boolean

Autologin boolean of the backup.

quota_space

integer · uint64

Total quota space of the backup.

quota_space_used

integer · uint64

Quota space used of the backup.

quota_files

integer · uint64

Total quota files of the backup.

quota_files_used

integer · uint64

Quota files used of the backup.

POST

https://api.scaleway.com

/dedibox/v1/zones/{zone}/servers/{server_id}/tags

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 the tags.

Request Body

tags

string[]

Tags of server to update.

Responses

200

scaleway.dedibox.v1.Server

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)

scaleway.dedibox.v1.Offer

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

scaleway.dedibox.v1.Server.Location

Location of the server.

abuse_contact

string

Abuse contact of the server.

scaleway.dedibox.v1.OS

OS installed on the server.

scaleway.dedibox.v1.NetworkInterface[]

Network interfaces of the server.

zone

string

The zone in which is the server.

scaleway.dedibox.v1.Server.Option[]

Options subscribe on the server.

scaleway.dedibox.v1.ServiceLevel

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.

POST/dedibox/v1/zones/{zone}/servers/{server_id}/tags

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

Example Request Body

{
  "tags": [
    "string"
  ]
}

json

Example Responses

{
  "id": 0,
  "organization_id": "organization_id",
  "project_id": "project_id",
  "hostname": "hostname",
  "rebooted_at": "2022-03-22T12:34:56.123456Z",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "expired_at": "2022-03-22T12:34:56.123456Z",
  "offer": {
    "id": 0,
    "name": "name",
    "catalog": "all",
    "payment_frequency": "monthly",
    "pricing": {
      "currency_code": "currency_code",
      "units": 0,
      "nanos": 0
    },
    "offer_id": 0,
    "server_info": {
      "bandwidth": 0,
      "stock": "empty",
      "commercial_range": "commercial_range",
      "disks": [
        {
          "capacity": 0,
          "type": "sata"
        }
      ],
      "cpus": [
        {
          "name": "name",
          "core_count": 0,
          "thread_count": 0,
          "frequency": 0
        }
      ],
      "memories": [
        {
          "capacity": 0,
          "type": "ddr2",
          "frequency": 0,
          "is_ecc": true
        }
      ],
      "persistent_memories": [
        {
          "capacity": 0,
          "frequency": 0,
          "model": "model"
        }
      ],
      "raid_controllers": [
        {
          "model": "model",
          "raid_level": [
            "string"
          ]
        }
      ],
      "available_options": [
        null
      ],
      "rpn_version": 0,
      "connectivity": 0,
      "stock_by_datacenter": {
        "<stock_by_datacenterKey>": "empty"
      }
    },
    "service_level_info": {
      "support_ticket": true,
      "support_phone": true,
      "sales_support": true,
      "git": "git",
      "sla": 0,
      "priority_support": true,
      "high_rpn_bandwidth": true,
      "customization": true,
      "antidos": true,
      "extra_failover_quota": 0,
      "available_options": [
        null
      ]
    },
    "rpn_info": {
      "speed": 0
    },
    "san_info": {
      "size": 0,
      "ha": true,
      "device_type": "hdd"
    },
    "antidos_info": {
      "type": "minimal"
    },
    "backup_info": {
      "size": 0
    },
    "usb_storage_info": {
      "max_quota": 0,
      "size": 0
    },
    "storage_info": {
      "max_quota": 0,
      "size": 0
    },
    "license_info": {
      "bound_to_ip": true
    },
    "failover_ip_info": {},
    "failover_block_info": {},
    "bandwidth_info": {
      "speed": 0
    }
  },
  "status": "unknown",
  "location": {
    "rack": "rack",
    "room": "room",
    "datacenter_name": "datacenter_name"
  },
  "abuse_contact": "abuse_contact",
  "os": {
    "id": 0,
    "name": "name",
    "type": "unknown_type",
    "version": "version",
    "arch": "unknown_arch",
    "allow_custom_partitioning": true,
    "allow_ssh_keys": true,
    "requires_user": true,
    "requires_admin_password": true,
    "requires_panel_password": true,
    "allowed_filesystems": [
      "unknown"
    ],
    "requires_license": true,
    "license_offers": [
      {
        "id": 0,
        "name": "name",
        "catalog": "all",
        "payment_frequency": "monthly",
        "pricing": {
          "currency_code": "currency_code",
          "units": 0,
          "nanos": 0
        },
        "offer_id": 0,
        "server_info": {
          "bandwidth": 0,
          "stock": "empty",
          "commercial_range": "commercial_range",
          "disks": [
            {
              "capacity": 0,
              "type": "sata"
            }
          ],
          "cpus": [
            {
              "name": "name",
              "core_count": 0,
              "thread_count": 0,
              "frequency": 0
            }
          ],
          "memories": [
            {
              "capacity": 0,
              "type": "ddr2",
              "frequency": 0,
              "is_ecc": true
            }
          ],
          "persistent_memories": [
            {
              "capacity": 0,
              "frequency": 0,
              "model": "model"
            }
          ],
          "raid_controllers": [
            {
              "model": "model",
              "raid_level": [
                "string"
              ]
            }
          ],
          "available_options": [
            null
          ],
          "rpn_version": 0,
          "connectivity": 0,
          "stock_by_datacenter": {
            "<stock_by_datacenterKey>": "empty"
          }
        },
        "service_level_info": {
          "support_ticket": true,
          "support_phone": true,
          "sales_support": true,
          "git": "git",
          "sla": 0,
          "priority_support": true,
          "high_rpn_bandwidth": true,
          "customization": true,
          "antidos": true,
          "extra_failover_quota": 0,
          "available_options": [
            null
          ]
        },
        "rpn_info": {
          "speed": 0
        },
        "san_info": {
          "size": 0,
          "ha": true,
          "device_type": "hdd"
        },
        "antidos_info": {
          "type": "minimal"
        },
        "backup_info": {
          "size": 0
        },
        "usb_storage_info": {
          "max_quota": 0,
          "size": 0
        },
        "storage_info": {
          "max_quota": 0,
          "size": 0
        },
        "license_info": {
          "bound_to_ip": true
        },
        "failover_ip_info": {},
        "failover_block_info": {},
        "bandwidth_info": {
          "speed": 0
        }
      }
    ],
    "max_partitions": 0,
    "display_name": "display_name",
    "password_regex": "password_regex",
    "panel_password_regex": "panel_password_regex",
    "requires_valid_hostname": true,
    "hostname_regex": "hostname_regex",
    "hostname_max_length": 0,
    "released_at": "2022-03-22T12:34:56.123456Z"
  },
  "interfaces": [
    {
      "card_id": 0,
      "device_id": 0,
      "mac": "mac",
      "type": "unknown",
      "ips": [
        {
          "ip_id": 0,
          "address": "1.2.3.4",
          "reverse": "reverse",
          "version": "ipv4",
          "cidr": 0,
          "netmask": "1.2.3.4",
          "semantic": "unknown",
          "gateway": "1.2.3.4",
          "status": "unknown_status"
        }
      ]
    }
  ],
  "zone": "zone",
  "options": [
    {
      "offer": {
        "id": 0,
        "name": "name",
        "catalog": "all",
        "payment_frequency": "monthly",
        "pricing": {
          "currency_code": "currency_code",
          "units": 0,
          "nanos": 0
        },
        "offer_id": 0,
        "server_info": {
          "bandwidth": 0,
          "stock": "empty",
          "commercial_range": "commercial_range",
          "disks": [
            {
              "capacity": 0,
              "type": "sata"
            }
          ],
          "cpus": [
            {
              "name": "name",
              "core_count": 0,
              "thread_count": 0,
              "frequency": 0
            }
          ],
          "memories": [
            {
              "capacity": 0,
              "type": "ddr2",
              "frequency": 0,
              "is_ecc": true
            }
          ],
          "persistent_memories": [
            {
              "capacity": 0,
              "frequency": 0,
              "model": "model"
            }
          ],
          "raid_controllers": [
            {
              "model": "model",
              "raid_level": [
                "string"
              ]
            }
          ],
          "available_options": [
            null
          ],
          "rpn_version": 0,
          "connectivity": 0,
          "stock_by_datacenter": {
            "<stock_by_datacenterKey>": "empty"
          }
        },
        "service_level_info": {
          "support_ticket": true,
          "support_phone": true,
          "sales_support": true,
          "git": "git",
          "sla": 0,
          "priority_support": true,
          "high_rpn_bandwidth": true,
          "customization": true,
          "antidos": true,
          "extra_failover_quota": 0,
          "available_options": [
            null
          ]
        },
        "rpn_info": {
          "speed": 0
        },
        "san_info": {
          "size": 0,
          "ha": true,
          "device_type": "hdd"
        },
        "antidos_info": {
          "type": "minimal"
        },
        "backup_info": {
          "size": 0
        },
        "usb_storage_info": {
          "max_quota": 0,
          "size": 0
        },
        "storage_info": {
          "max_quota": 0,
          "size": 0
        },
        "license_info": {
          "bound_to_ip": true
        },
        "failover_ip_info": {},
        "failover_block_info": {},
        "bandwidth_info": {
          "speed": 0
        }
      },
      "created_at": "2022-03-22T12:34:56.123456Z",
      "updated_at": "2022-03-22T12:34:56.123456Z",
      "expired_at": "2022-03-22T12:34:56.123456Z",
      "options": [
        null
      ]
    }
  ],
  "level": {
    "offer_id": 0,
    "level": "unknown"
  },
  "has_bmc": true,
  "rescue_os": {
    "id": 0,
    "name": "name",
    "type": "unknown_type",
    "version": "version",
    "arch": "unknown_arch",
    "allow_custom_partitioning": true,
    "allow_ssh_keys": true,
    "requires_user": true,
    "requires_admin_password": true,
    "requires_panel_password": true,
    "allowed_filesystems": [
      "unknown"
    ],
    "requires_license": true,
    "license_offers": [
      {
        "id": 0,
        "name": "name",
        "catalog": "all",
        "payment_frequency": "monthly",
        "pricing": {
          "currency_code": "currency_code",
          "units": 0,
          "nanos": 0
        },
        "offer_id": 0,
        "server_info": {
          "bandwidth": 0,
          "stock": "empty",
          "commercial_range": "commercial_range",
          "disks": [
            {
              "capacity": 0,
              "type": "sata"
            }
          ],
          "cpus": [
            {
              "name": "name",
              "core_count": 0,
              "thread_count": 0,
              "frequency": 0
            }
          ],
          "memories": [
            {
              "capacity": 0,
              "type": "ddr2",
              "frequency": 0,
              "is_ecc": true
            }
          ],
          "persistent_memories": [
            {
              "capacity": 0,
              "frequency": 0,
              "model": "model"
            }
          ],
          "raid_controllers": [
            {
              "model": "model",
              "raid_level": [
                "string"
              ]
            }
          ],
          "available_options": [
            null
          ],
          "rpn_version": 0,
          "connectivity": 0,
          "stock_by_datacenter": {
            "<stock_by_datacenterKey>": "empty"
          }
        },
        "service_level_info": {
          "support_ticket": true,
          "support_phone": true,
          "sales_support": true,
          "git": "git",
          "sla": 0,
          "priority_support": true,
          "high_rpn_bandwidth": true,
          "customization": true,
          "antidos": true,
          "extra_failover_quota": 0,
          "available_options": [
            null
          ]
        },
        "rpn_info": {
          "speed": 0
        },
        "san_info": {
          "size": 0,
          "ha": true,
          "device_type": "hdd"
        },
        "antidos_info": {
          "type": "minimal"
        },
        "backup_info": {
          "size": 0
        },
        "usb_storage_info": {
          "max_quota": 0,
          "size": 0
        },
        "storage_info": {
          "max_quota": 0,
          "size": 0
        },
        "license_info": {
          "bound_to_ip": true
        },
        "failover_ip_info": {},
        "failover_block_info": {},
        "bandwidth_info": {
          "speed": 0
        }
      }
    ],
    "max_partitions": 0,
    "display_name": "display_name",
    "password_regex": "password_regex",
    "panel_password_regex": "panel_password_regex",
    "requires_valid_hostname": true,
    "hostname_regex": "hostname_regex",
    "hostname_max_length": 0,
    "released_at": "2022-03-22T12:34:56.123456Z"
  },
  "tags": [
    "string"
  ],
  "is_outsourced": true,
  "ipv6_slaac": true,
  "qinq": true,
  "is_rpnv2_member": true,
  "is_hds": true
}

json

application/json

Quotas