Jump to

• Request
• Response

Get a Polling Policy

get

/api/metric/PollingPolicies/{id}

Gets the polling policy that matches the specified ID. The polling policy can be used by the Metric Poller Discovery scheduled job.

Request

Path Parameters

• id(required): integer(int32)
  The ID of the polling policy to get.

  Example:

  1

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Match All

Show Source

• object SuccessfulGetOperation
  The response body for a successful get operation.
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SuccessfulGetOperation"
        },
        {
            "type":"object",
            "properties":{
                "data":{
                    "type":"array",
                    "description":"The polling policy that matches the specified ID.",
                    "items":{
                        "$ref":"#/components/schemas/metricPollingPoliciesRead"
                    }
                },
                "total":{
                    "description":"The total number of results regardless of paging.",
                    "type":"integer",
                    "example":"1"
                }
            }
        }
    ]
}

Nested Schema : SuccessfulGetOperation

Type: object

The response body for a successful get operation.

Show Source

• message: string
  The response message.

  Example: Loaded 1 entries
• success: boolean
  Whether the operation was a success (true) or a failure (false).

  Example: true

{
    "description":"The response body for a successful get operation.",
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"true"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Loaded 1 entries"
        }
    },
    "type":"object"
}

Nested Schema : type

Type: object

Show Source

• data: array data
  The polling policy that matches the specified ID.
• total: integer
  The total number of results regardless of paging.

  Example: 1

{
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "description":"The polling policy that matches the specified ID.",
            "items":{
                "$ref":"#/components/schemas/metricPollingPoliciesRead"
            }
        },
        "total":{
            "description":"The total number of results regardless of paging.",
            "type":"integer",
            "example":"1"
        }
    }
}

Nested Schema : data

Type: array

The polling policy that matches the specified ID.

Show Source

• Array of: object metricPollingPoliciesRead

{
    "type":"array",
    "description":"The polling policy that matches the specified ID.",
    "items":{
        "$ref":"#/components/schemas/metricPollingPoliciesRead"
    }
}

Nested Schema : metricPollingPoliciesRead

Type: object

Show Source

• Category: string
  Category

  Example: Any
• CIDR: integer
  CIDR |Allowed Values: |0 => Disabled |1 => Enabled

  Example: 1
• CIDRDisplayName: string
  A descriptive label for the CIDR flag. Allowed Values are "Disabled" and "Enabled"

  Example: Disabled
• DeviceDisplayName: string
  Device Display Name

  Example: Any
• DeviceMetaTypeID: integer
  Device MetaType ID

  Example: 0
• DeviceMetaTypeName: string
  Device MetaType Name

  Example: ADBaseDN
• DeviceName: string
  Device Name

  Example: router.example.com
• DeviceNameMatchTypeID: integer
  The operator to match device names. Allowed Values: - 0 => LIKE - 1 => NOT LIKE - 2 => REGEXP - 3 => NOT REGEXP

  Example: 0
• DeviceType: string
  Device Type

  Example: Any
• DeviceTypeCategoryID: integer
  Device Type Category ID

  Example: 0
• DeviceTypeMatchTypeID: integer
  Device Type Match Type Allowed Values: - 0 => LIKE - 1 => NOT LIKE - 2 => REGEXP - 3 => NOT REGEXP

  Example: 0
• InstanceDisplayName: string
  Instance Display Name

  Example: LIKE/ens3/
• InstanceName: string
  Instance Name

  Example: ens3
• InstanceNameMatchTypeID: integer
  The operator to match instance names. Allowed Values: - 0 => LIKE - 1 => NOT LIKE - 2 => REGEXP - 3 => NOT REGEXP

  Example: 0
• InstanceTypeID: integer
  Instance Type ID

  Example: 1
• InstanceTypeName: string
  Instance Type Name

  Example: SNMP Interface
• IPRange: string
  IP Range (e.g. 10.*.0-9.1,2,3,4 or 172.16.10.0/24 for CIDR Scan)

  Example:
• IPRangeDisplayName: string
  IP Range Display Name. It will be the same as IP Range unless IP Range is blank. Then the display name will be "Any".

  Example: Any
• MetaData: string
  MetaData

  Example:
• MetaDataDisplay: string
  The meta data operator and value unless the value is blank. then the display will be "Any".

  Example: Any
• MetaDataMatchTypeID: integer
  Meta Data Match Type Allowed Values: - 0 => LIKE - 1 => NOT LIKE - 2 => REGEXP - 3 => NOT REGEXP

  Example: 0
• MethodID: integer
  MethodID |Allowed Values: |0 => NA |1 => SNMP |2 => WMI |3 => Other |5 => Transaction

  Example: 1
• MethodName: string
  Method Name

  Example: SNMP
• PolicyDescription: string
  Policy Description

  Example:
• PolicyID: integer
  Policy ID

  Example: 5
• PolicyName: string
  Policy Name

  Example: Configure Network Interface Polling - ens3
• PollerTemplateID: integer
  Poller Template ID

  Example: 3
• PollTime: integer
  PollTime in seconds

  Example: 300
• StatusIcon: string
  Status Icon

  Example: OrbGreen.png
• StatusID: boolean
  The metric policy status ID. Either 0 (disabled) or 1 (enabled).

  Example: 1
• StatusName: string
  Status Name

  Example: Enabled
• SysObjectID: integer
  The device type ID to match

  Example: NONE
• TemplateName: string
  Template Name

  Example: Default Network Interface
• ThresholdGroupID: integer
  Threshold Group ID

  Example: 3
• ThresholdGroupName: string
  Threshold Group Name

  Example: Default Network Interface

{
    "properties":{
        "PolicyID":{
            "description":"Policy ID",
            "type":"integer",
            "example":"5"
        },
        "PolicyName":{
            "description":"Policy Name",
            "type":"string",
            "example":"Configure Network Interface Polling - ens3"
        },
        "StatusID":{
            "description":"The metric policy status ID. Either <b>0</b> (disabled) or <b>1</b> (enabled).",
            "type":"boolean",
            "example":"1"
        },
        "StatusName":{
            "description":"Status Name",
            "type":"string",
            "example":"Enabled"
        },
        "StatusIcon":{
            "description":"Status Icon",
            "type":"string",
            "example":"OrbGreen.png"
        },
        "PolicyDescription":{
            "description":"Policy Description",
            "type":"string",
            "example":""
        },
        "PollTime":{
            "description":"PollTime in seconds",
            "type":"integer",
            "example":"300"
        },
        "IPRange":{
            "description":"IP Range (e.g. 10.*.0-9.1,2,3,4 or 172.16.10.0/24 for CIDR Scan)",
            "type":"string",
            "example":""
        },
        "IPRangeDisplayName":{
            "description":"IP Range Display Name. It will be the same as IP Range unless IP Range is blank. Then the display name will be \"Any\".",
            "type":"string",
            "example":"Any"
        },
        "CIDR":{
            "description":"CIDR\n|Allowed Values:\n|0 => Disabled\n|1 => Enabled",
            "type":"integer",
            "example":"1"
        },
        "CIDRDisplayName":{
            "description":"A descriptive label for the CIDR flag. Allowed Values are \"Disabled\" and \"Enabled\"",
            "type":"string",
            "example":"Disabled"
        },
        "DeviceNameMatchTypeID":{
            "description":"The operator to match device names. \n\nAllowed Values: \n- 0 => LIKE\n- 1 => NOT LIKE\n- 2 => REGEXP\n- 3 => NOT REGEXP",
            "type":"integer",
            "example":"0"
        },
        "InstanceNameMatchTypeID":{
            "description":"The operator to match instance names.\n\nAllowed Values:\n- 0 => LIKE\n- 1 => NOT LIKE\n- 2 => REGEXP\n- 3 => NOT REGEXP",
            "type":"integer",
            "example":"0"
        },
        "InstanceTypeID":{
            "description":"Instance Type ID",
            "type":"integer",
            "example":"1"
        },
        "InstanceTypeName":{
            "description":"Instance Type Name",
            "type":"string",
            "example":"SNMP Interface"
        },
        "MetaData":{
            "description":"MetaData",
            "type":"string",
            "example":""
        },
        "DeviceTypeCategoryID":{
            "description":"Device Type Category ID",
            "type":"integer",
            "example":"0"
        },
        "SysObjectID":{
            "description":"The device type ID to match",
            "type":"integer",
            "example":"NONE"
        },
        "PollerTemplateID":{
            "description":"Poller Template ID",
            "type":"integer",
            "example":"3"
        },
        "TemplateName":{
            "description":"Template Name",
            "type":"string",
            "example":"Default Network Interface"
        },
        "ThresholdGroupID":{
            "description":"Threshold Group ID",
            "type":"integer",
            "example":"3"
        },
        "ThresholdGroupName":{
            "description":"Threshold Group Name",
            "type":"string",
            "example":"Default Network Interface"
        },
        "MethodID":{
            "description":"MethodID\n|Allowed Values:\n|0 => NA\n|1 => SNMP\n|2 => WMI\n|3 => Other\n|5 => Transaction",
            "type":"integer",
            "example":"1"
        },
        "MethodName":{
            "description":"Method Name",
            "type":"string",
            "example":"SNMP"
        },
        "Category":{
            "description":"Category",
            "type":"string",
            "example":"Any"
        },
        "DeviceMetaTypeID":{
            "description":"Device MetaType ID",
            "type":"integer",
            "example":"0"
        },
        "DeviceMetaTypeName":{
            "description":"Device MetaType Name",
            "type":"string",
            "example":"ADBaseDN"
        },
        "DeviceName":{
            "description":"Device Name",
            "type":"string",
            "example":"router.example.com"
        },
        "DeviceDisplayName":{
            "description":"Device Display Name",
            "type":"string",
            "example":"Any"
        },
        "InstanceName":{
            "description":"Instance Name",
            "type":"string",
            "example":"ens3"
        },
        "InstanceDisplayName":{
            "description":"Instance Display Name",
            "type":"string",
            "example":"LIKE/ens3/"
        },
        "MetaDataMatchTypeID":{
            "description":"Meta Data Match Type\n\nAllowed Values:\n- 0 => LIKE\n- 1 => NOT LIKE\n- 2 => REGEXP\n- 3 => NOT REGEXP",
            "type":"integer",
            "example":"0"
        },
        "MetaDataDisplay":{
            "description":"The meta data operator and value unless the value is blank. then the display will be \"Any\".",
            "type":"string",
            "example":"Any"
        },
        "DeviceTypeMatchTypeID":{
            "description":"Device Type Match Type\n\nAllowed Values:\n- 0 => LIKE\n- 1 => NOT LIKE\n- 2 => REGEXP\n- 3 => NOT REGEXP",
            "type":"integer",
            "example":"0"
        },
        "DeviceType":{
            "description":"Device Type",
            "type":"string",
            "example":"Any"
        }
    },
    "type":"object"
}

Default Response

Failed operation

Body ()

Root Schema : schema

Type: object

Show Source

• errors: array errors
  The list of errors reported. Validation errors will be keyed by record field.
• message: string
  The response message.

  Example: Exception thrown
• success: boolean
  Whether the operation was a success (true) or a failure (false).

  Example: false

{
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"false"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Exception thrown"
        },
        "errors":{
            "description":"The list of errors reported. Validation errors will be keyed by record field.",
            "type":"array",
            "items":{
                "description":"An error.",
                "type":"object"
            }
        }
    },
    "type":"object"
}

Nested Schema : errors

Type: array

The list of errors reported. Validation errors will be keyed by record field.

Show Source

• Array of: object items
  An error.

{
    "description":"The list of errors reported. Validation errors will be keyed by record field.",
    "type":"array",
    "items":{
        "description":"An error.",
        "type":"object"
    }
}

Nested Schema : items

Type: object

An error.

Back to Top