Guides
Guides

get_cert

Returns the certificate for the specified SSL service product as well as associated product information.

Suggest Edits

Request parameters

Standard request parameters

  • action = get_cert
  • object = trust_service

Request attributes

Parameters within the attributes associative array are described below:

ParameterObligationDefinition/Value
product_idRequiredThe SSL service product ID number.
return_ca_certsOptionalIf this parameter is included and set to 1, the response will include root CA and intermediate certificates.
return_pkcs7_certOptionalIf this parameter is included and set to 1, the response will include the PKCS7 format certificate.

Response parameters

Standard response parameters

  • action = reply
  • object = trust_service
  • is_success = Boolean indicating success or failure of the request.
  • response_code = Response code indicating outcome of the request.
  • response_text = Message describing the outcome of the request.

Response attributes

If the request is successful, the attributes associative array may include the following:

ParameterObligationDefinition/Value
cert_dataAlways returnedThe SSL service certificate, for more information please see the cert_data table below.
contact_emailAlways returnedThe contact email address that was submitted with the SSL service order; may be the admin email address or the organization email address, depending on the product type.
domainAlways returnedThe domain associated with the SSL service.
expiry_dateAlways returnedThe date the SSL service expires.
issue_dateAlways returnedThe date the SSL service was issued.
product_idAlways returnedThe product ID number for the SSL service.
product_typeAlways returnedThe product type of the SSL service.
start_dateAlways returnedThe start date of the SSL service.
stateAlways returnedThe state of the product. Allowed values are:
expired
active
renewing
renewed
revoked

Response parameters within the cert_data associative array may include the following:

ParameterObligationDefinition/Value
ca_certificatesReturned if return_ca_certs=1An array that includes the root CA or intermediate CA certificates in order.
Note: Trustwave products do not return CA certificates; however, the intermediate bundle can be downloaded by visiting the Trustwave Support page.
certificateAlways returnedThe SSL certificate issued.
pkcs7Returned if return_pkcs7_cert=1The PKCS7 format certificate issued.

Example

<?xml version='1.0' encoding='UTF-8'?>
<OPS_envelope>
    <header>
        <version>0.9</version>
    </header>
    <body>
        <data_block>
            <dt_assoc>
                <item key="protocol">XCP</item>
                <item key="action">get_cert</item>
                <item key="object">trust_service</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="product_id">2096</item>
                    </dt_assoc>
                </item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<OPS_envelope>
  <header>
    <version>0.9</version>
  </header>
  <body>
    <data_block>
      <dt_assoc>
        <item key="protocol">XCP</item>
        <item key="action">REPLY</item>
        <item key="object">TRUST_SERVICE</item>
        <item key="is_success">1</item>
        <item key="response_text">Command completed successfully.</item>
        <item key="response_code">200</item>
        <item key="attributes">
          <dt_assoc>
            <item key="cert_data">
              <dt_assoc>
                <item key="certificate"
                  -----BEGIN CERTIFICATE REQUEST-----
                  MIICuzCCAaMCADB3MQswCQYDVQQGEwJVUzEUMBIGA1UEAxMLZXhhbXBsZS5jb20x
                  FDASBgNVBAcTC1NhbnRhIENsYXJhMRUwEwYDVQQKEwxFeGFtcGxlIEluYy4xEzAR
                  BgNVBAgTCkNhbGlmb3JuaWExEDAOBgNVBAsTB1N1cHBvcnQwggEiMA0GCSqGSIb3
                  DQEBAQUAA4IBDwAwggEKAoIBAQDTCJ1qnH3gaKVd8VXTOx5GR+MYinU36Z9psxuG
                  haMZ70qhTwng5zcbC93XIpAJRkbMwMu1EI10QDNi91Z4ORI9ExbBg0HBrAz+k85O
                  lMUk1xTR8FQ8eHWXLnL3uXDevi5XMsb0ASB6wADDdvVm2Eb4qu+B1KD5qCSPiRJ2
                  FLeNNI3JNosmKmtmhqgy6+0qYYTP5RPFJeIu55cvX+r9ghiL11eBg/A+3RBhLdLR
                  +z0CsngOFMlNxzmP0csINw4FIj4AoAkMiA/2Hf6rT6bHiAtJDbkW6jAS3AQjB1IC
                  LlkFbr12e5P7USqSsKSbwslOHHBJpfYceA6582MI4ZZ3CerNAgMBAAGgADANBgkq
                  hkiG9w0BAQsFAAOCAQEAaUwWHGCekeDC9U0OqLHlaXT9yRTpBcMu3waqWWhIgxLP
                  6ut1YlYjz1yAc7XIJPNo+uyXX1BtrMpGgXt7cJmwLeXPHHs1WoleQfKOGjVRf3+8
                  sQgdVroMR8HtOPid00Vxd4v1caUQtM7N2e2sWe5IL5OS2ziAflc3UhSoLu7JQwNg
                  pKCQbOVbq5Y+uWYmMkKaZewIiziUvqngUMgA2ci+BJ2xCZmq00Leq+AZMLKPI2NE
                  NcKsc4yjB4envG4vzc4qMFQakvH0uvsswZc80H7R7neThUgpfQM+PhDI/z3woTPG
                  exAECZo+AqWhnwdut/Socu+aFkMO0vl77JD4acjODA==
                  -----END CERTIFICATE REQUEST-----
                </item>
              </dt_assoc>
            </item>
            <item key="expiry_date">2012-05-08T07:34:49.000-04:00</item>
            <item key="state">active</item>
            <item key="product_type">quickssl</item>
            <item key="domain">example.com</item>
            <item key="issue_date">2012-04-30T11:27:59.000-04:00</item>
            <item key="product_id">2096</item>
            <item key="contact_email">[email protected]</item>
            <item key="start_date">2012-04-28T19:42:30.000-04:00</item>
          </dt_assoc>
        </item>
      </dt_assoc>
    </data_block>
  </body>
</OPS_envelope>

Updated about 2 years ago