Check keygroup

Purpose

to check the existence of a keygroup.

Specify one <keygroup:name> element for every keygroup that you want to check:

• <keygroup:name> is required. Contains the name of the keygroup.

Many keygroup objects can be checked with a single check command.

Please refer to the examples to see a complete request.

Examples

A check keygroup command for 2 objects looks like:

<?xml version="1.0" encoding="UTF-8"?>
<epp xmlns="urn:ietf:params:xml:ns:epp-1.0">
 <command>
  <check>
   <keygroup:check xmlns:keygroup="http://www.dns.be/xml/epp/keygroup-1.0">
     <keygroup:name>mykeygroup</keygroup:name>
     <keygroup:name>otherkeygroup</keygroup:name>
   </keygroup:check>
  </check>
  <clTRID>check-keygroup</clTRID>
 </command>
</epp>

In case of success, the EPP server responds:

<?xml version="1.0" encoding="UTF-8"?>
<epp xmlns="urn:ietf:params:xml:ns:epp-1.0" xmlns:keygroup="http://www.dns.be/xml/epp/keygroup-1.0">
  <response>
    <result code="1000">
      <msg>Command completed successfully</msg>
    </result>
    <resData>
      <keygroup:chkData>
        <keygroup:cd>
          <keygroup:name avail="false">mykeygroup</keygroup:name>
        </keygroup:cd>
        <keygroup:cd>
          <keygroup:name avail="true">otherkeygroup</keygroup:name>
        </keygroup:cd>
      </keygroup:chkData>
    </resData>
    <trID>
      <clTRID>check-keygroup</clTRID>
      <svTRID>dnsbe-0</svTRID>
    </trID>
  </response>
</epp>

The following information can be seen in the reply:

• <keygroup:name> Contains the name of the keygroup that was checked. The ‘avail’ attribute contains a value of ‘false’ if the keygroup is not available, a value of ‘true’ if the keygroup is available, at the time of the check.

There is an entry in the command for each of the keygroups that were checked.