Web Hosting

Download schema

With a Scaleway Web Hosting plan, you can manage your domain, configure your web hosting services, manage your emails and more. Create, list, update and delete your Web Hosting plans with these calls

List all Web Hosting plans

GET

https://api.scaleway.com

/webhosting/v1/regions/{region}/hostings

List all of your existing Web Hosting plans. Various filters are available to limit the results, including filtering by domain, status, tag and Project ID.

List all Web Hosting plans › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

List all Web Hosting plans › query Parameters

page

integer · int32

Page number to return, from the paginated results (must be a positive integer).

page_size

integer · uint32

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

order_by

string · enum

Sort order for Web Hosting plans in the response.

Enum values:

created_at_asc

created_at_desc

Default: created_at_asc

tags

string[]

Tags to filter for, only Web Hosting plans with matching tags will be returned.

statuses

scaleway.webhosting.v1.Hosting.Status[]

Statuses to filter for, only Web Hosting plans with matching statuses will be returned.

Enum values:

unknown_status

delivering

ready

deleting

error

locked

migrating

updating

domain

string

Domain to filter for, only Web Hosting plans associated with this domain will be returned.

project_id

string

Project ID to filter for, only Web Hosting plans from this Project will be returned.

organization_id

string

Organization ID to filter for, only Web Hosting plans from this Organization will be returned.

control_panels

string[]

Name of the control panel to filter for, only Web Hosting plans from this control panel will be returned.

subdomain

string

Optional free subdomain linked to the Web Hosting plan.

List all Web Hosting plans › Responses

200

scaleway.webhosting.v1.ListHostingsResponse

total_count

integer · uint64

Number of Web Hosting plans returned.

scaleway.webhosting.v1.HostingSummary[]

List of Web Hosting plans.

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

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

Example Responses

{
  "total_count": 0,
  "hostings": [
    {
      "id": "id",
      "project_id": "project_id",
      "created_at": "2022-03-22T12:34:56.123456Z",
      "updated_at": "2022-03-22T12:34:56.123456Z",
      "status": "unknown_status",
      "domain": "domain",
      "protected": true,
      "dns_status": "unknown_status",
      "offer_name": "offer_name",
      "domain_status": "unknown_status",
      "region": "region",
      "domain_info": {
        "subdomain": "subdomain",
        "custom_domain": {
          "domain": "domain",
          "domain_status": "unknown_status",
          "dns_status": "unknown_status",
          "auto_config_domain_dns": {
            "nameservers": true,
            "web_records": true,
            "mail_records": true,
            "all_records": true,
            "none": true
          }
        }
      }
    }
  ]
}

json

application/json

Order a Web Hosting plan

POST

https://api.scaleway.com

/webhosting/v1/regions/{region}/hostings

Order a Web Hosting plan, specifying the offer type required via the offer_id parameter.

Order a Web Hosting plan › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

Order a Web Hosting plan › Request Body

offer_id

string

ID of the selected offer for the Web Hosting plan.

project_id

string

ID of the Scaleway Project in which to create the Web Hosting plan.

email

string

Contact email for the Web Hosting client.

tags

string[]

List of tags for the Web Hosting plan.

domain

string

Domain name to link to the Web Hosting plan. You must already own this domain name, and have completed the DNS validation process beforehand.

subdomain

string

The name prefix to use as a free subdomain (for example, mysite) assigned to the Web Hosting plan. The full domain will be automatically created by adding it to the fixed base domain (e.g. mysite.scw.site). You do not need to include the base domain yourself.

scaleway.webhosting.v1.OfferOptionRequest[]

List of the Web Hosting plan options IDs with their quantities.

language

string · enum

Default language for the control panel interface.

Enum values:

unknown_language_code

en_US

fr_FR

de_DE

Default: unknown_language_code

skip_welcome_email

boolean

Indicates whether to skip a welcome email to the contact email containing hosting info.

object

Indicates whether to update hosting domain name servers and DNS records for domains managed by Scaleway Elements (deprecated, use auto_update_* fields instead).

offer_commitment_id

string

Offer commitment ID to which the hosting will be engaged.

Order a Web Hosting plan › Responses

200

scaleway.webhosting.v1.Hosting

id

string

ID of the Web Hosting plan.

project_id

string

ID of the Scaleway Project the Web Hosting plan belongs to.

updated_at

string · date-time

Date on which the Web Hosting plan was last updated. (RFC 3339 format)

created_at

string · date-time

Date on which the Web Hosting plan was created. (RFC 3339 format)

status

string · enum

Status of the Web Hosting plan.

Enum values:

unknown_status

delivering

ready

deleting

error

locked

migrating

updating

Default: unknown_status

object

Details of the Web Hosting plan offer and options.

object

Details of the hosting platform.

tags

string[]

List of tags associated with the Web Hosting plan.

ipv4

string

Current IPv4 address of the hosting. (IPv4 address)

protected

boolean

Whether the hosting is protected or not.

object

Details of the hosting user.

region

string

Region where the Web Hosting plan is hosted.

object

Domain configuration block (subdomain, optional custom domain, and DNS settings).

object

Commitment details to which the hosting is engaged.

POST/webhosting/v1/regions/{region}/hostings

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "domain": "string",
    "email": "string",
    "offer_id": "string",
    "project_id": "string"
  }' \
  "https://api.scaleway.com/webhosting/v1/regions/{region}/hostings"

Example Request Body

{
  "offer_id": "offer_id",
  "project_id": "project_id",
  "email": "email",
  "tags": [
    "string"
  ],
  "domain": "domain",
  "subdomain": "subdomain",
  "offer_options": [
    {
      "id": "id",
      "quantity": 0
    }
  ],
  "language": "unknown_language_code",
  "domain_configuration": {
    "update_nameservers": true,
    "update_web_record": true,
    "update_mail_record": true,
    "update_all_records": true
  },
  "skip_welcome_email": true,
  "auto_config_domain_dns": {
    "nameservers": true,
    "web_records": true,
    "mail_records": true,
    "all_records": true,
    "none": true
  },
  "offer_commitment_id": "offer_commitment_id"
}

json

Example Responses

{
  "id": "id",
  "project_id": "project_id",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "status": "unknown_status",
  "domain": "domain",
  "offer": {
    "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"
  },
  "platform": {
    "hostname": "hostname",
    "number": 0,
    "group_name": "unknown_group",
    "ipv4": "1.2.3.4",
    "ipv6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334",
    "control_panel": {
      "name": "name",
      "urls": {
        "dashboard": "dashboard",
        "webmail": "webmail"
      }
    }
  },
  "tags": [
    "string"
  ],
  "dns_status": "unknown_status",
  "ipv4": "1.2.3.4",
  "protected": true,
  "user": {
    "username": "username",
    "one_time_password": "one_time_password",
    "contact_email": "contact_email",
    "one_time_password_b64": "one_time_password_b64"
  },
  "domain_status": "unknown_status",
  "region": "region",
  "domain_info": {
    "subdomain": "subdomain",
    "custom_domain": {
      "domain": "domain",
      "domain_status": "unknown_status",
      "dns_status": "unknown_status",
      "auto_config_domain_dns": {
        "nameservers": true,
        "web_records": true,
        "mail_records": true,
        "all_records": true,
        "none": true
      }
    }
  },
  "commitment": {
    "offer_commitment": {
      "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,
      "next": {
        "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
      }
    },
    "start_at": "2022-03-22T12:34:56.123456Z",
    "end_at": "2022-03-22T12:34:56.123456Z",
    "delete_hosting_at_end": true
  }
}

json

application/json

Get a Web Hosting plan

GET

https://api.scaleway.com

/webhosting/v1/regions/{region}/hostings/{hosting_id}

Get the details of one of your existing Web Hosting plans, specified by its hosting_id.

Get a Web Hosting plan › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

hosting_id

string · required

Hosting ID.

Get a Web Hosting plan › Responses

200

scaleway.webhosting.v1.Hosting

id

string

ID of the Web Hosting plan.

project_id

string

ID of the Scaleway Project the Web Hosting plan belongs to.

updated_at

string · date-time

Date on which the Web Hosting plan was last updated. (RFC 3339 format)

created_at

string · date-time

Date on which the Web Hosting plan was created. (RFC 3339 format)

status

string · enum

Status of the Web Hosting plan.

Enum values:

unknown_status

delivering

ready

deleting

error

locked

migrating

updating

Default: unknown_status

object

Details of the Web Hosting plan offer and options.

object

Details of the hosting platform.

tags

string[]

List of tags associated with the Web Hosting plan.

ipv4

string

Current IPv4 address of the hosting. (IPv4 address)

protected

boolean

Whether the hosting is protected or not.

object

Details of the hosting user.

region

string

Region where the Web Hosting plan is hosted.

object

Domain configuration block (subdomain, optional custom domain, and DNS settings).

object

Commitment details to which the hosting is engaged.

GET/webhosting/v1/regions/{region}/hostings/{hosting_id}

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

Example Responses

{
  "id": "id",
  "project_id": "project_id",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "status": "unknown_status",
  "domain": "domain",
  "offer": {
    "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"
  },
  "platform": {
    "hostname": "hostname",
    "number": 0,
    "group_name": "unknown_group",
    "ipv4": "1.2.3.4",
    "ipv6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334",
    "control_panel": {
      "name": "name",
      "urls": {
        "dashboard": "dashboard",
        "webmail": "webmail"
      }
    }
  },
  "tags": [
    "string"
  ],
  "dns_status": "unknown_status",
  "ipv4": "1.2.3.4",
  "protected": true,
  "user": {
    "username": "username",
    "one_time_password": "one_time_password",
    "contact_email": "contact_email",
    "one_time_password_b64": "one_time_password_b64"
  },
  "domain_status": "unknown_status",
  "region": "region",
  "domain_info": {
    "subdomain": "subdomain",
    "custom_domain": {
      "domain": "domain",
      "domain_status": "unknown_status",
      "dns_status": "unknown_status",
      "auto_config_domain_dns": {
        "nameservers": true,
        "web_records": true,
        "mail_records": true,
        "all_records": true,
        "none": true
      }
    }
  },
  "commitment": {
    "offer_commitment": {
      "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,
      "next": {
        "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
      }
    },
    "start_at": "2022-03-22T12:34:56.123456Z",
    "end_at": "2022-03-22T12:34:56.123456Z",
    "delete_hosting_at_end": true
  }
}

json

application/json

Delete a Web Hosting plan

DELETE

https://api.scaleway.com

/webhosting/v1/regions/{region}/hostings/{hosting_id}

Delete a Web Hosting plan, specified by its hosting_id. Note that deletion is not immediate: it will take place at the end of the calendar month, after which time your Web Hosting plan and all its data (files and emails) will be irreversibly lost.

Delete a Web Hosting plan › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

hosting_id

string · required

Hosting ID.

Delete a Web Hosting plan › Responses

200

scaleway.webhosting.v1.Hosting

id

string

ID of the Web Hosting plan.

project_id

string

ID of the Scaleway Project the Web Hosting plan belongs to.

updated_at

string · date-time

Date on which the Web Hosting plan was last updated. (RFC 3339 format)

created_at

string · date-time

Date on which the Web Hosting plan was created. (RFC 3339 format)

status

string · enum

Status of the Web Hosting plan.

Enum values:

unknown_status

delivering

ready

deleting

error

locked

migrating

updating

Default: unknown_status

object

Details of the Web Hosting plan offer and options.

object

Details of the hosting platform.

tags

string[]

List of tags associated with the Web Hosting plan.

ipv4

string

Current IPv4 address of the hosting. (IPv4 address)

protected

boolean

Whether the hosting is protected or not.

object

Details of the hosting user.

region

string

Region where the Web Hosting plan is hosted.

object

Domain configuration block (subdomain, optional custom domain, and DNS settings).

object

Commitment details to which the hosting is engaged.

DELETE/webhosting/v1/regions/{region}/hostings/{hosting_id}

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

Example Responses

{
  "id": "id",
  "project_id": "project_id",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "status": "unknown_status",
  "domain": "domain",
  "offer": {
    "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"
  },
  "platform": {
    "hostname": "hostname",
    "number": 0,
    "group_name": "unknown_group",
    "ipv4": "1.2.3.4",
    "ipv6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334",
    "control_panel": {
      "name": "name",
      "urls": {
        "dashboard": "dashboard",
        "webmail": "webmail"
      }
    }
  },
  "tags": [
    "string"
  ],
  "dns_status": "unknown_status",
  "ipv4": "1.2.3.4",
  "protected": true,
  "user": {
    "username": "username",
    "one_time_password": "one_time_password",
    "contact_email": "contact_email",
    "one_time_password_b64": "one_time_password_b64"
  },
  "domain_status": "unknown_status",
  "region": "region",
  "domain_info": {
    "subdomain": "subdomain",
    "custom_domain": {
      "domain": "domain",
      "domain_status": "unknown_status",
      "dns_status": "unknown_status",
      "auto_config_domain_dns": {
        "nameservers": true,
        "web_records": true,
        "mail_records": true,
        "all_records": true,
        "none": true
      }
    }
  },
  "commitment": {
    "offer_commitment": {
      "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,
      "next": {
        "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
      }
    },
    "start_at": "2022-03-22T12:34:56.123456Z",
    "end_at": "2022-03-22T12:34:56.123456Z",
    "delete_hosting_at_end": true
  }
}

json

application/json

Update a Web Hosting plan

PATCH

https://api.scaleway.com

/webhosting/v1/regions/{region}/hostings/{hosting_id}

Update the details of one of your existing Web Hosting plans, specified by its hosting_id. You can update parameters including the contact email address, tags, options and offer.

Update a Web Hosting plan › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

hosting_id

string · required

Hosting ID.

Update a Web Hosting plan › Request Body

email

string

New contact email for the Web Hosting plan.

tags

string[]

New tags for the Web Hosting plan.

scaleway.webhosting.v1.OfferOptionRequest[]

List of the Web Hosting plan options IDs with their quantities.

offer_id

string

ID of the new offer for the Web Hosting plan.

protected

boolean

Whether the hosting is protected or not.

Update a Web Hosting plan › Responses

200

scaleway.webhosting.v1.Hosting

id

string

ID of the Web Hosting plan.

project_id

string

ID of the Scaleway Project the Web Hosting plan belongs to.

updated_at

string · date-time

Date on which the Web Hosting plan was last updated. (RFC 3339 format)

created_at

string · date-time

Date on which the Web Hosting plan was created. (RFC 3339 format)

status

string · enum

Status of the Web Hosting plan.

Enum values:

unknown_status

delivering

ready

deleting

error

locked

migrating

updating

Default: unknown_status

object

Details of the Web Hosting plan offer and options.

object

Details of the hosting platform.

tags

string[]

List of tags associated with the Web Hosting plan.

ipv4

string

Current IPv4 address of the hosting. (IPv4 address)

protected

boolean

Whether the hosting is protected or not.

object

Details of the hosting user.

region

string

Region where the Web Hosting plan is hosted.

object

Domain configuration block (subdomain, optional custom domain, and DNS settings).

object

Commitment details to which the hosting is engaged.

PATCH/webhosting/v1/regions/{region}/hostings/{hosting_id}

curl -X PATCH \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{}' \
  "https://api.scaleway.com/webhosting/v1/regions/{region}/hostings/{hosting_id}"

Example Request Body

{
  "email": "email",
  "tags": [
    "string"
  ],
  "offer_options": [
    {
      "id": "id",
      "quantity": 0
    }
  ],
  "offer_id": "offer_id",
  "protected": true
}

json

Example Responses

{
  "id": "id",
  "project_id": "project_id",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "status": "unknown_status",
  "domain": "domain",
  "offer": {
    "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"
  },
  "platform": {
    "hostname": "hostname",
    "number": 0,
    "group_name": "unknown_group",
    "ipv4": "1.2.3.4",
    "ipv6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334",
    "control_panel": {
      "name": "name",
      "urls": {
        "dashboard": "dashboard",
        "webmail": "webmail"
      }
    }
  },
  "tags": [
    "string"
  ],
  "dns_status": "unknown_status",
  "ipv4": "1.2.3.4",
  "protected": true,
  "user": {
    "username": "username",
    "one_time_password": "one_time_password",
    "contact_email": "contact_email",
    "one_time_password_b64": "one_time_password_b64"
  },
  "domain_status": "unknown_status",
  "region": "region",
  "domain_info": {
    "subdomain": "subdomain",
    "custom_domain": {
      "domain": "domain",
      "domain_status": "unknown_status",
      "dns_status": "unknown_status",
      "auto_config_domain_dns": {
        "nameservers": true,
        "web_records": true,
        "mail_records": true,
        "all_records": true,
        "none": true
      }
    }
  },
  "commitment": {
    "offer_commitment": {
      "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,
      "next": {
        "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
      }
    },
    "start_at": "2022-03-22T12:34:56.123456Z",
    "end_at": "2022-03-22T12:34:56.123456Z",
    "delete_hosting_at_end": true
  }
}

json

application/json

Attach a custom domain to a webhosting as an alias to the main domain

POST

https://api.scaleway.com

/webhosting/v1/regions/{region}/hostings/{hosting_id}/add-custom-domain

Attach a custom domain to a webhosting as an alias to the main domain › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

hosting_id

string · required

Hosting ID to which the custom domain is attached to.

Attach a custom domain to a webhosting as an alias to the main domain › Request Body

domain_name

string

The custom domain name to attach to the hosting.

Attach a custom domain to a webhosting as an alias to the main domain › Responses

200

scaleway.webhosting.v1.HostingSummary

id

string

ID of the Web Hosting plan.

project_id

string

ID of the Scaleway Project the Web Hosting plan belongs to.

created_at

string · date-time

Date on which the Web Hosting plan was created. (RFC 3339 format)

updated_at

string · date-time

Date on which the Web Hosting plan was last updated. (RFC 3339 format)

status

string · enum

Status of the Web Hosting plan.

Enum values:

unknown_status

delivering

ready

deleting

error

locked

migrating

updating

Default: unknown_status

protected

boolean

Whether the hosting is protected or not.

offer_name

string

Name of the active offer for the Web Hosting plan.

region

string

Region where the Web Hosting plan is hosted.

object

Domain configuration block (subdomain, optional custom domain, and DNS settings).

POST/webhosting/v1/regions/{region}/hostings/{hosting_id}/add-custom-domain

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{"domain_name":"string"}' \
  "https://api.scaleway.com/webhosting/v1/regions/{region}/hostings/{hosting_id}/add-custom-domain"

Example Request Body

{
  "domain_name": "domain_name"
}

json

Example Responses

{
  "id": "id",
  "project_id": "project_id",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "status": "unknown_status",
  "domain": "domain",
  "protected": true,
  "dns_status": "unknown_status",
  "offer_name": "offer_name",
  "domain_status": "unknown_status",
  "region": "region",
  "domain_info": {
    "subdomain": "subdomain",
    "custom_domain": {
      "domain": "domain",
      "domain_status": "unknown_status",
      "dns_status": "unknown_status",
      "auto_config_domain_dns": {
        "nameservers": true,
        "web_records": true,
        "mail_records": true,
        "all_records": true,
        "none": true
      }
    }
  }
}

json

application/json

Delete domains from a Web Hosting plan

POST

https://api.scaleway.com

/webhosting/v1/regions/{region}/hostings/{hosting_id}/delete-domains

Remove one or more domains from a Web Hosting plan, specified by its hosting_id. This permanently deletes the domains and all services tied to them, including mailboxes, FTP accounts and DNS zones.

Delete domains from a Web Hosting plan › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

hosting_id

string · required

Hosting ID of the Web Hosting plan from which to delete domains.

Delete domains from a Web Hosting plan › Request Body

domains

string[]

List of domains to delete from the Web Hosting plan.

Delete domains from a Web Hosting plan › Responses

200

scaleway.webhosting.v1.Hosting

id

string

ID of the Web Hosting plan.

project_id

string

ID of the Scaleway Project the Web Hosting plan belongs to.

updated_at

string · date-time

Date on which the Web Hosting plan was last updated. (RFC 3339 format)

created_at

string · date-time

Date on which the Web Hosting plan was created. (RFC 3339 format)

status

string · enum

Status of the Web Hosting plan.

Enum values:

unknown_status

delivering

ready

deleting

error

locked

migrating

updating

Default: unknown_status

object

Details of the Web Hosting plan offer and options.

object

Details of the hosting platform.

tags

string[]

List of tags associated with the Web Hosting plan.

ipv4

string

Current IPv4 address of the hosting. (IPv4 address)

protected

boolean

Whether the hosting is protected or not.

object

Details of the hosting user.

region

string

Region where the Web Hosting plan is hosted.

object

Domain configuration block (subdomain, optional custom domain, and DNS settings).

object

Commitment details to which the hosting is engaged.

POST/webhosting/v1/regions/{region}/hostings/{hosting_id}/delete-domains

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{}' \
  "https://api.scaleway.com/webhosting/v1/regions/{region}/hostings/{hosting_id}/delete-domains"

Example Request Body

{
  "domains": [
    "string"
  ]
}

json

Example Responses

{
  "id": "id",
  "project_id": "project_id",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "status": "unknown_status",
  "domain": "domain",
  "offer": {
    "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"
  },
  "platform": {
    "hostname": "hostname",
    "number": 0,
    "group_name": "unknown_group",
    "ipv4": "1.2.3.4",
    "ipv6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334",
    "control_panel": {
      "name": "name",
      "urls": {
        "dashboard": "dashboard",
        "webmail": "webmail"
      }
    }
  },
  "tags": [
    "string"
  ],
  "dns_status": "unknown_status",
  "ipv4": "1.2.3.4",
  "protected": true,
  "user": {
    "username": "username",
    "one_time_password": "one_time_password",
    "contact_email": "contact_email",
    "one_time_password_b64": "one_time_password_b64"
  },
  "domain_status": "unknown_status",
  "region": "region",
  "domain_info": {
    "subdomain": "subdomain",
    "custom_domain": {
      "domain": "domain",
      "domain_status": "unknown_status",
      "dns_status": "unknown_status",
      "auto_config_domain_dns": {
        "nameservers": true,
        "web_records": true,
        "mail_records": true,
        "all_records": true,
        "none": true
      }
    }
  },
  "commitment": {
    "offer_commitment": {
      "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,
      "next": {
        "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
      }
    },
    "start_at": "2022-03-22T12:34:56.123456Z",
    "end_at": "2022-03-22T12:34:56.123456Z",
    "delete_hosting_at_end": true
  }
}

json

application/json

Migrate a hosting to a new control panel.

POST

https://api.scaleway.com

/webhosting/v1/regions/{region}/hostings/{hosting_id}/migrate-control-panel

Migrate a hosting to a new control panel. › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

hosting_id

string · required

Hosting ID to migrate to a new control panel.

Migrate a hosting to a new control panel. › Request Body

control_panel_name

string

The name of the new control panel. Using the same name as the current. Control panel will migrate the hosting to a new server.

offer_id

string

ID of the new offer for the Web Hosting plan after control panel. Migration.

Migrate a hosting to a new control panel. › Responses

200

scaleway.webhosting.v1.HostingSummary

id

string

ID of the Web Hosting plan.

project_id

string

ID of the Scaleway Project the Web Hosting plan belongs to.

created_at

string · date-time

Date on which the Web Hosting plan was created. (RFC 3339 format)

updated_at

string · date-time

Date on which the Web Hosting plan was last updated. (RFC 3339 format)

status

string · enum

Status of the Web Hosting plan.

Enum values:

unknown_status

delivering

ready

deleting

error

locked

migrating

updating

Default: unknown_status

protected

boolean

Whether the hosting is protected or not.

offer_name

string

Name of the active offer for the Web Hosting plan.

region

string

Region where the Web Hosting plan is hosted.

object

Domain configuration block (subdomain, optional custom domain, and DNS settings).

POST/webhosting/v1/regions/{region}/hostings/{hosting_id}/migrate-control-panel

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{"control_panel_name":"string","offer_id":"string"}' \
  "https://api.scaleway.com/webhosting/v1/regions/{region}/hostings/{hosting_id}/migrate-control-panel"

Example Request Body

{
  "control_panel_name": "control_panel_name",
  "offer_id": "offer_id"
}

json

Example Responses

{
  "id": "id",
  "project_id": "project_id",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "status": "unknown_status",
  "domain": "domain",
  "protected": true,
  "dns_status": "unknown_status",
  "offer_name": "offer_name",
  "domain_status": "unknown_status",
  "region": "region",
  "domain_info": {
    "subdomain": "subdomain",
    "custom_domain": {
      "domain": "domain",
      "domain_status": "unknown_status",
      "dns_status": "unknown_status",
      "auto_config_domain_dns": {
        "nameservers": true,
        "web_records": true,
        "mail_records": true,
        "all_records": true,
        "none": true
      }
    }
  }
}

json

application/json

Detach a custom domain from a webhosting

POST

https://api.scaleway.com

/webhosting/v1/regions/{region}/hostings/{hosting_id}/remove-custom-domain

Detach a custom domain from a webhosting › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

hosting_id

string · required

Hosting ID to which the custom domain is detached from.

Detach a custom domain from a webhosting › Request Body

domain_name

string

The custom domain name to detach from the hosting.

Detach a custom domain from a webhosting › Responses

200

scaleway.webhosting.v1.HostingSummary

id

string

ID of the Web Hosting plan.

project_id

string

ID of the Scaleway Project the Web Hosting plan belongs to.

created_at

string · date-time

Date on which the Web Hosting plan was created. (RFC 3339 format)

updated_at

string · date-time

Date on which the Web Hosting plan was last updated. (RFC 3339 format)

status

string · enum

Status of the Web Hosting plan.

Enum values:

unknown_status

delivering

ready

deleting

error

locked

migrating

updating

Default: unknown_status

protected

boolean

Whether the hosting is protected or not.

offer_name

string

Name of the active offer for the Web Hosting plan.

region

string

Region where the Web Hosting plan is hosted.

object

Domain configuration block (subdomain, optional custom domain, and DNS settings).

POST/webhosting/v1/regions/{region}/hostings/{hosting_id}/remove-custom-domain

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{"domain_name":"string"}' \
  "https://api.scaleway.com/webhosting/v1/regions/{region}/hostings/{hosting_id}/remove-custom-domain"

Example Request Body

{
  "domain_name": "domain_name"
}

json

Example Responses

{
  "id": "id",
  "project_id": "project_id",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "status": "unknown_status",
  "domain": "domain",
  "protected": true,
  "dns_status": "unknown_status",
  "offer_name": "offer_name",
  "domain_status": "unknown_status",
  "region": "region",
  "domain_info": {
    "subdomain": "subdomain",
    "custom_domain": {
      "domain": "domain",
      "domain_status": "unknown_status",
      "dns_status": "unknown_status",
      "auto_config_domain_dns": {
        "nameservers": true,
        "web_records": true,
        "mail_records": true,
        "all_records": true,
        "none": true
      }
    }
  }
}

json

application/json

Reset a Web Hosting plan

POST

https://api.scaleway.com

/webhosting/v1/regions/{region}/hostings/{hosting_id}/reset

Reset a Web Hosting plan to its initial state, specified by its hosting_id. This permanently deletes all hosting data including files, databases and emails. The hosting will be re-provisioned.

Reset a Web Hosting plan › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

hosting_id

string · required

Hosting ID of the Web Hosting plan to reset.

Reset a Web Hosting plan › Request Body

Reset a Web Hosting plan › Responses

200

scaleway.webhosting.v1.Hosting

id

string

ID of the Web Hosting plan.

project_id

string

ID of the Scaleway Project the Web Hosting plan belongs to.

updated_at

string · date-time

Date on which the Web Hosting plan was last updated. (RFC 3339 format)

created_at

string · date-time

Date on which the Web Hosting plan was created. (RFC 3339 format)

status

string · enum

Status of the Web Hosting plan.

Enum values:

unknown_status

delivering

ready

deleting

error

locked

migrating

updating

Default: unknown_status

object

Details of the Web Hosting plan offer and options.

object

Details of the hosting platform.

tags

string[]

List of tags associated with the Web Hosting plan.

ipv4

string

Current IPv4 address of the hosting. (IPv4 address)

protected

boolean

Whether the hosting is protected or not.

object

Details of the hosting user.

region

string

Region where the Web Hosting plan is hosted.

object

Domain configuration block (subdomain, optional custom domain, and DNS settings).

object

Commitment details to which the hosting is engaged.

POST/webhosting/v1/regions/{region}/hostings/{hosting_id}/reset

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{}' \
  "https://api.scaleway.com/webhosting/v1/regions/{region}/hostings/{hosting_id}/reset"

Example Request Body

{}

json

Example Responses

{
  "id": "id",
  "project_id": "project_id",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "status": "unknown_status",
  "domain": "domain",
  "offer": {
    "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"
  },
  "platform": {
    "hostname": "hostname",
    "number": 0,
    "group_name": "unknown_group",
    "ipv4": "1.2.3.4",
    "ipv6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334",
    "control_panel": {
      "name": "name",
      "urls": {
        "dashboard": "dashboard",
        "webmail": "webmail"
      }
    }
  },
  "tags": [
    "string"
  ],
  "dns_status": "unknown_status",
  "ipv4": "1.2.3.4",
  "protected": true,
  "user": {
    "username": "username",
    "one_time_password": "one_time_password",
    "contact_email": "contact_email",
    "one_time_password_b64": "one_time_password_b64"
  },
  "domain_status": "unknown_status",
  "region": "region",
  "domain_info": {
    "subdomain": "subdomain",
    "custom_domain": {
      "domain": "domain",
      "domain_status": "unknown_status",
      "dns_status": "unknown_status",
      "auto_config_domain_dns": {
        "nameservers": true,
        "web_records": true,
        "mail_records": true,
        "all_records": true,
        "none": true
      }
    }
  },
  "commitment": {
    "offer_commitment": {
      "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,
      "next": {
        "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
      }
    },
    "start_at": "2022-03-22T12:34:56.123456Z",
    "end_at": "2022-03-22T12:34:56.123456Z",
    "delete_hosting_at_end": true
  }
}

json

application/json

Reset a Web Hosting plan password

POST

https://api.scaleway.com

/webhosting/v1/regions/{region}/hostings/{hosting_id}/reset-password

Reset a Web Hosting plan password › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

hosting_id

string · required

UUID of the hosting.

Reset a Web Hosting plan password › Request Body

Reset a Web Hosting plan password › Responses

200

scaleway.webhosting.v1.ResetHostingPasswordResponse

one_time_password_b64

string

New temporary password, encoded in base64.

Get the total counts of websites, databases, email accounts, and FTP accounts of a Web Hosting plan

GET

https://api.scaleway.com

/webhosting/v1/regions/{region}/hostings/{hosting_id}/resource-summary

Get the total counts of websites, databases, email accounts, and FTP accounts of a Web Hosting plan › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

hosting_id

string · required

Hosting ID.

Get the total counts of websites, databases, email accounts, and FTP accounts of a Web Hosting plan › Responses

200

scaleway.webhosting.v1.ResourceSummary

databases_count

integer · uint32

Total number of active databases in the Web Hosting plan.

mail_accounts_count

integer · uint32

Total number of active email accounts in the Web Hosting plan.

ftp_accounts_count

integer · uint32

Total number of active FTP accounts in the Web Hosting plan.

websites_count

integer · uint32

Total number of active domains in the Web Hosting plan.

Create a user session

POST

https://api.scaleway.com

/webhosting/v1/regions/{region}/hostings/{hosting_id}/sessions

Create a user session › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

hosting_id

string · required

Hosting ID.

Create a user session › Request Body

Create a user session › Responses

200

scaleway.webhosting.v1.Session

url

string

Logged user's session URL.

Update the free domain of a Web Hosting plan

PATCH

https://api.scaleway.com

/webhosting/v1/regions/{region}/hostings/{hosting_id}/update-free-domain

Change the free domain associated with a Web Hosting plan, specified by its hosting_id.

Update the free domain of a Web Hosting plan › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

hosting_id

string · required

Hosting ID of the Web Hosting plan to update.

Update the free domain of a Web Hosting plan › Request Body

free_domain

string

New free domain to associate with the Web Hosting plan.

Update the free domain of a Web Hosting plan › Responses

200

scaleway.webhosting.v1.Hosting

id

string

ID of the Web Hosting plan.

project_id

string

ID of the Scaleway Project the Web Hosting plan belongs to.

updated_at

string · date-time

Date on which the Web Hosting plan was last updated. (RFC 3339 format)

created_at

string · date-time

Date on which the Web Hosting plan was created. (RFC 3339 format)

status

string · enum

Status of the Web Hosting plan.

Enum values:

unknown_status

delivering

ready

deleting

error

locked

migrating

updating

Default: unknown_status

object

Details of the Web Hosting plan offer and options.

object

Details of the hosting platform.

tags

string[]

List of tags associated with the Web Hosting plan.

ipv4

string

Current IPv4 address of the hosting. (IPv4 address)

protected

boolean

Whether the hosting is protected or not.

object

Details of the hosting user.

region

string

Region where the Web Hosting plan is hosted.

object

Domain configuration block (subdomain, optional custom domain, and DNS settings).

object

Commitment details to which the hosting is engaged.

PATCH/webhosting/v1/regions/{region}/hostings/{hosting_id}/update-free-domain

curl -X PATCH \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{"free_domain":"string"}' \
  "https://api.scaleway.com/webhosting/v1/regions/{region}/hostings/{hosting_id}/update-free-domain"

Example Request Body

{
  "free_domain": "free_domain"
}

json

Example Responses

{
  "id": "id",
  "project_id": "project_id",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "status": "unknown_status",
  "domain": "domain",
  "offer": {
    "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"
  },
  "platform": {
    "hostname": "hostname",
    "number": 0,
    "group_name": "unknown_group",
    "ipv4": "1.2.3.4",
    "ipv6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334",
    "control_panel": {
      "name": "name",
      "urls": {
        "dashboard": "dashboard",
        "webmail": "webmail"
      }
    }
  },
  "tags": [
    "string"
  ],
  "dns_status": "unknown_status",
  "ipv4": "1.2.3.4",
  "protected": true,
  "user": {
    "username": "username",
    "one_time_password": "one_time_password",
    "contact_email": "contact_email",
    "one_time_password_b64": "one_time_password_b64"
  },
  "domain_status": "unknown_status",
  "region": "region",
  "domain_info": {
    "subdomain": "subdomain",
    "custom_domain": {
      "domain": "domain",
      "domain_status": "unknown_status",
      "dns_status": "unknown_status",
      "auto_config_domain_dns": {
        "nameservers": true,
        "web_records": true,
        "mail_records": true,
        "all_records": true,
        "none": true
      }
    }
  },
  "commitment": {
    "offer_commitment": {
      "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,
      "next": {
        "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
      }
    },
    "start_at": "2022-03-22T12:34:56.123456Z",
    "end_at": "2022-03-22T12:34:56.123456Z",
    "delete_hosting_at_end": true
  }
}

json

application/json