scaleway.webhosting.v1 package

Submodules

scaleway.webhosting.v1.api module

class scaleway.webhosting.v1.api.WebhostingV1ControlPanelAPI(client: Client, *, bypass_validation: bool = False)

Bases: API

This API allows you to manage your Web Hosting services.

list_control_panels(*, region: Optional[str] = None, page: Optional[int] = None, page_size: Optional[int] = None) → ListControlPanelsResponse

“List the control panels type: cpanel or plesk.”. :param region: Region to target. If none is passed will use default region from the config. :param page: Page number (must be a positive integer). :param page_size: Number of control panels to return (must be a positive integer lower or equal to 100). :return: ListControlPanelsResponse

Usage:

result = api.list_control_panels()

list_control_panels_all(*, region: Optional[str] = None, page: Optional[int] = None, page_size: Optional[int] = None) → List[ControlPanel]

“List the control panels type: cpanel or plesk.”. :param region: Region to target. If none is passed will use default region from the config. :param page: Page number (must be a positive integer). :param page_size: Number of control panels to return (must be a positive integer lower or equal to 100). :return: List[ControlPanel]

Usage:

result = api.list_control_panels_all()

class scaleway.webhosting.v1.api.WebhostingV1DatabaseAPI(client: Client, *, bypass_validation: bool = False)

Bases: API

This API allows you to manage your databases and database users for your Web Hosting services.

assign_database_user(*, hosting_id: str, username: str, database_name: str, region: Optional[str] = None) → DatabaseUser

“Assign a database user to a database”. :param hosting_id: UUID of the hosting plan. :param username: Name of the user to assign. :param database_name: Name of the database to be assigned. :param region: Region to target. If none is passed will use default region from the config. :return: DatabaseUser

Usage:

result = api.assign_database_user(
    hosting_id="example",
    username="example",
    database_name="example",
)

change_database_user_password(*, hosting_id: str, username: str, password: str, region: Optional[str] = None) → DatabaseUser

“Change the password of a database user”. :param hosting_id: UUID of the hosting plan. :param username: Name of the user to update. :param password: New password. :param region: Region to target. If none is passed will use default region from the config. :return: DatabaseUser

Usage:

result = api.change_database_user_password(
    hosting_id="example",
    username="example",
    password="example",
)

create_database(*, hosting_id: str, database_name: str, region: Optional[str] = None, new_user: Optional[CreateDatabaseRequestUser] = None, existing_username: Optional[str] = None) → Database

“Create a new database within your hosting plan”. :param hosting_id: UUID of the hosting plan where the database will be created. :param database_name: Name of the database to be created. :param region: Region to target. If none is passed will use default region from the config. :param new_user: (Optional) Username and password to create a user and link to the database. One-Of (‘user’): at most one of ‘new_user’, ‘existing_username’ could be set. :param existing_username: (Optional) Username to link an existing user to the database. One-Of (‘user’): at most one of ‘new_user’, ‘existing_username’ could be set. :return: Database

Usage:

result = api.create_database(
    hosting_id="example",
    database_name="example",
)

create_database_user(*, hosting_id: str, username: str, password: str, region: Optional[str] = None) → DatabaseUser

“Create a new database user”. :param hosting_id: UUID of the hosting plan. :param username: Name of the user to create. :param password: Password of the user to create. :param region: Region to target. If none is passed will use default region from the config. :return: DatabaseUser

Usage:

result = api.create_database_user(
    hosting_id="example",
    username="example",
    password="example",
)

delete_database(*, hosting_id: str, database_name: str, region: Optional[str] = None) → Database

“Delete a database within your hosting plan”. :param hosting_id: UUID of the hosting plan. :param database_name: Name of the database to delete. :param region: Region to target. If none is passed will use default region from the config. :return: Database

Usage:

result = api.delete_database(
    hosting_id="example",
    database_name="example",
)

delete_database_user(*, hosting_id: str, username: str, region: Optional[str] = None) → DatabaseUser

“Delete a database user”. :param hosting_id: UUID of the hosting plan. :param username: Name of the database user to delete. :param region: Region to target. If none is passed will use default region from the config. :return: DatabaseUser

Usage:

result = api.delete_database_user(
    hosting_id="example",
    username="example",
)

get_database(*, hosting_id: str, database_name: str, region: Optional[str] = None) → Database

“Get details of a database within your hosting plan”. :param hosting_id: UUID of the hosting plan. :param database_name: Name of the database. :param region: Region to target. If none is passed will use default region from the config. :return: Database

Usage:

result = api.get_database(
    hosting_id="example",
    database_name="example",
)

get_database_user(*, hosting_id: str, username: str, region: Optional[str] = None) → DatabaseUser

“Get details of a database user”. :param hosting_id: UUID of the hosting plan. :param username: Name of the database user to retrieve details. :param region: Region to target. If none is passed will use default region from the config. :return: DatabaseUser

Usage:

result = api.get_database_user(
    hosting_id="example",
    username="example",
)

list_database_users(*, hosting_id: str, region: Optional[str] = None, page: Optional[int] = None, page_size: Optional[int] = None, order_by: Optional[ListDatabaseUsersRequestOrderBy] = None) → ListDatabaseUsersResponse

“List all database users”. :param hosting_id: UUID of the hosting plan. :param region: Region to target. If none is passed will use default region from the config. :param page: Page number (must be a positive integer). :param page_size: Number of database users to return (must be a positive integer lower or equal to 100). :param order_by: Sort order of database users in the response. :return: ListDatabaseUsersResponse

Usage:

result = api.list_database_users(
    hosting_id="example",
)

list_database_users_all(*, hosting_id: str, region: Optional[str] = None, page: Optional[int] = None, page_size: Optional[int] = None, order_by: Optional[ListDatabaseUsersRequestOrderBy] = None) → List[DatabaseUser]

“List all database users”. :param hosting_id: UUID of the hosting plan. :param region: Region to target. If none is passed will use default region from the config. :param page: Page number (must be a positive integer). :param page_size: Number of database users to return (must be a positive integer lower or equal to 100). :param order_by: Sort order of database users in the response. :return: List[DatabaseUser]

Usage:

result = api.list_database_users_all(
    hosting_id="example",
)

list_databases(*, hosting_id: str, region: Optional[str] = None, page: Optional[int] = None, page_size: Optional[int] = None, order_by: Optional[ListDatabasesRequestOrderBy] = None) → ListDatabasesResponse

“List all databases within your hosting plan”. :param hosting_id: UUID of the hosting plan. :param region: Region to target. If none is passed will use default region from the config. :param page: Page number (must be a positive integer). :param page_size: Number of databases to return (must be a positive integer lower or equal to 100). :param order_by: Sort order of databases in the response. :return: ListDatabasesResponse

Usage:

result = api.list_databases(
    hosting_id="example",
)

list_databases_all(*, hosting_id: str, region: Optional[str] = None, page: Optional[int] = None, page_size: Optional[int] = None, order_by: Optional[ListDatabasesRequestOrderBy] = None) → List[Database]

“List all databases within your hosting plan”. :param hosting_id: UUID of the hosting plan. :param region: Region to target. If none is passed will use default region from the config. :param page: Page number (must be a positive integer). :param page_size: Number of databases to return (must be a positive integer lower or equal to 100). :param order_by: Sort order of databases in the response. :return: List[Database]

Usage:

result = api.list_databases_all(
    hosting_id="example",
)

unassign_database_user(*, hosting_id: str, username: str, database_name: str, region: Optional[str] = None) → DatabaseUser

“Unassign a database user from a database”. :param hosting_id: UUID of the hosting plan. :param username: Name of the user to unassign. :param database_name: Name of the database to be unassigned. :param region: Region to target. If none is passed will use default region from the config. :return: DatabaseUser

Usage:

result = api.unassign_database_user(
    hosting_id="example",
    username="example",
    database_name="example",
)

class scaleway.webhosting.v1.api.WebhostingV1DnsAPI(client: Client, *, bypass_validation: bool = False)

Bases: API

This API allows you to manage your Web Hosting services.

check_user_owns_domain(*, domain: str, region: Optional[str] = None, project_id: Optional[str] = None) → CheckUserOwnsDomainResponse

Check whether you own this domain or not. :param domain: Domain for which ownership is to be verified. :param region: Region to target. If none is passed will use default region from the config. :param project_id: ID of the project currently in use. :return: CheckUserOwnsDomainResponse

Usage:

result = api.check_user_owns_domain(
    domain="example",
)

get_domain(*, domain_name: str, region: Optional[str] = None, project_id: Optional[str] = None) → Domain

Retrieve detailed information about a specific domain, including its status, DNS configuration, and ownership. :param domain_name: Domain name to get. :param region: Region to target. If none is passed will use default region from the config. :param project_id: ID of the Scaleway Project in which to get the domain to create the Web Hosting plan. :return: Domain

Usage:

result = api.get_domain(
    domain_name="example",
)

get_domain_dns_records(*, domain: str, region: Optional[str] = None) → DnsRecords

Get DNS records. Get the set of DNS records of a specified domain associated with a Web Hosting plan’s domain. :param domain: Domain associated with the DNS records. :param region: Region to target. If none is passed will use default region from the config. :return: DnsRecords

Usage:

result = api.get_domain_dns_records(
    domain="example",
)

search_domains(*, domain_name: str, region: Optional[str] = None, project_id: Optional[str] = None) → SearchDomainsResponse

Search for available domains based on domain name. :param domain_name: Domain name to search. :param region: Region to target. If none is passed will use default region from the config. :param project_id: ID of the Scaleway Project in which to search the domain to create the Web Hosting plan. :return: SearchDomainsResponse

Usage:

result = api.search_domains(
    domain_name="example",
)

sync_domain_dns_records(*, domain: str, region: Optional[str] = None, update_web_records: Optional[bool] = None, update_mail_records: Optional[bool] = None, update_all_records: Optional[bool] = None, update_nameservers: Optional[bool] = None, custom_records: Optional[List[SyncDomainDnsRecordsRequestRecord]] = None, auto_config_domain_dns: Optional[AutoConfigDomainDns] = None) → DnsRecords

Synchronize your DNS records on the Elements Console and on cPanel. :param domain: Domain for which the DNS records will be synchronized. :param region: Region to target. If none is passed will use default region from the config. :param update_web_records: Whether or not to synchronize the web records (deprecated, use auto_config_domain_dns). :param update_mail_records: Whether or not to synchronize the mail records (deprecated, use auto_config_domain_dns). :param update_all_records: Whether or not to synchronize all types of records. This one has priority (deprecated, use auto_config_domain_dns). :param update_nameservers: Whether or not to synchronize domain nameservers (deprecated, use auto_config_domain_dns). :param custom_records: Custom records to synchronize. :param auto_config_domain_dns: Whether or not to synchronize each types of records. :return: DnsRecords

Usage:

result = api.sync_domain_dns_records(
    domain="example",
)

wait_for_domain(*, domain_name: str, region: Optional[str] = None, project_id: Optional[str] = None, options: Optional[WaitForOptions[Domain, bool]] = None) → Domain

Retrieve detailed information about a specific domain, including its status, DNS configuration, and ownership. :param domain_name: Domain name to get. :param region: Region to target. If none is passed will use default region from the config. :param project_id: ID of the Scaleway Project in which to get the domain to create the Web Hosting plan. :return: Domain

Usage:

result = api.get_domain(
    domain_name="example",
)

class scaleway.webhosting.v1.api.WebhostingV1FtpAccountAPI(client: Client, *, bypass_validation: bool = False)

Bases: API

This API allows you to manage your FTP accounts for your Web Hosting services.

change_ftp_account_password(*, hosting_id: str, username: str, password: str, region: Optional[str] = None) → FtpAccount

Parameters:

hosting_id – UUID of the hosting plan.
username – Username of the FTP account.
password – New password for the FTP account.
region – Region to target. If none is passed will use default region from the config.

Returns:

FtpAccount

Usage:

result = api.change_ftp_account_password(
    hosting_id="example",
    username="example",
    password="example",
)

create_ftp_account(*, hosting_id: str, username: str, path: str, password: str, region: Optional[str] = None) → FtpAccount

Create a new FTP account within your hosting plan. :param hosting_id: UUID of the hosting plan. :param username: Username for the new FTP account. :param path: Path for the new FTP account. :param password: Password for the new FTP account. :param region: Region to target. If none is passed will use default region from the config. :return: FtpAccount

Usage:

result = api.create_ftp_account(
    hosting_id="example",
    username="example",
    path="example",
    password="example",
)

list_ftp_accounts(*, hosting_id: str, region: Optional[str] = None, page: Optional[int] = None, page_size: Optional[int] = None, order_by: Optional[ListFtpAccountsRequestOrderBy] = None, domain: Optional[str] = None) → ListFtpAccountsResponse

List all FTP accounts within your hosting plan. :param hosting_id: UUID of the hosting plan. :param region: Region to target. If none is passed will use default region from the config. :param page: Page number (must be a positive integer). :param page_size: Number of FTP accounts to return (must be a positive integer lower or equal to 100). :param order_by: Sort order of FTP accounts in the response. :param domain: Domain to filter the FTP accounts. :return: ListFtpAccountsResponse

Usage:

result = api.list_ftp_accounts(
    hosting_id="example",
)

list_ftp_accounts_all(*, hosting_id: str, region: Optional[str] = None, page: Optional[int] = None, page_size: Optional[int] = None, order_by: Optional[ListFtpAccountsRequestOrderBy] = None, domain: Optional[str] = None) → List[FtpAccount]

List all FTP accounts within your hosting plan. :param hosting_id: UUID of the hosting plan. :param region: Region to target. If none is passed will use default region from the config. :param page: Page number (must be a positive integer). :param page_size: Number of FTP accounts to return (must be a positive integer lower or equal to 100). :param order_by: Sort order of FTP accounts in the response. :param domain: Domain to filter the FTP accounts. :return: List[FtpAccount]

Usage:

result = api.list_ftp_accounts_all(
    hosting_id="example",
)

remove_ftp_account(*, hosting_id: str, username: str, region: Optional[str] = None) → FtpAccount

Delete a specific FTP account within your hosting plan. :param hosting_id: UUID of the hosting plan. :param username: Username of the FTP account to be deleted. :param region: Region to target. If none is passed will use default region from the config. :return: FtpAccount

Usage:

result = api.remove_ftp_account(
    hosting_id="example",
    username="example",
)

class scaleway.webhosting.v1.api.WebhostingV1HostingAPI(client: Client, *, bypass_validation: bool = False)

Bases: API

This API allows you to manage your Web Hosting services.

create_hosting(*, offer_id: str, email: str, domain: str, region: Optional[str] = None, project_id: Optional[str] = None, tags: Optional[List[str]] = None, offer_options: Optional[List[OfferOptionRequest]] = None, language: Optional[LanguageCode] = None, domain_configuration: Optional[CreateHostingRequestDomainConfiguration] = None, skip_welcome_email: Optional[bool] = None, auto_config_domain_dns: Optional[AutoConfigDomainDns] = None) → Hosting

Order a Web Hosting plan. Order a Web Hosting plan, specifying the offer type required via the offer_id parameter. :param offer_id: ID of the selected offer for the Web Hosting plan. :param email: Contact email for the Web Hosting client. :param 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. :param region: Region to target. If none is passed will use default region from the config. :param project_id: ID of the Scaleway Project in which to create the Web Hosting plan. :param tags: List of tags for the Web Hosting plan. :param offer_options: List of the Web Hosting plan options IDs with their quantities. :param language: Default language for the control panel interface. :param domain_configuration: Indicates whether to update hosting domain name servers and DNS records for domains managed by Scaleway Elements (deprecated, use auto_config_domain_dns instead). :param skip_welcome_email: Indicates whether to skip a welcome email to the contact email containing hosting info. :param auto_config_domain_dns: Indicates whether to update hosting domain name servers and DNS records for domains managed by Scaleway Elements (deprecated, use auto_update_* fields instead). :return: Hosting

Usage:

result = api.create_hosting(
    offer_id="example",
    email="example",
    domain="example",
)

create_session(*, hosting_id: str, region: Optional[str] = None) → Session

Create a user session. :param hosting_id: Hosting ID. :param region: Region to target. If none is passed will use default region from the config. :return: Session

Usage:

result = api.create_session(
    hosting_id="example",
)

delete_hosting(*, hosting_id: str, region: Optional[str] = None) → Hosting

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. :param hosting_id: Hosting ID. :param region: Region to target. If none is passed will use default region from the config. :return: Hosting

Usage:

result = api.delete_hosting(
    hosting_id="example",
)

get_hosting(*, hosting_id: str, region: Optional[str] = None) → Hosting

Get a Web Hosting plan. Get the details of one of your existing Web Hosting plans, specified by its hosting_id. :param hosting_id: Hosting ID. :param region: Region to target. If none is passed will use default region from the config. :return: Hosting

Usage:

result = api.get_hosting(
    hosting_id="example",
)

get_resource_summary(*, hosting_id: str, region: Optional[str] = None) → ResourceSummary

Get the total counts of websites, databases, email accounts, and FTP accounts of a Web Hosting plan. :param hosting_id: Hosting ID. :param region: Region to target. If none is passed will use default region from the config. :return: ResourceSummary

Usage:

result = api.get_resource_summary(
    hosting_id="example",
)

list_hostings(*, region: Optional[str] = None, page: Optional[int] = None, page_size: Optional[int] = None, order_by: Optional[ListHostingsRequestOrderBy] = None, tags: Optional[List[str]] = None, statuses: Optional[List[HostingStatus]] = None, domain: Optional[str] = None, project_id: Optional[str] = None, organization_id: Optional[str] = None, control_panels: Optional[List[str]] = None) → ListHostingsResponse

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. :param region: Region to target. If none is passed will use default region from the config. :param page: Page number to return, from the paginated results (must be a positive integer). :param page_size: Number of Web Hosting plans to return (must be a positive integer lower or equal to 100). :param order_by: Sort order for Web Hosting plans in the response. :param tags: Tags to filter for, only Web Hosting plans with matching tags will be returned. :param statuses: Statuses to filter for, only Web Hosting plans with matching statuses will be returned. :param domain: Domain to filter for, only Web Hosting plans associated with this domain will be returned. :param project_id: Project ID to filter for, only Web Hosting plans from this Project will be returned. :param organization_id: Organization ID to filter for, only Web Hosting plans from this Organization will be returned. :param control_panels: Name of the control panel to filter for, only Web Hosting plans from this control panel will be returned. :return: ListHostingsResponse

Usage:

result = api.list_hostings()

list_hostings_all(*, region: Optional[str] = None, page: Optional[int] = None, page_size: Optional[int] = None, order_by: Optional[ListHostingsRequestOrderBy] = None, tags: Optional[List[str]] = None, statuses: Optional[List[HostingStatus]] = None, domain: Optional[str] = None, project_id: Optional[str] = None, organization_id: Optional[str] = None, control_panels: Optional[List[str]] = None) → List[HostingSummary]

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. :param region: Region to target. If none is passed will use default region from the config. :param page: Page number to return, from the paginated results (must be a positive integer). :param page_size: Number of Web Hosting plans to return (must be a positive integer lower or equal to 100). :param order_by: Sort order for Web Hosting plans in the response. :param tags: Tags to filter for, only Web Hosting plans with matching tags will be returned. :param statuses: Statuses to filter for, only Web Hosting plans with matching statuses will be returned. :param domain: Domain to filter for, only Web Hosting plans associated with this domain will be returned. :param project_id: Project ID to filter for, only Web Hosting plans from this Project will be returned. :param organization_id: Organization ID to filter for, only Web Hosting plans from this Organization will be returned. :param control_panels: Name of the control panel to filter for, only Web Hosting plans from this control panel will be returned. :return: List[HostingSummary]

Usage:

result = api.list_hostings_all()

reset_hosting_password(*, hosting_id: str, region: Optional[str] = None) → ResetHostingPasswordResponse

Reset a Web Hosting plan password. :param hosting_id: UUID of the hosting. :param region: Region to target. If none is passed will use default region from the config. :return: ResetHostingPasswordResponse

Usage:

result = api.reset_hosting_password(
    hosting_id="example",
)

update_hosting(*, hosting_id: str, region: Optional[str] = None, email: Optional[str] = None, tags: Optional[List[str]] = None, offer_options: Optional[List[OfferOptionRequest]] = None, offer_id: Optional[str] = None, protected: Optional[bool] = None) → Hosting

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. :param hosting_id: Hosting ID. :param region: Region to target. If none is passed will use default region from the config. :param email: New contact email for the Web Hosting plan. :param tags: New tags for the Web Hosting plan. :param offer_options: List of the Web Hosting plan options IDs with their quantities. :param offer_id: ID of the new offer for the Web Hosting plan. :param protected: Whether the hosting is protected or not. :return: Hosting

Usage:

result = api.update_hosting(
    hosting_id="example",
)

wait_for_hosting(*, hosting_id: str, region: Optional[str] = None, options: Optional[WaitForOptions[Hosting, bool]] = None) → Hosting

Get a Web Hosting plan. Get the details of one of your existing Web Hosting plans, specified by its hosting_id. :param hosting_id: Hosting ID. :param region: Region to target. If none is passed will use default region from the config. :return: Hosting

Usage:

result = api.get_hosting(
    hosting_id="example",
)

class scaleway.webhosting.v1.api.WebhostingV1MailAccountAPI(client: Client, *, bypass_validation: bool = False)

Bases: API

This API allows you to manage your mail accounts for your Web Hosting services.

change_mail_account_password(*, hosting_id: str, domain: str, username: str, password: str, region: Optional[str] = None) → MailAccount

Update the password of a mail account within your hosting plan. :param hosting_id: UUID of the hosting plan. :param domain: Domain part of the mail account address. :param username: Username part of the mail account address. :param password: New password for the mail account. :param region: Region to target. If none is passed will use default region from the config. :return: MailAccount

Usage:

result = api.change_mail_account_password(
    hosting_id="example",
    domain="example",
    username="example",
    password="example",
)

create_mail_account(*, hosting_id: str, domain: str, username: str, password: str, region: Optional[str] = None) → MailAccount

Create a new mail account within your hosting plan. :param hosting_id: UUID of the hosting plan. :param domain: Domain part of the mail account address. :param username: Username part address of the mail account address. :param password: Password for the new mail account. :param region: Region to target. If none is passed will use default region from the config. :return: MailAccount

Usage:

result = api.create_mail_account(
    hosting_id="example",
    domain="example",
    username="example",
    password="example",
)

list_mail_accounts(*, hosting_id: str, region: Optional[str] = None, page: Optional[int] = None, page_size: Optional[int] = None, order_by: Optional[ListMailAccountsRequestOrderBy] = None, domain: Optional[str] = None) → ListMailAccountsResponse

List all mail accounts within your hosting plan. :param hosting_id: UUID of the hosting plan. :param region: Region to target. If none is passed will use default region from the config. :param page: Page number (must be a positive integer). :param page_size: Number of mail accounts to return (must be a positive integer lower or equal to 100). :param order_by: Sort order of mail accounts in the response. :param domain: Domain to filter the mail accounts. :return: ListMailAccountsResponse

Usage:

result = api.list_mail_accounts(
    hosting_id="example",
)

list_mail_accounts_all(*, hosting_id: str, region: Optional[str] = None, page: Optional[int] = None, page_size: Optional[int] = None, order_by: Optional[ListMailAccountsRequestOrderBy] = None, domain: Optional[str] = None) → List[MailAccount]

List all mail accounts within your hosting plan. :param hosting_id: UUID of the hosting plan. :param region: Region to target. If none is passed will use default region from the config. :param page: Page number (must be a positive integer). :param page_size: Number of mail accounts to return (must be a positive integer lower or equal to 100). :param order_by: Sort order of mail accounts in the response. :param domain: Domain to filter the mail accounts. :return: List[MailAccount]

Usage:

result = api.list_mail_accounts_all(
    hosting_id="example",
)

remove_mail_account(*, hosting_id: str, domain: str, username: str, region: Optional[str] = None) → MailAccount

Delete a mail account within your hosting plan. :param hosting_id: UUID of the hosting plan. :param domain: Domain part of the mail account address. :param username: Username part of the mail account address. :param region: Region to target. If none is passed will use default region from the config. :return: MailAccount

Usage:

result = api.remove_mail_account(
    hosting_id="example",
    domain="example",
    username="example",
)

class scaleway.webhosting.v1.api.WebhostingV1OfferAPI(client: Client, *, bypass_validation: bool = False)

Bases: API

This API allows you to manage your offer for your Web Hosting services.

list_offers(*, region: Optional[str] = None, page: Optional[int] = None, page_size: Optional[int] = None, order_by: Optional[ListOffersRequestOrderBy] = None, hosting_id: Optional[str] = None, control_panels: Optional[List[str]] = None) → ListOffersResponse

List all available hosting offers along with their specific options. :param region: Region to target. If none is passed will use default region from the config. :param page: Page number (must be a positive integer). :param page_size: Number of websites to return (must be a positive integer lower or equal to 100). :param order_by: Sort order for Web Hosting offers in the response. :param hosting_id: UUID of the hosting plan. :param control_panels: Name of the control panel(s) to filter for. :return: ListOffersResponse

Usage:

result = api.list_offers()

list_offers_all(*, region: Optional[str] = None, page: Optional[int] = None, page_size: Optional[int] = None, order_by: Optional[ListOffersRequestOrderBy] = None, hosting_id: Optional[str] = None, control_panels: Optional[List[str]] = None) → List[Offer]

List all available hosting offers along with their specific options. :param region: Region to target. If none is passed will use default region from the config. :param page: Page number (must be a positive integer). :param page_size: Number of websites to return (must be a positive integer lower or equal to 100). :param order_by: Sort order for Web Hosting offers in the response. :param hosting_id: UUID of the hosting plan. :param control_panels: Name of the control panel(s) to filter for. :return: List[Offer]

Usage:

result = api.list_offers_all()

class scaleway.webhosting.v1.api.WebhostingV1WebsiteAPI(client: Client, *, bypass_validation: bool = False)

Bases: API

This API allows you to manage your websites for your Web Hosting services.

list_websites(*, hosting_id: str, region: Optional[str] = None, page: Optional[int] = None, page_size: Optional[int] = None, order_by: Optional[ListWebsitesRequestOrderBy] = None) → ListWebsitesResponse

List all websites for a specific hosting. :param hosting_id: UUID of the hosting plan. :param region: Region to target. If none is passed will use default region from the config. :param page: Page number (must be a positive integer). :param page_size: Number of websites to return (must be a positive integer lower or equal to 100). :param order_by: Sort order for Web Hosting websites in the response. :return: ListWebsitesResponse

Usage:

result = api.list_websites(
    hosting_id="example",
)

list_websites_all(*, hosting_id: str, region: Optional[str] = None, page: Optional[int] = None, page_size: Optional[int] = None, order_by: Optional[ListWebsitesRequestOrderBy] = None) → List[Website]

List all websites for a specific hosting. :param hosting_id: UUID of the hosting plan. :param region: Region to target. If none is passed will use default region from the config. :param page: Page number (must be a positive integer). :param page_size: Number of websites to return (must be a positive integer lower or equal to 100). :param order_by: Sort order for Web Hosting websites in the response. :return: List[Website]

Usage:

result = api.list_websites_all(
    hosting_id="example",
)

scaleway.webhosting.v1.content module

scaleway.webhosting.v1.content.DOMAIN_AVAILABILITY_TRANSIENT_STATUSES: List[DomainAvailabilityStatus] = [<DomainAvailabilityStatus.VALIDATING: 'validating'>]: Lists transient statutes of the enum DomainAvailabilityStatus.

scaleway.webhosting.v1.content.DOMAIN_TRANSIENT_STATUSES: List[DomainStatus] = [<DomainStatus.VALIDATING: 'validating'>]: Lists transient statutes of the enum DomainStatus.

scaleway.webhosting.v1.content.HOSTING_TRANSIENT_STATUSES: List[HostingStatus] = [<HostingStatus.DELIVERING: 'delivering'>, <HostingStatus.DELETING: 'deleting'>, <HostingStatus.MIGRATING: 'migrating'>]: Lists transient statutes of the enum HostingStatus.

scaleway.webhosting.v1.marshalling module

scaleway.webhosting.v1.marshalling.marshal_AutoConfigDomainDns(request: AutoConfigDomainDns, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.webhosting.v1.marshalling.marshal_CreateDatabaseRequestUser(request: CreateDatabaseRequestUser, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.webhosting.v1.marshalling.marshal_CreateHostingRequestDomainConfiguration(request: CreateHostingRequestDomainConfiguration, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.webhosting.v1.marshalling.marshal_DatabaseApiAssignDatabaseUserRequest(request: DatabaseApiAssignDatabaseUserRequest, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.webhosting.v1.marshalling.marshal_DatabaseApiChangeDatabaseUserPasswordRequest(request: DatabaseApiChangeDatabaseUserPasswordRequest, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.webhosting.v1.marshalling.marshal_DatabaseApiCreateDatabaseRequest(request: DatabaseApiCreateDatabaseRequest, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.webhosting.v1.marshalling.marshal_DatabaseApiCreateDatabaseUserRequest(request: DatabaseApiCreateDatabaseUserRequest, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.webhosting.v1.marshalling.marshal_DatabaseApiUnassignDatabaseUserRequest(request: DatabaseApiUnassignDatabaseUserRequest, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.webhosting.v1.marshalling.marshal_DnsApiCheckUserOwnsDomainRequest(request: DnsApiCheckUserOwnsDomainRequest, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.webhosting.v1.marshalling.marshal_DnsApiSyncDomainDnsRecordsRequest(request: DnsApiSyncDomainDnsRecordsRequest, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.webhosting.v1.marshalling.marshal_FtpAccountApiChangeFtpAccountPasswordRequest(request: FtpAccountApiChangeFtpAccountPasswordRequest, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.webhosting.v1.marshalling.marshal_FtpAccountApiCreateFtpAccountRequest(request: FtpAccountApiCreateFtpAccountRequest, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.webhosting.v1.marshalling.marshal_HostingApiCreateHostingRequest(request: HostingApiCreateHostingRequest, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.webhosting.v1.marshalling.marshal_HostingApiUpdateHostingRequest(request: HostingApiUpdateHostingRequest, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.webhosting.v1.marshalling.marshal_MailAccountApiChangeMailAccountPasswordRequest(request: MailAccountApiChangeMailAccountPasswordRequest, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.webhosting.v1.marshalling.marshal_MailAccountApiCreateMailAccountRequest(request: MailAccountApiCreateMailAccountRequest, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.webhosting.v1.marshalling.marshal_MailAccountApiRemoveMailAccountRequest(request: MailAccountApiRemoveMailAccountRequest, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.webhosting.v1.marshalling.marshal_OfferOptionRequest(request: OfferOptionRequest, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.webhosting.v1.marshalling.marshal_SyncDomainDnsRecordsRequestRecord(request: SyncDomainDnsRecordsRequestRecord, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.webhosting.v1.marshalling.unmarshal_AutoConfigDomainDns(data: Any) → AutoConfigDomainDns

scaleway.webhosting.v1.marshalling.unmarshal_CheckUserOwnsDomainResponse(data: Any) → CheckUserOwnsDomainResponse

scaleway.webhosting.v1.marshalling.unmarshal_ControlPanel(data: Any) → ControlPanel

scaleway.webhosting.v1.marshalling.unmarshal_Database(data: Any) → Database

scaleway.webhosting.v1.marshalling.unmarshal_DatabaseUser(data: Any) → DatabaseUser

scaleway.webhosting.v1.marshalling.unmarshal_DnsRecord(data: Any) → DnsRecord

scaleway.webhosting.v1.marshalling.unmarshal_DnsRecords(data: Any) → DnsRecords

scaleway.webhosting.v1.marshalling.unmarshal_Domain(data: Any) → Domain

scaleway.webhosting.v1.marshalling.unmarshal_DomainAvailability(data: Any) → DomainAvailability

scaleway.webhosting.v1.marshalling.unmarshal_FtpAccount(data: Any) → FtpAccount

scaleway.webhosting.v1.marshalling.unmarshal_Hosting(data: Any) → Hosting

scaleway.webhosting.v1.marshalling.unmarshal_HostingSummary(data: Any) → HostingSummary

scaleway.webhosting.v1.marshalling.unmarshal_HostingUser(data: Any) → HostingUser

scaleway.webhosting.v1.marshalling.unmarshal_ListControlPanelsResponse(data: Any) → ListControlPanelsResponse

scaleway.webhosting.v1.marshalling.unmarshal_ListDatabaseUsersResponse(data: Any) → ListDatabaseUsersResponse

scaleway.webhosting.v1.marshalling.unmarshal_ListDatabasesResponse(data: Any) → ListDatabasesResponse

scaleway.webhosting.v1.marshalling.unmarshal_ListFtpAccountsResponse(data: Any) → ListFtpAccountsResponse

scaleway.webhosting.v1.marshalling.unmarshal_ListHostingsResponse(data: Any) → ListHostingsResponse

scaleway.webhosting.v1.marshalling.unmarshal_ListMailAccountsResponse(data: Any) → ListMailAccountsResponse

scaleway.webhosting.v1.marshalling.unmarshal_ListOffersResponse(data: Any) → ListOffersResponse

scaleway.webhosting.v1.marshalling.unmarshal_ListWebsitesResponse(data: Any) → ListWebsitesResponse

scaleway.webhosting.v1.marshalling.unmarshal_MailAccount(data: Any) → MailAccount

scaleway.webhosting.v1.marshalling.unmarshal_Nameserver(data: Any) → Nameserver

scaleway.webhosting.v1.marshalling.unmarshal_Offer(data: Any) → Offer

scaleway.webhosting.v1.marshalling.unmarshal_OfferOption(data: Any) → OfferOption

scaleway.webhosting.v1.marshalling.unmarshal_Platform(data: Any) → Platform

scaleway.webhosting.v1.marshalling.unmarshal_PlatformControlPanel(data: Any) → PlatformControlPanel

scaleway.webhosting.v1.marshalling.unmarshal_PlatformControlPanelUrls(data: Any) → PlatformControlPanelUrls

scaleway.webhosting.v1.marshalling.unmarshal_ResetHostingPasswordResponse(data: Any) → ResetHostingPasswordResponse

scaleway.webhosting.v1.marshalling.unmarshal_ResourceSummary(data: Any) → ResourceSummary

scaleway.webhosting.v1.marshalling.unmarshal_SearchDomainsResponse(data: Any) → SearchDomainsResponse

scaleway.webhosting.v1.marshalling.unmarshal_Session(data: Any) → Session

scaleway.webhosting.v1.marshalling.unmarshal_Website(data: Any) → Website

scaleway.webhosting.v1.types module

class scaleway.webhosting.v1.types.AutoConfigDomainDns(nameservers: 'bool', web_records: 'bool', mail_records: 'bool', all_records: 'bool', none: 'bool')

Bases: object

all_records: bool: Whether or not to synchronize all types of records. Takes priority over the other fields.

mail_records: bool: Whether or not to synchronize mail records.

nameservers: bool: Whether or not to synchronize domain nameservers.

none: bool: No automatic domain configuration. Users must configure their domain for the Web Hosting to work.

web_records: bool: Whether or not to synchronize web records.

class scaleway.webhosting.v1.types.CheckUserOwnsDomainResponse(owns_domain: 'bool')

Bases: object

owns_domain: bool: Indicates whether the specified project owns the domain.

class scaleway.webhosting.v1.types.ControlPanel(name: 'str', available: 'bool', logo_url: 'str', available_languages: 'List[StdLanguageCode]')

Bases: object

available: bool: Define if the control panel type is available to order.

available_languages: List[LanguageCode]: List of available languages for the control panel.

logo_url: str: URL of the control panel’s logo.

name: str: Control panel name.

class scaleway.webhosting.v1.types.ControlPanelApiListControlPanelsRequest(region: 'Optional[ScwRegion]', page: 'Optional[int]', page_size: 'Optional[int]')

Bases: object

page: Optional[int]: Page number (must be a positive integer).

page_size: Optional[int]: Number of control panels to return (must be a positive integer lower or equal to 100).

region: Optional[str]: Region to target. If none is passed will use default region from the config.

class scaleway.webhosting.v1.types.CreateDatabaseRequestUser(username: 'str', password: 'str')

Bases: object

password: str

username: str

class scaleway.webhosting.v1.types.CreateHostingRequestDomainConfiguration(update_nameservers: 'bool', update_web_record: 'bool', update_mail_record: 'bool', update_all_records: 'bool')

Bases: object

update_all_records: bool

update_mail_record: bool

update_nameservers: bool

update_web_record: bool

class scaleway.webhosting.v1.types.Database(database_name: 'str', users: 'List[str]')

Bases: object

database_name: str: Name of the database.

users: List[str]: List of users who have access to the database.

class scaleway.webhosting.v1.types.DatabaseApiAssignDatabaseUserRequest(hosting_id: 'str', username: 'str', database_name: 'str', region: 'Optional[ScwRegion]')

Bases: object

database_name: str: Name of the database to be assigned.

hosting_id: str: UUID of the hosting plan.

region: Optional[str]: Region to target. If none is passed will use default region from the config.

username: str: Name of the user to assign.

class scaleway.webhosting.v1.types.DatabaseApiChangeDatabaseUserPasswordRequest(hosting_id: 'str', username: 'str', password: 'str', region: 'Optional[ScwRegion]')

Bases: object

hosting_id: str: UUID of the hosting plan.

password: str: New password.

region: Optional[str]: Region to target. If none is passed will use default region from the config.

username: str: Name of the user to update.

class scaleway.webhosting.v1.types.DatabaseApiCreateDatabaseRequest(hosting_id: 'str', database_name: 'str', region: 'Optional[ScwRegion]', new_user: 'Optional[CreateDatabaseRequestUser]', existing_username: 'Optional[str]')

Bases: object

database_name: str: Name of the database to be created.

existing_username: Optional[str]

hosting_id: str: UUID of the hosting plan where the database will be created.

new_user: Optional[CreateDatabaseRequestUser]

region: Optional[str]: Region to target. If none is passed will use default region from the config.

class scaleway.webhosting.v1.types.DatabaseApiCreateDatabaseUserRequest(hosting_id: 'str', username: 'str', password: 'str', region: 'Optional[ScwRegion]')

Bases: object

hosting_id: str: UUID of the hosting plan.

password: str: Password of the user to create.

region: Optional[str]: Region to target. If none is passed will use default region from the config.

username: str: Name of the user to create.

class scaleway.webhosting.v1.types.DatabaseApiDeleteDatabaseRequest(hosting_id: 'str', database_name: 'str', region: 'Optional[ScwRegion]')

Bases: object

database_name: str: Name of the database to delete.

hosting_id: str: UUID of the hosting plan.

region: Optional[str]: Region to target. If none is passed will use default region from the config.

class scaleway.webhosting.v1.types.DatabaseApiDeleteDatabaseUserRequest(hosting_id: 'str', username: 'str', region: 'Optional[ScwRegion]')

Bases: object

hosting_id: str: UUID of the hosting plan.

region: Optional[str]: Region to target. If none is passed will use default region from the config.

username: str: Name of the database user to delete.

class scaleway.webhosting.v1.types.DatabaseApiGetDatabaseRequest(hosting_id: 'str', database_name: 'str', region: 'Optional[ScwRegion]')

Bases: object

database_name: str: Name of the database.

hosting_id: str: UUID of the hosting plan.

region: Optional[str]: Region to target. If none is passed will use default region from the config.

class scaleway.webhosting.v1.types.DatabaseApiGetDatabaseUserRequest(hosting_id: 'str', username: 'str', region: 'Optional[ScwRegion]')

Bases: object

hosting_id: str: UUID of the hosting plan.

region: Optional[str]: Region to target. If none is passed will use default region from the config.

username: str: Name of the database user to retrieve details.

class scaleway.webhosting.v1.types.DatabaseApiListDatabaseUsersRequest(hosting_id: 'str', region: 'Optional[ScwRegion]', page: 'Optional[int]', page_size: 'Optional[int]', order_by: 'Optional[ListDatabaseUsersRequestOrderBy]')

Bases: object

hosting_id: str: UUID of the hosting plan.

order_by: Optional[ListDatabaseUsersRequestOrderBy]: Sort order of database users in the response.

page: Optional[int]: Page number (must be a positive integer).

page_size: Optional[int]: Number of database users to return (must be a positive integer lower or equal to 100).

region: Optional[str]: Region to target. If none is passed will use default region from the config.

class scaleway.webhosting.v1.types.DatabaseApiListDatabasesRequest(hosting_id: 'str', region: 'Optional[ScwRegion]', page: 'Optional[int]', page_size: 'Optional[int]', order_by: 'Optional[ListDatabasesRequestOrderBy]')

Bases: object

hosting_id: str: UUID of the hosting plan.

order_by: Optional[ListDatabasesRequestOrderBy]: Sort order of databases in the response.

page: Optional[int]: Page number (must be a positive integer).

page_size: Optional[int]: Number of databases to return (must be a positive integer lower or equal to 100).

region: Optional[str]: Region to target. If none is passed will use default region from the config.

class scaleway.webhosting.v1.types.DatabaseApiUnassignDatabaseUserRequest(hosting_id: 'str', username: 'str', database_name: 'str', region: 'Optional[ScwRegion]')

Bases: object

database_name: str: Name of the database to be unassigned.

hosting_id: str: UUID of the hosting plan.

region: Optional[str]: Region to target. If none is passed will use default region from the config.

username: str: Name of the user to unassign.

class scaleway.webhosting.v1.types.DatabaseUser(username: 'str', databases: 'List[str]')

Bases: object

databases: List[str]: List of databases accessible by the user.

username: str: Name of the database user.

class scaleway.webhosting.v1.types.DnsApiCheckUserOwnsDomainRequest(domain: 'str', region: 'Optional[ScwRegion]', project_id: 'Optional[str]')

Bases: object

domain: str: Domain for which ownership is to be verified.

project_id: Optional[str]: ID of the project currently in use.

region: Optional[str]: Region to target. If none is passed will use default region from the config.

class scaleway.webhosting.v1.types.DnsApiGetDomainDnsRecordsRequest(domain: 'str', region: 'Optional[ScwRegion]')

Bases: object

domain: str: Domain associated with the DNS records.

region: Optional[str]: Region to target. If none is passed will use default region from the config.

class scaleway.webhosting.v1.types.DnsApiGetDomainRequest(domain_name: 'str', region: 'Optional[ScwRegion]', project_id: 'Optional[str]')

Bases: object

domain_name: str: Domain name to get.

project_id: Optional[str]: ID of the Scaleway Project in which to get the domain to create the Web Hosting plan.

region: Optional[str]: Region to target. If none is passed will use default region from the config.

class scaleway.webhosting.v1.types.DnsApiSearchDomainsRequest(domain_name: 'str', region: 'Optional[ScwRegion]', project_id: 'Optional[str]')

Bases: object

domain_name: str: Domain name to search.

project_id: Optional[str]: ID of the Scaleway Project in which to search the domain to create the Web Hosting plan.

region: Optional[str]: Region to target. If none is passed will use default region from the config.

class scaleway.webhosting.v1.types.DnsApiSyncDomainDnsRecordsRequest(domain: 'str', region: 'Optional[ScwRegion]', update_web_records: 'Optional[bool]', update_mail_records: 'Optional[bool]', update_all_records: 'Optional[bool]', update_nameservers: 'Optional[bool]', custom_records: 'Optional[List[SyncDomainDnsRecordsRequestRecord]]', auto_config_domain_dns: 'Optional[AutoConfigDomainDns]')

Bases: object

auto_config_domain_dns: Optional[AutoConfigDomainDns]: Whether or not to synchronize each types of records.

custom_records: Optional[List[SyncDomainDnsRecordsRequestRecord]]: Custom records to synchronize.

domain: str: Domain for which the DNS records will be synchronized.

region: Optional[str]: Region to target. If none is passed will use default region from the config.

update_all_records: Optional[bool]: Whether or not to synchronize all types of records. This one has priority (deprecated, use auto_config_domain_dns).

update_mail_records: Optional[bool]: Whether or not to synchronize the mail records (deprecated, use auto_config_domain_dns).

update_nameservers: Optional[bool]: Whether or not to synchronize domain nameservers (deprecated, use auto_config_domain_dns).

update_web_records: Optional[bool]: Whether or not to synchronize the web records (deprecated, use auto_config_domain_dns).

class scaleway.webhosting.v1.types.DnsRecord(name: 'str', type_: 'DnsRecordType', ttl: 'int', value: 'str', status: 'DnsRecordStatus', raw_data: 'str', priority: 'Optional[int]')

Bases: object

name: str: Record name.

priority: Optional[int]: Record priority level.

raw_data: str: Record representation as it appears in the zone file or DNS management system.

status: DnsRecordStatus: Record status.

ttl: int: Record time-to-live.

type_: DnsRecordType: Record type.

value: str: Record value.

class scaleway.webhosting.v1.types.DnsRecordStatus(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

INVALID = 'invalid'

UNKNOWN_STATUS = 'unknown_status'

VALID = 'valid'

class scaleway.webhosting.v1.types.DnsRecordType(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

A = 'a'

AAAA = 'aaaa'

CNAME = 'cname'

MX = 'mx'

NS = 'ns'

TXT = 'txt'

UNKNOWN_TYPE = 'unknown_type'

class scaleway.webhosting.v1.types.DnsRecords(records: 'List[DnsRecord]', name_servers: 'List[Nameserver]', status: 'DnsRecordsStatus', dns_config: 'Optional[List[DomainDnsAction]]', auto_config_domain_dns: 'Optional[AutoConfigDomainDns]')

Bases: object

auto_config_domain_dns: Optional[AutoConfigDomainDns]: Whether or not to synchronize each types of records.

dns_config: Optional[List[DomainDnsAction]]: Records dns auto configuration settings (deprecated, use auto_config_domain_dns).

name_servers: List[Nameserver]: List of nameservers.

records: List[DnsRecord]: List of DNS records.

status: DnsRecordsStatus: Status of the records.

class scaleway.webhosting.v1.types.DnsRecordsStatus(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

INVALID = 'invalid'

UNKNOWN_STATUS = 'unknown_status'

VALID = 'valid'

class scaleway.webhosting.v1.types.Domain(name: 'str', status: 'DomainStatus', owner: 'DomainZoneOwner', available_actions: 'List[DomainAction]', available_dns_actions: 'Optional[List[DomainDnsAction]]', auto_config_domain_dns: 'Optional[AutoConfigDomainDns]')

Bases: object

auto_config_domain_dns: Optional[AutoConfigDomainDns]: Whether or not to synchronize each type of record.

available_actions: List[DomainAction]: A list of actions that can be performed on the domain.

available_dns_actions: Optional[List[DomainDnsAction]]: A list of DNS-related actions that can be auto configured for the domain (deprecated, use auto_config_domain_dns instead).

name: str: Name of the domain.

owner: DomainZoneOwner: Zone owner of the domain.

status: DomainStatus: Current status of the domain.

class scaleway.webhosting.v1.types.DomainAction(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

MANAGE_EXTERNAL = 'manage_external'

RENEW = 'renew'

TRANSFER = 'transfer'

UNKNOWN_ACTION = 'unknown_action'

class scaleway.webhosting.v1.types.DomainAvailability(name: 'str', zone_name: 'str', status: 'DomainAvailabilityStatus', available_actions: 'List[DomainAvailabilityAction]', can_create_hosting: 'bool', price: 'Optional[Money]')

Bases: object

available_actions: List[DomainAvailabilityAction]: A list of actions that can be performed on the domain.

can_create_hosting: bool: Whether a hosting can be created for this domain.

name: str: Fully qualified domain name (FQDN).

price: Optional[Money]: Price for registering the domain.

status: DomainAvailabilityStatus: Availability status of the domain.

zone_name: str: DNS zone associated with the domain.

class scaleway.webhosting.v1.types.DomainAvailabilityAction(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

MANAGE_EXTERNAL = 'manage_external'

REGISTER = 'register'

TRANSFER = 'transfer'

UNKNOWN_ACTION = 'unknown_action'

class scaleway.webhosting.v1.types.DomainAvailabilityStatus(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

AVAILABLE = 'available'

ERROR = 'error'

NOT_AVAILABLE = 'not_available'

OWNED = 'owned'

UNKNOWN_STATUS = 'unknown_status'

VALIDATING = 'validating'

class scaleway.webhosting.v1.types.DomainDnsAction(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

AUTO_CONFIG_ALL_RECORDS = 'auto_config_all_records'

AUTO_CONFIG_MAIL_RECORDS = 'auto_config_mail_records'

AUTO_CONFIG_NAMESERVERS = 'auto_config_nameservers'

AUTO_CONFIG_NONE = 'auto_config_none'

AUTO_CONFIG_WEB_RECORDS = 'auto_config_web_records'

UNKNOWN_DNS_ACTION = 'unknown_dns_action'

class scaleway.webhosting.v1.types.DomainStatus(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

ERROR = 'error'

INVALID = 'invalid'

UNKNOWN_STATUS = 'unknown_status'

VALID = 'valid'

VALIDATING = 'validating'

class scaleway.webhosting.v1.types.DomainZoneOwner(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

EXTERNAL = 'external'

ONLINE = 'online'

SCALEWAY = 'scaleway'

UNKNOWN_ZONE_OWNER = 'unknown_zone_owner'

WEBHOSTING = 'webhosting'

class scaleway.webhosting.v1.types.FtpAccount(username: 'str', path: 'str')

Bases: object

path: str: The path associated with the FTP account.

username: str: The username of the FTP account.

class scaleway.webhosting.v1.types.FtpAccountApiChangeFtpAccountPasswordRequest(hosting_id: 'str', username: 'str', password: 'str', region: 'Optional[ScwRegion]')

Bases: object

hosting_id: str: UUID of the hosting plan.

password: str: New password for the FTP account.

region: Optional[str]: Region to target. If none is passed will use default region from the config.

username: str: Username of the FTP account.

class scaleway.webhosting.v1.types.FtpAccountApiCreateFtpAccountRequest(hosting_id: 'str', username: 'str', path: 'str', password: 'str', region: 'Optional[ScwRegion]')

Bases: object

hosting_id: str: UUID of the hosting plan.

password: str: Password for the new FTP account.

path: str: Path for the new FTP account.

region: Optional[str]: Region to target. If none is passed will use default region from the config.

username: str: Username for the new FTP account.

class scaleway.webhosting.v1.types.FtpAccountApiListFtpAccountsRequest(hosting_id: 'str', region: 'Optional[ScwRegion]', page: 'Optional[int]', page_size: 'Optional[int]', order_by: 'Optional[ListFtpAccountsRequestOrderBy]', domain: 'Optional[str]')

Bases: object

domain: Optional[str]: Domain to filter the FTP accounts.

hosting_id: str: UUID of the hosting plan.

order_by: Optional[ListFtpAccountsRequestOrderBy]: Sort order of FTP accounts in the response.

page: Optional[int]: Page number (must be a positive integer).

page_size: Optional[int]: Number of FTP accounts to return (must be a positive integer lower or equal to 100).

region: Optional[str]: Region to target. If none is passed will use default region from the config.

class scaleway.webhosting.v1.types.FtpAccountApiRemoveFtpAccountRequest(hosting_id: 'str', username: 'str', region: 'Optional[ScwRegion]')

Bases: object

hosting_id: str: UUID of the hosting plan.

region: Optional[str]: Region to target. If none is passed will use default region from the config.

username: str: Username of the FTP account to be deleted.

class scaleway.webhosting.v1.types.Hosting(id: 'str', project_id: 'str', status: 'HostingStatus', domain: 'str', tags: 'List[str]', ipv4: 'str', updated_at: 'Optional[datetime]', created_at: 'Optional[datetime]', protected: 'bool', domain_status: 'DomainStatus', region: 'ScwRegion', offer: 'Optional[Offer]', platform: 'Optional[Platform]', dns_status: 'Optional[DnsRecordsStatus]', user: 'Optional[HostingUser]')

Bases: object

created_at: Optional[datetime]: Date on which the Web Hosting plan was created.

dns_status: Optional[DnsRecordsStatus]: DNS status of the Web Hosting plan.

domain: str: Main domain associated with the Web Hosting plan.

domain_status: DomainStatus: Main domain status of the Web Hosting plan.

id: str: ID of the Web Hosting plan.

ipv4: str: Current IPv4 address of the hosting.

offer: Optional[Offer]: Details of the Web Hosting plan offer and options.

platform: Optional[Platform]: Details of the hosting platform.

project_id: str: ID of the Scaleway Project the Web Hosting plan belongs to.

protected: bool: Whether the hosting is protected or not.

region: str: Region where the Web Hosting plan is hosted.

status: HostingStatus: Status of the Web Hosting plan.

tags: List[str]: List of tags associated with the Web Hosting plan.

updated_at: Optional[datetime]: Date on which the Web Hosting plan was last updated.

user: Optional[HostingUser]: Details of the hosting user.

class scaleway.webhosting.v1.types.HostingApiCreateHostingRequest(offer_id: 'str', email: 'str', domain: 'str', region: 'Optional[ScwRegion]', project_id: 'Optional[str]', tags: 'Optional[List[str]]', offer_options: 'Optional[List[OfferOptionRequest]]', language: 'Optional[StdLanguageCode]', domain_configuration: 'Optional[CreateHostingRequestDomainConfiguration]', skip_welcome_email: 'Optional[bool]', auto_config_domain_dns: 'Optional[AutoConfigDomainDns]')

Bases: object

auto_config_domain_dns: Optional[AutoConfigDomainDns]: Indicates whether to update hosting domain name servers and DNS records for domains managed by Scaleway Elements (deprecated, use auto_update_* fields instead).

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

domain_configuration: Optional[CreateHostingRequestDomainConfiguration]: Indicates whether to update hosting domain name servers and DNS records for domains managed by Scaleway Elements (deprecated, use auto_config_domain_dns instead).

email: str: Contact email for the Web Hosting client.

language: Optional[LanguageCode]: Default language for the control panel interface.

offer_id: str: ID of the selected offer for the Web Hosting plan.

offer_options: Optional[List[OfferOptionRequest]]: List of the Web Hosting plan options IDs with their quantities.

project_id: Optional[str]: ID of the Scaleway Project in which to create the Web Hosting plan.

region: Optional[str]: Region to target. If none is passed will use default region from the config.

skip_welcome_email: Optional[bool]: Indicates whether to skip a welcome email to the contact email containing hosting info.

tags: Optional[List[str]]: List of tags for the Web Hosting plan.

class scaleway.webhosting.v1.types.HostingApiCreateSessionRequest(hosting_id: 'str', region: 'Optional[ScwRegion]')

Bases: object

hosting_id: str: Hosting ID.

region: Optional[str]: Region to target. If none is passed will use default region from the config.

class scaleway.webhosting.v1.types.HostingApiDeleteHostingRequest(hosting_id: 'str', region: 'Optional[ScwRegion]')

Bases: object

hosting_id: str: Hosting ID.

region: Optional[str]: Region to target. If none is passed will use default region from the config.

class scaleway.webhosting.v1.types.HostingApiGetHostingRequest(hosting_id: 'str', region: 'Optional[ScwRegion]')

Bases: object

hosting_id: str: Hosting ID.

region: Optional[str]: Region to target. If none is passed will use default region from the config.

class scaleway.webhosting.v1.types.HostingApiGetResourceSummaryRequest(hosting_id: 'str', region: 'Optional[ScwRegion]')

Bases: object

hosting_id: str: Hosting ID.

region: Optional[str]: Region to target. If none is passed will use default region from the config.

class scaleway.webhosting.v1.types.HostingApiListHostingsRequest(region: 'Optional[ScwRegion]', page: 'Optional[int]', page_size: 'Optional[int]', order_by: 'Optional[ListHostingsRequestOrderBy]', tags: 'Optional[List[str]]', statuses: 'Optional[List[HostingStatus]]', domain: 'Optional[str]', project_id: 'Optional[str]', organization_id: 'Optional[str]', control_panels: 'Optional[List[str]]')

Bases: object

control_panels: Optional[List[str]]: Name of the control panel to filter for, only Web Hosting plans from this control panel will be returned.

domain: Optional[str]: Domain to filter for, only Web Hosting plans associated with this domain will be returned.

order_by: Optional[ListHostingsRequestOrderBy]: Sort order for Web Hosting plans in the response.

organization_id: Optional[str]: Organization ID to filter for, only Web Hosting plans from this Organization will be returned.

page: Optional[int]: Page number to return, from the paginated results (must be a positive integer).

page_size: Optional[int]: Number of Web Hosting plans to return (must be a positive integer lower or equal to 100).

project_id: Optional[str]: Project ID to filter for, only Web Hosting plans from this Project will be returned.

region: Optional[str]: Region to target. If none is passed will use default region from the config.

statuses: Optional[List[HostingStatus]]: Statuses to filter for, only Web Hosting plans with matching statuses will be returned.

tags: Optional[List[str]]: Tags to filter for, only Web Hosting plans with matching tags will be returned.

class scaleway.webhosting.v1.types.HostingApiResetHostingPasswordRequest(hosting_id: 'str', region: 'Optional[ScwRegion]')

Bases: object

hosting_id: str: UUID of the hosting.

region: Optional[str]: Region to target. If none is passed will use default region from the config.

class scaleway.webhosting.v1.types.HostingApiUpdateHostingRequest(hosting_id: 'str', region: 'Optional[ScwRegion]', email: 'Optional[str]', tags: 'Optional[List[str]]', offer_options: 'Optional[List[OfferOptionRequest]]', offer_id: 'Optional[str]', protected: 'Optional[bool]')

Bases: object

email: Optional[str]: New contact email for the Web Hosting plan.

hosting_id: str: Hosting ID.

offer_id: Optional[str]: ID of the new offer for the Web Hosting plan.

offer_options: Optional[List[OfferOptionRequest]]: List of the Web Hosting plan options IDs with their quantities.

protected: Optional[bool]: Whether the hosting is protected or not.

region: Optional[str]: Region to target. If none is passed will use default region from the config.

tags: Optional[List[str]]: New tags for the Web Hosting plan.

class scaleway.webhosting.v1.types.HostingStatus(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

DELETING = 'deleting'

DELIVERING = 'delivering'

ERROR = 'error'

LOCKED = 'locked'

MIGRATING = 'migrating'

READY = 'ready'

UNKNOWN_STATUS = 'unknown_status'

class scaleway.webhosting.v1.types.HostingSummary(id: 'str', project_id: 'str', status: 'HostingStatus', domain: 'str', protected: 'bool', offer_name: 'str', domain_status: 'DomainStatus', region: 'ScwRegion', created_at: 'Optional[datetime]', updated_at: 'Optional[datetime]', dns_status: 'Optional[DnsRecordsStatus]')

Bases: object

created_at: Optional[datetime]: Date on which the Web Hosting plan was created.

dns_status: Optional[DnsRecordsStatus]: DNS status of the Web Hosting plan.

domain: str: Main domain associated with the Web Hosting plan.

domain_status: DomainStatus: Main domain status of the Web Hosting plan.

id: str: ID of the Web Hosting plan.

offer_name: str: Name of the active offer for the Web Hosting plan.

project_id: str: ID of the Scaleway Project the Web Hosting plan belongs to.

protected: bool: Whether the hosting is protected or not.

region: str: Region where the Web Hosting plan is hosted.

status: HostingStatus: Status of the Web Hosting plan.

updated_at: Optional[datetime]: Date on which the Web Hosting plan was last updated.

class scaleway.webhosting.v1.types.HostingUser(username: 'str', contact_email: 'str', one_time_password: 'Optional[str]')

Bases: object

contact_email: str: Contact email used for the hosting.

one_time_password: Optional[str]: One-time-password used for the first login or reset password, empty after first use.

username: str: Main Web Hosting cPanel username.

class scaleway.webhosting.v1.types.ListControlPanelsResponse(total_count: 'int', control_panels: 'List[ControlPanel]')

Bases: object

control_panels: List[ControlPanel]: List of control panels.

total_count: int: Number of control panels returned.

class scaleway.webhosting.v1.types.ListDatabaseUsersRequestOrderBy(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

USERNAME_ASC = 'username_asc'

USERNAME_DESC = 'username_desc'

class scaleway.webhosting.v1.types.ListDatabaseUsersResponse(total_count: 'int', users: 'List[DatabaseUser]')

Bases: object

total_count: int: Total number of database users.

users: List[DatabaseUser]: List of database users.

class scaleway.webhosting.v1.types.ListDatabasesRequestOrderBy(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

DATABASE_NAME_ASC = 'database_name_asc'

DATABASE_NAME_DESC = 'database_name_desc'

class scaleway.webhosting.v1.types.ListDatabasesResponse(total_count: 'int', databases: 'List[Database]')

Bases: object

databases: List[Database]: List of databases.

total_count: int: Total number of databases.

class scaleway.webhosting.v1.types.ListFtpAccountsRequestOrderBy(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

USERNAME_ASC = 'username_asc'

USERNAME_DESC = 'username_desc'

class scaleway.webhosting.v1.types.ListFtpAccountsResponse(total_count: 'int', ftp_accounts: 'List[FtpAccount]')

Bases: object

ftp_accounts: List[FtpAccount]: List of FTP accounts.

total_count: int: Total number of FTP accounts.

class scaleway.webhosting.v1.types.ListHostingsRequestOrderBy(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

CREATED_AT_ASC = 'created_at_asc'

CREATED_AT_DESC = 'created_at_desc'

class scaleway.webhosting.v1.types.ListHostingsResponse(total_count: 'int', hostings: 'List[HostingSummary]')

Bases: object

hostings: List[HostingSummary]: List of Web Hosting plans.

total_count: int: Number of Web Hosting plans returned.

class scaleway.webhosting.v1.types.ListMailAccountsRequestOrderBy(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

DOMAIN_ASC = 'domain_asc'

DOMAIN_DESC = 'domain_desc'

USERNAME_ASC = 'username_asc'

USERNAME_DESC = 'username_desc'

class scaleway.webhosting.v1.types.ListMailAccountsResponse(total_count: 'int', mail_accounts: 'List[MailAccount]')

Bases: object

mail_accounts: List[MailAccount]: List of mail accounts.

total_count: int: Total number of mail accounts.

class scaleway.webhosting.v1.types.ListOffersRequestOrderBy(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

PRICE_ASC = 'price_asc'

class scaleway.webhosting.v1.types.ListOffersResponse(total_count: 'int', offers: 'List[Offer]')

Bases: object

offers: List[Offer]: List of offers.

total_count: int: Total number of offers.

class scaleway.webhosting.v1.types.ListWebsitesRequestOrderBy(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

DOMAIN_ASC = 'domain_asc'

DOMAIN_DESC = 'domain_desc'

class scaleway.webhosting.v1.types.ListWebsitesResponse(total_count: 'int', websites: 'List[Website]')

Bases: object

total_count: int: Total number of websites.

websites: List[Website]: List of websites.

class scaleway.webhosting.v1.types.MailAccount(domain: 'str', username: 'str')

Bases: object

domain: str: Domain part of the mail account address.

username: str: Username part address of the mail account address.

class scaleway.webhosting.v1.types.MailAccountApiChangeMailAccountPasswordRequest(hosting_id: 'str', domain: 'str', username: 'str', password: 'str', region: 'Optional[ScwRegion]')

Bases: object

domain: str: Domain part of the mail account address.

hosting_id: str: UUID of the hosting plan.

password: str: New password for the mail account.

region: Optional[str]: Region to target. If none is passed will use default region from the config.

username: str: Username part of the mail account address.

class scaleway.webhosting.v1.types.MailAccountApiCreateMailAccountRequest(hosting_id: 'str', domain: 'str', username: 'str', password: 'str', region: 'Optional[ScwRegion]')

Bases: object

domain: str: Domain part of the mail account address.

hosting_id: str: UUID of the hosting plan.

password: str: Password for the new mail account.

region: Optional[str]: Region to target. If none is passed will use default region from the config.

username: str: Username part address of the mail account address.

class scaleway.webhosting.v1.types.MailAccountApiListMailAccountsRequest(hosting_id: 'str', region: 'Optional[ScwRegion]', page: 'Optional[int]', page_size: 'Optional[int]', order_by: 'Optional[ListMailAccountsRequestOrderBy]', domain: 'Optional[str]')

Bases: object

domain: Optional[str]: Domain to filter the mail accounts.

hosting_id: str: UUID of the hosting plan.

order_by: Optional[ListMailAccountsRequestOrderBy]: Sort order of mail accounts in the response.

page: Optional[int]: Page number (must be a positive integer).

page_size: Optional[int]: Number of mail accounts to return (must be a positive integer lower or equal to 100).

region: Optional[str]: Region to target. If none is passed will use default region from the config.

class scaleway.webhosting.v1.types.MailAccountApiRemoveMailAccountRequest(hosting_id: 'str', domain: 'str', username: 'str', region: 'Optional[ScwRegion]')

Bases: object

domain: str: Domain part of the mail account address.

hosting_id: str: UUID of the hosting plan.

region: Optional[str]: Region to target. If none is passed will use default region from the config.

username: str: Username part of the mail account address.

class scaleway.webhosting.v1.types.Nameserver(hostname: 'str', status: 'NameserverStatus', is_default: 'bool')

Bases: object

hostname: str: Hostname of the nameserver.

is_default: bool: Defines whether the nameserver is the default one.

status: NameserverStatus: Status of the nameserver.

class scaleway.webhosting.v1.types.NameserverStatus(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

INVALID = 'invalid'

UNKNOWN_STATUS = 'unknown_status'

VALID = 'valid'

class scaleway.webhosting.v1.types.Offer(id: 'str', name: 'str', billing_operation_path: 'str', options: 'List[OfferOption]', available: 'bool', control_panel_name: 'str', end_of_life: 'bool', quota_warning: 'OfferOptionWarning', price: 'Optional[Money]')

Bases: object

available: bool: If a hosting_id was specified in the call, defines whether the offer is available for a specified hosting plan to migrate (update) to.

billing_operation_path: str: Unique identifier used for billing.

control_panel_name: str: Name of the control panel.

end_of_life: bool: Indicates if the offer has reached its end of life.

id: str: Offer ID.

name: str: Offer name.

options: List[OfferOption]: Options available for the offer.

price: Optional[Money]: Price of the offer.

quota_warning: OfferOptionWarning: Defines a warning if the maximum value for an option in the offer is exceeded.

class scaleway.webhosting.v1.types.OfferApiListOffersRequest(region: 'Optional[ScwRegion]', page: 'Optional[int]', page_size: 'Optional[int]', order_by: 'Optional[ListOffersRequestOrderBy]', hosting_id: 'Optional[str]', control_panels: 'Optional[List[str]]')

Bases: object

control_panels: Optional[List[str]]: Name of the control panel(s) to filter for.

hosting_id: Optional[str]: UUID of the hosting plan.

order_by: Optional[ListOffersRequestOrderBy]: Sort order for Web Hosting offers in the response.

page: Optional[int]: Page number (must be a positive integer).

page_size: Optional[int]: Number of websites to return (must be a positive integer lower or equal to 100).

region: Optional[str]: Region to target. If none is passed will use default region from the config.

class scaleway.webhosting.v1.types.OfferOption(id: 'str', name: 'OfferOptionName', billing_operation_path: 'str', min_value: 'int', current_value: 'int', max_value: 'int', quota_warning: 'OfferOptionWarning', price: 'Optional[Money]')

Bases: object

billing_operation_path: str: Unique identifier used for billing.

current_value: int: If a hosting_id was specified in the call, defines the current value of the option in the hosting.

id: str: Option ID.

max_value: int: Maximum value for the option in the offer.

min_value: int: Minimum value for the option in the offer.

name: OfferOptionName: Name of the option.

price: Optional[Money]: Price of the option for 1 value.

quota_warning: OfferOptionWarning: Defines a warning if the maximum value for the option has been reached.

class scaleway.webhosting.v1.types.OfferOptionName(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

BACKUP = 'backup'

DATABASE_COUNT = 'database_count'

DEDICATED_IP = 'dedicated_ip'

DOMAIN_COUNT = 'domain_count'

EMAIL_COUNT = 'email_count'

EMAIL_STORAGE_GB = 'email_storage_gb'

RAM_GB = 'ram_gb'

STORAGE_GB = 'storage_gb'

SUPPORT = 'support'

UNKNOWN_NAME = 'unknown_name'

VCPU_COUNT = 'vcpu_count'

class scaleway.webhosting.v1.types.OfferOptionRequest(id: 'str', quantity: 'int')

Bases: object

id: str: Offer option ID.

quantity: int: The option requested quantity to set for the Web Hosting plan.

class scaleway.webhosting.v1.types.OfferOptionWarning(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

QUOTA_EXCEEDED_WARNING = 'quota_exceeded_warning'

UNKNOWN_WARNING = 'unknown_warning'

USAGE_LOW_WARNING = 'usage_low_warning'

class scaleway.webhosting.v1.types.Platform(hostname: 'str', number: 'int', group_name: 'PlatformPlatformGroup', ipv4: 'str', ipv6: 'str', control_panel: 'Optional[PlatformControlPanel]')

Bases: object

control_panel: Optional[PlatformControlPanel]: Details of the platform control panel.

group_name: PlatformPlatformGroup: Group name of the hosting’s host platform.

hostname: str: Hostname of the host platform.

ipv4: str: IPv4 address of the hosting’s host platform.

ipv6: str: IPv6 address of the hosting’s host platform.

number: int: Number of the host platform.

class scaleway.webhosting.v1.types.PlatformControlPanel(name: 'str', urls: 'Optional[PlatformControlPanelUrls]')

Bases: object

name: str: Name of the control panel.

urls: Optional[PlatformControlPanelUrls]: URL to connect to cPanel dashboard and to Webmail interface.

class scaleway.webhosting.v1.types.PlatformControlPanelUrls(dashboard: 'str', webmail: 'str')

Bases: object

dashboard: str: URL to connect to the hosting control panel dashboard.

webmail: str: URL to connect to the hosting Webmail interface.

class scaleway.webhosting.v1.types.PlatformPlatformGroup(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

DEFAULT = 'default'

PREMIUM = 'premium'

UNKNOWN_GROUP = 'unknown_group'

class scaleway.webhosting.v1.types.ResetHostingPasswordResponse(one_time_password: 'str')

Bases: object

one_time_password: str: New temporary password.

class scaleway.webhosting.v1.types.ResourceSummary(databases_count: 'int', mail_accounts_count: 'int', ftp_accounts_count: 'int', websites_count: 'int')

Bases: object

databases_count: int: Total number of active databases in the Web Hosting plan.

ftp_accounts_count: int: Total number of active FTP accounts in the Web Hosting plan.

mail_accounts_count: int: Total number of active email accounts in the Web Hosting plan.

websites_count: int: Total number of active domains in the Web Hosting plan.

class scaleway.webhosting.v1.types.SearchDomainsResponse(domains_available: 'List[DomainAvailability]')

Bases: object

domains_available: List[DomainAvailability]: List of domains availability.

class scaleway.webhosting.v1.types.Session(url: 'str')

Bases: object

url: str: Logged user’s session URL.

class scaleway.webhosting.v1.types.SyncDomainDnsRecordsRequestRecord(name: 'str', type_: 'DnsRecordType')

Bases: object

name: str

type_: DnsRecordType

class scaleway.webhosting.v1.types.Website(domain: 'str', path: 'str', ssl_status: 'bool')

Bases: object

domain: str: The domain of the website.

path: str: The directory path of the website.

ssl_status: bool: The SSL status of the website.

class scaleway.webhosting.v1.types.WebsiteApiListWebsitesRequest(hosting_id: 'str', region: 'Optional[ScwRegion]', page: 'Optional[int]', page_size: 'Optional[int]', order_by: 'Optional[ListWebsitesRequestOrderBy]')

Bases: object

hosting_id: str: UUID of the hosting plan.

order_by: Optional[ListWebsitesRequestOrderBy]: Sort order for Web Hosting websites in the response.

page: Optional[int]: Page number (must be a positive integer).

page_size: Optional[int]: Number of websites to return (must be a positive integer lower or equal to 100).

region: Optional[str]: Region to target. If none is passed will use default region from the config.

Module contents

class scaleway.webhosting.v1.AutoConfigDomainDns(nameservers: 'bool', web_records: 'bool', mail_records: 'bool', all_records: 'bool', none: 'bool')

Bases: object

all_records: bool: Whether or not to synchronize all types of records. Takes priority over the other fields.

mail_records: bool: Whether or not to synchronize mail records.

nameservers: bool: Whether or not to synchronize domain nameservers.

none: bool: No automatic domain configuration. Users must configure their domain for the Web Hosting to work.

web_records: bool: Whether or not to synchronize web records.

class scaleway.webhosting.v1.CheckUserOwnsDomainResponse(owns_domain: 'bool')

Bases: object

owns_domain: bool: Indicates whether the specified project owns the domain.

class scaleway.webhosting.v1.ControlPanel(name: 'str', available: 'bool', logo_url: 'str', available_languages: 'List[StdLanguageCode]')

Bases: object

available: bool: Define if the control panel type is available to order.

available_languages: List[LanguageCode]: List of available languages for the control panel.

logo_url: str: URL of the control panel’s logo.

name: str: Control panel name.

class scaleway.webhosting.v1.ControlPanelApiListControlPanelsRequest(region: 'Optional[ScwRegion]', page: 'Optional[int]', page_size: 'Optional[int]')

Bases: object

page: Optional[int]: Page number (must be a positive integer).

page_size: Optional[int]: Number of control panels to return (must be a positive integer lower or equal to 100).

region: Optional[str]: Region to target. If none is passed will use default region from the config.

class scaleway.webhosting.v1.CreateDatabaseRequestUser(username: 'str', password: 'str')

Bases: object

password: str

username: str

class scaleway.webhosting.v1.CreateHostingRequestDomainConfiguration(update_nameservers: 'bool', update_web_record: 'bool', update_mail_record: 'bool', update_all_records: 'bool')

Bases: object

update_all_records: bool

update_mail_record: bool

update_nameservers: bool

update_web_record: bool

class scaleway.webhosting.v1.Database(database_name: 'str', users: 'List[str]')

Bases: object

database_name: str: Name of the database.

users: List[str]: List of users who have access to the database.

class scaleway.webhosting.v1.DatabaseApiAssignDatabaseUserRequest(hosting_id: 'str', username: 'str', database_name: 'str', region: 'Optional[ScwRegion]')

Bases: object

database_name: str: Name of the database to be assigned.

hosting_id: str: UUID of the hosting plan.

region: Optional[str]: Region to target. If none is passed will use default region from the config.

username: str: Name of the user to assign.

class scaleway.webhosting.v1.DatabaseApiChangeDatabaseUserPasswordRequest(hosting_id: 'str', username: 'str', password: 'str', region: 'Optional[ScwRegion]')

Bases: object

hosting_id: str: UUID of the hosting plan.

password: str: New password.

region: Optional[str]: Region to target. If none is passed will use default region from the config.

username: str: Name of the user to update.

class scaleway.webhosting.v1.DatabaseApiCreateDatabaseRequest(hosting_id: 'str', database_name: 'str', region: 'Optional[ScwRegion]', new_user: 'Optional[CreateDatabaseRequestUser]', existing_username: 'Optional[str]')

Bases: object

database_name: str: Name of the database to be created.

existing_username: Optional[str]

hosting_id: str: UUID of the hosting plan where the database will be created.

new_user: Optional[CreateDatabaseRequestUser]

region: Optional[str]: Region to target. If none is passed will use default region from the config.

class scaleway.webhosting.v1.DatabaseApiCreateDatabaseUserRequest(hosting_id: 'str', username: 'str', password: 'str', region: 'Optional[ScwRegion]')

Bases: object

hosting_id: str: UUID of the hosting plan.

password: str: Password of the user to create.

region: Optional[str]: Region to target. If none is passed will use default region from the config.

username: str: Name of the user to create.

class scaleway.webhosting.v1.DatabaseApiDeleteDatabaseRequest(hosting_id: 'str', database_name: 'str', region: 'Optional[ScwRegion]')

Bases: object

database_name: str: Name of the database to delete.

hosting_id: str: UUID of the hosting plan.

region: Optional[str]: Region to target. If none is passed will use default region from the config.

class scaleway.webhosting.v1.DatabaseApiDeleteDatabaseUserRequest(hosting_id: 'str', username: 'str', region: 'Optional[ScwRegion]')

Bases: object

hosting_id: str: UUID of the hosting plan.

region: Optional[str]: Region to target. If none is passed will use default region from the config.

username: str: Name of the database user to delete.

class scaleway.webhosting.v1.DatabaseApiGetDatabaseRequest(hosting_id: 'str', database_name: 'str', region: 'Optional[ScwRegion]')

Bases: object

database_name: str: Name of the database.

hosting_id: str: UUID of the hosting plan.

region: Optional[str]: Region to target. If none is passed will use default region from the config.

class scaleway.webhosting.v1.DatabaseApiGetDatabaseUserRequest(hosting_id: 'str', username: 'str', region: 'Optional[ScwRegion]')

Bases: object

hosting_id: str: UUID of the hosting plan.

region: Optional[str]: Region to target. If none is passed will use default region from the config.

username: str: Name of the database user to retrieve details.

class scaleway.webhosting.v1.DatabaseApiListDatabaseUsersRequest(hosting_id: 'str', region: 'Optional[ScwRegion]', page: 'Optional[int]', page_size: 'Optional[int]', order_by: 'Optional[ListDatabaseUsersRequestOrderBy]')

Bases: object

hosting_id: str: UUID of the hosting plan.

order_by: Optional[ListDatabaseUsersRequestOrderBy]: Sort order of database users in the response.

page: Optional[int]: Page number (must be a positive integer).

page_size: Optional[int]: Number of database users to return (must be a positive integer lower or equal to 100).

region: Optional[str]: Region to target. If none is passed will use default region from the config.

class scaleway.webhosting.v1.DatabaseApiListDatabasesRequest(hosting_id: 'str', region: 'Optional[ScwRegion]', page: 'Optional[int]', page_size: 'Optional[int]', order_by: 'Optional[ListDatabasesRequestOrderBy]')

Bases: object

hosting_id: str: UUID of the hosting plan.

order_by: Optional[ListDatabasesRequestOrderBy]: Sort order of databases in the response.

page: Optional[int]: Page number (must be a positive integer).

page_size: Optional[int]: Number of databases to return (must be a positive integer lower or equal to 100).

region: Optional[str]: Region to target. If none is passed will use default region from the config.

class scaleway.webhosting.v1.DatabaseApiUnassignDatabaseUserRequest(hosting_id: 'str', username: 'str', database_name: 'str', region: 'Optional[ScwRegion]')

Bases: object

database_name: str: Name of the database to be unassigned.

hosting_id: str: UUID of the hosting plan.

region: Optional[str]: Region to target. If none is passed will use default region from the config.

username: str: Name of the user to unassign.

class scaleway.webhosting.v1.DatabaseUser(username: 'str', databases: 'List[str]')

Bases: object

databases: List[str]: List of databases accessible by the user.

username: str: Name of the database user.

class scaleway.webhosting.v1.DnsApiCheckUserOwnsDomainRequest(domain: 'str', region: 'Optional[ScwRegion]', project_id: 'Optional[str]')

Bases: object

domain: str: Domain for which ownership is to be verified.

project_id: Optional[str]: ID of the project currently in use.

region: Optional[str]: Region to target. If none is passed will use default region from the config.

class scaleway.webhosting.v1.DnsApiGetDomainDnsRecordsRequest(domain: 'str', region: 'Optional[ScwRegion]')

Bases: object

domain: str: Domain associated with the DNS records.

region: Optional[str]: Region to target. If none is passed will use default region from the config.

class scaleway.webhosting.v1.DnsApiGetDomainRequest(domain_name: 'str', region: 'Optional[ScwRegion]', project_id: 'Optional[str]')

Bases: object

domain_name: str: Domain name to get.

project_id: Optional[str]: ID of the Scaleway Project in which to get the domain to create the Web Hosting plan.

region: Optional[str]: Region to target. If none is passed will use default region from the config.

class scaleway.webhosting.v1.DnsApiSearchDomainsRequest(domain_name: 'str', region: 'Optional[ScwRegion]', project_id: 'Optional[str]')

Bases: object

domain_name: str: Domain name to search.

project_id: Optional[str]: ID of the Scaleway Project in which to search the domain to create the Web Hosting plan.

region: Optional[str]: Region to target. If none is passed will use default region from the config.

class scaleway.webhosting.v1.DnsApiSyncDomainDnsRecordsRequest(domain: 'str', region: 'Optional[ScwRegion]', update_web_records: 'Optional[bool]', update_mail_records: 'Optional[bool]', update_all_records: 'Optional[bool]', update_nameservers: 'Optional[bool]', custom_records: 'Optional[List[SyncDomainDnsRecordsRequestRecord]]', auto_config_domain_dns: 'Optional[AutoConfigDomainDns]')

Bases: object

auto_config_domain_dns: Optional[AutoConfigDomainDns]: Whether or not to synchronize each types of records.

custom_records: Optional[List[SyncDomainDnsRecordsRequestRecord]]: Custom records to synchronize.

domain: str: Domain for which the DNS records will be synchronized.

region: Optional[str]: Region to target. If none is passed will use default region from the config.

update_all_records: Optional[bool]: Whether or not to synchronize all types of records. This one has priority (deprecated, use auto_config_domain_dns).

update_mail_records: Optional[bool]: Whether or not to synchronize the mail records (deprecated, use auto_config_domain_dns).

update_nameservers: Optional[bool]: Whether or not to synchronize domain nameservers (deprecated, use auto_config_domain_dns).

update_web_records: Optional[bool]: Whether or not to synchronize the web records (deprecated, use auto_config_domain_dns).

class scaleway.webhosting.v1.DnsRecord(name: 'str', type_: 'DnsRecordType', ttl: 'int', value: 'str', status: 'DnsRecordStatus', raw_data: 'str', priority: 'Optional[int]')

Bases: object

name: str: Record name.

priority: Optional[int]: Record priority level.

raw_data: str: Record representation as it appears in the zone file or DNS management system.

status: DnsRecordStatus: Record status.

ttl: int: Record time-to-live.

type_: DnsRecordType: Record type.

value: str: Record value.

class scaleway.webhosting.v1.DnsRecordStatus(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

INVALID = 'invalid'

UNKNOWN_STATUS = 'unknown_status'

VALID = 'valid'

class scaleway.webhosting.v1.DnsRecordType(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

A = 'a'

AAAA = 'aaaa'

CNAME = 'cname'

MX = 'mx'

NS = 'ns'

TXT = 'txt'

UNKNOWN_TYPE = 'unknown_type'

class scaleway.webhosting.v1.DnsRecords(records: 'List[DnsRecord]', name_servers: 'List[Nameserver]', status: 'DnsRecordsStatus', dns_config: 'Optional[List[DomainDnsAction]]', auto_config_domain_dns: 'Optional[AutoConfigDomainDns]')

Bases: object

auto_config_domain_dns: Optional[AutoConfigDomainDns]: Whether or not to synchronize each types of records.

dns_config: Optional[List[DomainDnsAction]]: Records dns auto configuration settings (deprecated, use auto_config_domain_dns).

name_servers: List[Nameserver]: List of nameservers.

records: List[DnsRecord]: List of DNS records.

status: DnsRecordsStatus: Status of the records.

class scaleway.webhosting.v1.DnsRecordsStatus(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

INVALID = 'invalid'

UNKNOWN_STATUS = 'unknown_status'

VALID = 'valid'

class scaleway.webhosting.v1.Domain(name: 'str', status: 'DomainStatus', owner: 'DomainZoneOwner', available_actions: 'List[DomainAction]', available_dns_actions: 'Optional[List[DomainDnsAction]]', auto_config_domain_dns: 'Optional[AutoConfigDomainDns]')

Bases: object

auto_config_domain_dns: Optional[AutoConfigDomainDns]: Whether or not to synchronize each type of record.

available_actions: List[DomainAction]: A list of actions that can be performed on the domain.

available_dns_actions: Optional[List[DomainDnsAction]]: A list of DNS-related actions that can be auto configured for the domain (deprecated, use auto_config_domain_dns instead).

name: str: Name of the domain.

owner: DomainZoneOwner: Zone owner of the domain.

status: DomainStatus: Current status of the domain.

class scaleway.webhosting.v1.DomainAction(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

MANAGE_EXTERNAL = 'manage_external'

RENEW = 'renew'

TRANSFER = 'transfer'

UNKNOWN_ACTION = 'unknown_action'

class scaleway.webhosting.v1.DomainAvailability(name: 'str', zone_name: 'str', status: 'DomainAvailabilityStatus', available_actions: 'List[DomainAvailabilityAction]', can_create_hosting: 'bool', price: 'Optional[Money]')

Bases: object

available_actions: List[DomainAvailabilityAction]: A list of actions that can be performed on the domain.

can_create_hosting: bool: Whether a hosting can be created for this domain.

name: str: Fully qualified domain name (FQDN).

price: Optional[Money]: Price for registering the domain.

status: DomainAvailabilityStatus: Availability status of the domain.

zone_name: str: DNS zone associated with the domain.

class scaleway.webhosting.v1.DomainAvailabilityAction(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

MANAGE_EXTERNAL = 'manage_external'

REGISTER = 'register'

TRANSFER = 'transfer'

UNKNOWN_ACTION = 'unknown_action'

class scaleway.webhosting.v1.DomainAvailabilityStatus(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

AVAILABLE = 'available'

ERROR = 'error'

NOT_AVAILABLE = 'not_available'

OWNED = 'owned'

UNKNOWN_STATUS = 'unknown_status'

VALIDATING = 'validating'

class scaleway.webhosting.v1.DomainDnsAction(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

AUTO_CONFIG_ALL_RECORDS = 'auto_config_all_records'

AUTO_CONFIG_MAIL_RECORDS = 'auto_config_mail_records'

AUTO_CONFIG_NAMESERVERS = 'auto_config_nameservers'

AUTO_CONFIG_NONE = 'auto_config_none'

AUTO_CONFIG_WEB_RECORDS = 'auto_config_web_records'

UNKNOWN_DNS_ACTION = 'unknown_dns_action'

class scaleway.webhosting.v1.DomainStatus(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

ERROR = 'error'

INVALID = 'invalid'

UNKNOWN_STATUS = 'unknown_status'

VALID = 'valid'

VALIDATING = 'validating'

class scaleway.webhosting.v1.DomainZoneOwner(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

EXTERNAL = 'external'

ONLINE = 'online'

SCALEWAY = 'scaleway'

UNKNOWN_ZONE_OWNER = 'unknown_zone_owner'

WEBHOSTING = 'webhosting'

class scaleway.webhosting.v1.FtpAccount(username: 'str', path: 'str')

Bases: object

path: str: The path associated with the FTP account.

username: str: The username of the FTP account.

class scaleway.webhosting.v1.FtpAccountApiChangeFtpAccountPasswordRequest(hosting_id: 'str', username: 'str', password: 'str', region: 'Optional[ScwRegion]')

Bases: object

hosting_id: str: UUID of the hosting plan.

password: str: New password for the FTP account.

region: Optional[str]: Region to target. If none is passed will use default region from the config.

username: str: Username of the FTP account.

class scaleway.webhosting.v1.FtpAccountApiCreateFtpAccountRequest(hosting_id: 'str', username: 'str', path: 'str', password: 'str', region: 'Optional[ScwRegion]')

Bases: object

hosting_id: str: UUID of the hosting plan.

password: str: Password for the new FTP account.

path: str: Path for the new FTP account.

region: Optional[str]: Region to target. If none is passed will use default region from the config.

username: str: Username for the new FTP account.

class scaleway.webhosting.v1.FtpAccountApiListFtpAccountsRequest(hosting_id: 'str', region: 'Optional[ScwRegion]', page: 'Optional[int]', page_size: 'Optional[int]', order_by: 'Optional[ListFtpAccountsRequestOrderBy]', domain: 'Optional[str]')

Bases: object

domain: Optional[str]: Domain to filter the FTP accounts.

hosting_id: str: UUID of the hosting plan.

order_by: Optional[ListFtpAccountsRequestOrderBy]: Sort order of FTP accounts in the response.

page: Optional[int]: Page number (must be a positive integer).

page_size: Optional[int]: Number of FTP accounts to return (must be a positive integer lower or equal to 100).

region: Optional[str]: Region to target. If none is passed will use default region from the config.

class scaleway.webhosting.v1.FtpAccountApiRemoveFtpAccountRequest(hosting_id: 'str', username: 'str', region: 'Optional[ScwRegion]')

Bases: object

hosting_id: str: UUID of the hosting plan.

region: Optional[str]: Region to target. If none is passed will use default region from the config.

username: str: Username of the FTP account to be deleted.

class scaleway.webhosting.v1.Hosting(id: 'str', project_id: 'str', status: 'HostingStatus', domain: 'str', tags: 'List[str]', ipv4: 'str', updated_at: 'Optional[datetime]', created_at: 'Optional[datetime]', protected: 'bool', domain_status: 'DomainStatus', region: 'ScwRegion', offer: 'Optional[Offer]', platform: 'Optional[Platform]', dns_status: 'Optional[DnsRecordsStatus]', user: 'Optional[HostingUser]')

Bases: object

created_at: Optional[datetime]: Date on which the Web Hosting plan was created.

dns_status: Optional[DnsRecordsStatus]: DNS status of the Web Hosting plan.

domain: str: Main domain associated with the Web Hosting plan.

domain_status: DomainStatus: Main domain status of the Web Hosting plan.

id: str: ID of the Web Hosting plan.

ipv4: str: Current IPv4 address of the hosting.

offer: Optional[Offer]: Details of the Web Hosting plan offer and options.

platform: Optional[Platform]: Details of the hosting platform.

project_id: str: ID of the Scaleway Project the Web Hosting plan belongs to.

protected: bool: Whether the hosting is protected or not.

region: str: Region where the Web Hosting plan is hosted.

status: HostingStatus: Status of the Web Hosting plan.

tags: List[str]: List of tags associated with the Web Hosting plan.

updated_at: Optional[datetime]: Date on which the Web Hosting plan was last updated.

user: Optional[HostingUser]: Details of the hosting user.

class scaleway.webhosting.v1.HostingApiCreateHostingRequest(offer_id: 'str', email: 'str', domain: 'str', region: 'Optional[ScwRegion]', project_id: 'Optional[str]', tags: 'Optional[List[str]]', offer_options: 'Optional[List[OfferOptionRequest]]', language: 'Optional[StdLanguageCode]', domain_configuration: 'Optional[CreateHostingRequestDomainConfiguration]', skip_welcome_email: 'Optional[bool]', auto_config_domain_dns: 'Optional[AutoConfigDomainDns]')

Bases: object

auto_config_domain_dns: Optional[AutoConfigDomainDns]: Indicates whether to update hosting domain name servers and DNS records for domains managed by Scaleway Elements (deprecated, use auto_update_* fields instead).

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

domain_configuration: Optional[CreateHostingRequestDomainConfiguration]: Indicates whether to update hosting domain name servers and DNS records for domains managed by Scaleway Elements (deprecated, use auto_config_domain_dns instead).

email: str: Contact email for the Web Hosting client.

language: Optional[LanguageCode]: Default language for the control panel interface.

offer_id: str: ID of the selected offer for the Web Hosting plan.

offer_options: Optional[List[OfferOptionRequest]]: List of the Web Hosting plan options IDs with their quantities.

project_id: Optional[str]: ID of the Scaleway Project in which to create the Web Hosting plan.

region: Optional[str]: Region to target. If none is passed will use default region from the config.

skip_welcome_email: Optional[bool]: Indicates whether to skip a welcome email to the contact email containing hosting info.

tags: Optional[List[str]]: List of tags for the Web Hosting plan.

class scaleway.webhosting.v1.HostingApiCreateSessionRequest(hosting_id: 'str', region: 'Optional[ScwRegion]')

Bases: object

hosting_id: str: Hosting ID.

region: Optional[str]: Region to target. If none is passed will use default region from the config.

class scaleway.webhosting.v1.HostingApiDeleteHostingRequest(hosting_id: 'str', region: 'Optional[ScwRegion]')

Bases: object

hosting_id: str: Hosting ID.

region: Optional[str]: Region to target. If none is passed will use default region from the config.

class scaleway.webhosting.v1.HostingApiGetHostingRequest(hosting_id: 'str', region: 'Optional[ScwRegion]')

Bases: object

hosting_id: str: Hosting ID.

region: Optional[str]: Region to target. If none is passed will use default region from the config.

class scaleway.webhosting.v1.HostingApiGetResourceSummaryRequest(hosting_id: 'str', region: 'Optional[ScwRegion]')

Bases: object

hosting_id: str: Hosting ID.

region: Optional[str]: Region to target. If none is passed will use default region from the config.

class scaleway.webhosting.v1.HostingApiListHostingsRequest(region: 'Optional[ScwRegion]', page: 'Optional[int]', page_size: 'Optional[int]', order_by: 'Optional[ListHostingsRequestOrderBy]', tags: 'Optional[List[str]]', statuses: 'Optional[List[HostingStatus]]', domain: 'Optional[str]', project_id: 'Optional[str]', organization_id: 'Optional[str]', control_panels: 'Optional[List[str]]')

Bases: object

control_panels: Optional[List[str]]: Name of the control panel to filter for, only Web Hosting plans from this control panel will be returned.

domain: Optional[str]: Domain to filter for, only Web Hosting plans associated with this domain will be returned.

order_by: Optional[ListHostingsRequestOrderBy]: Sort order for Web Hosting plans in the response.

organization_id: Optional[str]: Organization ID to filter for, only Web Hosting plans from this Organization will be returned.

page: Optional[int]: Page number to return, from the paginated results (must be a positive integer).

page_size: Optional[int]: Number of Web Hosting plans to return (must be a positive integer lower or equal to 100).

project_id: Optional[str]: Project ID to filter for, only Web Hosting plans from this Project will be returned.

region: Optional[str]: Region to target. If none is passed will use default region from the config.

statuses: Optional[List[HostingStatus]]: Statuses to filter for, only Web Hosting plans with matching statuses will be returned.

tags: Optional[List[str]]: Tags to filter for, only Web Hosting plans with matching tags will be returned.

class scaleway.webhosting.v1.HostingApiResetHostingPasswordRequest(hosting_id: 'str', region: 'Optional[ScwRegion]')

Bases: object

hosting_id: str: UUID of the hosting.

region: Optional[str]: Region to target. If none is passed will use default region from the config.

class scaleway.webhosting.v1.HostingApiUpdateHostingRequest(hosting_id: 'str', region: 'Optional[ScwRegion]', email: 'Optional[str]', tags: 'Optional[List[str]]', offer_options: 'Optional[List[OfferOptionRequest]]', offer_id: 'Optional[str]', protected: 'Optional[bool]')

Bases: object

email: Optional[str]: New contact email for the Web Hosting plan.

hosting_id: str: Hosting ID.

offer_id: Optional[str]: ID of the new offer for the Web Hosting plan.

offer_options: Optional[List[OfferOptionRequest]]: List of the Web Hosting plan options IDs with their quantities.

protected: Optional[bool]: Whether the hosting is protected or not.

region: Optional[str]: Region to target. If none is passed will use default region from the config.

tags: Optional[List[str]]: New tags for the Web Hosting plan.

class scaleway.webhosting.v1.HostingStatus(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

DELETING = 'deleting'

DELIVERING = 'delivering'

ERROR = 'error'

LOCKED = 'locked'

MIGRATING = 'migrating'

READY = 'ready'

UNKNOWN_STATUS = 'unknown_status'

class scaleway.webhosting.v1.HostingSummary(id: 'str', project_id: 'str', status: 'HostingStatus', domain: 'str', protected: 'bool', offer_name: 'str', domain_status: 'DomainStatus', region: 'ScwRegion', created_at: 'Optional[datetime]', updated_at: 'Optional[datetime]', dns_status: 'Optional[DnsRecordsStatus]')

Bases: object

created_at: Optional[datetime]: Date on which the Web Hosting plan was created.

dns_status: Optional[DnsRecordsStatus]: DNS status of the Web Hosting plan.

domain: str: Main domain associated with the Web Hosting plan.

domain_status: DomainStatus: Main domain status of the Web Hosting plan.

id: str: ID of the Web Hosting plan.

offer_name: str: Name of the active offer for the Web Hosting plan.

project_id: str: ID of the Scaleway Project the Web Hosting plan belongs to.

protected: bool: Whether the hosting is protected or not.

region: str: Region where the Web Hosting plan is hosted.

status: HostingStatus: Status of the Web Hosting plan.

updated_at: Optional[datetime]: Date on which the Web Hosting plan was last updated.

class scaleway.webhosting.v1.HostingUser(username: 'str', contact_email: 'str', one_time_password: 'Optional[str]')

Bases: object

contact_email: str: Contact email used for the hosting.

one_time_password: Optional[str]: One-time-password used for the first login or reset password, empty after first use.

username: str: Main Web Hosting cPanel username.

class scaleway.webhosting.v1.ListControlPanelsResponse(total_count: 'int', control_panels: 'List[ControlPanel]')

Bases: object

control_panels: List[ControlPanel]: List of control panels.

total_count: int: Number of control panels returned.

class scaleway.webhosting.v1.ListDatabaseUsersRequestOrderBy(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

USERNAME_ASC = 'username_asc'

USERNAME_DESC = 'username_desc'

class scaleway.webhosting.v1.ListDatabaseUsersResponse(total_count: 'int', users: 'List[DatabaseUser]')

Bases: object

total_count: int: Total number of database users.

users: List[DatabaseUser]: List of database users.

class scaleway.webhosting.v1.ListDatabasesRequestOrderBy(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

DATABASE_NAME_ASC = 'database_name_asc'

DATABASE_NAME_DESC = 'database_name_desc'

class scaleway.webhosting.v1.ListDatabasesResponse(total_count: 'int', databases: 'List[Database]')

Bases: object

databases: List[Database]: List of databases.

total_count: int: Total number of databases.

class scaleway.webhosting.v1.ListFtpAccountsRequestOrderBy(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

USERNAME_ASC = 'username_asc'

USERNAME_DESC = 'username_desc'

class scaleway.webhosting.v1.ListFtpAccountsResponse(total_count: 'int', ftp_accounts: 'List[FtpAccount]')

Bases: object

ftp_accounts: List[FtpAccount]: List of FTP accounts.

total_count: int: Total number of FTP accounts.

class scaleway.webhosting.v1.ListHostingsRequestOrderBy(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

CREATED_AT_ASC = 'created_at_asc'

CREATED_AT_DESC = 'created_at_desc'

class scaleway.webhosting.v1.ListHostingsResponse(total_count: 'int', hostings: 'List[HostingSummary]')

Bases: object

hostings: List[HostingSummary]: List of Web Hosting plans.

total_count: int: Number of Web Hosting plans returned.

class scaleway.webhosting.v1.ListMailAccountsRequestOrderBy(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

DOMAIN_ASC = 'domain_asc'

DOMAIN_DESC = 'domain_desc'

USERNAME_ASC = 'username_asc'

USERNAME_DESC = 'username_desc'

class scaleway.webhosting.v1.ListMailAccountsResponse(total_count: 'int', mail_accounts: 'List[MailAccount]')

Bases: object

mail_accounts: List[MailAccount]: List of mail accounts.

total_count: int: Total number of mail accounts.

class scaleway.webhosting.v1.ListOffersRequestOrderBy(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

PRICE_ASC = 'price_asc'

class scaleway.webhosting.v1.ListOffersResponse(total_count: 'int', offers: 'List[Offer]')

Bases: object

offers: List[Offer]: List of offers.

total_count: int: Total number of offers.

class scaleway.webhosting.v1.ListWebsitesRequestOrderBy(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

DOMAIN_ASC = 'domain_asc'

DOMAIN_DESC = 'domain_desc'

class scaleway.webhosting.v1.ListWebsitesResponse(total_count: 'int', websites: 'List[Website]')

Bases: object

total_count: int: Total number of websites.

websites: List[Website]: List of websites.

class scaleway.webhosting.v1.MailAccount(domain: 'str', username: 'str')

Bases: object

domain: str: Domain part of the mail account address.

username: str: Username part address of the mail account address.

class scaleway.webhosting.v1.MailAccountApiChangeMailAccountPasswordRequest(hosting_id: 'str', domain: 'str', username: 'str', password: 'str', region: 'Optional[ScwRegion]')

Bases: object

domain: str: Domain part of the mail account address.

hosting_id: str: UUID of the hosting plan.

password: str: New password for the mail account.

region: Optional[str]: Region to target. If none is passed will use default region from the config.

username: str: Username part of the mail account address.

class scaleway.webhosting.v1.MailAccountApiCreateMailAccountRequest(hosting_id: 'str', domain: 'str', username: 'str', password: 'str', region: 'Optional[ScwRegion]')

Bases: object

domain: str: Domain part of the mail account address.

hosting_id: str: UUID of the hosting plan.

password: str: Password for the new mail account.

region: Optional[str]: Region to target. If none is passed will use default region from the config.

username: str: Username part address of the mail account address.

class scaleway.webhosting.v1.MailAccountApiListMailAccountsRequest(hosting_id: 'str', region: 'Optional[ScwRegion]', page: 'Optional[int]', page_size: 'Optional[int]', order_by: 'Optional[ListMailAccountsRequestOrderBy]', domain: 'Optional[str]')

Bases: object

domain: Optional[str]: Domain to filter the mail accounts.

hosting_id: str: UUID of the hosting plan.

order_by: Optional[ListMailAccountsRequestOrderBy]: Sort order of mail accounts in the response.

page: Optional[int]: Page number (must be a positive integer).

page_size: Optional[int]: Number of mail accounts to return (must be a positive integer lower or equal to 100).

region: Optional[str]: Region to target. If none is passed will use default region from the config.

class scaleway.webhosting.v1.MailAccountApiRemoveMailAccountRequest(hosting_id: 'str', domain: 'str', username: 'str', region: 'Optional[ScwRegion]')

Bases: object

domain: str: Domain part of the mail account address.

hosting_id: str: UUID of the hosting plan.

region: Optional[str]: Region to target. If none is passed will use default region from the config.

username: str: Username part of the mail account address.

class scaleway.webhosting.v1.Nameserver(hostname: 'str', status: 'NameserverStatus', is_default: 'bool')

Bases: object

hostname: str: Hostname of the nameserver.

is_default: bool: Defines whether the nameserver is the default one.

status: NameserverStatus: Status of the nameserver.

class scaleway.webhosting.v1.NameserverStatus(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

INVALID = 'invalid'

UNKNOWN_STATUS = 'unknown_status'

VALID = 'valid'

class scaleway.webhosting.v1.Offer(id: 'str', name: 'str', billing_operation_path: 'str', options: 'List[OfferOption]', available: 'bool', control_panel_name: 'str', end_of_life: 'bool', quota_warning: 'OfferOptionWarning', price: 'Optional[Money]')

Bases: object

available: bool: If a hosting_id was specified in the call, defines whether the offer is available for a specified hosting plan to migrate (update) to.

billing_operation_path: str: Unique identifier used for billing.

control_panel_name: str: Name of the control panel.

end_of_life: bool: Indicates if the offer has reached its end of life.

id: str: Offer ID.

name: str: Offer name.

options: List[OfferOption]: Options available for the offer.

price: Optional[Money]: Price of the offer.

quota_warning: OfferOptionWarning: Defines a warning if the maximum value for an option in the offer is exceeded.

class scaleway.webhosting.v1.OfferApiListOffersRequest(region: 'Optional[ScwRegion]', page: 'Optional[int]', page_size: 'Optional[int]', order_by: 'Optional[ListOffersRequestOrderBy]', hosting_id: 'Optional[str]', control_panels: 'Optional[List[str]]')

Bases: object

control_panels: Optional[List[str]]: Name of the control panel(s) to filter for.

hosting_id: Optional[str]: UUID of the hosting plan.

order_by: Optional[ListOffersRequestOrderBy]: Sort order for Web Hosting offers in the response.

page: Optional[int]: Page number (must be a positive integer).

page_size: Optional[int]: Number of websites to return (must be a positive integer lower or equal to 100).

region: Optional[str]: Region to target. If none is passed will use default region from the config.

class scaleway.webhosting.v1.OfferOption(id: 'str', name: 'OfferOptionName', billing_operation_path: 'str', min_value: 'int', current_value: 'int', max_value: 'int', quota_warning: 'OfferOptionWarning', price: 'Optional[Money]')

Bases: object

billing_operation_path: str: Unique identifier used for billing.

current_value: int: If a hosting_id was specified in the call, defines the current value of the option in the hosting.

id: str: Option ID.

max_value: int: Maximum value for the option in the offer.

min_value: int: Minimum value for the option in the offer.

name: OfferOptionName: Name of the option.

price: Optional[Money]: Price of the option for 1 value.

quota_warning: OfferOptionWarning: Defines a warning if the maximum value for the option has been reached.

class scaleway.webhosting.v1.OfferOptionName(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

BACKUP = 'backup'

DATABASE_COUNT = 'database_count'

DEDICATED_IP = 'dedicated_ip'

DOMAIN_COUNT = 'domain_count'

EMAIL_COUNT = 'email_count'

EMAIL_STORAGE_GB = 'email_storage_gb'

RAM_GB = 'ram_gb'

STORAGE_GB = 'storage_gb'

SUPPORT = 'support'

UNKNOWN_NAME = 'unknown_name'

VCPU_COUNT = 'vcpu_count'

class scaleway.webhosting.v1.OfferOptionRequest(id: 'str', quantity: 'int')

Bases: object

id: str: Offer option ID.

quantity: int: The option requested quantity to set for the Web Hosting plan.

class scaleway.webhosting.v1.OfferOptionWarning(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

QUOTA_EXCEEDED_WARNING = 'quota_exceeded_warning'

UNKNOWN_WARNING = 'unknown_warning'

USAGE_LOW_WARNING = 'usage_low_warning'

class scaleway.webhosting.v1.Platform(hostname: 'str', number: 'int', group_name: 'PlatformPlatformGroup', ipv4: 'str', ipv6: 'str', control_panel: 'Optional[PlatformControlPanel]')

Bases: object

control_panel: Optional[PlatformControlPanel]: Details of the platform control panel.

group_name: PlatformPlatformGroup: Group name of the hosting’s host platform.

hostname: str: Hostname of the host platform.

ipv4: str: IPv4 address of the hosting’s host platform.

ipv6: str: IPv6 address of the hosting’s host platform.

number: int: Number of the host platform.

class scaleway.webhosting.v1.PlatformControlPanel(name: 'str', urls: 'Optional[PlatformControlPanelUrls]')

Bases: object

name: str: Name of the control panel.

urls: Optional[PlatformControlPanelUrls]: URL to connect to cPanel dashboard and to Webmail interface.

class scaleway.webhosting.v1.PlatformControlPanelUrls(dashboard: 'str', webmail: 'str')

Bases: object

dashboard: str: URL to connect to the hosting control panel dashboard.

webmail: str: URL to connect to the hosting Webmail interface.

class scaleway.webhosting.v1.PlatformPlatformGroup(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

DEFAULT = 'default'

PREMIUM = 'premium'

UNKNOWN_GROUP = 'unknown_group'

class scaleway.webhosting.v1.ResetHostingPasswordResponse(one_time_password: 'str')

Bases: object

one_time_password: str: New temporary password.

class scaleway.webhosting.v1.ResourceSummary(databases_count: 'int', mail_accounts_count: 'int', ftp_accounts_count: 'int', websites_count: 'int')

Bases: object

databases_count: int: Total number of active databases in the Web Hosting plan.

ftp_accounts_count: int: Total number of active FTP accounts in the Web Hosting plan.

mail_accounts_count: int: Total number of active email accounts in the Web Hosting plan.

websites_count: int: Total number of active domains in the Web Hosting plan.

class scaleway.webhosting.v1.SearchDomainsResponse(domains_available: 'List[DomainAvailability]')

Bases: object

domains_available: List[DomainAvailability]: List of domains availability.

class scaleway.webhosting.v1.Session(url: 'str')

Bases: object

url: str: Logged user’s session URL.

class scaleway.webhosting.v1.SyncDomainDnsRecordsRequestRecord(name: 'str', type_: 'DnsRecordType')

Bases: object

name: str

type_: DnsRecordType

class scaleway.webhosting.v1.WebhostingV1ControlPanelAPI(client: Client, *, bypass_validation: bool = False)

Bases: API

This API allows you to manage your Web Hosting services.

list_control_panels(*, region: Optional[str] = None, page: Optional[int] = None, page_size: Optional[int] = None) → ListControlPanelsResponse

“List the control panels type: cpanel or plesk.”. :param region: Region to target. If none is passed will use default region from the config. :param page: Page number (must be a positive integer). :param page_size: Number of control panels to return (must be a positive integer lower or equal to 100). :return: ListControlPanelsResponse

Usage:

result = api.list_control_panels()

list_control_panels_all(*, region: Optional[str] = None, page: Optional[int] = None, page_size: Optional[int] = None) → List[ControlPanel]

“List the control panels type: cpanel or plesk.”. :param region: Region to target. If none is passed will use default region from the config. :param page: Page number (must be a positive integer). :param page_size: Number of control panels to return (must be a positive integer lower or equal to 100). :return: List[ControlPanel]

Usage:

result = api.list_control_panels_all()

class scaleway.webhosting.v1.WebhostingV1DatabaseAPI(client: Client, *, bypass_validation: bool = False)

Bases: API

This API allows you to manage your databases and database users for your Web Hosting services.

assign_database_user(*, hosting_id: str, username: str, database_name: str, region: Optional[str] = None) → DatabaseUser

“Assign a database user to a database”. :param hosting_id: UUID of the hosting plan. :param username: Name of the user to assign. :param database_name: Name of the database to be assigned. :param region: Region to target. If none is passed will use default region from the config. :return: DatabaseUser

Usage:

result = api.assign_database_user(
    hosting_id="example",
    username="example",
    database_name="example",
)

change_database_user_password(*, hosting_id: str, username: str, password: str, region: Optional[str] = None) → DatabaseUser

“Change the password of a database user”. :param hosting_id: UUID of the hosting plan. :param username: Name of the user to update. :param password: New password. :param region: Region to target. If none is passed will use default region from the config. :return: DatabaseUser

Usage:

result = api.change_database_user_password(
    hosting_id="example",
    username="example",
    password="example",
)

create_database(*, hosting_id: str, database_name: str, region: Optional[str] = None, new_user: Optional[CreateDatabaseRequestUser] = None, existing_username: Optional[str] = None) → Database

“Create a new database within your hosting plan”. :param hosting_id: UUID of the hosting plan where the database will be created. :param database_name: Name of the database to be created. :param region: Region to target. If none is passed will use default region from the config. :param new_user: (Optional) Username and password to create a user and link to the database. One-Of (‘user’): at most one of ‘new_user’, ‘existing_username’ could be set. :param existing_username: (Optional) Username to link an existing user to the database. One-Of (‘user’): at most one of ‘new_user’, ‘existing_username’ could be set. :return: Database

Usage:

result = api.create_database(
    hosting_id="example",
    database_name="example",
)

create_database_user(*, hosting_id: str, username: str, password: str, region: Optional[str] = None) → DatabaseUser

“Create a new database user”. :param hosting_id: UUID of the hosting plan. :param username: Name of the user to create. :param password: Password of the user to create. :param region: Region to target. If none is passed will use default region from the config. :return: DatabaseUser

Usage:

result = api.create_database_user(
    hosting_id="example",
    username="example",
    password="example",
)

delete_database(*, hosting_id: str, database_name: str, region: Optional[str] = None) → Database

“Delete a database within your hosting plan”. :param hosting_id: UUID of the hosting plan. :param database_name: Name of the database to delete. :param region: Region to target. If none is passed will use default region from the config. :return: Database

Usage:

result = api.delete_database(
    hosting_id="example",
    database_name="example",
)

delete_database_user(*, hosting_id: str, username: str, region: Optional[str] = None) → DatabaseUser

“Delete a database user”. :param hosting_id: UUID of the hosting plan. :param username: Name of the database user to delete. :param region: Region to target. If none is passed will use default region from the config. :return: DatabaseUser

Usage:

result = api.delete_database_user(
    hosting_id="example",
    username="example",
)

get_database(*, hosting_id: str, database_name: str, region: Optional[str] = None) → Database

“Get details of a database within your hosting plan”. :param hosting_id: UUID of the hosting plan. :param database_name: Name of the database. :param region: Region to target. If none is passed will use default region from the config. :return: Database

Usage:

result = api.get_database(
    hosting_id="example",
    database_name="example",
)

get_database_user(*, hosting_id: str, username: str, region: Optional[str] = None) → DatabaseUser

“Get details of a database user”. :param hosting_id: UUID of the hosting plan. :param username: Name of the database user to retrieve details. :param region: Region to target. If none is passed will use default region from the config. :return: DatabaseUser

Usage:

result = api.get_database_user(
    hosting_id="example",
    username="example",
)

list_database_users(*, hosting_id: str, region: Optional[str] = None, page: Optional[int] = None, page_size: Optional[int] = None, order_by: Optional[ListDatabaseUsersRequestOrderBy] = None) → ListDatabaseUsersResponse

“List all database users”. :param hosting_id: UUID of the hosting plan. :param region: Region to target. If none is passed will use default region from the config. :param page: Page number (must be a positive integer). :param page_size: Number of database users to return (must be a positive integer lower or equal to 100). :param order_by: Sort order of database users in the response. :return: ListDatabaseUsersResponse

Usage:

result = api.list_database_users(
    hosting_id="example",
)

list_database_users_all(*, hosting_id: str, region: Optional[str] = None, page: Optional[int] = None, page_size: Optional[int] = None, order_by: Optional[ListDatabaseUsersRequestOrderBy] = None) → List[DatabaseUser]

“List all database users”. :param hosting_id: UUID of the hosting plan. :param region: Region to target. If none is passed will use default region from the config. :param page: Page number (must be a positive integer). :param page_size: Number of database users to return (must be a positive integer lower or equal to 100). :param order_by: Sort order of database users in the response. :return: List[DatabaseUser]

Usage:

result = api.list_database_users_all(
    hosting_id="example",
)

list_databases(*, hosting_id: str, region: Optional[str] = None, page: Optional[int] = None, page_size: Optional[int] = None, order_by: Optional[ListDatabasesRequestOrderBy] = None) → ListDatabasesResponse

“List all databases within your hosting plan”. :param hosting_id: UUID of the hosting plan. :param region: Region to target. If none is passed will use default region from the config. :param page: Page number (must be a positive integer). :param page_size: Number of databases to return (must be a positive integer lower or equal to 100). :param order_by: Sort order of databases in the response. :return: ListDatabasesResponse

Usage:

result = api.list_databases(
    hosting_id="example",
)

list_databases_all(*, hosting_id: str, region: Optional[str] = None, page: Optional[int] = None, page_size: Optional[int] = None, order_by: Optional[ListDatabasesRequestOrderBy] = None) → List[Database]

“List all databases within your hosting plan”. :param hosting_id: UUID of the hosting plan. :param region: Region to target. If none is passed will use default region from the config. :param page: Page number (must be a positive integer). :param page_size: Number of databases to return (must be a positive integer lower or equal to 100). :param order_by: Sort order of databases in the response. :return: List[Database]

Usage:

result = api.list_databases_all(
    hosting_id="example",
)

unassign_database_user(*, hosting_id: str, username: str, database_name: str, region: Optional[str] = None) → DatabaseUser

“Unassign a database user from a database”. :param hosting_id: UUID of the hosting plan. :param username: Name of the user to unassign. :param database_name: Name of the database to be unassigned. :param region: Region to target. If none is passed will use default region from the config. :return: DatabaseUser

Usage:

result = api.unassign_database_user(
    hosting_id="example",
    username="example",
    database_name="example",
)

class scaleway.webhosting.v1.WebhostingV1DnsAPI(client: Client, *, bypass_validation: bool = False)

Bases: API

This API allows you to manage your Web Hosting services.

check_user_owns_domain(*, domain: str, region: Optional[str] = None, project_id: Optional[str] = None) → CheckUserOwnsDomainResponse

Check whether you own this domain or not. :param domain: Domain for which ownership is to be verified. :param region: Region to target. If none is passed will use default region from the config. :param project_id: ID of the project currently in use. :return: CheckUserOwnsDomainResponse

Usage:

result = api.check_user_owns_domain(
    domain="example",
)

get_domain(*, domain_name: str, region: Optional[str] = None, project_id: Optional[str] = None) → Domain

Retrieve detailed information about a specific domain, including its status, DNS configuration, and ownership. :param domain_name: Domain name to get. :param region: Region to target. If none is passed will use default region from the config. :param project_id: ID of the Scaleway Project in which to get the domain to create the Web Hosting plan. :return: Domain

Usage:

result = api.get_domain(
    domain_name="example",
)

get_domain_dns_records(*, domain: str, region: Optional[str] = None) → DnsRecords

Get DNS records. Get the set of DNS records of a specified domain associated with a Web Hosting plan’s domain. :param domain: Domain associated with the DNS records. :param region: Region to target. If none is passed will use default region from the config. :return: DnsRecords

Usage:

result = api.get_domain_dns_records(
    domain="example",
)

search_domains(*, domain_name: str, region: Optional[str] = None, project_id: Optional[str] = None) → SearchDomainsResponse

Search for available domains based on domain name. :param domain_name: Domain name to search. :param region: Region to target. If none is passed will use default region from the config. :param project_id: ID of the Scaleway Project in which to search the domain to create the Web Hosting plan. :return: SearchDomainsResponse

Usage:

result = api.search_domains(
    domain_name="example",
)

sync_domain_dns_records(*, domain: str, region: Optional[str] = None, update_web_records: Optional[bool] = None, update_mail_records: Optional[bool] = None, update_all_records: Optional[bool] = None, update_nameservers: Optional[bool] = None, custom_records: Optional[List[SyncDomainDnsRecordsRequestRecord]] = None, auto_config_domain_dns: Optional[AutoConfigDomainDns] = None) → DnsRecords

Synchronize your DNS records on the Elements Console and on cPanel. :param domain: Domain for which the DNS records will be synchronized. :param region: Region to target. If none is passed will use default region from the config. :param update_web_records: Whether or not to synchronize the web records (deprecated, use auto_config_domain_dns). :param update_mail_records: Whether or not to synchronize the mail records (deprecated, use auto_config_domain_dns). :param update_all_records: Whether or not to synchronize all types of records. This one has priority (deprecated, use auto_config_domain_dns). :param update_nameservers: Whether or not to synchronize domain nameservers (deprecated, use auto_config_domain_dns). :param custom_records: Custom records to synchronize. :param auto_config_domain_dns: Whether or not to synchronize each types of records. :return: DnsRecords

Usage:

result = api.sync_domain_dns_records(
    domain="example",
)

wait_for_domain(*, domain_name: str, region: Optional[str] = None, project_id: Optional[str] = None, options: Optional[WaitForOptions[Domain, bool]] = None) → Domain

Retrieve detailed information about a specific domain, including its status, DNS configuration, and ownership. :param domain_name: Domain name to get. :param region: Region to target. If none is passed will use default region from the config. :param project_id: ID of the Scaleway Project in which to get the domain to create the Web Hosting plan. :return: Domain

Usage:

result = api.get_domain(
    domain_name="example",
)

class scaleway.webhosting.v1.WebhostingV1FtpAccountAPI(client: Client, *, bypass_validation: bool = False)

Bases: API

This API allows you to manage your FTP accounts for your Web Hosting services.

change_ftp_account_password(*, hosting_id: str, username: str, password: str, region: Optional[str] = None) → FtpAccount

Parameters:

hosting_id – UUID of the hosting plan.
username – Username of the FTP account.
password – New password for the FTP account.
region – Region to target. If none is passed will use default region from the config.

Returns:

FtpAccount

Usage:

result = api.change_ftp_account_password(
    hosting_id="example",
    username="example",
    password="example",
)

create_ftp_account(*, hosting_id: str, username: str, path: str, password: str, region: Optional[str] = None) → FtpAccount

Create a new FTP account within your hosting plan. :param hosting_id: UUID of the hosting plan. :param username: Username for the new FTP account. :param path: Path for the new FTP account. :param password: Password for the new FTP account. :param region: Region to target. If none is passed will use default region from the config. :return: FtpAccount

Usage:

result = api.create_ftp_account(
    hosting_id="example",
    username="example",
    path="example",
    password="example",
)

list_ftp_accounts(*, hosting_id: str, region: Optional[str] = None, page: Optional[int] = None, page_size: Optional[int] = None, order_by: Optional[ListFtpAccountsRequestOrderBy] = None, domain: Optional[str] = None) → ListFtpAccountsResponse

List all FTP accounts within your hosting plan. :param hosting_id: UUID of the hosting plan. :param region: Region to target. If none is passed will use default region from the config. :param page: Page number (must be a positive integer). :param page_size: Number of FTP accounts to return (must be a positive integer lower or equal to 100). :param order_by: Sort order of FTP accounts in the response. :param domain: Domain to filter the FTP accounts. :return: ListFtpAccountsResponse

Usage:

result = api.list_ftp_accounts(
    hosting_id="example",
)

list_ftp_accounts_all(*, hosting_id: str, region: Optional[str] = None, page: Optional[int] = None, page_size: Optional[int] = None, order_by: Optional[ListFtpAccountsRequestOrderBy] = None, domain: Optional[str] = None) → List[FtpAccount]

List all FTP accounts within your hosting plan. :param hosting_id: UUID of the hosting plan. :param region: Region to target. If none is passed will use default region from the config. :param page: Page number (must be a positive integer). :param page_size: Number of FTP accounts to return (must be a positive integer lower or equal to 100). :param order_by: Sort order of FTP accounts in the response. :param domain: Domain to filter the FTP accounts. :return: List[FtpAccount]

Usage:

result = api.list_ftp_accounts_all(
    hosting_id="example",
)

remove_ftp_account(*, hosting_id: str, username: str, region: Optional[str] = None) → FtpAccount

Delete a specific FTP account within your hosting plan. :param hosting_id: UUID of the hosting plan. :param username: Username of the FTP account to be deleted. :param region: Region to target. If none is passed will use default region from the config. :return: FtpAccount

Usage:

result = api.remove_ftp_account(
    hosting_id="example",
    username="example",
)

class scaleway.webhosting.v1.WebhostingV1HostingAPI(client: Client, *, bypass_validation: bool = False)

Bases: API

This API allows you to manage your Web Hosting services.

create_hosting(*, offer_id: str, email: str, domain: str, region: Optional[str] = None, project_id: Optional[str] = None, tags: Optional[List[str]] = None, offer_options: Optional[List[OfferOptionRequest]] = None, language: Optional[LanguageCode] = None, domain_configuration: Optional[CreateHostingRequestDomainConfiguration] = None, skip_welcome_email: Optional[bool] = None, auto_config_domain_dns: Optional[AutoConfigDomainDns] = None) → Hosting

Order a Web Hosting plan. Order a Web Hosting plan, specifying the offer type required via the offer_id parameter. :param offer_id: ID of the selected offer for the Web Hosting plan. :param email: Contact email for the Web Hosting client. :param 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. :param region: Region to target. If none is passed will use default region from the config. :param project_id: ID of the Scaleway Project in which to create the Web Hosting plan. :param tags: List of tags for the Web Hosting plan. :param offer_options: List of the Web Hosting plan options IDs with their quantities. :param language: Default language for the control panel interface. :param domain_configuration: Indicates whether to update hosting domain name servers and DNS records for domains managed by Scaleway Elements (deprecated, use auto_config_domain_dns instead). :param skip_welcome_email: Indicates whether to skip a welcome email to the contact email containing hosting info. :param auto_config_domain_dns: Indicates whether to update hosting domain name servers and DNS records for domains managed by Scaleway Elements (deprecated, use auto_update_* fields instead). :return: Hosting

Usage:

result = api.create_hosting(
    offer_id="example",
    email="example",
    domain="example",
)

create_session(*, hosting_id: str, region: Optional[str] = None) → Session

Create a user session. :param hosting_id: Hosting ID. :param region: Region to target. If none is passed will use default region from the config. :return: Session

Usage:

result = api.create_session(
    hosting_id="example",
)

delete_hosting(*, hosting_id: str, region: Optional[str] = None) → Hosting

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. :param hosting_id: Hosting ID. :param region: Region to target. If none is passed will use default region from the config. :return: Hosting

Usage:

result = api.delete_hosting(
    hosting_id="example",
)

get_hosting(*, hosting_id: str, region: Optional[str] = None) → Hosting

Get a Web Hosting plan. Get the details of one of your existing Web Hosting plans, specified by its hosting_id. :param hosting_id: Hosting ID. :param region: Region to target. If none is passed will use default region from the config. :return: Hosting

Usage:

result = api.get_hosting(
    hosting_id="example",
)

get_resource_summary(*, hosting_id: str, region: Optional[str] = None) → ResourceSummary

Get the total counts of websites, databases, email accounts, and FTP accounts of a Web Hosting plan. :param hosting_id: Hosting ID. :param region: Region to target. If none is passed will use default region from the config. :return: ResourceSummary

Usage:

result = api.get_resource_summary(
    hosting_id="example",
)

list_hostings(*, region: Optional[str] = None, page: Optional[int] = None, page_size: Optional[int] = None, order_by: Optional[ListHostingsRequestOrderBy] = None, tags: Optional[List[str]] = None, statuses: Optional[List[HostingStatus]] = None, domain: Optional[str] = None, project_id: Optional[str] = None, organization_id: Optional[str] = None, control_panels: Optional[List[str]] = None) → ListHostingsResponse

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. :param region: Region to target. If none is passed will use default region from the config. :param page: Page number to return, from the paginated results (must be a positive integer). :param page_size: Number of Web Hosting plans to return (must be a positive integer lower or equal to 100). :param order_by: Sort order for Web Hosting plans in the response. :param tags: Tags to filter for, only Web Hosting plans with matching tags will be returned. :param statuses: Statuses to filter for, only Web Hosting plans with matching statuses will be returned. :param domain: Domain to filter for, only Web Hosting plans associated with this domain will be returned. :param project_id: Project ID to filter for, only Web Hosting plans from this Project will be returned. :param organization_id: Organization ID to filter for, only Web Hosting plans from this Organization will be returned. :param control_panels: Name of the control panel to filter for, only Web Hosting plans from this control panel will be returned. :return: ListHostingsResponse

Usage:

result = api.list_hostings()

list_hostings_all(*, region: Optional[str] = None, page: Optional[int] = None, page_size: Optional[int] = None, order_by: Optional[ListHostingsRequestOrderBy] = None, tags: Optional[List[str]] = None, statuses: Optional[List[HostingStatus]] = None, domain: Optional[str] = None, project_id: Optional[str] = None, organization_id: Optional[str] = None, control_panels: Optional[List[str]] = None) → List[HostingSummary]

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. :param region: Region to target. If none is passed will use default region from the config. :param page: Page number to return, from the paginated results (must be a positive integer). :param page_size: Number of Web Hosting plans to return (must be a positive integer lower or equal to 100). :param order_by: Sort order for Web Hosting plans in the response. :param tags: Tags to filter for, only Web Hosting plans with matching tags will be returned. :param statuses: Statuses to filter for, only Web Hosting plans with matching statuses will be returned. :param domain: Domain to filter for, only Web Hosting plans associated with this domain will be returned. :param project_id: Project ID to filter for, only Web Hosting plans from this Project will be returned. :param organization_id: Organization ID to filter for, only Web Hosting plans from this Organization will be returned. :param control_panels: Name of the control panel to filter for, only Web Hosting plans from this control panel will be returned. :return: List[HostingSummary]

Usage:

result = api.list_hostings_all()

reset_hosting_password(*, hosting_id: str, region: Optional[str] = None) → ResetHostingPasswordResponse

Reset a Web Hosting plan password. :param hosting_id: UUID of the hosting. :param region: Region to target. If none is passed will use default region from the config. :return: ResetHostingPasswordResponse

Usage:

result = api.reset_hosting_password(
    hosting_id="example",
)

update_hosting(*, hosting_id: str, region: Optional[str] = None, email: Optional[str] = None, tags: Optional[List[str]] = None, offer_options: Optional[List[OfferOptionRequest]] = None, offer_id: Optional[str] = None, protected: Optional[bool] = None) → Hosting

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. :param hosting_id: Hosting ID. :param region: Region to target. If none is passed will use default region from the config. :param email: New contact email for the Web Hosting plan. :param tags: New tags for the Web Hosting plan. :param offer_options: List of the Web Hosting plan options IDs with their quantities. :param offer_id: ID of the new offer for the Web Hosting plan. :param protected: Whether the hosting is protected or not. :return: Hosting

Usage:

result = api.update_hosting(
    hosting_id="example",
)

wait_for_hosting(*, hosting_id: str, region: Optional[str] = None, options: Optional[WaitForOptions[Hosting, bool]] = None) → Hosting

Get a Web Hosting plan. Get the details of one of your existing Web Hosting plans, specified by its hosting_id. :param hosting_id: Hosting ID. :param region: Region to target. If none is passed will use default region from the config. :return: Hosting

Usage:

result = api.get_hosting(
    hosting_id="example",
)

class scaleway.webhosting.v1.WebhostingV1MailAccountAPI(client: Client, *, bypass_validation: bool = False)

Bases: API

This API allows you to manage your mail accounts for your Web Hosting services.

change_mail_account_password(*, hosting_id: str, domain: str, username: str, password: str, region: Optional[str] = None) → MailAccount

Update the password of a mail account within your hosting plan. :param hosting_id: UUID of the hosting plan. :param domain: Domain part of the mail account address. :param username: Username part of the mail account address. :param password: New password for the mail account. :param region: Region to target. If none is passed will use default region from the config. :return: MailAccount

Usage:

result = api.change_mail_account_password(
    hosting_id="example",
    domain="example",
    username="example",
    password="example",
)

create_mail_account(*, hosting_id: str, domain: str, username: str, password: str, region: Optional[str] = None) → MailAccount

Create a new mail account within your hosting plan. :param hosting_id: UUID of the hosting plan. :param domain: Domain part of the mail account address. :param username: Username part address of the mail account address. :param password: Password for the new mail account. :param region: Region to target. If none is passed will use default region from the config. :return: MailAccount

Usage:

result = api.create_mail_account(
    hosting_id="example",
    domain="example",
    username="example",
    password="example",
)

list_mail_accounts(*, hosting_id: str, region: Optional[str] = None, page: Optional[int] = None, page_size: Optional[int] = None, order_by: Optional[ListMailAccountsRequestOrderBy] = None, domain: Optional[str] = None) → ListMailAccountsResponse

List all mail accounts within your hosting plan. :param hosting_id: UUID of the hosting plan. :param region: Region to target. If none is passed will use default region from the config. :param page: Page number (must be a positive integer). :param page_size: Number of mail accounts to return (must be a positive integer lower or equal to 100). :param order_by: Sort order of mail accounts in the response. :param domain: Domain to filter the mail accounts. :return: ListMailAccountsResponse

Usage:

result = api.list_mail_accounts(
    hosting_id="example",
)

list_mail_accounts_all(*, hosting_id: str, region: Optional[str] = None, page: Optional[int] = None, page_size: Optional[int] = None, order_by: Optional[ListMailAccountsRequestOrderBy] = None, domain: Optional[str] = None) → List[MailAccount]

List all mail accounts within your hosting plan. :param hosting_id: UUID of the hosting plan. :param region: Region to target. If none is passed will use default region from the config. :param page: Page number (must be a positive integer). :param page_size: Number of mail accounts to return (must be a positive integer lower or equal to 100). :param order_by: Sort order of mail accounts in the response. :param domain: Domain to filter the mail accounts. :return: List[MailAccount]

Usage:

result = api.list_mail_accounts_all(
    hosting_id="example",
)

remove_mail_account(*, hosting_id: str, domain: str, username: str, region: Optional[str] = None) → MailAccount

Delete a mail account within your hosting plan. :param hosting_id: UUID of the hosting plan. :param domain: Domain part of the mail account address. :param username: Username part of the mail account address. :param region: Region to target. If none is passed will use default region from the config. :return: MailAccount

Usage:

result = api.remove_mail_account(
    hosting_id="example",
    domain="example",
    username="example",
)

class scaleway.webhosting.v1.WebhostingV1OfferAPI(client: Client, *, bypass_validation: bool = False)

Bases: API

This API allows you to manage your offer for your Web Hosting services.

list_offers(*, region: Optional[str] = None, page: Optional[int] = None, page_size: Optional[int] = None, order_by: Optional[ListOffersRequestOrderBy] = None, hosting_id: Optional[str] = None, control_panels: Optional[List[str]] = None) → ListOffersResponse

List all available hosting offers along with their specific options. :param region: Region to target. If none is passed will use default region from the config. :param page: Page number (must be a positive integer). :param page_size: Number of websites to return (must be a positive integer lower or equal to 100). :param order_by: Sort order for Web Hosting offers in the response. :param hosting_id: UUID of the hosting plan. :param control_panels: Name of the control panel(s) to filter for. :return: ListOffersResponse

Usage:

result = api.list_offers()

list_offers_all(*, region: Optional[str] = None, page: Optional[int] = None, page_size: Optional[int] = None, order_by: Optional[ListOffersRequestOrderBy] = None, hosting_id: Optional[str] = None, control_panels: Optional[List[str]] = None) → List[Offer]

List all available hosting offers along with their specific options. :param region: Region to target. If none is passed will use default region from the config. :param page: Page number (must be a positive integer). :param page_size: Number of websites to return (must be a positive integer lower or equal to 100). :param order_by: Sort order for Web Hosting offers in the response. :param hosting_id: UUID of the hosting plan. :param control_panels: Name of the control panel(s) to filter for. :return: List[Offer]

Usage:

result = api.list_offers_all()

class scaleway.webhosting.v1.WebhostingV1WebsiteAPI(client: Client, *, bypass_validation: bool = False)

Bases: API

This API allows you to manage your websites for your Web Hosting services.

list_websites(*, hosting_id: str, region: Optional[str] = None, page: Optional[int] = None, page_size: Optional[int] = None, order_by: Optional[ListWebsitesRequestOrderBy] = None) → ListWebsitesResponse

List all websites for a specific hosting. :param hosting_id: UUID of the hosting plan. :param region: Region to target. If none is passed will use default region from the config. :param page: Page number (must be a positive integer). :param page_size: Number of websites to return (must be a positive integer lower or equal to 100). :param order_by: Sort order for Web Hosting websites in the response. :return: ListWebsitesResponse

Usage:

result = api.list_websites(
    hosting_id="example",
)

list_websites_all(*, hosting_id: str, region: Optional[str] = None, page: Optional[int] = None, page_size: Optional[int] = None, order_by: Optional[ListWebsitesRequestOrderBy] = None) → List[Website]

List all websites for a specific hosting. :param hosting_id: UUID of the hosting plan. :param region: Region to target. If none is passed will use default region from the config. :param page: Page number (must be a positive integer). :param page_size: Number of websites to return (must be a positive integer lower or equal to 100). :param order_by: Sort order for Web Hosting websites in the response. :return: List[Website]

Usage:

result = api.list_websites_all(
    hosting_id="example",
)

class scaleway.webhosting.v1.Website(domain: 'str', path: 'str', ssl_status: 'bool')

Bases: object

domain: str: The domain of the website.

path: str: The directory path of the website.

ssl_status: bool: The SSL status of the website.

class scaleway.webhosting.v1.WebsiteApiListWebsitesRequest(hosting_id: 'str', region: 'Optional[ScwRegion]', page: 'Optional[int]', page_size: 'Optional[int]', order_by: 'Optional[ListWebsitesRequestOrderBy]')

Bases: object

hosting_id: str: UUID of the hosting plan.

order_by: Optional[ListWebsitesRequestOrderBy]: Sort order for Web Hosting websites in the response.

page: Optional[int]: Page number (must be a positive integer).

page_size: Optional[int]: Number of websites to return (must be a positive integer lower or equal to 100).

region: Optional[str]: Region to target. If none is passed will use default region from the config.