Metaregistrar EPP documentation

All SSL commands: (create) (delete) (info) (renew) (reissue) (poll)

SSL Poll

The command to poll for EPP messages has not changed. However, additional fields have been added to the poll response message when you receive messages about your SSL certificates.

It might be that you do not want the SSL poll messages to be intermixed with the poll messages that come from domain names. For this, you can enable or disable receiving SSL poll messages per EPP login. By default, receiving of SSL messages is switched off for new EPP users, so if you want to switch this on, login to the Metaregistrar control panel, look for the EPP user logins, and edit the settings.

Hereunder we show the command to receive poll messages once more (this command has not changed). After that, this page shows the possible responses that you can receive.

Poll command

<?xml version="1.0" encoding="UTF-8"?> <epp xmlns="urn:ietf:params:xml:ns:epp-1.0"> <command> <poll op="req"></poll> <clTRID>57d006e26bcc9</clTRID> </command> </epp>

Poll response: SSL status was updated

The [ssl:status] field will tell you the status of the SSL request

<?xml version="1.0" encoding="UTF-8"?> <epp xmlns="urn:ietf:params:xml:ns:epp-1.0" xmlns:ssl="http://www.metaregistrar.com/epp/ssl-1.0" > <response> <result code="1301"> <msg>Command completed successfully; ack to dequeue</msg> </result> <resData> <ssl:infData> <ssl:certificateId>1</ssl:certificateId> <ssl:provisioningId><![CDATA[12f83a6d81b79fed1]]></ssl:provisioningId> <ssl:commonName><![CDATA[example.com]]></ssl:commonName> <ssl:status><![CDATA[requested]]></ssl:status> <ssl:created><![CDATA[2018-04-11 10:50:28 UTC]]></ssl:created> <ssl:modified><![CDATA[2018-04-12 07:43:30 UTC]]></ssl:modified> <ssl:update> <ssl:step><![CDATA[create_product]]></ssl:step> <ssl:message><![CDATA[certificate reference created]]></ssl:message> </ssl:update> </ssl:infData> </resData> <msgQ count="1" id="602"> <qDate>2018-04-12T07:43:31.000000+0200</qDate> <msg lang="en"><![CDATA[There is an update for certificate request #1]]></msg> </msgQ> <trID> <clTRID>5acf0f2179a1d</clTRID> <svTRID>01c5b298f791c77a2d19cbbe0995fc5bee0bee16b9aa</svTRID> </trID> </response> </epp>

Poll response: Add record to your DNS

When requesting DNS validation, to validate you need to add a CNAME record to the DNS of the domain name. This information is sent to you in a poll message. <?xml version="1.0" encoding="UTF-8"?> <epp xmlns="urn:ietf:params:xml:ns:epp-1.0" xmlns:ssl="http://www.metaregistrar.com/epp/ssl-1.0"> <response> <result code="1301"> <msg>Command completed successfully; ack to dequeue</msg> </result> <resData> <ssl:infData> <ssl:certificateId>1</ssl:certificateId> <ssl:provisioningId><![CDATA[12f83a6d81b79fed1]]></ssl:provisioningId> <ssl:commonName><![CDATA[example.com]]></ssl:commonName> <ssl:status><![CDATA[requested]]></ssl:status> <ssl:created><![CDATA[2018-04-12 08:03:29 UTC]]></ssl:created> <ssl:modified><![CDATA[2018-04-12 08:03:29 UTC]]></ssl:modified> <ssl:update> <ssl:step><![CDATA[prep_environment]]></ssl:step> <ssl:subUpdate xmlns="http://www.metaregistrar.com/epp/ssl-1.0"> <ssl:messageCode><![CDATA[create_cname]]></ssl:messageCode> <ssl:message><![CDATA[dns not hosted with us; please add the cname to the dns of the domain]]></ssl:message> <ssl:name><![CDATA[example.com]]></ssl:name> <ssl:dcvType><![CDATA[DNS]]></ssl:dcvType> <ssl:dnsRecord><![CDATA[_676b2c95d75a4f0852d80753ac6091bc.example.com]]></ssl:dnsRecord> <ssl:dnsCnameValue><![CDATA[dummy_api.comodoca.com]]></ssl:dnsCnameValue> <ssl:type><![CDATA[update]]></ssl:type> </ssl:subUpdate> </ssl:update> </ssl:infData> </resData> <msgQ count="1" id="602"> <qDate>2018-04-12T08:03:30.000000+0200</qDate> <msg lang="en"><![CDATA[There is an update for certificate request #1]]></msg> </msgQ> <trID> <clTRID>5acf134c349b6</clTRID> <svTRID>MTR_3d19b481a2675fec630d0aa15b95e4a59c28e5279867</svTRID> </trID> </response> </epp>

Poll response: Add a file to your website

When requesting FILE validation, to validate your client will have to add a file with a certain name to their webpage. This poll message tells you which file is to be added and which text has to be in the file, so you can convey this message to your client, or put the file on the server yourself. <?xml version="1.0" encoding="UTF-8"?> <epp xmlns="urn:ietf:params:xml:ns:epp-1.0" xmlns:ssl="http://www.metaregistrar.com/epp/ssl-1.0" > <response> <result code="1301"> <msg>Command completed successfully; ack to dequeue</msg> </result> <resData> <ssl:infData> <ssl:certificateId>1</ssl:certificateId> <ssl:provisioningId><![CDATA[12f83a6d81b79fed1]]></ssl:provisioningId> <ssl:commonName><![CDATA[example.com]]></ssl:commonName> <ssl:status><![CDATA[requested]]></ssl:status> <ssl:created><![CDATA[2018-04-12 08:13:36 UTC]]></ssl:created> <ssl:modified><![CDATA[2018-04-12 08:13:36 UTC]]></ssl:modified> <ssl:update> <ssl:step><![CDATA[prep_environment]]></ssl:step> <ssl:subUpdate xmlns="http://www.metaregistrar.com/epp/ssl-1.0"> <ssl:messageCode><![CDATA[create_file]]></ssl:messageCode> <ssl:message><![CDATA[Please create the file in the following location]]></ssl:message> <ssl:name><![CDATA[example.com]]></ssl:name> <ssl:dcvType><![CDATA[FILE]]></ssl:dcvType> <ssl:fileLocation><![CDATA[example.com/.well-known/pki-validation/e280837e93....613821de8]]></ssl:fileLocation> <ssl:fileContents><![CDATA[hash_content_of_the_file]]></ssl:fileContents> <ssl:type><![CDATA[update]]></ssl:type> </ssl:subUpdate> </ssl:update> </ssl:infData> </resData> <msgQ count="1" id="602"> <qDate>2018-04-12T08:13:37.000000+0200</qDate> <msg lang="en"><![CDATA[There is an update for certificate request #1]]></msg> </msgQ> <trID> <clTRID>5acf1562ace79</clTRID> <svTRID>MTR_84c141a914624019e986f9224a4d6c1c6672405101af</svTRID> </trID> </response> </epp>

Poll response: Certificate billed

Requesting a certificate can be a lengthy process, but there is a certain point where the certificate will be issued and you will be invoiced for this certificate. This poll message indicates that the certificate will be billed, you can bill your customer now. <?xml version="1.0" encoding="UTF-8"?> <epp xmlns="urn:ietf:params:xml:ns:epp-1.0" xmlns:ssl="http://www.metaregistrar.com/epp/ssl-1.0"> <response> <result code="1301"> <msg>Command completed successfully; ack to dequeue</msg> </result> <resData> <ssl:infData> <ssl:certificateId>1</ssl:certificateId> <ssl:provisioningId><![CDATA[12f83a6d81b79fed1]]></ssl:provisioningId> <ssl:commonName><![CDATA[example.com]]></ssl:commonName> <ssl:status><![CDATA[requested]]></ssl:status> <ssl:created><![CDATA[2018-04-12 08:03:29 UTC]]></ssl:created> <ssl:modified><![CDATA[2018-04-12 08:03:29 UTC]]></ssl:modified> <ssl:update> <ssl:step><![CDATA[billing]]></ssl:step> <ssl:message><![CDATA[certificate billed]]></ssl:message> </ssl:update> </ssl:infData> </resData> <msgQ count="1" id="602"> <qDate>2018-04-12T08:06:21.000000+0200</qDate> <msg lang="en"><![CDATA[There is an update for certificate request #1]]></msg> </msgQ> <trID> <clTRID>5acf1462b1da5</clTRID> <svTRID>MTR_bfe071a73d04251b73d35395d0d22031ad084fe95a47</svTRID> </trID> </response> </epp>

Poll response: Certificate is ready

The certificate is ready, and can be downloaded via the download link provided in this message. You can send this download link to your customer, or use it to put the certificate on the website of the client. <?xml version="1.0" encoding="UTF-8"?> <epp xmlns="urn:ietf:params:xml:ns:epp-1.0" xmlns:ssl="http://www.metaregistrar.com/epp/ssl-1.0"> <response> <result code="1301"> <msg>Command completed successfully; ack to dequeue</msg> </result> <resData> <ssl:infData> <ssl:certificateId>1</ssl:certificateId> <ssl:provisioningId><![CDATA[12f83a6d81b79fed1]]></ssl:provisioningId> <ssl:commonName><![CDATA[example.com]]></ssl:commonName> <ssl:status><![CDATA[active]]></ssl:status> <ssl:created><![CDATA[2018-04-11 10:50:28 UTC]]></ssl:created> <ssl:modified><![CDATA[2018-04-12 07:43:30 UTC]]></ssl:modified> <ssl:downloadLink><![CDATA[https://dx.metaregistrar.com/dx/6aa9fb1cad457464c0473...13bd3fb3]]></ssl:downloadLink> <ssl:update> <ssl:step><![CDATA[send_certificate]]></ssl:step> <ssl:message><![CDATA[certificate ready for download]]></ssl:message> </ssl:update> </ssl:infData> </resData> <msgQ count="1" id="602"> <qDate>2018-04-12T07:57:23.000000+0200</qDate> <msg lang="en"><![CDATA[There is an update for certificate request #1]]></msg> </msgQ> <trID> <clTRID>5acf11b16ee42</clTRID> <svTRID>MTR_13dd93c48956843a051b1a02c3d1f2c06f950f4448b4</svTRID> </trID> </response> </epp>