Copy page

Commands

Documentation for `scw webhosting`

This API allows you to list and restore backups for your cPanel and WordPress Web Hosting service.

Backups

Backups represent snapshots of your hosting environment. You can list and restore individual items such as files, databases, or mailboxes.

Get info about a backup specified by the backup ID.

Get info about a backup specified by the backup ID.

Usage:

Code
scw webhosting backup get [arg=value ...]

Arguments:

Name	Description	Argument Specifications
hosting-id	UUID of the hosting account	Required
backup-id	ID of the backup to retrieve	Required
region	Region to target. If none is passed will use default region from the config	Default: fr-par One of: fr-par, nl-ams, pl-waw

List all available backups for a hosting account.

List all available backups for a hosting account.

Usage:

Code
scw webhosting backup list [arg=value ...]

Arguments:

Name	Description	Argument Specifications
hosting-id	UUID of the hosting account	Required
order-by	Order in which to return the list of backups	One of: created_at_desc, created_at_asc
region	Region to target. If none is passed will use default region from the config	Default: fr-par One of: fr-par, nl-ams, pl-waw, all

Restore an entire backup to your hosting environment.

Restore an entire backup to your hosting environment.

Usage:

Code
scw webhosting backup restore [arg=value ...]

Arguments:

Name	Description	Argument Specifications
hosting-id	UUID of the hosting account	Required
backup-id	ID of the backup to fully restore	Required
region	Region to target. If none is passed will use default region from the config	Default: fr-par One of: fr-par, nl-ams, pl-waw

Backups items

Backups represent dedicated snapshots of services of your hosting. You can list and restore individual items such as files, databases, or mailboxes.

List items within a specific backup, grouped by type.

List items within a specific backup, grouped by type.

Usage:

Code
scw webhosting backup-item list [arg=value ...]

Arguments:

Name	Description	Argument Specifications
hosting-id	UUID of the hosting account	Required
backup-id	ID of the backup to list items from
region	Region to target. If none is passed will use default region from the config	Default: fr-par One of: fr-par, nl-ams, pl-waw

Restore specific items from a backup (e.g., a database or mailbox).

Restore specific items from a backup (e.g., a database or mailbox).

Usage:

Code
scw webhosting backup-item restore [arg=value ...]

Arguments:

Name	Description	Argument Specifications
hosting-id	UUID of the hosting account	Required
item-ids.{index}	List of backup item IDs to restore individually
region	Region to target. If none is passed will use default region from the config	Default: fr-par One of: fr-par, nl-ams, pl-waw

Control Panels

Control panels represent the kind of administration panel to manage your Web Hosting plan, cPanel or plesk.

"List the control panels type: cpanel or plesk."

"List the control panels type: cpanel or plesk.".

Usage:

Code
scw webhosting control-panel list [arg=value ...]

Arguments:

Name	Description	Argument Specifications
region	Region to target. If none is passed will use default region from the config	Default: fr-par One of: fr-par, nl-ams, pl-waw, all

Database

Databases represent the databases you can create and manage within your Web Hosting plan. Supported types are MySQL and PostgreSQL.

"Create a new database within your hosting plan"

"Create a new database within your hosting plan".

Usage:

Code
scw webhosting database create [arg=value ...]

Arguments:

Name	Description	Argument Specifications
hosting-id	UUID of the hosting plan where the database will be created	Required
database-name	Name of the database to be created
new-user.username
new-user.password
existing-username	(Optional) Username to link an existing user to the database
region	Region to target. If none is passed will use default region from the config	Default: fr-par One of: fr-par, nl-ams, pl-waw

"Delete a database within your hosting plan"

"Delete a database within your hosting plan".

Usage:

Code
scw webhosting database delete [arg=value ...]

Arguments:

Name	Description	Argument Specifications
hosting-id	UUID of the hosting plan	Required
database-name	Name of the database to delete	Required
region	Region to target. If none is passed will use default region from the config	Default: fr-par One of: fr-par, nl-ams, pl-waw

"Get details of a database within your hosting plan"

"Get details of a database within your hosting plan".

Usage:

Code
scw webhosting database get [arg=value ...]

Arguments:

Name	Description	Argument Specifications
hosting-id	UUID of the hosting plan	Required
database-name	Name of the database	Required
region	Region to target. If none is passed will use default region from the config	Default: fr-par One of: fr-par, nl-ams, pl-waw

"List all databases within your hosting plan"

"List all databases within your hosting plan".

Usage:

Code
scw webhosting database list [arg=value ...]

Arguments:

Name	Description	Argument Specifications
hosting-id	UUID of the hosting plan	Required
order-by	Sort order of databases in the response	One of: database_name_asc, database_name_desc
region	Region to target. If none is passed will use default region from the config	Default: fr-par One of: fr-par, nl-ams, pl-waw, all

Database User

Database users represent the users that can access and manage the databases in your Web Hosting plan.

"Assign a database user to a database"

"Assign a database user to a database".

Usage:

Code
scw webhosting database-user assign [arg=value ...]

Arguments:

Name	Description	Argument Specifications
hosting-id	UUID of the hosting plan	Required
username	Name of the user to assign
database-name	Name of the database to be assigned	Required
region	Region to target. If none is passed will use default region from the config	Default: fr-par One of: fr-par, nl-ams, pl-waw

"Change the password of a database user"

"Change the password of a database user".

Usage:

Code
scw webhosting database-user change-password [arg=value ...]

Arguments:

Name	Description	Argument Specifications
hosting-id	UUID of the hosting plan	Required
username	Name of the user to update	Required
password	New password
region	Region to target. If none is passed will use default region from the config	Default: fr-par One of: fr-par, nl-ams, pl-waw

"Create a new database user"

"Create a new database user".

Usage:

Code
scw webhosting database-user create [arg=value ...]

Arguments:

Name	Description	Argument Specifications
hosting-id	UUID of the hosting plan	Required
username	Name of the user to create
password	Password of the user to create
region	Region to target. If none is passed will use default region from the config	Default: fr-par One of: fr-par, nl-ams, pl-waw

"Delete a database user"

"Delete a database user".

Usage:

Code
scw webhosting database-user delete [arg=value ...]

Arguments:

Name	Description	Argument Specifications
hosting-id	UUID of the hosting plan	Required
username	Name of the database user to delete	Required
region	Region to target. If none is passed will use default region from the config	Default: fr-par One of: fr-par, nl-ams, pl-waw

"Get details of a database user"

"Get details of a database user".

Usage:

Code
scw webhosting database-user get [arg=value ...]

Arguments:

Name	Description	Argument Specifications
hosting-id	UUID of the hosting plan	Required
username	Name of the database user to retrieve details	Required
region	Region to target. If none is passed will use default region from the config	Default: fr-par One of: fr-par, nl-ams, pl-waw

"List all database users"

"List all database users".

Usage:

Code
scw webhosting database-user list [arg=value ...]

Arguments:

Name	Description	Argument Specifications
hosting-id	UUID of the hosting plan	Required
order-by	Sort order of database users in the response	One of: username_asc, username_desc
region	Region to target. If none is passed will use default region from the config	Default: fr-par One of: fr-par, nl-ams, pl-waw, all

"Unassign a database user from a database"

"Unassign a database user from a database".

Usage:

Code
scw webhosting database-user unassign [arg=value ...]

Arguments:

Name	Description	Argument Specifications
hosting-id	UUID of the hosting plan	Required
username	Name of the user to unassign
database-name	Name of the database to be unassigned	Required
region	Region to target. If none is passed will use default region from the config	Default: fr-par One of: fr-par, nl-ams, pl-waw

Domain information commands

With a Scaleway Web Hosting plan, you can manage your domain, configure your web hosting services, manage your emails and more. Get dns records status and check if you own the domain with these calls.

Get DNS records

Get the set of DNS records of a specified domain associated with a Web Hosting plan's domain.

Usage:

Code
scw webhosting dns-records get-dns-records [arg=value ...]

Arguments:

Name	Description	Argument Specifications
domain	Domain associated with the DNS records	Required
region	Region to target. If none is passed will use default region from the config	Default: fr-par One of: fr-par, nl-ams, pl-waw

Examples:

Get DNS records associated to the given domain

Code
scw webhosting dns-records get-dns-records domain=foo.com

Domain information commands

With a Scaleway Web Hosting plan, you can manage your domain, configure your web hosting services, manage your emails and more. Get dns records status and check if you own the domain with these calls.

Check whether you own this domain or not.

Check whether you own this domain or not.

Usage:

Code
scw webhosting domain check-ownership [arg=value ...]

Arguments:

Name	Description	Argument Specifications
project-id	Project ID to use. If none is passed the default project ID will be used
domain	Domain for which ownership is to be verified.	Required
region	Region to target. If none is passed will use default region from the config	Default: fr-par One of: fr-par, nl-ams, pl-waw

Retrieve detailed information about a specific domain, including its status, DNS configuration, and ownership.

Retrieve detailed information about a specific domain, including its status, DNS configuration, and ownership.

Usage:

Code
scw webhosting domain get [arg=value ...]

Arguments:

Name	Description	Argument Specifications
domain-name	Domain name to get.	Required
project-id	Project ID to use. If none is passed the default project ID will be used
region	Region to target. If none is passed will use default region from the config	Default: fr-par One of: fr-par, nl-ams, pl-waw

Synchronize your DNS records on the Elements Console and on cPanel.

Synchronize your DNS records on the Elements Console and on cPanel.

Usage:

Code
scw webhosting domain sync-dns-records [arg=value ...]

Arguments:

Name	Description	Argument Specifications
domain	Domain for which the DNS records will be synchronized.	Required
update-web-records	Whether or not to synchronize the web records (deprecated, use auto_config_domain_dns).	Deprecated
update-mail-records	Whether or not to synchronize the mail records (deprecated, use auto_config_domain_dns).	Deprecated
update-all-records	Whether or not to synchronize all types of records. This one has priority (deprecated, use auto_config_domain_dns).	Deprecated
update-nameservers	Whether or not to synchronize domain nameservers (deprecated, use auto_config_domain_dns).	Deprecated
custom-records.{index}.name
custom-records.{index}.type		One of: unknown_type, a, cname, mx, txt, ns, aaaa
auto-config-domain-dns.nameservers	Whether or not to synchronize domain nameservers.
auto-config-domain-dns.web-records	Whether or not to synchronize web records.
auto-config-domain-dns.mail-records	Whether or not to synchronize mail records.
auto-config-domain-dns.all-records	Whether or not to synchronize all types of records. Takes priority over the other fields.
auto-config-domain-dns.none	No automatic domain configuration. Users must configure their domain for the Web Hosting to work.
region	Region to target. If none is passed will use default region from the config	Default: fr-par One of: fr-par, nl-ams, pl-waw

Domain information commands

With a Scaleway Web Hosting plan, you can manage your domain, configure your web hosting services, manage your emails and more. Get dns records status and check if you own the domain with these calls.

Search for available domains based on domain name.

Search for available domains based on domain name.

Usage:

Code
scw webhosting domain-availability search [arg=value ...]

Arguments:

Name	Description	Argument Specifications
domain-name	Domain name to search.
project-id	Project ID to use. If none is passed the default project ID will be used
region	Region to target. If none is passed will use default region from the config	Default: fr-par One of: fr-par, nl-ams, pl-waw

Free domains

A free subdomain provided by Scaleway for your hosting.

Check whether a given slug and free domain combination is available.

Check whether a given slug and free domain combination is available.

Usage:

Code
scw webhosting freedomain check-availability [arg=value ...]

Arguments:

Name	Description	Argument Specifications
slug	Custom prefix used for the free domain.
root-domain	Free root domain provided by Web Hosting, selected from the list returned by ListFreeRootDomains.
region	Region to target. If none is passed will use default region from the config	Default: fr-par One of: fr-par, nl-ams, pl-waw

Retrieve the list of free root domains available for a Web Hosting.

Retrieve the list of free root domains available for a Web Hosting.

Usage:

Code
scw webhosting freedomain list [arg=value ...]

Arguments:

Name	Description	Argument Specifications
region	Region to target. If none is passed will use default region from the config	Default: fr-par One of: fr-par, nl-ams, pl-waw, all

FTP Account

FTP accounts represent the access credentials for FTP (File Transfer Protocol) used to manage files on your web hosting plan.

Create a new FTP account within your hosting plan.

Create a new FTP account within your hosting plan.

Usage:

Code
scw webhosting ftp-account create [arg=value ...]

Arguments:

Name	Description	Argument Specifications
hosting-id	UUID of the hosting plan	Required
username	Username for the new FTP account
path	Path for the new FTP account
password	Password for the new FTP account
region	Region to target. If none is passed will use default region from the config	Default: fr-par One of: fr-par, nl-ams, pl-waw

Delete a specific FTP account within your hosting plan.

Delete a specific FTP account within your hosting plan.

Usage:

Code
scw webhosting ftp-account delete [arg=value ...]

Arguments:

Name	Description	Argument Specifications
hosting-id	UUID of the hosting plan	Required
username	Username of the FTP account to be deleted	Required
region	Region to target. If none is passed will use default region from the config	Default: fr-par One of: fr-par, nl-ams, pl-waw

List all FTP accounts within your hosting plan.

List all FTP accounts within your hosting plan.

Usage:

Code
scw webhosting ftp-account list [arg=value ...]

Arguments:

Name	Description	Argument Specifications
order-by	Sort order of FTP accounts in the response	One of: username_asc, username_desc
hosting-id	UUID of the hosting plan	Required
domain	Domain to filter the FTP accounts
region	Region to target. If none is passed will use default region from the config	Default: fr-par One of: fr-par, nl-ams, pl-waw, all

Hosting management commands

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.

Order a Web Hosting plan

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

Usage:

Code
scw webhosting hosting create [arg=value ...]

Arguments:

Name	Description	Argument Specifications
offer-id	ID of the selected offer for the Web Hosting plan
project-id	Project ID to use. If none is passed the default project ID will be used
email	Contact email for the Web Hosting client
tags.{index}	List of tags for the Web Hosting plan
domain	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	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.
offer-options.{index}.id	Offer option ID
offer-options.{index}.quantity	The option requested quantity to set for the Web Hosting plan
language	Default language for the control panel interface	One of: unknown_language_code, en_US, fr_FR, de_DE
domain-configuration.update-nameservers
domain-configuration.update-web-record
domain-configuration.update-mail-record
domain-configuration.update-all-records
skip-welcome-email	Indicates whether to skip a welcome email to the contact email containing hosting info.
auto-config-domain-dns.nameservers	Whether or not to synchronize domain nameservers.
auto-config-domain-dns.web-records	Whether or not to synchronize web records.
auto-config-domain-dns.mail-records	Whether or not to synchronize mail records.
auto-config-domain-dns.all-records	Whether or not to synchronize all types of records. Takes priority over the other fields.
auto-config-domain-dns.none	No automatic domain configuration. Users must configure their domain for the Web Hosting to work.
offer-commitment-id	Offer commitment ID to which the hosting will be engaged
region	Region to target. If none is passed will use default region from the config	Default: fr-par One of: fr-par, nl-ams, pl-waw

Create a user session

Create a user session.

Usage:

Code
scw webhosting hosting create-session [arg=value ...]

Arguments:

Name	Description	Argument Specifications
hosting-id	Hosting ID	Required
region	Region to target. If none is passed will use default region from the config	Default: fr-par One of: fr-par, nl-ams, pl-waw

Delete a Web Hosting plan

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.

Usage:

Code
scw webhosting hosting delete [arg=value ...]

Arguments:

Name	Description	Argument Specifications
hosting-id	Hosting ID	Required
region	Region to target. If none is passed will use default region from the config	Default: fr-par One of: fr-par, nl-ams, pl-waw

Examples:

Delete a Hosting with the given ID

Code
scw webhosting hosting delete hosting-id=a3244331-5d32-4e36-9bf9-b60233e201c7

Get a Web Hosting plan

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

Usage:

Code
scw webhosting hosting get [arg=value ...]

Arguments:

Name	Description	Argument Specifications
hosting-id	Hosting ID	Required
region	Region to target. If none is passed will use default region from the config	Default: fr-par One of: fr-par, nl-ams, pl-waw

Examples:

Get a Hosting with the given ID

Code
scw webhosting hosting get hosting-id=a3244331-5d32-4e36-9bf9-b60233e201c7

List all Web Hosting plans

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.

Usage:

Code
scw webhosting hosting list [arg=value ...]

Arguments:

Name	Description	Argument Specifications
order-by	Sort order for Web Hosting plans in the response	One of: created_at_asc, created_at_desc
tags.{index}	Tags to filter for, only Web Hosting plans with matching tags will be returned
statuses.{index}	Statuses to filter for, only Web Hosting plans with matching statuses will be returned	One of: unknown_status, delivering, ready, deleting, error, locked, migrating, updating, payment_pending, payment_failed
domain	Domain to filter for, only Web Hosting plans associated with this domain will be returned
project-id	Project ID to filter for, only Web Hosting plans from this Project will be returned
control-panels.{index}	Name of the control panel to filter for, only Web Hosting plans from this control panel will be returned
subdomain	Optional free subdomain linked to the Web Hosting plan
organization-id	Organization ID to filter for, only Web Hosting plans from this Organization will be returned
region	Region to target. If none is passed will use default region from the config	Default: fr-par One of: fr-par, nl-ams, pl-waw, all

Examples:

List all hostings of a given project ID

Code
scw webhosting hosting list project-id=a3244331-5d32-4e36-9bf9-b60233e201c7 organization-id=a3244331-5d32-4e36-9bf9-b60233e201c7

Update a Web Hosting plan

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.

Usage:

Code
scw webhosting hosting update [arg=value ...]

Arguments:

Name	Description	Argument Specifications
hosting-id	Hosting ID	Required
email	New contact email for the Web Hosting plan
tags.{index}	New tags for the Web Hosting plan
offer-options.{index}.id	Offer option ID
offer-options.{index}.quantity	The option requested quantity to set for the Web Hosting plan
offer-id	ID of the new offer for the Web Hosting plan
protected	Whether the hosting is protected or not
delete-hosting-after-commitment	Whether the hosting is deleted at the end of the commitment period
region	Region to target. If none is passed will use default region from the config	Default: fr-par One of: fr-par, nl-ams, pl-waw

Examples:

Update the contact email of a given hosting

Code
scw webhosting hosting update hosting-id=11111111-1111-1111-1111-111111111111 email=foobar@example.com

Overwrite tags of a given hosting

Code
scw webhosting hosting update hosting-id=11111111-1111-1111-1111-111111111111 tags.0=foo tags.1=bar

Mail Account

Mail accounts represent the email addresses you can create and manage within your Web Hosting plan.

Update the password of a mail account within your hosting plan.

Update the password of a mail account within your hosting plan.

Usage:

Code
scw webhosting mail-account change-password [arg=value ...]

Arguments:

Name	Description	Argument Specifications
hosting-id	UUID of the hosting plan	Required
domain	Domain part of the mail account address
username	Username part of the mail account address
password	New password for the mail account
region	Region to target. If none is passed will use default region from the config	Default: fr-par One of: fr-par, nl-ams, pl-waw

Create a new mail account within your hosting plan.

Create a new mail account within your hosting plan.

Usage:

Code
scw webhosting mail-account create [arg=value ...]

Arguments:

Name	Description	Argument Specifications
hosting-id	UUID of the hosting plan	Required
domain	Domain part of the mail account address
username	Username part address of the mail account address
password	Password for the new mail account
region	Region to target. If none is passed will use default region from the config	Default: fr-par One of: fr-par, nl-ams, pl-waw

Delete a mail account within your hosting plan.

Delete a mail account within your hosting plan.

Usage:

Code
scw webhosting mail-account delete [arg=value ...]

Arguments:

Name	Description	Argument Specifications
hosting-id	UUID of the hosting plan	Required
domain	Domain part of the mail account address
username	Username part of the mail account address
region	Region to target. If none is passed will use default region from the config	Default: fr-par One of: fr-par, nl-ams, pl-waw

List all mail accounts within your hosting plan.

List all mail accounts within your hosting plan.

Usage:

Code
scw webhosting mail-account list [arg=value ...]

Arguments:

Name	Description	Argument Specifications
order-by	Sort order of mail accounts in the response	One of: username_asc, username_desc, domain_asc, domain_desc
hosting-id	UUID of the hosting plan	Required
domain	Domain to filter the mail accounts
region	Region to target. If none is passed will use default region from the config	Default: fr-par One of: fr-par, nl-ams, pl-waw, all

Offer

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

List all available hosting offers along with their specific options.

List all available hosting offers along with their specific options.

Usage:

Code
scw webhosting offer list [arg=value ...]

Arguments:

Name	Description	Argument Specifications
order-by	Sort order for Web Hosting offers in the response	One of: price_asc
hosting-id	UUID of the hosting plan
control-panels.{index}	Name of the control panel(s) to filter for
region	Region to target. If none is passed will use default region from the config	Default: fr-par One of: fr-par, nl-ams, pl-waw, all

Progresses

Progresses give details on the advancement of a backup,.

Retrieve detailed information about a specific progress by its ID.

Retrieve detailed information about a specific progress by its ID.

Usage:

Code
scw webhosting progress get [arg=value ...]

Arguments:

Name	Description	Argument Specifications
hosting-id	ID of the hosting associated with the progress.	Required
progress-id	ID of the progress to retrieve.	Required
region	Region to target. If none is passed will use default region from the config	Default: fr-par One of: fr-par, nl-ams, pl-waw

List recent progresses associated with a specific backup, grouped by type.

List recent progresses associated with a specific backup, grouped by type.

Usage:

Code
scw webhosting progress list [arg=value ...]

Arguments:

Name	Description	Argument Specifications
hosting-id	ID of the hosting linked to the progress.	Required
region	Region to target. If none is passed will use default region from the config	Default: fr-par One of: fr-par, nl-ams, pl-waw

Website

Websites represent the domains and paths hosted within your Web Hosting plan.

List all websites for a specific hosting.

List all websites for a specific hosting.

Usage:

Code
scw webhosting website list [arg=value ...]

Arguments:

Name	Description	Argument Specifications
hosting-id	UUID of the hosting plan	Required
order-by	Sort order for Web Hosting websites in the response	One of: domain_asc, domain_desc
region	Region to target. If none is passed will use default region from the config	Default: fr-par One of: fr-par, nl-ams, pl-waw, all