BULK SELECT returns chosen fields for a list of domain names matching given filter. It is a flexible method of obtaining data for large numbers of existing domain names in a single, terse request. It is broadly similar to the LIST operation, but allows considerably more flexibility both for the set of fields and for the set of domain names returned.

Instructions

• Send to the address auto-bulk@nic.uk.
• Use the subject line TAG Bulk (replace TAG with your tag name in capitals)
• Make sure the e-mail is PGP-signed with a registered PGP key.
• Construct the message body using the template given below.

Operation template

BULK SELECT operations may include the following:

operation: bulk
select:
filter:

BULK SELECT operations consist of:

• exactly one

  operation:bulk

• exactly one select clause.
• 0 or 1 filter clause.

A select clause specifies which fields are to be returned. An optional filter clause chooses which domain names are returned by specifying criteria which they must match; if no filter clause is given, then all domain names on the requesting tag are returned.

Reply template

The exact format of the reply depends on which fields were specified in the select clause. For example, the reply to the request

operation: bulk
select: key, account-name

will be in the form

Subject: Re: TAG bulk

Domain Name List follows...
Domain name|account-name
example1.co.uk|Mr Example
example2.co.uk|Mrs Example
Number of domains in the list: 2.

If you have any questions please contact support@nominet.org.uk.

Documentation on the automaton can be found on the Nominet Web
site at http://www.nominet.org.uk/go/automaton

Your original message follows
-------------------------------------------------------------------------------
operation: bulk
select: key, account-name

Errors

After processing the operation the Automaton sends an automated reply. If there is a problem then two different error conditions may occur

• non-fatal errors (warning messages) may be appended to successful replies.
• fatal errors that prevent the operation from being carried out; an error reply is generated.

Details of the template of the error reply and the meaning of the error messages are available.

Examples

List all the domain names on the requesting tag

Omitting a filter clause returns all domain names on the requesting tag.

operation: bulk
select: key

List all the domain names on an account

This returns a list of all the domain names on the 10002 account

operation: bulk
filter: account-id = '10002'
select: key

Selecting and filtering by date

This returns a list of key, created date, and expiry date for each domain name on the requesting tag that was registered in January 2008.

operation: bulk
filter: created >= '20080101' and created < '20080201'
select: key, created, expiry

Selecting with a complex filter clause

This returns a list of key, expiry, auto-bill and account-name for all domain names on the requesting tag which are not on an account with name 'Ms Example' and expire after 3rd Feb 2010.

operation: bulk
select: key, expiry, auto-bill, account-name
filter: not account-name = 'Ms Example' and expiry > '20100203'

Selecting all domain names with a given nameserver

This returns a list of key and nameserver list for all domain names on the requesting tag whose nameserver list includes the nameserver 'ns1.example.co.uk'.

operation: bulk
filter: 'ns1.example.co.uk' in nservers
select: key, nservers

Selecting all domain names with only the given nameservers

This returns a list all domain names on the requesting tag whose nameserver list includes 'ns1.example.co.uk' and 'ns2.example.co.uk' and no other nameservers.

operation: bulk
filter: nservers = ['ns1.example.co.uk', 'ns2.example.co.uk']
select: key

Selecting all domain names with no nameservers

This returns a list of all domain names on the requesting tag with no nameservers.

operation: bulk
filter: nservers = 'NULL'
select: key