--- title: "GET /api/v1/config/notifiers" method: GET path: "/api/v1/config/notifiers" tags: ["Notifier"] --- # GET /api/v1/config/notifiers `GET /api/v1/config/notifiers` ## Query parameters - `page.max_size` integer - `page.token` string - `slugs` string[] - `names` string[] ## Response `200` A successful response. - Configv1ListNotifiersResponse - `page` Configv1PageResult - `next_token` string — Opaque page token which identifies the next page of items which the client should request. An empty next_token indicates that there are no more items to return. - `notifiers` Configv1Notifier[] - `slug` string — Unique identifier of the Notifier. If a `slug` isn't provided, one will be generated based of the `name` field. You can't modify this field after the Notifier is created. - `name` string — Required. Name of the Notifier. You can modify this value after the Notifier is created. - `created_at` string, date-time — Timestamp of when the Notifier was created. Cannot be set by clients. - `updated_at` string, date-time — Timestamp of when the Notifier was last updated. Cannot be set by clients. - `skip_resolved` boolean — If true, do not notify on resolved alerts. Cannot set if discard is set. - `webhook` NotifierWebhookConfig - `http_config` NotifierHTTPConfig - `basic_auth` HTTPConfigBasicAuth - `username` string - `password` string - `bearer_token` string — Bearer token authentication. Cannot be set if basic_auth is set. - `proxy_url` string — Optional proxy URL. DEPRECATED: Custom proxies are unsupported. - `tls_config` HTTPConfigTLSConfig - `insecure_skip_verify` boolean — Disables validation of the server certificate. - `url` string — Required webhook URL (will be called as a POST request). - `slack` NotifierSlackConfig - `http_config` NotifierHTTPConfig - `basic_auth` HTTPConfigBasicAuth - `username` string - `password` string - `bearer_token` string — Bearer token authentication. Cannot be set if basic_auth is set. - `proxy_url` string — Optional proxy URL. DEPRECATED: Custom proxies are unsupported. - `tls_config` HTTPConfigTLSConfig - `insecure_skip_verify` boolean — Disables validation of the server certificate. - `api_url` string — Required Slack webhook API URL. - `channel` string — The channel to send notifications to. - `username` string — The user to send notifications to. - `color` string - `title` string - `title_link` string - `pretext` string - `text` string - `footer` string - `fallback` string - `callback_id` string - `icon_emoji` string - `icon_url` string - `image_url` string - `thumb_url` string - `short_fields` boolean - `link_names` boolean - `mrkdwn_in` string[] - `fields` SlackConfigField[] - `title` string - `value` string - `short` boolean - `actions` NotifierSlackConfigAction[] - `type` string - `text` string - `url` string - `style` string - `name` string - `value` string - `confirm_field` SlackConfigConfirmationField - `text` string - `title` string - `ok_text` string - `dismiss_text` string - `pagerduty` NotifierPagerdutyConfig - `http_config` NotifierHTTPConfig - `basic_auth` HTTPConfigBasicAuth - `username` string - `password` string - `bearer_token` string — Bearer token authentication. Cannot be set if basic_auth is set. - `proxy_url` string — Optional proxy URL. DEPRECATED: Custom proxies are unsupported. - `tls_config` HTTPConfigTLSConfig - `insecure_skip_verify` boolean — Disables validation of the server certificate. - `url` string — The Pagerduty URL to send API requests to. - `client` string — Client identification of the notification sender. - `client_url` string — A backlink to the sender of the notification. - `description` string — Description of the incident. - `severity` string — Severity of the incident. Valid values are 'critical', 'error', 'warning', 'info', or blank - `class` string — The class/type of the event. - `component` string — The part or component of the affected system which is broken. - `group` string — A cluster or grouping of services. - `details` object — Set of arbitrary key/value pairs which provide further detail about the incident. - `images` PagerdutyConfigImage[] — Images to attach to the incident. - `src` string - `alt` string - `href` string - `links` PagerdutyConfigLink[] — Links to attach to the incident. - `href` string - `text` string - `service_key` string — The PagerDuty integration key (when using PagerDuty integration type "Prometheus"). Cannot be set if routing_key is set. - `routing_key` string — The PagerDuty integration key (when using PagerDuty integration type "Events API v2"). Cannot be set if service_key is set. - `email` NotifierEmailConfig - `to` string — Required email address to send notifications to. - `html` string — Optional HTML body of the email. - `text` string — Optional text body of the email. - `ops_genie` NotifierOpsGenieConfig - `http_config` NotifierHTTPConfig - `basic_auth` HTTPConfigBasicAuth - `username` string - `password` string - `bearer_token` string — Bearer token authentication. Cannot be set if basic_auth is set. - `proxy_url` string — Optional proxy URL. DEPRECATED: Custom proxies are unsupported. - `tls_config` HTTPConfigTLSConfig - `insecure_skip_verify` boolean — Disables validation of the server certificate. - `api_key` string — Required OpsGenie API key. - `api_url` string — Required OpsGenie API URL to send requests to, e.g. "https://api.opsgenie.com/". - `message` string — Alert text. - `description` string — Description of the alert. - `source` string — A backlink to the sender of the notification. - `details` object — A set of arbitrary key/value pairs that provide further detail about the alert. - `responders` OpsGenieConfigResponder[] — List of responders responsible for notifications. - `id` string — ID of the responder. Cannot be set if name or username are set. - `name` string — Name of the responder. Cannot be set if id or username are set. - `username` string — Username of the responder. Cannot be set if id or name are set. - `responder_type` 'TEAM' | 'USER' | 'ESCALATION' | 'SCHEDULE' - `tags` string — Comma separated list of tags attached to the notifications. - `note` string — Additional alert note. - `priority` string — Priority level of alert. Possible values are P1, P2, P3, P4, and P5. - `victor_ops` NotifierVictorOpsConfig - `http_config` NotifierHTTPConfig - `basic_auth` HTTPConfigBasicAuth - `username` string - `password` string - `bearer_token` string — Bearer token authentication. Cannot be set if basic_auth is set. - `proxy_url` string — Optional proxy URL. DEPRECATED: Custom proxies are unsupported. - `tls_config` HTTPConfigTLSConfig - `insecure_skip_verify` boolean — Disables validation of the server certificate. - `api_key` string — Required VictorOps API key. - `api_url` string — Required VictorOps API URL. - `routing_key` string — Required VictorOps routing key. - `message_type` string — Describes the behavior of the alert (CRITICAL, WARNING, INFO). - `entity_display_name` string — Summary of the alerted problem. - `state_message` string — Long explanation of the alerted problem. - `monitoring_tool` string — The monitoring tool the state message is from. - `custom_fields` object - `discard` boolean — If set, enables the "discard" integration which simply discards all notifications. Cannot set if another integration is set. ## Other responses - `500` — An unexpected error response. - `default` — An undefined error response. --- [API](https://skmtc.net/chronosphere/apis/config-v1-api.md) · [All operations](https://skmtc.net/chronosphere/apis/config-v1-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/chronosphere/config-v1-api/revisions/530951bd2ccf/schema)