Offers

Download schema

Offers represent the available Web Hosting plans and their associated options.

List all available hosting offers along with their specific options.

GET

https://api.scaleway.com

/webhosting/v1/regions/{region}/offers

List all available hosting offers along with their specific options. › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

List all available hosting offers along with their specific options. › query Parameters

page

integer · int32

Page number (must be a positive integer).

page_size

integer · uint32

Number of websites to return (must be a positive integer lower or equal to 100).

order_by

string · enum

Sort order for Web Hosting offers in the response.

Enum values:

price_asc

Default: price_asc

hosting_id

string

UUID of the hosting plan.

control_panels

string[]

Name of the control panel(s) to filter for.

List all available hosting offers along with their specific options. › Responses

200

scaleway.webhosting.v1.ListOffersResponse

total_count

integer · uint64

Total number of offers.

scaleway.webhosting.v1.Offer[]

List of offers.

GET/webhosting/v1/regions/{region}/offers

curl -X GET \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/webhosting/v1/regions/{region}/offers"

Example Responses

{
  "total_count": 0,
  "offers": [
    {
      "id": "id",
      "name": "name",
      "billing_operation_path": "billing_operation_path",
      "options": [
        {
          "id": "id",
          "name": "unknown_name",
          "billing_operation_path": "billing_operation_path",
          "min_value": 0,
          "current_value": 0,
          "max_value": 0,
          "quota_warning": "unknown_warning",
          "price": {
            "currency_code": "currency_code",
            "units": 0,
            "nanos": 0
          }
        }
      ],
      "price": {
        "currency_code": "currency_code",
        "units": 0,
        "nanos": 0
      },
      "available": true,
      "control_panel_name": "control_panel_name",
      "end_of_life": true,
      "quota_warning": "unknown_warning",
      "control_panels": [
        {
          "name": "name",
          "available": true,
          "logo_url": "logo_url",
          "available_languages": [
            "unknown_language_code"
          ]
        }
      ],
      "commitments": [
        {
          "id": "id",
          "type": "unknown_commitment_type",
          "billing_mode": "unknown_billing_mode",
          "billing_operation_path": "billing_operation_path",
          "price": {
            "currency_code": "currency_code",
            "units": 0,
            "nanos": 0
          },
          "duration_in_month": 0
        }
      ],
      "region": "region"
    }
  ]
}

json

application/json

List all available hosting offers along with their specific options.

GET

https://api.scaleway.com

/webhosting/v1/regions/{region}/offers

List all available hosting offers along with their specific options. › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

List all available hosting offers along with their specific options. › query Parameters

page

integer · int32

Page number (must be a positive integer).

page_size

integer · uint32

Number of websites to return (must be a positive integer lower or equal to 100).

order_by

string · enum

Sort order for Web Hosting offers in the response.

Enum values:

price_asc

Default: price_asc

hosting_id

string

UUID of the hosting plan.

control_panels

string[]

Name of the control panel(s) to filter for.

List all available hosting offers along with their specific options. › Responses

200

scaleway.webhosting.v1.ListOffersResponse

total_count

integer · uint64

Total number of offers.

scaleway.webhosting.v1.Offer[]

List of offers.