scaleway.domain.v2beta1 package

Submodules

scaleway.domain.v2beta1.api module

class scaleway.domain.v2beta1.api.DomainV2Beta1API(client: Client, *, bypass_validation: bool = False)

Bases: API

This API allows you to manage your domains, DNS zones and records.

clear_dns_zone_records(*, dns_zone: str) → ClearDNSZoneRecordsResponse

Clear records within a DNS zone. Delete all records within a DNS zone that has default name servers. All edits will be versioned. :param dns_zone: DNS zone to clear. :return: ClearDNSZoneRecordsResponse

Usage:

result = api.clear_dns_zone_records(
    dns_zone="example",
)

clone_dns_zone(*, dns_zone: str, dest_dns_zone: str, overwrite: bool, project_id: str | None = None) → DNSZone

Clone a DNS zone. Clone an existing DNS zone with all its records into a new DNS zone. :param dns_zone: DNS zone to clone. :param dest_dns_zone: Destination DNS zone in which to clone the chosen DNS zone. :param overwrite: Specifies whether or not the destination DNS zone will be overwritten. :param project_id: Project ID of the destination DNS zone. :return: DNSZone

Usage:

result = api.clone_dns_zone(
    dns_zone="example",
    dest_dns_zone="example",
    overwrite=False,
)

create_dns_zone(*, domain: str, subdomain: str, project_id: str | None = None) → DNSZone

Create a DNS zone. Create a new DNS zone specified by the domain name, the subdomain and the Project ID. :param domain: Domain in which to crreate the DNS zone. :param subdomain: Subdomain of the DNS zone to create. :param project_id: Project ID in which to create the DNS zone. :return: DNSZone

Usage:

result = api.create_dns_zone(
    domain="example",
    subdomain="example",
)

create_ssl_certificate(*, dns_zone: str, alternative_dns_zones: List[str] | None = None) → SSLCertificate

Create or get the DNS zone’s TLS certificate. Create a new TLS certificate or retrieve information about an existing TLS certificate. :param dns_zone: :param alternative_dns_zones: :return: SSLCertificate

Usage:

result = api.create_ssl_certificate(
    dns_zone="example",
)

delete_dns_zone(*, dns_zone: str, project_id: str | None = None) → DeleteDNSZoneResponse

Delete a DNS zone. Delete a DNS zone and all its records. :param dns_zone: DNS zone to delete. :param project_id: Project ID of the DNS zone to delete. :return: DeleteDNSZoneResponse

Usage:

result = api.delete_dns_zone(
    dns_zone="example",
)

delete_dns_zone_tsig_key(*, dns_zone: str) → None

Delete the DNS zone’s TSIG key. Delete an existing TSIG key specified by its DNS zone. Deleting a TSIG key is permanent and cannot be undone. :param dns_zone:

Usage:

result = api.delete_dns_zone_tsig_key(
    dns_zone="example",
)

delete_ssl_certificate(*, dns_zone: str) → DeleteSSLCertificateResponse

Delete a TLS certificate. Delete an existing TLS certificate specified by its DNS zone. Deleting a TLS certificate is permanent and cannot be undone. :param dns_zone: :return: DeleteSSLCertificateResponse

Usage:

result = api.delete_ssl_certificate(
    dns_zone="example",
)

export_raw_dns_zone(*, dns_zone: str, format: RawFormat | None = None) → ScwFile

Export a raw DNS zone. Export a DNS zone with default name servers, in a specific format. :param dns_zone: DNS zone to export. :param format: DNS zone format. :return: ScwFile

Usage:

result = api.export_raw_dns_zone(
    dns_zone="example",
)

get_dns_zone_tsig_key(*, dns_zone: str) → GetDNSZoneTsigKeyResponse

Get the DNS zone’s TSIG key. Retrieve information about the TSIG key of a given DNS zone to allow AXFR requests. :param dns_zone: :return: GetDNSZoneTsigKeyResponse

Usage:

result = api.get_dns_zone_tsig_key(
    dns_zone="example",
)

get_dns_zone_version_diff(*, dns_zone_version_id: str) → GetDNSZoneVersionDiffResponse

Access differences from a specific DNS zone version. Access a previous DNS zone version to see the differences from another specific version. :param dns_zone_version_id: :return: GetDNSZoneVersionDiffResponse

Usage:

result = api.get_dns_zone_version_diff(
    dns_zone_version_id="example",
)

get_ssl_certificate(*, dns_zone: str) → SSLCertificate

Get a DNS zone’s TLS certificate. Get the DNS zone’s TLS certificate. If you do not have a certificate, the ouptut returns no certificate found. :param dns_zone: :return: SSLCertificate

Usage:

result = api.get_ssl_certificate(
    dns_zone="example",
)

import_provider_dns_zone(*, dns_zone: str, online_v1: ImportProviderDNSZoneRequestOnlineV1 | None = None) → ImportProviderDNSZoneResponse

Import a DNS zone from another provider. Import and replace the format of records from a given provider, with default name servers. :param dns_zone: :param online_v1: One-Of (‘provider’): at most one of ‘online_v1’ could be set. :return: ImportProviderDNSZoneResponse

Usage:

result = api.import_provider_dns_zone(
    dns_zone="example",
)

import_raw_dns_zone(*, dns_zone: str, content: str | None = None, project_id: str | None = None, format: RawFormat | None = None, bind_source: ImportRawDNSZoneRequestBindSource | None = None, axfr_source: ImportRawDNSZoneRequestAXFRSource | None = None) → ImportRawDNSZoneResponse

Import a raw DNS zone. Import and replace the format of records from a given provider, with default name servers. :param dns_zone: DNS zone to import. :param content: :param project_id: :param format: :param bind_source: Import a bind file format. One-Of (‘source’): at most one of ‘bind_source’, ‘axfr_source’ could be set. :param axfr_source: Import from the name server given with TSIG, to use or not. One-Of (‘source’): at most one of ‘bind_source’, ‘axfr_source’ could be set. :return: ImportRawDNSZoneResponse

Usage:

result = api.import_raw_dns_zone(
    dns_zone="example",
)

list_dns_zone_nameservers(*, project_id: str | None = None, dns_zone: str) → ListDNSZoneNameserversResponse

List name servers within a DNS zone. Retrieve a list of name servers within a DNS zone and their optional glue records. :param project_id: Project ID on which to filter the returned DNS zone name servers. :param dns_zone: DNS zone on which to filter the returned DNS zone name servers. :return: ListDNSZoneNameserversResponse

Usage:

result = api.list_dns_zone_nameservers(
    dns_zone="example",
)

List records within a DNS zone. Retrieve a list of DNS records within a DNS zone that has default name servers. You can filter records by type and name. :param project_id: Project ID on which to filter the returned DNS zone records. :param order_by: Sort order of the returned DNS zone records. :param page: Page number to return, from the paginated results. :param page_size: Maximum number of DNS zone records per page. :param dns_zone: DNS zone on which to filter the returned DNS zone records. :param name: Name on which to filter the returned DNS zone records. :param type_: Record type on which to filter the returned DNS zone records. :param id: Record ID on which to filter the returned DNS zone records. :return: ListDNSZoneRecordsResponse

Usage:

result = api.list_dns_zone_records(
    dns_zone="example",
    name="example",
)

List records within a DNS zone. Retrieve a list of DNS records within a DNS zone that has default name servers. You can filter records by type and name. :param project_id: Project ID on which to filter the returned DNS zone records. :param order_by: Sort order of the returned DNS zone records. :param page: Page number to return, from the paginated results. :param page_size: Maximum number of DNS zone records per page. :param dns_zone: DNS zone on which to filter the returned DNS zone records. :param name: Name on which to filter the returned DNS zone records. :param type_: Record type on which to filter the returned DNS zone records. :param id: Record ID on which to filter the returned DNS zone records. :return: List[Record]

Usage:

result = api.list_dns_zone_records_all(
    dns_zone="example",
    name="example",
)

list_dns_zone_version_records(*, page: int | None = None, page_size: int | None = None, dns_zone_version_id: str) → ListDNSZoneVersionRecordsResponse

List records from a given version of a specific DNS zone. Retrieve a list of records from a specific DNS zone version. :param page: Page number to return, from the paginated results. :param page_size: Maximum number of DNS zones versions records per page. :param dns_zone_version_id: :return: ListDNSZoneVersionRecordsResponse

Usage:

result = api.list_dns_zone_version_records(
    dns_zone_version_id="example",
)

list_dns_zone_version_records_all(*, page: int | None = None, page_size: int | None = None, dns_zone_version_id: str) → List[Record]

List records from a given version of a specific DNS zone. Retrieve a list of records from a specific DNS zone version. :param page: Page number to return, from the paginated results. :param page_size: Maximum number of DNS zones versions records per page. :param dns_zone_version_id: :return: List[Record]

Usage:

result = api.list_dns_zone_version_records_all(
    dns_zone_version_id="example",
)

list_dns_zone_versions(*, page: int | None = None, page_size: int | None = None, dns_zone: str) → ListDNSZoneVersionsResponse

List versions of a DNS zone. Retrieve a list of a DNS zone’s versions. The maximum version count is 100. If the count reaches this limit, the oldest version will be deleted after each new modification. :param page: Page number to return, from the paginated results. :param page_size: Maximum number of DNS zones versions per page. :param dns_zone: :return: ListDNSZoneVersionsResponse

Usage:

result = api.list_dns_zone_versions(
    dns_zone="example",
)

list_dns_zone_versions_all(*, page: int | None = None, page_size: int | None = None, dns_zone: str) → List[DNSZoneVersion]

List versions of a DNS zone. Retrieve a list of a DNS zone’s versions. The maximum version count is 100. If the count reaches this limit, the oldest version will be deleted after each new modification. :param page: Page number to return, from the paginated results. :param page_size: Maximum number of DNS zones versions per page. :param dns_zone: :return: List[DNSZoneVersion]

Usage:

result = api.list_dns_zone_versions_all(
    dns_zone="example",
)

List DNS zones. Retrieve the list of DNS zones you can manage and filter DNS zones associated with specific domain names. :param domain: Domain on which to filter the returned DNS zones. :param organization_id: Organization ID on which to filter the returned DNS zones. :param project_id: Project ID on which to filter the returned DNS zones. :param order_by: Sort order of the returned DNS zones. :param page: Page number to return, from the paginated results. :param page_size: Maximum number of DNS zones to return per page. :param dns_zone: DNS zone on which to filter the returned DNS zones. :param dns_zones: DNS zones on which to filter the returned DNS zones. :param created_after: Only list DNS zones created after this date. :param created_before: Only list DNS zones created before this date. :param updated_after: Only list DNS zones updated after this date. :param updated_before: Only list DNS zones updated before this date. :return: ListDNSZonesResponse

Usage:

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

List DNS zones. Retrieve the list of DNS zones you can manage and filter DNS zones associated with specific domain names. :param domain: Domain on which to filter the returned DNS zones. :param organization_id: Organization ID on which to filter the returned DNS zones. :param project_id: Project ID on which to filter the returned DNS zones. :param order_by: Sort order of the returned DNS zones. :param page: Page number to return, from the paginated results. :param page_size: Maximum number of DNS zones to return per page. :param dns_zone: DNS zone on which to filter the returned DNS zones. :param dns_zones: DNS zones on which to filter the returned DNS zones. :param created_after: Only list DNS zones created after this date. :param created_before: Only list DNS zones created before this date. :param updated_after: Only list DNS zones updated after this date. :param updated_before: Only list DNS zones updated before this date. :return: List[DNSZone]

Usage:

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

list_ssl_certificates(*, dns_zone: str, page: int | None = None, page_size: int | None = None, project_id: str | None = None) → ListSSLCertificatesResponse

List a user’s TLS certificates. List all the TLS certificates a user has created, specified by the user’s Project ID and the DNS zone. :param dns_zone: :param page: :param page_size: :param project_id: :return: ListSSLCertificatesResponse

Usage:

result = api.list_ssl_certificates(
    dns_zone="example",
)

list_ssl_certificates_all(*, dns_zone: str, page: int | None = None, page_size: int | None = None, project_id: str | None = None) → List[SSLCertificate]

List a user’s TLS certificates. List all the TLS certificates a user has created, specified by the user’s Project ID and the DNS zone. :param dns_zone: :param page: :param page_size: :param project_id: :return: List[SSLCertificate]

Usage:

result = api.list_ssl_certificates_all(
    dns_zone="example",
)

refresh_dns_zone(*, dns_zone: str, recreate_dns_zone: bool, recreate_sub_dns_zone: bool) → RefreshDNSZoneResponse

Refresh a DNS zone. Refresh an SOA DNS zone to reload the records in the DNS zone and update the SOA serial. You can recreate the given DNS zone and its sub DNS zone if needed. :param dns_zone: DNS zone to refresh. :param recreate_dns_zone: Specifies whether or not to recreate the DNS zone. :param recreate_sub_dns_zone: Specifies whether or not to recreate the sub DNS zone. :return: RefreshDNSZoneResponse

Usage:

result = api.refresh_dns_zone(
    dns_zone="example",
    recreate_dns_zone=False,
    recreate_sub_dns_zone=False,
)

restore_dns_zone_version(*, dns_zone_version_id: str) → RestoreDNSZoneVersionResponse

Restore a DNS zone version. Restore and activate a version of a specific DNS zone. :param dns_zone_version_id: :return: RestoreDNSZoneVersionResponse

Usage:

result = api.restore_dns_zone_version(
    dns_zone_version_id="example",
)

update_dns_zone(*, dns_zone: str, new_dns_zone: str | None = None, project_id: str | None = None) → DNSZone

Update a DNS zone. Update the name and/or the Organizations for a DNS zone. :param dns_zone: DNS zone to update. :param new_dns_zone: Name of the new DNS zone to create. :param project_id: Project ID in which to create the new DNS zone. :return: DNSZone

Usage:

result = api.update_dns_zone(
    dns_zone="example",
)

update_dns_zone_nameservers(*, dns_zone: str, ns: List[Nameserver]) → UpdateDNSZoneNameserversResponse

Update name servers within a DNS zone. Update name servers within a DNS zone and set optional glue records. :param dns_zone: DNS zone in which to update the DNS zone name servers. :param ns: New DNS zone name servers. :return: UpdateDNSZoneNameserversResponse

Usage:

result = api.update_dns_zone_nameservers(
    dns_zone="example",
    ns=[],
)

update_dns_zone_records(*, dns_zone: str, changes: List[RecordChange], disallow_new_zone_creation: bool, return_all_records: bool | None = None, serial: int | None = None) → UpdateDNSZoneRecordsResponse

Update records within a DNS zone. Update records within a DNS zone that has default name servers and perform several actions on your records.

Actions include:

add: allows you to add a new record or add a new IP to an existing A record, for example
set: allows you to edit a record or edit an IP from an existing A record, for example
delete: allows you to delete a record or delete an IP from an existing A record, for example
clear: allows you to delete all records from a DNS zone

All edits will be versioned. :param dns_zone: DNS zone in which to update the DNS zone records. :param changes: Changes made to the records. :param disallow_new_zone_creation: Disable the creation of the target zone if it does not exist. Target zone creation is disabled by default. :param return_all_records: Specifies whether or not to return all the records. :param serial: Use the provided serial (0) instead of the auto-increment serial. :return: UpdateDNSZoneRecordsResponse

Usage:

result = api.update_dns_zone_records(
    dns_zone="example",
    changes=[],
    disallow_new_zone_creation=False,
)

wait_for_ssl_certificate(*, dns_zone: str, options: WaitForOptions[SSLCertificate, bool] | None = None) → SSLCertificate

Get a DNS zone’s TLS certificate. Get the DNS zone’s TLS certificate. If you do not have a certificate, the ouptut returns no certificate found. :param dns_zone: :return: SSLCertificate

Usage:

result = api.get_ssl_certificate(
    dns_zone="example",
)

class scaleway.domain.v2beta1.api.DomainV2Beta1RegistrarAPI(client: Client, *, bypass_validation: bool = False)

Bases: API

Manage your domains and contacts.

buy_domains(*, domains: List[str], duration_in_years: int, project_id: str | None = None, owner_contact_id: str | None = None, owner_contact: NewContact | None = None, administrative_contact_id: str | None = None, administrative_contact: NewContact | None = None, technical_contact_id: str | None = None, technical_contact: NewContact | None = None) → OrderResponse

Purchase domains. Request the registration of domain names. You can provide a domain’s already existing contact or a new contact. :param domains: :param duration_in_years: :param project_id: :param owner_contact_id: One-Of (‘owner_contact_type’): at most one of ‘owner_contact_id’, ‘owner_contact’ could be set. :param owner_contact: One-Of (‘owner_contact_type’): at most one of ‘owner_contact_id’, ‘owner_contact’ could be set. :param administrative_contact_id: One-Of (‘administrative_contact_type’): at most one of ‘administrative_contact_id’, ‘administrative_contact’ could be set. :param administrative_contact: One-Of (‘administrative_contact_type’): at most one of ‘administrative_contact_id’, ‘administrative_contact’ could be set. :param technical_contact_id: One-Of (‘technical_contact_type’): at most one of ‘technical_contact_id’, ‘technical_contact’ could be set. :param technical_contact: One-Of (‘technical_contact_type’): at most one of ‘technical_contact_id’, ‘technical_contact’ could be set. :return: OrderResponse

Usage:

result = api.buy_domains(
    domains=[],
    duration_in_years=1,
)

check_contacts_compatibility(*, domains: List[str] | None = None, tlds: List[str] | None = None, owner_contact_id: str | None = None, owner_contact: NewContact | None = None, administrative_contact_id: str | None = None, administrative_contact: NewContact | None = None, technical_contact_id: str | None = None, technical_contact: NewContact | None = None) → CheckContactsCompatibilityResponse

Check if contacts are compatible with a domain or a TLD. Check whether contacts are compatible with a domain or a TLD. If contacts are not compatible with either the domain or the TLD, the information that needs to be corrected is returned. :param domains: :param tlds: :param owner_contact_id: One-Of (‘owner_contact_type’): at most one of ‘owner_contact_id’, ‘owner_contact’ could be set. :param owner_contact: One-Of (‘owner_contact_type’): at most one of ‘owner_contact_id’, ‘owner_contact’ could be set. :param administrative_contact_id: One-Of (‘administrative_contact_type’): at most one of ‘administrative_contact_id’, ‘administrative_contact’ could be set. :param administrative_contact: One-Of (‘administrative_contact_type’): at most one of ‘administrative_contact_id’, ‘administrative_contact’ could be set. :param technical_contact_id: One-Of (‘technical_contact_type’): at most one of ‘technical_contact_id’, ‘technical_contact’ could be set. :param technical_contact: One-Of (‘technical_contact_type’): at most one of ‘technical_contact_id’, ‘technical_contact’ could be set. :return: CheckContactsCompatibilityResponse

Usage:

result = api.check_contacts_compatibility()

create_domain_host(*, domain: str, name: str, ips: List[str] | None = None) → Host

Create a hostname for a domain. Create a hostname for a domain with glue IPs. :param domain: :param name: :param ips: :return: Host

Usage:

result = api.create_domain_host(
    domain="example",
    name="example",
)

delete_domain_host(*, domain: str, name: str) → Host

Delete a domain’s hostname. :param domain: :param name: :return: Host

Usage:

result = api.delete_domain_host(
    domain="example",
    name="example",
)

delete_external_domain(*, domain: str) → DeleteExternalDomainResponse

Delete an external domain. Delete an external domain name. :param domain: :return: DeleteExternalDomainResponse

Usage:

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

disable_domain_auto_renew(*, domain: str) → Domain

Disable auto renew. Disable the auto renew feature for a domain. This means the domain will not be renewed before its expiry date. :param domain: :return: Domain

Usage:

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

disable_domain_dnssec(*, domain: str) → Domain

Disable a domain’s DNSSEC. Disable DNSSEC for a domain. :param domain: :return: Domain

Usage:

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

enable_domain_auto_renew(*, domain: str) → Domain

Enable auto renew. Enable the auto renew feature for a domain. This means the domain will be automatically renewed before its expiry date. :param domain: :return: Domain

Usage:

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

enable_domain_dnssec(*, domain: str, ds_record: DSRecord | None = None) → Domain

Update domain DNSSEC. If your domain uses another registrar and has the default Scaleway NS, you have to update the DS record at your registrar. :param domain: :param ds_record: :return: Domain

Usage:

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

get_contact(*, contact_id: str) → Contact

Get a contact. Retrieve a contact’s details from the registrar using the given contact’s ID. :param contact_id: :return: Contact

Usage:

result = api.get_contact(
    contact_id="example",
)

get_domain(*, domain: str) → Domain

Get domain. Retrieve a specific domain and display the domain’s information. :param domain: :return: Domain

Usage:

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

get_domain_auth_code(*, domain: str) → GetDomainAuthCodeResponse

Get a domain’s authorization code. Retrieve the authorization code to tranfer an unlocked domain. The output returns an error if the domain is locked. Some TLDs may have a different procedure to retrieve the authorization code. In that case, the information displays in the message field. :param domain: :return: GetDomainAuthCodeResponse

Usage:

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

List contacts. Retrieve the list of contacts and their associated domains and roles. You can filter the list by domain name. :param page: :param page_size: :param domain: :param project_id: :param organization_id: :param role: :param email_status: :return: ListContactsResponse

Usage:

result = api.list_contacts()

List contacts. Retrieve the list of contacts and their associated domains and roles. You can filter the list by domain name. :param page: :param page_size: :param domain: :param project_id: :param organization_id: :param role: :param email_status: :return: List[ContactRoles]

Usage:

result = api.list_contacts_all()

list_domain_hosts(*, page: int | None = None, page_size: int | None = None, domain: str) → ListDomainHostsResponse

List a domain’s hostnames. List a domain’s hostnames using their glue IPs. :param page: :param page_size: :param domain: :return: ListDomainHostsResponse

Usage:

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

list_domain_hosts_all(*, page: int | None = None, page_size: int | None = None, domain: str) → List[Host]

List a domain’s hostnames. List a domain’s hostnames using their glue IPs. :param page: :param page_size: :param domain: :return: List[Host]

Usage:

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

List domains. Retrieve the list of domains you own. :param page: :param page_size: :param order_by: :param registrar: :param status: :param project_id: :param organization_id: :param is_external: :param domain: :return: ListDomainsResponse

Usage:

result = api.list_domains()

List domains. Retrieve the list of domains you own. :param page: :param page_size: :param order_by: :param registrar: :param status: :param project_id: :param organization_id: :param is_external: :param domain: :return: List[DomainSummary]

Usage:

result = api.list_domains_all()

list_inbound_transfers(*, page: int, domain: str, page_size: int | None = None, project_id: str | None = None, organization_id: str | None = None) → ListInboundTransfersResponse

Parameters:

page –
domain –
page_size –
project_id –
organization_id –

Returns:

ListInboundTransfersResponse

Usage:

result = api.list_inbound_transfers(
    page=1,
    domain="example",
)

list_inbound_transfers_all(*, page: int, domain: str, page_size: int | None = None, project_id: str | None = None, organization_id: str | None = None) → List[InboundTransfer]

Parameters:

page –
domain –
page_size –
project_id –
organization_id –

Returns:

List[InboundTransfer]

Usage:

result = api.list_inbound_transfers_all(
    page=1,
    domain="example",
)

List domains that can be renewed. Retrieve the list of domains you own that can be renewed. You can also see the maximum renewal duration in years for your domains that are renewable. :param page: :param page_size: :param order_by: :param project_id: :param organization_id: :return: ListRenewableDomainsResponse

Usage:

result = api.list_renewable_domains()

List domains that can be renewed. Retrieve the list of domains you own that can be renewed. You can also see the maximum renewal duration in years for your domains that are renewable. :param page: :param page_size: :param order_by: :param project_id: :param organization_id: :return: List[RenewableDomain]

Usage:

result = api.list_renewable_domains_all()

List tasks. List all operations performed on the account. You can filter the list of tasks by domain name. :param page: :param page_size: :param project_id: :param organization_id: :param domain: :param types: :param statuses: :param order_by: :return: ListTasksResponse

Usage:

result = api.list_tasks()

List tasks. List all operations performed on the account. You can filter the list of tasks by domain name. :param page: :param page_size: :param project_id: :param organization_id: :param domain: :param types: :param statuses: :param order_by: :return: List[Task]

Usage:

result = api.list_tasks_all()

list_tlds(*, tlds: List[str] | None = None, page: int | None = None, page_size: int | None = None, order_by: ListTldsRequestOrderBy | None = None) → ListTldsResponse

List TLD offers. Retrieve the list of TLDs and offers associated with them. :param tlds: Array of TLDs to return. :param page: Page number for the returned Projects. :param page_size: Maximum number of Project per page. :param order_by: Sort order of the returned TLDs. :return: ListTldsResponse

Usage:

result = api.list_tlds()

list_tlds_all(*, tlds: List[str] | None = None, page: int | None = None, page_size: int | None = None, order_by: ListTldsRequestOrderBy | None = None) → List[Tld]

List TLD offers. Retrieve the list of TLDs and offers associated with them. :param tlds: Array of TLDs to return. :param page: Page number for the returned Projects. :param page_size: Maximum number of Project per page. :param order_by: Sort order of the returned TLDs. :return: List[Tld]

Usage:

result = api.list_tlds_all()

lock_domain_transfer(*, domain: str) → Domain

Lock the transfer of a domain. Lock the transfer of a domain. This means that the domain cannot be transferred and the authorization code cannot be requested to your current registrar. :param domain: :return: Domain

Usage:

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

register_external_domain(*, domain: str, project_id: str | None = None) → RegisterExternalDomainResponse

Register an external domain. Request the registration of an external domain name. :param domain: :param project_id: :return: RegisterExternalDomainResponse

Usage:

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

renew_domains(*, domains: List[str], duration_in_years: int, force_late_renewal: bool | None = None) → OrderResponse

Renew domains. Request the renewal of one or more domain names. :param domains: :param duration_in_years: :param force_late_renewal: :return: OrderResponse

Usage:

result = api.renew_domains(
    domains=[],
    duration_in_years=1,
)

search_available_domains(*, domains: List[str], strict_search: bool, tlds: List[str] | None = None) → SearchAvailableDomainsResponse

Search available domains. Search a domain or a maximum of 10 domains that are available.

If the TLD list is empty or not set, the search returns the results from the most popular TLDs. :param domains: A list of domain to search, TLD is optional. :param strict_search: Search exact match. :param tlds: Array of tlds to search on. :return: SearchAvailableDomainsResponse

Usage:

result = api.search_available_domains(
    domains=[],
    strict_search=False,
)

trade_domain(*, domain: str, project_id: str | None = None, new_owner_contact_id: str | None = None, new_owner_contact: NewContact | None = None) → OrderResponse

Trade a domain’s contact. Request to change a domain’s contact owner. If you specify the organization_id of the domain’s new owner, the contact will change from the current owner’s Scaleway account to the new owner’s Scaleway account. If the new owner’s current contact information is not available, the first ever contact they have created for previous domains is taken into account to operate the change. If the new owner has never created a contact to register domains before, an error message displays. :param domain: :param project_id: :param new_owner_contact_id: One-Of (‘new_owner_contact_type’): at most one of ‘new_owner_contact_id’, ‘new_owner_contact’ could be set. :param new_owner_contact: One-Of (‘new_owner_contact_type’): at most one of ‘new_owner_contact_id’, ‘new_owner_contact’ could be set. :return: OrderResponse

Usage:

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

transfer_in_domain(*, domains: List[TransferInDomainRequestTransferRequest], project_id: str | None = None, owner_contact_id: str | None = None, owner_contact: NewContact | None = None, administrative_contact_id: str | None = None, administrative_contact: NewContact | None = None, technical_contact_id: str | None = None, technical_contact: NewContact | None = None) → OrderResponse

Transfer a domain. Request the transfer of a domain from another registrar to Scaleway Domains and DNS. :param domains: :param project_id: :param owner_contact_id: One-Of (‘owner_contact_type’): at most one of ‘owner_contact_id’, ‘owner_contact’ could be set. :param owner_contact: One-Of (‘owner_contact_type’): at most one of ‘owner_contact_id’, ‘owner_contact’ could be set. :param administrative_contact_id: One-Of (‘administrative_contact_type’): at most one of ‘administrative_contact_id’, ‘administrative_contact’ could be set. :param administrative_contact: One-Of (‘administrative_contact_type’): at most one of ‘administrative_contact_id’, ‘administrative_contact’ could be set. :param technical_contact_id: One-Of (‘technical_contact_type’): at most one of ‘technical_contact_id’, ‘technical_contact’ could be set. :param technical_contact: One-Of (‘technical_contact_type’): at most one of ‘technical_contact_id’, ‘technical_contact’ could be set. :return: OrderResponse

Usage:

result = api.transfer_in_domain(
    domains=[],
)

unlock_domain_transfer(*, domain: str) → Domain

Unlock the transfer of a domain. Unlock the transfer of a domain. This means that the domain can be transferred and the authorization code can be requested to your current registrar. :param domain: :return: Domain

Usage:

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

Update contact. Edit the contact’s information. :param contact_id: :param email: :param email_alt: :param phone_number: :param fax_number: :param address_line_1: :param address_line_2: :param zip: :param city: :param country: :param vat_identification_code: :param company_identification_code: :param lang: :param resale: :param questions: :param extension_fr: :param extension_eu: :param whois_opt_in: :param state: :param extension_nl: :return: Contact

Usage:

result = api.update_contact(
    contact_id="example",
)

update_domain(*, domain: str, technical_contact_id: str | None = None, technical_contact: NewContact | None = None, owner_contact_id: str | None = None, owner_contact: NewContact | None = None, administrative_contact_id: str | None = None, administrative_contact: NewContact | None = None) → Domain

Update a domain’s contacts. Update contacts for a specific domain or create a new contact. If you add the same contact for multiple roles (owner, administrative, technical), only one ID will be created and used for all of the roles. :param domain: :param technical_contact_id: One-Of (‘technical_contact_info’): at most one of ‘technical_contact_id’, ‘technical_contact’ could be set. :param technical_contact: One-Of (‘technical_contact_info’): at most one of ‘technical_contact_id’, ‘technical_contact’ could be set. :param owner_contact_id: One-Of (‘owner_contact_info’): at most one of ‘owner_contact_id’, ‘owner_contact’ could be set. :param owner_contact: One-Of (‘owner_contact_info’): at most one of ‘owner_contact_id’, ‘owner_contact’ could be set. :param administrative_contact_id: One-Of (‘administrative_contact_info’): at most one of ‘administrative_contact_id’, ‘administrative_contact’ could be set. :param administrative_contact: One-Of (‘administrative_contact_info’): at most one of ‘administrative_contact_id’, ‘administrative_contact’ could be set. :return: Domain

Usage:

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

update_domain_host(*, domain: str, name: str, ips: List[str] | None = None) → Host

Update a domain’s hostname. Update a domain’s hostname with glue IPs. :param domain: :param name: :param ips: :return: Host

Usage:

result = api.update_domain_host(
    domain="example",
    name="example",
)

wait_for_domain(*, domain: str, options: WaitForOptions[Domain, bool] | None = None) → Domain

Get domain. Retrieve a specific domain and display the domain’s information. :param domain: :return: Domain

Usage:

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

scaleway.domain.v2beta1.content module

scaleway.domain.v2beta1.content.DNS_ZONE_TRANSIENT_STATUSES: List[DNSZoneStatus] = [<DNSZoneStatus.PENDING: 'pending'>]: Lists transient statutes of the enum DNSZoneStatus.

scaleway.domain.v2beta1.content.DOMAIN_FEATURE_TRANSIENT_STATUSES: List[DomainFeatureStatus] = [<DomainFeatureStatus.ENABLING: 'enabling'>, <DomainFeatureStatus.DISABLING: 'disabling'>]: Lists transient statutes of the enum DomainFeatureStatus.

scaleway.domain.v2beta1.content.DOMAIN_REGISTRATION_STATUS_TRANSFER_TRANSIENT_STATUSES: List[DomainRegistrationStatusTransferStatus] = [<DomainRegistrationStatusTransferStatus.PENDING: 'pending'>, <DomainRegistrationStatusTransferStatus.PROCESSING: 'processing'>]: Lists transient statutes of the enum DomainRegistrationStatusTransferStatus.

scaleway.domain.v2beta1.content.DOMAIN_TRANSIENT_STATUSES: List[DomainStatus] = [<DomainStatus.CREATING: 'creating'>, <DomainStatus.RENEWING: 'renewing'>, <DomainStatus.XFERING: 'xfering'>, <DomainStatus.EXPIRING: 'expiring'>, <DomainStatus.UPDATING: 'updating'>, <DomainStatus.CHECKING: 'checking'>, <DomainStatus.DELETING: 'deleting'>]: Lists transient statutes of the enum DomainStatus.

scaleway.domain.v2beta1.content.HOST_TRANSIENT_STATUSES: List[HostStatus] = [<HostStatus.UPDATING: 'updating'>, <HostStatus.DELETING: 'deleting'>]: Lists transient statutes of the enum HostStatus.

scaleway.domain.v2beta1.content.SSL_CERTIFICATE_TRANSIENT_STATUSES: List[SSLCertificateStatus] = [<SSLCertificateStatus.PENDING: 'pending'>]: Lists transient statutes of the enum SSLCertificateStatus.

scaleway.domain.v2beta1.content.TASK_TRANSIENT_STATUSES: List[TaskStatus] = [<TaskStatus.PENDING: 'pending'>]: Lists transient statutes of the enum TaskStatus.

scaleway.domain.v2beta1.marshalling module

scaleway.domain.v2beta1.marshalling.marshal_CloneDNSZoneRequest(request: CloneDNSZoneRequest, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.domain.v2beta1.marshalling.marshal_ContactExtensionEU(request: ContactExtensionEU, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.domain.v2beta1.marshalling.marshal_ContactExtensionFR(request: ContactExtensionFR, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.domain.v2beta1.marshalling.marshal_ContactExtensionFRAssociationInfo(request: ContactExtensionFRAssociationInfo, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.domain.v2beta1.marshalling.marshal_ContactExtensionFRCodeAuthAfnicInfo(request: ContactExtensionFRCodeAuthAfnicInfo, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.domain.v2beta1.marshalling.marshal_ContactExtensionFRDunsInfo(request: ContactExtensionFRDunsInfo, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.domain.v2beta1.marshalling.marshal_ContactExtensionFRIndividualInfo(request: ContactExtensionFRIndividualInfo, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.domain.v2beta1.marshalling.marshal_ContactExtensionFRTrademarkInfo(request: ContactExtensionFRTrademarkInfo, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.domain.v2beta1.marshalling.marshal_ContactExtensionNL(request: ContactExtensionNL, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.domain.v2beta1.marshalling.marshal_ContactQuestion(request: ContactQuestion, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.domain.v2beta1.marshalling.marshal_CreateDNSZoneRequest(request: CreateDNSZoneRequest, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.domain.v2beta1.marshalling.marshal_CreateSSLCertificateRequest(request: CreateSSLCertificateRequest, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.domain.v2beta1.marshalling.marshal_DSRecord(request: DSRecord, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.domain.v2beta1.marshalling.marshal_DSRecordDigest(request: DSRecordDigest, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.domain.v2beta1.marshalling.marshal_DSRecordPublicKey(request: DSRecordPublicKey, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.domain.v2beta1.marshalling.marshal_ImportProviderDNSZoneRequest(request: ImportProviderDNSZoneRequest, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.domain.v2beta1.marshalling.marshal_ImportProviderDNSZoneRequestOnlineV1(request: ImportProviderDNSZoneRequestOnlineV1, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.domain.v2beta1.marshalling.marshal_ImportRawDNSZoneRequest(request: ImportRawDNSZoneRequest, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.domain.v2beta1.marshalling.marshal_ImportRawDNSZoneRequestAXFRSource(request: ImportRawDNSZoneRequestAXFRSource, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.domain.v2beta1.marshalling.marshal_ImportRawDNSZoneRequestBindSource(request: ImportRawDNSZoneRequestBindSource, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.domain.v2beta1.marshalling.marshal_ImportRawDNSZoneRequestTsigKey(request: ImportRawDNSZoneRequestTsigKey, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.domain.v2beta1.marshalling.marshal_Nameserver(request: Nameserver, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.domain.v2beta1.marshalling.marshal_NewContact(request: NewContact, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.domain.v2beta1.marshalling.marshal_Record(request: Record, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.domain.v2beta1.marshalling.marshal_RecordChange(request: RecordChange, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.domain.v2beta1.marshalling.marshal_RecordChangeAdd(request: RecordChangeAdd, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.domain.v2beta1.marshalling.marshal_RecordChangeClear(request: RecordChangeClear, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.domain.v2beta1.marshalling.marshal_RecordChangeDelete(request: RecordChangeDelete, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.domain.v2beta1.marshalling.marshal_RecordChangeSet(request: RecordChangeSet, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.domain.v2beta1.marshalling.marshal_RecordGeoIPConfig(request: RecordGeoIPConfig, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.domain.v2beta1.marshalling.marshal_RecordGeoIPConfigMatch(request: RecordGeoIPConfigMatch, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.domain.v2beta1.marshalling.marshal_RecordHTTPServiceConfig(request: RecordHTTPServiceConfig, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.domain.v2beta1.marshalling.marshal_RecordIdentifier(request: RecordIdentifier, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.domain.v2beta1.marshalling.marshal_RecordViewConfig(request: RecordViewConfig, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.domain.v2beta1.marshalling.marshal_RecordViewConfigView(request: RecordViewConfigView, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.domain.v2beta1.marshalling.marshal_RecordWeightedConfig(request: RecordWeightedConfig, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.domain.v2beta1.marshalling.marshal_RecordWeightedConfigWeightedIP(request: RecordWeightedConfigWeightedIP, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.domain.v2beta1.marshalling.marshal_RefreshDNSZoneRequest(request: RefreshDNSZoneRequest, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.domain.v2beta1.marshalling.marshal_RegistrarApiBuyDomainsRequest(request: RegistrarApiBuyDomainsRequest, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.domain.v2beta1.marshalling.marshal_RegistrarApiCheckContactsCompatibilityRequest(request: RegistrarApiCheckContactsCompatibilityRequest, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.domain.v2beta1.marshalling.marshal_RegistrarApiCreateDomainHostRequest(request: RegistrarApiCreateDomainHostRequest, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.domain.v2beta1.marshalling.marshal_RegistrarApiEnableDomainDNSSECRequest(request: RegistrarApiEnableDomainDNSSECRequest, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.domain.v2beta1.marshalling.marshal_RegistrarApiRegisterExternalDomainRequest(request: RegistrarApiRegisterExternalDomainRequest, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.domain.v2beta1.marshalling.marshal_RegistrarApiRenewDomainsRequest(request: RegistrarApiRenewDomainsRequest, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.domain.v2beta1.marshalling.marshal_RegistrarApiTradeDomainRequest(request: RegistrarApiTradeDomainRequest, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.domain.v2beta1.marshalling.marshal_RegistrarApiTransferInDomainRequest(request: RegistrarApiTransferInDomainRequest, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.domain.v2beta1.marshalling.marshal_RegistrarApiUpdateContactRequest(request: RegistrarApiUpdateContactRequest, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.domain.v2beta1.marshalling.marshal_RegistrarApiUpdateDomainHostRequest(request: RegistrarApiUpdateDomainHostRequest, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.domain.v2beta1.marshalling.marshal_RegistrarApiUpdateDomainRequest(request: RegistrarApiUpdateDomainRequest, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.domain.v2beta1.marshalling.marshal_TransferInDomainRequestTransferRequest(request: TransferInDomainRequestTransferRequest, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.domain.v2beta1.marshalling.marshal_UpdateContactRequestQuestion(request: UpdateContactRequestQuestion, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.domain.v2beta1.marshalling.marshal_UpdateDNSZoneNameserversRequest(request: UpdateDNSZoneNameserversRequest, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.domain.v2beta1.marshalling.marshal_UpdateDNSZoneRecordsRequest(request: UpdateDNSZoneRecordsRequest, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.domain.v2beta1.marshalling.marshal_UpdateDNSZoneRequest(request: UpdateDNSZoneRequest, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.domain.v2beta1.marshalling.unmarshal_AvailableDomain(data: Any) → AvailableDomain

scaleway.domain.v2beta1.marshalling.unmarshal_CheckContactsCompatibilityResponse(data: Any) → CheckContactsCompatibilityResponse

scaleway.domain.v2beta1.marshalling.unmarshal_CheckContactsCompatibilityResponseContactCheckResult(data: Any) → CheckContactsCompatibilityResponseContactCheckResult

scaleway.domain.v2beta1.marshalling.unmarshal_ClearDNSZoneRecordsResponse(data: Any) → ClearDNSZoneRecordsResponse

scaleway.domain.v2beta1.marshalling.unmarshal_Contact(data: Any) → Contact

scaleway.domain.v2beta1.marshalling.unmarshal_ContactExtensionEU(data: Any) → ContactExtensionEU

scaleway.domain.v2beta1.marshalling.unmarshal_ContactExtensionFR(data: Any) → ContactExtensionFR

scaleway.domain.v2beta1.marshalling.unmarshal_ContactExtensionFRAssociationInfo(data: Any) → ContactExtensionFRAssociationInfo

scaleway.domain.v2beta1.marshalling.unmarshal_ContactExtensionFRCodeAuthAfnicInfo(data: Any) → ContactExtensionFRCodeAuthAfnicInfo

scaleway.domain.v2beta1.marshalling.unmarshal_ContactExtensionFRDunsInfo(data: Any) → ContactExtensionFRDunsInfo

scaleway.domain.v2beta1.marshalling.unmarshal_ContactExtensionFRIndividualInfo(data: Any) → ContactExtensionFRIndividualInfo

scaleway.domain.v2beta1.marshalling.unmarshal_ContactExtensionFRTrademarkInfo(data: Any) → ContactExtensionFRTrademarkInfo

scaleway.domain.v2beta1.marshalling.unmarshal_ContactExtensionNL(data: Any) → ContactExtensionNL

scaleway.domain.v2beta1.marshalling.unmarshal_ContactQuestion(data: Any) → ContactQuestion

scaleway.domain.v2beta1.marshalling.unmarshal_ContactRoles(data: Any) → ContactRoles

scaleway.domain.v2beta1.marshalling.unmarshal_ContactRolesRoles(data: Any) → ContactRolesRoles

scaleway.domain.v2beta1.marshalling.unmarshal_DNSZone(data: Any) → DNSZone

scaleway.domain.v2beta1.marshalling.unmarshal_DNSZoneVersion(data: Any) → DNSZoneVersion

scaleway.domain.v2beta1.marshalling.unmarshal_DSRecord(data: Any) → DSRecord

scaleway.domain.v2beta1.marshalling.unmarshal_DSRecordDigest(data: Any) → DSRecordDigest

scaleway.domain.v2beta1.marshalling.unmarshal_DSRecordPublicKey(data: Any) → DSRecordPublicKey

scaleway.domain.v2beta1.marshalling.unmarshal_DeleteDNSZoneResponse(data: Any) → DeleteDNSZoneResponse

scaleway.domain.v2beta1.marshalling.unmarshal_DeleteExternalDomainResponse(data: Any) → DeleteExternalDomainResponse

scaleway.domain.v2beta1.marshalling.unmarshal_DeleteSSLCertificateResponse(data: Any) → DeleteSSLCertificateResponse

scaleway.domain.v2beta1.marshalling.unmarshal_Domain(data: Any) → Domain

scaleway.domain.v2beta1.marshalling.unmarshal_DomainDNSSEC(data: Any) → DomainDNSSEC

scaleway.domain.v2beta1.marshalling.unmarshal_DomainRegistrationStatusExternalDomain(data: Any) → DomainRegistrationStatusExternalDomain

scaleway.domain.v2beta1.marshalling.unmarshal_DomainRegistrationStatusTransfer(data: Any) → DomainRegistrationStatusTransfer

scaleway.domain.v2beta1.marshalling.unmarshal_DomainSummary(data: Any) → DomainSummary

scaleway.domain.v2beta1.marshalling.unmarshal_GetDNSZoneTsigKeyResponse(data: Any) → GetDNSZoneTsigKeyResponse

scaleway.domain.v2beta1.marshalling.unmarshal_GetDNSZoneVersionDiffResponse(data: Any) → GetDNSZoneVersionDiffResponse

scaleway.domain.v2beta1.marshalling.unmarshal_GetDomainAuthCodeResponse(data: Any) → GetDomainAuthCodeResponse

scaleway.domain.v2beta1.marshalling.unmarshal_Host(data: Any) → Host

scaleway.domain.v2beta1.marshalling.unmarshal_ImportProviderDNSZoneResponse(data: Any) → ImportProviderDNSZoneResponse

scaleway.domain.v2beta1.marshalling.unmarshal_ImportRawDNSZoneResponse(data: Any) → ImportRawDNSZoneResponse

scaleway.domain.v2beta1.marshalling.unmarshal_InboundTransfer(data: Any) → InboundTransfer

scaleway.domain.v2beta1.marshalling.unmarshal_ListContactsResponse(data: Any) → ListContactsResponse

scaleway.domain.v2beta1.marshalling.unmarshal_ListDNSZoneNameserversResponse(data: Any) → ListDNSZoneNameserversResponse

scaleway.domain.v2beta1.marshalling.unmarshal_ListDNSZoneRecordsResponse(data: Any) → ListDNSZoneRecordsResponse

scaleway.domain.v2beta1.marshalling.unmarshal_ListDNSZoneVersionRecordsResponse(data: Any) → ListDNSZoneVersionRecordsResponse

scaleway.domain.v2beta1.marshalling.unmarshal_ListDNSZoneVersionsResponse(data: Any) → ListDNSZoneVersionsResponse

scaleway.domain.v2beta1.marshalling.unmarshal_ListDNSZonesResponse(data: Any) → ListDNSZonesResponse

scaleway.domain.v2beta1.marshalling.unmarshal_ListDomainHostsResponse(data: Any) → ListDomainHostsResponse

scaleway.domain.v2beta1.marshalling.unmarshal_ListDomainsResponse(data: Any) → ListDomainsResponse

scaleway.domain.v2beta1.marshalling.unmarshal_ListInboundTransfersResponse(data: Any) → ListInboundTransfersResponse

scaleway.domain.v2beta1.marshalling.unmarshal_ListRenewableDomainsResponse(data: Any) → ListRenewableDomainsResponse

scaleway.domain.v2beta1.marshalling.unmarshal_ListSSLCertificatesResponse(data: Any) → ListSSLCertificatesResponse

scaleway.domain.v2beta1.marshalling.unmarshal_ListTasksResponse(data: Any) → ListTasksResponse

scaleway.domain.v2beta1.marshalling.unmarshal_ListTldsResponse(data: Any) → ListTldsResponse

scaleway.domain.v2beta1.marshalling.unmarshal_Nameserver(data: Any) → Nameserver

scaleway.domain.v2beta1.marshalling.unmarshal_OrderResponse(data: Any) → OrderResponse

scaleway.domain.v2beta1.marshalling.unmarshal_Record(data: Any) → Record

scaleway.domain.v2beta1.marshalling.unmarshal_RecordChange(data: Any) → RecordChange

scaleway.domain.v2beta1.marshalling.unmarshal_RecordChangeAdd(data: Any) → RecordChangeAdd

scaleway.domain.v2beta1.marshalling.unmarshal_RecordChangeClear(data: Any) → RecordChangeClear

scaleway.domain.v2beta1.marshalling.unmarshal_RecordChangeDelete(data: Any) → RecordChangeDelete

scaleway.domain.v2beta1.marshalling.unmarshal_RecordChangeSet(data: Any) → RecordChangeSet

scaleway.domain.v2beta1.marshalling.unmarshal_RecordGeoIPConfig(data: Any) → RecordGeoIPConfig

scaleway.domain.v2beta1.marshalling.unmarshal_RecordGeoIPConfigMatch(data: Any) → RecordGeoIPConfigMatch

scaleway.domain.v2beta1.marshalling.unmarshal_RecordHTTPServiceConfig(data: Any) → RecordHTTPServiceConfig

scaleway.domain.v2beta1.marshalling.unmarshal_RecordIdentifier(data: Any) → RecordIdentifier

scaleway.domain.v2beta1.marshalling.unmarshal_RecordViewConfig(data: Any) → RecordViewConfig

scaleway.domain.v2beta1.marshalling.unmarshal_RecordViewConfigView(data: Any) → RecordViewConfigView

scaleway.domain.v2beta1.marshalling.unmarshal_RecordWeightedConfig(data: Any) → RecordWeightedConfig

scaleway.domain.v2beta1.marshalling.unmarshal_RecordWeightedConfigWeightedIP(data: Any) → RecordWeightedConfigWeightedIP

scaleway.domain.v2beta1.marshalling.unmarshal_RefreshDNSZoneResponse(data: Any) → RefreshDNSZoneResponse

scaleway.domain.v2beta1.marshalling.unmarshal_RegisterExternalDomainResponse(data: Any) → RegisterExternalDomainResponse

scaleway.domain.v2beta1.marshalling.unmarshal_RenewableDomain(data: Any) → RenewableDomain

scaleway.domain.v2beta1.marshalling.unmarshal_RestoreDNSZoneVersionResponse(data: Any) → RestoreDNSZoneVersionResponse

scaleway.domain.v2beta1.marshalling.unmarshal_SSLCertificate(data: Any) → SSLCertificate

scaleway.domain.v2beta1.marshalling.unmarshal_SearchAvailableDomainsResponse(data: Any) → SearchAvailableDomainsResponse

scaleway.domain.v2beta1.marshalling.unmarshal_Task(data: Any) → Task

scaleway.domain.v2beta1.marshalling.unmarshal_Tld(data: Any) → Tld

scaleway.domain.v2beta1.marshalling.unmarshal_TldOffer(data: Any) → TldOffer

scaleway.domain.v2beta1.marshalling.unmarshal_UpdateDNSZoneNameserversResponse(data: Any) → UpdateDNSZoneNameserversResponse

scaleway.domain.v2beta1.marshalling.unmarshal_UpdateDNSZoneRecordsResponse(data: Any) → UpdateDNSZoneRecordsResponse

scaleway.domain.v2beta1.types module

class scaleway.domain.v2beta1.types.AvailableDomain(domain: 'str', available: 'bool', tld: 'Optional[Tld]' = None)

Bases: object

available: bool

domain: str

tld: Tld | None = None

class scaleway.domain.v2beta1.types.CheckContactsCompatibilityResponse(compatible: 'bool', owner_check_result: 'Optional[CheckContactsCompatibilityResponseContactCheckResult]' = None, administrative_check_result: 'Optional[CheckContactsCompatibilityResponseContactCheckResult]' = None, technical_check_result: 'Optional[CheckContactsCompatibilityResponseContactCheckResult]' = None)

Bases: object

administrative_check_result: CheckContactsCompatibilityResponseContactCheckResult | None = None

compatible: bool

owner_check_result: CheckContactsCompatibilityResponseContactCheckResult | None = None

technical_check_result: CheckContactsCompatibilityResponseContactCheckResult | None = None

class scaleway.domain.v2beta1.types.CheckContactsCompatibilityResponseContactCheckResult(compatible: 'bool', error_message: 'Optional[str]' = None)

Bases: object

compatible: bool

error_message: str | None = None

class scaleway.domain.v2beta1.types.ClearDNSZoneRecordsRequest(dns_zone: 'str')

Bases: object

dns_zone: str: DNS zone to clear.

class scaleway.domain.v2beta1.types.ClearDNSZoneRecordsResponse: Bases: object

class scaleway.domain.v2beta1.types.CloneDNSZoneRequest(dns_zone: 'str', dest_dns_zone: 'str', overwrite: 'bool', project_id: 'Optional[str]' = None)

Bases: object

dest_dns_zone: str: Destination DNS zone in which to clone the chosen DNS zone.

dns_zone: str: DNS zone to clone.

overwrite: bool: Specifies whether or not the destination DNS zone will be overwritten.

project_id: str | None = None: Project ID of the destination DNS zone.

class scaleway.domain.v2beta1.types.Contact(id: 'str', legal_form: 'ContactLegalForm', firstname: 'str', lastname: 'str', company_name: 'str', email: 'str', email_alt: 'str', phone_number: 'str', fax_number: 'str', address_line_1: 'str', address_line_2: 'str', zip: 'str', city: 'str', country: 'str', vat_identification_code: 'str', company_identification_code: 'str', lang: 'StdLanguageCode', resale: 'bool', whois_opt_in: 'bool', email_status: 'ContactEmailStatus', state: 'str', status: 'ContactStatus', questions: 'Optional[List[ContactQuestion]]' = <factory>, extension_fr: 'Optional[ContactExtensionFR]' = None, extension_eu: 'Optional[ContactExtensionEU]' = None, extension_nl: 'Optional[ContactExtensionNL]' = None)

Bases: object

address_line_1: str

address_line_2: str

city: str

company_identification_code: str

company_name: str

country: str

email: str

email_alt: str

email_status: ContactEmailStatus

extension_eu: ContactExtensionEU | None = None

extension_fr: ContactExtensionFR | None = None

extension_nl: ContactExtensionNL | None = None

fax_number: str

firstname: str

id: str

lang: LanguageCode

lastname: str

legal_form: ContactLegalForm

phone_number: str

questions: List[ContactQuestion] | None

resale: bool

state: str

status: ContactStatus

vat_identification_code: str

whois_opt_in: bool

zip: str

class scaleway.domain.v2beta1.types.ContactEmailStatus(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

EMAIL_STATUS_UNKNOWN = 'email_status_unknown'

INVALID_EMAIL = 'invalid_email'

NOT_VALIDATED = 'not_validated'

VALIDATED = 'validated'

class scaleway.domain.v2beta1.types.ContactExtensionEU(european_citizenship: 'str')

Bases: object

european_citizenship: str

class scaleway.domain.v2beta1.types.ContactExtensionFR(mode: 'ContactExtensionFRMode', individual_info: 'Optional[ContactExtensionFRIndividualInfo]' = None, duns_info: 'Optional[ContactExtensionFRDunsInfo]' = None, association_info: 'Optional[ContactExtensionFRAssociationInfo]' = None, trademark_info: 'Optional[ContactExtensionFRTrademarkInfo]' = None, code_auth_afnic_info: 'Optional[ContactExtensionFRCodeAuthAfnicInfo]' = None)

Bases: object

association_info: ContactExtensionFRAssociationInfo | None = None

code_auth_afnic_info: ContactExtensionFRCodeAuthAfnicInfo | None = None

duns_info: ContactExtensionFRDunsInfo | None = None

individual_info: ContactExtensionFRIndividualInfo | None = None

mode: ContactExtensionFRMode

trademark_info: ContactExtensionFRTrademarkInfo | None = None

class scaleway.domain.v2beta1.types.ContactExtensionFRAssociationInfo(publication_jo_page: 'int', publication_jo: 'Optional[datetime]' = None)

Bases: object

publication_jo: datetime | None = None

publication_jo_page: int

class scaleway.domain.v2beta1.types.ContactExtensionFRCodeAuthAfnicInfo(code_auth_afnic: 'str')

Bases: object

code_auth_afnic: str

class scaleway.domain.v2beta1.types.ContactExtensionFRDunsInfo(duns_id: 'str', local_id: 'str')

Bases: object

duns_id: str

local_id: str

class scaleway.domain.v2beta1.types.ContactExtensionFRIndividualInfo(whois_opt_in: 'bool')

Bases: object

whois_opt_in: bool

class scaleway.domain.v2beta1.types.ContactExtensionFRMode(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

ASSOCIATION = 'association'

CODE_AUTH_AFNIC = 'code_auth_afnic'

COMPANY_IDENTIFICATION_CODE = 'company_identification_code'

DUNS = 'duns'

INDIVIDUAL = 'individual'

LOCAL = 'local'

MODE_UNKNOWN = 'mode_unknown'

TRADEMARK = 'trademark'

class scaleway.domain.v2beta1.types.ContactExtensionFRTrademarkInfo(trademark_inpi: 'str')

Bases: object

trademark_inpi: str

class scaleway.domain.v2beta1.types.ContactExtensionNL(legal_form: 'ContactExtensionNLLegalForm', legal_form_registration_number: 'str')

Bases: object

legal_form: ContactExtensionNLLegalForm

legal_form_registration_number: str

class scaleway.domain.v2beta1.types.ContactExtensionNLLegalForm(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

ASSOCIATION = 'association'

COOPERATIVE = 'cooperative'

EUROPEAN_ECONOMIC_INTEREST_GROUP = 'european_economic_interest_group'

FOUNDATION = 'foundation'

LEGAL_FORM_UNKNOWN = 'legal_form_unknown'

LIMITED_COMPANY = 'limited_company'

LIMITED_COMPANY_IN_FORMATION = 'limited_company_in_formation'

LIMITED_PARTNERSHIP = 'limited_partnership'

MUTUAL_BENEFIT_COMPANY = 'mutual_benefit_company'

NATURAL_PERSON = 'natural_person'

NON_DUTCH_EU_COMPANY = 'non_dutch_eu_company'

NON_DUTCH_LEGAL_FORM_ENTERPRISE_SUBSIDIARY = 'non_dutch_legal_form_enterprise_subsidiary'

OTHER = 'other'

PARTNERSHIP = 'partnership'

PUBLIC_COMPANY = 'public_company'

RELIGIOUS_ENTITY = 'religious_entity'

RESIDENTIAL = 'residential'

SHIPPING_COMPANY = 'shipping_company'

SOLE_COMPANY = 'sole_company'

TRADING_PARTNERSHIP = 'trading_partnership'

class scaleway.domain.v2beta1.types.ContactLegalForm(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

ASSOCIATION = 'association'

CORPORATE = 'corporate'

INDIVIDUAL = 'individual'

LEGAL_FORM_UNKNOWN = 'legal_form_unknown'

OTHER = 'other'

class scaleway.domain.v2beta1.types.ContactQuestion(question: 'str', answer: 'str')

Bases: object

answer: str

question: str

class scaleway.domain.v2beta1.types.ContactRoles(roles: 'Dict[str, ContactRolesRoles]', contact: 'Optional[Contact]' = None)

Bases: object

contact: Contact | None = None

roles: Dict[str, ContactRolesRoles]

class scaleway.domain.v2beta1.types.ContactRolesRoles(is_owner: 'bool', is_administrative: 'bool', is_technical: 'bool')

Bases: object

is_administrative: bool

is_owner: bool

is_technical: bool

class scaleway.domain.v2beta1.types.ContactStatus(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

ACTIVE = 'active'

PENDING = 'pending'

STATUS_UNKNOWN = 'status_unknown'

class scaleway.domain.v2beta1.types.CreateDNSZoneRequest(domain: 'str', subdomain: 'str', project_id: 'Optional[str]' = None)

Bases: object

domain: str: Domain in which to crreate the DNS zone.

project_id: str | None = None: Project ID in which to create the DNS zone.

subdomain: str: Subdomain of the DNS zone to create.

class scaleway.domain.v2beta1.types.CreateSSLCertificateRequest(dns_zone: 'str', alternative_dns_zones: 'Optional[List[str]]' = <factory>)

Bases: object

alternative_dns_zones: List[str] | None

dns_zone: str

class scaleway.domain.v2beta1.types.DNSZone(domain: 'str', subdomain: 'str', ns: 'List[str]', ns_default: 'List[str]', ns_master: 'List[str]', status: 'DNSZoneStatus', project_id: 'str', linked_products: 'List[LinkedProduct]', message: 'Optional[str]' = None, updated_at: 'Optional[datetime]' = None)

Bases: object

domain: str

linked_products: List[LinkedProduct]

message: str | None = None

ns: List[str]

ns_default: List[str]

ns_master: List[str]

project_id: str

status: DNSZoneStatus

subdomain: str

updated_at: datetime | None = None

class scaleway.domain.v2beta1.types.DNSZoneStatus(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

ACTIVE = 'active'

ERROR = 'error'

LOCKED = 'locked'

PENDING = 'pending'

UNKNOWN = 'unknown'

class scaleway.domain.v2beta1.types.DNSZoneVersion(id: 'str', created_at: 'Optional[datetime]' = None)

Bases: object

created_at: datetime | None = None

id: str

class scaleway.domain.v2beta1.types.DSRecord(key_id: 'int', algorithm: 'DSRecordAlgorithm', digest: 'Optional[DSRecordDigest]' = None, public_key: 'Optional[DSRecordPublicKey]' = None)

Bases: object

algorithm: DSRecordAlgorithm

digest: DSRecordDigest | None = None

key_id: int

public_key: DSRecordPublicKey | None = None

class scaleway.domain.v2beta1.types.DSRecordAlgorithm(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

DH = 'dh'

DSA = 'dsa'

DSA_NSEC3_SHA1 = 'dsa_nsec3_sha1'

ECC_GOST = 'ecc_gost'

ECDSAP256SHA256 = 'ecdsap256sha256'

ECDSAP384SHA384 = 'ecdsap384sha384'

ED25519 = 'ed25519'

ED448 = 'ed448'

RSAMD5 = 'rsamd5'

RSASHA1 = 'rsasha1'

RSASHA1_NSEC3_SHA1 = 'rsasha1_nsec3_sha1'

RSASHA256 = 'rsasha256'

RSASHA512 = 'rsasha512'

class scaleway.domain.v2beta1.types.DSRecordDigest(type_: 'DSRecordDigestType', digest: 'str', public_key: 'Optional[DSRecordPublicKey]' = None)

Bases: object

digest: str

public_key: DSRecordPublicKey | None = None

type_: DSRecordDigestType

class scaleway.domain.v2beta1.types.DSRecordDigestType(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

GOST_R_34_11_94 = 'gost_r_34_11_94'

SHA_1 = 'sha_1'

SHA_256 = 'sha_256'

SHA_384 = 'sha_384'

class scaleway.domain.v2beta1.types.DSRecordPublicKey(key: 'str')

Bases: object

key: str

class scaleway.domain.v2beta1.types.DeleteDNSZoneRequest(dns_zone: 'str', project_id: 'Optional[str]' = None)

Bases: object

dns_zone: str: DNS zone to delete.

project_id: str | None = None: Project ID of the DNS zone to delete.

class scaleway.domain.v2beta1.types.DeleteDNSZoneResponse: Bases: object

class scaleway.domain.v2beta1.types.DeleteDNSZoneTsigKeyRequest(dns_zone: 'str')

Bases: object

dns_zone: str

class scaleway.domain.v2beta1.types.DeleteExternalDomainResponse: Bases: object

class scaleway.domain.v2beta1.types.DeleteSSLCertificateRequest(dns_zone: 'str')

Bases: object

dns_zone: str

class scaleway.domain.v2beta1.types.DeleteSSLCertificateResponse: Bases: object

class scaleway.domain.v2beta1.types.Domain(domain: 'str', organization_id: 'str', project_id: 'str', auto_renew_status: 'DomainFeatureStatus', epp_code: 'List[str]', registrar: 'str', is_external: 'bool', status: 'DomainStatus', dns_zones: 'List[DNSZone]', linked_products: 'List[LinkedProduct]', pending_trade: 'bool', dnssec: 'Optional[DomainDNSSEC]' = None, expired_at: 'Optional[datetime]' = None, updated_at: 'Optional[datetime]' = None, owner_contact: 'Optional[Contact]' = None, technical_contact: 'Optional[Contact]' = None, administrative_contact: 'Optional[Contact]' = None, tld: 'Optional[Tld]' = None, external_domain_registration_status: 'Optional[DomainRegistrationStatusExternalDomain]' = None, transfer_registration_status: 'Optional[DomainRegistrationStatusTransfer]' = None)

Bases: object

administrative_contact: Contact | None = None: Contact information of the domain’s administrative contact.

auto_renew_status: DomainFeatureStatus: Status of the automatic renewal of the domain.

dns_zones: List[DNSZone]: List of the domain’s DNS zones.

dnssec: DomainDNSSEC | None = None: Status of the DNSSEC configuration of the domain.

domain: str

epp_code: List[str]: List of the domain’s EPP codes.

expired_at: datetime | None = None: Date of expiration of the domain.

external_domain_registration_status: DomainRegistrationStatusExternalDomain | None = None

is_external: bool: Indicates whether Scaleway is the domain’s registrar.

linked_products: List[LinkedProduct]: List of Scaleway resources linked to the domain.

organization_id: str

owner_contact: Contact | None = None: Contact information of the domain’s owner.

pending_trade: bool: Indicates if a trade is ongoing.

project_id: str

registrar: str

status: DomainStatus: Status of the domain.

technical_contact: Contact | None = None: Contact information of the domain’s technical contact.

tld: Tld | None = None: Domain’s TLD information.

transfer_registration_status: DomainRegistrationStatusTransfer | None = None

updated_at: datetime | None = None: Domain’s last modification date.

class scaleway.domain.v2beta1.types.DomainDNSSEC(status: 'DomainFeatureStatus', ds_records: 'List[DSRecord]')

Bases: object

ds_records: List[DSRecord]

status: DomainFeatureStatus

class scaleway.domain.v2beta1.types.DomainFeatureStatus(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

DISABLED = 'disabled'

DISABLING = 'disabling'

ENABLED = 'enabled'

ENABLING = 'enabling'

FEATURE_STATUS_UNKNOWN = 'feature_status_unknown'

class scaleway.domain.v2beta1.types.DomainRegistrationStatusExternalDomain(validation_token: 'str')

Bases: object

validation_token: str

class scaleway.domain.v2beta1.types.DomainRegistrationStatusTransfer(status: 'DomainRegistrationStatusTransferStatus', vote_current_owner: 'bool', vote_new_owner: 'bool')

Bases: object

status: DomainRegistrationStatusTransferStatus

vote_current_owner: bool

vote_new_owner: bool

class scaleway.domain.v2beta1.types.DomainRegistrationStatusTransferStatus(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

DONE = 'done'

PENDING = 'pending'

PROCESSING = 'processing'

REJECTED = 'rejected'

STATUS_UNKNOWN = 'status_unknown'

WAITING_VOTE = 'waiting_vote'

class scaleway.domain.v2beta1.types.DomainStatus(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

ACTIVE = 'active'

CHECKING = 'checking'

CREATE_ERROR = 'create_error'

CREATING = 'creating'

DELETING = 'deleting'

EXPIRED = 'expired'

EXPIRING = 'expiring'

LOCKED = 'locked'

RENEWING = 'renewing'

RENEW_ERROR = 'renew_error'

STATUS_UNKNOWN = 'status_unknown'

UPDATING = 'updating'

XFERING = 'xfering'

XFER_ERROR = 'xfer_error'

class scaleway.domain.v2beta1.types.DomainSummary(domain: 'str', project_id: 'str', auto_renew_status: 'DomainFeatureStatus', dnssec_status: 'DomainFeatureStatus', epp_code: 'List[str]', registrar: 'str', is_external: 'bool', status: 'DomainStatus', organization_id: 'str', pending_trade: 'bool', expired_at: 'Optional[datetime]' = None, updated_at: 'Optional[datetime]' = None, created_at: 'Optional[datetime]' = None, external_domain_registration_status: 'Optional[DomainRegistrationStatusExternalDomain]' = None, transfer_registration_status: 'Optional[DomainRegistrationStatusTransfer]' = None)

Bases: object

auto_renew_status: DomainFeatureStatus

created_at: datetime | None = None

dnssec_status: DomainFeatureStatus

domain: str

epp_code: List[str]

expired_at: datetime | None = None

external_domain_registration_status: DomainRegistrationStatusExternalDomain | None = None

is_external: bool

organization_id: str

pending_trade: bool

project_id: str

registrar: str

status: DomainStatus

transfer_registration_status: DomainRegistrationStatusTransfer | None = None

updated_at: datetime | None = None

class scaleway.domain.v2beta1.types.ExportRawDNSZoneRequest(dns_zone: 'str', format: 'Optional[RawFormat]' = <RawFormat.UNKNOWN_RAW_FORMAT: 'unknown_raw_format'>)

Bases: object

dns_zone: str: DNS zone to export.

format: RawFormat | None = 'unknown_raw_format': DNS zone format.

class scaleway.domain.v2beta1.types.GetDNSZoneTsigKeyRequest(dns_zone: 'str')

Bases: object

dns_zone: str

class scaleway.domain.v2beta1.types.GetDNSZoneTsigKeyResponse(name: 'str', key: 'str', algorithm: 'str')

Bases: object

algorithm: str

key: str

name: str

class scaleway.domain.v2beta1.types.GetDNSZoneVersionDiffRequest(dns_zone_version_id: 'str')

Bases: object

dns_zone_version_id: str

class scaleway.domain.v2beta1.types.GetDNSZoneVersionDiffResponse(changes: 'List[RecordChange]')

Bases: object

changes: List[RecordChange]

class scaleway.domain.v2beta1.types.GetDomainAuthCodeResponse(auth_code: 'str')

Bases: object

auth_code: str

class scaleway.domain.v2beta1.types.GetSSLCertificateRequest(dns_zone: 'str')

Bases: object

dns_zone: str

class scaleway.domain.v2beta1.types.Host(domain: 'str', name: 'str', ips: 'List[str]', status: 'HostStatus')

Bases: object

domain: str

ips: List[str]

name: str

status: HostStatus

class scaleway.domain.v2beta1.types.HostStatus(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

ACTIVE = 'active'

DELETING = 'deleting'

UNKNOWN_STATUS = 'unknown_status'

UPDATING = 'updating'

class scaleway.domain.v2beta1.types.ImportProviderDNSZoneRequest(dns_zone: 'str', online_v1: 'Optional[ImportProviderDNSZoneRequestOnlineV1]' = None)

Bases: object

dns_zone: str

online_v1: ImportProviderDNSZoneRequestOnlineV1 | None = None

class scaleway.domain.v2beta1.types.ImportProviderDNSZoneRequestOnlineV1(token: 'str')

Bases: object

token: str

class scaleway.domain.v2beta1.types.ImportProviderDNSZoneResponse(records: 'List[Record]')

Bases: object

records: List[Record]

class scaleway.domain.v2beta1.types.ImportRawDNSZoneRequest(dns_zone: 'str', content: 'Optional[str]' = None, project_id: 'Optional[str]' = None, format: 'Optional[RawFormat]' = <RawFormat.UNKNOWN_RAW_FORMAT: 'unknown_raw_format'>, bind_source: 'Optional[ImportRawDNSZoneRequestBindSource]' = None, axfr_source: 'Optional[ImportRawDNSZoneRequestAXFRSource]' = None)

Bases: object

axfr_source: ImportRawDNSZoneRequestAXFRSource | None = None

bind_source: ImportRawDNSZoneRequestBindSource | None = None

content: str | None = None

dns_zone: str: DNS zone to import.

format: RawFormat | None = 'unknown_raw_format'

project_id: str | None = None

class scaleway.domain.v2beta1.types.ImportRawDNSZoneRequestAXFRSource(name_server: 'str', tsig_key: 'Optional[ImportRawDNSZoneRequestTsigKey]' = None)

Bases: object

name_server: str

tsig_key: ImportRawDNSZoneRequestTsigKey | None = None

class scaleway.domain.v2beta1.types.ImportRawDNSZoneRequestBindSource(content: 'str')

Bases: object

content: str

class scaleway.domain.v2beta1.types.ImportRawDNSZoneRequestTsigKey(name: 'str', key: 'str', algorithm: 'str')

Bases: object

algorithm: str

key: str

name: str

class scaleway.domain.v2beta1.types.ImportRawDNSZoneResponse(records: 'List[Record]')

Bases: object

records: List[Record]

class scaleway.domain.v2beta1.types.InboundTransfer(id: 'str', project_id: 'str', domain: 'str', status: 'InboundTransferStatus', message: 'str', task_id: 'str', created_at: 'Optional[datetime]' = None, last_updated_at: 'Optional[datetime]' = None)

Bases: object

created_at: datetime | None = None: The creation date of the inbound transfer.

domain: str: The domain associated with the inbound transfer.

id: str: The unique identifier of the inbound transfer.

last_updated_at: datetime | None = None: The last modification date of the inbound transfer.

message: str: Human-friendly message to describe the current inbound transfer status.

project_id: str: The project ID associated with the inbound transfer.

status: InboundTransferStatus: Inbound transfer status.

task_id: str: The unique identifier of the associated task.

class scaleway.domain.v2beta1.types.InboundTransferStatus(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

DONE = 'done'

ERR_ALREADY_TRANSFERRING = 'err_already_transferring'

ERR_DOMAIN_PENDING = 'err_domain_pending'

ERR_DOMAIN_TOO_YOUNG = 'err_domain_too_young'

ERR_INTERNAL = 'err_internal'

ERR_INVALID_AUTHCODE = 'err_invalid_authcode'

ERR_TOO_MANY_REQUESTS = 'err_too_many_requests'

ERR_TRANSFER_IMPOSSIBLE = 'err_transfer_impossible'

ERR_TRANSFER_PROHIBITED = 'err_transfer_prohibited'

IN_PROGRESS = 'in_progress'

UNKNOWN = 'unknown'

class scaleway.domain.v2beta1.types.LinkedProduct(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

UNKNOWN_PRODUCT = 'unknown_product'

VPC = 'vpc'

class scaleway.domain.v2beta1.types.ListContactsRequestRole(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

ADMINISTRATIVE = 'administrative'

OWNER = 'owner'

TECHNICAL = 'technical'

UNKNOWN_ROLE = 'unknown_role'

class scaleway.domain.v2beta1.types.ListContactsResponse(total_count: 'int', contacts: 'List[ContactRoles]')

Bases: object

contacts: List[ContactRoles]

total_count: int

class scaleway.domain.v2beta1.types.ListDNSZoneNameserversRequest(dns_zone: 'str', project_id: 'Optional[str]' = None)

Bases: object

dns_zone: str: DNS zone on which to filter the returned DNS zone name servers.

project_id: str | None = None: Project ID on which to filter the returned DNS zone name servers.

class scaleway.domain.v2beta1.types.ListDNSZoneNameserversResponse(ns: 'List[Nameserver]')

Bases: object

ns: List[Nameserver]: DNS zone name servers returned.

class scaleway.domain.v2beta1.types.ListDNSZoneRecordsRequest(dns_zone: 'str', name: 'str', project_id: 'Optional[str]' = None, order_by: 'Optional[ListDNSZoneRecordsRequestOrderBy]' = <ListDNSZoneRecordsRequestOrderBy.NAME_ASC: 'name_asc'>, page: 'Optional[int]' = 0, page_size: 'Optional[int]' = 0, type_: 'Optional[RecordType]' = <RecordType.UNKNOWN: 'unknown'>, id: 'Optional[str]' = None)

Bases: object

dns_zone: str: DNS zone on which to filter the returned DNS zone records.

id: str | None = None: Record ID on which to filter the returned DNS zone records.

name: str: Name on which to filter the returned DNS zone records.

order_by: ListDNSZoneRecordsRequestOrderBy | None = 'name_asc': Sort order of the returned DNS zone records.

page: int | None = 0: Page number to return, from the paginated results.

page_size: int | None = 0: Maximum number of DNS zone records per page.

project_id: str | None = None: Project ID on which to filter the returned DNS zone records.

type_: RecordType | None = 'unknown': Record type on which to filter the returned DNS zone records.

class scaleway.domain.v2beta1.types.ListDNSZoneRecordsRequestOrderBy(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

NAME_ASC = 'name_asc'

NAME_DESC = 'name_desc'

class scaleway.domain.v2beta1.types.ListDNSZoneRecordsResponse(total_count: 'int', records: 'List[Record]')

Bases: object

records: List[Record]: Paginated returned DNS zone records.

total_count: int: Total number of DNS zone records.

class scaleway.domain.v2beta1.types.ListDNSZoneVersionRecordsRequest(dns_zone_version_id: 'str', page: 'Optional[int]' = 0, page_size: 'Optional[int]' = 0)

Bases: object

dns_zone_version_id: str

page: int | None = 0: Page number to return, from the paginated results.

page_size: int | None = 0: Maximum number of DNS zones versions records per page.

class scaleway.domain.v2beta1.types.ListDNSZoneVersionRecordsResponse(total_count: 'int', records: 'List[Record]')

Bases: object

records: List[Record]

total_count: int: Total number of DNS zones versions records.

class scaleway.domain.v2beta1.types.ListDNSZoneVersionsRequest(dns_zone: 'str', page: 'Optional[int]' = 0, page_size: 'Optional[int]' = 0)

Bases: object

dns_zone: str

page: int | None = 0: Page number to return, from the paginated results.

page_size: int | None = 0: Maximum number of DNS zones versions per page.

class scaleway.domain.v2beta1.types.ListDNSZoneVersionsResponse(total_count: 'int', versions: 'List[DNSZoneVersion]')

Bases: object

total_count: int: Total number of DNS zones versions.

versions: List[DNSZoneVersion]

class scaleway.domain.v2beta1.types.ListDNSZonesRequest(domain: 'str', organization_id: 'Optional[str]' = None, project_id: 'Optional[str]' = None, order_by: 'Optional[ListDNSZonesRequestOrderBy]' = <ListDNSZonesRequestOrderBy.DOMAIN_ASC: 'domain_asc'>, page: 'Optional[int]' = 0, page_size: 'Optional[int]' = 0, dns_zone: 'Optional[str]' = None, dns_zones: 'Optional[List[str]]' = <factory>, created_after: 'Optional[datetime]' = None, created_before: 'Optional[datetime]' = None, updated_after: 'Optional[datetime]' = None, updated_before: 'Optional[datetime]' = None)

Bases: object

created_after: datetime | None = None: Only list DNS zones created after this date.

created_before: datetime | None = None: Only list DNS zones created before this date.

dns_zone: str | None = None: DNS zone on which to filter the returned DNS zones.

dns_zones: List[str] | None: DNS zones on which to filter the returned DNS zones.

domain: str: Domain on which to filter the returned DNS zones.

order_by: ListDNSZonesRequestOrderBy | None = 'domain_asc': Sort order of the returned DNS zones.

organization_id: str | None = None: Organization ID on which to filter the returned DNS zones.

page: int | None = 0: Page number to return, from the paginated results.

page_size: int | None = 0: Maximum number of DNS zones to return per page.

project_id: str | None = None: Project ID on which to filter the returned DNS zones.

updated_after: datetime | None = None: Only list DNS zones updated after this date.

updated_before: datetime | None = None: Only list DNS zones updated before this date.

class scaleway.domain.v2beta1.types.ListDNSZonesRequestOrderBy(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

CREATED_AT_ASC = 'created_at_asc'

CREATED_AT_DESC = 'created_at_desc'

DOMAIN_ASC = 'domain_asc'

DOMAIN_DESC = 'domain_desc'

SUBDOMAIN_ASC = 'subdomain_asc'

SUBDOMAIN_DESC = 'subdomain_desc'

UPDATED_AT_ASC = 'updated_at_asc'

UPDATED_AT_DESC = 'updated_at_desc'

class scaleway.domain.v2beta1.types.ListDNSZonesResponse(total_count: 'int', dns_zones: 'List[DNSZone]')

Bases: object

dns_zones: List[DNSZone]: Paginated returned DNS zones.

total_count: int: Total number of DNS zones matching the requested criteria.

class scaleway.domain.v2beta1.types.ListDomainHostsResponse(total_count: 'int', hosts: 'List[Host]')

Bases: object

hosts: List[Host]

total_count: int

class scaleway.domain.v2beta1.types.ListDomainsRequestOrderBy(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

DOMAIN_ASC = 'domain_asc'

DOMAIN_DESC = 'domain_desc'

class scaleway.domain.v2beta1.types.ListDomainsResponse(total_count: 'int', domains: 'List[DomainSummary]')

Bases: object

domains: List[DomainSummary]

total_count: int

class scaleway.domain.v2beta1.types.ListInboundTransfersResponse(total_count: 'int', inbound_transfers: 'List[InboundTransfer]')

Bases: object

inbound_transfers: List[InboundTransfer]

total_count: int

class scaleway.domain.v2beta1.types.ListRenewableDomainsRequestOrderBy(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

DOMAIN_ASC = 'domain_asc'

DOMAIN_DESC = 'domain_desc'

class scaleway.domain.v2beta1.types.ListRenewableDomainsResponse(total_count: 'int', domains: 'List[RenewableDomain]')

Bases: object

domains: List[RenewableDomain]

total_count: int

class scaleway.domain.v2beta1.types.ListSSLCertificatesRequest(dns_zone: 'str', page: 'Optional[int]' = 0, page_size: 'Optional[int]' = 0, project_id: 'Optional[str]' = None)

Bases: object

dns_zone: str

page: int | None = 0

page_size: int | None = 0

project_id: str | None = None

class scaleway.domain.v2beta1.types.ListSSLCertificatesResponse(total_count: 'int', certificates: 'List[SSLCertificate]')

Bases: object

certificates: List[SSLCertificate]

total_count: int

class scaleway.domain.v2beta1.types.ListTasksRequestOrderBy(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

DOMAIN_ASC = 'domain_asc'

DOMAIN_DESC = 'domain_desc'

STATUS_ASC = 'status_asc'

STATUS_DESC = 'status_desc'

TYPE_ASC = 'type_asc'

TYPE_DESC = 'type_desc'

UPDATED_AT_ASC = 'updated_at_asc'

UPDATED_AT_DESC = 'updated_at_desc'

class scaleway.domain.v2beta1.types.ListTasksResponse(total_count: 'int', tasks: 'List[Task]')

Bases: object

tasks: List[Task]

total_count: int

class scaleway.domain.v2beta1.types.ListTldsRequestOrderBy(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

NAME_ASC = 'name_asc'

NAME_DESC = 'name_desc'

class scaleway.domain.v2beta1.types.ListTldsResponse(tlds: 'List[Tld]', total_count: 'int')

Bases: object

tlds: List[Tld]: Array of TLDs.

total_count: int: Total count of TLDs returned.

class scaleway.domain.v2beta1.types.Nameserver(name: 'str', ip: 'List[str]')

Bases: object

ip: List[str]

name: str

class scaleway.domain.v2beta1.types.NewContact(legal_form: 'ContactLegalForm', firstname: 'str', lastname: 'str', email: 'str', phone_number: 'str', address_line_1: 'str', zip: 'str', city: 'str', country: 'str', lang: 'StdLanguageCode', resale: 'bool', whois_opt_in: 'bool', company_name: 'Optional[str]' = None, email_alt: 'Optional[str]' = None, fax_number: 'Optional[str]' = None, address_line_2: 'Optional[str]' = None, vat_identification_code: 'Optional[str]' = None, company_identification_code: 'Optional[str]' = None, questions: 'Optional[List[ContactQuestion]]' = <factory>, extension_fr: 'Optional[ContactExtensionFR]' = None, extension_eu: 'Optional[ContactExtensionEU]' = None, state: 'Optional[str]' = None, extension_nl: 'Optional[ContactExtensionNL]' = None)

Bases: object

address_line_1: str

address_line_2: str | None = None

city: str

company_identification_code: str | None = None

company_name: str | None = None

country: str

email: str

email_alt: str | None = None

extension_eu: ContactExtensionEU | None = None

extension_fr: ContactExtensionFR | None = None

extension_nl: ContactExtensionNL | None = None

fax_number: str | None = None

firstname: str

lang: LanguageCode

lastname: str

legal_form: ContactLegalForm

phone_number: str

questions: List[ContactQuestion] | None

resale: bool

state: str | None = None

vat_identification_code: str | None = None

whois_opt_in: bool

zip: str

class scaleway.domain.v2beta1.types.OrderResponse(domains: 'List[str]', organization_id: 'str', project_id: 'str', task_id: 'str', created_at: 'Optional[datetime]' = None)

Bases: object

created_at: datetime | None = None

domains: List[str]

organization_id: str

project_id: str

task_id: str

class scaleway.domain.v2beta1.types.RawFormat(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

BIND = 'bind'

UNKNOWN_RAW_FORMAT = 'unknown_raw_format'

class scaleway.domain.v2beta1.types.Record(data: 'str', name: 'str', priority: 'int', ttl: 'int', type_: 'RecordType', id: 'str', comment: 'Optional[str]' = None, geo_ip_config: 'Optional[RecordGeoIPConfig]' = None, http_service_config: 'Optional[RecordHTTPServiceConfig]' = None, weighted_config: 'Optional[RecordWeightedConfig]' = None, view_config: 'Optional[RecordViewConfig]' = None)

Bases: object

comment: str | None = None

data: str

geo_ip_config: RecordGeoIPConfig | None = None

http_service_config: RecordHTTPServiceConfig | None = None

id: str

name: str

priority: int

ttl: int

type_: RecordType

view_config: RecordViewConfig | None = None

weighted_config: RecordWeightedConfig | None = None

class scaleway.domain.v2beta1.types.RecordChange(add: 'Optional[RecordChangeAdd]' = None, set_: 'Optional[RecordChangeSet]' = None, delete: 'Optional[RecordChangeDelete]' = None, clear: 'Optional[RecordChangeClear]' = None)

Bases: object

add: RecordChangeAdd | None = None

clear: RecordChangeClear | None = None

delete: RecordChangeDelete | None = None

set_: RecordChangeSet | None = None

class scaleway.domain.v2beta1.types.RecordChangeAdd(records: 'List[Record]')

Bases: object

records: List[Record]

class scaleway.domain.v2beta1.types.RecordChangeClear: Bases: object

class scaleway.domain.v2beta1.types.RecordChangeDelete(id: 'Optional[str]' = None, id_fields: 'Optional[RecordIdentifier]' = None)

Bases: object

id: str | None = None

id_fields: RecordIdentifier | None = None

class scaleway.domain.v2beta1.types.RecordChangeSet(records: 'List[Record]', id: 'Optional[str]' = None, id_fields: 'Optional[RecordIdentifier]' = None)

Bases: object

id: str | None = None

id_fields: RecordIdentifier | None = None

records: List[Record]

class scaleway.domain.v2beta1.types.RecordGeoIPConfig(matches: 'List[RecordGeoIPConfigMatch]', default: 'str')

Bases: object

default: str

matches: List[RecordGeoIPConfigMatch]

class scaleway.domain.v2beta1.types.RecordGeoIPConfigMatch(countries: 'List[str]', continents: 'List[str]', data: 'str')

Bases: object

continents: List[str]

countries: List[str]

data: str

class scaleway.domain.v2beta1.types.RecordHTTPServiceConfig(ips: 'List[str]', url: 'str', strategy: 'RecordHTTPServiceConfigStrategy', must_contain: 'Optional[str]' = None, user_agent: 'Optional[str]' = None)

Bases: object

ips: List[str]

must_contain: str | None = None

strategy: RecordHTTPServiceConfigStrategy

url: str

user_agent: str | None = None

class scaleway.domain.v2beta1.types.RecordHTTPServiceConfigStrategy(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

ALL = 'all'

HASHED = 'hashed'

RANDOM = 'random'

class scaleway.domain.v2beta1.types.RecordIdentifier(name: 'str', type_: 'RecordType', data: 'Optional[str]' = None, ttl: 'Optional[int]' = None)

Bases: object

data: str | None = None

name: str

ttl: int | None = None

type_: RecordType

class scaleway.domain.v2beta1.types.RecordType(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

A = 'a'

AAAA = 'aaaa'

ALIAS = 'alias'

CAA = 'caa'

CNAME = 'cname'

DNAME = 'dname'

DS = 'ds'

HINFO = 'hinfo'

HTTPS = 'https'

LOC = 'loc'

MX = 'mx'

NAPTR = 'naptr'

NS = 'ns'

PTR = 'ptr'

RP = 'rp'

SRV = 'srv'

SSHFP = 'sshfp'

SVCB = 'svcb'

TLSA = 'tlsa'

TXT = 'txt'

UNKNOWN = 'unknown'

URI = 'uri'

class scaleway.domain.v2beta1.types.RecordViewConfig(views: 'List[RecordViewConfigView]')

Bases: object

views: List[RecordViewConfigView]

class scaleway.domain.v2beta1.types.RecordViewConfigView(subnet: 'str', data: 'str')

Bases: object

data: str

subnet: str

class scaleway.domain.v2beta1.types.RecordWeightedConfig(weighted_ips: 'List[RecordWeightedConfigWeightedIP]')

Bases: object

weighted_ips: List[RecordWeightedConfigWeightedIP]

class scaleway.domain.v2beta1.types.RecordWeightedConfigWeightedIP(ip: 'str', weight: 'int')

Bases: object

ip: str

weight: int

class scaleway.domain.v2beta1.types.RefreshDNSZoneRequest(dns_zone: 'str', recreate_dns_zone: 'bool', recreate_sub_dns_zone: 'bool')

Bases: object

dns_zone: str: DNS zone to refresh.

recreate_dns_zone: bool: Specifies whether or not to recreate the DNS zone.

recreate_sub_dns_zone: bool: Specifies whether or not to recreate the sub DNS zone.

class scaleway.domain.v2beta1.types.RefreshDNSZoneResponse(dns_zones: 'List[DNSZone]')

Bases: object

dns_zones: List[DNSZone]: DNS zones returned.

class scaleway.domain.v2beta1.types.RegisterExternalDomainResponse(domain: 'str', organization_id: 'str', validation_token: 'str', project_id: 'str', created_at: 'Optional[datetime]' = None)

Bases: object

created_at: datetime | None = None

domain: str

organization_id: str

project_id: str

validation_token: str

class scaleway.domain.v2beta1.types.RegistrarApiBuyDomainsRequest(domains: 'List[str]', duration_in_years: 'int', project_id: 'Optional[str]' = None, owner_contact_id: 'Optional[str]' = None, owner_contact: 'Optional[NewContact]' = None, administrative_contact_id: 'Optional[str]' = None, administrative_contact: 'Optional[NewContact]' = None, technical_contact_id: 'Optional[str]' = None, technical_contact: 'Optional[NewContact]' = None)

Bases: object

administrative_contact: NewContact | None = None

administrative_contact_id: str | None = None

domains: List[str]

duration_in_years: int

owner_contact: NewContact | None = None

owner_contact_id: str | None = None

project_id: str | None = None

technical_contact: NewContact | None = None

technical_contact_id: str | None = None

class scaleway.domain.v2beta1.types.RegistrarApiCheckContactsCompatibilityRequest(domains: 'Optional[List[str]]' = <factory>, tlds: 'Optional[List[str]]' = <factory>, owner_contact_id: 'Optional[str]' = None, owner_contact: 'Optional[NewContact]' = None, administrative_contact_id: 'Optional[str]' = None, administrative_contact: 'Optional[NewContact]' = None, technical_contact_id: 'Optional[str]' = None, technical_contact: 'Optional[NewContact]' = None)

Bases: object

administrative_contact: NewContact | None = None

administrative_contact_id: str | None = None

domains: List[str] | None

owner_contact: NewContact | None = None

owner_contact_id: str | None = None

technical_contact: NewContact | None = None

technical_contact_id: str | None = None

tlds: List[str] | None

class scaleway.domain.v2beta1.types.RegistrarApiCreateDomainHostRequest(domain: 'str', name: 'str', ips: 'Optional[List[str]]' = <factory>)

Bases: object

domain: str

ips: List[str] | None

name: str

class scaleway.domain.v2beta1.types.RegistrarApiDeleteDomainHostRequest(domain: 'str', name: 'str')

Bases: object

domain: str

name: str

class scaleway.domain.v2beta1.types.RegistrarApiDeleteExternalDomainRequest(domain: 'str')

Bases: object

domain: str

class scaleway.domain.v2beta1.types.RegistrarApiDisableDomainAutoRenewRequest(domain: 'str')

Bases: object

domain: str

class scaleway.domain.v2beta1.types.RegistrarApiDisableDomainDNSSECRequest(domain: 'str')

Bases: object

domain: str

class scaleway.domain.v2beta1.types.RegistrarApiEnableDomainAutoRenewRequest(domain: 'str')

Bases: object

domain: str

class scaleway.domain.v2beta1.types.RegistrarApiEnableDomainDNSSECRequest(domain: 'str', ds_record: 'Optional[DSRecord]' = None)

Bases: object

domain: str

ds_record: DSRecord | None = None

class scaleway.domain.v2beta1.types.RegistrarApiGetContactRequest(contact_id: 'str')

Bases: object

contact_id: str

class scaleway.domain.v2beta1.types.RegistrarApiGetDomainAuthCodeRequest(domain: 'str')

Bases: object

domain: str

class scaleway.domain.v2beta1.types.RegistrarApiGetDomainRequest(domain: 'str')

Bases: object

domain: str

class scaleway.domain.v2beta1.types.RegistrarApiListContactsRequest(page: 'Optional[int]' = None, page_size: 'Optional[int]' = None, domain: 'Optional[str]' = None, project_id: 'Optional[str]' = None, organization_id: 'Optional[str]' = None, role: 'Optional[ListContactsRequestRole]' = None, email_status: 'Optional[ContactEmailStatus]' = None)

Bases: object

domain: str | None = None

email_status: ContactEmailStatus | None = None

organization_id: str | None = None

page: int | None = None

page_size: int | None = None

project_id: str | None = None

role: ListContactsRequestRole | None = None

class scaleway.domain.v2beta1.types.RegistrarApiListDomainHostsRequest(domain: 'str', page: 'Optional[int]' = None, page_size: 'Optional[int]' = None)

Bases: object

domain: str

page: int | None = None

page_size: int | None = None

class scaleway.domain.v2beta1.types.RegistrarApiListDomainsRequest(page: 'Optional[int]' = None, page_size: 'Optional[int]' = None, order_by: 'Optional[ListDomainsRequestOrderBy]' = None, registrar: 'Optional[str]' = None, status: 'Optional[DomainStatus]' = None, project_id: 'Optional[str]' = None, organization_id: 'Optional[str]' = None, is_external: 'Optional[bool]' = None, domain: 'Optional[str]' = None)

Bases: object

domain: str | None = None

is_external: bool | None = None

order_by: ListDomainsRequestOrderBy | None = None

organization_id: str | None = None

page: int | None = None

page_size: int | None = None

project_id: str | None = None

registrar: str | None = None

status: DomainStatus | None = None

class scaleway.domain.v2beta1.types.RegistrarApiListInboundTransfersRequest(page: 'int', domain: 'str', page_size: 'Optional[int]' = None, project_id: 'Optional[str]' = None, organization_id: 'Optional[str]' = None)

Bases: object

domain: str

organization_id: str | None = None

page: int

page_size: int | None = None

project_id: str | None = None

class scaleway.domain.v2beta1.types.RegistrarApiListRenewableDomainsRequest(page: 'Optional[int]' = None, page_size: 'Optional[int]' = None, order_by: 'Optional[ListRenewableDomainsRequestOrderBy]' = None, project_id: 'Optional[str]' = None, organization_id: 'Optional[str]' = None)

Bases: object

order_by: ListRenewableDomainsRequestOrderBy | None = None

organization_id: str | None = None

page: int | None = None

page_size: int | None = None

project_id: str | None = None

class scaleway.domain.v2beta1.types.RegistrarApiListTasksRequest(page: 'Optional[int]' = None, page_size: 'Optional[int]' = None, project_id: 'Optional[str]' = None, organization_id: 'Optional[str]' = None, domain: 'Optional[str]' = None, types: 'Optional[List[TaskType]]' = <factory>, statuses: 'Optional[List[TaskStatus]]' = <factory>, order_by: 'Optional[ListTasksRequestOrderBy]' = None)

Bases: object

domain: str | None = None

order_by: ListTasksRequestOrderBy | None = None

organization_id: str | None = None

page: int | None = None

page_size: int | None = None

project_id: str | None = None

statuses: List[TaskStatus] | None

types: List[TaskType] | None

class scaleway.domain.v2beta1.types.RegistrarApiListTldsRequest(tlds: 'Optional[List[str]]' = <factory>, page: 'Optional[int]' = 0, page_size: 'Optional[int]' = 0, order_by: 'Optional[ListTldsRequestOrderBy]' = <ListTldsRequestOrderBy.NAME_ASC: 'name_asc'>)

Bases: object

order_by: ListTldsRequestOrderBy | None = 'name_asc': Sort order of the returned TLDs.

page: int | None = 0: Page number for the returned Projects.

page_size: int | None = 0: Maximum number of Project per page.

tlds: List[str] | None: Array of TLDs to return.

class scaleway.domain.v2beta1.types.RegistrarApiLockDomainTransferRequest(domain: 'str')

Bases: object

domain: str

class scaleway.domain.v2beta1.types.RegistrarApiRegisterExternalDomainRequest(domain: 'str', project_id: 'Optional[str]' = None)

Bases: object

domain: str

project_id: str | None = None

class scaleway.domain.v2beta1.types.RegistrarApiRenewDomainsRequest(domains: 'List[str]', duration_in_years: 'int', force_late_renewal: 'Optional[bool]' = False)

Bases: object

domains: List[str]

duration_in_years: int

force_late_renewal: bool | None = False

class scaleway.domain.v2beta1.types.RegistrarApiSearchAvailableDomainsRequest(domains: 'List[str]', strict_search: 'bool', tlds: 'Optional[List[str]]' = <factory>)

Bases: object

domains: List[str]: A list of domain to search, TLD is optional.

strict_search: bool: Search exact match.

tlds: List[str] | None: Array of tlds to search on.

class scaleway.domain.v2beta1.types.RegistrarApiTradeDomainRequest(domain: 'str', project_id: 'Optional[str]' = None, new_owner_contact_id: 'Optional[str]' = None, new_owner_contact: 'Optional[NewContact]' = None)

Bases: object

domain: str

new_owner_contact: NewContact | None = None

new_owner_contact_id: str | None = None

project_id: str | None = None

class scaleway.domain.v2beta1.types.RegistrarApiTransferInDomainRequest(domains: 'List[TransferInDomainRequestTransferRequest]', project_id: 'Optional[str]' = None, owner_contact_id: 'Optional[str]' = None, owner_contact: 'Optional[NewContact]' = None, administrative_contact_id: 'Optional[str]' = None, administrative_contact: 'Optional[NewContact]' = None, technical_contact_id: 'Optional[str]' = None, technical_contact: 'Optional[NewContact]' = None)

Bases: object

administrative_contact: NewContact | None = None

administrative_contact_id: str | None = None

domains: List[TransferInDomainRequestTransferRequest]

owner_contact: NewContact | None = None

owner_contact_id: str | None = None

project_id: str | None = None

technical_contact: NewContact | None = None

technical_contact_id: str | None = None

class scaleway.domain.v2beta1.types.RegistrarApiUnlockDomainTransferRequest(domain: 'str')

Bases: object

domain: str

class scaleway.domain.v2beta1.types.RegistrarApiUpdateContactRequest(contact_id: 'str', email: 'Optional[str]' = None, email_alt: 'Optional[str]' = None, phone_number: 'Optional[str]' = None, fax_number: 'Optional[str]' = None, address_line_1: 'Optional[str]' = None, address_line_2: 'Optional[str]' = None, zip: 'Optional[str]' = None, city: 'Optional[str]' = None, country: 'Optional[str]' = None, vat_identification_code: 'Optional[str]' = None, company_identification_code: 'Optional[str]' = None, lang: 'Optional[StdLanguageCode]' = None, resale: 'Optional[bool]' = None, questions: 'Optional[List[UpdateContactRequestQuestion]]' = <factory>, extension_fr: 'Optional[ContactExtensionFR]' = None, extension_eu: 'Optional[ContactExtensionEU]' = None, whois_opt_in: 'Optional[bool]' = None, state: 'Optional[str]' = None, extension_nl: 'Optional[ContactExtensionNL]' = None)

Bases: object

address_line_1: str | None = None

address_line_2: str | None = None

city: str | None = None

company_identification_code: str | None = None

contact_id: str

country: str | None = None

email: str | None = None

email_alt: str | None = None

extension_eu: ContactExtensionEU | None = None

extension_fr: ContactExtensionFR | None = None

extension_nl: ContactExtensionNL | None = None

fax_number: str | None = None

lang: LanguageCode | None = None

phone_number: str | None = None

questions: List[UpdateContactRequestQuestion] | None

resale: bool | None = None

state: str | None = None

vat_identification_code: str | None = None

whois_opt_in: bool | None = None

zip: str | None = None

class scaleway.domain.v2beta1.types.RegistrarApiUpdateDomainHostRequest(domain: 'str', name: 'str', ips: 'Optional[List[str]]' = <factory>)

Bases: object

domain: str

ips: List[str] | None

name: str

class scaleway.domain.v2beta1.types.RegistrarApiUpdateDomainRequest(domain: 'str', technical_contact_id: 'Optional[str]' = None, technical_contact: 'Optional[NewContact]' = None, owner_contact_id: 'Optional[str]' = None, owner_contact: 'Optional[NewContact]' = None, administrative_contact_id: 'Optional[str]' = None, administrative_contact: 'Optional[NewContact]' = None)

Bases: object

administrative_contact: NewContact | None = None

administrative_contact_id: str | None = None

domain: str

owner_contact: NewContact | None = None

owner_contact_id: str | None = None

technical_contact: NewContact | None = None

technical_contact_id: str | None = None

class scaleway.domain.v2beta1.types.RenewableDomain(domain: 'str', project_id: 'str', organization_id: 'str', status: 'RenewableDomainStatus', renewable_duration_in_years: 'Optional[int]' = None, expired_at: 'Optional[datetime]' = None, limit_renew_at: 'Optional[datetime]' = None, limit_redemption_at: 'Optional[datetime]' = None, estimated_delete_at: 'Optional[datetime]' = None, tld: 'Optional[Tld]' = None)

Bases: object

domain: str

estimated_delete_at: datetime | None = None

expired_at: datetime | None = None

limit_redemption_at: datetime | None = None

limit_renew_at: datetime | None = None

organization_id: str

project_id: str

renewable_duration_in_years: int | None = None

status: RenewableDomainStatus

tld: Tld | None = None

class scaleway.domain.v2beta1.types.RenewableDomainStatus(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

LATE_RENEWEABLE = 'late_reneweable'

NOT_RENEWABLE = 'not_renewable'

RENEWABLE = 'renewable'

UNKNOWN = 'unknown'

class scaleway.domain.v2beta1.types.RestoreDNSZoneVersionRequest(dns_zone_version_id: 'str')

Bases: object

dns_zone_version_id: str

class scaleway.domain.v2beta1.types.RestoreDNSZoneVersionResponse: Bases: object

class scaleway.domain.v2beta1.types.SSLCertificate(dns_zone: 'str', alternative_dns_zones: 'List[str]', status: 'SSLCertificateStatus', private_key: 'str', certificate_chain: 'str', created_at: 'Optional[datetime]' = None, expired_at: 'Optional[datetime]' = None)

Bases: object

alternative_dns_zones: List[str]

certificate_chain: str

created_at: datetime | None = None

dns_zone: str

expired_at: datetime | None = None

private_key: str

status: SSLCertificateStatus

class scaleway.domain.v2beta1.types.SSLCertificateStatus(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

ERROR = 'error'

NEW = 'new'

PENDING = 'pending'

SUCCESS = 'success'

UNKNOWN = 'unknown'

class scaleway.domain.v2beta1.types.SearchAvailableDomainsResponse(available_domains: 'List[AvailableDomain]')

Bases: object

available_domains: List[AvailableDomain]: Array of available domains.

class scaleway.domain.v2beta1.types.Task(id: 'str', project_id: 'str', organization_id: 'str', type_: 'TaskType', status: 'TaskStatus', domain: 'Optional[str]' = None, started_at: 'Optional[datetime]' = None, updated_at: 'Optional[datetime]' = None, message: 'Optional[str]' = None, contact_identifier: 'Optional[str]' = None)

Bases: object

contact_identifier: str | None = None: Human-friendly contact identifier used when the task concerns a contact.

domain: str | None = None: The domain name associated to the task.

id: str: The unique identifier of the task.

message: str | None = None: Error message associated to the task.

organization_id: str: The organization ID associated to the task.

project_id: str: The project ID associated to the task.

started_at: datetime | None = None: Start date of the task.

status: TaskStatus: The status of the task.

type_: TaskType: The type of the task.

updated_at: datetime | None = None: Last update of the task.

class scaleway.domain.v2beta1.types.TaskStatus(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

ERROR = 'error'

NEW = 'new'

PENDING = 'pending'

SUCCESS = 'success'

UNAVAILABLE = 'unavailable'

WAITING_PAYMENT = 'waiting_payment'

class scaleway.domain.v2beta1.types.TaskType(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

CANCEL_TASK = 'cancel_task'

CREATE_DOMAIN = 'create_domain'

CREATE_EXTERNAL_DOMAIN = 'create_external_domain'

CREATE_HOST = 'create_host'

DELETE_DOMAIN = 'delete_domain'

DELETE_DOMAIN_EXPIRED = 'delete_domain_expired'

DELETE_EXTERNAL_DOMAIN = 'delete_external_domain'

DELETE_HOST = 'delete_host'

DISABLE_DNSSEC = 'disable_dnssec'

ENABLE_DNSSEC = 'enable_dnssec'

GENERATE_SSL_CERTIFICATE = 'generate_ssl_certificate'

LOCK_DOMAIN_TRANSFER = 'lock_domain_transfer'

MOVE_PROJECT = 'move_project'

RENEW_DOMAIN = 'renew_domain'

RENEW_SSL_CERTIFICATE = 'renew_ssl_certificate'

SEND_MESSAGE = 'send_message'

TRADE_DOMAIN = 'trade_domain'

TRANSFER_DOMAIN = 'transfer_domain'

TRANSFER_ONLINE_DOMAIN = 'transfer_online_domain'

UNKNOWN = 'unknown'

UNLOCK_DOMAIN_TRANSFER = 'unlock_domain_transfer'

UPDATE_CONTACT = 'update_contact'

UPDATE_DOMAIN = 'update_domain'

UPDATE_HOST = 'update_host'

class scaleway.domain.v2beta1.types.Tld(name: 'str', dnssec_support: 'bool', duration_in_years_min: 'int', duration_in_years_max: 'int', idn_support: 'bool', offers: 'Dict[str, TldOffer]', specifications: 'Dict[str, str]')

Bases: object

dnssec_support: bool

duration_in_years_max: int

duration_in_years_min: int

idn_support: bool

name: str

offers: Dict[str, TldOffer]

specifications: Dict[str, str]

class scaleway.domain.v2beta1.types.TldOffer(action: 'str', operation_path: 'str', price: 'Optional[Money]' = None)

Bases: object

action: str

operation_path: str

price: Money | None = None

class scaleway.domain.v2beta1.types.TransferInDomainRequestTransferRequest(domain: 'str', auth_code: 'str')

Bases: object

auth_code: str

domain: str

class scaleway.domain.v2beta1.types.UpdateContactRequestQuestion(question: 'Optional[str]' = None, answer: 'Optional[str]' = None)

Bases: object

answer: str | None = None

question: str | None = None

class scaleway.domain.v2beta1.types.UpdateDNSZoneNameserversRequest(dns_zone: 'str', ns: 'List[Nameserver]')

Bases: object

dns_zone: str: DNS zone in which to update the DNS zone name servers.

ns: List[Nameserver]: New DNS zone name servers.

class scaleway.domain.v2beta1.types.UpdateDNSZoneNameserversResponse(ns: 'List[Nameserver]')

Bases: object

ns: List[Nameserver]: DNS zone name servers returned.

class scaleway.domain.v2beta1.types.UpdateDNSZoneRecordsRequest(dns_zone: 'str', changes: 'List[RecordChange]', disallow_new_zone_creation: 'bool', return_all_records: 'Optional[bool]' = False, serial: 'Optional[int]' = 0)

Bases: object

changes: List[RecordChange]: Changes made to the records.

disallow_new_zone_creation: bool: Disable the creation of the target zone if it does not exist. Target zone creation is disabled by default.

dns_zone: str: DNS zone in which to update the DNS zone records.

return_all_records: bool | None = False: Specifies whether or not to return all the records.

serial: int | None = 0: Use the provided serial (0) instead of the auto-increment serial.

class scaleway.domain.v2beta1.types.UpdateDNSZoneRecordsResponse(records: 'List[Record]')

Bases: object

records: List[Record]: DNS zone records returned.

class scaleway.domain.v2beta1.types.UpdateDNSZoneRequest(dns_zone: 'str', new_dns_zone: 'Optional[str]' = None, project_id: 'Optional[str]' = None)

Bases: object

dns_zone: str: DNS zone to update.

new_dns_zone: str | None = None: Name of the new DNS zone to create.

project_id: str | None = None: Project ID in which to create the new DNS zone.

Module contents

class scaleway.domain.v2beta1.AvailableDomain(domain: 'str', available: 'bool', tld: 'Optional[Tld]' = None)

Bases: object

available: bool

domain: str

tld: Tld | None = None

class scaleway.domain.v2beta1.CheckContactsCompatibilityResponse(compatible: 'bool', owner_check_result: 'Optional[CheckContactsCompatibilityResponseContactCheckResult]' = None, administrative_check_result: 'Optional[CheckContactsCompatibilityResponseContactCheckResult]' = None, technical_check_result: 'Optional[CheckContactsCompatibilityResponseContactCheckResult]' = None)

Bases: object

administrative_check_result: CheckContactsCompatibilityResponseContactCheckResult | None = None

compatible: bool

owner_check_result: CheckContactsCompatibilityResponseContactCheckResult | None = None

technical_check_result: CheckContactsCompatibilityResponseContactCheckResult | None = None

class scaleway.domain.v2beta1.CheckContactsCompatibilityResponseContactCheckResult(compatible: 'bool', error_message: 'Optional[str]' = None)

Bases: object

compatible: bool

error_message: str | None = None

class scaleway.domain.v2beta1.ClearDNSZoneRecordsRequest(dns_zone: 'str')

Bases: object

dns_zone: str: DNS zone to clear.

class scaleway.domain.v2beta1.ClearDNSZoneRecordsResponse: Bases: object

class scaleway.domain.v2beta1.CloneDNSZoneRequest(dns_zone: 'str', dest_dns_zone: 'str', overwrite: 'bool', project_id: 'Optional[str]' = None)

Bases: object

dest_dns_zone: str: Destination DNS zone in which to clone the chosen DNS zone.

dns_zone: str: DNS zone to clone.

overwrite: bool: Specifies whether or not the destination DNS zone will be overwritten.

project_id: str | None = None: Project ID of the destination DNS zone.

class scaleway.domain.v2beta1.Contact(id: 'str', legal_form: 'ContactLegalForm', firstname: 'str', lastname: 'str', company_name: 'str', email: 'str', email_alt: 'str', phone_number: 'str', fax_number: 'str', address_line_1: 'str', address_line_2: 'str', zip: 'str', city: 'str', country: 'str', vat_identification_code: 'str', company_identification_code: 'str', lang: 'StdLanguageCode', resale: 'bool', whois_opt_in: 'bool', email_status: 'ContactEmailStatus', state: 'str', status: 'ContactStatus', questions: 'Optional[List[ContactQuestion]]' = <factory>, extension_fr: 'Optional[ContactExtensionFR]' = None, extension_eu: 'Optional[ContactExtensionEU]' = None, extension_nl: 'Optional[ContactExtensionNL]' = None)

Bases: object

address_line_1: str

address_line_2: str

city: str

company_identification_code: str

company_name: str

country: str

email: str

email_alt: str

email_status: ContactEmailStatus

extension_eu: ContactExtensionEU | None = None

extension_fr: ContactExtensionFR | None = None

extension_nl: ContactExtensionNL | None = None

fax_number: str

firstname: str

id: str

lang: LanguageCode

lastname: str

legal_form: ContactLegalForm

phone_number: str

questions: List[ContactQuestion] | None

resale: bool

state: str

status: ContactStatus

vat_identification_code: str

whois_opt_in: bool

zip: str

class scaleway.domain.v2beta1.ContactEmailStatus(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

EMAIL_STATUS_UNKNOWN = 'email_status_unknown'

INVALID_EMAIL = 'invalid_email'

NOT_VALIDATED = 'not_validated'

VALIDATED = 'validated'

class scaleway.domain.v2beta1.ContactExtensionEU(european_citizenship: 'str')

Bases: object

european_citizenship: str

class scaleway.domain.v2beta1.ContactExtensionFR(mode: 'ContactExtensionFRMode', individual_info: 'Optional[ContactExtensionFRIndividualInfo]' = None, duns_info: 'Optional[ContactExtensionFRDunsInfo]' = None, association_info: 'Optional[ContactExtensionFRAssociationInfo]' = None, trademark_info: 'Optional[ContactExtensionFRTrademarkInfo]' = None, code_auth_afnic_info: 'Optional[ContactExtensionFRCodeAuthAfnicInfo]' = None)

Bases: object

association_info: ContactExtensionFRAssociationInfo | None = None

code_auth_afnic_info: ContactExtensionFRCodeAuthAfnicInfo | None = None

duns_info: ContactExtensionFRDunsInfo | None = None

individual_info: ContactExtensionFRIndividualInfo | None = None

mode: ContactExtensionFRMode

trademark_info: ContactExtensionFRTrademarkInfo | None = None

class scaleway.domain.v2beta1.ContactExtensionFRAssociationInfo(publication_jo_page: 'int', publication_jo: 'Optional[datetime]' = None)

Bases: object

publication_jo: datetime | None = None

publication_jo_page: int

class scaleway.domain.v2beta1.ContactExtensionFRCodeAuthAfnicInfo(code_auth_afnic: 'str')

Bases: object

code_auth_afnic: str

class scaleway.domain.v2beta1.ContactExtensionFRDunsInfo(duns_id: 'str', local_id: 'str')

Bases: object

duns_id: str

local_id: str

class scaleway.domain.v2beta1.ContactExtensionFRIndividualInfo(whois_opt_in: 'bool')

Bases: object

whois_opt_in: bool

class scaleway.domain.v2beta1.ContactExtensionFRMode(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

ASSOCIATION = 'association'

CODE_AUTH_AFNIC = 'code_auth_afnic'

COMPANY_IDENTIFICATION_CODE = 'company_identification_code'

DUNS = 'duns'

INDIVIDUAL = 'individual'

LOCAL = 'local'

MODE_UNKNOWN = 'mode_unknown'

TRADEMARK = 'trademark'

class scaleway.domain.v2beta1.ContactExtensionFRTrademarkInfo(trademark_inpi: 'str')

Bases: object

trademark_inpi: str

class scaleway.domain.v2beta1.ContactExtensionNL(legal_form: 'ContactExtensionNLLegalForm', legal_form_registration_number: 'str')

Bases: object

legal_form: ContactExtensionNLLegalForm

legal_form_registration_number: str

class scaleway.domain.v2beta1.ContactExtensionNLLegalForm(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

ASSOCIATION = 'association'

COOPERATIVE = 'cooperative'

EUROPEAN_ECONOMIC_INTEREST_GROUP = 'european_economic_interest_group'

FOUNDATION = 'foundation'

LEGAL_FORM_UNKNOWN = 'legal_form_unknown'

LIMITED_COMPANY = 'limited_company'

LIMITED_COMPANY_IN_FORMATION = 'limited_company_in_formation'

LIMITED_PARTNERSHIP = 'limited_partnership'

MUTUAL_BENEFIT_COMPANY = 'mutual_benefit_company'

NATURAL_PERSON = 'natural_person'

NON_DUTCH_EU_COMPANY = 'non_dutch_eu_company'

NON_DUTCH_LEGAL_FORM_ENTERPRISE_SUBSIDIARY = 'non_dutch_legal_form_enterprise_subsidiary'

OTHER = 'other'

PARTNERSHIP = 'partnership'

PUBLIC_COMPANY = 'public_company'

RELIGIOUS_ENTITY = 'religious_entity'

RESIDENTIAL = 'residential'

SHIPPING_COMPANY = 'shipping_company'

SOLE_COMPANY = 'sole_company'

TRADING_PARTNERSHIP = 'trading_partnership'

class scaleway.domain.v2beta1.ContactLegalForm(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

ASSOCIATION = 'association'

CORPORATE = 'corporate'

INDIVIDUAL = 'individual'

LEGAL_FORM_UNKNOWN = 'legal_form_unknown'

OTHER = 'other'

class scaleway.domain.v2beta1.ContactQuestion(question: 'str', answer: 'str')

Bases: object

answer: str

question: str

class scaleway.domain.v2beta1.ContactRoles(roles: 'Dict[str, ContactRolesRoles]', contact: 'Optional[Contact]' = None)

Bases: object

contact: Contact | None = None

roles: Dict[str, ContactRolesRoles]

class scaleway.domain.v2beta1.ContactRolesRoles(is_owner: 'bool', is_administrative: 'bool', is_technical: 'bool')

Bases: object

is_administrative: bool

is_owner: bool

is_technical: bool

class scaleway.domain.v2beta1.ContactStatus(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

ACTIVE = 'active'

PENDING = 'pending'

STATUS_UNKNOWN = 'status_unknown'

class scaleway.domain.v2beta1.CreateDNSZoneRequest(domain: 'str', subdomain: 'str', project_id: 'Optional[str]' = None)

Bases: object

domain: str: Domain in which to crreate the DNS zone.

project_id: str | None = None: Project ID in which to create the DNS zone.

subdomain: str: Subdomain of the DNS zone to create.

class scaleway.domain.v2beta1.CreateSSLCertificateRequest(dns_zone: 'str', alternative_dns_zones: 'Optional[List[str]]' = <factory>)

Bases: object

alternative_dns_zones: List[str] | None

dns_zone: str

class scaleway.domain.v2beta1.DNSZone(domain: 'str', subdomain: 'str', ns: 'List[str]', ns_default: 'List[str]', ns_master: 'List[str]', status: 'DNSZoneStatus', project_id: 'str', linked_products: 'List[LinkedProduct]', message: 'Optional[str]' = None, updated_at: 'Optional[datetime]' = None)

Bases: object

domain: str

linked_products: List[LinkedProduct]

message: str | None = None

ns: List[str]

ns_default: List[str]

ns_master: List[str]

project_id: str

status: DNSZoneStatus

subdomain: str

updated_at: datetime | None = None

class scaleway.domain.v2beta1.DNSZoneStatus(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

ACTIVE = 'active'

ERROR = 'error'

LOCKED = 'locked'

PENDING = 'pending'

UNKNOWN = 'unknown'

class scaleway.domain.v2beta1.DNSZoneVersion(id: 'str', created_at: 'Optional[datetime]' = None)

Bases: object

created_at: datetime | None = None

id: str

class scaleway.domain.v2beta1.DSRecord(key_id: 'int', algorithm: 'DSRecordAlgorithm', digest: 'Optional[DSRecordDigest]' = None, public_key: 'Optional[DSRecordPublicKey]' = None)

Bases: object

algorithm: DSRecordAlgorithm

digest: DSRecordDigest | None = None

key_id: int

public_key: DSRecordPublicKey | None = None

class scaleway.domain.v2beta1.DSRecordAlgorithm(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

DH = 'dh'

DSA = 'dsa'

DSA_NSEC3_SHA1 = 'dsa_nsec3_sha1'

ECC_GOST = 'ecc_gost'

ECDSAP256SHA256 = 'ecdsap256sha256'

ECDSAP384SHA384 = 'ecdsap384sha384'

ED25519 = 'ed25519'

ED448 = 'ed448'

RSAMD5 = 'rsamd5'

RSASHA1 = 'rsasha1'

RSASHA1_NSEC3_SHA1 = 'rsasha1_nsec3_sha1'

RSASHA256 = 'rsasha256'

RSASHA512 = 'rsasha512'

class scaleway.domain.v2beta1.DSRecordDigest(type_: 'DSRecordDigestType', digest: 'str', public_key: 'Optional[DSRecordPublicKey]' = None)

Bases: object

digest: str

public_key: DSRecordPublicKey | None = None

type_: DSRecordDigestType

class scaleway.domain.v2beta1.DSRecordDigestType(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

GOST_R_34_11_94 = 'gost_r_34_11_94'

SHA_1 = 'sha_1'

SHA_256 = 'sha_256'

SHA_384 = 'sha_384'

class scaleway.domain.v2beta1.DSRecordPublicKey(key: 'str')

Bases: object

key: str

class scaleway.domain.v2beta1.DeleteDNSZoneRequest(dns_zone: 'str', project_id: 'Optional[str]' = None)

Bases: object

dns_zone: str: DNS zone to delete.

project_id: str | None = None: Project ID of the DNS zone to delete.

class scaleway.domain.v2beta1.DeleteDNSZoneResponse: Bases: object

class scaleway.domain.v2beta1.DeleteDNSZoneTsigKeyRequest(dns_zone: 'str')

Bases: object

dns_zone: str

class scaleway.domain.v2beta1.DeleteExternalDomainResponse: Bases: object

class scaleway.domain.v2beta1.DeleteSSLCertificateRequest(dns_zone: 'str')

Bases: object

dns_zone: str

class scaleway.domain.v2beta1.DeleteSSLCertificateResponse: Bases: object

class scaleway.domain.v2beta1.Domain(domain: 'str', organization_id: 'str', project_id: 'str', auto_renew_status: 'DomainFeatureStatus', epp_code: 'List[str]', registrar: 'str', is_external: 'bool', status: 'DomainStatus', dns_zones: 'List[DNSZone]', linked_products: 'List[LinkedProduct]', pending_trade: 'bool', dnssec: 'Optional[DomainDNSSEC]' = None, expired_at: 'Optional[datetime]' = None, updated_at: 'Optional[datetime]' = None, owner_contact: 'Optional[Contact]' = None, technical_contact: 'Optional[Contact]' = None, administrative_contact: 'Optional[Contact]' = None, tld: 'Optional[Tld]' = None, external_domain_registration_status: 'Optional[DomainRegistrationStatusExternalDomain]' = None, transfer_registration_status: 'Optional[DomainRegistrationStatusTransfer]' = None)

Bases: object

administrative_contact: Contact | None = None: Contact information of the domain’s administrative contact.

auto_renew_status: DomainFeatureStatus: Status of the automatic renewal of the domain.

dns_zones: List[DNSZone]: List of the domain’s DNS zones.

dnssec: DomainDNSSEC | None = None: Status of the DNSSEC configuration of the domain.

domain: str

epp_code: List[str]: List of the domain’s EPP codes.

expired_at: datetime | None = None: Date of expiration of the domain.

external_domain_registration_status: DomainRegistrationStatusExternalDomain | None = None

is_external: bool: Indicates whether Scaleway is the domain’s registrar.

linked_products: List[LinkedProduct]: List of Scaleway resources linked to the domain.

organization_id: str

owner_contact: Contact | None = None: Contact information of the domain’s owner.

pending_trade: bool: Indicates if a trade is ongoing.

project_id: str

registrar: str

status: DomainStatus: Status of the domain.

technical_contact: Contact | None = None: Contact information of the domain’s technical contact.

tld: Tld | None = None: Domain’s TLD information.

transfer_registration_status: DomainRegistrationStatusTransfer | None = None

updated_at: datetime | None = None: Domain’s last modification date.

class scaleway.domain.v2beta1.DomainDNSSEC(status: 'DomainFeatureStatus', ds_records: 'List[DSRecord]')

Bases: object

ds_records: List[DSRecord]

status: DomainFeatureStatus

class scaleway.domain.v2beta1.DomainFeatureStatus(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

DISABLED = 'disabled'

DISABLING = 'disabling'

ENABLED = 'enabled'

ENABLING = 'enabling'

FEATURE_STATUS_UNKNOWN = 'feature_status_unknown'

class scaleway.domain.v2beta1.DomainRegistrationStatusExternalDomain(validation_token: 'str')

Bases: object

validation_token: str

class scaleway.domain.v2beta1.DomainRegistrationStatusTransfer(status: 'DomainRegistrationStatusTransferStatus', vote_current_owner: 'bool', vote_new_owner: 'bool')

Bases: object

status: DomainRegistrationStatusTransferStatus

vote_current_owner: bool

vote_new_owner: bool

class scaleway.domain.v2beta1.DomainRegistrationStatusTransferStatus(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

DONE = 'done'

PENDING = 'pending'

PROCESSING = 'processing'

REJECTED = 'rejected'

STATUS_UNKNOWN = 'status_unknown'

WAITING_VOTE = 'waiting_vote'

class scaleway.domain.v2beta1.DomainStatus(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

ACTIVE = 'active'

CHECKING = 'checking'

CREATE_ERROR = 'create_error'

CREATING = 'creating'

DELETING = 'deleting'

EXPIRED = 'expired'

EXPIRING = 'expiring'

LOCKED = 'locked'

RENEWING = 'renewing'

RENEW_ERROR = 'renew_error'

STATUS_UNKNOWN = 'status_unknown'

UPDATING = 'updating'

XFERING = 'xfering'

XFER_ERROR = 'xfer_error'

class scaleway.domain.v2beta1.DomainSummary(domain: 'str', project_id: 'str', auto_renew_status: 'DomainFeatureStatus', dnssec_status: 'DomainFeatureStatus', epp_code: 'List[str]', registrar: 'str', is_external: 'bool', status: 'DomainStatus', organization_id: 'str', pending_trade: 'bool', expired_at: 'Optional[datetime]' = None, updated_at: 'Optional[datetime]' = None, created_at: 'Optional[datetime]' = None, external_domain_registration_status: 'Optional[DomainRegistrationStatusExternalDomain]' = None, transfer_registration_status: 'Optional[DomainRegistrationStatusTransfer]' = None)

Bases: object

auto_renew_status: DomainFeatureStatus

created_at: datetime | None = None

dnssec_status: DomainFeatureStatus

domain: str

epp_code: List[str]

expired_at: datetime | None = None

external_domain_registration_status: DomainRegistrationStatusExternalDomain | None = None

is_external: bool

organization_id: str

pending_trade: bool

project_id: str

registrar: str

status: DomainStatus

transfer_registration_status: DomainRegistrationStatusTransfer | None = None

updated_at: datetime | None = None

class scaleway.domain.v2beta1.DomainV2Beta1API(client: Client, *, bypass_validation: bool = False)

Bases: API

This API allows you to manage your domains, DNS zones and records.

clear_dns_zone_records(*, dns_zone: str) → ClearDNSZoneRecordsResponse

Clear records within a DNS zone. Delete all records within a DNS zone that has default name servers. All edits will be versioned. :param dns_zone: DNS zone to clear. :return: ClearDNSZoneRecordsResponse

Usage:

result = api.clear_dns_zone_records(
    dns_zone="example",
)

clone_dns_zone(*, dns_zone: str, dest_dns_zone: str, overwrite: bool, project_id: str | None = None) → DNSZone

Clone a DNS zone. Clone an existing DNS zone with all its records into a new DNS zone. :param dns_zone: DNS zone to clone. :param dest_dns_zone: Destination DNS zone in which to clone the chosen DNS zone. :param overwrite: Specifies whether or not the destination DNS zone will be overwritten. :param project_id: Project ID of the destination DNS zone. :return: DNSZone

Usage:

result = api.clone_dns_zone(
    dns_zone="example",
    dest_dns_zone="example",
    overwrite=False,
)

create_dns_zone(*, domain: str, subdomain: str, project_id: str | None = None) → DNSZone

Create a DNS zone. Create a new DNS zone specified by the domain name, the subdomain and the Project ID. :param domain: Domain in which to crreate the DNS zone. :param subdomain: Subdomain of the DNS zone to create. :param project_id: Project ID in which to create the DNS zone. :return: DNSZone

Usage:

result = api.create_dns_zone(
    domain="example",
    subdomain="example",
)

create_ssl_certificate(*, dns_zone: str, alternative_dns_zones: List[str] | None = None) → SSLCertificate

Create or get the DNS zone’s TLS certificate. Create a new TLS certificate or retrieve information about an existing TLS certificate. :param dns_zone: :param alternative_dns_zones: :return: SSLCertificate

Usage:

result = api.create_ssl_certificate(
    dns_zone="example",
)

delete_dns_zone(*, dns_zone: str, project_id: str | None = None) → DeleteDNSZoneResponse

Delete a DNS zone. Delete a DNS zone and all its records. :param dns_zone: DNS zone to delete. :param project_id: Project ID of the DNS zone to delete. :return: DeleteDNSZoneResponse

Usage:

result = api.delete_dns_zone(
    dns_zone="example",
)

delete_dns_zone_tsig_key(*, dns_zone: str) → None

Delete the DNS zone’s TSIG key. Delete an existing TSIG key specified by its DNS zone. Deleting a TSIG key is permanent and cannot be undone. :param dns_zone:

Usage:

result = api.delete_dns_zone_tsig_key(
    dns_zone="example",
)

delete_ssl_certificate(*, dns_zone: str) → DeleteSSLCertificateResponse

Delete a TLS certificate. Delete an existing TLS certificate specified by its DNS zone. Deleting a TLS certificate is permanent and cannot be undone. :param dns_zone: :return: DeleteSSLCertificateResponse

Usage:

result = api.delete_ssl_certificate(
    dns_zone="example",
)

export_raw_dns_zone(*, dns_zone: str, format: RawFormat | None = None) → ScwFile

Export a raw DNS zone. Export a DNS zone with default name servers, in a specific format. :param dns_zone: DNS zone to export. :param format: DNS zone format. :return: ScwFile

Usage:

result = api.export_raw_dns_zone(
    dns_zone="example",
)

get_dns_zone_tsig_key(*, dns_zone: str) → GetDNSZoneTsigKeyResponse

Get the DNS zone’s TSIG key. Retrieve information about the TSIG key of a given DNS zone to allow AXFR requests. :param dns_zone: :return: GetDNSZoneTsigKeyResponse

Usage:

result = api.get_dns_zone_tsig_key(
    dns_zone="example",
)

get_dns_zone_version_diff(*, dns_zone_version_id: str) → GetDNSZoneVersionDiffResponse

Access differences from a specific DNS zone version. Access a previous DNS zone version to see the differences from another specific version. :param dns_zone_version_id: :return: GetDNSZoneVersionDiffResponse

Usage:

result = api.get_dns_zone_version_diff(
    dns_zone_version_id="example",
)

get_ssl_certificate(*, dns_zone: str) → SSLCertificate

Get a DNS zone’s TLS certificate. Get the DNS zone’s TLS certificate. If you do not have a certificate, the ouptut returns no certificate found. :param dns_zone: :return: SSLCertificate

Usage:

result = api.get_ssl_certificate(
    dns_zone="example",
)

import_provider_dns_zone(*, dns_zone: str, online_v1: ImportProviderDNSZoneRequestOnlineV1 | None = None) → ImportProviderDNSZoneResponse

Import a DNS zone from another provider. Import and replace the format of records from a given provider, with default name servers. :param dns_zone: :param online_v1: One-Of (‘provider’): at most one of ‘online_v1’ could be set. :return: ImportProviderDNSZoneResponse

Usage:

result = api.import_provider_dns_zone(
    dns_zone="example",
)

import_raw_dns_zone(*, dns_zone: str, content: str | None = None, project_id: str | None = None, format: RawFormat | None = None, bind_source: ImportRawDNSZoneRequestBindSource | None = None, axfr_source: ImportRawDNSZoneRequestAXFRSource | None = None) → ImportRawDNSZoneResponse

Import a raw DNS zone. Import and replace the format of records from a given provider, with default name servers. :param dns_zone: DNS zone to import. :param content: :param project_id: :param format: :param bind_source: Import a bind file format. One-Of (‘source’): at most one of ‘bind_source’, ‘axfr_source’ could be set. :param axfr_source: Import from the name server given with TSIG, to use or not. One-Of (‘source’): at most one of ‘bind_source’, ‘axfr_source’ could be set. :return: ImportRawDNSZoneResponse

Usage:

result = api.import_raw_dns_zone(
    dns_zone="example",
)

list_dns_zone_nameservers(*, project_id: str | None = None, dns_zone: str) → ListDNSZoneNameserversResponse

List name servers within a DNS zone. Retrieve a list of name servers within a DNS zone and their optional glue records. :param project_id: Project ID on which to filter the returned DNS zone name servers. :param dns_zone: DNS zone on which to filter the returned DNS zone name servers. :return: ListDNSZoneNameserversResponse

Usage:

result = api.list_dns_zone_nameservers(
    dns_zone="example",
)

List records within a DNS zone. Retrieve a list of DNS records within a DNS zone that has default name servers. You can filter records by type and name. :param project_id: Project ID on which to filter the returned DNS zone records. :param order_by: Sort order of the returned DNS zone records. :param page: Page number to return, from the paginated results. :param page_size: Maximum number of DNS zone records per page. :param dns_zone: DNS zone on which to filter the returned DNS zone records. :param name: Name on which to filter the returned DNS zone records. :param type_: Record type on which to filter the returned DNS zone records. :param id: Record ID on which to filter the returned DNS zone records. :return: ListDNSZoneRecordsResponse

Usage:

result = api.list_dns_zone_records(
    dns_zone="example",
    name="example",
)

List records within a DNS zone. Retrieve a list of DNS records within a DNS zone that has default name servers. You can filter records by type and name. :param project_id: Project ID on which to filter the returned DNS zone records. :param order_by: Sort order of the returned DNS zone records. :param page: Page number to return, from the paginated results. :param page_size: Maximum number of DNS zone records per page. :param dns_zone: DNS zone on which to filter the returned DNS zone records. :param name: Name on which to filter the returned DNS zone records. :param type_: Record type on which to filter the returned DNS zone records. :param id: Record ID on which to filter the returned DNS zone records. :return: List[Record]

Usage:

result = api.list_dns_zone_records_all(
    dns_zone="example",
    name="example",
)

list_dns_zone_version_records(*, page: int | None = None, page_size: int | None = None, dns_zone_version_id: str) → ListDNSZoneVersionRecordsResponse

List records from a given version of a specific DNS zone. Retrieve a list of records from a specific DNS zone version. :param page: Page number to return, from the paginated results. :param page_size: Maximum number of DNS zones versions records per page. :param dns_zone_version_id: :return: ListDNSZoneVersionRecordsResponse

Usage:

result = api.list_dns_zone_version_records(
    dns_zone_version_id="example",
)

list_dns_zone_version_records_all(*, page: int | None = None, page_size: int | None = None, dns_zone_version_id: str) → List[Record]

List records from a given version of a specific DNS zone. Retrieve a list of records from a specific DNS zone version. :param page: Page number to return, from the paginated results. :param page_size: Maximum number of DNS zones versions records per page. :param dns_zone_version_id: :return: List[Record]

Usage:

result = api.list_dns_zone_version_records_all(
    dns_zone_version_id="example",
)

list_dns_zone_versions(*, page: int | None = None, page_size: int | None = None, dns_zone: str) → ListDNSZoneVersionsResponse

List versions of a DNS zone. Retrieve a list of a DNS zone’s versions. The maximum version count is 100. If the count reaches this limit, the oldest version will be deleted after each new modification. :param page: Page number to return, from the paginated results. :param page_size: Maximum number of DNS zones versions per page. :param dns_zone: :return: ListDNSZoneVersionsResponse

Usage:

result = api.list_dns_zone_versions(
    dns_zone="example",
)

list_dns_zone_versions_all(*, page: int | None = None, page_size: int | None = None, dns_zone: str) → List[DNSZoneVersion]

List versions of a DNS zone. Retrieve a list of a DNS zone’s versions. The maximum version count is 100. If the count reaches this limit, the oldest version will be deleted after each new modification. :param page: Page number to return, from the paginated results. :param page_size: Maximum number of DNS zones versions per page. :param dns_zone: :return: List[DNSZoneVersion]

Usage:

result = api.list_dns_zone_versions_all(
    dns_zone="example",
)

List DNS zones. Retrieve the list of DNS zones you can manage and filter DNS zones associated with specific domain names. :param domain: Domain on which to filter the returned DNS zones. :param organization_id: Organization ID on which to filter the returned DNS zones. :param project_id: Project ID on which to filter the returned DNS zones. :param order_by: Sort order of the returned DNS zones. :param page: Page number to return, from the paginated results. :param page_size: Maximum number of DNS zones to return per page. :param dns_zone: DNS zone on which to filter the returned DNS zones. :param dns_zones: DNS zones on which to filter the returned DNS zones. :param created_after: Only list DNS zones created after this date. :param created_before: Only list DNS zones created before this date. :param updated_after: Only list DNS zones updated after this date. :param updated_before: Only list DNS zones updated before this date. :return: ListDNSZonesResponse

Usage:

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

List DNS zones. Retrieve the list of DNS zones you can manage and filter DNS zones associated with specific domain names. :param domain: Domain on which to filter the returned DNS zones. :param organization_id: Organization ID on which to filter the returned DNS zones. :param project_id: Project ID on which to filter the returned DNS zones. :param order_by: Sort order of the returned DNS zones. :param page: Page number to return, from the paginated results. :param page_size: Maximum number of DNS zones to return per page. :param dns_zone: DNS zone on which to filter the returned DNS zones. :param dns_zones: DNS zones on which to filter the returned DNS zones. :param created_after: Only list DNS zones created after this date. :param created_before: Only list DNS zones created before this date. :param updated_after: Only list DNS zones updated after this date. :param updated_before: Only list DNS zones updated before this date. :return: List[DNSZone]

Usage:

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

list_ssl_certificates(*, dns_zone: str, page: int | None = None, page_size: int | None = None, project_id: str | None = None) → ListSSLCertificatesResponse

List a user’s TLS certificates. List all the TLS certificates a user has created, specified by the user’s Project ID and the DNS zone. :param dns_zone: :param page: :param page_size: :param project_id: :return: ListSSLCertificatesResponse

Usage:

result = api.list_ssl_certificates(
    dns_zone="example",
)

list_ssl_certificates_all(*, dns_zone: str, page: int | None = None, page_size: int | None = None, project_id: str | None = None) → List[SSLCertificate]

List a user’s TLS certificates. List all the TLS certificates a user has created, specified by the user’s Project ID and the DNS zone. :param dns_zone: :param page: :param page_size: :param project_id: :return: List[SSLCertificate]

Usage:

result = api.list_ssl_certificates_all(
    dns_zone="example",
)

refresh_dns_zone(*, dns_zone: str, recreate_dns_zone: bool, recreate_sub_dns_zone: bool) → RefreshDNSZoneResponse

Refresh a DNS zone. Refresh an SOA DNS zone to reload the records in the DNS zone and update the SOA serial. You can recreate the given DNS zone and its sub DNS zone if needed. :param dns_zone: DNS zone to refresh. :param recreate_dns_zone: Specifies whether or not to recreate the DNS zone. :param recreate_sub_dns_zone: Specifies whether or not to recreate the sub DNS zone. :return: RefreshDNSZoneResponse

Usage:

result = api.refresh_dns_zone(
    dns_zone="example",
    recreate_dns_zone=False,
    recreate_sub_dns_zone=False,
)

restore_dns_zone_version(*, dns_zone_version_id: str) → RestoreDNSZoneVersionResponse

Restore a DNS zone version. Restore and activate a version of a specific DNS zone. :param dns_zone_version_id: :return: RestoreDNSZoneVersionResponse

Usage:

result = api.restore_dns_zone_version(
    dns_zone_version_id="example",
)

update_dns_zone(*, dns_zone: str, new_dns_zone: str | None = None, project_id: str | None = None) → DNSZone

Update a DNS zone. Update the name and/or the Organizations for a DNS zone. :param dns_zone: DNS zone to update. :param new_dns_zone: Name of the new DNS zone to create. :param project_id: Project ID in which to create the new DNS zone. :return: DNSZone

Usage:

result = api.update_dns_zone(
    dns_zone="example",
)

update_dns_zone_nameservers(*, dns_zone: str, ns: List[Nameserver]) → UpdateDNSZoneNameserversResponse

Update name servers within a DNS zone. Update name servers within a DNS zone and set optional glue records. :param dns_zone: DNS zone in which to update the DNS zone name servers. :param ns: New DNS zone name servers. :return: UpdateDNSZoneNameserversResponse

Usage:

result = api.update_dns_zone_nameservers(
    dns_zone="example",
    ns=[],
)

update_dns_zone_records(*, dns_zone: str, changes: List[RecordChange], disallow_new_zone_creation: bool, return_all_records: bool | None = None, serial: int | None = None) → UpdateDNSZoneRecordsResponse

Update records within a DNS zone. Update records within a DNS zone that has default name servers and perform several actions on your records.

Actions include:

add: allows you to add a new record or add a new IP to an existing A record, for example
set: allows you to edit a record or edit an IP from an existing A record, for example
delete: allows you to delete a record or delete an IP from an existing A record, for example
clear: allows you to delete all records from a DNS zone

All edits will be versioned. :param dns_zone: DNS zone in which to update the DNS zone records. :param changes: Changes made to the records. :param disallow_new_zone_creation: Disable the creation of the target zone if it does not exist. Target zone creation is disabled by default. :param return_all_records: Specifies whether or not to return all the records. :param serial: Use the provided serial (0) instead of the auto-increment serial. :return: UpdateDNSZoneRecordsResponse

Usage:

result = api.update_dns_zone_records(
    dns_zone="example",
    changes=[],
    disallow_new_zone_creation=False,
)

wait_for_ssl_certificate(*, dns_zone: str, options: WaitForOptions[SSLCertificate, bool] | None = None) → SSLCertificate

Get a DNS zone’s TLS certificate. Get the DNS zone’s TLS certificate. If you do not have a certificate, the ouptut returns no certificate found. :param dns_zone: :return: SSLCertificate

Usage:

result = api.get_ssl_certificate(
    dns_zone="example",
)

class scaleway.domain.v2beta1.DomainV2Beta1RegistrarAPI(client: Client, *, bypass_validation: bool = False)

Bases: API

Manage your domains and contacts.

buy_domains(*, domains: List[str], duration_in_years: int, project_id: str | None = None, owner_contact_id: str | None = None, owner_contact: NewContact | None = None, administrative_contact_id: str | None = None, administrative_contact: NewContact | None = None, technical_contact_id: str | None = None, technical_contact: NewContact | None = None) → OrderResponse

Purchase domains. Request the registration of domain names. You can provide a domain’s already existing contact or a new contact. :param domains: :param duration_in_years: :param project_id: :param owner_contact_id: One-Of (‘owner_contact_type’): at most one of ‘owner_contact_id’, ‘owner_contact’ could be set. :param owner_contact: One-Of (‘owner_contact_type’): at most one of ‘owner_contact_id’, ‘owner_contact’ could be set. :param administrative_contact_id: One-Of (‘administrative_contact_type’): at most one of ‘administrative_contact_id’, ‘administrative_contact’ could be set. :param administrative_contact: One-Of (‘administrative_contact_type’): at most one of ‘administrative_contact_id’, ‘administrative_contact’ could be set. :param technical_contact_id: One-Of (‘technical_contact_type’): at most one of ‘technical_contact_id’, ‘technical_contact’ could be set. :param technical_contact: One-Of (‘technical_contact_type’): at most one of ‘technical_contact_id’, ‘technical_contact’ could be set. :return: OrderResponse

Usage:

result = api.buy_domains(
    domains=[],
    duration_in_years=1,
)

check_contacts_compatibility(*, domains: List[str] | None = None, tlds: List[str] | None = None, owner_contact_id: str | None = None, owner_contact: NewContact | None = None, administrative_contact_id: str | None = None, administrative_contact: NewContact | None = None, technical_contact_id: str | None = None, technical_contact: NewContact | None = None) → CheckContactsCompatibilityResponse

Check if contacts are compatible with a domain or a TLD. Check whether contacts are compatible with a domain or a TLD. If contacts are not compatible with either the domain or the TLD, the information that needs to be corrected is returned. :param domains: :param tlds: :param owner_contact_id: One-Of (‘owner_contact_type’): at most one of ‘owner_contact_id’, ‘owner_contact’ could be set. :param owner_contact: One-Of (‘owner_contact_type’): at most one of ‘owner_contact_id’, ‘owner_contact’ could be set. :param administrative_contact_id: One-Of (‘administrative_contact_type’): at most one of ‘administrative_contact_id’, ‘administrative_contact’ could be set. :param administrative_contact: One-Of (‘administrative_contact_type’): at most one of ‘administrative_contact_id’, ‘administrative_contact’ could be set. :param technical_contact_id: One-Of (‘technical_contact_type’): at most one of ‘technical_contact_id’, ‘technical_contact’ could be set. :param technical_contact: One-Of (‘technical_contact_type’): at most one of ‘technical_contact_id’, ‘technical_contact’ could be set. :return: CheckContactsCompatibilityResponse

Usage:

result = api.check_contacts_compatibility()

create_domain_host(*, domain: str, name: str, ips: List[str] | None = None) → Host

Create a hostname for a domain. Create a hostname for a domain with glue IPs. :param domain: :param name: :param ips: :return: Host

Usage:

result = api.create_domain_host(
    domain="example",
    name="example",
)

delete_domain_host(*, domain: str, name: str) → Host

Delete a domain’s hostname. :param domain: :param name: :return: Host

Usage:

result = api.delete_domain_host(
    domain="example",
    name="example",
)

delete_external_domain(*, domain: str) → DeleteExternalDomainResponse

Delete an external domain. Delete an external domain name. :param domain: :return: DeleteExternalDomainResponse

Usage:

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

disable_domain_auto_renew(*, domain: str) → Domain

Disable auto renew. Disable the auto renew feature for a domain. This means the domain will not be renewed before its expiry date. :param domain: :return: Domain

Usage:

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

disable_domain_dnssec(*, domain: str) → Domain

Disable a domain’s DNSSEC. Disable DNSSEC for a domain. :param domain: :return: Domain

Usage:

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

enable_domain_auto_renew(*, domain: str) → Domain

Enable auto renew. Enable the auto renew feature for a domain. This means the domain will be automatically renewed before its expiry date. :param domain: :return: Domain

Usage:

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

enable_domain_dnssec(*, domain: str, ds_record: DSRecord | None = None) → Domain

Update domain DNSSEC. If your domain uses another registrar and has the default Scaleway NS, you have to update the DS record at your registrar. :param domain: :param ds_record: :return: Domain

Usage:

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

get_contact(*, contact_id: str) → Contact

Get a contact. Retrieve a contact’s details from the registrar using the given contact’s ID. :param contact_id: :return: Contact

Usage:

result = api.get_contact(
    contact_id="example",
)

get_domain(*, domain: str) → Domain

Get domain. Retrieve a specific domain and display the domain’s information. :param domain: :return: Domain

Usage:

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

get_domain_auth_code(*, domain: str) → GetDomainAuthCodeResponse

Get a domain’s authorization code. Retrieve the authorization code to tranfer an unlocked domain. The output returns an error if the domain is locked. Some TLDs may have a different procedure to retrieve the authorization code. In that case, the information displays in the message field. :param domain: :return: GetDomainAuthCodeResponse

Usage:

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

List contacts. Retrieve the list of contacts and their associated domains and roles. You can filter the list by domain name. :param page: :param page_size: :param domain: :param project_id: :param organization_id: :param role: :param email_status: :return: ListContactsResponse

Usage:

result = api.list_contacts()

List contacts. Retrieve the list of contacts and their associated domains and roles. You can filter the list by domain name. :param page: :param page_size: :param domain: :param project_id: :param organization_id: :param role: :param email_status: :return: List[ContactRoles]

Usage:

result = api.list_contacts_all()

list_domain_hosts(*, page: int | None = None, page_size: int | None = None, domain: str) → ListDomainHostsResponse

List a domain’s hostnames. List a domain’s hostnames using their glue IPs. :param page: :param page_size: :param domain: :return: ListDomainHostsResponse

Usage:

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

list_domain_hosts_all(*, page: int | None = None, page_size: int | None = None, domain: str) → List[Host]

List a domain’s hostnames. List a domain’s hostnames using their glue IPs. :param page: :param page_size: :param domain: :return: List[Host]

Usage:

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

List domains. Retrieve the list of domains you own. :param page: :param page_size: :param order_by: :param registrar: :param status: :param project_id: :param organization_id: :param is_external: :param domain: :return: ListDomainsResponse

Usage:

result = api.list_domains()

List domains. Retrieve the list of domains you own. :param page: :param page_size: :param order_by: :param registrar: :param status: :param project_id: :param organization_id: :param is_external: :param domain: :return: List[DomainSummary]

Usage:

result = api.list_domains_all()

list_inbound_transfers(*, page: int, domain: str, page_size: int | None = None, project_id: str | None = None, organization_id: str | None = None) → ListInboundTransfersResponse

Parameters:

page –
domain –
page_size –
project_id –
organization_id –

Returns:

ListInboundTransfersResponse

Usage:

result = api.list_inbound_transfers(
    page=1,
    domain="example",
)

list_inbound_transfers_all(*, page: int, domain: str, page_size: int | None = None, project_id: str | None = None, organization_id: str | None = None) → List[InboundTransfer]

Parameters:

page –
domain –
page_size –
project_id –
organization_id –

Returns:

List[InboundTransfer]

Usage:

result = api.list_inbound_transfers_all(
    page=1,
    domain="example",
)

List domains that can be renewed. Retrieve the list of domains you own that can be renewed. You can also see the maximum renewal duration in years for your domains that are renewable. :param page: :param page_size: :param order_by: :param project_id: :param organization_id: :return: ListRenewableDomainsResponse

Usage:

result = api.list_renewable_domains()

List domains that can be renewed. Retrieve the list of domains you own that can be renewed. You can also see the maximum renewal duration in years for your domains that are renewable. :param page: :param page_size: :param order_by: :param project_id: :param organization_id: :return: List[RenewableDomain]

Usage:

result = api.list_renewable_domains_all()

List tasks. List all operations performed on the account. You can filter the list of tasks by domain name. :param page: :param page_size: :param project_id: :param organization_id: :param domain: :param types: :param statuses: :param order_by: :return: ListTasksResponse

Usage:

result = api.list_tasks()

List tasks. List all operations performed on the account. You can filter the list of tasks by domain name. :param page: :param page_size: :param project_id: :param organization_id: :param domain: :param types: :param statuses: :param order_by: :return: List[Task]

Usage:

result = api.list_tasks_all()

list_tlds(*, tlds: List[str] | None = None, page: int | None = None, page_size: int | None = None, order_by: ListTldsRequestOrderBy | None = None) → ListTldsResponse

List TLD offers. Retrieve the list of TLDs and offers associated with them. :param tlds: Array of TLDs to return. :param page: Page number for the returned Projects. :param page_size: Maximum number of Project per page. :param order_by: Sort order of the returned TLDs. :return: ListTldsResponse

Usage:

result = api.list_tlds()

list_tlds_all(*, tlds: List[str] | None = None, page: int | None = None, page_size: int | None = None, order_by: ListTldsRequestOrderBy | None = None) → List[Tld]

List TLD offers. Retrieve the list of TLDs and offers associated with them. :param tlds: Array of TLDs to return. :param page: Page number for the returned Projects. :param page_size: Maximum number of Project per page. :param order_by: Sort order of the returned TLDs. :return: List[Tld]

Usage:

result = api.list_tlds_all()

lock_domain_transfer(*, domain: str) → Domain

Lock the transfer of a domain. Lock the transfer of a domain. This means that the domain cannot be transferred and the authorization code cannot be requested to your current registrar. :param domain: :return: Domain

Usage:

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

register_external_domain(*, domain: str, project_id: str | None = None) → RegisterExternalDomainResponse

Register an external domain. Request the registration of an external domain name. :param domain: :param project_id: :return: RegisterExternalDomainResponse

Usage:

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

renew_domains(*, domains: List[str], duration_in_years: int, force_late_renewal: bool | None = None) → OrderResponse

Renew domains. Request the renewal of one or more domain names. :param domains: :param duration_in_years: :param force_late_renewal: :return: OrderResponse

Usage:

result = api.renew_domains(
    domains=[],
    duration_in_years=1,
)

search_available_domains(*, domains: List[str], strict_search: bool, tlds: List[str] | None = None) → SearchAvailableDomainsResponse

Search available domains. Search a domain or a maximum of 10 domains that are available.

If the TLD list is empty or not set, the search returns the results from the most popular TLDs. :param domains: A list of domain to search, TLD is optional. :param strict_search: Search exact match. :param tlds: Array of tlds to search on. :return: SearchAvailableDomainsResponse

Usage:

result = api.search_available_domains(
    domains=[],
    strict_search=False,
)

trade_domain(*, domain: str, project_id: str | None = None, new_owner_contact_id: str | None = None, new_owner_contact: NewContact | None = None) → OrderResponse

Trade a domain’s contact. Request to change a domain’s contact owner. If you specify the organization_id of the domain’s new owner, the contact will change from the current owner’s Scaleway account to the new owner’s Scaleway account. If the new owner’s current contact information is not available, the first ever contact they have created for previous domains is taken into account to operate the change. If the new owner has never created a contact to register domains before, an error message displays. :param domain: :param project_id: :param new_owner_contact_id: One-Of (‘new_owner_contact_type’): at most one of ‘new_owner_contact_id’, ‘new_owner_contact’ could be set. :param new_owner_contact: One-Of (‘new_owner_contact_type’): at most one of ‘new_owner_contact_id’, ‘new_owner_contact’ could be set. :return: OrderResponse

Usage:

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

transfer_in_domain(*, domains: List[TransferInDomainRequestTransferRequest], project_id: str | None = None, owner_contact_id: str | None = None, owner_contact: NewContact | None = None, administrative_contact_id: str | None = None, administrative_contact: NewContact | None = None, technical_contact_id: str | None = None, technical_contact: NewContact | None = None) → OrderResponse

Transfer a domain. Request the transfer of a domain from another registrar to Scaleway Domains and DNS. :param domains: :param project_id: :param owner_contact_id: One-Of (‘owner_contact_type’): at most one of ‘owner_contact_id’, ‘owner_contact’ could be set. :param owner_contact: One-Of (‘owner_contact_type’): at most one of ‘owner_contact_id’, ‘owner_contact’ could be set. :param administrative_contact_id: One-Of (‘administrative_contact_type’): at most one of ‘administrative_contact_id’, ‘administrative_contact’ could be set. :param administrative_contact: One-Of (‘administrative_contact_type’): at most one of ‘administrative_contact_id’, ‘administrative_contact’ could be set. :param technical_contact_id: One-Of (‘technical_contact_type’): at most one of ‘technical_contact_id’, ‘technical_contact’ could be set. :param technical_contact: One-Of (‘technical_contact_type’): at most one of ‘technical_contact_id’, ‘technical_contact’ could be set. :return: OrderResponse

Usage:

result = api.transfer_in_domain(
    domains=[],
)

unlock_domain_transfer(*, domain: str) → Domain

Unlock the transfer of a domain. Unlock the transfer of a domain. This means that the domain can be transferred and the authorization code can be requested to your current registrar. :param domain: :return: Domain

Usage:

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

Update contact. Edit the contact’s information. :param contact_id: :param email: :param email_alt: :param phone_number: :param fax_number: :param address_line_1: :param address_line_2: :param zip: :param city: :param country: :param vat_identification_code: :param company_identification_code: :param lang: :param resale: :param questions: :param extension_fr: :param extension_eu: :param whois_opt_in: :param state: :param extension_nl: :return: Contact

Usage:

result = api.update_contact(
    contact_id="example",
)

update_domain(*, domain: str, technical_contact_id: str | None = None, technical_contact: NewContact | None = None, owner_contact_id: str | None = None, owner_contact: NewContact | None = None, administrative_contact_id: str | None = None, administrative_contact: NewContact | None = None) → Domain

Update a domain’s contacts. Update contacts for a specific domain or create a new contact. If you add the same contact for multiple roles (owner, administrative, technical), only one ID will be created and used for all of the roles. :param domain: :param technical_contact_id: One-Of (‘technical_contact_info’): at most one of ‘technical_contact_id’, ‘technical_contact’ could be set. :param technical_contact: One-Of (‘technical_contact_info’): at most one of ‘technical_contact_id’, ‘technical_contact’ could be set. :param owner_contact_id: One-Of (‘owner_contact_info’): at most one of ‘owner_contact_id’, ‘owner_contact’ could be set. :param owner_contact: One-Of (‘owner_contact_info’): at most one of ‘owner_contact_id’, ‘owner_contact’ could be set. :param administrative_contact_id: One-Of (‘administrative_contact_info’): at most one of ‘administrative_contact_id’, ‘administrative_contact’ could be set. :param administrative_contact: One-Of (‘administrative_contact_info’): at most one of ‘administrative_contact_id’, ‘administrative_contact’ could be set. :return: Domain

Usage:

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

update_domain_host(*, domain: str, name: str, ips: List[str] | None = None) → Host

Update a domain’s hostname. Update a domain’s hostname with glue IPs. :param domain: :param name: :param ips: :return: Host

Usage:

result = api.update_domain_host(
    domain="example",
    name="example",
)

wait_for_domain(*, domain: str, options: WaitForOptions[Domain, bool] | None = None) → Domain

Get domain. Retrieve a specific domain and display the domain’s information. :param domain: :return: Domain

Usage:

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

class scaleway.domain.v2beta1.ExportRawDNSZoneRequest(dns_zone: 'str', format: 'Optional[RawFormat]' = <RawFormat.UNKNOWN_RAW_FORMAT: 'unknown_raw_format'>)

Bases: object

dns_zone: str: DNS zone to export.

format: RawFormat | None = 'unknown_raw_format': DNS zone format.

class scaleway.domain.v2beta1.GetDNSZoneTsigKeyRequest(dns_zone: 'str')

Bases: object

dns_zone: str

class scaleway.domain.v2beta1.GetDNSZoneTsigKeyResponse(name: 'str', key: 'str', algorithm: 'str')

Bases: object

algorithm: str

key: str

name: str

class scaleway.domain.v2beta1.GetDNSZoneVersionDiffRequest(dns_zone_version_id: 'str')

Bases: object

dns_zone_version_id: str

class scaleway.domain.v2beta1.GetDNSZoneVersionDiffResponse(changes: 'List[RecordChange]')

Bases: object

changes: List[RecordChange]

class scaleway.domain.v2beta1.GetDomainAuthCodeResponse(auth_code: 'str')

Bases: object

auth_code: str

class scaleway.domain.v2beta1.GetSSLCertificateRequest(dns_zone: 'str')

Bases: object

dns_zone: str

class scaleway.domain.v2beta1.Host(domain: 'str', name: 'str', ips: 'List[str]', status: 'HostStatus')

Bases: object

domain: str

ips: List[str]

name: str

status: HostStatus

class scaleway.domain.v2beta1.HostStatus(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

ACTIVE = 'active'

DELETING = 'deleting'

UNKNOWN_STATUS = 'unknown_status'

UPDATING = 'updating'

class scaleway.domain.v2beta1.ImportProviderDNSZoneRequest(dns_zone: 'str', online_v1: 'Optional[ImportProviderDNSZoneRequestOnlineV1]' = None)

Bases: object

dns_zone: str

online_v1: ImportProviderDNSZoneRequestOnlineV1 | None = None

class scaleway.domain.v2beta1.ImportProviderDNSZoneRequestOnlineV1(token: 'str')

Bases: object

token: str

class scaleway.domain.v2beta1.ImportProviderDNSZoneResponse(records: 'List[Record]')

Bases: object

records: List[Record]

class scaleway.domain.v2beta1.ImportRawDNSZoneRequest(dns_zone: 'str', content: 'Optional[str]' = None, project_id: 'Optional[str]' = None, format: 'Optional[RawFormat]' = <RawFormat.UNKNOWN_RAW_FORMAT: 'unknown_raw_format'>, bind_source: 'Optional[ImportRawDNSZoneRequestBindSource]' = None, axfr_source: 'Optional[ImportRawDNSZoneRequestAXFRSource]' = None)

Bases: object

axfr_source: ImportRawDNSZoneRequestAXFRSource | None = None

bind_source: ImportRawDNSZoneRequestBindSource | None = None

content: str | None = None

dns_zone: str: DNS zone to import.

format: RawFormat | None = 'unknown_raw_format'

project_id: str | None = None

class scaleway.domain.v2beta1.ImportRawDNSZoneRequestAXFRSource(name_server: 'str', tsig_key: 'Optional[ImportRawDNSZoneRequestTsigKey]' = None)

Bases: object

name_server: str

tsig_key: ImportRawDNSZoneRequestTsigKey | None = None

class scaleway.domain.v2beta1.ImportRawDNSZoneRequestBindSource(content: 'str')

Bases: object

content: str

class scaleway.domain.v2beta1.ImportRawDNSZoneRequestTsigKey(name: 'str', key: 'str', algorithm: 'str')

Bases: object

algorithm: str

key: str

name: str

class scaleway.domain.v2beta1.ImportRawDNSZoneResponse(records: 'List[Record]')

Bases: object

records: List[Record]

class scaleway.domain.v2beta1.InboundTransfer(id: 'str', project_id: 'str', domain: 'str', status: 'InboundTransferStatus', message: 'str', task_id: 'str', created_at: 'Optional[datetime]' = None, last_updated_at: 'Optional[datetime]' = None)

Bases: object

created_at: datetime | None = None: The creation date of the inbound transfer.

domain: str: The domain associated with the inbound transfer.

id: str: The unique identifier of the inbound transfer.

last_updated_at: datetime | None = None: The last modification date of the inbound transfer.

message: str: Human-friendly message to describe the current inbound transfer status.

project_id: str: The project ID associated with the inbound transfer.

status: InboundTransferStatus: Inbound transfer status.

task_id: str: The unique identifier of the associated task.

class scaleway.domain.v2beta1.InboundTransferStatus(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

DONE = 'done'

ERR_ALREADY_TRANSFERRING = 'err_already_transferring'

ERR_DOMAIN_PENDING = 'err_domain_pending'

ERR_DOMAIN_TOO_YOUNG = 'err_domain_too_young'

ERR_INTERNAL = 'err_internal'

ERR_INVALID_AUTHCODE = 'err_invalid_authcode'

ERR_TOO_MANY_REQUESTS = 'err_too_many_requests'

ERR_TRANSFER_IMPOSSIBLE = 'err_transfer_impossible'

ERR_TRANSFER_PROHIBITED = 'err_transfer_prohibited'

IN_PROGRESS = 'in_progress'

UNKNOWN = 'unknown'

class scaleway.domain.v2beta1.LinkedProduct(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

UNKNOWN_PRODUCT = 'unknown_product'

VPC = 'vpc'

class scaleway.domain.v2beta1.ListContactsRequestRole(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

ADMINISTRATIVE = 'administrative'

OWNER = 'owner'

TECHNICAL = 'technical'

UNKNOWN_ROLE = 'unknown_role'

class scaleway.domain.v2beta1.ListContactsResponse(total_count: 'int', contacts: 'List[ContactRoles]')

Bases: object

contacts: List[ContactRoles]

total_count: int

class scaleway.domain.v2beta1.ListDNSZoneNameserversRequest(dns_zone: 'str', project_id: 'Optional[str]' = None)

Bases: object

dns_zone: str: DNS zone on which to filter the returned DNS zone name servers.

project_id: str | None = None: Project ID on which to filter the returned DNS zone name servers.

class scaleway.domain.v2beta1.ListDNSZoneNameserversResponse(ns: 'List[Nameserver]')

Bases: object

ns: List[Nameserver]: DNS zone name servers returned.

class scaleway.domain.v2beta1.ListDNSZoneRecordsRequest(dns_zone: 'str', name: 'str', project_id: 'Optional[str]' = None, order_by: 'Optional[ListDNSZoneRecordsRequestOrderBy]' = <ListDNSZoneRecordsRequestOrderBy.NAME_ASC: 'name_asc'>, page: 'Optional[int]' = 0, page_size: 'Optional[int]' = 0, type_: 'Optional[RecordType]' = <RecordType.UNKNOWN: 'unknown'>, id: 'Optional[str]' = None)

Bases: object

dns_zone: str: DNS zone on which to filter the returned DNS zone records.

id: str | None = None: Record ID on which to filter the returned DNS zone records.

name: str: Name on which to filter the returned DNS zone records.

order_by: ListDNSZoneRecordsRequestOrderBy | None = 'name_asc': Sort order of the returned DNS zone records.

page: int | None = 0: Page number to return, from the paginated results.

page_size: int | None = 0: Maximum number of DNS zone records per page.

project_id: str | None = None: Project ID on which to filter the returned DNS zone records.

type_: RecordType | None = 'unknown': Record type on which to filter the returned DNS zone records.

class scaleway.domain.v2beta1.ListDNSZoneRecordsRequestOrderBy(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

NAME_ASC = 'name_asc'

NAME_DESC = 'name_desc'

class scaleway.domain.v2beta1.ListDNSZoneRecordsResponse(total_count: 'int', records: 'List[Record]')

Bases: object

records: List[Record]: Paginated returned DNS zone records.

total_count: int: Total number of DNS zone records.

class scaleway.domain.v2beta1.ListDNSZoneVersionRecordsRequest(dns_zone_version_id: 'str', page: 'Optional[int]' = 0, page_size: 'Optional[int]' = 0)

Bases: object

dns_zone_version_id: str

page: int | None = 0: Page number to return, from the paginated results.

page_size: int | None = 0: Maximum number of DNS zones versions records per page.

class scaleway.domain.v2beta1.ListDNSZoneVersionRecordsResponse(total_count: 'int', records: 'List[Record]')

Bases: object

records: List[Record]

total_count: int: Total number of DNS zones versions records.

class scaleway.domain.v2beta1.ListDNSZoneVersionsRequest(dns_zone: 'str', page: 'Optional[int]' = 0, page_size: 'Optional[int]' = 0)

Bases: object

dns_zone: str

page: int | None = 0: Page number to return, from the paginated results.

page_size: int | None = 0: Maximum number of DNS zones versions per page.

class scaleway.domain.v2beta1.ListDNSZoneVersionsResponse(total_count: 'int', versions: 'List[DNSZoneVersion]')

Bases: object

total_count: int: Total number of DNS zones versions.

versions: List[DNSZoneVersion]

class scaleway.domain.v2beta1.ListDNSZonesRequest(domain: 'str', organization_id: 'Optional[str]' = None, project_id: 'Optional[str]' = None, order_by: 'Optional[ListDNSZonesRequestOrderBy]' = <ListDNSZonesRequestOrderBy.DOMAIN_ASC: 'domain_asc'>, page: 'Optional[int]' = 0, page_size: 'Optional[int]' = 0, dns_zone: 'Optional[str]' = None, dns_zones: 'Optional[List[str]]' = <factory>, created_after: 'Optional[datetime]' = None, created_before: 'Optional[datetime]' = None, updated_after: 'Optional[datetime]' = None, updated_before: 'Optional[datetime]' = None)

Bases: object

created_after: datetime | None = None: Only list DNS zones created after this date.

created_before: datetime | None = None: Only list DNS zones created before this date.

dns_zone: str | None = None: DNS zone on which to filter the returned DNS zones.

dns_zones: List[str] | None: DNS zones on which to filter the returned DNS zones.

domain: str: Domain on which to filter the returned DNS zones.

order_by: ListDNSZonesRequestOrderBy | None = 'domain_asc': Sort order of the returned DNS zones.

organization_id: str | None = None: Organization ID on which to filter the returned DNS zones.

page: int | None = 0: Page number to return, from the paginated results.

page_size: int | None = 0: Maximum number of DNS zones to return per page.

project_id: str | None = None: Project ID on which to filter the returned DNS zones.

updated_after: datetime | None = None: Only list DNS zones updated after this date.

updated_before: datetime | None = None: Only list DNS zones updated before this date.

class scaleway.domain.v2beta1.ListDNSZonesRequestOrderBy(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

CREATED_AT_ASC = 'created_at_asc'

CREATED_AT_DESC = 'created_at_desc'

DOMAIN_ASC = 'domain_asc'

DOMAIN_DESC = 'domain_desc'

SUBDOMAIN_ASC = 'subdomain_asc'

SUBDOMAIN_DESC = 'subdomain_desc'

UPDATED_AT_ASC = 'updated_at_asc'

UPDATED_AT_DESC = 'updated_at_desc'

class scaleway.domain.v2beta1.ListDNSZonesResponse(total_count: 'int', dns_zones: 'List[DNSZone]')

Bases: object

dns_zones: List[DNSZone]: Paginated returned DNS zones.

total_count: int: Total number of DNS zones matching the requested criteria.

class scaleway.domain.v2beta1.ListDomainHostsResponse(total_count: 'int', hosts: 'List[Host]')

Bases: object

hosts: List[Host]

total_count: int

class scaleway.domain.v2beta1.ListDomainsRequestOrderBy(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

DOMAIN_ASC = 'domain_asc'

DOMAIN_DESC = 'domain_desc'

class scaleway.domain.v2beta1.ListDomainsResponse(total_count: 'int', domains: 'List[DomainSummary]')

Bases: object

domains: List[DomainSummary]

total_count: int

class scaleway.domain.v2beta1.ListInboundTransfersResponse(total_count: 'int', inbound_transfers: 'List[InboundTransfer]')

Bases: object

inbound_transfers: List[InboundTransfer]

total_count: int

class scaleway.domain.v2beta1.ListRenewableDomainsRequestOrderBy(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

DOMAIN_ASC = 'domain_asc'

DOMAIN_DESC = 'domain_desc'

class scaleway.domain.v2beta1.ListRenewableDomainsResponse(total_count: 'int', domains: 'List[RenewableDomain]')

Bases: object

domains: List[RenewableDomain]

total_count: int

class scaleway.domain.v2beta1.ListSSLCertificatesRequest(dns_zone: 'str', page: 'Optional[int]' = 0, page_size: 'Optional[int]' = 0, project_id: 'Optional[str]' = None)

Bases: object

dns_zone: str

page: int | None = 0

page_size: int | None = 0

project_id: str | None = None

class scaleway.domain.v2beta1.ListSSLCertificatesResponse(total_count: 'int', certificates: 'List[SSLCertificate]')

Bases: object

certificates: List[SSLCertificate]

total_count: int

class scaleway.domain.v2beta1.ListTasksRequestOrderBy(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

DOMAIN_ASC = 'domain_asc'

DOMAIN_DESC = 'domain_desc'

STATUS_ASC = 'status_asc'

STATUS_DESC = 'status_desc'

TYPE_ASC = 'type_asc'

TYPE_DESC = 'type_desc'

UPDATED_AT_ASC = 'updated_at_asc'

UPDATED_AT_DESC = 'updated_at_desc'

class scaleway.domain.v2beta1.ListTasksResponse(total_count: 'int', tasks: 'List[Task]')

Bases: object

tasks: List[Task]

total_count: int

class scaleway.domain.v2beta1.ListTldsRequestOrderBy(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

NAME_ASC = 'name_asc'

NAME_DESC = 'name_desc'

class scaleway.domain.v2beta1.ListTldsResponse(tlds: 'List[Tld]', total_count: 'int')

Bases: object

tlds: List[Tld]: Array of TLDs.

total_count: int: Total count of TLDs returned.

class scaleway.domain.v2beta1.Nameserver(name: 'str', ip: 'List[str]')

Bases: object

ip: List[str]

name: str

class scaleway.domain.v2beta1.NewContact(legal_form: 'ContactLegalForm', firstname: 'str', lastname: 'str', email: 'str', phone_number: 'str', address_line_1: 'str', zip: 'str', city: 'str', country: 'str', lang: 'StdLanguageCode', resale: 'bool', whois_opt_in: 'bool', company_name: 'Optional[str]' = None, email_alt: 'Optional[str]' = None, fax_number: 'Optional[str]' = None, address_line_2: 'Optional[str]' = None, vat_identification_code: 'Optional[str]' = None, company_identification_code: 'Optional[str]' = None, questions: 'Optional[List[ContactQuestion]]' = <factory>, extension_fr: 'Optional[ContactExtensionFR]' = None, extension_eu: 'Optional[ContactExtensionEU]' = None, state: 'Optional[str]' = None, extension_nl: 'Optional[ContactExtensionNL]' = None)

Bases: object

address_line_1: str

address_line_2: str | None = None

city: str

company_identification_code: str | None = None

company_name: str | None = None

country: str

email: str

email_alt: str | None = None

extension_eu: ContactExtensionEU | None = None

extension_fr: ContactExtensionFR | None = None

extension_nl: ContactExtensionNL | None = None

fax_number: str | None = None

firstname: str

lang: LanguageCode

lastname: str

legal_form: ContactLegalForm

phone_number: str

questions: List[ContactQuestion] | None

resale: bool

state: str | None = None

vat_identification_code: str | None = None

whois_opt_in: bool

zip: str

class scaleway.domain.v2beta1.OrderResponse(domains: 'List[str]', organization_id: 'str', project_id: 'str', task_id: 'str', created_at: 'Optional[datetime]' = None)

Bases: object

created_at: datetime | None = None

domains: List[str]

organization_id: str

project_id: str

task_id: str

class scaleway.domain.v2beta1.RawFormat(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

BIND = 'bind'

UNKNOWN_RAW_FORMAT = 'unknown_raw_format'

class scaleway.domain.v2beta1.Record(data: 'str', name: 'str', priority: 'int', ttl: 'int', type_: 'RecordType', id: 'str', comment: 'Optional[str]' = None, geo_ip_config: 'Optional[RecordGeoIPConfig]' = None, http_service_config: 'Optional[RecordHTTPServiceConfig]' = None, weighted_config: 'Optional[RecordWeightedConfig]' = None, view_config: 'Optional[RecordViewConfig]' = None)

Bases: object

comment: str | None = None

data: str

geo_ip_config: RecordGeoIPConfig | None = None

http_service_config: RecordHTTPServiceConfig | None = None

id: str

name: str

priority: int

ttl: int

type_: RecordType

view_config: RecordViewConfig | None = None

weighted_config: RecordWeightedConfig | None = None

class scaleway.domain.v2beta1.RecordChange(add: 'Optional[RecordChangeAdd]' = None, set_: 'Optional[RecordChangeSet]' = None, delete: 'Optional[RecordChangeDelete]' = None, clear: 'Optional[RecordChangeClear]' = None)

Bases: object

add: RecordChangeAdd | None = None

clear: RecordChangeClear | None = None

delete: RecordChangeDelete | None = None

set_: RecordChangeSet | None = None

class scaleway.domain.v2beta1.RecordChangeAdd(records: 'List[Record]')

Bases: object

records: List[Record]

class scaleway.domain.v2beta1.RecordChangeClear: Bases: object

class scaleway.domain.v2beta1.RecordChangeDelete(id: 'Optional[str]' = None, id_fields: 'Optional[RecordIdentifier]' = None)

Bases: object

id: str | None = None

id_fields: RecordIdentifier | None = None

class scaleway.domain.v2beta1.RecordChangeSet(records: 'List[Record]', id: 'Optional[str]' = None, id_fields: 'Optional[RecordIdentifier]' = None)

Bases: object

id: str | None = None

id_fields: RecordIdentifier | None = None

records: List[Record]

class scaleway.domain.v2beta1.RecordGeoIPConfig(matches: 'List[RecordGeoIPConfigMatch]', default: 'str')

Bases: object

default: str

matches: List[RecordGeoIPConfigMatch]

class scaleway.domain.v2beta1.RecordGeoIPConfigMatch(countries: 'List[str]', continents: 'List[str]', data: 'str')

Bases: object

continents: List[str]

countries: List[str]

data: str

class scaleway.domain.v2beta1.RecordHTTPServiceConfig(ips: 'List[str]', url: 'str', strategy: 'RecordHTTPServiceConfigStrategy', must_contain: 'Optional[str]' = None, user_agent: 'Optional[str]' = None)

Bases: object

ips: List[str]

must_contain: str | None = None

strategy: RecordHTTPServiceConfigStrategy

url: str

user_agent: str | None = None

class scaleway.domain.v2beta1.RecordHTTPServiceConfigStrategy(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

ALL = 'all'

HASHED = 'hashed'

RANDOM = 'random'

class scaleway.domain.v2beta1.RecordIdentifier(name: 'str', type_: 'RecordType', data: 'Optional[str]' = None, ttl: 'Optional[int]' = None)

Bases: object

data: str | None = None

name: str

ttl: int | None = None

type_: RecordType

class scaleway.domain.v2beta1.RecordType(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

A = 'a'

AAAA = 'aaaa'

ALIAS = 'alias'

CAA = 'caa'

CNAME = 'cname'

DNAME = 'dname'

DS = 'ds'

HINFO = 'hinfo'

HTTPS = 'https'

LOC = 'loc'

MX = 'mx'

NAPTR = 'naptr'

NS = 'ns'

PTR = 'ptr'

RP = 'rp'

SRV = 'srv'

SSHFP = 'sshfp'

SVCB = 'svcb'

TLSA = 'tlsa'

TXT = 'txt'

UNKNOWN = 'unknown'

URI = 'uri'

class scaleway.domain.v2beta1.RecordViewConfig(views: 'List[RecordViewConfigView]')

Bases: object

views: List[RecordViewConfigView]

class scaleway.domain.v2beta1.RecordViewConfigView(subnet: 'str', data: 'str')

Bases: object

data: str

subnet: str

class scaleway.domain.v2beta1.RecordWeightedConfig(weighted_ips: 'List[RecordWeightedConfigWeightedIP]')

Bases: object

weighted_ips: List[RecordWeightedConfigWeightedIP]

class scaleway.domain.v2beta1.RecordWeightedConfigWeightedIP(ip: 'str', weight: 'int')

Bases: object

ip: str

weight: int

class scaleway.domain.v2beta1.RefreshDNSZoneRequest(dns_zone: 'str', recreate_dns_zone: 'bool', recreate_sub_dns_zone: 'bool')

Bases: object

dns_zone: str: DNS zone to refresh.

recreate_dns_zone: bool: Specifies whether or not to recreate the DNS zone.

recreate_sub_dns_zone: bool: Specifies whether or not to recreate the sub DNS zone.

class scaleway.domain.v2beta1.RefreshDNSZoneResponse(dns_zones: 'List[DNSZone]')

Bases: object

dns_zones: List[DNSZone]: DNS zones returned.

class scaleway.domain.v2beta1.RegisterExternalDomainResponse(domain: 'str', organization_id: 'str', validation_token: 'str', project_id: 'str', created_at: 'Optional[datetime]' = None)

Bases: object

created_at: datetime | None = None

domain: str

organization_id: str

project_id: str

validation_token: str

class scaleway.domain.v2beta1.RegistrarApiBuyDomainsRequest(domains: 'List[str]', duration_in_years: 'int', project_id: 'Optional[str]' = None, owner_contact_id: 'Optional[str]' = None, owner_contact: 'Optional[NewContact]' = None, administrative_contact_id: 'Optional[str]' = None, administrative_contact: 'Optional[NewContact]' = None, technical_contact_id: 'Optional[str]' = None, technical_contact: 'Optional[NewContact]' = None)

Bases: object

administrative_contact: NewContact | None = None

administrative_contact_id: str | None = None

domains: List[str]

duration_in_years: int

owner_contact: NewContact | None = None

owner_contact_id: str | None = None

project_id: str | None = None

technical_contact: NewContact | None = None

technical_contact_id: str | None = None

class scaleway.domain.v2beta1.RegistrarApiCheckContactsCompatibilityRequest(domains: 'Optional[List[str]]' = <factory>, tlds: 'Optional[List[str]]' = <factory>, owner_contact_id: 'Optional[str]' = None, owner_contact: 'Optional[NewContact]' = None, administrative_contact_id: 'Optional[str]' = None, administrative_contact: 'Optional[NewContact]' = None, technical_contact_id: 'Optional[str]' = None, technical_contact: 'Optional[NewContact]' = None)

Bases: object

administrative_contact: NewContact | None = None

administrative_contact_id: str | None = None

domains: List[str] | None

owner_contact: NewContact | None = None

owner_contact_id: str | None = None

technical_contact: NewContact | None = None

technical_contact_id: str | None = None

tlds: List[str] | None

class scaleway.domain.v2beta1.RegistrarApiCreateDomainHostRequest(domain: 'str', name: 'str', ips: 'Optional[List[str]]' = <factory>)

Bases: object

domain: str

ips: List[str] | None

name: str

class scaleway.domain.v2beta1.RegistrarApiDeleteDomainHostRequest(domain: 'str', name: 'str')

Bases: object

domain: str

name: str

class scaleway.domain.v2beta1.RegistrarApiDeleteExternalDomainRequest(domain: 'str')

Bases: object

domain: str

class scaleway.domain.v2beta1.RegistrarApiDisableDomainAutoRenewRequest(domain: 'str')

Bases: object

domain: str

class scaleway.domain.v2beta1.RegistrarApiDisableDomainDNSSECRequest(domain: 'str')

Bases: object

domain: str

class scaleway.domain.v2beta1.RegistrarApiEnableDomainAutoRenewRequest(domain: 'str')

Bases: object

domain: str

class scaleway.domain.v2beta1.RegistrarApiEnableDomainDNSSECRequest(domain: 'str', ds_record: 'Optional[DSRecord]' = None)

Bases: object

domain: str

ds_record: DSRecord | None = None

class scaleway.domain.v2beta1.RegistrarApiGetContactRequest(contact_id: 'str')

Bases: object

contact_id: str

class scaleway.domain.v2beta1.RegistrarApiGetDomainAuthCodeRequest(domain: 'str')

Bases: object

domain: str

class scaleway.domain.v2beta1.RegistrarApiGetDomainRequest(domain: 'str')

Bases: object

domain: str

class scaleway.domain.v2beta1.RegistrarApiListContactsRequest(page: 'Optional[int]' = None, page_size: 'Optional[int]' = None, domain: 'Optional[str]' = None, project_id: 'Optional[str]' = None, organization_id: 'Optional[str]' = None, role: 'Optional[ListContactsRequestRole]' = None, email_status: 'Optional[ContactEmailStatus]' = None)

Bases: object

domain: str | None = None

email_status: ContactEmailStatus | None = None

organization_id: str | None = None

page: int | None = None

page_size: int | None = None

project_id: str | None = None

role: ListContactsRequestRole | None = None

class scaleway.domain.v2beta1.RegistrarApiListDomainHostsRequest(domain: 'str', page: 'Optional[int]' = None, page_size: 'Optional[int]' = None)

Bases: object

domain: str

page: int | None = None

page_size: int | None = None

class scaleway.domain.v2beta1.RegistrarApiListDomainsRequest(page: 'Optional[int]' = None, page_size: 'Optional[int]' = None, order_by: 'Optional[ListDomainsRequestOrderBy]' = None, registrar: 'Optional[str]' = None, status: 'Optional[DomainStatus]' = None, project_id: 'Optional[str]' = None, organization_id: 'Optional[str]' = None, is_external: 'Optional[bool]' = None, domain: 'Optional[str]' = None)

Bases: object

domain: str | None = None

is_external: bool | None = None

order_by: ListDomainsRequestOrderBy | None = None

organization_id: str | None = None

page: int | None = None

page_size: int | None = None

project_id: str | None = None

registrar: str | None = None

status: DomainStatus | None = None

class scaleway.domain.v2beta1.RegistrarApiListInboundTransfersRequest(page: 'int', domain: 'str', page_size: 'Optional[int]' = None, project_id: 'Optional[str]' = None, organization_id: 'Optional[str]' = None)

Bases: object

domain: str

organization_id: str | None = None

page: int

page_size: int | None = None

project_id: str | None = None

class scaleway.domain.v2beta1.RegistrarApiListRenewableDomainsRequest(page: 'Optional[int]' = None, page_size: 'Optional[int]' = None, order_by: 'Optional[ListRenewableDomainsRequestOrderBy]' = None, project_id: 'Optional[str]' = None, organization_id: 'Optional[str]' = None)

Bases: object

order_by: ListRenewableDomainsRequestOrderBy | None = None

organization_id: str | None = None

page: int | None = None

page_size: int | None = None

project_id: str | None = None

class scaleway.domain.v2beta1.RegistrarApiListTasksRequest(page: 'Optional[int]' = None, page_size: 'Optional[int]' = None, project_id: 'Optional[str]' = None, organization_id: 'Optional[str]' = None, domain: 'Optional[str]' = None, types: 'Optional[List[TaskType]]' = <factory>, statuses: 'Optional[List[TaskStatus]]' = <factory>, order_by: 'Optional[ListTasksRequestOrderBy]' = None)

Bases: object

domain: str | None = None

order_by: ListTasksRequestOrderBy | None = None

organization_id: str | None = None

page: int | None = None

page_size: int | None = None

project_id: str | None = None

statuses: List[TaskStatus] | None

types: List[TaskType] | None

class scaleway.domain.v2beta1.RegistrarApiListTldsRequest(tlds: 'Optional[List[str]]' = <factory>, page: 'Optional[int]' = 0, page_size: 'Optional[int]' = 0, order_by: 'Optional[ListTldsRequestOrderBy]' = <ListTldsRequestOrderBy.NAME_ASC: 'name_asc'>)

Bases: object

order_by: ListTldsRequestOrderBy | None = 'name_asc': Sort order of the returned TLDs.

page: int | None = 0: Page number for the returned Projects.

page_size: int | None = 0: Maximum number of Project per page.

tlds: List[str] | None: Array of TLDs to return.

class scaleway.domain.v2beta1.RegistrarApiLockDomainTransferRequest(domain: 'str')

Bases: object

domain: str

class scaleway.domain.v2beta1.RegistrarApiRegisterExternalDomainRequest(domain: 'str', project_id: 'Optional[str]' = None)

Bases: object

domain: str

project_id: str | None = None

class scaleway.domain.v2beta1.RegistrarApiRenewDomainsRequest(domains: 'List[str]', duration_in_years: 'int', force_late_renewal: 'Optional[bool]' = False)

Bases: object

domains: List[str]

duration_in_years: int

force_late_renewal: bool | None = False

class scaleway.domain.v2beta1.RegistrarApiSearchAvailableDomainsRequest(domains: 'List[str]', strict_search: 'bool', tlds: 'Optional[List[str]]' = <factory>)

Bases: object

domains: List[str]: A list of domain to search, TLD is optional.

strict_search: bool: Search exact match.

tlds: List[str] | None: Array of tlds to search on.

class scaleway.domain.v2beta1.RegistrarApiTradeDomainRequest(domain: 'str', project_id: 'Optional[str]' = None, new_owner_contact_id: 'Optional[str]' = None, new_owner_contact: 'Optional[NewContact]' = None)

Bases: object

domain: str

new_owner_contact: NewContact | None = None

new_owner_contact_id: str | None = None

project_id: str | None = None

class scaleway.domain.v2beta1.RegistrarApiTransferInDomainRequest(domains: 'List[TransferInDomainRequestTransferRequest]', project_id: 'Optional[str]' = None, owner_contact_id: 'Optional[str]' = None, owner_contact: 'Optional[NewContact]' = None, administrative_contact_id: 'Optional[str]' = None, administrative_contact: 'Optional[NewContact]' = None, technical_contact_id: 'Optional[str]' = None, technical_contact: 'Optional[NewContact]' = None)

Bases: object

administrative_contact: NewContact | None = None

administrative_contact_id: str | None = None

domains: List[TransferInDomainRequestTransferRequest]

owner_contact: NewContact | None = None

owner_contact_id: str | None = None

project_id: str | None = None

technical_contact: NewContact | None = None

technical_contact_id: str | None = None

class scaleway.domain.v2beta1.RegistrarApiUnlockDomainTransferRequest(domain: 'str')

Bases: object

domain: str

class scaleway.domain.v2beta1.RegistrarApiUpdateContactRequest(contact_id: 'str', email: 'Optional[str]' = None, email_alt: 'Optional[str]' = None, phone_number: 'Optional[str]' = None, fax_number: 'Optional[str]' = None, address_line_1: 'Optional[str]' = None, address_line_2: 'Optional[str]' = None, zip: 'Optional[str]' = None, city: 'Optional[str]' = None, country: 'Optional[str]' = None, vat_identification_code: 'Optional[str]' = None, company_identification_code: 'Optional[str]' = None, lang: 'Optional[StdLanguageCode]' = None, resale: 'Optional[bool]' = None, questions: 'Optional[List[UpdateContactRequestQuestion]]' = <factory>, extension_fr: 'Optional[ContactExtensionFR]' = None, extension_eu: 'Optional[ContactExtensionEU]' = None, whois_opt_in: 'Optional[bool]' = None, state: 'Optional[str]' = None, extension_nl: 'Optional[ContactExtensionNL]' = None)

Bases: object

address_line_1: str | None = None

address_line_2: str | None = None

city: str | None = None

company_identification_code: str | None = None

contact_id: str

country: str | None = None

email: str | None = None

email_alt: str | None = None

extension_eu: ContactExtensionEU | None = None

extension_fr: ContactExtensionFR | None = None

extension_nl: ContactExtensionNL | None = None

fax_number: str | None = None

lang: LanguageCode | None = None

phone_number: str | None = None

questions: List[UpdateContactRequestQuestion] | None

resale: bool | None = None

state: str | None = None

vat_identification_code: str | None = None

whois_opt_in: bool | None = None

zip: str | None = None

class scaleway.domain.v2beta1.RegistrarApiUpdateDomainHostRequest(domain: 'str', name: 'str', ips: 'Optional[List[str]]' = <factory>)

Bases: object

domain: str

ips: List[str] | None

name: str

class scaleway.domain.v2beta1.RegistrarApiUpdateDomainRequest(domain: 'str', technical_contact_id: 'Optional[str]' = None, technical_contact: 'Optional[NewContact]' = None, owner_contact_id: 'Optional[str]' = None, owner_contact: 'Optional[NewContact]' = None, administrative_contact_id: 'Optional[str]' = None, administrative_contact: 'Optional[NewContact]' = None)

Bases: object

administrative_contact: NewContact | None = None

administrative_contact_id: str | None = None

domain: str

owner_contact: NewContact | None = None

owner_contact_id: str | None = None

technical_contact: NewContact | None = None

technical_contact_id: str | None = None

class scaleway.domain.v2beta1.RenewableDomain(domain: 'str', project_id: 'str', organization_id: 'str', status: 'RenewableDomainStatus', renewable_duration_in_years: 'Optional[int]' = None, expired_at: 'Optional[datetime]' = None, limit_renew_at: 'Optional[datetime]' = None, limit_redemption_at: 'Optional[datetime]' = None, estimated_delete_at: 'Optional[datetime]' = None, tld: 'Optional[Tld]' = None)

Bases: object

domain: str

estimated_delete_at: datetime | None = None

expired_at: datetime | None = None

limit_redemption_at: datetime | None = None

limit_renew_at: datetime | None = None

organization_id: str

project_id: str

renewable_duration_in_years: int | None = None

status: RenewableDomainStatus

tld: Tld | None = None

class scaleway.domain.v2beta1.RenewableDomainStatus(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

LATE_RENEWEABLE = 'late_reneweable'

NOT_RENEWABLE = 'not_renewable'

RENEWABLE = 'renewable'

UNKNOWN = 'unknown'

class scaleway.domain.v2beta1.RestoreDNSZoneVersionRequest(dns_zone_version_id: 'str')

Bases: object

dns_zone_version_id: str

class scaleway.domain.v2beta1.RestoreDNSZoneVersionResponse: Bases: object

class scaleway.domain.v2beta1.SSLCertificate(dns_zone: 'str', alternative_dns_zones: 'List[str]', status: 'SSLCertificateStatus', private_key: 'str', certificate_chain: 'str', created_at: 'Optional[datetime]' = None, expired_at: 'Optional[datetime]' = None)

Bases: object

alternative_dns_zones: List[str]

certificate_chain: str

created_at: datetime | None = None

dns_zone: str

expired_at: datetime | None = None

private_key: str

status: SSLCertificateStatus

class scaleway.domain.v2beta1.SSLCertificateStatus(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

ERROR = 'error'

NEW = 'new'

PENDING = 'pending'

SUCCESS = 'success'

UNKNOWN = 'unknown'

class scaleway.domain.v2beta1.SearchAvailableDomainsResponse(available_domains: 'List[AvailableDomain]')

Bases: object

available_domains: List[AvailableDomain]: Array of available domains.

class scaleway.domain.v2beta1.Task(id: 'str', project_id: 'str', organization_id: 'str', type_: 'TaskType', status: 'TaskStatus', domain: 'Optional[str]' = None, started_at: 'Optional[datetime]' = None, updated_at: 'Optional[datetime]' = None, message: 'Optional[str]' = None, contact_identifier: 'Optional[str]' = None)

Bases: object

contact_identifier: str | None = None: Human-friendly contact identifier used when the task concerns a contact.

domain: str | None = None: The domain name associated to the task.

id: str: The unique identifier of the task.

message: str | None = None: Error message associated to the task.

organization_id: str: The organization ID associated to the task.

project_id: str: The project ID associated to the task.

started_at: datetime | None = None: Start date of the task.

status: TaskStatus: The status of the task.

type_: TaskType: The type of the task.

updated_at: datetime | None = None: Last update of the task.

class scaleway.domain.v2beta1.TaskStatus(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

ERROR = 'error'

NEW = 'new'

PENDING = 'pending'

SUCCESS = 'success'

UNAVAILABLE = 'unavailable'

WAITING_PAYMENT = 'waiting_payment'

class scaleway.domain.v2beta1.TaskType(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

CANCEL_TASK = 'cancel_task'

CREATE_DOMAIN = 'create_domain'

CREATE_EXTERNAL_DOMAIN = 'create_external_domain'

CREATE_HOST = 'create_host'

DELETE_DOMAIN = 'delete_domain'

DELETE_DOMAIN_EXPIRED = 'delete_domain_expired'

DELETE_EXTERNAL_DOMAIN = 'delete_external_domain'

DELETE_HOST = 'delete_host'

DISABLE_DNSSEC = 'disable_dnssec'

ENABLE_DNSSEC = 'enable_dnssec'

GENERATE_SSL_CERTIFICATE = 'generate_ssl_certificate'

LOCK_DOMAIN_TRANSFER = 'lock_domain_transfer'

MOVE_PROJECT = 'move_project'

RENEW_DOMAIN = 'renew_domain'

RENEW_SSL_CERTIFICATE = 'renew_ssl_certificate'

SEND_MESSAGE = 'send_message'

TRADE_DOMAIN = 'trade_domain'

TRANSFER_DOMAIN = 'transfer_domain'

TRANSFER_ONLINE_DOMAIN = 'transfer_online_domain'

UNKNOWN = 'unknown'

UNLOCK_DOMAIN_TRANSFER = 'unlock_domain_transfer'

UPDATE_CONTACT = 'update_contact'

UPDATE_DOMAIN = 'update_domain'

UPDATE_HOST = 'update_host'

class scaleway.domain.v2beta1.Tld(name: 'str', dnssec_support: 'bool', duration_in_years_min: 'int', duration_in_years_max: 'int', idn_support: 'bool', offers: 'Dict[str, TldOffer]', specifications: 'Dict[str, str]')

Bases: object

dnssec_support: bool

duration_in_years_max: int

duration_in_years_min: int

idn_support: bool

name: str

offers: Dict[str, TldOffer]

specifications: Dict[str, str]

class scaleway.domain.v2beta1.TldOffer(action: 'str', operation_path: 'str', price: 'Optional[Money]' = None)

Bases: object

action: str

operation_path: str

price: Money | None = None

class scaleway.domain.v2beta1.TransferInDomainRequestTransferRequest(domain: 'str', auth_code: 'str')

Bases: object

auth_code: str

domain: str

class scaleway.domain.v2beta1.UpdateContactRequestQuestion(question: 'Optional[str]' = None, answer: 'Optional[str]' = None)

Bases: object

answer: str | None = None

question: str | None = None

class scaleway.domain.v2beta1.UpdateDNSZoneNameserversRequest(dns_zone: 'str', ns: 'List[Nameserver]')

Bases: object

dns_zone: str: DNS zone in which to update the DNS zone name servers.

ns: List[Nameserver]: New DNS zone name servers.

class scaleway.domain.v2beta1.UpdateDNSZoneNameserversResponse(ns: 'List[Nameserver]')

Bases: object

ns: List[Nameserver]: DNS zone name servers returned.

class scaleway.domain.v2beta1.UpdateDNSZoneRecordsRequest(dns_zone: 'str', changes: 'List[RecordChange]', disallow_new_zone_creation: 'bool', return_all_records: 'Optional[bool]' = False, serial: 'Optional[int]' = 0)

Bases: object

changes: List[RecordChange]: Changes made to the records.

disallow_new_zone_creation: bool: Disable the creation of the target zone if it does not exist. Target zone creation is disabled by default.

dns_zone: str: DNS zone in which to update the DNS zone records.

return_all_records: bool | None = False: Specifies whether or not to return all the records.

serial: int | None = 0: Use the provided serial (0) instead of the auto-increment serial.

class scaleway.domain.v2beta1.UpdateDNSZoneRecordsResponse(records: 'List[Record]')

Bases: object

records: List[Record]: DNS zone records returned.

class scaleway.domain.v2beta1.UpdateDNSZoneRequest(dns_zone: 'str', new_dns_zone: 'Optional[str]' = None, project_id: 'Optional[str]' = None)

Bases: object

dns_zone: str: DNS zone to update.

new_dns_zone: str | None = None: Name of the new DNS zone to create.

project_id: str | None = None: Project ID in which to create the new DNS zone.