domain

package
v1.0.0-beta.6 Latest Latest
Warning

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

Go to latest
Published: Feb 28, 2020 License: Apache-2.0 Imports: 12 Imported by: 0

Documentation

Overview

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

Index

Constants

View Source
const (
	// CivilityCivilityUnknown is [insert doc].
	CivilityCivilityUnknown = Civility("civility_unknown")
	// CivilityM is [insert doc].
	CivilityM = Civility("m")
	// CivilityMme is [insert doc].
	CivilityMme = Civility("mme")
)
View Source
const (
	// DNSZoneStatusUnknown is [insert doc].
	DNSZoneStatusUnknown = DNSZoneStatus("unknown")
	// DNSZoneStatusActive is [insert doc].
	DNSZoneStatusActive = DNSZoneStatus("active")
	// DNSZoneStatusPending is [insert doc].
	DNSZoneStatusPending = DNSZoneStatus("pending")
	// DNSZoneStatusError is [insert doc].
	DNSZoneStatusError = DNSZoneStatus("error")
)
View Source
const (
	// DSRecordDNSSECAlgorithmRsamd5 is [insert doc].
	DSRecordDNSSECAlgorithmRsamd5 = DSRecordDNSSECAlgorithm("rsamd5")
	// DSRecordDNSSECAlgorithmDh is [insert doc].
	DSRecordDNSSECAlgorithmDh = DSRecordDNSSECAlgorithm("dh")
	// DSRecordDNSSECAlgorithmDsa is [insert doc].
	DSRecordDNSSECAlgorithmDsa = DSRecordDNSSECAlgorithm("dsa")
	// DSRecordDNSSECAlgorithmRsasha1 is [insert doc].
	DSRecordDNSSECAlgorithmRsasha1 = DSRecordDNSSECAlgorithm("rsasha1")
	// DSRecordDNSSECAlgorithmDsaNsec3Sha1 is [insert doc].
	DSRecordDNSSECAlgorithmDsaNsec3Sha1 = DSRecordDNSSECAlgorithm("dsa_nsec3_sha1")
	// DSRecordDNSSECAlgorithmRsasha1Nsec3Sha1 is [insert doc].
	DSRecordDNSSECAlgorithmRsasha1Nsec3Sha1 = DSRecordDNSSECAlgorithm("rsasha1_nsec3_sha1")
	// DSRecordDNSSECAlgorithmRsasha256 is [insert doc].
	DSRecordDNSSECAlgorithmRsasha256 = DSRecordDNSSECAlgorithm("rsasha256")
	// DSRecordDNSSECAlgorithmRsasha512 is [insert doc].
	DSRecordDNSSECAlgorithmRsasha512 = DSRecordDNSSECAlgorithm("rsasha512")
	// DSRecordDNSSECAlgorithmEccGost is [insert doc].
	DSRecordDNSSECAlgorithmEccGost = DSRecordDNSSECAlgorithm("ecc_gost")
	// DSRecordDNSSECAlgorithmEcdsap256sha256 is [insert doc].
	DSRecordDNSSECAlgorithmEcdsap256sha256 = DSRecordDNSSECAlgorithm("ecdsap256sha256")
	// DSRecordDNSSECAlgorithmEcdsap384sha384 is [insert doc].
	DSRecordDNSSECAlgorithmEcdsap384sha384 = DSRecordDNSSECAlgorithm("ecdsap384sha384")
	// DSRecordDNSSECAlgorithmEd25519 is [insert doc].
	DSRecordDNSSECAlgorithmEd25519 = DSRecordDNSSECAlgorithm("ed25519")
	// DSRecordDNSSECAlgorithmEd448 is [insert doc].
	DSRecordDNSSECAlgorithmEd448 = DSRecordDNSSECAlgorithm("ed448")
)
View Source
const (
	// DigestDNSSECDigestTypeSha1 is [insert doc].
	DigestDNSSECDigestTypeSha1 = DigestDNSSECDigestType("sha_1")
	// DigestDNSSECDigestTypeSha256 is [insert doc].
	DigestDNSSECDigestTypeSha256 = DigestDNSSECDigestType("sha_256")
	// DigestDNSSECDigestTypeGostR34_11_94 is [insert doc].
	DigestDNSSECDigestTypeGostR34_11_94 = DigestDNSSECDigestType("gost_r_34_11_94")
	// DigestDNSSECDigestTypeSha384 is [insert doc].
	DigestDNSSECDigestTypeSha384 = DigestDNSSECDigestType("sha_384")
)
View Source
const (
	// DomainFeatureStatusUnavailable is [insert doc].
	DomainFeatureStatusUnavailable = DomainFeatureStatus("unavailable")
	// DomainFeatureStatusEnabling is [insert doc].
	DomainFeatureStatusEnabling = DomainFeatureStatus("enabling")
	// DomainFeatureStatusEnabled is [insert doc].
	DomainFeatureStatusEnabled = DomainFeatureStatus("enabled")
	// DomainFeatureStatusDisabling is [insert doc].
	DomainFeatureStatusDisabling = DomainFeatureStatus("disabling")
	// DomainFeatureStatusDisabled is [insert doc].
	DomainFeatureStatusDisabled = DomainFeatureStatus("disabled")
)
View Source
const (
	// DomainStatusUnknown is [insert doc].
	DomainStatusUnknown = DomainStatus("unknown")
	// DomainStatusActive is [insert doc].
	DomainStatusActive = DomainStatus("active")
	// DomainStatusToCreate is [insert doc].
	DomainStatusToCreate = DomainStatus("to_create")
	// DomainStatusCreating is [insert doc].
	DomainStatusCreating = DomainStatus("creating")
	// DomainStatusCreateError is [insert doc].
	DomainStatusCreateError = DomainStatus("create_error")
	// DomainStatusToRenew is [insert doc].
	DomainStatusToRenew = DomainStatus("to_renew")
	// DomainStatusRenewing is [insert doc].
	DomainStatusRenewing = DomainStatus("renewing")
	// DomainStatusRenewError is [insert doc].
	DomainStatusRenewError = DomainStatus("renew_error")
	// DomainStatusToXfer is [insert doc].
	DomainStatusToXfer = DomainStatus("to_xfer")
	// DomainStatusXfering is [insert doc].
	DomainStatusXfering = DomainStatus("xfering")
	// DomainStatusXferError is [insert doc].
	DomainStatusXferError = DomainStatus("xfer_error")
	// DomainStatusToRestore is [insert doc].
	DomainStatusToRestore = DomainStatus("to_restore")
	// DomainStatusRestoring is [insert doc].
	DomainStatusRestoring = DomainStatus("restoring")
	// DomainStatusRestoreError is [insert doc].
	DomainStatusRestoreError = DomainStatus("restore_error")
	// DomainStatusToDelete is [insert doc].
	DomainStatusToDelete = DomainStatus("to_delete")
	// DomainStatusExpired is [insert doc].
	DomainStatusExpired = DomainStatus("expired")
	// DomainStatusExpiring is [insert doc].
	DomainStatusExpiring = DomainStatus("expiring")
	// DomainStatusUpdating is [insert doc].
	DomainStatusUpdating = DomainStatus("updating")
)
View Source
const (
	// ExtensionFRModeModeUnknown is [insert doc].
	ExtensionFRModeModeUnknown = ExtensionFRMode("mode_unknown")
	// ExtensionFRModeParticular is [insert doc].
	ExtensionFRModeParticular = ExtensionFRMode("particular")
	// ExtensionFRModeSiret is [insert doc].
	ExtensionFRModeSiret = ExtensionFRMode("siret")
	// ExtensionFRModeDuns is [insert doc].
	ExtensionFRModeDuns = ExtensionFRMode("duns")
	// ExtensionFRModeLocal is [insert doc].
	ExtensionFRModeLocal = ExtensionFRMode("local")
	// ExtensionFRModeAssociation is [insert doc].
	ExtensionFRModeAssociation = ExtensionFRMode("association")
	// ExtensionFRModeBrand is [insert doc].
	ExtensionFRModeBrand = ExtensionFRMode("brand")
	// ExtensionFRModeCodeAuthAfnic is [insert doc].
	ExtensionFRModeCodeAuthAfnic = ExtensionFRMode("code_auth_afnic")
)
View Source
const (
	// LangLangUnknown is [insert doc].
	LangLangUnknown = Lang("lang_unknown")
	// LangFrench is [insert doc].
	LangFrench = Lang("french")
	// LangEnglish is [insert doc].
	LangEnglish = Lang("english")
	// LangSpanish is [insert doc].
	LangSpanish = Lang("spanish")
	// LangGerman is [insert doc].
	LangGerman = Lang("german")
)
View Source
const (
	// LegalFormLegalFormUnknown is [insert doc].
	LegalFormLegalFormUnknown = LegalForm("legal_form_unknown")
	// LegalFormParticular is [insert doc].
	LegalFormParticular = LegalForm("particular")
	// LegalFormSociety is [insert doc].
	LegalFormSociety = LegalForm("society")
	// LegalFormAssociation is [insert doc].
	LegalFormAssociation = LegalForm("association")
	// LegalFormOther is [insert doc].
	LegalFormOther = LegalForm("other")
)
View Source
const (
	// ListDNSZoneRecordsRequestOrderByNameAsc is [insert doc].
	ListDNSZoneRecordsRequestOrderByNameAsc = ListDNSZoneRecordsRequestOrderBy("name_asc")
	// ListDNSZoneRecordsRequestOrderByNameDesc is [insert doc].
	ListDNSZoneRecordsRequestOrderByNameDesc = ListDNSZoneRecordsRequestOrderBy("name_desc")
)
View Source
const (
	// ListDNSZonesRequestOrderByDomainAsc is [insert doc].
	ListDNSZonesRequestOrderByDomainAsc = ListDNSZonesRequestOrderBy("domain_asc")
	// ListDNSZonesRequestOrderByDomainDesc is [insert doc].
	ListDNSZonesRequestOrderByDomainDesc = ListDNSZonesRequestOrderBy("domain_desc")
	// ListDNSZonesRequestOrderBySubdomainAsc is [insert doc].
	ListDNSZonesRequestOrderBySubdomainAsc = ListDNSZonesRequestOrderBy("subdomain_asc")
	// ListDNSZonesRequestOrderBySubdomainDesc is [insert doc].
	ListDNSZonesRequestOrderBySubdomainDesc = ListDNSZonesRequestOrderBy("subdomain_desc")
)
View Source
const (
	// ListDomainsRequestOrderByDomainAsc is [insert doc].
	ListDomainsRequestOrderByDomainAsc = ListDomainsRequestOrderBy("domain_asc")
	// ListDomainsRequestOrderByDomainDesc is [insert doc].
	ListDomainsRequestOrderByDomainDesc = ListDomainsRequestOrderBy("domain_desc")
)
View Source
const (
	// ListTldsRequestOrderByPopularityAsc is [insert doc].
	ListTldsRequestOrderByPopularityAsc = ListTldsRequestOrderBy("popularity_asc")
	// ListTldsRequestOrderByPopularityDesc is [insert doc].
	ListTldsRequestOrderByPopularityDesc = ListTldsRequestOrderBy("popularity_desc")
	// ListTldsRequestOrderByNameAsc is [insert doc].
	ListTldsRequestOrderByNameAsc = ListTldsRequestOrderBy("name_asc")
	// ListTldsRequestOrderByNameDesc is [insert doc].
	ListTldsRequestOrderByNameDesc = ListTldsRequestOrderBy("name_desc")
)
View Source
const (
	// RecordServiceUPConfigStrategyRandom is [insert doc].
	RecordServiceUPConfigStrategyRandom = RecordServiceUPConfigStrategy("random")
	// RecordServiceUPConfigStrategyHashed is [insert doc].
	RecordServiceUPConfigStrategyHashed = RecordServiceUPConfigStrategy("hashed")
)
View Source
const (
	// RecordTypeUnknown is [insert doc].
	RecordTypeUnknown = RecordType("unknown")
	// RecordTypeA is [insert doc].
	RecordTypeA = RecordType("A")
	// RecordTypeAAAA is [insert doc].
	RecordTypeAAAA = RecordType("AAAA")
	// RecordTypeCNAME is [insert doc].
	RecordTypeCNAME = RecordType("CNAME")
	// RecordTypeTXT is [insert doc].
	RecordTypeTXT = RecordType("TXT")
	// RecordTypeSRV is [insert doc].
	RecordTypeSRV = RecordType("SRV")
	// RecordTypeTLSA is [insert doc].
	RecordTypeTLSA = RecordType("TLSA")
	// RecordTypeMX is [insert doc].
	RecordTypeMX = RecordType("MX")
	// RecordTypeNS is [insert doc].
	RecordTypeNS = RecordType("NS")
	// RecordTypePTR is [insert doc].
	RecordTypePTR = RecordType("PTR")
	// RecordTypeCAA is [insert doc].
	RecordTypeCAA = RecordType("CAA")
	// RecordTypeFUNCMYIPA is [insert doc].
	RecordTypeFUNCMYIPA = RecordType("FUNC_MYIP_A")
	// RecordTypeFUNCMYIPAAAA is [insert doc].
	RecordTypeFUNCMYIPAAAA = RecordType("FUNC_MYIP_AAAA")
	// RecordTypeFUNCURLUPA is [insert doc].
	RecordTypeFUNCURLUPA = RecordType("FUNC_URLUP_A")
	// RecordTypeFUNCURLUPAAAA is [insert doc].
	RecordTypeFUNCURLUPAAAA = RecordType("FUNC_URLUP_AAAA")
	// RecordTypeFUNCPORTUPA is [insert doc].
	RecordTypeFUNCPORTUPA = RecordType("FUNC_PORTUP_A")
	// RecordTypeFUNCPORTUPAAAA is [insert doc].
	RecordTypeFUNCPORTUPAAAA = RecordType("FUNC_PORTUP_AAAA")
	// RecordTypeFUNCVIEWA is [insert doc].
	RecordTypeFUNCVIEWA = RecordType("FUNC_VIEW_A")
	// RecordTypeFUNCVIEWAAAA is [insert doc].
	RecordTypeFUNCVIEWAAAA = RecordType("FUNC_VIEW_AAAA")
	// RecordTypeFUNCVIEWCNAME is [insert doc].
	RecordTypeFUNCVIEWCNAME = RecordType("FUNC_VIEW_CNAME")
	// RecordTypeFUNCVIEWTXT is [insert doc].
	RecordTypeFUNCVIEWTXT = RecordType("FUNC_VIEW_TXT")
	// RecordTypeALIAS is [insert doc].
	RecordTypeALIAS = RecordType("ALIAS")
	// RecordTypeFUNCTION is [insert doc].
	RecordTypeFUNCTION = RecordType("FUNCTION")
)
View Source
const (
	// TaskStatusUnavailable is [insert doc].
	TaskStatusUnavailable = TaskStatus("unavailable")
	// TaskStatusNew is [insert doc].
	TaskStatusNew = TaskStatus("new")
	// TaskStatusWaitingPayment is [insert doc].
	TaskStatusWaitingPayment = TaskStatus("waiting_payment")
	// TaskStatusPending is [insert doc].
	TaskStatusPending = TaskStatus("pending")
	// TaskStatusSuccess is [insert doc].
	TaskStatusSuccess = TaskStatus("success")
	// TaskStatusError is [insert doc].
	TaskStatusError = TaskStatus("error")
)
View Source
const (
	// TaskTypeUnknown is [insert doc].
	TaskTypeUnknown = TaskType("unknown")
	// TaskTypeCreateDomain is [insert doc].
	TaskTypeCreateDomain = TaskType("create_domain")
	// TaskTypeCreateExternalDomain is [insert doc].
	TaskTypeCreateExternalDomain = TaskType("create_external_domain")
	// TaskTypeRenewDomain is [insert doc].
	TaskTypeRenewDomain = TaskType("renew_domain")
	// TaskTypeRestoreDomain is [insert doc].
	TaskTypeRestoreDomain = TaskType("restore_domain")
	// TaskTypeTransferDomain is [insert doc].
	TaskTypeTransferDomain = TaskType("transfer_domain")
	// TaskTypeTradeDomain is [insert doc].
	TaskTypeTradeDomain = TaskType("trade_domain")
	// TaskTypeLockDomainTransfer is [insert doc].
	TaskTypeLockDomainTransfer = TaskType("lock_domain_transfer")
	// TaskTypeUnlockDomainTransfer is [insert doc].
	TaskTypeUnlockDomainTransfer = TaskType("unlock_domain_transfer")
	// TaskTypeEnableDnssec is [insert doc].
	TaskTypeEnableDnssec = TaskType("enable_dnssec")
	// TaskTypeDisableDnssec is [insert doc].
	TaskTypeDisableDnssec = TaskType("disable_dnssec")
	// TaskTypeUpdateDomain is [insert doc].
	TaskTypeUpdateDomain = TaskType("update_domain")
	// TaskTypeUpdateContact is [insert doc].
	TaskTypeUpdateContact = TaskType("update_contact")
	// TaskTypeDeleteDomain is [insert doc].
	TaskTypeDeleteDomain = TaskType("delete_domain")
	// TaskTypeCancelTask is [insert doc].
	TaskTypeCancelTask = TaskType("cancel_task")
	// TaskTypeGenerateSslCertificate is [insert doc].
	TaskTypeGenerateSslCertificate = TaskType("generate_ssl_certificate")
	// TaskTypeRenewSslCertificate is [insert doc].
	TaskTypeRenewSslCertificate = TaskType("renew_ssl_certificate")
	// TaskTypeSendMessage is [insert doc].
	TaskTypeSendMessage = TaskType("send_message")
)
View Source
const (
	// ZoneSSLStatusUnknown is [insert doc].
	ZoneSSLStatusUnknown = ZoneSSLStatus("unknown")
	// ZoneSSLStatusNew is [insert doc].
	ZoneSSLStatusNew = ZoneSSLStatus("new")
	// ZoneSSLStatusPending is [insert doc].
	ZoneSSLStatusPending = ZoneSSLStatus("pending")
	// ZoneSSLStatusSuccess is [insert doc].
	ZoneSSLStatusSuccess = ZoneSSLStatus("success")
	// ZoneSSLStatusError is [insert doc].
	ZoneSSLStatusError = ZoneSSLStatus("error")
)

Variables

This section is empty.

Functions

This section is empty.

Types

type API

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

API domain API

Manage your domain DNS zones and records.

func NewAPI

func NewAPI(client *scw.Client) *API

NewAPI returns a API object from a Scaleway client.

func (*API) BuyDomain

func (s *API) BuyDomain(req *BuyDomainRequest, opts ...scw.RequestOption) (*Domain, error)

BuyDomain buy a domain

Request the registration of a domain name. You can give an owned domain contact or a full new contact.

func (*API) ClearDNSZoneRecords

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

ClearDNSZoneRecords clear DNS zone records

Only available with default NS.<br/> Delete all the records from a DNS zone. Any edition will be versioned.

func (*API) CopyDNSZone

func (s *API) CopyDNSZone(req *CopyDNSZoneRequest, opts ...scw.RequestOption) (*DNSZone, error)

CopyDNSZone copy a DNS zone

Copy an existed DNS zone with all its records into a new one.

func (*API) CreateDNSZone

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

CreateDNSZone create a DNS zone

Create a new DNS zone.

func (*API) CreateSSLCertificate

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

CreateSSLCertificate create a new SSL certificate

func (*API) DeleteDNSZone

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

DeleteDNSZone delete DNS zone

Delete a DNS zone and all it's records.

func (*API) DeleteDNSZoneTsigKey

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

DeleteDNSZoneTsigKey delete the DNS zone TSIG Key

func (*API) DeleteExternalDomain

func (s *API) DeleteExternalDomain(req *DeleteExternalDomainRequest, opts ...scw.RequestOption) (*DeleteExternalDomainResponse, error)

DeleteExternalDomain delete an external domain

Delete an external domain name.

func (*API) DeleteSSLCertificate

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

DeleteSSLCertificate delete an SSL certificate

func (*API) DisableDomainAutoRenew

func (s *API) DisableDomainAutoRenew(req *DisableDomainAutoRenewRequest, opts ...scw.RequestOption) (*Domain, error)

DisableDomainAutoRenew disable domain auto renew

func (*API) DisableDomainDNSSEC

func (s *API) DisableDomainDNSSEC(req *DisableDomainDNSSECRequest, opts ...scw.RequestOption) (*Domain, error)

DisableDomainDNSSEC disable domain DNSSEC

func (*API) EnableDomainAutoRenew

func (s *API) EnableDomainAutoRenew(req *EnableDomainAutoRenewRequest, opts ...scw.RequestOption) (*Domain, error)

EnableDomainAutoRenew enable domain auto renew

func (*API) EnableDomainDNSSEC

func (s *API) EnableDomainDNSSEC(req *EnableDomainDNSSECRequest, opts ...scw.RequestOption) (*Domain, error)

EnableDomainDNSSEC update domain DNSSEC

If your domain has the default Scaleway NS and uses another registrar, you have to update the DS record manually. For the algorithm, here the code number for each type:

  • 1: RSAMD5
  • 2: DIFFIE_HELLMAN
  • 3: DSA_SHA1
  • 5: RSA_SHA1
  • 6: DSA_NSEC3_SHA1
  • 7: RSASHA1_NSEC3_SHA1
  • 8: RSASHA256
  • 10: RSASHA512
  • 12: ECC_GOST
  • 13: ECDSAP256SHA256
  • 14: ECDSAP384SHA384

And for the digest type:

  • 1: SHA_1
  • 2: SHA_256
  • 3: GOST_R_34_11_94
  • 4: SHA_384

func (*API) ExportRawDNSZone

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

ExportRawDNSZone export raw DNS zone

Get DNS zone from a given format with default NS.

func (*API) GetContact

func (s *API) GetContact(req *GetContactRequest, opts ...scw.RequestOption) (*Contact, error)

GetContact get a contact

Return a contact details retrieve from the registrar by a given contact ID.

func (*API) GetDNSZoneTsigKey

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

GetDNSZoneTsigKey get the DNS zone TSIG Key

Get the DNS zone TSIG Key to allow AXFR request.

func (*API) GetDNSZoneVersionDiff

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

GetDNSZoneVersionDiff get DNS zone version diff

Get all differences from an old DNS zone version.

func (*API) GetDomain

func (s *API) GetDomain(req *GetDomainRequest, opts ...scw.RequestOption) (*GetDomainResponse, error)

GetDomain get domain

Returns a the domain with more informations.

func (*API) GetDomainAuthCode

func (s *API) GetDomainAuthCode(req *GetDomainAuthCodeRequest, opts ...scw.RequestOption) (*GetDomainAuthCodeResponse, error)

GetDomainAuthCode return domain auth code

If possible, return the auth code for an unlock domain transfer, or an error if the domain is locked. Some TLD may have a different procedure to retrieve the auth code, in that case, the informations is given in the message field.

func (*API) ImportProviderDNSZone

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

ImportProviderDNSZone import provider DNS zone

Import and replace records from a given provider format with default NS.

func (*API) ImportRawDNSZone

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

ImportRawDNSZone import raw DNS zone

Import and replace records from a given provider format with default NS.

func (*API) ListContacts

func (s *API) ListContacts(req *ListContactsRequest, opts ...scw.RequestOption) (*ListContactsResponse, error)

ListContacts list contacts

Return a list of contacts with their domains and roles. You can filter the list by a domain name.

func (*API) ListDNSZoneNameservers

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

ListDNSZoneNameservers list DNS zone nameservers

Returns a list of Nameservers and there optionnal glue records for a DNS zone.

func (*API) ListDNSZoneRecords

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

ListDNSZoneRecords list DNS zone records

Returns a list of DNS records about a DNS zone with default NS. You can filter the records by a type and a name.

func (*API) ListDNSZoneVersionRecords

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

ListDNSZoneVersionRecords list DNS zone version records

Get a list of records from an old DNS zone version.

func (*API) ListDNSZoneVersions

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

ListDNSZoneVersions list DNS zone versions

Get a list of DNS zone versions.<br/> You are limited to 100 versions.<br/> Beyound that, the most older version will be erased after each new modification.

func (*API) ListDNSZones

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

ListDNSZones list DNS zones

Returns a list of manageable DNS zones. You can filter the DNS zones by a domain name.

func (*API) ListDomains

func (s *API) ListDomains(req *ListDomainsRequest, opts ...scw.RequestOption) (*ListDomainsResponse, error)

ListDomains list domains

Returns a list of domains owned by the user.

func (*API) ListSSLCertificates

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

ListSSLCertificates list all user SSL certificate

func (*API) ListTasks

func (s *API) ListTasks(req *ListTasksRequest, opts ...scw.RequestOption) (*ListTasksResponse, error)

ListTasks list tasks

List all account tasks. You can filter the list by a domain name.

func (*API) LockDomainTransfer

func (s *API) LockDomainTransfer(req *LockDomainTransferRequest, opts ...scw.RequestOption) (*Domain, error)

LockDomainTransfer lock domain transfer

Lock domain transfer, a lock domain transfer can't be transferred and the auth code can't be requested.

func (*API) RefreshDNSZone

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

RefreshDNSZone refresh DNS zone

Refresh SOA DNS zone. You can recreate the given DNS zone and it's sub DNS zone if needed.

func (*API) RegisterExternalDomain

func (s *API) RegisterExternalDomain(req *RegisterExternalDomainRequest, opts ...scw.RequestOption) (*Domain, error)

RegisterExternalDomain register an external domain

Request the register of an external domain name.

func (*API) RenewDomain

func (s *API) RenewDomain(req *RenewDomainRequest, opts ...scw.RequestOption) (*Domain, error)

RenewDomain renew a domain

Request the renew of a domain name.

func (*API) RestoreDNSZoneVersion

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

RestoreDNSZoneVersion restore DNS zone version

Restore and active old DNS zone version.

func (*API) TradeDomain

func (s *API) TradeDomain(req *TradeDomainRequest, opts ...scw.RequestOption) (*Domain, error)

TradeDomain trade a domain contact

Request a trade for the contact owner.<br/> If an `organization_id` is given, the change is a from the current Scaleway account to another Scaleway account.<br/> If no contact is given, the first contact of the other Scaleway account is taken.<br/> If the other Scaleway account has no contact. An error occurred.

func (*API) TransferDomain

func (s *API) TransferDomain(req *TransferDomainRequest, opts ...scw.RequestOption) (*Domain, error)

TransferDomain transfer a domain

Request the transfer from an other registrar domain to Scaleway.

func (*API) UnlockDomainTransfer

func (s *API) UnlockDomainTransfer(req *UnlockDomainTransferRequest, opts ...scw.RequestOption) (*Domain, error)

UnlockDomainTransfer unlock domain transfer

Unlock domain transfer, an unlock domain transfer can be transferred and the auth code can be requested.

func (*API) UpdateContact

func (s *API) UpdateContact(req *UpdateContactRequest, opts ...scw.RequestOption) (*Contact, error)

UpdateContact update contact

You can edit the contact coordinates.

func (*API) UpdateDNSZone

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

UpdateDNSZone update a DNS zone

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 DNS zone nameservers

Update DNS zone nameservers and set optionnal glue records.

func (*API) UpdateDNSZoneRecords

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

UpdateDNSZoneRecords update DNS zone records

Only available with default NS.<br/> Send a list of actions and records.

Action can be:

  • add:
  • Add new record
  • Can be more specific and add a new IP to an existing A record for example
  • set:
  • Edit a record
  • Can be more specific and edit an IP from an existing A record for example
  • delete:
  • Delete a record
  • Can be more specific and delete an IP from an existing A record for example
  • clear:
  • Delete all records from a DNS zone

Any edition will be versioned.

func (*API) UpdateDomain

func (s *API) UpdateDomain(req *UpdateDomainRequest, opts ...scw.RequestOption) (*Domain, error)

UpdateDomain update a domain

Update the domain contacts or create a new one.<br/> If you add the same contact for multiple roles. Only one ID will be created and use for all of them.

type AvailableDomain

type AvailableDomain struct {
	// Domain domain name
	Domain string `json:"domain"`
	// Available availability
	Available bool `json:"available"`
	// Creation price for a creation
	// Precisely one of Creation, Renew, Transfer must be set.
	Creation *scw.Money `json:"creation,omitempty"`
	// Renew price for a renew
	// Precisely one of Creation, Renew, Transfer must be set.
	Renew *scw.Money `json:"renew,omitempty"`
	// Transfer price for a transfer
	// Precisely one of Creation, Renew, Transfer must be set.
	Transfer *scw.Money `json:"transfer,omitempty"`
	// Tld tLD of the domain
	Tld *Tld `json:"tld"`
	// DNSOptions dNS options availability
	DNSOptions *DNSOptions `json:"dns_options"`
}

AvailableDomain available domain

type BuyDomainRequest

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

	Period uint32 `json:"period"`

	OrganizationID string `json:"organization_id"`

	// Precisely one of Contact, ContactID must be set.
	ContactID *string `json:"contact_id,omitempty"`

	// Precisely one of Contact, ContactID must be set.
	Contact *NewContact `json:"contact,omitempty"`

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

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

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

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

type Civility

type Civility string

func (Civility) MarshalJSON

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

func (Civility) String

func (enum Civility) String() string

func (*Civility) UnmarshalJSON

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

type ClearDNSZoneRecordsRequest

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

type ClearDNSZoneRecordsResponse

type ClearDNSZoneRecordsResponse struct {
}

ClearDNSZoneRecordsResponse clear dns zone records response

type Contact

type Contact struct {
	ID string `json:"id"`
	// LegalForm
	//
	// Default value: legal_form_unknown
	LegalForm LegalForm `json:"legal_form"`
	// Civility
	//
	// Default value: civility_unknown
	Civility Civility `json:"civility"`

	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"`

	Address1 string `json:"address1"`

	Address2 string `json:"address2"`

	Zip string `json:"zip"`

	City string `json:"city"`

	Country string `json:"country"`

	Vat string `json:"vat"`

	Siret string `json:"siret"`
	// Lang
	//
	// Default value: lang_unknown
	Lang Lang `json:"lang"`

	Resale bool `json:"resale"`

	Question1 string `json:"question1"`

	Answer1 string `json:"answer1"`

	Question2 string `json:"question2"`

	Answer2 string `json:"answer2"`

	Question3 string `json:"question3"`

	Answer3 string `json:"answer3"`

	Question4 string `json:"question4"`

	Answer4 string `json:"answer4"`

	Question5 string `json:"question5"`

	Answer5 string `json:"answer5"`

	ExtensionFr *ExtensionFR `json:"extension_fr"`

	ExtensionEu *ExtensionEU `json:"extension_eu"`
}

Contact contact

type ContactRoles

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

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

type ContactRolesRoles

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

	IsAdminitrative bool `json:"is_adminitrative"`

	IsTechnical bool `json:"is_technical"`
}

type CopyDNSZoneRequest

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

	NewDNSZone *string `json:"new_dns_zone"`

	Overwrite *bool `json:"overwrite"`
}

type CreateDNSZoneRequest

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

	Subdomain string `json:"subdomain"`

	OrganizationIDs []string `json:"organization_ids"`
}

type CreateSSLCertificateRequest

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

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

type DNSOptions

type DNSOptions struct {
	BasicInternal *scw.Money `json:"basic_internal"`

	BasicExternal *scw.Money `json:"basic_external"`

	PremiumInternal *scw.Money `json:"premium_internal"`

	PremiumExternal *scw.Money `json:"premium_external"`
}

DNSOptions summary on availables options

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"`

	OrganizationIDs []string `json:"organization_ids"`
}

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 DSRecord

type DSRecord struct {
	KeyID uint32 `json:"key_id"`
	// Algorithm
	//
	// Default value: rsamd5
	Algorithm DSRecordDNSSECAlgorithm `json:"algorithm"`

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

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

type DSRecordDNSSECAlgorithm

type DSRecordDNSSECAlgorithm string

func (DSRecordDNSSECAlgorithm) MarshalJSON

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

func (DSRecordDNSSECAlgorithm) String

func (enum DSRecordDNSSECAlgorithm) String() string

func (*DSRecordDNSSECAlgorithm) UnmarshalJSON

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

type DeleteDNSZoneRequest

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

type DeleteDNSZoneResponse

type DeleteDNSZoneResponse struct {
}

DeleteDNSZoneResponse delete dns zone response

type DeleteDNSZoneTsigKeyRequest

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

	ID string `json:"-"`
}

type DeleteExternalDomainRequest

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

type DeleteExternalDomainResponse

type DeleteExternalDomainResponse struct {
}

DeleteExternalDomainResponse delete external domain response

type DeleteSSLCertificateRequest

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

type DeleteSSLCertificateResponse

type DeleteSSLCertificateResponse struct {
}

DeleteSSLCertificateResponse delete ssl certificate response

type Digest

type Digest struct {
	// Type
	//
	// Default value: sha_1
	Type DigestDNSSECDigestType `json:"type"`

	Digest string `json:"digest"`
}

type DigestDNSSECDigestType

type DigestDNSSECDigestType string

func (DigestDNSSECDigestType) MarshalJSON

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

func (DigestDNSSECDigestType) String

func (enum DigestDNSSECDigestType) String() string

func (*DigestDNSSECDigestType) UnmarshalJSON

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

type DisableDomainAutoRenewRequest

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

type DisableDomainDNSSECRequest

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

type Domain

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

	OrganizationID string `json:"organization_id"`
	// AutoRenewStatus
	//
	// Default value: unavailable
	AutoRenewStatus DomainFeatureStatus `json:"auto_renew_status"`
	// DnssecStatus
	//
	// Default value: unavailable
	DnssecStatus DomainFeatureStatus `json:"dnssec_status"`

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

	Epp []string `json:"epp"`

	ExpiredAt time.Time `json:"expired_at"`

	UpdatedAt time.Time `json:"updated_at"`

	Registrar string `json:"registrar"`

	IsExternal bool `json:"is_external"`
	// Status
	//
	// Default value: unknown
	Status DomainStatus `json:"status"`

	DNSZones []*DNSZone `json:"dns_zones"`

	DNSZoneCount uint32 `json:"dns_zone_count"`

	TrademarkProtection *DomainTrademarkProtectionConfig `json:"trademark_protection"`

	OwnerContact *Contact `json:"owner_contact"`

	TechnicalContact *Contact `json:"technical_contact"`

	AdministrativeContact *Contact `json:"administrative_contact"`
}

Domain domain

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 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"`

	OrganizationID string `json:"organization_id"`
	// AutoRenewStatus
	//
	// Default value: unavailable
	AutoRenewStatus DomainFeatureStatus `json:"auto_renew_status"`
	// DnssecStatus
	//
	// Default value: unavailable
	DnssecStatus DomainFeatureStatus `json:"dnssec_status"`

	Epp []string `json:"epp"`

	ExpiredAt time.Time `json:"expired_at"`

	UpdatedAt time.Time `json:"updated_at"`

	Registrar string `json:"registrar"`

	IsExternal bool `json:"is_external"`
	// Status
	//
	// Default value: unknown
	Status DomainStatus `json:"status"`

	DNSZoneCount uint32 `json:"dns_zone_count"`
}

type DomainTrademarkProtectionConfig

type DomainTrademarkProtectionConfig struct {
}

type EnableDomainAutoRenewRequest

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

type EnableDomainDNSSECRequest

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

	DsRecord *DSRecord `json:"ds_record"`
}

type ExportRawDNSZoneRequest

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

	Format string `json:"-"`
}

type ExtensionEU

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

type ExtensionFR

type ExtensionFR struct {
	// Mode
	//
	// Default value: mode_unknown
	Mode ExtensionFRMode `json:"mode"`

	// Precisely one of AssociationInfos, BrandInfos, CodeAuthAfnicInfos, DunsInfos, ParticularInfos must be set.
	ParticularInfos *ExtensionFRParticularInfos `json:"particular_infos,omitempty"`

	// Precisely one of AssociationInfos, BrandInfos, CodeAuthAfnicInfos, DunsInfos, ParticularInfos must be set.
	DunsInfos *ExtensionFRDunsInfos `json:"duns_infos,omitempty"`

	// Precisely one of AssociationInfos, BrandInfos, CodeAuthAfnicInfos, DunsInfos, ParticularInfos must be set.
	AssociationInfos *ExtensionFRAssociationInfos `json:"association_infos,omitempty"`

	// Precisely one of AssociationInfos, BrandInfos, CodeAuthAfnicInfos, DunsInfos, ParticularInfos must be set.
	BrandInfos *ExtensionFRBrandInfos `json:"brand_infos,omitempty"`

	// Precisely one of AssociationInfos, BrandInfos, CodeAuthAfnicInfos, DunsInfos, ParticularInfos must be set.
	CodeAuthAfnicInfos *ExtensionFRCodeAuthAfnicInfos `json:"code_auth_afnic_infos,omitempty"`
}

type ExtensionFRAssociationInfos

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

	PublicationJoPage uint32 `json:"publication_jo_page"`
}

type ExtensionFRBrandInfos

type ExtensionFRBrandInfos struct {
	BrandInpi string `json:"brand_inpi"`
}

type ExtensionFRCodeAuthAfnicInfos

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

type ExtensionFRDunsInfos

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

	LocalID string `json:"local_id"`
}

type ExtensionFRMode

type ExtensionFRMode string

func (ExtensionFRMode) MarshalJSON

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

func (ExtensionFRMode) String

func (enum ExtensionFRMode) String() string

func (*ExtensionFRMode) UnmarshalJSON

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

type ExtensionFRParticularInfos

type ExtensionFRParticularInfos struct {
	WhoisOptOut bool `json:"whois_opt_out"`
}

type GetContactRequest

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

type GetDNSZoneTsigKeyRequest

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

type GetDNSZoneTsigKeyResponse

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

	Key string `json:"key"`

	Algorithm string `json:"algorithm"`
}

GetDNSZoneTsigKeyResponse get dns zone tsig key response

type GetDNSZoneVersionDiffRequest

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

	Version string `json:"-"`
}

type GetDNSZoneVersionDiffResponse

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

GetDNSZoneVersionDiffResponse get dns zone version diff response

type GetDomainAuthCodeRequest

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

type GetDomainAuthCodeResponse

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

GetDomainAuthCodeResponse get domain auth code response

type GetDomainRequest

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

type GetDomainResponse

type GetDomainResponse struct {
	Domain *Domain `json:"domain"`
}

GetDomainResponse get domain response

type ImportProviderDNSZoneRequest

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

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

type ImportProviderDNSZoneRequestOnlineV1

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

type ImportProviderDNSZoneResponse

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

ImportProviderDNSZoneResponse import provider dns zone response

type ImportRawDNSZoneRequest

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

	Format string `json:"format"`

	Content string `json:"content"`
}

type ImportRawDNSZoneResponse

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

ImportRawDNSZoneResponse import raw dns zone response

type Lang

type Lang string

func (Lang) MarshalJSON

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

func (Lang) String

func (enum Lang) String() string

func (*Lang) UnmarshalJSON

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

type LegalForm

type LegalForm string

func (LegalForm) MarshalJSON

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

func (LegalForm) String

func (enum LegalForm) String() string

func (*LegalForm) UnmarshalJSON

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

type ListContactsRequest

type ListContactsRequest struct {
	Domain *string `json:"-"`
}

type ListContactsResponse

type ListContactsResponse struct {
	Contacts []*ContactRoles `json:"contacts"`
}

ListContactsResponse list contacts response

type ListDNSZoneNameserversRequest

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

type ListDNSZoneNameserversResponse

type ListDNSZoneNameserversResponse struct {
	Ns []*Nameserver `json:"ns"`
}

ListDNSZoneNameserversResponse list dns zone nameservers response

type ListDNSZoneRecordsRequest

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

	Page *int32 `json:"-"`

	PageSize *uint32 `json:"-"`
	// OrderBy
	//
	// Default value: name_asc
	OrderBy ListDNSZoneRecordsRequestOrderBy `json:"-"`

	Name string `json:"-"`
	// Type
	//
	// Default value: unknown
	Type RecordType `json:"-"`
}

type ListDNSZoneRecordsRequestOrderBy

type ListDNSZoneRecordsRequestOrderBy string

func (ListDNSZoneRecordsRequestOrderBy) MarshalJSON

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

func (ListDNSZoneRecordsRequestOrderBy) String

func (*ListDNSZoneRecordsRequestOrderBy) UnmarshalJSON

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

type ListDNSZoneRecordsResponse

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

	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 {
	DNSZone string `json:"-"`

	Version string `json:"-"`
}

type ListDNSZoneVersionRecordsResponse

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

ListDNSZoneVersionRecordsResponse list dns zone version records response

type ListDNSZoneVersionsRequest

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

type ListDNSZoneVersionsResponse

type ListDNSZoneVersionsResponse struct {
	Versions []*Version `json:"versions"`
}

ListDNSZoneVersionsResponse list dns zone versions response

type ListDNSZonesRequest

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

	PageSize *uint32 `json:"-"`
	// OrderBy
	//
	// Default value: domain_asc
	OrderBy ListDNSZonesRequestOrderBy `json:"-"`

	Domain string `json:"-"`

	DNSZone string `json:"-"`
}

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 uint32 `json:"total_count"`

	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 ListDomainsRequest

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

	PageSize *uint32 `json:"-"`
	// OrderBy
	//
	// Default value: domain_asc
	OrderBy ListDomainsRequestOrderBy `json:"-"`

	Registrar string `json:"-"`
	// Status
	//
	// Default value: unknown
	Status DomainStatus `json:"-"`
}

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 ListSSLCertificatesRequest

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

	PageSize *uint32 `json:"-"`

	DNSZone string `json:"-"`
}

type ListSSLCertificatesResponse

type ListSSLCertificatesResponse struct {
	Certificates []*ZoneSSL `json:"certificates"`
}

ListSSLCertificatesResponse list ssl certificates response

type ListTasksRequest

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

	PageSize *uint32 `json:"-"`

	Domain string `json:"-"`
}

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 {
	// TotalCount number of tlds
	TotalCount uint32 `json:"total_count"`
	// Tlds array of tlds summaries
	Tlds []*Tld `json:"tlds"`
}

ListTldsResponse list tlds response

func (*ListTldsResponse) UnsafeAppend

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

UnsafeAppend should not be used Internal usage only

func (*ListTldsResponse) UnsafeGetTotalCount

func (r *ListTldsResponse) UnsafeGetTotalCount() uint32

UnsafeGetTotalCount should not be used Internal usage only

type LockDomainTransferRequest

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

type Nameserver

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

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

type NewContact

type NewContact struct {
	// LegalForm
	//
	// Default value: legal_form_unknown
	LegalForm LegalForm `json:"legal_form"`
	// Civility
	//
	// Default value: civility_unknown
	Civility Civility `json:"civility"`

	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"`

	Address1 string `json:"address1"`

	Address2 string `json:"address2"`

	Zip string `json:"zip"`

	City string `json:"city"`

	Country string `json:"country"`

	Vat string `json:"vat"`

	Siret string `json:"siret"`
	// Lang
	//
	// Default value: lang_unknown
	Lang Lang `json:"lang"`

	Resale bool `json:"resale"`

	Question1 string `json:"question1"`

	Answer1 string `json:"answer1"`

	Question2 string `json:"question2"`

	Answer2 string `json:"answer2"`

	Question3 string `json:"question3"`

	Answer3 string `json:"answer3"`

	Question4 string `json:"question4"`

	Answer4 string `json:"answer4"`

	Question5 string `json:"question5"`

	Answer5 string `json:"answer5"`

	ExtensionFr *ExtensionFR `json:"extension_fr"`

	ExtensionEu *ExtensionEU `json:"extension_eu"`
}

type PublicKey

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

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, ServiceUpConfig, ViewConfig, WeightedConfig must be set.
	GeoIPConfig *RecordGeoIPConfig `json:"geo_ip_config,omitempty"`

	// Precisely one of GeoIPConfig, ServiceUpConfig, ViewConfig, WeightedConfig must be set.
	ServiceUpConfig *RecordServiceUPConfig `json:"service_up_config,omitempty"`

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

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

type RecordChange

type RecordChange struct {

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

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

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

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

type RecordChangeAdd

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

type RecordChangeClear

type RecordChangeClear struct {
}

type RecordChangeDelete

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

	Name string `json:"name"`
	// Type
	//
	// Default value: unknown
	Type RecordType `json:"type"`
}

type RecordChangeSet

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

	Name string `json:"name"`

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

	TTL uint32 `json:"ttl"`
	// Type
	//
	// Default value: unknown
	Type RecordType `json:"type"`
}

type RecordGeoIPConfig

type RecordGeoIPConfig struct {
	Filters []*RecordGeoIPConfigFilter `json:"filters"`

	Default string `json:"default"`
}

type RecordGeoIPConfigFilter

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

	Continents []string `json:"continents"`

	Data string `json:"data"`
}

type RecordServiceUPConfig

type RecordServiceUPConfig 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 RecordServiceUPConfigStrategy `json:"strategy"`
}

type RecordServiceUPConfigStrategy

type RecordServiceUPConfigStrategy string

func (RecordServiceUPConfigStrategy) MarshalJSON

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

func (RecordServiceUPConfigStrategy) String

func (enum RecordServiceUPConfigStrategy) String() string

func (*RecordServiceUPConfigStrategy) UnmarshalJSON

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

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"`
}

type RecordViewConfigView

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

	Data string `json:"data"`
}

type RecordWeightedConfig

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

type RecordWeightedConfigWeightedIP

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

	Weight uint32 `json:"weight"`
}

type RefreshDNSZoneRequest

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

	RecreateDNSZone bool `json:"recreate_dns_zone"`

	RecreateSubDNSZone bool `json:"recreate_sub_dns_zone"`
}

type RefreshDNSZoneResponse

type RefreshDNSZoneResponse struct {
	DNSZones []*DNSZone `json:"dns_zones"`
}

RefreshDNSZoneResponse refresh dns zone response

type RegisterExternalDomainRequest

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

	OrganizationID string `json:"organization_id"`
}

type RenewDomainRequest

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

	Period uint32 `json:"period"`
}

type RestoreDNSZoneVersionRequest

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

	Version string `json:"-"`
}

type RestoreDNSZoneVersionResponse

type RestoreDNSZoneVersionResponse struct {
}

RestoreDNSZoneVersionResponse restore dns zone version response

type SearchAPI

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

SearchAPI domain API

Manage your domain zones and records.

func NewSearchAPI

func NewSearchAPI(client *scw.Client) *SearchAPI

NewSearchAPI returns a SearchAPI object from a Scaleway client.

func (*SearchAPI) ListTlds

ListTlds list available TLDs

Returns a list of all Top-Level-Domain available.

func (*SearchAPI) SearchAvailableDomains

SearchAvailableDomains search available domains

Search a domain (you can search multiple domains by separate them with a comma). With their corresponding price:

  • `creation` price for a new domain.
  • `renew` price for an owned domain.
  • `transfer` price for a domain not owned on this registrar.

If the TLD list is empty or not set. The search returns the results from the most popular TLDs.

type SearchAPIListTldsRequest

type SearchAPIListTldsRequest struct {
	// Page page required
	Page *int32 `json:"-"`
	// PageSize number of tlds by page
	PageSize *uint32 `json:"-"`
	// OrderBy field to use to order
	//
	// Default value: popularity_asc
	OrderBy ListTldsRequestOrderBy `json:"-"`
	// Tlds array of tlds to search on
	Tlds []string `json:"-"`
}

type SearchAPISearchAvailableDomainsRequest

type SearchAPISearchAvailableDomainsRequest struct {
	// Search string to search on
	Search string `json:"-"`
	// Tlds array of tlds to search on
	Tlds []string `json:"-"`
}

type SearchAvailableDomainsResponse

type SearchAvailableDomainsResponse struct {
	// Domains array of domains summaries
	Domains []*AvailableDomain `json:"domains"`
}

SearchAvailableDomainsResponse search available domains response

type Task

type Task struct {
	Domain *string `json:"domain"`
	// Type
	//
	// Default value: unknown
	Type TaskType `json:"type"`
	// Status
	//
	// Default value: unavailable
	Status TaskStatus `json:"status"`

	StartedAt time.Time `json:"started_at"`

	UpdatedAt time.Time `json:"updated_at"`

	ID string `json:"id"`

	Message string `json:"message"`
}

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 tLD extension
	Name string `json:"name"`
	// Prices prices summary
	Prices *TldPrice `json:"prices"`
	// Infos infos summary
	Infos *TldInfo `json:"infos"`
}

Tld tld

type TldInfo

type TldInfo struct {
	Dnssec bool `json:"dnssec"`

	PeriodMin uint32 `json:"period_min"`

	PeriodMax uint32 `json:"period_max"`

	IsDiscount bool `json:"is_discount"`

	RealPrice *TldPrice `json:"real_price"`

	IdnSupport bool `json:"idn_support"`
}

type TldPrice

type TldPrice struct {
	Creation *scw.Money `json:"creation"`

	Renew *scw.Money `json:"renew"`

	Transfer *scw.Money `json:"transfer"`

	Trade *scw.Money `json:"trade"`

	Restore *scw.Money `json:"restore"`
}

type TradeDomainRequest

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

	OrganizationID *string `json:"organization_id"`

	// Precisely one of Contact, ContactID must be set.
	ContactID *string `json:"contact_id,omitempty"`

	// Precisely one of Contact, ContactID must be set.
	Contact *NewContact `json:"contact,omitempty"`
}

type TransferDomainRequest

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

	AuthCode string `json:"auth_code"`

	OrganizationID string `json:"organization_id"`

	// Precisely one of Contact, ContactID must be set.
	ContactID *string `json:"contact_id,omitempty"`

	// Precisely one of Contact, ContactID must be set.
	Contact *NewContact `json:"contact,omitempty"`

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

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

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

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

type UnlockDomainTransferRequest

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

type UpdateContactRequest

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

	Email *string `json:"email"`

	EmailAlt *string `json:"email_alt"`

	PhoneNumber *string `json:"phone_number"`

	FaxNumber *string `json:"fax_number"`

	Address1 *string `json:"address1"`

	Address2 *string `json:"address2"`

	Zip *string `json:"zip"`

	City *string `json:"city"`

	Country *string `json:"country"`

	Vat *string `json:"vat"`

	Siret *string `json:"siret"`
	// Lang
	//
	// Default value: lang_unknown
	Lang Lang `json:"lang"`

	Resale *bool `json:"resale"`

	Question1 *string `json:"question1"`

	Answer1 *string `json:"answer1"`

	Question2 *string `json:"question2"`

	Answer2 *string `json:"answer2"`

	Question3 *string `json:"question3"`

	Answer3 *string `json:"answer3"`

	Question4 *string `json:"question4"`

	Answer4 *string `json:"answer4"`

	Question5 *string `json:"question5"`

	Answer5 *string `json:"answer5"`

	ExtensionFr *ExtensionFR `json:"extension_fr"`

	ExtensionEu *ExtensionEU `json:"extension_eu"`
}

type UpdateDNSZoneNameserversRequest

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

	Ns []*Nameserver `json:"ns"`
}

type UpdateDNSZoneNameserversResponse

type UpdateDNSZoneNameserversResponse struct {
	Ns []*Nameserver `json:"ns"`
}

UpdateDNSZoneNameserversResponse update dns zone nameservers response

type UpdateDNSZoneRecordsRequest

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

	Changes []*RecordChange `json:"changes"`

	ReturnAllRecords *bool `json:"return_all_records"`
}

type UpdateDNSZoneRecordsResponse

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

UpdateDNSZoneRecordsResponse update dns zone records response

type UpdateDNSZoneRequest

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

	NewDNSZone *string `json:"new_dns_zone"`

	OrganizationIDs *[]string `json:"organization_ids"`
}

type UpdateDomainRequest

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

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

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

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

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

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

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

type Version

type Version struct {
	CreatedAt time.Time `json:"created_at"`
}

type ZoneSSL

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

	AlternativeDNSZones []string `json:"alternative_dns_zones"`
	// Status
	//
	// Default value: unknown
	Status ZoneSSLStatus `json:"status"`

	PrivateKey []string `json:"private_key"`

	Certificate []string `json:"certificate"`

	CreatedAt time.Time `json:"created_at"`

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

type ZoneSSLStatus

type ZoneSSLStatus string

func (ZoneSSLStatus) MarshalJSON

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

func (ZoneSSLStatus) String

func (enum ZoneSSLStatus) String() string

func (*ZoneSSLStatus) UnmarshalJSON

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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL