# Cloned Web Ignore List

We have added the ability to add your own regex or website to be ignored when alerting for Cloned web Canarytokens.

This is useful if you see that your Cloned Web token is generating alerts that you deem "safe".

Cloned Web Ignore

# Disable Ignore List

POST /api/v1/canarytokens/clonedsite/ignorelist/disable

Disable the ignore list for a specific Cloned Web token.

Required Parameters

auth_token string
A valid auth token
flock_id string
A valid flock_id
canarytoken string
A valid Canarytoken

Response

A JSON structure with result indicator.

Example

    Response
    {
      "result": "success"
    }
    
    1
    2
    3

    # Enable Ignore List

    POST /api/v1/canarytokens/clonedsite/ignorelist/enable

    Enable the ignore list for a specific Cloned Web token.

    Required Parameters

    auth_token string
    A valid auth token
    flock_id string
    A valid flock_id
    canarytoken string
    A valid Canarytoken

    Response

    A JSON structure with result indicator.

    Example

      Response
      {
        "result": "success"
      }
      
      1
      2
      3

      # Fetch Ignore List

      GET /api/v1/canarytokens/clonedsite/ignorelist/fetch

      Enable the ignore list for a specific Cloned Web token.

      Required Parameters

      auth_token string
      A valid auth token
      flock_id string
      A valid flock_id
      canarytoken string
      A valid Canarytoken

      Response

      A JSON structure containing the ignore list info for the specified Cloned Web token.

      Example

        Response
        {
          "ignore_lists": {
            "enabled": "true",
            "ignores": "^https?://web.archive.org,^https?://[a-z]{2}.hideproxy.me/"
          },
          "result": "success"
        }
        
        1
        2
        3
        4
        5
        6
        7

        # Save Ignore List

        POST /api/v1/canarytokens/clonedsite/ignorelist/save

        Save a new ignore list for a specific Cloned Web token.

        Required Parameters

        auth_token string
        A valid auth token
        flock_id string
        A valid flock_id
        canarytoken string
        A valid Canarytoken

        Optional Parameters

        ignores string
        A comma separated list of regex ignores

        WARNING

        Sending through a save without ignores, will assume you want to blank previously set values.

        Response

        A JSON structure with result indicator.

        Example

          Response
          {
            "result": "success"
          }
          
          1
          2
          3