Create a Poller Template
post
/api/metric/PollerTemplates
Creates a poller template.
The minimum required properties in the request body are:
The minimum required properties in the request body are:
- TemplateName
- MetricTypes
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
MetricTypes: array
MetricTypes
Metric Types to be included in the template
-
TemplateName: string
Poller Template NameExample:
Default Ping
Nested Schema : MetricTypes
Type:
array
Metric Types to be included in the template
Show Source
Example:
[
"60",
"61",
"62",
"63"
]
Response
Supported Media Types
- application/json
200 Response
Successful operation
Root Schema : schema
Match All
Show Source
-
object
SuccessfulAddOperation
The response body for a successful add operation.
-
object
type
Nested Schema : SuccessfulAddOperation
Type:
object
The response body for a successful add operation.
Show Source
-
message: string
The response message.Example:
Added record
-
success: boolean
Whether the operation was a success (true) or a failure (false).Example:
true
Nested Schema : type
Type:
Show Source
object
-
data: array
data
The new poller template.
-
total: integer
The total number of results regardless of paging.Example:
1
Nested Schema : metricPollerTemplatesRead
Type:
Show Source
object
-
MetricTypeList: string
Metric Type ListExample:
Latency <br>Packet Loss <br>Ping Jitter <br>Ping Jitter Utilization
-
MetricTypes: array
MetricTypes
Metric Types to be included in the template
-
TemplateID: integer
Template IDExample:
1
-
TemplateName: string
Poller Template NameExample:
Default Ping
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:
Show Source
object
-
MetricTypeID: integer
Metric Type IDExample:
60
-
MetricTypeName: string
Metric Type NameExample:
Latency
Default Response
Failed operation
Root Schema : schema
Type:
Show Source
object
-
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
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.
Nested Schema : items
Type:
object
An error.