domain

package
v1.0.0-beta.26 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 12, 2024 License: Apache-2.0 Imports: 15 Imported by: 16

Documentation

Overview

Package domain provides methods and message types of the domain v2beta1 API.

Index

Constants

View Source 
const (
	// If unspecified, the status is unknown by default.
	ContactEmailStatusEmailStatusUnknown = ContactEmailStatus("email_status_unknown")
	// The contact email has been validated.
	ContactEmailStatusValidated = ContactEmailStatus("validated")
	// The contact email has not been validated.
	ContactEmailStatusNotValidated = ContactEmailStatus("not_validated")
	// The contact email is invalid.
	ContactEmailStatusInvalidEmail = ContactEmailStatus("invalid_email")
)
View Source 
const (
	// If unspecified, the status is unknown by default.
	ContactExtensionFRModeModeUnknown = ContactExtensionFRMode("mode_unknown")
	// The contact is a physical person (only for .fr domains).
	ContactExtensionFRModeIndividual = ContactExtensionFRMode("individual")
	// The contact is a company with a SIRET/SIREN code (only for .fr domains).
	ContactExtensionFRModeCompanyIdentificationCode = ContactExtensionFRMode("company_identification_code")
	// The contact has a Data Universal Numbering System code (only for .fr domains).
	ContactExtensionFRModeDuns = ContactExtensionFRMode("duns")
	// The contact has a local or a country ID (only for .fr domains).
	ContactExtensionFRModeLocal = ContactExtensionFRMode("local")
	// The contact is an association (only for .fr domains).
	ContactExtensionFRModeAssociation = ContactExtensionFRMode("association")
	// The contact is a brand (only for .fr domains).
	ContactExtensionFRModeTrademark = ContactExtensionFRMode("trademark")
	// The contact has an intervention code (DSIA) from AFNIC (only for .fr domains).
	ContactExtensionFRModeCodeAuthAfnic = ContactExtensionFRMode("code_auth_afnic")
)
View Source 
const (
	// If unspecified, the status is unknown by default.
	ContactExtensionNLLegalFormLegalFormUnknown = ContactExtensionNLLegalForm("legal_form_unknown")
	// The contact's legal form is not listed below (only for .nl domains).
	ContactExtensionNLLegalFormOther = ContactExtensionNLLegalForm("other")
	// The contact is a non-Dutch EC company (only for .nl domains).
	ContactExtensionNLLegalFormNonDutchEuCompany = ContactExtensionNLLegalForm("non_dutch_eu_company")
	// The contact is a non-Dutch legal form/enterprise/subsidiary (only for .nl domains).
	ContactExtensionNLLegalFormNonDutchLegalFormEnterpriseSubsidiary = ContactExtensionNLLegalForm("non_dutch_legal_form_enterprise_subsidiary")
	// The contact is a limited company (only for .nl domains).
	ContactExtensionNLLegalFormLimitedCompany = ContactExtensionNLLegalForm("limited_company")
	// The contact is a limited company in formation (only for .nl domains).
	ContactExtensionNLLegalFormLimitedCompanyInFormation = ContactExtensionNLLegalForm("limited_company_in_formation")
	// The contact is a cooperative (only for .nl domains).
	ContactExtensionNLLegalFormCooperative = ContactExtensionNLLegalForm("cooperative")
	// The contact is a limited Partnership (only for .nl domains).
	ContactExtensionNLLegalFormLimitedPartnership = ContactExtensionNLLegalForm("limited_partnership")
	// The contact is a sole trader (only for .nl domains).
	ContactExtensionNLLegalFormSoleCompany = ContactExtensionNLLegalForm("sole_company")
	// The contact is a European Economic Interest Group (only for .nl domains).
	ContactExtensionNLLegalFormEuropeanEconomicInterestGroup = ContactExtensionNLLegalForm("european_economic_interest_group")
	// The contact is a religious society (only for .nl domains).
	ContactExtensionNLLegalFormReligiousEntity = ContactExtensionNLLegalForm("religious_entity")
	// The contact is a partnership (only for .nl domains).
	ContactExtensionNLLegalFormPartnership = ContactExtensionNLLegalForm("partnership")
	// The contact is a public Company (only for .nl domains).
	ContactExtensionNLLegalFormPublicCompany = ContactExtensionNLLegalForm("public_company")
	// The contact is a mutual benefit company (only for .nl domains).
	ContactExtensionNLLegalFormMutualBenefitCompany = ContactExtensionNLLegalForm("mutual_benefit_company")
	// The contact is a natural person (only for .nl domains).
	ContactExtensionNLLegalFormResidential = ContactExtensionNLLegalForm("residential")
	// The contact is a shipping company (only for .nl domains).
	ContactExtensionNLLegalFormShippingCompany = ContactExtensionNLLegalForm("shipping_company")
	// The contact is a foundation (only for .nl domains).
	ContactExtensionNLLegalFormFoundation = ContactExtensionNLLegalForm("foundation")
	// The contact is a association (only for .nl domains).
	ContactExtensionNLLegalFormAssociation = ContactExtensionNLLegalForm("association")
	// The contact is a trading partnership (only for .nl domains).
	ContactExtensionNLLegalFormTradingPartnership = ContactExtensionNLLegalForm("trading_partnership")
	// The contact is a physical person (only for .nl domains).
	ContactExtensionNLLegalFormNaturalPerson = ContactExtensionNLLegalForm("natural_person")
)
View Source 
const (
	// If unspecified, the status is unknown by default.
	ContactLegalFormLegalFormUnknown = ContactLegalForm("legal_form_unknown")
	// The contact is a physical person.
	ContactLegalFormIndividual = ContactLegalForm("individual")
	// The contact is a corporate or a society.
	ContactLegalFormCorporate = ContactLegalForm("corporate")
	// The contact is an association.
	ContactLegalFormAssociation = ContactLegalForm("association")
	// The contact is not represented by a physical person, a corporate or an association.
	ContactLegalFormOther = ContactLegalForm("other")
)
View Source 
const (
	// If unspecified, the status is unknown by default.
	ContactStatusStatusUnknown = ContactStatus("status_unknown")
	// The contact is active and can be edited.
	ContactStatusActive = ContactStatus("active")
	// The contact is temporarily locked (ie. while being edited).
	ContactStatusPending = ContactStatus("pending")
)
View Source 
const (
	// If unspecified, the DNS zone's status is unknown by default.
	DNSZoneStatusUnknown = DNSZoneStatus("unknown")
	// The DNS zone is active and healthy.
	DNSZoneStatusActive = DNSZoneStatus("active")
	// The DNS zone is updating.
	DNSZoneStatusPending = DNSZoneStatus("pending")
	// An error occurred after updating the DNS zone.
	DNSZoneStatusError = DNSZoneStatus("error")
	// The DNS zone is locked and cannot be updated anymore.
	DNSZoneStatusLocked = DNSZoneStatus("locked")
)
View Source 
const (
	// Code 1, algorithm: 'RSAMD5'.
	DSRecordAlgorithmRsamd5 = DSRecordAlgorithm("rsamd5")
	// Code 2, algorithm: 'DIFFIE_HELLMAN'.
	DSRecordAlgorithmDh = DSRecordAlgorithm("dh")
	// Code 3, algorithm: 'DSA_SHA1'.
	DSRecordAlgorithmDsa = DSRecordAlgorithm("dsa")
	// Code 5, algorithm: 'RSA_SHA1'.
	DSRecordAlgorithmRsasha1 = DSRecordAlgorithm("rsasha1")
	// Code 6, algorithm: 'DSA_NSEC3_SHA1'.
	DSRecordAlgorithmDsaNsec3Sha1 = DSRecordAlgorithm("dsa_nsec3_sha1")
	// Code 7, algorithm: 'RSASHA1_NSEC3_SHA1'.
	DSRecordAlgorithmRsasha1Nsec3Sha1 = DSRecordAlgorithm("rsasha1_nsec3_sha1")
	// Code 8, algorithm: 'RSASHA256'.
	DSRecordAlgorithmRsasha256 = DSRecordAlgorithm("rsasha256")
	// Code 10, algorithm: 'RSASHA512'.
	DSRecordAlgorithmRsasha512 = DSRecordAlgorithm("rsasha512")
	// Code 12, algorithm: 'ECC_GOST'.
	DSRecordAlgorithmEccGost = DSRecordAlgorithm("ecc_gost")
	// Code 13, algorithm: 'ECDSAP256SHA256'.
	DSRecordAlgorithmEcdsap256sha256 = DSRecordAlgorithm("ecdsap256sha256")
	// Code 14, algorithm: 'ECDSAP384SHA384'.
	DSRecordAlgorithmEcdsap384sha384 = DSRecordAlgorithm("ecdsap384sha384")
	// Code 15, algorithm: 'ED25519'.
	DSRecordAlgorithmEd25519 = DSRecordAlgorithm("ed25519")
	// Code 16, algorithm: 'ED448'.
	DSRecordAlgorithmEd448 = DSRecordAlgorithm("ed448")
)
View Source 
const (
	// Code 1, digest type: 'SHA_1'.
	DSRecordDigestTypeSha1 = DSRecordDigestType("sha_1")
	// Code 2, digest type: 'SHA_256'.
	DSRecordDigestTypeSha256 = DSRecordDigestType("sha_256")
	// Code 3, digest type: 'GOST_R_34_11_94'.
	DSRecordDigestTypeGostR34_11_94 = DSRecordDigestType("gost_r_34_11_94")
	// Code 4, digest type: 'SHA_384'.
	DSRecordDigestTypeSha384 = DSRecordDigestType("sha_384")
)
View Source 
const (
	// Default unknown status.
	DomainFeatureStatusFeatureStatusUnknown = DomainFeatureStatus("feature_status_unknown")
	// A feature (auto renew, DNSSEC) is being enabled.
	DomainFeatureStatusEnabling = DomainFeatureStatus("enabling")
	// A feature (auto renew, DNSSEC) has been enabled.
	DomainFeatureStatusEnabled = DomainFeatureStatus("enabled")
	// A feature (auto renew, DNSSEC) is being disabled.
	DomainFeatureStatusDisabling = DomainFeatureStatus("disabling")
	// A feature (auto renew, DNSSEC) has been disabled.
	DomainFeatureStatusDisabled = DomainFeatureStatus("disabled")
)
View Source 
const (
	// If unspecified, the status is unknown by default.
	DomainRegistrationStatusTransferStatusStatusUnknown = DomainRegistrationStatusTransferStatus("status_unknown")
	// The domain transfer is being initialized.
	DomainRegistrationStatusTransferStatusPending = DomainRegistrationStatusTransferStatus("pending")
	// The domain transfer has started. The process can be accelerated if you accept the vote.
	DomainRegistrationStatusTransferStatusWaitingVote = DomainRegistrationStatusTransferStatus("waiting_vote")
	// The domain transfer has been rejected.
	DomainRegistrationStatusTransferStatusRejected = DomainRegistrationStatusTransferStatus("rejected")
	// The domain transfer has been accepted. Your resources are being created.
	DomainRegistrationStatusTransferStatusProcessing = DomainRegistrationStatusTransferStatus("processing")
	// The domain transfer is complete.
	DomainRegistrationStatusTransferStatusDone = DomainRegistrationStatusTransferStatus("done")
)
View Source 
const (
	// If unspecified, the status is unknown by default.
	DomainStatusStatusUnknown = DomainStatus("status_unknown")
	// The domain is active.
	DomainStatusActive = DomainStatus("active")
	// The domain is in the process of being created.
	DomainStatusCreating = DomainStatus("creating")
	// An error occurred during the domain's creation process.
	DomainStatusCreateError = DomainStatus("create_error")
	// The domain is being renewed.
	DomainStatusRenewing = DomainStatus("renewing")
	// An error occurred during the domain's renewal process.
	DomainStatusRenewError = DomainStatus("renew_error")
	// The domain is being transferred to Scaleway Domains and DNS.
	DomainStatusXfering = DomainStatus("xfering")
	// An error occurred during the domain's transfer process.
	DomainStatusXferError = DomainStatus("xfer_error")
	// The domain is expired but it can be renewed.
	DomainStatusExpired = DomainStatus("expired")
	// The domain is expiring but it is still renewable.
	DomainStatusExpiring = DomainStatus("expiring")
	// The domain's information is updating.
	DomainStatusUpdating = DomainStatus("updating")
	// The external domain has not yet been validated. It will be automatically removed after 48 hours if it still has not been validated by then.
	DomainStatusChecking = DomainStatus("checking")
	// The domain is locked. Contact Scaleway's support team for more information.
	DomainStatusLocked = DomainStatus("locked")
	// The domain will be deleted soon. This process cannot be canceled.
	DomainStatusDeleting = DomainStatus("deleting")
)
View Source 
const (
	// If unspecified, the status is unknown by default.
	HostStatusUnknownStatus = HostStatus("unknown_status")
	// The host is active.
	HostStatusActive = HostStatus("active")
	// The host is being updated.
	HostStatusUpdating = HostStatus("updating")
	// The host is being deleted.
	HostStatusDeleting = HostStatus("deleting")
)
View Source 
const (
	// If unspecified, no Scaleway product uses the resources.
	LinkedProductUnknownProduct = LinkedProduct("unknown_product")
	// Resources are used by Scaleway VPC.
	LinkedProductVpc = LinkedProduct("vpc")
)
View Source 
const (
	ListContactsRequestRoleUnknownRole = ListContactsRequestRole("unknown_role")
	// The contact is a domain's owner.
	ListContactsRequestRoleOwner = ListContactsRequestRole("owner")
	// The contact is a domain's administrative contact.
	ListContactsRequestRoleAdministrative = ListContactsRequestRole("administrative")
	// The contact is a domain's technical contact.
	ListContactsRequestRoleTechnical = ListContactsRequestRole("technical")
)
View Source 
const (
	// Order by record name (ascending).
	ListDNSZoneRecordsRequestOrderByNameAsc = ListDNSZoneRecordsRequestOrderBy("name_asc")
	// Order by record name (descending).
	ListDNSZoneRecordsRequestOrderByNameDesc = ListDNSZoneRecordsRequestOrderBy("name_desc")
)
View Source 
const (
	// Order by domain name (ascending).
	ListDNSZonesRequestOrderByDomainAsc = ListDNSZonesRequestOrderBy("domain_asc")
	// Order by domain name (descending).
	ListDNSZonesRequestOrderByDomainDesc = ListDNSZonesRequestOrderBy("domain_desc")
	// Order by subdomain name (ascending).
	ListDNSZonesRequestOrderBySubdomainAsc = ListDNSZonesRequestOrderBy("subdomain_asc")
	// Order by subdomain name (descending).
	ListDNSZonesRequestOrderBySubdomainDesc = ListDNSZonesRequestOrderBy("subdomain_desc")
	// Order by created date (ascending).
	ListDNSZonesRequestOrderByCreatedAtAsc = ListDNSZonesRequestOrderBy("created_at_asc")
	// Order by created date (descending).
	ListDNSZonesRequestOrderByCreatedAtDesc = ListDNSZonesRequestOrderBy("created_at_desc")
	// Order by updated date (ascending).
	ListDNSZonesRequestOrderByUpdatedAtAsc = ListDNSZonesRequestOrderBy("updated_at_asc")
	// Order by updated date (descending).
	ListDNSZonesRequestOrderByUpdatedAtDesc = ListDNSZonesRequestOrderBy("updated_at_desc")
)
View Source 
const (
	// Order by domain name (ascending).
	ListDomainsRequestOrderByDomainAsc = ListDomainsRequestOrderBy("domain_asc")
	// Order by domain name (descending).
	ListDomainsRequestOrderByDomainDesc = ListDomainsRequestOrderBy("domain_desc")
)
View Source 
const (
	// Order by domain name (ascending).
	ListRenewableDomainsRequestOrderByDomainAsc = ListRenewableDomainsRequestOrderBy("domain_asc")
	// Order by domain name (descending).
	ListRenewableDomainsRequestOrderByDomainDesc = ListRenewableDomainsRequestOrderBy("domain_desc")
)
View Source 
const (
	// Order by domain name (descending).
	ListTasksRequestOrderByDomainDesc = ListTasksRequestOrderBy("domain_desc")
	// Order by domain name (ascending).
	ListTasksRequestOrderByDomainAsc = ListTasksRequestOrderBy("domain_asc")
	// Order by type (ascending).
	ListTasksRequestOrderByTypeAsc = ListTasksRequestOrderBy("type_asc")
	// Order by type (descending).
	ListTasksRequestOrderByTypeDesc = ListTasksRequestOrderBy("type_desc")
	// Order by status (ascending).
	ListTasksRequestOrderByStatusAsc = ListTasksRequestOrderBy("status_asc")
	// Order by status (descending).
	ListTasksRequestOrderByStatusDesc = ListTasksRequestOrderBy("status_desc")
	// Order by updated date (ascending).
	ListTasksRequestOrderByUpdatedAtAsc = ListTasksRequestOrderBy("updated_at_asc")
	// Order by updated date (descending).
	ListTasksRequestOrderByUpdatedAtDesc = ListTasksRequestOrderBy("updated_at_desc")
)
View Source 
const (
	// Order by TLD name (ascending).
	ListTldsRequestOrderByNameAsc = ListTldsRequestOrderBy("name_asc")
	// Order by TLD name (descending).
	ListTldsRequestOrderByNameDesc = ListTldsRequestOrderBy("name_desc")
)
View Source 
const (
	// If unspecified, the format is unknown by default.
	RawFormatUnknownRawFormat = RawFormat("unknown_raw_format")
	// Export the DNS zone in text bind format.
	RawFormatBind = RawFormat("bind")
)
View Source 
const (
	// Returns a random IP based of the list of IPs available.
	RecordHTTPServiceConfigStrategyRandom = RecordHTTPServiceConfigStrategy("random")
	// Based on the hash of bestwho, returns a random functioning IP out of the best IPs available.
	RecordHTTPServiceConfigStrategyHashed = RecordHTTPServiceConfigStrategy("hashed")
	// Return all functioning IPs available.
	RecordHTTPServiceConfigStrategyAll = RecordHTTPServiceConfigStrategy("all")
)
View Source 
const (
	// If unspecified, the record's type is unknown by default.
	RecordTypeUnknown = RecordType("unknown")
	// An A record contains an IP address. Example: '203.0.113.210'.
	RecordTypeA = RecordType("A")
	// An AAAA record contains an IPv6 address. Example: '2001:DB8:2000:bf0::1'.
	RecordTypeAAAA = RecordType("AAAA")
	// A CNAME record specifies the canonical name of a record. Example 'webserver-01.yourcompany.com'.
	RecordTypeCNAME = RecordType("CNAME")
	// A TXT record can be used to attach textual data to a domain. Example 'v=spf1 include:_spf.tem.scw.cloud -all'.
	RecordTypeTXT = RecordType("TXT")
	// SRV records can be used to encode the location and port of services on a domain name. Example : '20 443 sipdir.scaleway.example.com'.
	RecordTypeSRV = RecordType("SRV")
	// TLSA records are used to bind SSL/TLS certificates to named hosts and ports.
	RecordTypeTLSA = RecordType("TLSA")
	// An MX record specifies a mail exchanger host for a domain. Example '10 mx.example.net.'.
	RecordTypeMX = RecordType("MX")
	// Specifies nameservers for a domain. Example: 'ns1.yourcompany.com'.
	RecordTypeNS = RecordType("NS")
	// A reverse pointer is used to specify the hostname that belongs to an IP or an IPv6 address. Example: 'www.yourcompany.com.'.
	RecordTypePTR = RecordType("PTR")
	// A 'Certification Authority Authorization' record is used to specify certificate authorities that may issue certificates for a domain. Example: '0 issue ca.yourcompany.com'.
	RecordTypeCAA = RecordType("CAA")
	// The ALIAS pseudo-record type is supported to provide CNAME-like mechanisms on a zone's apex.
	RecordTypeALIAS = RecordType("ALIAS")
	// A LOC record is a way of expressing geographic location information for a domain name. It contains WGS84 latitude, longitude and altitude. Example: '51 56 0.123 N 5 54 0.000 E 4.00m 1.00m 10000.00m 10.00m'.
	RecordTypeLOC = RecordType("LOC")
	// An SSHFP record type is used for storing Secure Shell (SSH) fingerprints. Example: '2 1 123456789abcdef67890123456789abcdef67890'.
	RecordTypeSSHFP = RecordType("SSHFP")
	// A Hardware Info record is used to specify the CPU and operating system you are using. Example: 'i386 Linux'.
	RecordTypeHINFO = RecordType("HINFO")
	// A Responsible Person record stores the mailbox name and the more-information pointer. Example: 'michel.yourcompany.com michel.people.yourcompany.com', to indicate that michel@yourcompany.com is responsible and that more information about Michel is available by querying the `TXT` record of 'michel.people.yourcompany.com'.
	RecordTypeRP = RecordType("RP")
	// A URI record, is used to publish mappings from hostnames to URIs. Example: '10 1 'ftp://ftp.yourcompany.com/public'.
	RecordTypeURI = RecordType("URI")
	// DS records (Delegation Signer) are used to secure delegations (DNSSEC). Example: '2371 13 2 1F987CC6583E92DF0890718C42'.
	RecordTypeDS = RecordType("DS")
	// A Naming Authority Pointer record is used to set rules for how websites process requests. Example: '100 50 "s" "z3950+I2L+I2C" "" _z3950._tcp.yourcompany.com'.
	RecordTypeNAPTR = RecordType("NAPTR")
	// A DNAME record provides redirection from one part of the DNS name tree to another part of the DNS name tree. DNAME and CNAME records both cause a lookup to (potentially) return data corresponding to a different domain name from the queried domain name. Example: 'yourcompany.com'.
	RecordTypeDNAME = RecordType("DNAME")
)
View Source 
const (
	// If unspecified, the status is unknown by default.
	RenewableDomainStatusUnknown = RenewableDomainStatus("unknown")
	// The domain can be renewed.
	RenewableDomainStatusRenewable = RenewableDomainStatus("renewable")
	// The domain is expired, but it still can be late renewed.
	RenewableDomainStatusLateReneweable = RenewableDomainStatus("late_reneweable")
	// The domain cannot be renewed.
	RenewableDomainStatusNotRenewable = RenewableDomainStatus("not_renewable")
)
View Source 
const (
	// If unspecified, the SSL certificate's status is unknown by default.
	SSLCertificateStatusUnknown = SSLCertificateStatus("unknown")
	// The SSL certificate has been created but it has not been processed yet.
	SSLCertificateStatusNew = SSLCertificateStatus("new")
	// The SSL certificate's status is pending.
	SSLCertificateStatusPending = SSLCertificateStatus("pending")
	// The SSL certificate has been created and processed.
	SSLCertificateStatusSuccess = SSLCertificateStatus("success")
	// An error occurred during the SSL certificate's creation.
	SSLCertificateStatusError = SSLCertificateStatus("error")
)
View Source 
const (
	// If unspecified, the status is unavailable by default.
	TaskStatusUnavailable = TaskStatus("unavailable")
	// The task has been created but it has not yet started.
	TaskStatusNew = TaskStatus("new")
	// The task is waiting for a payment to be validated.
	TaskStatusWaitingPayment = TaskStatus("waiting_payment")
	// The task is pending.
	TaskStatusPending = TaskStatus("pending")
	// The task has been completed.
	TaskStatusSuccess = TaskStatus("success")
	// The task is in an error state.
	TaskStatusError = TaskStatus("error")
)
View Source 
const (
	// If unspecified, the status is unknown by default.
	TaskTypeUnknown = TaskType("unknown")
	// Create a new internal domain.
	TaskTypeCreateDomain = TaskType("create_domain")
	// Create a new external domain.
	TaskTypeCreateExternalDomain = TaskType("create_external_domain")
	// Renew a domain.
	TaskTypeRenewDomain = TaskType("renew_domain")
	// Transfer a domain to Scaleway Domains and DNS.
	TaskTypeTransferDomain = TaskType("transfer_domain")
	// Trade a domain to a new owner.
	TaskTypeTradeDomain = TaskType("trade_domain")
	// Lock the transfer of a domain for protection.
	TaskTypeLockDomainTransfer = TaskType("lock_domain_transfer")
	// Unlock the transfer of a domain.
	TaskTypeUnlockDomainTransfer = TaskType("unlock_domain_transfer")
	// Enable DNSSEC for a domain.
	TaskTypeEnableDnssec = TaskType("enable_dnssec")
	// Disable DNSSEC for a domain.
	TaskTypeDisableDnssec = TaskType("disable_dnssec")
	// Update the domain's information.
	TaskTypeUpdateDomain = TaskType("update_domain")
	// Change the technical or administrative contact.
	TaskTypeUpdateContact = TaskType("update_contact")
	// Delete a domain and destroy its zone versions, zones, and SSL certificates.
	TaskTypeDeleteDomain = TaskType("delete_domain")
	// Cancel a task that has not yet started.
	TaskTypeCancelTask = TaskType("cancel_task")
	// Generate a new SSL certificate.
	TaskTypeGenerateSslCertificate = TaskType("generate_ssl_certificate")
	// Renew an SSL certificate.
	TaskTypeRenewSslCertificate = TaskType("renew_ssl_certificate")
	// Send a message. For most cases, it will be followed by an email.
	TaskTypeSendMessage = TaskType("send_message")
	// Delete a domain that has expired and not been restored for at least 3 months.
	TaskTypeDeleteDomainExpired = TaskType("delete_domain_expired")
	// Delete a newly registered external domain that has not been validated after 48 hours or when the external domain fails to point to our name servers for more than 14 days.
	TaskTypeDeleteExternalDomain = TaskType("delete_external_domain")
	// Create domain's hostname with glue IPs.
	TaskTypeCreateHost = TaskType("create_host")
	// Update domain's hostname with glue IPs.
	TaskTypeUpdateHost = TaskType("update_host")
	// Delete domain's hostname.
	TaskTypeDeleteHost = TaskType("delete_host")
	// Move a domain to another Project.
	TaskTypeMoveProject = TaskType("move_project")
	// Transfer a domain from Online to Scaleway Domains and DNS.
	TaskTypeTransferOnlineDomain = TaskType("transfer_online_domain")
)
View Source 
const (
	// ErrCodeNoSuchDNSZone for service response error code
	//
	// The specified dns zone does not exist.
	ErrCodeNoSuchDNSZone   = "NoSuchDNSZone"
	ErrCodeNoSuchDNSRecord = "NoSuchDNSRecord"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type API 

type API struct {
	// contains filtered or unexported fields
}

Manage your domains, DNS zones and records with the Domains and DNS API.

func NewAPI 

func NewAPI(client *scw.Client) *API

NewAPI returns a API object from a Scaleway client.

func (*API) ClearDNSZoneRecords 

func (s *API) ClearDNSZoneRecords(req *ClearDNSZoneRecordsRequest, opts ...scw.RequestOption) (*ClearDNSZoneRecordsResponse, error)

ClearDNSZoneRecords: Delete all records within a DNS zone that has default name servers.<br/> All edits will be versioned.

func (*API) CloneDNSZone 

func (s *API) CloneDNSZone(req *CloneDNSZoneRequest, opts ...scw.RequestOption) (*DNSZone, error)

CloneDNSZone: Clone an existing DNS zone with all its records into a new DNS zone.

func (*API) CreateDNSZone 

func (s *API) CreateDNSZone(req *CreateDNSZoneRequest, opts ...scw.RequestOption) (*DNSZone, error)

CreateDNSZone: Create a new DNS zone specified by the domain name, the subdomain and the Project ID.

func (*API) CreateSSLCertificate 

func (s *API) CreateSSLCertificate(req *CreateSSLCertificateRequest, opts ...scw.RequestOption) (*SSLCertificate, error)

CreateSSLCertificate: Create a new TLS certificate or retrieve information about an existing TLS certificate.

func (*API) DeleteDNSZone 

func (s *API) DeleteDNSZone(req *DeleteDNSZoneRequest, opts ...scw.RequestOption) (*DeleteDNSZoneResponse, error)

DeleteDNSZone: Delete a DNS zone and all its records.

func (*API) DeleteDNSZoneTsigKey 

func (s *API) DeleteDNSZoneTsigKey(req *DeleteDNSZoneTsigKeyRequest, opts ...scw.RequestOption) error

DeleteDNSZoneTsigKey: Delete an existing TSIG key specified by its DNS zone. Deleting a TSIG key is permanent and cannot be undone.

func (*API) DeleteSSLCertificate 

func (s *API) DeleteSSLCertificate(req *DeleteSSLCertificateRequest, opts ...scw.RequestOption) (*DeleteSSLCertificateResponse, error)

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

func (*API) ExportRawDNSZone 

func (s *API) ExportRawDNSZone(req *ExportRawDNSZoneRequest, opts ...scw.RequestOption) (*scw.File, error)

ExportRawDNSZone: Export a DNS zone with default name servers, in a specific format.

func (*API) GetDNSZoneTsigKey 

func (s *API) GetDNSZoneTsigKey(req *GetDNSZoneTsigKeyRequest, opts ...scw.RequestOption) (*GetDNSZoneTsigKeyResponse, error)

GetDNSZoneTsigKey: Retrieve information about the TSIG key of a given DNS zone to allow AXFR requests.

func (*API) GetDNSZoneVersionDiff 

func (s *API) GetDNSZoneVersionDiff(req *GetDNSZoneVersionDiffRequest, opts ...scw.RequestOption) (*GetDNSZoneVersionDiffResponse, error)

GetDNSZoneVersionDiff: Access a previous DNS zone version to see the differences from another specific version.

func (*API) GetSSLCertificate 

func (s *API) GetSSLCertificate(req *GetSSLCertificateRequest, opts ...scw.RequestOption) (*SSLCertificate, error)

GetSSLCertificate: Get the DNS zone's TLS certificate. If you do not have a certificate, the ouptut returns `no certificate found`.

func (*API) ImportProviderDNSZone 

func (s *API) ImportProviderDNSZone(req *ImportProviderDNSZoneRequest, opts ...scw.RequestOption) (*ImportProviderDNSZoneResponse, error)

ImportProviderDNSZone: Import and replace the format of records from a given provider, with default name servers.

func (*API) ImportRawDNSZone 

func (s *API) ImportRawDNSZone(req *ImportRawDNSZoneRequest, opts ...scw.RequestOption) (*ImportRawDNSZoneResponse, error)

ImportRawDNSZone: Import and replace the format of records from a given provider, with default name servers.

func (*API) ListDNSZoneNameservers 

func (s *API) ListDNSZoneNameservers(req *ListDNSZoneNameserversRequest, opts ...scw.RequestOption) (*ListDNSZoneNameserversResponse, error)

ListDNSZoneNameservers: Retrieve a list of name servers within a DNS zone and their optional glue records.

func (*API) ListDNSZoneRecords 

func (s *API) ListDNSZoneRecords(req *ListDNSZoneRecordsRequest, opts ...scw.RequestOption) (*ListDNSZoneRecordsResponse, error)

ListDNSZoneRecords: Retrieve a list of DNS records within a DNS zone that has default name servers. You can filter records by type and name.

func (*API) ListDNSZoneVersionRecords 

func (s *API) ListDNSZoneVersionRecords(req *ListDNSZoneVersionRecordsRequest, opts ...scw.RequestOption) (*ListDNSZoneVersionRecordsResponse, error)

ListDNSZoneVersionRecords: Retrieve a list of records from a specific DNS zone version.

func (*API) ListDNSZoneVersions 

func (s *API) ListDNSZoneVersions(req *ListDNSZoneVersionsRequest, opts ...scw.RequestOption) (*ListDNSZoneVersionsResponse, error)

ListDNSZoneVersions: Retrieve a list of a DNS zone's versions.<br/> The maximum version count is 100. If the count reaches this limit, the oldest version will be deleted after each new modification.

func (*API) ListDNSZones 

func (s *API) ListDNSZones(req *ListDNSZonesRequest, opts ...scw.RequestOption) (*ListDNSZonesResponse, error)

ListDNSZones: Retrieve the list of DNS zones you can manage and filter DNS zones associated with specific domain names.

func (*API) ListSSLCertificates 

func (s *API) ListSSLCertificates(req *ListSSLCertificatesRequest, opts ...scw.RequestOption) (*ListSSLCertificatesResponse, error)

ListSSLCertificates: List all the TLS certificates a user has created, specified by the user's Project ID and the DNS zone.

func (*API) RefreshDNSZone 

func (s *API) RefreshDNSZone(req *RefreshDNSZoneRequest, opts ...scw.RequestOption) (*RefreshDNSZoneResponse, error)

RefreshDNSZone: 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.

func (*API) RestoreDNSZoneVersion 

func (s *API) RestoreDNSZoneVersion(req *RestoreDNSZoneVersionRequest, opts ...scw.RequestOption) (*RestoreDNSZoneVersionResponse, error)

RestoreDNSZoneVersion: Restore and activate a version of a specific DNS zone.

func (*API) UpdateDNSZone 

func (s *API) UpdateDNSZone(req *UpdateDNSZoneRequest, opts ...scw.RequestOption) (*DNSZone, error)

UpdateDNSZone: Update the name and/or the Organizations for a DNS zone.

func (*API) UpdateDNSZoneNameservers 

func (s *API) UpdateDNSZoneNameservers(req *UpdateDNSZoneNameserversRequest, opts ...scw.RequestOption) (*UpdateDNSZoneNameserversResponse, error)

UpdateDNSZoneNameservers: Update name servers within a DNS zone and set optional glue records.

func (*API) UpdateDNSZoneRecords 

func (s *API) UpdateDNSZoneRecords(req *UpdateDNSZoneRecordsRequest, opts ...scw.RequestOption) (*UpdateDNSZoneRecordsResponse, error)

UpdateDNSZoneRecords: 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.

func (*API) WaitForDNSRecordExist 

func (s *API) WaitForDNSRecordExist(
	req *WaitForDNSRecordExistRequest,
	opts ...scw.RequestOption,
) (*Record, error)

func (*API) WaitForDNSZone 

func (s *API) WaitForDNSZone(
	req *WaitForDNSZoneRequest,
	opts ...scw.RequestOption,
) (*DNSZone, error)

type AvailableDomain 

type AvailableDomain struct {
	Domain string `json:"domain"`

	Available bool `json:"available"`

	Tld *Tld `json:"tld"`
}

AvailableDomain: available domain.

type CheckContactsCompatibilityResponse 

type CheckContactsCompatibilityResponse struct {
	Compatible bool `json:"compatible"`

	OwnerCheckResult *CheckContactsCompatibilityResponseContactCheckResult `json:"owner_check_result"`

	AdministrativeCheckResult *CheckContactsCompatibilityResponseContactCheckResult `json:"administrative_check_result"`

	TechnicalCheckResult *CheckContactsCompatibilityResponseContactCheckResult `json:"technical_check_result"`
}

CheckContactsCompatibilityResponse: check contacts compatibility response.

type CheckContactsCompatibilityResponseContactCheckResult 

type CheckContactsCompatibilityResponseContactCheckResult struct {
	Compatible bool `json:"compatible"`

	ErrorMessage *string `json:"error_message"`
}

CheckContactsCompatibilityResponseContactCheckResult: check contacts compatibility response contact check result.

type ClearDNSZoneRecordsRequest 

type ClearDNSZoneRecordsRequest struct {
	// DNSZone: DNS zone to clear.
	DNSZone string `json:"-"`
}

ClearDNSZoneRecordsRequest: clear dns zone records request.

type ClearDNSZoneRecordsResponse 

type ClearDNSZoneRecordsResponse struct {
}

ClearDNSZoneRecordsResponse: clear dns zone records response.

type CloneDNSZoneRequest 

type CloneDNSZoneRequest struct {
	// DNSZone: DNS zone to clone.
	DNSZone string `json:"-"`

	// DestDNSZone: destination DNS zone in which to clone the chosen DNS zone.
	DestDNSZone string `json:"dest_dns_zone"`

	// Overwrite: specifies whether or not the destination DNS zone will be overwritten.
	Overwrite bool `json:"overwrite"`

	// ProjectID: project ID of the destination DNS zone.
	ProjectID *string `json:"project_id,omitempty"`
}

CloneDNSZoneRequest: clone dns zone request.

type Contact 

type Contact struct {
	ID string `json:"id"`

	// LegalForm: default value: legal_form_unknown
	LegalForm ContactLegalForm `json:"legal_form"`

	Firstname string `json:"firstname"`

	Lastname string `json:"lastname"`

	CompanyName string `json:"company_name"`

	Email string `json:"email"`

	EmailAlt string `json:"email_alt"`

	PhoneNumber string `json:"phone_number"`

	FaxNumber string `json:"fax_number"`

	AddressLine1 string `json:"address_line_1"`

	AddressLine2 string `json:"address_line_2"`

	Zip string `json:"zip"`

	City string `json:"city"`

	Country string `json:"country"`

	VatIDentificationCode string `json:"vat_identification_code"`

	CompanyIDentificationCode string `json:"company_identification_code"`

	// Lang: default value: unknown_language_code
	Lang std.LanguageCode `json:"lang"`

	Resale bool `json:"resale"`

	// Deprecated
	Questions *[]*ContactQuestion `json:"questions,omitempty"`

	ExtensionFr *ContactExtensionFR `json:"extension_fr"`

	ExtensionEu *ContactExtensionEU `json:"extension_eu"`

	WhoisOptIn bool `json:"whois_opt_in"`

	// EmailStatus: default value: email_status_unknown
	EmailStatus ContactEmailStatus `json:"email_status"`

	State string `json:"state"`

	ExtensionNl *ContactExtensionNL `json:"extension_nl"`

	// Status: default value: status_unknown
	Status ContactStatus `json:"status"`
}

Contact: contact.

type ContactEmailStatus 

type ContactEmailStatus string

func (ContactEmailStatus) MarshalJSON 

func (enum ContactEmailStatus) MarshalJSON() ([]byte, error)

func (ContactEmailStatus) String 

func (enum ContactEmailStatus) String() string

func (*ContactEmailStatus) UnmarshalJSON 

func (enum *ContactEmailStatus) UnmarshalJSON(data []byte) error

type ContactExtensionEU 

type ContactExtensionEU struct {
	EuropeanCitizenship string `json:"european_citizenship"`
}

ContactExtensionEU: contact extension eu.

type ContactExtensionFR 

type ContactExtensionFR struct {
	// Mode: default value: mode_unknown
	Mode ContactExtensionFRMode `json:"mode"`

	// Precisely one of IndividualInfo, DunsInfo, AssociationInfo, TrademarkInfo, CodeAuthAfnicInfo must be set.
	IndividualInfo *ContactExtensionFRIndividualInfo `json:"individual_info,omitempty"`

	// Precisely one of IndividualInfo, DunsInfo, AssociationInfo, TrademarkInfo, CodeAuthAfnicInfo must be set.
	DunsInfo *ContactExtensionFRDunsInfo `json:"duns_info,omitempty"`

	// Precisely one of IndividualInfo, DunsInfo, AssociationInfo, TrademarkInfo, CodeAuthAfnicInfo must be set.
	AssociationInfo *ContactExtensionFRAssociationInfo `json:"association_info,omitempty"`

	// Precisely one of IndividualInfo, DunsInfo, AssociationInfo, TrademarkInfo, CodeAuthAfnicInfo must be set.
	TrademarkInfo *ContactExtensionFRTrademarkInfo `json:"trademark_info,omitempty"`

	// Precisely one of IndividualInfo, DunsInfo, AssociationInfo, TrademarkInfo, CodeAuthAfnicInfo must be set.
	CodeAuthAfnicInfo *ContactExtensionFRCodeAuthAfnicInfo `json:"code_auth_afnic_info,omitempty"`
}

ContactExtensionFR: contact extension fr.

type ContactExtensionFRAssociationInfo 

type ContactExtensionFRAssociationInfo struct {
	PublicationJo *time.Time `json:"publication_jo"`

	PublicationJoPage uint32 `json:"publication_jo_page"`
}

ContactExtensionFRAssociationInfo: contact extension fr association info.

type ContactExtensionFRCodeAuthAfnicInfo 

type ContactExtensionFRCodeAuthAfnicInfo struct {
	CodeAuthAfnic string `json:"code_auth_afnic"`
}

ContactExtensionFRCodeAuthAfnicInfo: contact extension fr code auth afnic info.

type ContactExtensionFRDunsInfo 

type ContactExtensionFRDunsInfo struct {
	DunsID string `json:"duns_id"`

	LocalID string `json:"local_id"`
}

ContactExtensionFRDunsInfo: contact extension fr duns info.

type ContactExtensionFRIndividualInfo 

type ContactExtensionFRIndividualInfo struct {
	WhoisOptIn bool `json:"whois_opt_in"`
}

ContactExtensionFRIndividualInfo: contact extension fr individual info.

type ContactExtensionFRMode 

type ContactExtensionFRMode string

func (ContactExtensionFRMode) MarshalJSON 

func (enum ContactExtensionFRMode) MarshalJSON() ([]byte, error)

func (ContactExtensionFRMode) String 

func (enum ContactExtensionFRMode) String() string

func (*ContactExtensionFRMode) UnmarshalJSON 

func (enum *ContactExtensionFRMode) UnmarshalJSON(data []byte) error

type ContactExtensionFRTrademarkInfo 

type ContactExtensionFRTrademarkInfo struct {
	TrademarkInpi string `json:"trademark_inpi"`
}

ContactExtensionFRTrademarkInfo: contact extension fr trademark info.

type ContactExtensionNL 

type ContactExtensionNL struct {
	// LegalForm: default value: legal_form_unknown
	LegalForm ContactExtensionNLLegalForm `json:"legal_form"`

	LegalFormRegistrationNumber string `json:"legal_form_registration_number"`
}

ContactExtensionNL: contact extension nl.

type ContactExtensionNLLegalForm 

type ContactExtensionNLLegalForm string

func (ContactExtensionNLLegalForm) MarshalJSON 

func (enum ContactExtensionNLLegalForm) MarshalJSON() ([]byte, error)

func (ContactExtensionNLLegalForm) String 

func (enum ContactExtensionNLLegalForm) String() string

func (*ContactExtensionNLLegalForm) UnmarshalJSON 

func (enum *ContactExtensionNLLegalForm) UnmarshalJSON(data []byte) error

type ContactLegalForm 

type ContactLegalForm string

func (ContactLegalForm) MarshalJSON 

func (enum ContactLegalForm) MarshalJSON() ([]byte, error)

func (ContactLegalForm) String 

func (enum ContactLegalForm) String() string

func (*ContactLegalForm) UnmarshalJSON 

func (enum *ContactLegalForm) UnmarshalJSON(data []byte) error

type ContactQuestion 

type ContactQuestion struct {
	Question string `json:"question"`

	Answer string `json:"answer"`
}

ContactQuestion: contact question.

type ContactRoles 

type ContactRoles struct {
	Contact *Contact `json:"contact"`

	Roles map[string]*ContactRolesRoles `json:"roles"`
}

ContactRoles: contact roles.

type ContactRolesRoles 

type ContactRolesRoles struct {
	IsOwner bool `json:"is_owner"`

	IsAdministrative bool `json:"is_administrative"`

	IsTechnical bool `json:"is_technical"`
}

ContactRolesRoles: contact roles roles.

type ContactStatus 

type ContactStatus string

func (ContactStatus) MarshalJSON 

func (enum ContactStatus) MarshalJSON() ([]byte, error)

func (ContactStatus) String 

func (enum ContactStatus) String() string

func (*ContactStatus) UnmarshalJSON 

func (enum *ContactStatus) UnmarshalJSON(data []byte) error

type CreateDNSZoneRequest 

type CreateDNSZoneRequest struct {
	// Domain: domain in which to crreate the DNS zone.
	Domain string `json:"domain"`

	// Subdomain: subdomain of the DNS zone to create.
	Subdomain string `json:"subdomain"`

	// ProjectID: project ID in which to create the DNS zone.
	ProjectID string `json:"project_id"`
}

CreateDNSZoneRequest: create dns zone request.

type CreateSSLCertificateRequest 

type CreateSSLCertificateRequest struct {
	DNSZone string `json:"dns_zone"`

	AlternativeDNSZones []string `json:"alternative_dns_zones"`
}

CreateSSLCertificateRequest: create ssl certificate request.

type DNSZone 

type DNSZone struct {
	Domain string `json:"domain"`

	Subdomain string `json:"subdomain"`

	Ns []string `json:"ns"`

	NsDefault []string `json:"ns_default"`

	NsMaster []string `json:"ns_master"`

	// Status: default value: unknown
	Status DNSZoneStatus `json:"status"`

	Message *string `json:"message"`

	UpdatedAt *time.Time `json:"updated_at"`

	ProjectID string `json:"project_id"`

	LinkedProducts []LinkedProduct `json:"linked_products"`
}

DNSZone: dns zone.

type DNSZoneStatus 

type DNSZoneStatus string

func (DNSZoneStatus) MarshalJSON 

func (enum DNSZoneStatus) MarshalJSON() ([]byte, error)

func (DNSZoneStatus) String 

func (enum DNSZoneStatus) String() string

func (*DNSZoneStatus) UnmarshalJSON 

func (enum *DNSZoneStatus) UnmarshalJSON(data []byte) error

type DNSZoneVersion 

type DNSZoneVersion struct {
	ID string `json:"id"`

	CreatedAt *time.Time `json:"created_at"`
}

DNSZoneVersion: dns zone version.

type DSRecord 

type DSRecord struct {
	KeyID uint32 `json:"key_id"`

	// Algorithm: default value: rsamd5
	Algorithm DSRecordAlgorithm `json:"algorithm"`

	// Precisely one of Digest, PublicKey must be set.
	Digest *DSRecordDigest `json:"digest,omitempty"`

	// Precisely one of Digest, PublicKey must be set.
	PublicKey *DSRecordPublicKey `json:"public_key,omitempty"`
}

DSRecord: ds record.

type DSRecordAlgorithm 

type DSRecordAlgorithm string

func (DSRecordAlgorithm) MarshalJSON 

func (enum DSRecordAlgorithm) MarshalJSON() ([]byte, error)

func (DSRecordAlgorithm) String 

func (enum DSRecordAlgorithm) String() string

func (*DSRecordAlgorithm) UnmarshalJSON 

func (enum *DSRecordAlgorithm) UnmarshalJSON(data []byte) error

type DSRecordDigest 

type DSRecordDigest struct {
	// Type: default value: sha_1
	Type DSRecordDigestType `json:"type"`

	Digest string `json:"digest"`

	PublicKey *DSRecordPublicKey `json:"public_key"`
}

DSRecordDigest: ds record digest.

type DSRecordDigestType 

type DSRecordDigestType string

func (DSRecordDigestType) MarshalJSON 

func (enum DSRecordDigestType) MarshalJSON() ([]byte, error)

func (DSRecordDigestType) String 

func (enum DSRecordDigestType) String() string

func (*DSRecordDigestType) UnmarshalJSON 

func (enum *DSRecordDigestType) UnmarshalJSON(data []byte) error

type DSRecordPublicKey 

type DSRecordPublicKey struct {
	Key string `json:"key"`
}

DSRecordPublicKey: ds record public key.

type DeleteDNSZoneRequest 

type DeleteDNSZoneRequest struct {
	// DNSZone: DNS zone to delete.
	DNSZone string `json:"-"`

	// ProjectID: project ID of the DNS zone to delete.
	ProjectID string `json:"-"`
}

DeleteDNSZoneRequest: delete dns zone request.

type DeleteDNSZoneResponse 

type DeleteDNSZoneResponse struct {
}

DeleteDNSZoneResponse: delete dns zone response.

type DeleteDNSZoneTsigKeyRequest 

type DeleteDNSZoneTsigKeyRequest struct {
	DNSZone string `json:"-"`
}

DeleteDNSZoneTsigKeyRequest: delete dns zone tsig key request.

type DeleteExternalDomainResponse 

type DeleteExternalDomainResponse struct {
}

DeleteExternalDomainResponse: delete external domain response.

type DeleteSSLCertificateRequest 

type DeleteSSLCertificateRequest struct {
	DNSZone string `json:"-"`
}

DeleteSSLCertificateRequest: delete ssl certificate request.

type DeleteSSLCertificateResponse 

type DeleteSSLCertificateResponse struct {
}

DeleteSSLCertificateResponse: delete ssl certificate response.

type Domain 

type Domain struct {
	Domain string `json:"domain"`

	OrganizationID string `json:"organization_id"`

	ProjectID string `json:"project_id"`

	// AutoRenewStatus: status of the automatic renewal of the domain.
	// Default value: feature_status_unknown
	AutoRenewStatus DomainFeatureStatus `json:"auto_renew_status"`

	// Dnssec: status of the DNSSEC configuration of the domain.
	Dnssec *DomainDNSSEC `json:"dnssec"`

	// EppCode: list of the domain's EPP codes.
	EppCode []string `json:"epp_code"`

	// ExpiredAt: date of expiration of the domain.
	ExpiredAt *time.Time `json:"expired_at"`

	// UpdatedAt: domain's last modification date.
	UpdatedAt *time.Time `json:"updated_at"`

	Registrar string `json:"registrar"`

	// IsExternal: indicates whether Scaleway is the domain's registrar.
	IsExternal bool `json:"is_external"`

	// Status: status of the domain.
	// Default value: status_unknown
	Status DomainStatus `json:"status"`

	// DNSZones: list of the domain's DNS zones.
	DNSZones []*DNSZone `json:"dns_zones"`

	// OwnerContact: contact information of the domain's owner.
	OwnerContact *Contact `json:"owner_contact"`

	// TechnicalContact: contact information of the domain's technical contact.
	TechnicalContact *Contact `json:"technical_contact"`

	// AdministrativeContact: contact information of the domain's administrative contact.
	AdministrativeContact *Contact `json:"administrative_contact"`

	// ExternalDomainRegistrationStatus: registration status of an external domain, if available.
	// Precisely one of ExternalDomainRegistrationStatus, TransferRegistrationStatus must be set.
	ExternalDomainRegistrationStatus *DomainRegistrationStatusExternalDomain `json:"external_domain_registration_status,omitempty"`

	// TransferRegistrationStatus: status of a domain, when available for transfer.
	// Precisely one of ExternalDomainRegistrationStatus, TransferRegistrationStatus must be set.
	TransferRegistrationStatus *DomainRegistrationStatusTransfer `json:"transfer_registration_status,omitempty"`

	// Tld: domain's TLD information.
	Tld *Tld `json:"tld"`

	// LinkedProducts: list of Scaleway resources linked to the domain.
	LinkedProducts []LinkedProduct `json:"linked_products"`

	// PendingTrade: indicates if a trade is ongoing.
	PendingTrade bool `json:"pending_trade"`
}

Domain: domain.

type DomainDNSSEC 

type DomainDNSSEC struct {
	// Status: default value: feature_status_unknown
	Status DomainFeatureStatus `json:"status"`

	DsRecords []*DSRecord `json:"ds_records"`
}

DomainDNSSEC: domain dnssec.

type DomainFeatureStatus 

type DomainFeatureStatus string

func (DomainFeatureStatus) MarshalJSON 

func (enum DomainFeatureStatus) MarshalJSON() ([]byte, error)

func (DomainFeatureStatus) String 

func (enum DomainFeatureStatus) String() string

func (*DomainFeatureStatus) UnmarshalJSON 

func (enum *DomainFeatureStatus) UnmarshalJSON(data []byte) error

type DomainRegistrationStatusExternalDomain 

type DomainRegistrationStatusExternalDomain struct {
	ValidationToken string `json:"validation_token"`
}

DomainRegistrationStatusExternalDomain: domain registration status external domain.

type DomainRegistrationStatusTransfer 

type DomainRegistrationStatusTransfer struct {
	// Status: default value: status_unknown
	Status DomainRegistrationStatusTransferStatus `json:"status"`

	VoteCurrentOwner bool `json:"vote_current_owner"`

	VoteNewOwner bool `json:"vote_new_owner"`
}

DomainRegistrationStatusTransfer: domain registration status transfer.

type DomainRegistrationStatusTransferStatus 

type DomainRegistrationStatusTransferStatus string

func (DomainRegistrationStatusTransferStatus) MarshalJSON 

func (enum DomainRegistrationStatusTransferStatus) MarshalJSON() ([]byte, error)

func (DomainRegistrationStatusTransferStatus) String 

func (enum DomainRegistrationStatusTransferStatus) String() string

func (*DomainRegistrationStatusTransferStatus) UnmarshalJSON 

func (enum *DomainRegistrationStatusTransferStatus) UnmarshalJSON(data []byte) error

type DomainStatus 

type DomainStatus string

func (DomainStatus) MarshalJSON 

func (enum DomainStatus) MarshalJSON() ([]byte, error)

func (DomainStatus) String 

func (enum DomainStatus) String() string

func (*DomainStatus) UnmarshalJSON 

func (enum *DomainStatus) UnmarshalJSON(data []byte) error

type DomainSummary 

type DomainSummary struct {
	Domain string `json:"domain"`

	ProjectID string `json:"project_id"`

	// AutoRenewStatus: default value: feature_status_unknown
	AutoRenewStatus DomainFeatureStatus `json:"auto_renew_status"`

	// DnssecStatus: default value: feature_status_unknown
	DnssecStatus DomainFeatureStatus `json:"dnssec_status"`

	EppCode []string `json:"epp_code"`

	ExpiredAt *time.Time `json:"expired_at"`

	UpdatedAt *time.Time `json:"updated_at"`

	Registrar string `json:"registrar"`

	IsExternal bool `json:"is_external"`

	// Status: default value: status_unknown
	Status DomainStatus `json:"status"`

	// Precisely one of ExternalDomainRegistrationStatus, TransferRegistrationStatus must be set.
	ExternalDomainRegistrationStatus *DomainRegistrationStatusExternalDomain `json:"external_domain_registration_status,omitempty"`

	// Precisely one of ExternalDomainRegistrationStatus, TransferRegistrationStatus must be set.
	TransferRegistrationStatus *DomainRegistrationStatusTransfer `json:"transfer_registration_status,omitempty"`

	OrganizationID string `json:"organization_id"`

	CreatedAt *time.Time `json:"created_at"`

	PendingTrade bool `json:"pending_trade"`
}

DomainSummary: domain summary.

type ExportRawDNSZoneRequest 

type ExportRawDNSZoneRequest struct {
	// DNSZone: DNS zone to export.
	DNSZone string `json:"-"`

	// Format: DNS zone format.
	// Default value: unknown_raw_format
	Format RawFormat `json:"-"`
}

ExportRawDNSZoneRequest: export raw dns zone request.

type GetDNSZoneTsigKeyRequest 

type GetDNSZoneTsigKeyRequest struct {
	DNSZone string `json:"-"`
}

GetDNSZoneTsigKeyRequest: get dns zone tsig key request.

type GetDNSZoneTsigKeyResponse 

type GetDNSZoneTsigKeyResponse struct {
	Name string `json:"name"`

	Key string `json:"key"`

	Algorithm string `json:"algorithm"`
}

GetDNSZoneTsigKeyResponse: get dns zone tsig key response.

type GetDNSZoneVersionDiffRequest 

type GetDNSZoneVersionDiffRequest struct {
	DNSZoneVersionID string `json:"-"`
}

GetDNSZoneVersionDiffRequest: get dns zone version diff request.

type GetDNSZoneVersionDiffResponse 

type GetDNSZoneVersionDiffResponse struct {
	Changes []*RecordChange `json:"changes"`
}

GetDNSZoneVersionDiffResponse: get dns zone version diff response.

type GetDomainAuthCodeResponse 

type GetDomainAuthCodeResponse struct {
	AuthCode string `json:"auth_code"`
}

GetDomainAuthCodeResponse: get domain auth code response.

type GetSSLCertificateRequest 

type GetSSLCertificateRequest struct {
	DNSZone string `json:"-"`
}

GetSSLCertificateRequest: get ssl certificate request.

type Host 

type Host struct {
	Domain string `json:"domain"`

	Name string `json:"name"`

	IPs []net.IP `json:"ips"`

	// Status: default value: unknown_status
	Status HostStatus `json:"status"`
}

Host: host.

type HostStatus 

type HostStatus string

func (HostStatus) MarshalJSON 

func (enum HostStatus) MarshalJSON() ([]byte, error)

func (HostStatus) String 

func (enum HostStatus) String() string

func (*HostStatus) UnmarshalJSON 

func (enum *HostStatus) UnmarshalJSON(data []byte) error

type ImportProviderDNSZoneRequest 

type ImportProviderDNSZoneRequest struct {
	DNSZone string `json:"-"`

	// Precisely one of OnlineV1 must be set.
	OnlineV1 *ImportProviderDNSZoneRequestOnlineV1 `json:"online_v1,omitempty"`
}

ImportProviderDNSZoneRequest: import provider dns zone request.

type ImportProviderDNSZoneRequestOnlineV1 

type ImportProviderDNSZoneRequestOnlineV1 struct {
	Token string `json:"token"`
}

ImportProviderDNSZoneRequestOnlineV1: import provider dns zone request online v1.

type ImportProviderDNSZoneResponse 

type ImportProviderDNSZoneResponse struct {
	Records []*Record `json:"records"`
}

ImportProviderDNSZoneResponse: import provider dns zone response.

type ImportRawDNSZoneRequest 

type ImportRawDNSZoneRequest struct {
	// DNSZone: DNS zone to import.
	DNSZone string `json:"-"`

	// Deprecated
	Content *string `json:"content,omitempty"`

	ProjectID string `json:"project_id"`

	// Deprecated: Format: default value: unknown_raw_format
	Format *RawFormat `json:"format,omitempty"`

	// BindSource: import a bind file format.
	// Precisely one of BindSource, AxfrSource must be set.
	BindSource *ImportRawDNSZoneRequestBindSource `json:"bind_source,omitempty"`

	// AxfrSource: import from the name server given with TSIG, to use or not.
	// Precisely one of BindSource, AxfrSource must be set.
	AxfrSource *ImportRawDNSZoneRequestAXFRSource `json:"axfr_source,omitempty"`
}

ImportRawDNSZoneRequest: import raw dns zone request.

type ImportRawDNSZoneRequestAXFRSource 

type ImportRawDNSZoneRequestAXFRSource struct {
	NameServer string `json:"name_server"`

	TsigKey *ImportRawDNSZoneRequestTsigKey `json:"tsig_key"`
}

ImportRawDNSZoneRequestAXFRSource: import raw dns zone request axfr source.

type ImportRawDNSZoneRequestBindSource 

type ImportRawDNSZoneRequestBindSource struct {
	Content string `json:"content"`
}

ImportRawDNSZoneRequestBindSource: import raw dns zone request bind source.

type ImportRawDNSZoneRequestTsigKey 

type ImportRawDNSZoneRequestTsigKey struct {
	Name string `json:"name"`

	Key string `json:"key"`

	Algorithm string `json:"algorithm"`
}

ImportRawDNSZoneRequestTsigKey: import raw dns zone request tsig key.

type ImportRawDNSZoneResponse 

type ImportRawDNSZoneResponse struct {
	Records []*Record `json:"records"`
}

ImportRawDNSZoneResponse: import raw dns zone response.

type LinkedProduct 

type LinkedProduct string

func (LinkedProduct) MarshalJSON 

func (enum LinkedProduct) MarshalJSON() ([]byte, error)

func (LinkedProduct) String 

func (enum LinkedProduct) String() string

func (*LinkedProduct) UnmarshalJSON 

func (enum *LinkedProduct) UnmarshalJSON(data []byte) error

type ListContactsRequestRole 

type ListContactsRequestRole string

func (ListContactsRequestRole) MarshalJSON 

func (enum ListContactsRequestRole) MarshalJSON() ([]byte, error)

func (ListContactsRequestRole) String 

func (enum ListContactsRequestRole) String() string

func (*ListContactsRequestRole) UnmarshalJSON 

func (enum *ListContactsRequestRole) UnmarshalJSON(data []byte) error

type ListContactsResponse 

type ListContactsResponse struct {
	TotalCount uint32 `json:"total_count"`

	Contacts []*ContactRoles `json:"contacts"`
}

ListContactsResponse: list contacts response.

func (*ListContactsResponse) UnsafeAppend 

func (r *ListContactsResponse) UnsafeAppend(res interface{}) (uint32, error)

UnsafeAppend should not be used Internal usage only

func (*ListContactsResponse) UnsafeGetTotalCount 

func (r *ListContactsResponse) UnsafeGetTotalCount() uint32

UnsafeGetTotalCount should not be used Internal usage only

type ListDNSZoneNameserversRequest 

type ListDNSZoneNameserversRequest struct {
	// DNSZone: DNS zone on which to filter the returned DNS zone name servers.
	DNSZone string `json:"-"`

	// ProjectID: project ID on which to filter the returned DNS zone name servers.
	ProjectID *string `json:"-"`
}

ListDNSZoneNameserversRequest: list dns zone nameservers request.

type ListDNSZoneNameserversResponse 

type ListDNSZoneNameserversResponse struct {
	// Ns: DNS zone name servers returned.
	Ns []*Nameserver `json:"ns"`
}

ListDNSZoneNameserversResponse: list dns zone nameservers response.

type ListDNSZoneRecordsRequest 

type ListDNSZoneRecordsRequest struct {
	// DNSZone: DNS zone on which to filter the returned DNS zone records.
	DNSZone string `json:"-"`

	// ProjectID: project ID on which to filter the returned DNS zone records.
	ProjectID *string `json:"-"`

	// OrderBy: sort order of the returned DNS zone records.
	// Default value: name_asc
	OrderBy ListDNSZoneRecordsRequestOrderBy `json:"-"`

	// Page: page number to return, from the paginated results.
	Page *int32 `json:"-"`

	// PageSize: maximum number of DNS zone records per page.
	PageSize *uint32 `json:"-"`

	// Name: name on which to filter the returned DNS zone records.
	Name string `json:"-"`

	// Type: record type on which to filter the returned DNS zone records.
	// Default value: unknown
	Type RecordType `json:"-"`

	// ID: record ID on which to filter the returned DNS zone records.
	ID *string `json:"-"`
}

ListDNSZoneRecordsRequest: list dns zone records request.

type ListDNSZoneRecordsRequestOrderBy 

type ListDNSZoneRecordsRequestOrderBy string

func (ListDNSZoneRecordsRequestOrderBy) MarshalJSON 

func (enum ListDNSZoneRecordsRequestOrderBy) MarshalJSON() ([]byte, error)

func (ListDNSZoneRecordsRequestOrderBy) String 

func (enum ListDNSZoneRecordsRequestOrderBy) String() string

func (*ListDNSZoneRecordsRequestOrderBy) UnmarshalJSON 

func (enum *ListDNSZoneRecordsRequestOrderBy) UnmarshalJSON(data []byte) error

type ListDNSZoneRecordsResponse 

type ListDNSZoneRecordsResponse struct {
	// TotalCount: total number of DNS zone records.
	TotalCount uint32 `json:"total_count"`

	// Records: paginated returned DNS zone records.
	Records []*Record `json:"records"`
}

ListDNSZoneRecordsResponse: list dns zone records response.

func (*ListDNSZoneRecordsResponse) UnsafeAppend 

func (r *ListDNSZoneRecordsResponse) UnsafeAppend(res interface{}) (uint32, error)

UnsafeAppend should not be used Internal usage only

func (*ListDNSZoneRecordsResponse) UnsafeGetTotalCount 

func (r *ListDNSZoneRecordsResponse) UnsafeGetTotalCount() uint32

UnsafeGetTotalCount should not be used Internal usage only

type ListDNSZoneVersionRecordsRequest 

type ListDNSZoneVersionRecordsRequest struct {
	DNSZoneVersionID string `json:"-"`

	// Page: page number to return, from the paginated results.
	Page *int32 `json:"-"`

	// PageSize: maximum number of DNS zones versions records per page.
	PageSize *uint32 `json:"-"`
}

ListDNSZoneVersionRecordsRequest: list dns zone version records request.

type ListDNSZoneVersionRecordsResponse 

type ListDNSZoneVersionRecordsResponse struct {
	// TotalCount: total number of DNS zones versions records.
	TotalCount uint32 `json:"total_count"`

	Records []*Record `json:"records"`
}

ListDNSZoneVersionRecordsResponse: list dns zone version records response.

func (*ListDNSZoneVersionRecordsResponse) UnsafeAppend 

func (r *ListDNSZoneVersionRecordsResponse) UnsafeAppend(res interface{}) (uint32, error)

UnsafeAppend should not be used Internal usage only

func (*ListDNSZoneVersionRecordsResponse) UnsafeGetTotalCount 

func (r *ListDNSZoneVersionRecordsResponse) UnsafeGetTotalCount() uint32

UnsafeGetTotalCount should not be used Internal usage only

type ListDNSZoneVersionsRequest 

type ListDNSZoneVersionsRequest struct {
	DNSZone string `json:"-"`

	// Page: page number to return, from the paginated results.
	Page *int32 `json:"-"`

	// PageSize: maximum number of DNS zones versions per page.
	PageSize *uint32 `json:"-"`
}

ListDNSZoneVersionsRequest: list dns zone versions request.

type ListDNSZoneVersionsResponse 

type ListDNSZoneVersionsResponse struct {
	// TotalCount: total number of DNS zones versions.
	TotalCount uint32 `json:"total_count"`

	Versions []*DNSZoneVersion `json:"versions"`
}

ListDNSZoneVersionsResponse: list dns zone versions response.

func (*ListDNSZoneVersionsResponse) UnsafeAppend 

func (r *ListDNSZoneVersionsResponse) UnsafeAppend(res interface{}) (uint32, error)

UnsafeAppend should not be used Internal usage only

func (*ListDNSZoneVersionsResponse) UnsafeGetTotalCount 

func (r *ListDNSZoneVersionsResponse) UnsafeGetTotalCount() uint32

UnsafeGetTotalCount should not be used Internal usage only

type ListDNSZonesRequest 

type ListDNSZonesRequest struct {
	// OrganizationID: organization ID on which to filter the returned DNS zones.
	OrganizationID *string `json:"-"`

	// ProjectID: project ID on which to filter the returned DNS zones.
	ProjectID *string `json:"-"`

	// OrderBy: sort order of the returned DNS zones.
	// Default value: domain_asc
	OrderBy ListDNSZonesRequestOrderBy `json:"-"`

	// Page: page number to return, from the paginated results.
	Page *int32 `json:"-"`

	// PageSize: maximum number of DNS zones to return per page.
	PageSize *uint32 `json:"-"`

	// Domain: domain on which to filter the returned DNS zones.
	Domain string `json:"-"`

	// Deprecated: DNSZone: DNS zone on which to filter the returned DNS zones.
	DNSZone *string `json:"-"`

	// DNSZones: DNS zones on which to filter the returned DNS zones.
	DNSZones []string `json:"-"`

	// CreatedAfter: only list DNS zones created after this date.
	CreatedAfter *time.Time `json:"-"`

	// CreatedBefore: only list DNS zones created before this date.
	CreatedBefore *time.Time `json:"-"`

	// UpdatedAfter: only list DNS zones updated after this date.
	UpdatedAfter *time.Time `json:"-"`

	// UpdatedBefore: only list DNS zones updated before this date.
	UpdatedBefore *time.Time `json:"-"`
}

ListDNSZonesRequest: list dns zones request.

type ListDNSZonesRequestOrderBy 

type ListDNSZonesRequestOrderBy string

func (ListDNSZonesRequestOrderBy) MarshalJSON 

func (enum ListDNSZonesRequestOrderBy) MarshalJSON() ([]byte, error)

func (ListDNSZonesRequestOrderBy) String 

func (enum ListDNSZonesRequestOrderBy) String() string

func (*ListDNSZonesRequestOrderBy) UnmarshalJSON 

func (enum *ListDNSZonesRequestOrderBy) UnmarshalJSON(data []byte) error

type ListDNSZonesResponse 

type ListDNSZonesResponse struct {
	// TotalCount: total number of DNS zones matching the requested criteria.
	TotalCount uint32 `json:"total_count"`

	// DNSZones: paginated returned DNS zones.
	DNSZones []*DNSZone `json:"dns_zones"`
}

ListDNSZonesResponse: list dns zones response.

func (*ListDNSZonesResponse) UnsafeAppend 

func (r *ListDNSZonesResponse) UnsafeAppend(res interface{}) (uint32, error)

UnsafeAppend should not be used Internal usage only

func (*ListDNSZonesResponse) UnsafeGetTotalCount 

func (r *ListDNSZonesResponse) UnsafeGetTotalCount() uint32

UnsafeGetTotalCount should not be used Internal usage only

type ListDomainHostsResponse 

type ListDomainHostsResponse struct {
	TotalCount uint32 `json:"total_count"`

	Hosts []*Host `json:"hosts"`
}

ListDomainHostsResponse: list domain hosts response.

func (*ListDomainHostsResponse) UnsafeAppend 

func (r *ListDomainHostsResponse) UnsafeAppend(res interface{}) (uint32, error)

UnsafeAppend should not be used Internal usage only

func (*ListDomainHostsResponse) UnsafeGetTotalCount 

func (r *ListDomainHostsResponse) UnsafeGetTotalCount() uint32

UnsafeGetTotalCount should not be used Internal usage only

type ListDomainsRequestOrderBy 

type ListDomainsRequestOrderBy string

func (ListDomainsRequestOrderBy) MarshalJSON 

func (enum ListDomainsRequestOrderBy) MarshalJSON() ([]byte, error)

func (ListDomainsRequestOrderBy) String 

func (enum ListDomainsRequestOrderBy) String() string

func (*ListDomainsRequestOrderBy) UnmarshalJSON 

func (enum *ListDomainsRequestOrderBy) UnmarshalJSON(data []byte) error

type ListDomainsResponse 

type ListDomainsResponse struct {
	TotalCount uint32 `json:"total_count"`

	Domains []*DomainSummary `json:"domains"`
}

ListDomainsResponse: list domains response.

func (*ListDomainsResponse) UnsafeAppend 

func (r *ListDomainsResponse) UnsafeAppend(res interface{}) (uint32, error)

UnsafeAppend should not be used Internal usage only

func (*ListDomainsResponse) UnsafeGetTotalCount 

func (r *ListDomainsResponse) UnsafeGetTotalCount() uint32

UnsafeGetTotalCount should not be used Internal usage only

type ListRenewableDomainsRequestOrderBy 

type ListRenewableDomainsRequestOrderBy string

func (ListRenewableDomainsRequestOrderBy) MarshalJSON 

func (enum ListRenewableDomainsRequestOrderBy) MarshalJSON() ([]byte, error)

func (ListRenewableDomainsRequestOrderBy) String 

func (enum ListRenewableDomainsRequestOrderBy) String() string

func (*ListRenewableDomainsRequestOrderBy) UnmarshalJSON 

func (enum *ListRenewableDomainsRequestOrderBy) UnmarshalJSON(data []byte) error

type ListRenewableDomainsResponse 

type ListRenewableDomainsResponse struct {
	TotalCount uint32 `json:"total_count"`

	Domains []*RenewableDomain `json:"domains"`
}

ListRenewableDomainsResponse: list renewable domains response.

func (*ListRenewableDomainsResponse) UnsafeAppend 

func (r *ListRenewableDomainsResponse) UnsafeAppend(res interface{}) (uint32, error)

UnsafeAppend should not be used Internal usage only

func (*ListRenewableDomainsResponse) UnsafeGetTotalCount 

func (r *ListRenewableDomainsResponse) UnsafeGetTotalCount() uint32

UnsafeGetTotalCount should not be used Internal usage only

type ListSSLCertificatesRequest 

type ListSSLCertificatesRequest struct {
	DNSZone string `json:"-"`

	Page *int32 `json:"-"`

	PageSize *uint32 `json:"-"`

	ProjectID *string `json:"-"`
}

ListSSLCertificatesRequest: list ssl certificates request.

type ListSSLCertificatesResponse 

type ListSSLCertificatesResponse struct {
	TotalCount uint32 `json:"total_count"`

	Certificates []*SSLCertificate `json:"certificates"`
}

ListSSLCertificatesResponse: list ssl certificates response.

func (*ListSSLCertificatesResponse) UnsafeAppend 

func (r *ListSSLCertificatesResponse) UnsafeAppend(res interface{}) (uint32, error)

UnsafeAppend should not be used Internal usage only

func (*ListSSLCertificatesResponse) UnsafeGetTotalCount 

func (r *ListSSLCertificatesResponse) UnsafeGetTotalCount() uint32

UnsafeGetTotalCount should not be used Internal usage only

type ListTasksRequestOrderBy 

type ListTasksRequestOrderBy string

func (ListTasksRequestOrderBy) MarshalJSON 

func (enum ListTasksRequestOrderBy) MarshalJSON() ([]byte, error)

func (ListTasksRequestOrderBy) String 

func (enum ListTasksRequestOrderBy) String() string

func (*ListTasksRequestOrderBy) UnmarshalJSON 

func (enum *ListTasksRequestOrderBy) UnmarshalJSON(data []byte) error

type ListTasksResponse 

type ListTasksResponse struct {
	TotalCount uint32 `json:"total_count"`

	Tasks []*Task `json:"tasks"`
}

ListTasksResponse: list tasks response.

func (*ListTasksResponse) UnsafeAppend 

func (r *ListTasksResponse) UnsafeAppend(res interface{}) (uint32, error)

UnsafeAppend should not be used Internal usage only

func (*ListTasksResponse) UnsafeGetTotalCount 

func (r *ListTasksResponse) UnsafeGetTotalCount() uint32

UnsafeGetTotalCount should not be used Internal usage only

type ListTldsRequestOrderBy 

type ListTldsRequestOrderBy string

func (ListTldsRequestOrderBy) MarshalJSON 

func (enum ListTldsRequestOrderBy) MarshalJSON() ([]byte, error)

func (ListTldsRequestOrderBy) String 

func (enum ListTldsRequestOrderBy) String() string

func (*ListTldsRequestOrderBy) UnmarshalJSON 

func (enum *ListTldsRequestOrderBy) UnmarshalJSON(data []byte) error

type ListTldsResponse 

type ListTldsResponse struct {
	// Tlds: array of TLDs.
	Tlds []*Tld `json:"tlds"`

	// TotalCount: total count of TLDs returned.
	TotalCount uint64 `json:"total_count"`
}

ListTldsResponse: list tlds response.

func (*ListTldsResponse) UnsafeAppend 

func (r *ListTldsResponse) UnsafeAppend(res interface{}) (uint64, error)

UnsafeAppend should not be used Internal usage only

func (*ListTldsResponse) UnsafeGetTotalCount 

func (r *ListTldsResponse) UnsafeGetTotalCount() uint64

UnsafeGetTotalCount should not be used Internal usage only

type Nameserver 

type Nameserver struct {
	Name string `json:"name"`

	IP []string `json:"ip"`
}

Nameserver: nameserver.

type NewContact 

type NewContact struct {
	// LegalForm: default value: legal_form_unknown
	LegalForm ContactLegalForm `json:"legal_form"`

	Firstname string `json:"firstname"`

	Lastname string `json:"lastname"`

	CompanyName *string `json:"company_name"`

	Email string `json:"email"`

	EmailAlt *string `json:"email_alt"`

	PhoneNumber string `json:"phone_number"`

	FaxNumber *string `json:"fax_number"`

	AddressLine1 string `json:"address_line_1"`

	AddressLine2 *string `json:"address_line_2"`

	Zip string `json:"zip"`

	City string `json:"city"`

	Country string `json:"country"`

	VatIDentificationCode *string `json:"vat_identification_code"`

	CompanyIDentificationCode *string `json:"company_identification_code"`

	// Lang: default value: unknown_language_code
	Lang std.LanguageCode `json:"lang"`

	Resale bool `json:"resale"`

	// Deprecated
	Questions *[]*ContactQuestion `json:"questions,omitempty"`

	ExtensionFr *ContactExtensionFR `json:"extension_fr"`

	ExtensionEu *ContactExtensionEU `json:"extension_eu"`

	WhoisOptIn bool `json:"whois_opt_in"`

	State *string `json:"state"`

	ExtensionNl *ContactExtensionNL `json:"extension_nl"`
}

NewContact: new contact.

type OrderResponse 

type OrderResponse struct {
	Domains []string `json:"domains"`

	OrganizationID string `json:"organization_id"`

	ProjectID string `json:"project_id"`

	TaskID string `json:"task_id"`

	CreatedAt *time.Time `json:"created_at"`
}

OrderResponse: order response.

type RawFormat 

type RawFormat string

func (RawFormat) MarshalJSON 

func (enum RawFormat) MarshalJSON() ([]byte, error)

func (RawFormat) String 

func (enum RawFormat) String() string

func (*RawFormat) UnmarshalJSON 

func (enum *RawFormat) UnmarshalJSON(data []byte) error

type Record 

type Record struct {
	Data string `json:"data"`

	Name string `json:"name"`

	Priority uint32 `json:"priority"`

	TTL uint32 `json:"ttl"`

	// Type: default value: unknown
	Type RecordType `json:"type"`

	Comment *string `json:"comment"`

	// Precisely one of GeoIPConfig, HTTPServiceConfig, WeightedConfig, ViewConfig must be set.
	GeoIPConfig *RecordGeoIPConfig `json:"geo_ip_config,omitempty"`

	// Precisely one of GeoIPConfig, HTTPServiceConfig, WeightedConfig, ViewConfig must be set.
	HTTPServiceConfig *RecordHTTPServiceConfig `json:"http_service_config,omitempty"`

	// Precisely one of GeoIPConfig, HTTPServiceConfig, WeightedConfig, ViewConfig must be set.
	WeightedConfig *RecordWeightedConfig `json:"weighted_config,omitempty"`

	// Precisely one of GeoIPConfig, HTTPServiceConfig, WeightedConfig, ViewConfig must be set.
	ViewConfig *RecordViewConfig `json:"view_config,omitempty"`

	ID string `json:"id"`
}

Record: record.

type RecordChange 

type RecordChange struct {
	// Precisely one of Add, Set, Delete, Clear must be set.
	Add *RecordChangeAdd `json:"add,omitempty"`

	// Precisely one of Add, Set, Delete, Clear must be set.
	Set *RecordChangeSet `json:"set,omitempty"`

	// Precisely one of Add, Set, Delete, Clear must be set.
	Delete *RecordChangeDelete `json:"delete,omitempty"`

	// Precisely one of Add, Set, Delete, Clear must be set.
	Clear *RecordChangeClear `json:"clear,omitempty"`
}

RecordChange: record change.

type RecordChangeAdd 

type RecordChangeAdd struct {
	Records []*Record `json:"records"`
}

RecordChangeAdd: record change add.

type RecordChangeClear 

type RecordChangeClear struct {
}

RecordChangeClear: record change clear.

type RecordChangeDelete 

type RecordChangeDelete struct {
	// Precisely one of ID, IDFields must be set.
	ID *string `json:"id,omitempty"`

	// Precisely one of ID, IDFields must be set.
	IDFields *RecordIdentifier `json:"id_fields,omitempty"`
}

RecordChangeDelete: record change delete.

type RecordChangeSet 

type RecordChangeSet struct {
	// Precisely one of ID, IDFields must be set.
	ID *string `json:"id,omitempty"`

	// Precisely one of ID, IDFields must be set.
	IDFields *RecordIdentifier `json:"id_fields,omitempty"`

	Records []*Record `json:"records"`
}

RecordChangeSet: record change set.

type RecordGeoIPConfig 

type RecordGeoIPConfig struct {
	Matches []*RecordGeoIPConfigMatch `json:"matches"`

	Default string `json:"default"`
}

RecordGeoIPConfig: record geo ip config.

type RecordGeoIPConfigMatch 

type RecordGeoIPConfigMatch struct {
	Countries []string `json:"countries"`

	Continents []string `json:"continents"`

	Data string `json:"data"`
}

RecordGeoIPConfigMatch: record geo ip config match.

type RecordHTTPServiceConfig 

type RecordHTTPServiceConfig struct {
	IPs []net.IP `json:"ips"`

	MustContain *string `json:"must_contain"`

	URL string `json:"url"`

	UserAgent *string `json:"user_agent"`

	// Strategy: default value: random
	Strategy RecordHTTPServiceConfigStrategy `json:"strategy"`
}

RecordHTTPServiceConfig: record http service config.

type RecordHTTPServiceConfigStrategy 

type RecordHTTPServiceConfigStrategy string

func (RecordHTTPServiceConfigStrategy) MarshalJSON 

func (enum RecordHTTPServiceConfigStrategy) MarshalJSON() ([]byte, error)

func (RecordHTTPServiceConfigStrategy) String 

func (enum RecordHTTPServiceConfigStrategy) String() string

func (*RecordHTTPServiceConfigStrategy) UnmarshalJSON 

func (enum *RecordHTTPServiceConfigStrategy) UnmarshalJSON(data []byte) error

type RecordIdentifier 

type RecordIdentifier struct {
	Name string `json:"name"`

	// Type: default value: unknown
	Type RecordType `json:"type"`

	Data *string `json:"data"`

	TTL *uint32 `json:"ttl"`
}

RecordIdentifier: record identifier.

type RecordType 

type RecordType string

func (RecordType) MarshalJSON 

func (enum RecordType) MarshalJSON() ([]byte, error)

func (RecordType) String 

func (enum RecordType) String() string

func (*RecordType) UnmarshalJSON 

func (enum *RecordType) UnmarshalJSON(data []byte) error

type RecordViewConfig 

type RecordViewConfig struct {
	Views []*RecordViewConfigView `json:"views"`
}

RecordViewConfig: record view config.

type RecordViewConfigView 

type RecordViewConfigView struct {
	Subnet string `json:"subnet"`

	Data string `json:"data"`
}

RecordViewConfigView: record view config view.

type RecordWeightedConfig 

type RecordWeightedConfig struct {
	WeightedIPs []*RecordWeightedConfigWeightedIP `json:"weighted_ips"`
}

RecordWeightedConfig: record weighted config.

type RecordWeightedConfigWeightedIP 

type RecordWeightedConfigWeightedIP struct {
	IP net.IP `json:"ip"`

	Weight uint32 `json:"weight"`
}

RecordWeightedConfigWeightedIP: record weighted config weighted ip.

type RefreshDNSZoneRequest 

type RefreshDNSZoneRequest struct {
	// DNSZone: DNS zone to refresh.
	DNSZone string `json:"-"`

	// RecreateDNSZone: specifies whether or not to recreate the DNS zone.
	RecreateDNSZone bool `json:"recreate_dns_zone"`

	// RecreateSubDNSZone: specifies whether or not to recreate the sub DNS zone.
	RecreateSubDNSZone bool `json:"recreate_sub_dns_zone"`
}

RefreshDNSZoneRequest: refresh dns zone request.

type RefreshDNSZoneResponse 

type RefreshDNSZoneResponse struct {
	// DNSZones: DNS zones returned.
	DNSZones []*DNSZone `json:"dns_zones"`
}

RefreshDNSZoneResponse: refresh dns zone response.

type RegisterExternalDomainResponse 

type RegisterExternalDomainResponse struct {
	Domain string `json:"domain"`

	OrganizationID string `json:"organization_id"`

	ValidationToken string `json:"validation_token"`

	CreatedAt *time.Time `json:"created_at"`

	ProjectID string `json:"project_id"`
}

RegisterExternalDomainResponse: register external domain response.

type RegistrarAPI 

type RegistrarAPI struct {
	// contains filtered or unexported fields
}

Manage your domains and contacts.

func NewRegistrarAPI 

func NewRegistrarAPI(client *scw.Client) *RegistrarAPI

NewRegistrarAPI returns a RegistrarAPI object from a Scaleway client.

func (*RegistrarAPI) BuyDomains 

func (s *RegistrarAPI) BuyDomains(req *RegistrarAPIBuyDomainsRequest, opts ...scw.RequestOption) (*OrderResponse, error)

BuyDomains: Request the registration of domain names. You can provide a domain's already existing contact or a new contact.

func (*RegistrarAPI) CheckContactsCompatibility 

func (s *RegistrarAPI) CheckContactsCompatibility(req *RegistrarAPICheckContactsCompatibilityRequest, opts ...scw.RequestOption) (*CheckContactsCompatibilityResponse, error)

CheckContactsCompatibility: 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.

func (*RegistrarAPI) CreateDomainHost 

func (s *RegistrarAPI) CreateDomainHost(req *RegistrarAPICreateDomainHostRequest, opts ...scw.RequestOption) (*Host, error)

CreateDomainHost: Create a hostname for a domain with glue IPs.

func (*RegistrarAPI) DeleteDomainHost 

func (s *RegistrarAPI) DeleteDomainHost(req *RegistrarAPIDeleteDomainHostRequest, opts ...scw.RequestOption) (*Host, error)

DeleteDomainHost: Delete a domain's hostname.

func (*RegistrarAPI) DeleteExternalDomain 

func (s *RegistrarAPI) DeleteExternalDomain(req *RegistrarAPIDeleteExternalDomainRequest, opts ...scw.RequestOption) (*DeleteExternalDomainResponse, error)

DeleteExternalDomain: Delete an external domain name.

func (*RegistrarAPI) DisableDomainAutoRenew 

func (s *RegistrarAPI) DisableDomainAutoRenew(req *RegistrarAPIDisableDomainAutoRenewRequest, opts ...scw.RequestOption) (*Domain, error)

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

func (*RegistrarAPI) DisableDomainDNSSEC 

func (s *RegistrarAPI) DisableDomainDNSSEC(req *RegistrarAPIDisableDomainDNSSECRequest, opts ...scw.RequestOption) (*Domain, error)

DisableDomainDNSSEC: Disable DNSSEC for a domain.

func (*RegistrarAPI) EnableDomainAutoRenew 

func (s *RegistrarAPI) EnableDomainAutoRenew(req *RegistrarAPIEnableDomainAutoRenewRequest, opts ...scw.RequestOption) (*Domain, error)

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

func (*RegistrarAPI) EnableDomainDNSSEC 

func (s *RegistrarAPI) EnableDomainDNSSEC(req *RegistrarAPIEnableDomainDNSSECRequest, opts ...scw.RequestOption) (*Domain, error)

EnableDomainDNSSEC: If your domain has the default Scaleway NS and uses another registrar, you have to update the DS record manually.

func (*RegistrarAPI) GetContact 

func (s *RegistrarAPI) GetContact(req *RegistrarAPIGetContactRequest, opts ...scw.RequestOption) (*Contact, error)

GetContact: Retrieve a contact's details from the registrar using the given contact's ID.

func (*RegistrarAPI) GetDomain 

func (s *RegistrarAPI) GetDomain(req *RegistrarAPIGetDomainRequest, opts ...scw.RequestOption) (*Domain, error)

GetDomain: Retrieve a specific domain and display the domain's information.

func (*RegistrarAPI) GetDomainAuthCode 

func (s *RegistrarAPI) GetDomainAuthCode(req *RegistrarAPIGetDomainAuthCodeRequest, opts ...scw.RequestOption) (*GetDomainAuthCodeResponse, error)

GetDomainAuthCode: 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.

func (*RegistrarAPI) ListContacts 

func (s *RegistrarAPI) ListContacts(req *RegistrarAPIListContactsRequest, opts ...scw.RequestOption) (*ListContactsResponse, error)

ListContacts: Retrieve the list of contacts and their associated domains and roles. You can filter the list by domain name.

func (*RegistrarAPI) ListDomainHosts 

func (s *RegistrarAPI) ListDomainHosts(req *RegistrarAPIListDomainHostsRequest, opts ...scw.RequestOption) (*ListDomainHostsResponse, error)

ListDomainHosts: List a domain's hostnames using their glue IPs.

func (*RegistrarAPI) ListDomains 

func (s *RegistrarAPI) ListDomains(req *RegistrarAPIListDomainsRequest, opts ...scw.RequestOption) (*ListDomainsResponse, error)

ListDomains: Retrieve the list of domains you own.

func (*RegistrarAPI) ListRenewableDomains 

func (s *RegistrarAPI) ListRenewableDomains(req *RegistrarAPIListRenewableDomainsRequest, opts ...scw.RequestOption) (*ListRenewableDomainsResponse, error)

ListRenewableDomains: 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.

func (*RegistrarAPI) ListTasks 

func (s *RegistrarAPI) ListTasks(req *RegistrarAPIListTasksRequest, opts ...scw.RequestOption) (*ListTasksResponse, error)

ListTasks: List all operations performed on the account. You can filter the list of tasks by domain name.

func (*RegistrarAPI) ListTlds 

func (s *RegistrarAPI) ListTlds(req *RegistrarAPIListTldsRequest, opts ...scw.RequestOption) (*ListTldsResponse, error)

ListTlds: Retrieve the list of TLDs and offers associated with them.

func (*RegistrarAPI) LockDomainTransfer 

func (s *RegistrarAPI) LockDomainTransfer(req *RegistrarAPILockDomainTransferRequest, opts ...scw.RequestOption) (*Domain, error)

LockDomainTransfer: 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.

func (*RegistrarAPI) RegisterExternalDomain 

func (s *RegistrarAPI) RegisterExternalDomain(req *RegistrarAPIRegisterExternalDomainRequest, opts ...scw.RequestOption) (*RegisterExternalDomainResponse, error)

RegisterExternalDomain: Request the registration of an external domain name.

func (*RegistrarAPI) RenewDomains 

func (s *RegistrarAPI) RenewDomains(req *RegistrarAPIRenewDomainsRequest, opts ...scw.RequestOption) (*OrderResponse, error)

RenewDomains: Request the renewal of one or more domain names.

func (*RegistrarAPI) SearchAvailableDomains 

func (s *RegistrarAPI) SearchAvailableDomains(req *RegistrarAPISearchAvailableDomainsRequest, opts ...scw.RequestOption) (*SearchAvailableDomainsResponse, error)

SearchAvailableDomains: 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.

func (*RegistrarAPI) TradeDomain 

func (s *RegistrarAPI) TradeDomain(req *RegistrarAPITradeDomainRequest, opts ...scw.RequestOption) (*OrderResponse, error)

TradeDomain: Request to change a domain's contact owner.<br/> 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.<br/> 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.<br/> If the new owner has never created a contact to register domains before, an error message displays.

func (*RegistrarAPI) TransferInDomain 

func (s *RegistrarAPI) TransferInDomain(req *RegistrarAPITransferInDomainRequest, opts ...scw.RequestOption) (*OrderResponse, error)

TransferInDomain: Request the transfer of a domain from another registrar to Scaleway Domains and DNS.

func (*RegistrarAPI) UnlockDomainTransfer 

func (s *RegistrarAPI) UnlockDomainTransfer(req *RegistrarAPIUnlockDomainTransferRequest, opts ...scw.RequestOption) (*Domain, error)

UnlockDomainTransfer: 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.

func (*RegistrarAPI) UpdateContact 

func (s *RegistrarAPI) UpdateContact(req *RegistrarAPIUpdateContactRequest, opts ...scw.RequestOption) (*Contact, error)

UpdateContact: Edit the contact's information.

func (*RegistrarAPI) UpdateDomain 

func (s *RegistrarAPI) UpdateDomain(req *RegistrarAPIUpdateDomainRequest, opts ...scw.RequestOption) (*Domain, error)

UpdateDomain: Update contacts for a specific domain or create a new contact.<br/> 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.

func (*RegistrarAPI) UpdateDomainHost 

func (s *RegistrarAPI) UpdateDomainHost(req *RegistrarAPIUpdateDomainHostRequest, opts ...scw.RequestOption) (*Host, error)

UpdateDomainHost: Update a domain's hostname with glue IPs.

type RegistrarAPIBuyDomainsRequest 

type RegistrarAPIBuyDomainsRequest struct {
	Domains []string `json:"domains"`

	DurationInYears uint32 `json:"duration_in_years"`

	ProjectID string `json:"project_id"`

	// Precisely one of OwnerContactID, OwnerContact must be set.
	OwnerContactID *string `json:"owner_contact_id,omitempty"`

	// Precisely one of OwnerContactID, OwnerContact must be set.
	OwnerContact *NewContact `json:"owner_contact,omitempty"`

	// Precisely one of AdministrativeContactID, AdministrativeContact must be set.
	AdministrativeContactID *string `json:"administrative_contact_id,omitempty"`

	// Precisely one of AdministrativeContactID, AdministrativeContact must be set.
	AdministrativeContact *NewContact `json:"administrative_contact,omitempty"`

	// Precisely one of TechnicalContactID, TechnicalContact must be set.
	TechnicalContactID *string `json:"technical_contact_id,omitempty"`

	// Precisely one of TechnicalContactID, TechnicalContact must be set.
	TechnicalContact *NewContact `json:"technical_contact,omitempty"`
}

RegistrarAPIBuyDomainsRequest: registrar api buy domains request.

type RegistrarAPICheckContactsCompatibilityRequest 

type RegistrarAPICheckContactsCompatibilityRequest struct {
	Domains []string `json:"domains"`

	Tlds []string `json:"tlds"`

	// Precisely one of OwnerContactID, OwnerContact must be set.
	OwnerContactID *string `json:"owner_contact_id,omitempty"`

	// Precisely one of OwnerContactID, OwnerContact must be set.
	OwnerContact *NewContact `json:"owner_contact,omitempty"`

	// Precisely one of AdministrativeContactID, AdministrativeContact must be set.
	AdministrativeContactID *string `json:"administrative_contact_id,omitempty"`

	// Precisely one of AdministrativeContactID, AdministrativeContact must be set.
	AdministrativeContact *NewContact `json:"administrative_contact,omitempty"`

	// Precisely one of TechnicalContactID, TechnicalContact must be set.
	TechnicalContactID *string `json:"technical_contact_id,omitempty"`

	// Precisely one of TechnicalContactID, TechnicalContact must be set.
	TechnicalContact *NewContact `json:"technical_contact,omitempty"`
}

RegistrarAPICheckContactsCompatibilityRequest: registrar api check contacts compatibility request.

type RegistrarAPICreateDomainHostRequest 

type RegistrarAPICreateDomainHostRequest struct {
	Domain string `json:"-"`

	Name string `json:"name"`

	IPs []net.IP `json:"ips"`
}

RegistrarAPICreateDomainHostRequest: registrar api create domain host request.

type RegistrarAPIDeleteDomainHostRequest 

type RegistrarAPIDeleteDomainHostRequest struct {
	Domain string `json:"-"`

	Name string `json:"-"`
}

RegistrarAPIDeleteDomainHostRequest: registrar api delete domain host request.

type RegistrarAPIDeleteExternalDomainRequest 

type RegistrarAPIDeleteExternalDomainRequest struct {
	Domain string `json:"-"`
}

RegistrarAPIDeleteExternalDomainRequest: registrar api delete external domain request.

type RegistrarAPIDisableDomainAutoRenewRequest 

type RegistrarAPIDisableDomainAutoRenewRequest struct {
	Domain string `json:"-"`
}

RegistrarAPIDisableDomainAutoRenewRequest: registrar api disable domain auto renew request.

type RegistrarAPIDisableDomainDNSSECRequest 

type RegistrarAPIDisableDomainDNSSECRequest struct {
	Domain string `json:"-"`
}

RegistrarAPIDisableDomainDNSSECRequest: registrar api disable domain dnssec request.

type RegistrarAPIEnableDomainAutoRenewRequest 

type RegistrarAPIEnableDomainAutoRenewRequest struct {
	Domain string `json:"-"`
}

RegistrarAPIEnableDomainAutoRenewRequest: registrar api enable domain auto renew request.

type RegistrarAPIEnableDomainDNSSECRequest 

type RegistrarAPIEnableDomainDNSSECRequest struct {
	Domain string `json:"-"`

	DsRecord *DSRecord `json:"ds_record,omitempty"`
}

RegistrarAPIEnableDomainDNSSECRequest: registrar api enable domain dnssec request.

type RegistrarAPIGetContactRequest 

type RegistrarAPIGetContactRequest struct {
	ContactID string `json:"-"`
}

RegistrarAPIGetContactRequest: registrar api get contact request.

type RegistrarAPIGetDomainAuthCodeRequest 

type RegistrarAPIGetDomainAuthCodeRequest struct {
	Domain string `json:"-"`
}

RegistrarAPIGetDomainAuthCodeRequest: registrar api get domain auth code request.

type RegistrarAPIGetDomainRequest 

type RegistrarAPIGetDomainRequest struct {
	Domain string `json:"-"`
}

RegistrarAPIGetDomainRequest: registrar api get domain request.

type RegistrarAPIListContactsRequest 

type RegistrarAPIListContactsRequest struct {
	Page *int32 `json:"-"`

	PageSize *uint32 `json:"-"`

	Domain *string `json:"-"`

	ProjectID *string `json:"-"`

	OrganizationID *string `json:"-"`

	// Role: default value: unknown_role
	Role ListContactsRequestRole `json:"-"`

	// EmailStatus: default value: email_status_unknown
	EmailStatus ContactEmailStatus `json:"-"`
}

RegistrarAPIListContactsRequest: registrar api list contacts request.

type RegistrarAPIListDomainHostsRequest 

type RegistrarAPIListDomainHostsRequest struct {
	Domain string `json:"-"`

	Page *int32 `json:"-"`

	PageSize *uint32 `json:"-"`
}

RegistrarAPIListDomainHostsRequest: registrar api list domain hosts request.

type RegistrarAPIListDomainsRequest 

type RegistrarAPIListDomainsRequest struct {
	Page *int32 `json:"-"`

	PageSize *uint32 `json:"-"`

	// OrderBy: default value: domain_asc
	OrderBy ListDomainsRequestOrderBy `json:"-"`

	Registrar *string `json:"-"`

	// Status: default value: status_unknown
	Status DomainStatus `json:"-"`

	ProjectID *string `json:"-"`

	OrganizationID *string `json:"-"`

	IsExternal *bool `json:"-"`

	Domain *string `json:"-"`
}

RegistrarAPIListDomainsRequest: registrar api list domains request.

type RegistrarAPIListRenewableDomainsRequest 

type RegistrarAPIListRenewableDomainsRequest struct {
	Page *int32 `json:"-"`

	PageSize *uint32 `json:"-"`

	// OrderBy: default value: domain_asc
	OrderBy ListRenewableDomainsRequestOrderBy `json:"-"`

	ProjectID *string `json:"-"`

	OrganizationID *string `json:"-"`
}

RegistrarAPIListRenewableDomainsRequest: registrar api list renewable domains request.

type RegistrarAPIListTasksRequest 

type RegistrarAPIListTasksRequest struct {
	Page *int32 `json:"-"`

	PageSize *uint32 `json:"-"`

	ProjectID *string `json:"-"`

	OrganizationID *string `json:"-"`

	Domain *string `json:"-"`

	Types []TaskType `json:"-"`

	Statuses []TaskStatus `json:"-"`

	// OrderBy: default value: domain_desc
	OrderBy ListTasksRequestOrderBy `json:"-"`
}

RegistrarAPIListTasksRequest: registrar api list tasks request.

type RegistrarAPIListTldsRequest 

type RegistrarAPIListTldsRequest struct {
	// Tlds: array of TLDs to return.
	Tlds []string `json:"-"`

	// Page: page number for the returned Projects.
	Page *int32 `json:"-"`

	// PageSize: maximum number of Project per page.
	PageSize *uint32 `json:"-"`

	// OrderBy: sort order of the returned TLDs.
	// Default value: name_asc
	OrderBy ListTldsRequestOrderBy `json:"-"`
}

RegistrarAPIListTldsRequest: registrar api list tlds request.

type RegistrarAPILockDomainTransferRequest 

type RegistrarAPILockDomainTransferRequest struct {
	Domain string `json:"-"`
}

RegistrarAPILockDomainTransferRequest: registrar api lock domain transfer request.

type RegistrarAPIRegisterExternalDomainRequest 

type RegistrarAPIRegisterExternalDomainRequest struct {
	Domain string `json:"domain"`

	ProjectID string `json:"project_id"`
}

RegistrarAPIRegisterExternalDomainRequest: registrar api register external domain request.

type RegistrarAPIRenewDomainsRequest 

type RegistrarAPIRenewDomainsRequest struct {
	Domains []string `json:"domains"`

	DurationInYears uint32 `json:"duration_in_years"`

	ForceLateRenewal *bool `json:"force_late_renewal,omitempty"`
}

RegistrarAPIRenewDomainsRequest: registrar api renew domains request.

type RegistrarAPISearchAvailableDomainsRequest 

type RegistrarAPISearchAvailableDomainsRequest struct {
	// Domains: a list of domain to search, TLD is optional.
	Domains []string `json:"-"`

	// Tlds: array of tlds to search on.
	Tlds []string `json:"-"`

	// StrictSearch: search exact match.
	StrictSearch bool `json:"-"`
}

RegistrarAPISearchAvailableDomainsRequest: registrar api search available domains request.

type RegistrarAPITradeDomainRequest 

type RegistrarAPITradeDomainRequest struct {
	Domain string `json:"-"`

	ProjectID *string `json:"project_id,omitempty"`

	// Precisely one of NewOwnerContactID, NewOwnerContact must be set.
	NewOwnerContactID *string `json:"new_owner_contact_id,omitempty"`

	// Precisely one of NewOwnerContactID, NewOwnerContact must be set.
	NewOwnerContact *NewContact `json:"new_owner_contact,omitempty"`
}

RegistrarAPITradeDomainRequest: registrar api trade domain request.

type RegistrarAPITransferInDomainRequest 

type RegistrarAPITransferInDomainRequest struct {
	Domains []*TransferInDomainRequestTransferRequest `json:"domains"`

	ProjectID string `json:"project_id"`

	// Precisely one of OwnerContactID, OwnerContact must be set.
	OwnerContactID *string `json:"owner_contact_id,omitempty"`

	// Precisely one of OwnerContactID, OwnerContact must be set.
	OwnerContact *NewContact `json:"owner_contact,omitempty"`

	// Precisely one of AdministrativeContactID, AdministrativeContact must be set.
	AdministrativeContactID *string `json:"administrative_contact_id,omitempty"`

	// Precisely one of AdministrativeContactID, AdministrativeContact must be set.
	AdministrativeContact *NewContact `json:"administrative_contact,omitempty"`

	// Precisely one of TechnicalContactID, TechnicalContact must be set.
	TechnicalContactID *string `json:"technical_contact_id,omitempty"`

	// Precisely one of TechnicalContactID, TechnicalContact must be set.
	TechnicalContact *NewContact `json:"technical_contact,omitempty"`
}

RegistrarAPITransferInDomainRequest: registrar api transfer in domain request.

type RegistrarAPIUnlockDomainTransferRequest 

type RegistrarAPIUnlockDomainTransferRequest struct {
	Domain string `json:"-"`
}

RegistrarAPIUnlockDomainTransferRequest: registrar api unlock domain transfer request.

type RegistrarAPIUpdateContactRequest 

type RegistrarAPIUpdateContactRequest struct {
	ContactID string `json:"-"`

	Email *string `json:"email,omitempty"`

	EmailAlt *string `json:"email_alt,omitempty"`

	PhoneNumber *string `json:"phone_number,omitempty"`

	FaxNumber *string `json:"fax_number,omitempty"`

	AddressLine1 *string `json:"address_line_1,omitempty"`

	AddressLine2 *string `json:"address_line_2,omitempty"`

	Zip *string `json:"zip,omitempty"`

	City *string `json:"city,omitempty"`

	Country *string `json:"country,omitempty"`

	VatIDentificationCode *string `json:"vat_identification_code,omitempty"`

	CompanyIDentificationCode *string `json:"company_identification_code,omitempty"`

	// Lang: default value: unknown_language_code
	Lang std.LanguageCode `json:"lang"`

	Resale *bool `json:"resale,omitempty"`

	// Deprecated
	Questions *[]*UpdateContactRequestQuestion `json:"questions,omitempty"`

	ExtensionFr *ContactExtensionFR `json:"extension_fr,omitempty"`

	ExtensionEu *ContactExtensionEU `json:"extension_eu,omitempty"`

	WhoisOptIn *bool `json:"whois_opt_in,omitempty"`

	State *string `json:"state,omitempty"`

	ExtensionNl *ContactExtensionNL `json:"extension_nl,omitempty"`
}

RegistrarAPIUpdateContactRequest: registrar api update contact request.

type RegistrarAPIUpdateDomainHostRequest 

type RegistrarAPIUpdateDomainHostRequest struct {
	Domain string `json:"-"`

	Name string `json:"-"`

	IPs *[]string `json:"ips,omitempty"`
}

RegistrarAPIUpdateDomainHostRequest: registrar api update domain host request.

type RegistrarAPIUpdateDomainRequest 

type RegistrarAPIUpdateDomainRequest struct {
	Domain string `json:"-"`

	// Precisely one of TechnicalContactID, TechnicalContact must be set.
	TechnicalContactID *string `json:"technical_contact_id,omitempty"`

	// Precisely one of TechnicalContactID, TechnicalContact must be set.
	TechnicalContact *NewContact `json:"technical_contact,omitempty"`

	// Deprecated
	// Precisely one of OwnerContactID, OwnerContact must be set.
	OwnerContactID *string `json:"owner_contact_id,omitempty"`

	// Deprecated
	// Precisely one of OwnerContactID, OwnerContact must be set.
	OwnerContact *NewContact `json:"owner_contact,omitempty"`

	// Precisely one of AdministrativeContactID, AdministrativeContact must be set.
	AdministrativeContactID *string `json:"administrative_contact_id,omitempty"`

	// Precisely one of AdministrativeContactID, AdministrativeContact must be set.
	AdministrativeContact *NewContact `json:"administrative_contact,omitempty"`
}

RegistrarAPIUpdateDomainRequest: registrar api update domain request.

type RenewableDomain 

type RenewableDomain struct {
	Domain string `json:"domain"`

	ProjectID string `json:"project_id"`

	OrganizationID string `json:"organization_id"`

	// Status: default value: unknown
	Status RenewableDomainStatus `json:"status"`

	RenewableDurationInYears *int32 `json:"renewable_duration_in_years"`

	ExpiredAt *time.Time `json:"expired_at"`

	LimitRenewAt *time.Time `json:"limit_renew_at"`

	LimitRedemptionAt *time.Time `json:"limit_redemption_at"`

	EstimatedDeleteAt *time.Time `json:"estimated_delete_at"`

	Tld *Tld `json:"tld"`
}

RenewableDomain: renewable domain.

type RenewableDomainStatus 

type RenewableDomainStatus string

func (RenewableDomainStatus) MarshalJSON 

func (enum RenewableDomainStatus) MarshalJSON() ([]byte, error)

func (RenewableDomainStatus) String 

func (enum RenewableDomainStatus) String() string

func (*RenewableDomainStatus) UnmarshalJSON 

func (enum *RenewableDomainStatus) UnmarshalJSON(data []byte) error

type RestoreDNSZoneVersionRequest 

type RestoreDNSZoneVersionRequest struct {
	DNSZoneVersionID string `json:"-"`
}

RestoreDNSZoneVersionRequest: restore dns zone version request.

type RestoreDNSZoneVersionResponse 

type RestoreDNSZoneVersionResponse struct {
}

RestoreDNSZoneVersionResponse: restore dns zone version response.

type SSLCertificate 

type SSLCertificate struct {
	DNSZone string `json:"dns_zone"`

	AlternativeDNSZones []string `json:"alternative_dns_zones"`

	// Status: default value: unknown
	Status SSLCertificateStatus `json:"status"`

	PrivateKey string `json:"private_key"`

	CertificateChain string `json:"certificate_chain"`

	CreatedAt *time.Time `json:"created_at"`

	ExpiredAt *time.Time `json:"expired_at"`
}

SSLCertificate: ssl certificate.

type SSLCertificateStatus 

type SSLCertificateStatus string

func (SSLCertificateStatus) MarshalJSON 

func (enum SSLCertificateStatus) MarshalJSON() ([]byte, error)

func (SSLCertificateStatus) String 

func (enum SSLCertificateStatus) String() string

func (*SSLCertificateStatus) UnmarshalJSON 

func (enum *SSLCertificateStatus) UnmarshalJSON(data []byte) error

type SearchAvailableDomainsResponse 

type SearchAvailableDomainsResponse struct {
	// AvailableDomains: array of available domains.
	AvailableDomains []*AvailableDomain `json:"available_domains"`
}

SearchAvailableDomainsResponse: search available domains response.

type Task 

type Task struct {
	// ID: the unique identifier of the task.
	ID string `json:"id"`

	// ProjectID: the project ID associated to the task.
	ProjectID string `json:"project_id"`

	// OrganizationID: the organization ID associated to the task.
	OrganizationID string `json:"organization_id"`

	// Domain: the domain name associated to the task.
	Domain *string `json:"domain"`

	// Type: the type of the task.
	// Default value: unknown
	Type TaskType `json:"type"`

	// Status: the status of the task.
	// Default value: unavailable
	Status TaskStatus `json:"status"`

	// StartedAt: start date of the task.
	StartedAt *time.Time `json:"started_at"`

	// UpdatedAt: last update of the task.
	UpdatedAt *time.Time `json:"updated_at"`

	// Message: error message associated to the task.
	Message *string `json:"message"`

	// ContactIDentifier: human-friendly contact identifier used when the task concerns a contact.
	ContactIDentifier *string `json:"contact_identifier"`
}

Task: task.

type TaskStatus 

type TaskStatus string

func (TaskStatus) MarshalJSON 

func (enum TaskStatus) MarshalJSON() ([]byte, error)

func (TaskStatus) String 

func (enum TaskStatus) String() string

func (*TaskStatus) UnmarshalJSON 

func (enum *TaskStatus) UnmarshalJSON(data []byte) error

type TaskType 

type TaskType string

func (TaskType) MarshalJSON 

func (enum TaskType) MarshalJSON() ([]byte, error)

func (TaskType) String 

func (enum TaskType) String() string

func (*TaskType) UnmarshalJSON 

func (enum *TaskType) UnmarshalJSON(data []byte) error

type Tld 

type Tld struct {
	Name string `json:"name"`

	DnssecSupport bool `json:"dnssec_support"`

	DurationInYearsMin uint32 `json:"duration_in_years_min"`

	DurationInYearsMax uint32 `json:"duration_in_years_max"`

	IDnSupport bool `json:"idn_support"`

	Offers map[string]*TldOffer `json:"offers"`

	Specifications map[string]string `json:"specifications"`
}

Tld: tld.

type TldOffer 

type TldOffer struct {
	Action string `json:"action"`

	OperationPath string `json:"operation_path"`

	Price *scw.Money `json:"price"`
}

TldOffer: tld offer.

type TransferInDomainRequestTransferRequest 

type TransferInDomainRequestTransferRequest struct {
	Domain string `json:"domain"`

	AuthCode string `json:"auth_code"`
}

TransferInDomainRequestTransferRequest: transfer in domain request transfer request.

type UpdateContactRequestQuestion 

type UpdateContactRequestQuestion struct {
	Question *string `json:"question"`

	Answer *string `json:"answer"`
}

UpdateContactRequestQuestion: update contact request question.

type UpdateDNSZoneNameserversRequest 

type UpdateDNSZoneNameserversRequest struct {
	// DNSZone: DNS zone in which to update the DNS zone name servers.
	DNSZone string `json:"-"`

	// Ns: new DNS zone name servers.
	Ns []*Nameserver `json:"ns"`
}

UpdateDNSZoneNameserversRequest: update dns zone nameservers request.

type UpdateDNSZoneNameserversResponse 

type UpdateDNSZoneNameserversResponse struct {
	// Ns: DNS zone name servers returned.
	Ns []*Nameserver `json:"ns"`
}

UpdateDNSZoneNameserversResponse: update dns zone nameservers response.

type UpdateDNSZoneRecordsRequest 

type UpdateDNSZoneRecordsRequest struct {
	// DNSZone: DNS zone in which to update the DNS zone records.
	DNSZone string `json:"-"`

	// Changes: changes made to the records.
	Changes []*RecordChange `json:"changes"`

	// ReturnAllRecords: specifies whether or not to return all the records.
	ReturnAllRecords *bool `json:"return_all_records,omitempty"`

	// DisallowNewZoneCreation: disable the creation of the target zone if it does not exist. Target zone creation is disabled by default.
	DisallowNewZoneCreation bool `json:"disallow_new_zone_creation"`

	// Serial: use the provided serial (0) instead of the auto-increment serial.
	Serial *uint64 `json:"serial,omitempty"`
}

UpdateDNSZoneRecordsRequest: update dns zone records request.

type UpdateDNSZoneRecordsResponse 

type UpdateDNSZoneRecordsResponse struct {
	// Records: DNS zone records returned.
	Records []*Record `json:"records"`
}

UpdateDNSZoneRecordsResponse: update dns zone records response.

type UpdateDNSZoneRequest 

type UpdateDNSZoneRequest struct {
	// DNSZone: DNS zone to update.
	DNSZone string `json:"-"`

	// NewDNSZone: name of the new DNS zone to create.
	NewDNSZone *string `json:"new_dns_zone,omitempty"`

	// ProjectID: project ID in which to create the new DNS zone.
	ProjectID string `json:"project_id"`
}

UpdateDNSZoneRequest: update dns zone request.

type WaitForDNSRecordExistRequest 

type WaitForDNSRecordExistRequest struct {
	DNSZone       string
	RecordName    string
	RecordType    RecordType
	Timeout       *time.Duration
	RetryInterval *time.Duration
}

WaitForDNSRecordExistRequest is used by WaitForDNSRecordExist method.

type WaitForDNSZoneRequest 

type WaitForDNSZoneRequest struct {
	DNSZone       string
	DNSZones      []string
	Timeout       *time.Duration
	RetryInterval *time.Duration
}

WaitForDNSZoneRequest is used by WaitForDNSZone method.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.