getWafBypass — Retrieving the current bypass state

The getWafBypass method retrieves the current Firewall & CDN bypass status. The Firewall & CDN bypass state is also available on the SiteLock Dashboard.

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
- getWafOrigin: The method name
  - site_id: The ID of the site for which to retrieve the bypass state

Example request

<SiteLockOnlineRequest>
    <authentication>
        <user>Username</user>
        <password>Password</password>
    </authentication>
    <getWafBypass>
        <site_id>1234567</site_id>
    </getWafBypass>
</SiteLockOnlineRequest>

Response format

SiteLockOnlineResponse: This element is used to delineate the full API response.
- getWafBypass: The method name
  - bypass_status: The bypass status. The possible values are off and on.
  - use_true_shield: The Firewall & CDN protection status. The possible values are 1 and 0
  - use_true_speed: The CDN caching status. The possible values are 1 or 0.
  - status: The possible values are ok and error.

Example response

<SiteLockOnlineResponse>
    <getWafBypass>
        <bypass_status>off</bypass_status>
        <use_true_shield>1</use_true_shield>
        <use_true_speed>1</use_true_speed>
        <status>ok</status>
    </getWafBypass>
</SiteLockOnlineResponse>