List templates

get https://{hostname}/alerts/v2/alert-templates

Lists templates for all supported alerts. Objects listed in the response provide only high-level information about each alert template, such as its name and whether its origin is STATIC or ADAPTIVE. For a full definition that specifies all required fields, get a specific template instance.

Responses

Response body

object

data

array of objects

required

length ≥ 1

Alert template describing a type of alert that can be defined or configured for monitoring.

data*

object

fields

array

required

length ≥ 1

Lists the set of fields required to populate an alert based on this template. This doesn't appear within template collections.

fields*

firingFields

array of strings

required

length ≥ 1

Lists field names expected in alert firing objects associated with this template. This doesn't appear within template collections.

firingFields*

links

array of objects

required

length ≥ 2

Link relations to schemas and REST endpoints.

links*

object

href

string

required

length ≥ 1

Link to resource of type described by rel.

rel

string

required

length ≥ 1

Describes type of link.

name

string

required

length ≥ 1

Name of the template.

origin

string

required

Identifies the type of alert the template enables, either STATIC or ADAPTIVE. Static alert types specify raw values, while the adaptive alert type expresses standard deviations. The only available ADAPTIVE alert identifies excessive traffic, and its templateId is a@1.

STATIC ADAPTIVE

products

array of objects

length ≥ 1

Describes products associated with each template. You can only use the template if one of the products is on your contract.

products

object

name

string

required

length ≥ 1

A basic description of content.

objectId

string

required

length ≥ 1

A unique identifier for this content.

templateId

string

required

length ≥ 1

Identifies the template. Template origin types that are STATIC and ADAPTIVE are distinguished with s@ and a@ prefixes.

Language

Authentication

Remember to add your authentication credentials to run this code.

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://hostname/alerts/v2/alert-templates \
3
     --header 'accept: application/json'


xxxxxxxxxx
86
}
1
{
2
  "data": [
3
    {
4
      "links": [
5
        {
6
          "href": "/alerts/v2/json-schema/alert-templates/s@1",
7
          "rel": "describedBy"
8
        },
9
        {
10
          "href": "/alerts/v2/alert-templates/s@1",
11
          "rel": "self"
12
        }
13
      ],
14
      "name": "High Traffic -- Content Delivery",
15
      "origin": "STATIC",
16
      "products": [
17
        {
18
          "name": "Terra Alta Enterprise Accelerator",
19
          "objectId": "Alta_alerts"
20
        },
21
        {
22
          "name": "Terra Alta Enterprise Accelerator Fast File Upload",
23
          "objectId": "Alta_ffu_alerts"
24
        },
25
        {

200The response lists templates.

401Unauthorized error.

403Access is forbidden.

405Method not allowed.

500Server error.