Request URL

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

Path Parameters

Field Type Required Description
filter_id

string

true

 The filter unique id.
Example request URL

https://api.dotcom-monitor.com/config_api_v1/filter/16789

Success Response

Example Response
{
    "Name": "API - test22",
    "Id": 83714,
    "Description": "description",
    "Rules": {
        "Time_Min": 4,
        "Number_Of_Locations": 4,
        "Number_Of_Tasks": 4,
        "Owner_Device": false
    },
    "Items": [
        {
            "Error_Type": "HTTP",
            "Error_Code_To_Ignore": [
                409
            ]
        },
        {
            "Error_Type": "DNS",
            "Error_Code_To_Ignore": [
                {
                    "From": 12765,
                    "To": 12770
                }
            ]
        },
        {
            "Error_Type": "Certificate",
            "Error_Code_To_Ignore": [
                {
                    "From": 105,
                    "To": 107
                },
                109,
                {
                    "From": 111,
                    "To": 115
                },
                117,
                {
                    "From": 119,
                    "To": 121
                }
            ]
        },
        {
            "Error_Type": "Validation",
            "Error_Code_To_Ignore": [
                400,
                403,
                405
            ]
        }
    ],
    "Assigned_To": [
               63425,
               63462
    ]
}

Fields Description

Field

Type

 Description

Name

string

 The name of the filter.

Id

int32
Unique filter id.

Description

string

 The description of the filter.

Rules

object

 Possible Rules:

  • “Time_Min” defines duration of the reported error.
  • “Number_Of_Locations” defines number of monitoring locations which are sending error responses.
  • “Number_Of_Tasks” defines number failed tasks.
  • “Owner_Device” flag lets you enable, or disable verification if an Owner Device is DOWN.

Items

array of objects

 Ignore an Error Type with specific Error Codes.

Possible Error Types: Validation, Runtime, CustomScript, Certificate, Cryptographic, Tcp, Dns, Udp, Http, Ftp, Sftp, Smtp, Pop3, Imap, Icmp, IcmpV6, DnsBL, Media, Sip.

Assigned_To

array of int32

 This array contains the list of device IDs, to which the filter is assigned.