getSSLHost — Retrieving an SSL host

The getSSLHost method retrieves a hostname for which an SSL check is conducted.

The API endpoint is:

https://api.sitelock.com/v1/partner

Request format

SiteLockOnlineRequest: This element is used to delineate the full API request.
- authentication: The partner’s username, password, and branding
  - username: The partner’s API username
  - password: The partner’s API password
- getSSLHost: The method name
  - site_id: (Repeatable) The ID of the site for which to retrieve the hostname. An alternative method is to pass the account_id element instead of one or more site_id elements, which will return all sites and their hostnames for that account.

Example request

<SiteLockOnlineRequest>
    <authentication>
        <user>Username</user>
        <password>Password</password>
    </authentication>
    <getSSLHost>
        <site_id>10900</site_id>
        <site_id>10800</site_id>
    </getSSLHost>
</SiteLockOnlineRequest>

Response format

SiteLockOnlineResponse: This element is used to delineate the full API response.
- getSSLHost: The method name
  - sslhost: (Repeatable) The hostname details
    
    site_id: [attribute] - The ID of the site for which the hostname was retrieved
    
    id: [attribute] - An internal SiteLock host ID, can safely be ignored
    
    domain: [attribute] - The hostname for which an SSL check is conducted

Example response

No hosts are defined

<SiteLockOnlineResponse>
    <getSSLHost>
        <sslhost site_id="100900"/>
        <sslhost site_id="100800"/>
    </getSSLHost>
</SiteLockOnlineResponse>

Hosts have been defined

<SiteLockOnlineResponse>
    <getSSLHost>
        <sslhost site_id="100900" id="523998" domain="www.example.com" />
    </getSSLHost>
</SiteLockOnlineResponse>