scaleway_async.domain.v2beta1 package

Submodules

scaleway_async.domain.v2beta1.api module

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

Bases: API

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

async 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 = await api.clear_dns_zone_records(
    dns_zone="example",
)

async clone_dns_zone(*, dns_zone: str, dest_dns_zone: str, overwrite: bool, project_id: Optional[str] = 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 = await api.clone_dns_zone(
    dns_zone="example",
    dest_dns_zone="example",
    overwrite=False,
)

async create_dns_zone(*, domain: str, subdomain: str, project_id: Optional[str] = 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 = await api.create_dns_zone(
    domain="example",
    subdomain="example",
)

async create_ssl_certificate(*, dns_zone: str, alternative_dns_zones: Optional[List[str]] = 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 = await api.create_ssl_certificate(
    dns_zone="example",
)

async delete_dns_zone(*, dns_zone: str, project_id: Optional[str] = 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 = await api.delete_dns_zone(
    dns_zone="example",
)

async 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 = await api.delete_dns_zone_tsig_key(
    dns_zone="example",
)

async 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 = await api.delete_ssl_certificate(
    dns_zone="example",
)

async export_raw_dns_zone(*, dns_zone: str, format: Optional[RawFormat] = 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 = await api.export_raw_dns_zone(
    dns_zone="example",
)

async 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 = await api.get_dns_zone_tsig_key(
    dns_zone="example",
)

async 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 = await api.get_dns_zone_version_diff(
    dns_zone_version_id="example",
)

async 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 = await api.get_ssl_certificate(
    dns_zone="example",
)

async import_provider_dns_zone(*, dns_zone: str, online_v1: Optional[ImportProviderDNSZoneRequestOnlineV1] = 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 = await api.import_provider_dns_zone(
    dns_zone="example",
)

async import_raw_dns_zone(*, dns_zone: str, content: Optional[str] = None, project_id: Optional[str] = None, format: Optional[RawFormat] = None, bind_source: Optional[ImportRawDNSZoneRequestBindSource] = None, axfr_source: Optional[ImportRawDNSZoneRequestAXFRSource] = 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 = await api.import_raw_dns_zone(
    dns_zone="example",
)

async list_dns_zone_nameservers(*, project_id: Optional[str] = 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 = await api.list_dns_zone_nameservers(
    dns_zone="example",
)

async list_dns_zone_records(*, project_id: Optional[str] = None, order_by: Optional[ListDNSZoneRecordsRequestOrderBy] = None, page: Optional[int] = None, page_size: Optional[int] = None, dns_zone: str, name: str, type_: Optional[RecordType] = None, id: Optional[str] = None) → ListDNSZoneRecordsResponse

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 = await api.list_dns_zone_records(
    dns_zone="example",
    name="example",
)

async list_dns_zone_records_all(*, project_id: Optional[str] = None, order_by: Optional[ListDNSZoneRecordsRequestOrderBy] = None, page: Optional[int] = None, page_size: Optional[int] = None, dns_zone: str, name: str, type_: Optional[RecordType] = None, id: Optional[str] = None) → List[Record]

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 = await api.list_dns_zone_records_all(
    dns_zone="example",
    name="example",
)

async list_dns_zone_version_records(*, page: Optional[int] = None, page_size: Optional[int] = 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 = await api.list_dns_zone_version_records(
    dns_zone_version_id="example",
)

async list_dns_zone_version_records_all(*, page: Optional[int] = None, page_size: Optional[int] = 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 = await api.list_dns_zone_version_records_all(
    dns_zone_version_id="example",
)

async list_dns_zone_versions(*, page: Optional[int] = None, page_size: Optional[int] = 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 = await api.list_dns_zone_versions(
    dns_zone="example",
)

async list_dns_zone_versions_all(*, page: Optional[int] = None, page_size: Optional[int] = 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 = await api.list_dns_zone_versions_all(
    dns_zone="example",
)

async list_dns_zones(*, domain: str, organization_id: Optional[str] = None, project_id: Optional[str] = None, order_by: Optional[ListDNSZonesRequestOrderBy] = None, page: Optional[int] = None, page_size: Optional[int] = None, dns_zone: Optional[str] = None, dns_zones: Optional[List[str]] = None, created_after: Optional[datetime] = None, created_before: Optional[datetime] = None, updated_after: Optional[datetime] = None, updated_before: Optional[datetime] = None) → ListDNSZonesResponse

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 = await api.list_dns_zones(
    domain="example",
)

async list_dns_zones_all(*, domain: str, organization_id: Optional[str] = None, project_id: Optional[str] = None, order_by: Optional[ListDNSZonesRequestOrderBy] = None, page: Optional[int] = None, page_size: Optional[int] = None, dns_zone: Optional[str] = None, dns_zones: Optional[List[str]] = None, created_after: Optional[datetime] = None, created_before: Optional[datetime] = None, updated_after: Optional[datetime] = None, updated_before: Optional[datetime] = None) → List[DNSZone]

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 = await api.list_dns_zones_all(
    domain="example",
)

async list_ssl_certificates(*, dns_zone: str, page: Optional[int] = None, page_size: Optional[int] = None, project_id: Optional[str] = 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 = await api.list_ssl_certificates(
    dns_zone="example",
)

async list_ssl_certificates_all(*, dns_zone: str, page: Optional[int] = None, page_size: Optional[int] = None, project_id: Optional[str] = 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 = await api.list_ssl_certificates_all(
    dns_zone="example",
)

async 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 = await api.refresh_dns_zone(
    dns_zone="example",
    recreate_dns_zone=False,
    recreate_sub_dns_zone=False,
)

async 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 = await api.restore_dns_zone_version(
    dns_zone_version_id="example",
)

async update_dns_zone(*, dns_zone: str, new_dns_zone: Optional[str] = None, project_id: Optional[str] = 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 = await api.update_dns_zone(
    dns_zone="example",
)

async 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 = await api.update_dns_zone_nameservers(
    dns_zone="example",
    ns=[],
)

async update_dns_zone_records(*, dns_zone: str, changes: List[RecordChange], disallow_new_zone_creation: bool, return_all_records: Optional[bool] = None, serial: Optional[int] = 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 = await api.update_dns_zone_records(
    dns_zone="example",
    changes=[],
    disallow_new_zone_creation=False,
)

async wait_for_ssl_certificate(*, dns_zone: str, options: Optional[WaitForOptions[SSLCertificate, Union[bool, Awaitable[bool]]]] = 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 = await api.get_ssl_certificate(
    dns_zone="example",
)

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

Bases: API

Manage your domains and contacts.

async buy_domains(*, 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) → 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 = await api.buy_domains(
    domains=[],
    duration_in_years=1,
)

async check_contacts_compatibility(*, domains: Optional[List[str]] = None, tlds: Optional[List[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) → 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 = await api.check_contacts_compatibility()

async create_domain_host(*, domain: str, name: str, ips: Optional[List[str]] = 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 = await api.create_domain_host(
    domain="example",
    name="example",
)

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

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

Usage:

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

async delete_external_domain(*, domain: str) → DeleteExternalDomainResponse

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

Usage:

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

async 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 = await api.disable_domain_auto_renew(
    domain="example",
)

async disable_domain_dnssec(*, domain: str) → Domain

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

Usage:

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

async 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 = await api.enable_domain_auto_renew(
    domain="example",
)

async enable_domain_dnssec(*, domain: str, ds_record: Optional[DSRecord] = 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 = await api.enable_domain_dnssec(
    domain="example",
)

async 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 = await api.get_contact(
    contact_id="example",
)

async get_domain(*, domain: str) → Domain

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

Usage:

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

async 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 = await api.get_domain_auth_code(
    domain="example",
)

async list_contacts(*, 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) → ListContactsResponse

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 = await api.list_contacts()

async list_contacts_all(*, 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) → List[ContactRoles]

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 = await api.list_contacts_all()

async list_domain_hosts(*, page: Optional[int] = None, page_size: Optional[int] = 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 = await api.list_domain_hosts(
    domain="example",
)

async list_domain_hosts_all(*, page: Optional[int] = None, page_size: Optional[int] = 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 = await api.list_domain_hosts_all(
    domain="example",
)

async list_domains(*, 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) → ListDomainsResponse

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 = await api.list_domains()

async list_domains_all(*, 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) → List[DomainSummary]

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 = await api.list_domains_all()

async list_renewable_domains(*, page: Optional[int] = None, page_size: Optional[int] = None, order_by: Optional[ListRenewableDomainsRequestOrderBy] = None, project_id: Optional[str] = None, organization_id: Optional[str] = None) → ListRenewableDomainsResponse

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 = await api.list_renewable_domains()

async list_renewable_domains_all(*, page: Optional[int] = None, page_size: Optional[int] = None, order_by: Optional[ListRenewableDomainsRequestOrderBy] = None, project_id: Optional[str] = None, organization_id: Optional[str] = None) → List[RenewableDomain]

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 = await api.list_renewable_domains_all()

async list_tasks(*, 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]] = None, statuses: Optional[List[TaskStatus]] = None, order_by: Optional[ListTasksRequestOrderBy] = None) → ListTasksResponse

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 = await api.list_tasks()

async list_tasks_all(*, 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]] = None, statuses: Optional[List[TaskStatus]] = None, order_by: Optional[ListTasksRequestOrderBy] = None) → List[Task]

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 = await api.list_tasks_all()

async list_tlds(*, tlds: Optional[List[str]] = None, page: Optional[int] = None, page_size: Optional[int] = None, order_by: Optional[ListTldsRequestOrderBy] = 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 = await api.list_tlds()

async list_tlds_all(*, tlds: Optional[List[str]] = None, page: Optional[int] = None, page_size: Optional[int] = None, order_by: Optional[ListTldsRequestOrderBy] = 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 = await api.list_tlds_all()

async 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 = await api.lock_domain_transfer(
    domain="example",
)

async register_external_domain(*, domain: str, project_id: Optional[str] = None) → RegisterExternalDomainResponse

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

Usage:

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

async renew_domains(*, domains: List[str], duration_in_years: int, force_late_renewal: Optional[bool] = 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 = await api.renew_domains(
    domains=[],
    duration_in_years=1,
)

async search_available_domains(*, domains: List[str], strict_search: bool, tlds: Optional[List[str]] = 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 = await api.search_available_domains(
    domains=[],
    strict_search=False,
)

async trade_domain(*, domain: str, project_id: Optional[str] = None, new_owner_contact_id: Optional[str] = None, new_owner_contact: Optional[NewContact] = 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 = await api.trade_domain(
    domain="example",
)

async transfer_in_domain(*, 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) → 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 = await api.transfer_in_domain(
    domains=[],
)

async 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 = await api.unlock_domain_transfer(
    domain="example",
)

async update_contact(*, 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[LanguageCode] = None, resale: Optional[bool] = None, questions: Optional[List[UpdateContactRequestQuestion]] = None, 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) → Contact

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 = await api.update_contact(
    contact_id="example",
)

async update_domain(*, 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) → 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 = await api.update_domain(
    domain="example",
)

async update_domain_host(*, domain: str, name: str, ips: Optional[List[str]] = 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 = await api.update_domain_host(
    domain="example",
    name="example",
)

async wait_for_domain(*, domain: str, options: Optional[WaitForOptions[Domain, Union[bool, Awaitable[bool]]]] = None) → Domain

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

Usage:

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

scaleway_async.domain.v2beta1.content module

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

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

scaleway_async.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_async.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_async.domain.v2beta1.content.HOST_TRANSIENT_STATUSES: List[HostStatus] = [<HostStatus.UPDATING: 'updating'>, <HostStatus.DELETING: 'deleting'>]: Lists transient statutes of the enum HostStatus.

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

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

scaleway_async.domain.v2beta1.marshalling module

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

scaleway_async.domain.v2beta1.types module

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

Bases: object

available: bool

domain: str

tld: Optional[Tld]

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

Bases: object

administrative_check_result: Optional[CheckContactsCompatibilityResponseContactCheckResult]

compatible: bool

owner_check_result: Optional[CheckContactsCompatibilityResponseContactCheckResult]

technical_check_result: Optional[CheckContactsCompatibilityResponseContactCheckResult]

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

Bases: object

compatible: bool

error_message: Optional[str]

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

Bases: object

dns_zone: str: DNS zone to clear.

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

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

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: Optional[str]: Project ID of the destination DNS zone.

class scaleway_async.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', questions: 'Optional[List[ContactQuestion]]', extension_fr: 'Optional[ContactExtensionFR]', extension_eu: 'Optional[ContactExtensionEU]', email_status: 'ContactEmailStatus', state: 'str', status: 'ContactStatus', extension_nl: 'Optional[ContactExtensionNL]')

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: Optional[ContactExtensionEU]

extension_fr: Optional[ContactExtensionFR]

extension_nl: Optional[ContactExtensionNL]

fax_number: str

firstname: str

id: str

lang: LanguageCode

lastname: str

legal_form: ContactLegalForm

phone_number: str

questions: Optional[List[ContactQuestion]]

resale: bool

state: str

status: ContactStatus

vat_identification_code: str

whois_opt_in: bool

zip: str

class scaleway_async.domain.v2beta1.types.ContactEmailStatus(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

EMAIL_STATUS_UNKNOWN = 'email_status_unknown'

INVALID_EMAIL = 'invalid_email'

NOT_VALIDATED = 'not_validated'

VALIDATED = 'validated'

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

Bases: object

european_citizenship: str

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

Bases: object

association_info: Optional[ContactExtensionFRAssociationInfo]

code_auth_afnic_info: Optional[ContactExtensionFRCodeAuthAfnicInfo]

duns_info: Optional[ContactExtensionFRDunsInfo]

individual_info: Optional[ContactExtensionFRIndividualInfo]

mode: ContactExtensionFRMode

trademark_info: Optional[ContactExtensionFRTrademarkInfo]

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

Bases: object

publication_jo: Optional[datetime]

publication_jo_page: int

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

Bases: object

code_auth_afnic: str

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

Bases: object

duns_id: str

local_id: str

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

Bases: object

whois_opt_in: bool

class scaleway_async.domain.v2beta1.types.ContactExtensionFRMode(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

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_async.domain.v2beta1.types.ContactExtensionFRTrademarkInfo(trademark_inpi: 'str')

Bases: object

trademark_inpi: str

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

Bases: object

legal_form: ContactExtensionNLLegalForm

legal_form_registration_number: str

class scaleway_async.domain.v2beta1.types.ContactExtensionNLLegalForm(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

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_async.domain.v2beta1.types.ContactLegalForm(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

ASSOCIATION = 'association'

CORPORATE = 'corporate'

INDIVIDUAL = 'individual'

LEGAL_FORM_UNKNOWN = 'legal_form_unknown'

OTHER = 'other'

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

Bases: object

answer: str

question: str

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

Bases: object

contact: Optional[Contact]

roles: Dict[str, ContactRolesRoles]

class scaleway_async.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_async.domain.v2beta1.types.ContactStatus(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

ACTIVE = 'active'

PENDING = 'pending'

STATUS_UNKNOWN = 'status_unknown'

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

Bases: object

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

project_id: Optional[str]: Project ID in which to create the DNS zone.

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

class scaleway_async.domain.v2beta1.types.CreateSSLCertificateRequest(dns_zone: 'str', alternative_dns_zones: 'Optional[List[str]]')

Bases: object

alternative_dns_zones: Optional[List[str]]

dns_zone: str

class scaleway_async.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]', updated_at: 'Optional[datetime]')

Bases: object

domain: str

linked_products: List[LinkedProduct]

message: Optional[str]

ns: List[str]

ns_default: List[str]

ns_master: List[str]

project_id: str

status: DNSZoneStatus

subdomain: str

updated_at: Optional[datetime]

class scaleway_async.domain.v2beta1.types.DNSZoneStatus(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

ACTIVE = 'active'

ERROR = 'error'

LOCKED = 'locked'

PENDING = 'pending'

UNKNOWN = 'unknown'

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

Bases: object

created_at: Optional[datetime]

id: str

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

Bases: object

algorithm: DSRecordAlgorithm

digest: Optional[DSRecordDigest]

key_id: int

public_key: Optional[DSRecordPublicKey]

class scaleway_async.domain.v2beta1.types.DSRecordAlgorithm(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

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_async.domain.v2beta1.types.DSRecordDigest(type_: 'DSRecordDigestType', digest: 'str', public_key: 'Optional[DSRecordPublicKey]')

Bases: object

digest: str

public_key: Optional[DSRecordPublicKey]

type_: DSRecordDigestType

class scaleway_async.domain.v2beta1.types.DSRecordDigestType(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

GOST_R_34_11_94 = 'gost_r_34_11_94'

SHA_1 = 'sha_1'

SHA_256 = 'sha_256'

SHA_384 = 'sha_384'

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

Bases: object

key: str

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

Bases: object

dns_zone: str: DNS zone to delete.

project_id: Optional[str]: Project ID of the DNS zone to delete.

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

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

Bases: object

dns_zone: str

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

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

Bases: object

dns_zone: str

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

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

Bases: object

administrative_contact: Optional[Contact]: 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: Optional[DomainDNSSEC]: Status of the DNSSEC configuration of the domain.

domain: str

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

expired_at: Optional[datetime]: Date of expiration of the domain.

external_domain_registration_status: Optional[DomainRegistrationStatusExternalDomain]

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: Optional[Contact]: 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: Optional[Contact]: Contact information of the domain’s technical contact.

tld: Optional[Tld]: Domain’s TLD information.

transfer_registration_status: Optional[DomainRegistrationStatusTransfer]

updated_at: Optional[datetime]: Domain’s last modification date.

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

Bases: object

ds_records: List[DSRecord]

status: DomainFeatureStatus

class scaleway_async.domain.v2beta1.types.DomainFeatureStatus(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

DISABLED = 'disabled'

DISABLING = 'disabling'

ENABLED = 'enabled'

ENABLING = 'enabling'

FEATURE_STATUS_UNKNOWN = 'feature_status_unknown'

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

Bases: object

validation_token: str

class scaleway_async.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_async.domain.v2beta1.types.DomainRegistrationStatusTransferStatus(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

DONE = 'done'

PENDING = 'pending'

PROCESSING = 'processing'

REJECTED = 'rejected'

STATUS_UNKNOWN = 'status_unknown'

WAITING_VOTE = 'waiting_vote'

class scaleway_async.domain.v2beta1.types.DomainStatus(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

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_async.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', expired_at: 'Optional[datetime]', updated_at: 'Optional[datetime]', status: 'DomainStatus', organization_id: 'str', pending_trade: 'bool', created_at: 'Optional[datetime]', external_domain_registration_status: 'Optional[DomainRegistrationStatusExternalDomain]', transfer_registration_status: 'Optional[DomainRegistrationStatusTransfer]')

Bases: object

auto_renew_status: DomainFeatureStatus

created_at: Optional[datetime]

dnssec_status: DomainFeatureStatus

domain: str

epp_code: List[str]

expired_at: Optional[datetime]

external_domain_registration_status: Optional[DomainRegistrationStatusExternalDomain]

is_external: bool

organization_id: str

pending_trade: bool

project_id: str

registrar: str

status: DomainStatus

transfer_registration_status: Optional[DomainRegistrationStatusTransfer]

updated_at: Optional[datetime]

class scaleway_async.domain.v2beta1.types.ExportRawDNSZoneRequest(dns_zone: 'str', format: 'Optional[RawFormat]')

Bases: object

dns_zone: str: DNS zone to export.

format: Optional[RawFormat]: DNS zone format.

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

Bases: object

dns_zone: str

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

Bases: object

algorithm: str

key: str

name: str

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

Bases: object

dns_zone_version_id: str

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

Bases: object

changes: List[RecordChange]

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

Bases: object

auth_code: str

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

Bases: object

dns_zone: str

class scaleway_async.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_async.domain.v2beta1.types.HostStatus(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

ACTIVE = 'active'

DELETING = 'deleting'

UNKNOWN_STATUS = 'unknown_status'

UPDATING = 'updating'

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

Bases: object

dns_zone: str

online_v1: Optional[ImportProviderDNSZoneRequestOnlineV1]

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

Bases: object

token: str

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

Bases: object

records: List[Record]

class scaleway_async.domain.v2beta1.types.ImportRawDNSZoneRequest(dns_zone: 'str', content: 'Optional[str]', project_id: 'Optional[str]', format: 'Optional[RawFormat]', bind_source: 'Optional[ImportRawDNSZoneRequestBindSource]', axfr_source: 'Optional[ImportRawDNSZoneRequestAXFRSource]')

Bases: object

axfr_source: Optional[ImportRawDNSZoneRequestAXFRSource]

bind_source: Optional[ImportRawDNSZoneRequestBindSource]

content: Optional[str]

dns_zone: str: DNS zone to import.

format: Optional[RawFormat]

project_id: Optional[str]

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

Bases: object

name_server: str

tsig_key: Optional[ImportRawDNSZoneRequestTsigKey]

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

Bases: object

content: str

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

Bases: object

algorithm: str

key: str

name: str

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

Bases: object

records: List[Record]

class scaleway_async.domain.v2beta1.types.LinkedProduct(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

UNKNOWN_PRODUCT = 'unknown_product'

VPC = 'vpc'

class scaleway_async.domain.v2beta1.types.ListContactsRequestRole(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

ADMINISTRATIVE = 'administrative'

OWNER = 'owner'

TECHNICAL = 'technical'

UNKNOWN_ROLE = 'unknown_role'

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

Bases: object

contacts: List[ContactRoles]

total_count: int

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

Bases: object

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

project_id: Optional[str]: Project ID on which to filter the returned DNS zone name servers.

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

Bases: object

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

class scaleway_async.domain.v2beta1.types.ListDNSZoneRecordsRequest(project_id: 'Optional[str]', order_by: 'Optional[ListDNSZoneRecordsRequestOrderBy]', page: 'Optional[int]', page_size: 'Optional[int]', dns_zone: 'str', name: 'str', type_: 'Optional[RecordType]', id: 'Optional[str]')

Bases: object

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

id: Optional[str]: 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: Optional[ListDNSZoneRecordsRequestOrderBy]: Sort order of the returned DNS zone records.

page: Optional[int]: Page number to return, from the paginated results.

page_size: Optional[int]: Maximum number of DNS zone records per page.

project_id: Optional[str]: Project ID on which to filter the returned DNS zone records.

type_: Optional[RecordType]: Record type on which to filter the returned DNS zone records.

class scaleway_async.domain.v2beta1.types.ListDNSZoneRecordsRequestOrderBy(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

NAME_ASC = 'name_asc'

NAME_DESC = 'name_desc'

class scaleway_async.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_async.domain.v2beta1.types.ListDNSZoneVersionRecordsRequest(page: 'Optional[int]', page_size: 'Optional[int]', dns_zone_version_id: 'str')

Bases: object

dns_zone_version_id: str

page: Optional[int]: Page number to return, from the paginated results.

page_size: Optional[int]: Maximum number of DNS zones versions records per page.

class scaleway_async.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_async.domain.v2beta1.types.ListDNSZoneVersionsRequest(page: 'Optional[int]', page_size: 'Optional[int]', dns_zone: 'str')

Bases: object

dns_zone: str

page: Optional[int]: Page number to return, from the paginated results.

page_size: Optional[int]: Maximum number of DNS zones versions per page.

class scaleway_async.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_async.domain.v2beta1.types.ListDNSZonesRequest(domain: 'str', organization_id: 'Optional[str]', project_id: 'Optional[str]', order_by: 'Optional[ListDNSZonesRequestOrderBy]', page: 'Optional[int]', page_size: 'Optional[int]', dns_zone: 'Optional[str]', dns_zones: 'Optional[List[str]]', created_after: 'Optional[datetime]', created_before: 'Optional[datetime]', updated_after: 'Optional[datetime]', updated_before: 'Optional[datetime]')

Bases: object

created_after: Optional[datetime]: Only list DNS zones created after this date.

created_before: Optional[datetime]: Only list DNS zones created before this date.

dns_zone: Optional[str]: DNS zone on which to filter the returned DNS zones.

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

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

order_by: Optional[ListDNSZonesRequestOrderBy]: Sort order of the returned DNS zones.

organization_id: Optional[str]: Organization ID on which to filter the returned DNS zones.

page: Optional[int]: Page number to return, from the paginated results.

page_size: Optional[int]: Maximum number of DNS zones to return per page.

project_id: Optional[str]: Project ID on which to filter the returned DNS zones.

updated_after: Optional[datetime]: Only list DNS zones updated after this date.

updated_before: Optional[datetime]: Only list DNS zones updated before this date.

class scaleway_async.domain.v2beta1.types.ListDNSZonesRequestOrderBy(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

CREATED_AT_ASC = 'created_at_asc'

CREATED_AT_DESC = 'created_at_desc'

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_async.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_async.domain.v2beta1.types.ListDomainHostsResponse(total_count: 'int', hosts: 'List[Host]')

Bases: object

hosts: List[Host]

total_count: int

class scaleway_async.domain.v2beta1.types.ListDomainsRequestOrderBy(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

DOMAIN_ASC = 'domain_asc'

DOMAIN_DESC = 'domain_desc'

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

Bases: object

domains: List[DomainSummary]

total_count: int

class scaleway_async.domain.v2beta1.types.ListRenewableDomainsRequestOrderBy(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

DOMAIN_ASC = 'domain_asc'

DOMAIN_DESC = 'domain_desc'

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

Bases: object

domains: List[RenewableDomain]

total_count: int

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

Bases: object

dns_zone: str

page: Optional[int]

page_size: Optional[int]

project_id: Optional[str]

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

Bases: object

certificates: List[SSLCertificate]

total_count: int

class scaleway_async.domain.v2beta1.types.ListTasksRequestOrderBy(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

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_async.domain.v2beta1.types.ListTasksResponse(total_count: 'int', tasks: 'List[Task]')

Bases: object

tasks: List[Task]

total_count: int

class scaleway_async.domain.v2beta1.types.ListTldsRequestOrderBy(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

NAME_ASC = 'name_asc'

NAME_DESC = 'name_desc'

class scaleway_async.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_async.domain.v2beta1.types.Nameserver(name: 'str', ip: 'List[str]')

Bases: object

ip: List[str]

name: str

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

Bases: object

address_line_1: str

address_line_2: Optional[str]

city: str

company_identification_code: Optional[str]

company_name: Optional[str]

country: str

email: str

email_alt: Optional[str]

extension_eu: Optional[ContactExtensionEU]

extension_fr: Optional[ContactExtensionFR]

extension_nl: Optional[ContactExtensionNL]

fax_number: Optional[str]

firstname: str

lang: LanguageCode

lastname: str

legal_form: ContactLegalForm

phone_number: str

questions: Optional[List[ContactQuestion]]

resale: bool

state: Optional[str]

vat_identification_code: Optional[str]

whois_opt_in: bool

zip: str

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

Bases: object

created_at: Optional[datetime]

domains: List[str]

organization_id: str

project_id: str

task_id: str

class scaleway_async.domain.v2beta1.types.RawFormat(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

BIND = 'bind'

UNKNOWN_RAW_FORMAT = 'unknown_raw_format'

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

Bases: object

comment: Optional[str]

data: str

geo_ip_config: Optional[RecordGeoIPConfig]

http_service_config: Optional[RecordHTTPServiceConfig]

id: str

name: str

priority: int

ttl: int

type_: RecordType

view_config: Optional[RecordViewConfig]

weighted_config: Optional[RecordWeightedConfig]

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

Bases: object

add: Optional[RecordChangeAdd]

clear: Optional[RecordChangeClear]

delete: Optional[RecordChangeDelete]

set_: Optional[RecordChangeSet]

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

Bases: object

records: List[Record]

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

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

Bases: object

id: Optional[str]

id_fields: Optional[RecordIdentifier]

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

Bases: object

id: Optional[str]

id_fields: Optional[RecordIdentifier]

records: List[Record]

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

Bases: object

default: str

matches: List[RecordGeoIPConfigMatch]

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

Bases: object

continents: List[str]

countries: List[str]

data: str

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

Bases: object

ips: List[str]

must_contain: Optional[str]

strategy: RecordHTTPServiceConfigStrategy

url: str

user_agent: Optional[str]

class scaleway_async.domain.v2beta1.types.RecordHTTPServiceConfigStrategy(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

ALL = 'all'

HASHED = 'hashed'

RANDOM = 'random'

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

Bases: object

data: Optional[str]

name: str

ttl: Optional[int]

type_: RecordType

class scaleway_async.domain.v2beta1.types.RecordType(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

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_async.domain.v2beta1.types.RecordViewConfig(views: 'List[RecordViewConfigView]')

Bases: object

views: List[RecordViewConfigView]

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

Bases: object

data: str

subnet: str

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

Bases: object

weighted_ips: List[RecordWeightedConfigWeightedIP]

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

Bases: object

ip: str

weight: int

class scaleway_async.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_async.domain.v2beta1.types.RefreshDNSZoneResponse(dns_zones: 'List[DNSZone]')

Bases: object

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

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

Bases: object

created_at: Optional[datetime]

domain: str

organization_id: str

project_id: str

validation_token: str

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

Bases: object

administrative_contact: Optional[NewContact]

administrative_contact_id: Optional[str]

domains: List[str]

duration_in_years: int

owner_contact: Optional[NewContact]

owner_contact_id: Optional[str]

project_id: Optional[str]

technical_contact: Optional[NewContact]

technical_contact_id: Optional[str]

class scaleway_async.domain.v2beta1.types.RegistrarApiCheckContactsCompatibilityRequest(domains: 'Optional[List[str]]', tlds: 'Optional[List[str]]', owner_contact_id: 'Optional[str]', owner_contact: 'Optional[NewContact]', administrative_contact_id: 'Optional[str]', administrative_contact: 'Optional[NewContact]', technical_contact_id: 'Optional[str]', technical_contact: 'Optional[NewContact]')

Bases: object

administrative_contact: Optional[NewContact]

administrative_contact_id: Optional[str]

domains: Optional[List[str]]

owner_contact: Optional[NewContact]

owner_contact_id: Optional[str]

technical_contact: Optional[NewContact]

technical_contact_id: Optional[str]

tlds: Optional[List[str]]

class scaleway_async.domain.v2beta1.types.RegistrarApiCreateDomainHostRequest(domain: 'str', name: 'str', ips: 'Optional[List[str]]')

Bases: object

domain: str

ips: Optional[List[str]]

name: str

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

Bases: object

domain: str

name: str

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

Bases: object

domain: str

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

Bases: object

domain: str

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

Bases: object

domain: str

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

Bases: object

domain: str

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

Bases: object

domain: str

ds_record: Optional[DSRecord]

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

Bases: object

contact_id: str

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

Bases: object

domain: str

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

Bases: object

domain: str

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

Bases: object

domain: Optional[str]

email_status: Optional[ContactEmailStatus]

organization_id: Optional[str]

page: Optional[int]

page_size: Optional[int]

project_id: Optional[str]

role: Optional[ListContactsRequestRole]

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

Bases: object

domain: str

page: Optional[int]

page_size: Optional[int]

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

Bases: object

domain: Optional[str]

is_external: Optional[bool]

order_by: Optional[ListDomainsRequestOrderBy]

organization_id: Optional[str]

page: Optional[int]

page_size: Optional[int]

project_id: Optional[str]

registrar: Optional[str]

status: Optional[DomainStatus]

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

Bases: object

order_by: Optional[ListRenewableDomainsRequestOrderBy]

organization_id: Optional[str]

page: Optional[int]

page_size: Optional[int]

project_id: Optional[str]

class scaleway_async.domain.v2beta1.types.RegistrarApiListTasksRequest(page: 'Optional[int]', page_size: 'Optional[int]', project_id: 'Optional[str]', organization_id: 'Optional[str]', domain: 'Optional[str]', types: 'Optional[List[TaskType]]', statuses: 'Optional[List[TaskStatus]]', order_by: 'Optional[ListTasksRequestOrderBy]')

Bases: object

domain: Optional[str]

order_by: Optional[ListTasksRequestOrderBy]

organization_id: Optional[str]

page: Optional[int]

page_size: Optional[int]

project_id: Optional[str]

statuses: Optional[List[TaskStatus]]

types: Optional[List[TaskType]]

class scaleway_async.domain.v2beta1.types.RegistrarApiListTldsRequest(tlds: 'Optional[List[str]]', page: 'Optional[int]', page_size: 'Optional[int]', order_by: 'Optional[ListTldsRequestOrderBy]')

Bases: object

order_by: Optional[ListTldsRequestOrderBy]: Sort order of the returned TLDs.

page: Optional[int]: Page number for the returned Projects.

page_size: Optional[int]: Maximum number of Project per page.

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

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

Bases: object

domain: str

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

Bases: object

domain: str

project_id: Optional[str]

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

Bases: object

domains: List[str]

duration_in_years: int

force_late_renewal: Optional[bool]

class scaleway_async.domain.v2beta1.types.RegistrarApiSearchAvailableDomainsRequest(domains: 'List[str]', strict_search: 'bool', tlds: 'Optional[List[str]]')

Bases: object

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

strict_search: bool: Search exact match.

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

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

Bases: object

domain: str

new_owner_contact: Optional[NewContact]

new_owner_contact_id: Optional[str]

project_id: Optional[str]

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

Bases: object

administrative_contact: Optional[NewContact]

administrative_contact_id: Optional[str]

domains: List[TransferInDomainRequestTransferRequest]

owner_contact: Optional[NewContact]

owner_contact_id: Optional[str]

project_id: Optional[str]

technical_contact: Optional[NewContact]

technical_contact_id: Optional[str]

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

Bases: object

domain: str

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

Bases: object

address_line_1: Optional[str]

address_line_2: Optional[str]

city: Optional[str]

company_identification_code: Optional[str]

contact_id: str

country: Optional[str]

email: Optional[str]

email_alt: Optional[str]

extension_eu: Optional[ContactExtensionEU]

extension_fr: Optional[ContactExtensionFR]

extension_nl: Optional[ContactExtensionNL]

fax_number: Optional[str]

lang: Optional[LanguageCode]

phone_number: Optional[str]

questions: Optional[List[UpdateContactRequestQuestion]]

resale: Optional[bool]

state: Optional[str]

vat_identification_code: Optional[str]

whois_opt_in: Optional[bool]

zip: Optional[str]

class scaleway_async.domain.v2beta1.types.RegistrarApiUpdateDomainHostRequest(domain: 'str', name: 'str', ips: 'Optional[List[str]]')

Bases: object

domain: str

ips: Optional[List[str]]

name: str

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

Bases: object

administrative_contact: Optional[NewContact]

administrative_contact_id: Optional[str]

domain: str

owner_contact: Optional[NewContact]

owner_contact_id: Optional[str]

technical_contact: Optional[NewContact]

technical_contact_id: Optional[str]

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

Bases: object

domain: str

estimated_delete_at: Optional[datetime]

expired_at: Optional[datetime]

limit_redemption_at: Optional[datetime]

limit_renew_at: Optional[datetime]

organization_id: str

project_id: str

renewable_duration_in_years: Optional[int]

status: RenewableDomainStatus

tld: Optional[Tld]

class scaleway_async.domain.v2beta1.types.RenewableDomainStatus(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

LATE_RENEWEABLE = 'late_reneweable'

NOT_RENEWABLE = 'not_renewable'

RENEWABLE = 'renewable'

UNKNOWN = 'unknown'

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

Bases: object

dns_zone_version_id: str

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

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

Bases: object

alternative_dns_zones: List[str]

certificate_chain: str

created_at: Optional[datetime]

dns_zone: str

expired_at: Optional[datetime]

private_key: str

status: SSLCertificateStatus

class scaleway_async.domain.v2beta1.types.SSLCertificateStatus(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

ERROR = 'error'

NEW = 'new'

PENDING = 'pending'

SUCCESS = 'success'

UNKNOWN = 'unknown'

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

Bases: object

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

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

Bases: object

contact_identifier: Optional[str]: Human-friendly contact identifier used when the task concerns a contact.

domain: Optional[str]: The domain name associated to the task.

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

message: Optional[str]: 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: Optional[datetime]: Start date of the task.

status: TaskStatus: The status of the task.

type_: TaskType: The type of the task.

updated_at: Optional[datetime]: Last update of the task.

class scaleway_async.domain.v2beta1.types.TaskStatus(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

ERROR = 'error'

NEW = 'new'

PENDING = 'pending'

SUCCESS = 'success'

UNAVAILABLE = 'unavailable'

WAITING_PAYMENT = 'waiting_payment'

class scaleway_async.domain.v2beta1.types.TaskType(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

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_async.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_async.domain.v2beta1.types.TldOffer(action: 'str', operation_path: 'str', price: 'Optional[Money]')

Bases: object

action: str

operation_path: str

price: Optional[Money]

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

Bases: object

auth_code: str

domain: str

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

Bases: object

answer: Optional[str]

question: Optional[str]

class scaleway_async.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_async.domain.v2beta1.types.UpdateDNSZoneNameserversResponse(ns: 'List[Nameserver]')

Bases: object

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

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

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: Optional[bool]: Specifies whether or not to return all the records.

serial: Optional[int]: Use the provided serial (0) instead of the auto-increment serial.

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

Bases: object

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

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

Bases: object

dns_zone: str: DNS zone to update.

new_dns_zone: Optional[str]: Name of the new DNS zone to create.

project_id: Optional[str]: Project ID in which to create the new DNS zone.

Module contents

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

Bases: object

available: bool

domain: str

tld: Optional[Tld]

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

Bases: object

administrative_check_result: Optional[CheckContactsCompatibilityResponseContactCheckResult]

compatible: bool

owner_check_result: Optional[CheckContactsCompatibilityResponseContactCheckResult]

technical_check_result: Optional[CheckContactsCompatibilityResponseContactCheckResult]

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

Bases: object

compatible: bool

error_message: Optional[str]

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

Bases: object

dns_zone: str: DNS zone to clear.

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

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

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: Optional[str]: Project ID of the destination DNS zone.

class scaleway_async.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', questions: 'Optional[List[ContactQuestion]]', extension_fr: 'Optional[ContactExtensionFR]', extension_eu: 'Optional[ContactExtensionEU]', email_status: 'ContactEmailStatus', state: 'str', status: 'ContactStatus', extension_nl: 'Optional[ContactExtensionNL]')

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: Optional[ContactExtensionEU]

extension_fr: Optional[ContactExtensionFR]

extension_nl: Optional[ContactExtensionNL]

fax_number: str

firstname: str

id: str

lang: LanguageCode

lastname: str

legal_form: ContactLegalForm

phone_number: str

questions: Optional[List[ContactQuestion]]

resale: bool

state: str

status: ContactStatus

vat_identification_code: str

whois_opt_in: bool

zip: str

class scaleway_async.domain.v2beta1.ContactEmailStatus(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

EMAIL_STATUS_UNKNOWN = 'email_status_unknown'

INVALID_EMAIL = 'invalid_email'

NOT_VALIDATED = 'not_validated'

VALIDATED = 'validated'

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

Bases: object

european_citizenship: str

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

Bases: object

association_info: Optional[ContactExtensionFRAssociationInfo]

code_auth_afnic_info: Optional[ContactExtensionFRCodeAuthAfnicInfo]

duns_info: Optional[ContactExtensionFRDunsInfo]

individual_info: Optional[ContactExtensionFRIndividualInfo]

mode: ContactExtensionFRMode

trademark_info: Optional[ContactExtensionFRTrademarkInfo]

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

Bases: object

publication_jo: Optional[datetime]

publication_jo_page: int

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

Bases: object

code_auth_afnic: str

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

Bases: object

duns_id: str

local_id: str

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

Bases: object

whois_opt_in: bool

class scaleway_async.domain.v2beta1.ContactExtensionFRMode(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

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_async.domain.v2beta1.ContactExtensionFRTrademarkInfo(trademark_inpi: 'str')

Bases: object

trademark_inpi: str

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

Bases: object

legal_form: ContactExtensionNLLegalForm

legal_form_registration_number: str

class scaleway_async.domain.v2beta1.ContactExtensionNLLegalForm(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

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_async.domain.v2beta1.ContactLegalForm(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

ASSOCIATION = 'association'

CORPORATE = 'corporate'

INDIVIDUAL = 'individual'

LEGAL_FORM_UNKNOWN = 'legal_form_unknown'

OTHER = 'other'

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

Bases: object

answer: str

question: str

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

Bases: object

contact: Optional[Contact]

roles: Dict[str, ContactRolesRoles]

class scaleway_async.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_async.domain.v2beta1.ContactStatus(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

ACTIVE = 'active'

PENDING = 'pending'

STATUS_UNKNOWN = 'status_unknown'

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

Bases: object

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

project_id: Optional[str]: Project ID in which to create the DNS zone.

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

class scaleway_async.domain.v2beta1.CreateSSLCertificateRequest(dns_zone: 'str', alternative_dns_zones: 'Optional[List[str]]')

Bases: object

alternative_dns_zones: Optional[List[str]]

dns_zone: str

class scaleway_async.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]', updated_at: 'Optional[datetime]')

Bases: object

domain: str

linked_products: List[LinkedProduct]

message: Optional[str]

ns: List[str]

ns_default: List[str]

ns_master: List[str]

project_id: str

status: DNSZoneStatus

subdomain: str

updated_at: Optional[datetime]

class scaleway_async.domain.v2beta1.DNSZoneStatus(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

ACTIVE = 'active'

ERROR = 'error'

LOCKED = 'locked'

PENDING = 'pending'

UNKNOWN = 'unknown'

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

Bases: object

created_at: Optional[datetime]

id: str

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

Bases: object

algorithm: DSRecordAlgorithm

digest: Optional[DSRecordDigest]

key_id: int

public_key: Optional[DSRecordPublicKey]

class scaleway_async.domain.v2beta1.DSRecordAlgorithm(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

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_async.domain.v2beta1.DSRecordDigest(type_: 'DSRecordDigestType', digest: 'str', public_key: 'Optional[DSRecordPublicKey]')

Bases: object

digest: str

public_key: Optional[DSRecordPublicKey]

type_: DSRecordDigestType

class scaleway_async.domain.v2beta1.DSRecordDigestType(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

GOST_R_34_11_94 = 'gost_r_34_11_94'

SHA_1 = 'sha_1'

SHA_256 = 'sha_256'

SHA_384 = 'sha_384'

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

Bases: object

key: str

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

Bases: object

dns_zone: str: DNS zone to delete.

project_id: Optional[str]: Project ID of the DNS zone to delete.

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

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

Bases: object

dns_zone: str

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

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

Bases: object

dns_zone: str

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

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

Bases: object

administrative_contact: Optional[Contact]: 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: Optional[DomainDNSSEC]: Status of the DNSSEC configuration of the domain.

domain: str

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

expired_at: Optional[datetime]: Date of expiration of the domain.

external_domain_registration_status: Optional[DomainRegistrationStatusExternalDomain]

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: Optional[Contact]: 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: Optional[Contact]: Contact information of the domain’s technical contact.

tld: Optional[Tld]: Domain’s TLD information.

transfer_registration_status: Optional[DomainRegistrationStatusTransfer]

updated_at: Optional[datetime]: Domain’s last modification date.

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

Bases: object

ds_records: List[DSRecord]

status: DomainFeatureStatus

class scaleway_async.domain.v2beta1.DomainFeatureStatus(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

DISABLED = 'disabled'

DISABLING = 'disabling'

ENABLED = 'enabled'

ENABLING = 'enabling'

FEATURE_STATUS_UNKNOWN = 'feature_status_unknown'

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

Bases: object

validation_token: str

class scaleway_async.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_async.domain.v2beta1.DomainRegistrationStatusTransferStatus(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

DONE = 'done'

PENDING = 'pending'

PROCESSING = 'processing'

REJECTED = 'rejected'

STATUS_UNKNOWN = 'status_unknown'

WAITING_VOTE = 'waiting_vote'

class scaleway_async.domain.v2beta1.DomainStatus(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

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_async.domain.v2beta1.DomainSummary(domain: 'str', project_id: 'str', auto_renew_status: 'DomainFeatureStatus', dnssec_status: 'DomainFeatureStatus', epp_code: 'List[str]', registrar: 'str', is_external: 'bool', expired_at: 'Optional[datetime]', updated_at: 'Optional[datetime]', status: 'DomainStatus', organization_id: 'str', pending_trade: 'bool', created_at: 'Optional[datetime]', external_domain_registration_status: 'Optional[DomainRegistrationStatusExternalDomain]', transfer_registration_status: 'Optional[DomainRegistrationStatusTransfer]')

Bases: object

auto_renew_status: DomainFeatureStatus

created_at: Optional[datetime]

dnssec_status: DomainFeatureStatus

domain: str

epp_code: List[str]

expired_at: Optional[datetime]

external_domain_registration_status: Optional[DomainRegistrationStatusExternalDomain]

is_external: bool

organization_id: str

pending_trade: bool

project_id: str

registrar: str

status: DomainStatus

transfer_registration_status: Optional[DomainRegistrationStatusTransfer]

updated_at: Optional[datetime]

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

Bases: API

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

async 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 = await api.clear_dns_zone_records(
    dns_zone="example",
)

async clone_dns_zone(*, dns_zone: str, dest_dns_zone: str, overwrite: bool, project_id: Optional[str] = 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 = await api.clone_dns_zone(
    dns_zone="example",
    dest_dns_zone="example",
    overwrite=False,
)

async create_dns_zone(*, domain: str, subdomain: str, project_id: Optional[str] = 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 = await api.create_dns_zone(
    domain="example",
    subdomain="example",
)

async create_ssl_certificate(*, dns_zone: str, alternative_dns_zones: Optional[List[str]] = 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 = await api.create_ssl_certificate(
    dns_zone="example",
)

async delete_dns_zone(*, dns_zone: str, project_id: Optional[str] = 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 = await api.delete_dns_zone(
    dns_zone="example",
)

async 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 = await api.delete_dns_zone_tsig_key(
    dns_zone="example",
)

async 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 = await api.delete_ssl_certificate(
    dns_zone="example",
)

async export_raw_dns_zone(*, dns_zone: str, format: Optional[RawFormat] = 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 = await api.export_raw_dns_zone(
    dns_zone="example",
)

async 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 = await api.get_dns_zone_tsig_key(
    dns_zone="example",
)

async 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 = await api.get_dns_zone_version_diff(
    dns_zone_version_id="example",
)

async 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 = await api.get_ssl_certificate(
    dns_zone="example",
)

async import_provider_dns_zone(*, dns_zone: str, online_v1: Optional[ImportProviderDNSZoneRequestOnlineV1] = 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 = await api.import_provider_dns_zone(
    dns_zone="example",
)

async import_raw_dns_zone(*, dns_zone: str, content: Optional[str] = None, project_id: Optional[str] = None, format: Optional[RawFormat] = None, bind_source: Optional[ImportRawDNSZoneRequestBindSource] = None, axfr_source: Optional[ImportRawDNSZoneRequestAXFRSource] = 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 = await api.import_raw_dns_zone(
    dns_zone="example",
)

async list_dns_zone_nameservers(*, project_id: Optional[str] = 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 = await api.list_dns_zone_nameservers(
    dns_zone="example",
)

async list_dns_zone_records(*, project_id: Optional[str] = None, order_by: Optional[ListDNSZoneRecordsRequestOrderBy] = None, page: Optional[int] = None, page_size: Optional[int] = None, dns_zone: str, name: str, type_: Optional[RecordType] = None, id: Optional[str] = None) → ListDNSZoneRecordsResponse

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 = await api.list_dns_zone_records(
    dns_zone="example",
    name="example",
)

async list_dns_zone_records_all(*, project_id: Optional[str] = None, order_by: Optional[ListDNSZoneRecordsRequestOrderBy] = None, page: Optional[int] = None, page_size: Optional[int] = None, dns_zone: str, name: str, type_: Optional[RecordType] = None, id: Optional[str] = None) → List[Record]

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 = await api.list_dns_zone_records_all(
    dns_zone="example",
    name="example",
)

async list_dns_zone_version_records(*, page: Optional[int] = None, page_size: Optional[int] = 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 = await api.list_dns_zone_version_records(
    dns_zone_version_id="example",
)

async list_dns_zone_version_records_all(*, page: Optional[int] = None, page_size: Optional[int] = 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 = await api.list_dns_zone_version_records_all(
    dns_zone_version_id="example",
)

async list_dns_zone_versions(*, page: Optional[int] = None, page_size: Optional[int] = 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 = await api.list_dns_zone_versions(
    dns_zone="example",
)

async list_dns_zone_versions_all(*, page: Optional[int] = None, page_size: Optional[int] = 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 = await api.list_dns_zone_versions_all(
    dns_zone="example",
)

async list_dns_zones(*, domain: str, organization_id: Optional[str] = None, project_id: Optional[str] = None, order_by: Optional[ListDNSZonesRequestOrderBy] = None, page: Optional[int] = None, page_size: Optional[int] = None, dns_zone: Optional[str] = None, dns_zones: Optional[List[str]] = None, created_after: Optional[datetime] = None, created_before: Optional[datetime] = None, updated_after: Optional[datetime] = None, updated_before: Optional[datetime] = None) → ListDNSZonesResponse

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 = await api.list_dns_zones(
    domain="example",
)

async list_dns_zones_all(*, domain: str, organization_id: Optional[str] = None, project_id: Optional[str] = None, order_by: Optional[ListDNSZonesRequestOrderBy] = None, page: Optional[int] = None, page_size: Optional[int] = None, dns_zone: Optional[str] = None, dns_zones: Optional[List[str]] = None, created_after: Optional[datetime] = None, created_before: Optional[datetime] = None, updated_after: Optional[datetime] = None, updated_before: Optional[datetime] = None) → List[DNSZone]

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 = await api.list_dns_zones_all(
    domain="example",
)

async list_ssl_certificates(*, dns_zone: str, page: Optional[int] = None, page_size: Optional[int] = None, project_id: Optional[str] = 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 = await api.list_ssl_certificates(
    dns_zone="example",
)

async list_ssl_certificates_all(*, dns_zone: str, page: Optional[int] = None, page_size: Optional[int] = None, project_id: Optional[str] = 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 = await api.list_ssl_certificates_all(
    dns_zone="example",
)

async 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 = await api.refresh_dns_zone(
    dns_zone="example",
    recreate_dns_zone=False,
    recreate_sub_dns_zone=False,
)

async 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 = await api.restore_dns_zone_version(
    dns_zone_version_id="example",
)

async update_dns_zone(*, dns_zone: str, new_dns_zone: Optional[str] = None, project_id: Optional[str] = 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 = await api.update_dns_zone(
    dns_zone="example",
)

async 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 = await api.update_dns_zone_nameservers(
    dns_zone="example",
    ns=[],
)

async update_dns_zone_records(*, dns_zone: str, changes: List[RecordChange], disallow_new_zone_creation: bool, return_all_records: Optional[bool] = None, serial: Optional[int] = 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 = await api.update_dns_zone_records(
    dns_zone="example",
    changes=[],
    disallow_new_zone_creation=False,
)

async wait_for_ssl_certificate(*, dns_zone: str, options: Optional[WaitForOptions[SSLCertificate, Union[bool, Awaitable[bool]]]] = 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 = await api.get_ssl_certificate(
    dns_zone="example",
)

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

Bases: API

Manage your domains and contacts.

async buy_domains(*, 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) → 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 = await api.buy_domains(
    domains=[],
    duration_in_years=1,
)

async check_contacts_compatibility(*, domains: Optional[List[str]] = None, tlds: Optional[List[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) → 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 = await api.check_contacts_compatibility()

async create_domain_host(*, domain: str, name: str, ips: Optional[List[str]] = 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 = await api.create_domain_host(
    domain="example",
    name="example",
)

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

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

Usage:

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

async delete_external_domain(*, domain: str) → DeleteExternalDomainResponse

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

Usage:

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

async 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 = await api.disable_domain_auto_renew(
    domain="example",
)

async disable_domain_dnssec(*, domain: str) → Domain

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

Usage:

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

async 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 = await api.enable_domain_auto_renew(
    domain="example",
)

async enable_domain_dnssec(*, domain: str, ds_record: Optional[DSRecord] = 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 = await api.enable_domain_dnssec(
    domain="example",
)

async 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 = await api.get_contact(
    contact_id="example",
)

async get_domain(*, domain: str) → Domain

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

Usage:

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

async 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 = await api.get_domain_auth_code(
    domain="example",
)

async list_contacts(*, 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) → ListContactsResponse

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 = await api.list_contacts()

async list_contacts_all(*, 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) → List[ContactRoles]

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 = await api.list_contacts_all()

async list_domain_hosts(*, page: Optional[int] = None, page_size: Optional[int] = 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 = await api.list_domain_hosts(
    domain="example",
)

async list_domain_hosts_all(*, page: Optional[int] = None, page_size: Optional[int] = 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 = await api.list_domain_hosts_all(
    domain="example",
)

async list_domains(*, 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) → ListDomainsResponse

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 = await api.list_domains()

async list_domains_all(*, 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) → List[DomainSummary]

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 = await api.list_domains_all()

async list_renewable_domains(*, page: Optional[int] = None, page_size: Optional[int] = None, order_by: Optional[ListRenewableDomainsRequestOrderBy] = None, project_id: Optional[str] = None, organization_id: Optional[str] = None) → ListRenewableDomainsResponse

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 = await api.list_renewable_domains()

async list_renewable_domains_all(*, page: Optional[int] = None, page_size: Optional[int] = None, order_by: Optional[ListRenewableDomainsRequestOrderBy] = None, project_id: Optional[str] = None, organization_id: Optional[str] = None) → List[RenewableDomain]

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 = await api.list_renewable_domains_all()

async list_tasks(*, 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]] = None, statuses: Optional[List[TaskStatus]] = None, order_by: Optional[ListTasksRequestOrderBy] = None) → ListTasksResponse

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 = await api.list_tasks()

async list_tasks_all(*, 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]] = None, statuses: Optional[List[TaskStatus]] = None, order_by: Optional[ListTasksRequestOrderBy] = None) → List[Task]

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 = await api.list_tasks_all()

async list_tlds(*, tlds: Optional[List[str]] = None, page: Optional[int] = None, page_size: Optional[int] = None, order_by: Optional[ListTldsRequestOrderBy] = 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 = await api.list_tlds()

async list_tlds_all(*, tlds: Optional[List[str]] = None, page: Optional[int] = None, page_size: Optional[int] = None, order_by: Optional[ListTldsRequestOrderBy] = 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 = await api.list_tlds_all()

async 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 = await api.lock_domain_transfer(
    domain="example",
)

async register_external_domain(*, domain: str, project_id: Optional[str] = None) → RegisterExternalDomainResponse

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

Usage:

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

async renew_domains(*, domains: List[str], duration_in_years: int, force_late_renewal: Optional[bool] = 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 = await api.renew_domains(
    domains=[],
    duration_in_years=1,
)

async search_available_domains(*, domains: List[str], strict_search: bool, tlds: Optional[List[str]] = 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 = await api.search_available_domains(
    domains=[],
    strict_search=False,
)

async trade_domain(*, domain: str, project_id: Optional[str] = None, new_owner_contact_id: Optional[str] = None, new_owner_contact: Optional[NewContact] = 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 = await api.trade_domain(
    domain="example",
)

async transfer_in_domain(*, 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) → 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 = await api.transfer_in_domain(
    domains=[],
)

async 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 = await api.unlock_domain_transfer(
    domain="example",
)

async update_contact(*, 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[LanguageCode] = None, resale: Optional[bool] = None, questions: Optional[List[UpdateContactRequestQuestion]] = None, 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) → Contact

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 = await api.update_contact(
    contact_id="example",
)

async update_domain(*, 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) → 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 = await api.update_domain(
    domain="example",
)

async update_domain_host(*, domain: str, name: str, ips: Optional[List[str]] = 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 = await api.update_domain_host(
    domain="example",
    name="example",
)

async wait_for_domain(*, domain: str, options: Optional[WaitForOptions[Domain, Union[bool, Awaitable[bool]]]] = None) → Domain

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

Usage:

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

class scaleway_async.domain.v2beta1.ExportRawDNSZoneRequest(dns_zone: 'str', format: 'Optional[RawFormat]')

Bases: object

dns_zone: str: DNS zone to export.

format: Optional[RawFormat]: DNS zone format.

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

Bases: object

dns_zone: str

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

Bases: object

algorithm: str

key: str

name: str

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

Bases: object

dns_zone_version_id: str

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

Bases: object

changes: List[RecordChange]

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

Bases: object

auth_code: str

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

Bases: object

dns_zone: str

class scaleway_async.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_async.domain.v2beta1.HostStatus(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

ACTIVE = 'active'

DELETING = 'deleting'

UNKNOWN_STATUS = 'unknown_status'

UPDATING = 'updating'

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

Bases: object

dns_zone: str

online_v1: Optional[ImportProviderDNSZoneRequestOnlineV1]

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

Bases: object

token: str

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

Bases: object

records: List[Record]

class scaleway_async.domain.v2beta1.ImportRawDNSZoneRequest(dns_zone: 'str', content: 'Optional[str]', project_id: 'Optional[str]', format: 'Optional[RawFormat]', bind_source: 'Optional[ImportRawDNSZoneRequestBindSource]', axfr_source: 'Optional[ImportRawDNSZoneRequestAXFRSource]')

Bases: object

axfr_source: Optional[ImportRawDNSZoneRequestAXFRSource]

bind_source: Optional[ImportRawDNSZoneRequestBindSource]

content: Optional[str]

dns_zone: str: DNS zone to import.

format: Optional[RawFormat]

project_id: Optional[str]

class scaleway_async.domain.v2beta1.ImportRawDNSZoneRequestAXFRSource(name_server: 'str', tsig_key: 'Optional[ImportRawDNSZoneRequestTsigKey]')

Bases: object

name_server: str

tsig_key: Optional[ImportRawDNSZoneRequestTsigKey]

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

Bases: object

content: str

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

Bases: object

algorithm: str

key: str

name: str

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

Bases: object

records: List[Record]

class scaleway_async.domain.v2beta1.LinkedProduct(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

UNKNOWN_PRODUCT = 'unknown_product'

VPC = 'vpc'

class scaleway_async.domain.v2beta1.ListContactsRequestRole(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

ADMINISTRATIVE = 'administrative'

OWNER = 'owner'

TECHNICAL = 'technical'

UNKNOWN_ROLE = 'unknown_role'

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

Bases: object

contacts: List[ContactRoles]

total_count: int

class scaleway_async.domain.v2beta1.ListDNSZoneNameserversRequest(project_id: 'Optional[str]', dns_zone: 'str')

Bases: object

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

project_id: Optional[str]: Project ID on which to filter the returned DNS zone name servers.

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

Bases: object

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

class scaleway_async.domain.v2beta1.ListDNSZoneRecordsRequest(project_id: 'Optional[str]', order_by: 'Optional[ListDNSZoneRecordsRequestOrderBy]', page: 'Optional[int]', page_size: 'Optional[int]', dns_zone: 'str', name: 'str', type_: 'Optional[RecordType]', id: 'Optional[str]')

Bases: object

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

id: Optional[str]: 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: Optional[ListDNSZoneRecordsRequestOrderBy]: Sort order of the returned DNS zone records.

page: Optional[int]: Page number to return, from the paginated results.

page_size: Optional[int]: Maximum number of DNS zone records per page.

project_id: Optional[str]: Project ID on which to filter the returned DNS zone records.

type_: Optional[RecordType]: Record type on which to filter the returned DNS zone records.

class scaleway_async.domain.v2beta1.ListDNSZoneRecordsRequestOrderBy(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

NAME_ASC = 'name_asc'

NAME_DESC = 'name_desc'

class scaleway_async.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_async.domain.v2beta1.ListDNSZoneVersionRecordsRequest(page: 'Optional[int]', page_size: 'Optional[int]', dns_zone_version_id: 'str')

Bases: object

dns_zone_version_id: str

page: Optional[int]: Page number to return, from the paginated results.

page_size: Optional[int]: Maximum number of DNS zones versions records per page.

class scaleway_async.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_async.domain.v2beta1.ListDNSZoneVersionsRequest(page: 'Optional[int]', page_size: 'Optional[int]', dns_zone: 'str')

Bases: object

dns_zone: str

page: Optional[int]: Page number to return, from the paginated results.

page_size: Optional[int]: Maximum number of DNS zones versions per page.

class scaleway_async.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_async.domain.v2beta1.ListDNSZonesRequest(domain: 'str', organization_id: 'Optional[str]', project_id: 'Optional[str]', order_by: 'Optional[ListDNSZonesRequestOrderBy]', page: 'Optional[int]', page_size: 'Optional[int]', dns_zone: 'Optional[str]', dns_zones: 'Optional[List[str]]', created_after: 'Optional[datetime]', created_before: 'Optional[datetime]', updated_after: 'Optional[datetime]', updated_before: 'Optional[datetime]')

Bases: object

created_after: Optional[datetime]: Only list DNS zones created after this date.

created_before: Optional[datetime]: Only list DNS zones created before this date.

dns_zone: Optional[str]: DNS zone on which to filter the returned DNS zones.

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

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

order_by: Optional[ListDNSZonesRequestOrderBy]: Sort order of the returned DNS zones.

organization_id: Optional[str]: Organization ID on which to filter the returned DNS zones.

page: Optional[int]: Page number to return, from the paginated results.

page_size: Optional[int]: Maximum number of DNS zones to return per page.

project_id: Optional[str]: Project ID on which to filter the returned DNS zones.

updated_after: Optional[datetime]: Only list DNS zones updated after this date.

updated_before: Optional[datetime]: Only list DNS zones updated before this date.

class scaleway_async.domain.v2beta1.ListDNSZonesRequestOrderBy(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

CREATED_AT_ASC = 'created_at_asc'

CREATED_AT_DESC = 'created_at_desc'

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_async.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_async.domain.v2beta1.ListDomainHostsResponse(total_count: 'int', hosts: 'List[Host]')

Bases: object

hosts: List[Host]

total_count: int

class scaleway_async.domain.v2beta1.ListDomainsRequestOrderBy(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

DOMAIN_ASC = 'domain_asc'

DOMAIN_DESC = 'domain_desc'

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

Bases: object

domains: List[DomainSummary]

total_count: int

class scaleway_async.domain.v2beta1.ListRenewableDomainsRequestOrderBy(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

DOMAIN_ASC = 'domain_asc'

DOMAIN_DESC = 'domain_desc'

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

Bases: object

domains: List[RenewableDomain]

total_count: int

class scaleway_async.domain.v2beta1.ListSSLCertificatesRequest(dns_zone: 'str', page: 'Optional[int]', page_size: 'Optional[int]', project_id: 'Optional[str]')

Bases: object

dns_zone: str

page: Optional[int]

page_size: Optional[int]

project_id: Optional[str]

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

Bases: object

certificates: List[SSLCertificate]

total_count: int

class scaleway_async.domain.v2beta1.ListTasksRequestOrderBy(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

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_async.domain.v2beta1.ListTasksResponse(total_count: 'int', tasks: 'List[Task]')

Bases: object

tasks: List[Task]

total_count: int

class scaleway_async.domain.v2beta1.ListTldsRequestOrderBy(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

NAME_ASC = 'name_asc'

NAME_DESC = 'name_desc'

class scaleway_async.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_async.domain.v2beta1.Nameserver(name: 'str', ip: 'List[str]')

Bases: object

ip: List[str]

name: str

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

Bases: object

address_line_1: str

address_line_2: Optional[str]

city: str

company_identification_code: Optional[str]

company_name: Optional[str]

country: str

email: str

email_alt: Optional[str]

extension_eu: Optional[ContactExtensionEU]

extension_fr: Optional[ContactExtensionFR]

extension_nl: Optional[ContactExtensionNL]

fax_number: Optional[str]

firstname: str

lang: LanguageCode

lastname: str

legal_form: ContactLegalForm

phone_number: str

questions: Optional[List[ContactQuestion]]

resale: bool

state: Optional[str]

vat_identification_code: Optional[str]

whois_opt_in: bool

zip: str

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

Bases: object

created_at: Optional[datetime]

domains: List[str]

organization_id: str

project_id: str

task_id: str

class scaleway_async.domain.v2beta1.RawFormat(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

BIND = 'bind'

UNKNOWN_RAW_FORMAT = 'unknown_raw_format'

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

Bases: object

comment: Optional[str]

data: str

geo_ip_config: Optional[RecordGeoIPConfig]

http_service_config: Optional[RecordHTTPServiceConfig]

id: str

name: str

priority: int

ttl: int

type_: RecordType

view_config: Optional[RecordViewConfig]

weighted_config: Optional[RecordWeightedConfig]

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

Bases: object

add: Optional[RecordChangeAdd]

clear: Optional[RecordChangeClear]

delete: Optional[RecordChangeDelete]

set_: Optional[RecordChangeSet]

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

Bases: object

records: List[Record]

class scaleway_async.domain.v2beta1.RecordChangeClear: Bases: object

class scaleway_async.domain.v2beta1.RecordChangeDelete(id: 'Optional[str]', id_fields: 'Optional[RecordIdentifier]')

Bases: object

id: Optional[str]

id_fields: Optional[RecordIdentifier]

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

Bases: object

id: Optional[str]

id_fields: Optional[RecordIdentifier]

records: List[Record]

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

Bases: object

default: str

matches: List[RecordGeoIPConfigMatch]

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

Bases: object

continents: List[str]

countries: List[str]

data: str

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

Bases: object

ips: List[str]

must_contain: Optional[str]

strategy: RecordHTTPServiceConfigStrategy

url: str

user_agent: Optional[str]

class scaleway_async.domain.v2beta1.RecordHTTPServiceConfigStrategy(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

ALL = 'all'

HASHED = 'hashed'

RANDOM = 'random'

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

Bases: object

data: Optional[str]

name: str

ttl: Optional[int]

type_: RecordType

class scaleway_async.domain.v2beta1.RecordType(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

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_async.domain.v2beta1.RecordViewConfig(views: 'List[RecordViewConfigView]')

Bases: object

views: List[RecordViewConfigView]

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

Bases: object

data: str

subnet: str

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

Bases: object

weighted_ips: List[RecordWeightedConfigWeightedIP]

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

Bases: object

ip: str

weight: int

class scaleway_async.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_async.domain.v2beta1.RefreshDNSZoneResponse(dns_zones: 'List[DNSZone]')

Bases: object

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

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

Bases: object

created_at: Optional[datetime]

domain: str

organization_id: str

project_id: str

validation_token: str

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

Bases: object

administrative_contact: Optional[NewContact]

administrative_contact_id: Optional[str]

domains: List[str]

duration_in_years: int

owner_contact: Optional[NewContact]

owner_contact_id: Optional[str]

project_id: Optional[str]

technical_contact: Optional[NewContact]

technical_contact_id: Optional[str]

class scaleway_async.domain.v2beta1.RegistrarApiCheckContactsCompatibilityRequest(domains: 'Optional[List[str]]', tlds: 'Optional[List[str]]', owner_contact_id: 'Optional[str]', owner_contact: 'Optional[NewContact]', administrative_contact_id: 'Optional[str]', administrative_contact: 'Optional[NewContact]', technical_contact_id: 'Optional[str]', technical_contact: 'Optional[NewContact]')

Bases: object

administrative_contact: Optional[NewContact]

administrative_contact_id: Optional[str]

domains: Optional[List[str]]

owner_contact: Optional[NewContact]

owner_contact_id: Optional[str]

technical_contact: Optional[NewContact]

technical_contact_id: Optional[str]

tlds: Optional[List[str]]

class scaleway_async.domain.v2beta1.RegistrarApiCreateDomainHostRequest(domain: 'str', name: 'str', ips: 'Optional[List[str]]')

Bases: object

domain: str

ips: Optional[List[str]]

name: str

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

Bases: object

domain: str

name: str

class scaleway_async.domain.v2beta1.RegistrarApiDeleteExternalDomainRequest(domain: 'str')

Bases: object

domain: str

class scaleway_async.domain.v2beta1.RegistrarApiDisableDomainAutoRenewRequest(domain: 'str')

Bases: object

domain: str

class scaleway_async.domain.v2beta1.RegistrarApiDisableDomainDNSSECRequest(domain: 'str')

Bases: object

domain: str

class scaleway_async.domain.v2beta1.RegistrarApiEnableDomainAutoRenewRequest(domain: 'str')

Bases: object

domain: str

class scaleway_async.domain.v2beta1.RegistrarApiEnableDomainDNSSECRequest(domain: 'str', ds_record: 'Optional[DSRecord]')

Bases: object

domain: str

ds_record: Optional[DSRecord]

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

Bases: object

contact_id: str

class scaleway_async.domain.v2beta1.RegistrarApiGetDomainAuthCodeRequest(domain: 'str')

Bases: object

domain: str

class scaleway_async.domain.v2beta1.RegistrarApiGetDomainRequest(domain: 'str')

Bases: object

domain: str

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

Bases: object

domain: Optional[str]

email_status: Optional[ContactEmailStatus]

organization_id: Optional[str]

page: Optional[int]

page_size: Optional[int]

project_id: Optional[str]

role: Optional[ListContactsRequestRole]

class scaleway_async.domain.v2beta1.RegistrarApiListDomainHostsRequest(page: 'Optional[int]', page_size: 'Optional[int]', domain: 'str')

Bases: object

domain: str

page: Optional[int]

page_size: Optional[int]

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

Bases: object

domain: Optional[str]

is_external: Optional[bool]

order_by: Optional[ListDomainsRequestOrderBy]

organization_id: Optional[str]

page: Optional[int]

page_size: Optional[int]

project_id: Optional[str]

registrar: Optional[str]

status: Optional[DomainStatus]

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

Bases: object

order_by: Optional[ListRenewableDomainsRequestOrderBy]

organization_id: Optional[str]

page: Optional[int]

page_size: Optional[int]

project_id: Optional[str]

class scaleway_async.domain.v2beta1.RegistrarApiListTasksRequest(page: 'Optional[int]', page_size: 'Optional[int]', project_id: 'Optional[str]', organization_id: 'Optional[str]', domain: 'Optional[str]', types: 'Optional[List[TaskType]]', statuses: 'Optional[List[TaskStatus]]', order_by: 'Optional[ListTasksRequestOrderBy]')

Bases: object

domain: Optional[str]

order_by: Optional[ListTasksRequestOrderBy]

organization_id: Optional[str]

page: Optional[int]

page_size: Optional[int]

project_id: Optional[str]

statuses: Optional[List[TaskStatus]]

types: Optional[List[TaskType]]

class scaleway_async.domain.v2beta1.RegistrarApiListTldsRequest(tlds: 'Optional[List[str]]', page: 'Optional[int]', page_size: 'Optional[int]', order_by: 'Optional[ListTldsRequestOrderBy]')

Bases: object

order_by: Optional[ListTldsRequestOrderBy]: Sort order of the returned TLDs.

page: Optional[int]: Page number for the returned Projects.

page_size: Optional[int]: Maximum number of Project per page.

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

class scaleway_async.domain.v2beta1.RegistrarApiLockDomainTransferRequest(domain: 'str')

Bases: object

domain: str

class scaleway_async.domain.v2beta1.RegistrarApiRegisterExternalDomainRequest(domain: 'str', project_id: 'Optional[str]')

Bases: object

domain: str

project_id: Optional[str]

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

Bases: object

domains: List[str]

duration_in_years: int

force_late_renewal: Optional[bool]

class scaleway_async.domain.v2beta1.RegistrarApiSearchAvailableDomainsRequest(domains: 'List[str]', strict_search: 'bool', tlds: 'Optional[List[str]]')

Bases: object

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

strict_search: bool: Search exact match.

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

class scaleway_async.domain.v2beta1.RegistrarApiTradeDomainRequest(domain: 'str', project_id: 'Optional[str]', new_owner_contact_id: 'Optional[str]', new_owner_contact: 'Optional[NewContact]')

Bases: object

domain: str

new_owner_contact: Optional[NewContact]

new_owner_contact_id: Optional[str]

project_id: Optional[str]

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

Bases: object

administrative_contact: Optional[NewContact]

administrative_contact_id: Optional[str]

domains: List[TransferInDomainRequestTransferRequest]

owner_contact: Optional[NewContact]

owner_contact_id: Optional[str]

project_id: Optional[str]

technical_contact: Optional[NewContact]

technical_contact_id: Optional[str]

class scaleway_async.domain.v2beta1.RegistrarApiUnlockDomainTransferRequest(domain: 'str')

Bases: object

domain: str

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

Bases: object

address_line_1: Optional[str]

address_line_2: Optional[str]

city: Optional[str]

company_identification_code: Optional[str]

contact_id: str

country: Optional[str]

email: Optional[str]

email_alt: Optional[str]

extension_eu: Optional[ContactExtensionEU]

extension_fr: Optional[ContactExtensionFR]

extension_nl: Optional[ContactExtensionNL]

fax_number: Optional[str]

lang: Optional[LanguageCode]

phone_number: Optional[str]

questions: Optional[List[UpdateContactRequestQuestion]]

resale: Optional[bool]

state: Optional[str]

vat_identification_code: Optional[str]

whois_opt_in: Optional[bool]

zip: Optional[str]

class scaleway_async.domain.v2beta1.RegistrarApiUpdateDomainHostRequest(domain: 'str', name: 'str', ips: 'Optional[List[str]]')

Bases: object

domain: str

ips: Optional[List[str]]

name: str

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

Bases: object

administrative_contact: Optional[NewContact]

administrative_contact_id: Optional[str]

domain: str

owner_contact: Optional[NewContact]

owner_contact_id: Optional[str]

technical_contact: Optional[NewContact]

technical_contact_id: Optional[str]

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

Bases: object

domain: str

estimated_delete_at: Optional[datetime]

expired_at: Optional[datetime]

limit_redemption_at: Optional[datetime]

limit_renew_at: Optional[datetime]

organization_id: str

project_id: str

renewable_duration_in_years: Optional[int]

status: RenewableDomainStatus

tld: Optional[Tld]

class scaleway_async.domain.v2beta1.RenewableDomainStatus(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

LATE_RENEWEABLE = 'late_reneweable'

NOT_RENEWABLE = 'not_renewable'

RENEWABLE = 'renewable'

UNKNOWN = 'unknown'

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

Bases: object

dns_zone_version_id: str

class scaleway_async.domain.v2beta1.RestoreDNSZoneVersionResponse: Bases: object

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

Bases: object

alternative_dns_zones: List[str]

certificate_chain: str

created_at: Optional[datetime]

dns_zone: str

expired_at: Optional[datetime]

private_key: str

status: SSLCertificateStatus

class scaleway_async.domain.v2beta1.SSLCertificateStatus(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

ERROR = 'error'

NEW = 'new'

PENDING = 'pending'

SUCCESS = 'success'

UNKNOWN = 'unknown'

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

Bases: object

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

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

Bases: object

contact_identifier: Optional[str]: Human-friendly contact identifier used when the task concerns a contact.

domain: Optional[str]: The domain name associated to the task.

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

message: Optional[str]: 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: Optional[datetime]: Start date of the task.

status: TaskStatus: The status of the task.

type_: TaskType: The type of the task.

updated_at: Optional[datetime]: Last update of the task.

class scaleway_async.domain.v2beta1.TaskStatus(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

ERROR = 'error'

NEW = 'new'

PENDING = 'pending'

SUCCESS = 'success'

UNAVAILABLE = 'unavailable'

WAITING_PAYMENT = 'waiting_payment'

class scaleway_async.domain.v2beta1.TaskType(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

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_async.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_async.domain.v2beta1.TldOffer(action: 'str', operation_path: 'str', price: 'Optional[Money]')

Bases: object

action: str

operation_path: str

price: Optional[Money]

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

Bases: object

auth_code: str

domain: str

class scaleway_async.domain.v2beta1.UpdateContactRequestQuestion(question: 'Optional[str]', answer: 'Optional[str]')

Bases: object

answer: Optional[str]

question: Optional[str]

class scaleway_async.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_async.domain.v2beta1.UpdateDNSZoneNameserversResponse(ns: 'List[Nameserver]')

Bases: object

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

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

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: Optional[bool]: Specifies whether or not to return all the records.

serial: Optional[int]: Use the provided serial (0) instead of the auto-increment serial.

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

Bases: object

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

class scaleway_async.domain.v2beta1.UpdateDNSZoneRequest(dns_zone: 'str', new_dns_zone: 'Optional[str]', project_id: 'Optional[str]')

Bases: object

dns_zone: str: DNS zone to update.

new_dns_zone: Optional[str]: Name of the new DNS zone to create.

project_id: Optional[str]: Project ID in which to create the new DNS zone.