Request URL

POST  https://api.dotcom-monitor.com/config_api_v1/filter/{filter_id}

Path Parameters

Field Type Required Description
filter_id

string

true

 The unique id of the filter you need to edit.

Header Parameters

Content-Type: application/json
POST Content example: Adding one more 404 HTTP Error Code to ignore
{
    "Name": "HTTP ERRORS",
    "Rules": 
    {
        "Time_Min": 5,
        "Number_Of_Locations": 4,
        "Number_Of_Tasks": 1,
        "Owner_Device": false
    },
    "Items": 
    [
        {
            "Error_Type": "Http",
            "Error_Code_To_Ignore": [404]
        }
    ]
}

Required Body Parameters

To specify a filter object fields to edit, we recommend you get the filter info first and use the response as a sample for a JSON object. Find the description of the fields in the API: Filter Methods Overview.

Regardless of the fields you want to edit, the following fields are required in the edit request body:

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": "Filter 1110 has been updated"
}