Service.DNS

DNS methods.

Summary
Service.DNSDNS methods.
Functions
createDomainCreate a new domain name.
listDomainsList domains that match optional criteria.
destroyDomainDestory a domain and all its related records.
createRecordCreate a domain record on a previously existing domain.
updateRecordUpdate a domain record by its id.
listRecordsList all records matching optional criteria.
destroyRecordDelete a single domain record by id.
destroyRecordsByNameDelete all records by DomainName and DomainRecordName

Functions

createDomain

Create a new domain name.  Necessary before creating records.  The ‘name’ must be globally unique, so only use fully qualified domain names.  If the domain already exists (created by you or someone else), an InvalidArguments exception will be raised on the ‘name’ argument.

Parameters

customerIdno docs (idx: 1, type: Types.CustomerId, optional)
nameno docs (idx: 2, type: Types.DomainName)

Returns

Types.DomainDetails

Throws

Exceptions.InvalidArguments (idx: 1)

Roles

  • customer

listDomains

List domains that match optional criteria.

Parameters

customerIdno docs (idx: 1, type: Types.CustomerId, optional)
nameno docs (idx: 2, type: Types.DomainName, optional)
domainIdno docs (idx: 3, type: Types.DomainId, optional)

Returns

Thrift.list (Types.DomainDetails)

Throws

Exceptions.InvalidArguments (idx: 1)

Roles

  • customer

destroyDomain

Destory a domain and all its related records.  Provide ‘id’ or ‘name’ to refer to the domain, but not both.

Parameters

idno docs (idx: 1, type: Types.DomainId, optional)
nameno docs (idx: 2, type: Types.DomainName, optional)

Returns

Thrift.void

Throws

Exceptions.InvalidArguments (idx: 1)

Roles

  • customer

createRecord

Create a domain record on a previously existing domain.  If the record already exists, no error will be thrown.  Provide ‘domainId’ or ‘domainName’ to refer to the domain, but not both.

Parameters

domainIdno docs (idx: 1, type: Types.DomainId, optional)
domainNameno docs (idx: 2, type: Types.DomainName, optional)
nameno docs (idx: 3, type: Types.DomainRecordName)
typeno docs (idx: 4, type: Types.DomainRecordType)
contentno docs (idx: 5, type: Types.DomainRecordContent)
ttlno docs (idx: 6, type: Types.DomainRecordTTL, optional)
priorityno docs (idx: 7, type: Types.DomainRecordPriority, optional)

Returns

Types.DomainRecordDetails

Throws

Exceptions.InvalidArguments (idx: 1)

Roles

  • customer

updateRecord

Update a domain record by its id.

Parameters

idno docs (idx: 1, type: Types.DomainRecordId)
nameno docs (idx: 2, type: Types.DomainRecordName, optional)
typeno docs (idx: 3, type: Types.DomainRecordType, optional)
contentno docs (idx: 4, type: Types.DomainRecordContent, optional)
ttlno docs (idx: 5, type: Types.DomainRecordTTL, optional)
priorityno docs (idx: 6, type: Types.DomainRecordPriority, optional)

Returns

Types.DomainRecordDetails

Throws

Exceptions.InvalidArguments (idx: 1)

Roles

  • customer

listRecords

List all records matching optional criteria.  Must provide a domain.  Provide ‘domainId’ or ‘domainName’ to refer to the domain, but not both.

Parameters

domainIdno docs (idx: 1, type: Types.DomainId, optional)
domainNameno docs (idx: 2, type: Types.DomainName, optional)
nameno docs (idx: 3, type: Types.DomainRecordName, optional)
typeno docs (idx: 4, type: Types.DomainRecordType, optional)
contentno docs (idx: 5, type: Types.DomainRecordContent, optional)
ttlno docs (idx: 6, type: Types.DomainRecordTTL, optional)
priorityno docs (idx: 7, type: Types.DomainRecordPriority, optional)

Returns

Thrift.list (Types.DomainRecordDetails)

Throws

Exceptions.InvalidArguments (idx: 1)

Roles

  • customer

destroyRecord

Delete a single domain record by id.

Parameters

idno docs (idx: 1, type: Types.DomainRecordId)

Returns

Thrift.void

Throws

Exceptions.InvalidArguments (idx: 1)

Roles

  • customer

destroyRecordsByName

Delete all records by DomainName and DomainRecordName

Parameters

domainno docs (idx: 1, type: Types.DomainName)
nameno docs (idx: 2, type: Types.DomainRecordName)

Returns

Thrift.void

Throws

Exceptions.InvalidArguments (idx: 1)

Roles

  • customer
Base type Thrift.i16
Base type Thrift.string
A representation of a domain
Base type Thrift.i32
A Thrift built-in type.
A Thrift built-in type.
Base type Thrift.string
Base type Thrift.string
Base type Thrift.i32
Base type Thrift.i16
A representation of a domain record
Base type Thrift.i32
Close