{
"notifier": {
"name": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"discard": true,
"email": {
"html": "<string>",
"text": "<string>",
"to": "<string>"
},
"ops_genie": {
"api_key": "<string>",
"api_url": "https://api.opsgenie.com/",
"description": "<string>",
"details": {},
"http_config": {
"basic_auth": {
"password": "<string>",
"username": "<string>"
},
"bearer_token": "<string>",
"proxy_url": "<string>",
"tls_config": {
"insecure_skip_verify": true
}
},
"message": "<string>",
"note": "<string>",
"priority": "<string>",
"responders": [
{
"id": "<string>",
"name": "<string>",
"responder_type": "TEAM",
"username": "<string>"
}
],
"source": "<string>",
"tags": "<string>"
},
"pagerduty": {
"class": "<string>",
"client": "<string>",
"client_url": "<string>",
"component": "<string>",
"description": "<string>",
"details": {},
"group": "<string>",
"http_config": {
"basic_auth": {
"password": "<string>",
"username": "<string>"
},
"bearer_token": "<string>",
"proxy_url": "<string>",
"tls_config": {
"insecure_skip_verify": true
}
},
"images": [
{
"alt": "<string>",
"href": "<string>",
"src": "<string>"
}
],
"links": [
{
"href": "<string>",
"text": "<string>"
}
],
"routing_key": "<string>",
"service_key": "<string>",
"severity": "<string>",
"url": "<string>"
},
"skip_resolved": true,
"slack": {
"actions": [
{
"confirm_field": {
"dismiss_text": "<string>",
"ok_text": "<string>",
"text": "<string>",
"title": "<string>"
},
"name": "<string>",
"style": "<string>",
"text": "<string>",
"type": "<string>",
"url": "<string>",
"value": "<string>"
}
],
"api_url": "<string>",
"callback_id": "<string>",
"channel": "<string>",
"color": "<string>",
"fallback": "<string>",
"fields": [
{
"short": true,
"title": "<string>",
"value": "<string>"
}
],
"footer": "<string>",
"http_config": {
"basic_auth": {
"password": "<string>",
"username": "<string>"
},
"bearer_token": "<string>",
"proxy_url": "<string>",
"tls_config": {
"insecure_skip_verify": true
}
},
"icon_emoji": "<string>",
"icon_url": "<string>",
"image_url": "<string>",
"link_names": true,
"mrkdwn_in": [
"<string>"
],
"pretext": "<string>",
"short_fields": true,
"text": "<string>",
"thumb_url": "<string>",
"title": "<string>",
"title_link": "<string>",
"username": "<string>"
},
"slug": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"victor_ops": {
"api_key": "<string>",
"api_url": "<string>",
"custom_fields": {},
"entity_display_name": "<string>",
"http_config": {
"basic_auth": {
"password": "<string>",
"username": "<string>"
},
"bearer_token": "<string>",
"proxy_url": "<string>",
"tls_config": {
"insecure_skip_verify": true
}
},
"message_type": "<string>",
"monitoring_tool": "<string>",
"routing_key": "<string>",
"state_message": "<string>"
},
"webhook": {
"http_config": {
"basic_auth": {
"password": "<string>",
"username": "<string>"
},
"bearer_token": "<string>",
"proxy_url": "<string>",
"tls_config": {
"insecure_skip_verify": true
}
},
"url": "<string>"
}
}
}{
"notifier": {
"name": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"discard": true,
"email": {
"html": "<string>",
"text": "<string>",
"to": "<string>"
},
"ops_genie": {
"api_key": "<string>",
"api_url": "https://api.opsgenie.com/",
"description": "<string>",
"details": {},
"http_config": {
"basic_auth": {
"password": "<string>",
"username": "<string>"
},
"bearer_token": "<string>",
"proxy_url": "<string>",
"tls_config": {
"insecure_skip_verify": true
}
},
"message": "<string>",
"note": "<string>",
"priority": "<string>",
"responders": [
{
"id": "<string>",
"name": "<string>",
"responder_type": "TEAM",
"username": "<string>"
}
],
"source": "<string>",
"tags": "<string>"
},
"pagerduty": {
"class": "<string>",
"client": "<string>",
"client_url": "<string>",
"component": "<string>",
"description": "<string>",
"details": {},
"group": "<string>",
"http_config": {
"basic_auth": {
"password": "<string>",
"username": "<string>"
},
"bearer_token": "<string>",
"proxy_url": "<string>",
"tls_config": {
"insecure_skip_verify": true
}
},
"images": [
{
"alt": "<string>",
"href": "<string>",
"src": "<string>"
}
],
"links": [
{
"href": "<string>",
"text": "<string>"
}
],
"routing_key": "<string>",
"service_key": "<string>",
"severity": "<string>",
"url": "<string>"
},
"skip_resolved": true,
"slack": {
"actions": [
{
"confirm_field": {
"dismiss_text": "<string>",
"ok_text": "<string>",
"text": "<string>",
"title": "<string>"
},
"name": "<string>",
"style": "<string>",
"text": "<string>",
"type": "<string>",
"url": "<string>",
"value": "<string>"
}
],
"api_url": "<string>",
"callback_id": "<string>",
"channel": "<string>",
"color": "<string>",
"fallback": "<string>",
"fields": [
{
"short": true,
"title": "<string>",
"value": "<string>"
}
],
"footer": "<string>",
"http_config": {
"basic_auth": {
"password": "<string>",
"username": "<string>"
},
"bearer_token": "<string>",
"proxy_url": "<string>",
"tls_config": {
"insecure_skip_verify": true
}
},
"icon_emoji": "<string>",
"icon_url": "<string>",
"image_url": "<string>",
"link_names": true,
"mrkdwn_in": [
"<string>"
],
"pretext": "<string>",
"short_fields": true,
"text": "<string>",
"thumb_url": "<string>",
"title": "<string>",
"title_link": "<string>",
"username": "<string>"
},
"slug": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"victor_ops": {
"api_key": "<string>",
"api_url": "<string>",
"custom_fields": {},
"entity_display_name": "<string>",
"http_config": {
"basic_auth": {
"password": "<string>",
"username": "<string>"
},
"bearer_token": "<string>",
"proxy_url": "<string>",
"tls_config": {
"insecure_skip_verify": true
}
},
"message_type": "<string>",
"monitoring_tool": "<string>",
"routing_key": "<string>",
"state_message": "<string>"
},
"webhook": {
"http_config": {
"basic_auth": {
"password": "<string>",
"username": "<string>"
},
"bearer_token": "<string>",
"proxy_url": "<string>",
"tls_config": {
"insecure_skip_verify": true
}
},
"url": "<string>"
}
}
}Authorizations
Chronosphere API token
Body
If true, validates the specified configuration without creating the Notifier. If the specified configuration is valid, the endpoint returns a partial response without the Notifier. If the specified configuration is invalid, the endpoint returns an error.
The Notifier to create.
Show child attributes
Show child attributes
The name of the Notifier. You can modify this value after the Notifier is created.
If true, enables the discard integration, which discards all
notifications. Cannot be set if another integration is set.
If an object is specified, sends notifications through an email integration. Cannot be set if another integration is set.
If an object is specified, sends notifications through an Opsgenie integration. Cannot be set if another integration is set.
Show child attributes
Show child attributes
Your Opsgenie API key. Required if including an ops_genie object in your
request body.
The Opsgenie API URL to send requests to. Required if including an
ops_genie object in your request body.
"https://api.opsgenie.com/"
A description of the alert.
Your HTTP client configuration.
Show child attributes
Show child attributes
Sets a token for bearer authentication. Cannot be set if basic_auth is set.
Your proxy URL. (This parameter is deprecated, and custom proxies are unsupported.)
The alert text.
A note about the alert.
The priority level of alert. Possible values are P1, P2, P3, P4, and P5.
List of responders responsible for notifications.
Show child attributes
Show child attributes
The ID of the responder. Cannot be set if name or username are set.
The name of the responder. Cannot be set if id or username are set.
The type of the responder.
TEAM, USER, ESCALATION, SCHEDULE The username of the responder. Cannot be set if id or name are set.
A backlink to the sender of the notification.
A comma-separated list of tags attached to the notifications.
If an object is specified, sends notifications through a PagerDuty integration. Cannot be set if another integration is set.
Show child attributes
Show child attributes
The class of the event.
The client identification of the notification sender.
A backlink to the sender of the notification.
The part or component of the affected system that is broken.
A description of the incident.
A cluster or grouping of services.
Your HTTP client configuration.
Show child attributes
Show child attributes
Sets a token for bearer authentication. Cannot be set if basic_auth is set.
Your proxy URL. (This parameter is deprecated, and custom proxies are unsupported.)
Your PagerDuty integration key, if using the PagerDuty integration type
Events API v2. Cannot be set if service_key is set.
Your PagerDuty integration key, if using the PagerDuty integration type
Prometheus. Cannot be set if routing_key is set.
The severity of the incident. Possible values: critical, error,
warning, or info.
The Pagerduty URL to send API requests to.
If true, disables notifications for resolved alerts. Cannot be set if
discard equals true.
If an object is specified, sends notifications through a Slack integration. Cannot be set if another integration is set.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Your Slack webhook API URL. Required if including a slack object in
your request body.
The channel to send notifications to.
Your HTTP client configuration.
Show child attributes
Show child attributes
Sets a token for bearer authentication. Cannot be set if basic_auth is set.
Your proxy URL. (This parameter is deprecated, and custom proxies are unsupported.)
The user to send notifications to.
The unique identifier of the Notifier. If a slug isn't provided, one is generated based on the name field. You can't modify this field after the Notifier is created.
If an object is specified, sends notifications through a VictorOps integration. Cannot be set if another integration is set.
Show child attributes
Show child attributes
Your VictorOps API key. Required if including a victor_ops object in
your request body.
The VictorOps API URL. Required if including a victor_ops object in your
request body.
A summary of the alerted problem.
Your HTTP client configuration.
Show child attributes
Show child attributes
Sets a token for bearer authentication. Cannot be set if basic_auth is set.
Your proxy URL. (This parameter is deprecated, and custom proxies are unsupported.)
The behavior of the alert. Possible values are CRITICAL, WARNING, and
INFO.
The monitoring tool from which the state message originated.
Your VictorOps routing key. Required if including a victor_ops object in
your request body.
A detailed explanation of the alerted problem.
If an object is specified, sends notifications through a webhook integration. Cannot be set if another integration is set.
Show child attributes
Show child attributes
Your HTTP client configuration.
Show child attributes
Show child attributes
Sets a token for bearer authentication. Cannot be set if basic_auth is set.
Your proxy URL. (This parameter is deprecated, and custom proxies are unsupported.)
Your webhook URL. This URL will be called as a POST request. Required
if including a webhook object in your request body.
Response
A successful response containing the created Notifier.
Show child attributes
Show child attributes
The name of the Notifier. You can modify this value after the Notifier is created.
Timestamp of when the Notifier was created. Cannot be set by clients.
If true, enables the discard integration, which discards all
notifications. Cannot be set if another integration is set.
If an object is specified, sends notifications through an email integration. Cannot be set if another integration is set.
If an object is specified, sends notifications through an Opsgenie integration. Cannot be set if another integration is set.
Show child attributes
Show child attributes
Your Opsgenie API key. Required if including an ops_genie object in your
request body.
The Opsgenie API URL to send requests to. Required if including an
ops_genie object in your request body.
"https://api.opsgenie.com/"
A description of the alert.
Your HTTP client configuration.
Show child attributes
Show child attributes
Sets a token for bearer authentication. Cannot be set if basic_auth is set.
Your proxy URL. (This parameter is deprecated, and custom proxies are unsupported.)
The alert text.
A note about the alert.
The priority level of alert. Possible values are P1, P2, P3, P4, and P5.
List of responders responsible for notifications.
Show child attributes
Show child attributes
The ID of the responder. Cannot be set if name or username are set.
The name of the responder. Cannot be set if id or username are set.
The type of the responder.
TEAM, USER, ESCALATION, SCHEDULE The username of the responder. Cannot be set if id or name are set.
A backlink to the sender of the notification.
A comma-separated list of tags attached to the notifications.
If an object is specified, sends notifications through a PagerDuty integration. Cannot be set if another integration is set.
Show child attributes
Show child attributes
The class of the event.
The client identification of the notification sender.
A backlink to the sender of the notification.
The part or component of the affected system that is broken.
A description of the incident.
A cluster or grouping of services.
Your HTTP client configuration.
Show child attributes
Show child attributes
Sets a token for bearer authentication. Cannot be set if basic_auth is set.
Your proxy URL. (This parameter is deprecated, and custom proxies are unsupported.)
Your PagerDuty integration key, if using the PagerDuty integration type
Events API v2. Cannot be set if service_key is set.
Your PagerDuty integration key, if using the PagerDuty integration type
Prometheus. Cannot be set if routing_key is set.
The severity of the incident. Possible values: critical, error,
warning, or info.
The Pagerduty URL to send API requests to.
If true, disables notifications for resolved alerts. Cannot be set if
discard equals true.
If an object is specified, sends notifications through a Slack integration. Cannot be set if another integration is set.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Your Slack webhook API URL. Required if including a slack object in
your request body.
The channel to send notifications to.
Your HTTP client configuration.
Show child attributes
Show child attributes
Sets a token for bearer authentication. Cannot be set if basic_auth is set.
Your proxy URL. (This parameter is deprecated, and custom proxies are unsupported.)
The user to send notifications to.
The unique identifier of the Notifier. If a slug isn't provided, one is generated based on the name field. You can't modify this field after the Notifier is created.
Timestamp of when the Notifier was last updated. Cannot be set by clients.
If an object is specified, sends notifications through a VictorOps integration. Cannot be set if another integration is set.
Show child attributes
Show child attributes
Your VictorOps API key. Required if including a victor_ops object in
your request body.
The VictorOps API URL. Required if including a victor_ops object in your
request body.
A summary of the alerted problem.
Your HTTP client configuration.
Show child attributes
Show child attributes
Sets a token for bearer authentication. Cannot be set if basic_auth is set.
Your proxy URL. (This parameter is deprecated, and custom proxies are unsupported.)
The behavior of the alert. Possible values are CRITICAL, WARNING, and
INFO.
The monitoring tool from which the state message originated.
Your VictorOps routing key. Required if including a victor_ops object in
your request body.
A detailed explanation of the alerted problem.
If an object is specified, sends notifications through a webhook integration. Cannot be set if another integration is set.
Show child attributes
Show child attributes
Your HTTP client configuration.
Show child attributes
Show child attributes
Sets a token for bearer authentication. Cannot be set if basic_auth is set.
Your proxy URL. (This parameter is deprecated, and custom proxies are unsupported.)
Your webhook URL. This URL will be called as a POST request. Required
if including a webhook object in your request body.