loginProtectConfigAddUrl — Adding a URL

This method adds a URL to the list of protected URLs for Login Protect.

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.

      • user: The partner’s API username.

      • password: The partner’s API password.

    • loginProtectConfigAddUrl: The method name.

      • site_id: The ID of the site for which to add the protected URL.

      • urls: The list of URLs to add to the protected URLs for Login Protect.

        • url: The URL to add to the protected URLs for Login Protect.

          • value: The URL to add to the protected URLs for Login Protect.

          • pattern: The pattern used to match the URL. The possible values are:

            • prefix: The URL must start with the specified value.

            • suffix: The URL must end with the specified value.

            • contains: The URL must contain the specified value.

            • not_contains: The URL must not contain the specified value.

Example request

<SiteLockOnlineRequest>
    <authentication>
        <user>User</user>
        <password>Password</password>
    </authentication>
    <loginProtectConfigAddUrl>
        <site_id>49031907</site_id>
        <urls>
            <url>
                <value>\https://example.com/page1</value>
                <pattern>page.html</pattern>
            </url>
        </urls>
    </loginProtectConfigAddUrl>
</SiteLockOnlineRequest>

Response format

  • SiteLockOnlineResponse: This element is used to delineate the full API response.

    • loginProtectConfigAddUrl: The method name.

      • message: The message associated with the API response.

      • status: The status of the API response.

      • error: An error element containing an error code and an error message.

Example response

<SiteLockOnlineResponse>
    <loginProtectConfigAddUrl>
        <message>OK</message>
        <status>ok</status>
    </loginProtectConfigAddUrl>
</SiteLockOnlineResponse>

Error response

<SiteLockOnlineResponse>
    <loginProtectConfigAddUrl>
        <error code="NNNN">Error Msg…XXXX</error>
    </loginProtectConfigAddUrl>
</SiteLockOnlineResponse>