getSiteLockIPs — Retrieving a list of SiteLock IP addresses

The getSiteLockIPs method retrieves the updated list of SiteLock IP addresses. These addresses should be whitelisted on your servers when necessary to ensure the best performance and uninterrupted services from SiteLock.

Since SiteLock IP addresses are subject to change, we recommend calling this method regularly to ensure your whitelist is up-to-date.

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
  - partner: (Optional) The brand name to use in messaging
- getSiteLockIPs: The method name

Example request

<SiteLockOnlineRequest>
    <authentication>
        <user>Username</user>
        <password>Password</password>
    </authentication>
    <getSiteLockIPs />
</SiteLockOnlineRequest>

Response format

SiteLockOnlineResponse: This element is used to delineate the full API response.
- getSiteLockIPs: The method name
  - status: Either ok or error
  - active: Currently active IP addresses and ranges, containing the following elements:
    
    class: The type of the IP address
    
    type: [attribute] - Can have the following values:
    
    waf: A list of IP addresses used by Firewall & CDN
    
    api: A list of IP addresses used by Partner API
    
    expert services: A list of IP addresses used by manual remediation team
    
    scan: A list of IP addresses used by Site Scan
    
    smart: A list of IP addresses used by SMART
    
    wehbook: A list of IP addresses used by DNSSEC
    
    protocol: [attribute] - The value can be http, http,ftp, or http,https The class element contains one or more of the following subelements:
    
    ip: (Repeatable) An IP address
    
    ipRange: (Repeatable) A range of IPv4 addresses
    
    ipv6Range: (Repeatable) A range of IPv6 addresses
  - all: A list of all current SiteLock IP addresses and ranges:
    
    ip: (Repeatable) An IP address
    
    ipRange: (Repeatable) A range of IPv4 addresses
    
    ipv6Range: (Repeatable) A range of IPv6 addresses
  - error: The error message. This element is present if status is error.
    
    code: [attribute] - The error code

Example success response

<SiteLockOnlineResponse>
    <getSiteLockIPs>
        <status>ok</status>
        <active>
            <class type="waf" protocol="http">
                <ipRange>199.83.128.0/21</ipRange>
                ...
                <ipv6Range>2a02:e980::/29</ipv6Range>
            </class>
            <class type="api" protocol="http,ftp">
                <ip>184.154.139.53</ip>
                ...
            </class>
            <class type="expert services" protocol="http,ftp">
                <ip>184.154.121.250</ip>
                ...
            </class>
            <class type="scan" protocol="http">
                <ip>184.154.36.163</ip>
                ...
            </class>
            <class type="smart" protocol="http,ftp">
                <ip>184.154.139.56</ip>
                ...
            </class>
            <class type="webhook" protocol="http,https">
                <ip>34.231.30.97/32</ip>
                <ip>54.225.157.75/32</ip>
            </class>
        </active>
        <all>
            <ipRange>199.83.128.0/21</ipRange>
            ...
            <ip>184.154.36.163</ip>
            ...
        </all>
    </getSiteLockIPs>
</SiteLockOnlineResponse>

Example error response

<SiteLockOnlineResponse>
    <getSiteLockIPs>
        <error code="[ERROR_CODE]">[MESSAGE]</error>
    </getSiteLockIPs>
</SiteLockOnlineResponse>