Gets a list of all alert types for which an account is eligible.
/accounts/{account_id}/alerting/v3/available_alerts
get
Notification Alert Types
notification-alert-types-get-alert-types
nullnull[
{
"in": "path",
"name": "account_id",
"required": true,
"schema": {
"description": "The account id",
"example": "023e105f4ecef8ad9ca31a8372d0c353",
"maxLength": 32,
"readOnly": true,
"type": "string"
}
}
]null{
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"allOf": [
{
"properties": {
"errors": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"messages": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"result": {
"anyOf": [
{
"type": "object"
},
{
"items": {},
"type": "array"
},
{
"type": "string"
}
]
},
"success": {
"description": "Whether the API call was successful",
"enum": [
true
],
"example": true,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
},
{
"properties": {
"result": {
"items": {},
"nullable": true,
"type": "array"
},
"result_info": {
"properties": {
"count": {
"description": "Total number of results for the requested service",
"example": 1,
"type": "number"
},
"page": {
"description": "Current page within paginated list of results",
"example": 1,
"type": "number"
},
"per_page": {
"description": "Number of results per page of results",
"example": 20,
"type": "number"
},
"total_count": {
"description": "Total results available without any search parameters",
"example": 2000,
"type": "number"
}
},
"type": "object"
}
}
}
],
"type": "object"
},
{
"properties": {
"result": {
"additionalProperties": {
"items": {
"properties": {
"description": {
"description": "Describes the alert type.",
"example": "High levels of 5xx HTTP errors at your origin",
"type": "string"
},
"display_name": {
"description": "Alert type name.",
"example": "Origin Error Rate Alert",
"type": "string"
},
"filter_options": {
"description": "Format of additional configuration options (filters) for the alert type. Data type of filters during policy creation: Array of strings.",
"example": [
{
"AvailableValues": null,
"ComparisonOperator": "==",
"Key": "zones",
"Range": "1-n"
},
{
"AvailableValues": [
{
"Description": "Service-Level Objective of 99.7",
"ID": "99.7"
},
{
"Description": "Service-Level Objective of 99.8",
"ID": "99.8"
}
],
"ComparisonOperator": ">=",
"Key": "slo",
"Range": "0-1"
}
],
"items": {},
"type": "array"
},
"type": {
"description": "Use this value when creating and updating a notification policy.",
"example": "http_alert_origin_error",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"example": {
"Origin Monitoring": [
{
"description": "High levels of 5xx HTTP errors at your origin.",
"display_name": "Origin Error Rate Alert",
"filter_options": [
{
"AvailableValues": null,
"ComparisonOperator": "==",
"Key": "zones",
"Range": "1-n"
},
{
"AvailableValues": [
{
"Description": "Service-Level Objective of 99.7",
"ID": "99.7"
},
{
"Description": "Service-Level Objective of 99.8",
"ID": "99.8"
}
],
"ComparisonOperator": ">=",
"Key": "slo",
"Range": "0-1"
}
],
"type": "http_alert_origin_error"
}
]
},
"type": "object"
}
}
}
]
}
}
},
"description": "Get Alert Types response"
},
"4XX": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"allOf": [
{
"allOf": [
{
"properties": {
"errors": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"messages": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"result": {
"anyOf": [
{
"type": "object"
},
{
"items": {},
"type": "array"
},
{
"type": "string"
}
]
},
"success": {
"description": "Whether the API call was successful",
"enum": [
true
],
"example": true,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
},
{
"properties": {
"result": {
"items": {},
"nullable": true,
"type": "array"
},
"result_info": {
"properties": {
"count": {
"description": "Total number of results for the requested service",
"example": 1,
"type": "number"
},
"page": {
"description": "Current page within paginated list of results",
"example": 1,
"type": "number"
},
"per_page": {
"description": "Number of results per page of results",
"example": 20,
"type": "number"
},
"total_count": {
"description": "Total results available without any search parameters",
"example": 2000,
"type": "number"
}
},
"type": "object"
}
}
}
],
"type": "object"
},
{
"properties": {
"result": {
"additionalProperties": {
"items": {
"properties": {
"description": {
"description": "Describes the alert type.",
"example": "High levels of 5xx HTTP errors at your origin",
"type": "string"
},
"display_name": {
"description": "Alert type name.",
"example": "Origin Error Rate Alert",
"type": "string"
},
"filter_options": {
"description": "Format of additional configuration options (filters) for the alert type. Data type of filters during policy creation: Array of strings.",
"example": [
{
"AvailableValues": null,
"ComparisonOperator": "==",
"Key": "zones",
"Range": "1-n"
},
{
"AvailableValues": [
{
"Description": "Service-Level Objective of 99.7",
"ID": "99.7"
},
{
"Description": "Service-Level Objective of 99.8",
"ID": "99.8"
}
],
"ComparisonOperator": ">=",
"Key": "slo",
"Range": "0-1"
}
],
"items": {},
"type": "array"
},
"type": {
"description": "Use this value when creating and updating a notification policy.",
"example": "http_alert_origin_error",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"example": {
"Origin Monitoring": [
{
"description": "High levels of 5xx HTTP errors at your origin.",
"display_name": "Origin Error Rate Alert",
"filter_options": [
{
"AvailableValues": null,
"ComparisonOperator": "==",
"Key": "zones",
"Range": "1-n"
},
{
"AvailableValues": [
{
"Description": "Service-Level Objective of 99.7",
"ID": "99.7"
},
{
"Description": "Service-Level Objective of 99.8",
"ID": "99.8"
}
],
"ComparisonOperator": ">=",
"Key": "slo",
"Range": "0-1"
}
],
"type": "http_alert_origin_error"
}
]
},
"type": "object"
}
}
}
]
},
{
"properties": {
"errors": {
"allOf": [
{
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
}
],
"example": [
{
"code": 7003,
"message": "No route for the URI"
}
],
"minLength": 1
},
"messages": {
"allOf": [
{
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
}
],
"example": []
},
"result": {
"enum": [
null
],
"nullable": true,
"type": "object"
},
"success": {
"description": "Whether the API call was successful",
"enum": [
false
],
"example": false,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
}
]
}
}
},
"description": "Get Alert Types response failure"
}
}[
{
"api_token": []
},
{
"api_email": [],
"api_key": []
}
]