The get-pool operator is used for retrieving a list of certificates for a particular domain or for all administrator's domains.
A request XML packet that retrieves a list of certificates should include the generate operation node:
<packet>
<certificate>
<get-pool>
...
</get-pool>
</certificate>
</packet>
The get-pool node does not have a separate data type, it is nested in type CertificateActionRequest (certificate_input.xsd
). The node has the following graphical representation:
Important: When creating request packets, put nodes and elements in the order they follow in the packet structure.
The get-pool node of the output XML packet is structured as follows:
common.xsd
).common.xsd
). Allowed values: ok|error
.common.xsd
).This packet retrieves a list of certificates associated with domain example.com.
<packet>
<certificate>
<get-pool>
<filter>
<domain-name>example.com</domain-name>
</filter>
</get-pool>
</certificate>
</packet>
Response:
<packet>
<certificate>
<get-pool>
<result>
<status>ok</status>
<certificates>
<certificate>
<name>default certificate</name>
</certificate>
...
</certificates>
</result>
</get-pool>
</certificate>
</packet>
Note: Data structures that describe a number of properties are omitted to improve the readability of the sample.
This packet retrieves a list of certificates belonging to the Administrator.
<packet>
<certificate>
<get-pool>
<admin/>
</get-pool>
</certificate>
</packet>