Services

Download schema

List services

GET

https://api.scaleway.com

/dedibox/v1/zones/{zone}/services

List services › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

nl-ams-1

List services › query Parameters

page

integer · uint32

Page number.

page_size

integer · uint32

Number of service per page.

order_by

string · enum

Order of the services.

Enum values:

created_at_asc

created_at_desc

Default: created_at_asc

project_id

string

Project ID.

List services › Responses

200

scaleway.dedibox.v1.ListServicesResponse

total_count

integer · uint32

Total count of matching services.

scaleway.dedibox.v1.Service[]

Services that match filters.

GET/dedibox/v1/zones/{zone}/services

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

Example Responses

{
  "total_count": 0,
  "services": [
    {
      "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": [
            {
              "id": 0,
              "name": "name",
              "catalog": "all",
              "payment_frequency": "monthly",
              "pricing": {
                "currency_code": "currency_code",
                "units": 0,
                "nanos": 0
              },
              "offer_id": 0,
              "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
              }
            }
          ],
          "rpn_version": 0,
          "connectivity": 0,
          "onetime_fees": {
            "id": 0,
            "name": "name",
            "catalog": "all",
            "payment_frequency": "monthly",
            "pricing": {
              "currency_code": "currency_code",
              "units": 0,
              "nanos": 0
            },
            "offer_id": 0,
            "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
            }
          },
          "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

Delete a specific service

DELETE

https://api.scaleway.com

/dedibox/v1/zones/{zone}/services/{service_id}

Delete the service associated with the given ID.

Delete a specific service › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

nl-ams-1

service_id

integer · uint64 · required

ID of the service.

Delete a specific service › Responses

200

scaleway.dedibox.v1.Service

id

integer · uint64

ID of the service.

resource_id

integer · uint64

Resource ID of the service.

provisioning_status

string · enum

Provisioning status of the service.

Enum values:

unknown

delivering

ready

error

expiring

expired

Default: unknown

object

Offer of the service.

created_at

string · date-time

Creation date of the service. (RFC 3339 format)

delivered_at

string · date-time

Delivery date of the service. (RFC 3339 format)

terminated_at

string · date-time

Terminatation date of the service. (RFC 3339 format)

expires_at

string · date-time

Expiration date of the service. (RFC 3339 format)

type

string · enum

Service type, either order or service.

Enum values:

unknown_type

service

order

Default: unknown_type

DELETE/dedibox/v1/zones/{zone}/services/{service_id}

curl -X DELETE \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/dedibox/v1/zones/{zone}/services/{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": [
        {
          "id": 0,
          "name": "name",
          "catalog": "all",
          "payment_frequency": "monthly",
          "pricing": {
            "currency_code": "currency_code",
            "units": 0,
            "nanos": 0
          },
          "offer_id": 0,
          "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
          }
        }
      ],
      "rpn_version": 0,
      "connectivity": 0,
      "onetime_fees": {
        "id": 0,
        "name": "name",
        "catalog": "all",
        "payment_frequency": "monthly",
        "pricing": {
          "currency_code": "currency_code",
          "units": 0,
          "nanos": 0
        },
        "offer_id": 0,
        "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
        }
      },
      "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 a specific service

PATCH

https://api.scaleway.com

/dedibox/v1/zones/{zone}/services/{service_id}

Get the service associated with the given ID.

Get a specific service › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

nl-ams-1

service_id

integer · uint64 · required

ID of the service.

Get a specific service › Request Body

Get a specific service › Responses

200

scaleway.dedibox.v1.Service

id

integer · uint64

ID of the service.

resource_id

integer · uint64

Resource ID of the service.

provisioning_status

string · enum

Provisioning status of the service.

Enum values:

unknown

delivering

ready

error

expiring

expired

Default: unknown

object

Offer of the service.

created_at

string · date-time

Creation date of the service. (RFC 3339 format)

delivered_at

string · date-time

Delivery date of the service. (RFC 3339 format)

terminated_at

string · date-time

Terminatation date of the service. (RFC 3339 format)

expires_at

string · date-time

Expiration date of the service. (RFC 3339 format)

type

string · enum

Service type, either order or service.

Enum values:

unknown_type

service

order

Default: unknown_type

PATCH/dedibox/v1/zones/{zone}/services/{service_id}

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

Example Request Body

{}

json

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": [
        {
          "id": 0,
          "name": "name",
          "catalog": "all",
          "payment_frequency": "monthly",
          "pricing": {
            "currency_code": "currency_code",
            "units": 0,
            "nanos": 0
          },
          "offer_id": 0,
          "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
          }
        }
      ],
      "rpn_version": 0,
      "connectivity": 0,
      "onetime_fees": {
        "id": 0,
        "name": "name",
        "catalog": "all",
        "payment_frequency": "monthly",
        "pricing": {
          "currency_code": "currency_code",
          "units": 0,
          "nanos": 0
        },
        "offer_id": 0,
        "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
        }
      },
      "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

Servers Install

List services

GET

https://api.scaleway.com

/dedibox/v1/zones/{zone}/services

List services › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

nl-ams-1

List services › query Parameters

page

integer · uint32

Page number.

page_size

integer · uint32

Number of service per page.

order_by

string · enum

Order of the services.

Enum values:

created_at_asc

created_at_desc

Default: created_at_asc

project_id

string

Project ID.

List services › Responses

200

scaleway.dedibox.v1.ListServicesResponse

total_count

integer · uint32

Total count of matching services.

scaleway.dedibox.v1.Service[]

Services that match filters.

Delete a specific service

DELETE

https://api.scaleway.com

/dedibox/v1/zones/{zone}/services/{service_id}

Delete the service associated with the given ID.

Delete a specific service › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

nl-ams-1

service_id

integer · uint64 · required

ID of the service.

Delete a specific service › Responses

200

scaleway.dedibox.v1.Service

id

integer · uint64

ID of the service.

resource_id

integer · uint64

Resource ID of the service.

provisioning_status

string · enum

Provisioning status of the service.

Enum values:

unknown

delivering

ready

error

expiring

expired

Default: unknown

object

Offer of the service.

created_at

string · date-time

Creation date of the service. (RFC 3339 format)

delivered_at

string · date-time

Delivery date of the service. (RFC 3339 format)

terminated_at

string · date-time

Terminatation date of the service. (RFC 3339 format)

expires_at

string · date-time

Expiration date of the service. (RFC 3339 format)

type

string · enum

Service type, either order or service.

Enum values:

unknown_type

service

order

Default: unknown_type

Get a specific service

PATCH

https://api.scaleway.com

/dedibox/v1/zones/{zone}/services/{service_id}

Get the service associated with the given ID.

Get a specific service › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

nl-ams-1

service_id

integer · uint64 · required

ID of the service.

Get a specific service › Request Body

Get a specific service › Responses

200

scaleway.dedibox.v1.Service

id

integer · uint64

ID of the service.

resource_id

integer · uint64

Resource ID of the service.

provisioning_status

string · enum

Provisioning status of the service.

Enum values:

unknown

delivering

ready

error

expiring

expired

Default: unknown

object

Offer of the service.

created_at

string · date-time

Creation date of the service. (RFC 3339 format)

delivered_at

string · date-time

Delivery date of the service. (RFC 3339 format)

terminated_at

string · date-time

Terminatation date of the service. (RFC 3339 format)

expires_at

string · date-time

Expiration date of the service. (RFC 3339 format)

type

string · enum

Service type, either order or service.

Enum values:

unknown_type

service

order

Default: unknown_type