Request URL

Filter can be created using two methods:

PUT https://api.dotcom-monitor.com/config_api_v1/filters
POST  https://api.dotcom-monitor.com/config_api_v1/filters?verb=PUT

 Header Parameters

Content-Type: application/json
Example PUT / POST body
{
    "Name": "HTTP ERRORS",
    "Description": "HTTP 500 & 504 Ignore",
    "Rules": 
    {
        "Time_Min": 5,
        "Number_Of_Locations": 4,
        "Number_Of_Tasks": 1,
        "Owner_Device": false
    },
    "Items": 
    [
        {
            "Error_Type": "Http",
            "Error_Code_To_Ignore": [500]
        }, 
        {
            "Error_Type": "Http",
            "Error_Code_To_Ignore": [504]
        }
    ]
}

Required Body Parameters

To specify a JSON object parameters for a new filter, we recommend you get an existed filter info first and use the response as a sample for a new filter object.

Field Type Required/Optional Description

Name

string

required

 Filter name.

Example:
"Name": "4 locations"

Rules

object

required

 Required Rules:

  • “Number_Of_Locations” defines number of monitoring locations which are sending error responses. Number_Of_Locations must be greater than 0.
  • “Number_Of_Tasks” defines number failed tasks. Number_Of_Tasks must be greater or equal than 1.

Example:

"Rules": {
            "Number_Of_Locations": 4,
            "Number_Of_Tasks": 1
      }

Success Response

Example response
{
    "Success": true,
    "Result": 1110
}
Field

Type

 Description

Result

int32

 The unique id for the filter.