get_cert

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

📘

Note:

This command can only be used for orders whose status is Completed.

Request parameters for get_cert

Standard parameters

  • action = get_cert
  • object = trust_service

Attributes

Parameters within the attributes associative array are described below.

Parameter name

Obligation

Definition/Value

product_id

Required

The SSL Service ID number.

return_ca_certs

Optional

If this parameter is included and set to 1, the response will include root CA and intermediate certificates.

return_pkcs7_cert

Optional

If this parameter is included and set to 1, the response will include the PKCS#7 format certificate.

Response parameters for get_cert

Standard parameters

  • action = reply
  • object = trust_service
  • is_success = a Boolean is returned, 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

Attributes

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

Parameter name

Obligation

Definition/Value

cert_data

Returned if is_success = true

The SSL Service Certificate.
For more information, see the cert_data table below.

contact_email

Returned if is_success = true

The 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.

Note: The contact_email value can be updated by using the update_product command.

domain

Returned if is_success = true

The domain with which the SSL Service is associated.

expiry_date

Returned if is_success = true

The date on which the SSL Service certificate expires.

issue_date

Returned if is_success = true

The date on which the SSL Service certificate was issued.

product_id

Returned if is_success = true

The ID number for the SSL Service.

product_type

Returned if is_success = true

The SSL Service product type. Allowed values are:

  • comodo_ev

  • comodo_instantssl

  • comodo_premiumssl

  • comodo_premiumssl_wildcard

  • comodo_ssl

  • comodo_wildcard

  • essentialssl

  • essentialssl_wildcard

  • positivessl

  • malwarescan

  • quickssl

  • quickssl_premium

  • securesite

  • securesite_pro

  • securesite_ev

  • securesite_pro_ev

  • sgcsuper_certs

  • sitelock_basic

  • sitelock_premium

  • sitelock_enterprise

  • sitelock_find

  • sitelock_fix

  • sitelock_prevent

  • sitelock_911

  • ssl123

  • sslwebserver

  • sslwebserver_wildcard

  • sslwebserver_ev

  • symantec_ssl_lite

  • symantec_ssl_lite_wildcard

  • truebizid

  • truebizid_ev

  • truebizid_wildcard

  • truste_hpp (Hosted Privacy Policy)

  • truste_tps (TRUSTE Privacy Policy with seal)

  • trustwave_dv

  • trustwave_ev

  • trustwave_premiumssl

  • trustwave_premiumssl_wildcard

Please note: Sitelock products are changing as of July 2015. Values for outgoing products (sitelock_basic, sitelock_premium, sitelock_enterprise) will remain in place for the near future.

start_date

Returned if is_success = true

The effective date for the SSL service.

state

Returned if is_success = true

The state of the product. Allowed values are:

  • expired
  • active
  • renewing
  • renewed
  • revoked

cert_data

Parameters within the cert_data associative array are described below.

Parameter name

Obligation

Definition/Value

ca_certificates

Returned if return_ca_certs = 1

An array that includes the ROOT or Intermediate CA certificates chain, in order.
Note: Trustwave does not return CA certificates; however, the intermediate bundle can be downloaded by visiting the TrustwaveSupport page.

certificate

Returned if
is_success = true

The SSL service certificate that was issued.

pkcs7

Returned if
return_pkcs7_cert =1

The PKCS#7 format certificate that was issued.

Example for get_cert

Example

Uses the product ID to retrieve the properties for a Trust Service product.

Request

<?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>

Response

<?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-----
                                    MIIEUTCCAzmgAwIBAgIDAX8yMA0GCSqGSIb3DQEBBQUAME8xCzAJBgNVBAYTAlVT MRUwEwYDVQQKEwxHZW9UcnVzdCBJbmMxKTAnBgNVBAMTIEdlb1RydXN0IFByZS1Q cm9kdWN0aW9uIFNVQiBDQSAzMB4XDTEyMDQyODIzNDIzMFoXDTEyMDUwODExMzQ0 OVowgZoxEzARBgNVBAsTCkdUMDgzMjUxNzMxMTAvBgNVBAsTKFNlZSB3d3cucmFw aWRzc2wuY29tL3Jlc291cmNlcy9jcHMgKGMpMTIxLzAtBgNVBAsTJkRvbWFpbiBD b250cm9sIFZhbGlkYXRlZCAtIFJhcGlkU1NMKFIpMR8wHQYDVQQDExZyYXBpZC5x YXJlZ3Jlc3Npb24ub3JnMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA 01fy13nKyEaR7BcXW/ZOzrgNbW/v57Q4HtJsFLhakoVU30C6N+xUwZMVMTpMlq5f xmHjC8/bJN1vho9l3EI9W+QEFXcyh3O9F/11SPqFxStjA/F1R5uzIQuMwMpe4Z3o EPAusTDDEZDn6KtDMrsjgDRXNUL6IjWHTErj9G4bl13bwqBUy6LyCQoGOpME5qNA skJ3HWdv99xJy4b1XjOw5qekIrYYXcslV3INDnV+V+jR/LuU+JuqTaZKL5fnIp5i
                                    n6WDTK1EYQ7L1KnA4WlXL0cOy7xCnH2AjR5iV+gOX0mypJ0RbCYWMWfQC+1BxLVP /wlljvTkIaZkiGkJPz3KUwIDAQABo4HpMIHmMB8GA1UdIwQYMBaAFGV1riJo592U KxNo1SwYK4YYVaDFMA4GA1UdDwEB/wQEAwIFoDAhBgNVHREEGjAYghZyYXBpZC5x YXJlZ3Jlc3Npb24ub3JnMEQGA1UdHwQ9MDswOaA3oDWGM2h0dHA6Ly90ZXN0LWNy bC5nZW90cnVzdC5jb20vY3Jscy9wcmVwcm9kc3ViY2EzLmNybDAMBgNVHRMBAf8E AjAAMB0GA1UdDgQWBBQDOAEoYLLChTqOW8wOPRiHwcgQMjAdBgNVHSUEFjAUBggr BgEFBQcDAQYIKwYBBQUHAwIwDQYJKoZIhvcNAQEFBQADggEBAMBPQE2zs+68mvwQ xWs5ajDPkDerr5IGWwAPx9n9YonnIydHuB5wqAN6tr34f8wT4hqwMhGO1JPZzEyF I3flV4Ca5P14bpLC96G4O8/XDG0off2tDYf5OVQgbNP/s93mvMhSo3jAHN3Enpn0 iLDRXuc+UVFmiakLrANsVGKzMReBeWtk0tej6ONSC0Ds6PGrlzHSXcWHR9WD1dVF +1vKnaS2pp4nXBQthh1wbvk8+VekrYRaPy/5h3/9hRHVb85rb8hbLWSBfN6oyLRw KZnecg3wOB449Hfi072JKEgEViBkuYJLr94KQ8gTSEtDlGmSLGCZaGsrtgmNbyne aNzofSA=
                                    -----END CERTIFICATE-----</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>