Create a Poller Template

post

/api/metric/PollerTemplates

Creates a poller template.
The minimum required properties in the request body are:
  • TemplateName
  • MetricTypes

Request

There are no request parameters for this operation.

Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
Nested Schema : MetricTypes
Type: array
Metric Types to be included in the template
Show Source
Example:
[
    "60",
    "61",
    "62",
    "63"
]
Back to Top

Response

Supported Media Types

200 Response

Successful operation
Body ()
Root Schema : schema
Match All
Show Source
Nested Schema : SuccessfulAddOperation
Type: object
The response body for a successful add operation.
Show Source
Nested Schema : type
Type: object
Show Source
Nested Schema : data
Type: array
The new poller template.
Show Source
Nested Schema : metricPollerTemplatesRead
Type: object
Show Source
Nested Schema : MetricTypes
Type: array
Metric Types to be included in the template
Show Source
Example:
[
    {
        "MetricTypeID":"60",
        "MetricTypeName":"Latency"
    },
    {
        "MetricTypeID":"61",
        "MetricTypeName":"Packet Loss"
    },
    {
        "MetricTypeID":"62",
        "MetricTypeName":"Ping Jitter"
    },
    {
        "MetricTypeID":"63",
        "MetricTypeName":"Ping Jitter Utilization"
    }
]
Nested Schema : items
Type: object
Show Source

Default Response

Failed operation
Body ()
Root Schema : schema
Type: object
Show Source
Nested Schema : errors
Type: array
The list of errors reported. Validation errors will be keyed by record field.
Show Source
Nested Schema : items
Type: object
An error.
Back to Top