openapi: 3.0.3 info: contact: email: support@signoz.io name: SigNoz Support url: https://signoz.io description: OpenTelemetry-Native Logs, Metrics and Traces in a single pane termsOfService: https://signoz.io/terms-of-service/ title: SigNoz alerts channels API version: '' servers: - description: The fully qualified URL to the SigNoz APIServer. url: https://{host}:{port}{base_path} variables: base_path: default: / description: The base path of the SigNoz APIServer host: default: localhost description: The host of the SigNoz APIServer port: default: '8080' description: The port of the SigNoz APIServer tags: - name: channels paths: /api/v1/channels: get: deprecated: false description: This endpoint lists all notification channels for the organization operationId: ListChannels responses: '200': content: application/json: schema: properties: data: items: $ref: '#/components/schemas/AlertmanagertypesChannel' type: array status: type: string required: - status - data type: object description: OK '401': content: application/json: schema: $ref: '#/components/schemas/RenderErrorResponse' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/RenderErrorResponse' description: Forbidden '500': content: application/json: schema: $ref: '#/components/schemas/RenderErrorResponse' description: Internal Server Error security: - api_key: - VIEWER - tokenizer: - VIEWER summary: List notification channels tags: - channels post: deprecated: false description: This endpoint creates a notification channel operationId: CreateChannel requestBody: content: application/json: schema: $ref: '#/components/schemas/ConfigReceiver' responses: '201': content: application/json: schema: properties: data: $ref: '#/components/schemas/AlertmanagertypesChannel' status: type: string required: - status - data type: object description: Created '400': content: application/json: schema: $ref: '#/components/schemas/RenderErrorResponse' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/RenderErrorResponse' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/RenderErrorResponse' description: Forbidden '500': content: application/json: schema: $ref: '#/components/schemas/RenderErrorResponse' description: Internal Server Error security: - api_key: - ADMIN - tokenizer: - ADMIN summary: Create notification channel tags: - channels /api/v1/channels/{id}: delete: deprecated: false description: This endpoint deletes a notification channel by ID operationId: DeleteChannelByID parameters: - in: path name: id required: true schema: type: string responses: '204': description: No Content '401': content: application/json: schema: $ref: '#/components/schemas/RenderErrorResponse' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/RenderErrorResponse' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/RenderErrorResponse' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/RenderErrorResponse' description: Internal Server Error security: - api_key: - ADMIN - tokenizer: - ADMIN summary: Delete notification channel tags: - channels get: deprecated: false description: This endpoint returns a notification channel by ID operationId: GetChannelByID parameters: - in: path name: id required: true schema: type: string responses: '200': content: application/json: schema: properties: data: $ref: '#/components/schemas/AlertmanagertypesChannel' status: type: string required: - status - data type: object description: OK '401': content: application/json: schema: $ref: '#/components/schemas/RenderErrorResponse' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/RenderErrorResponse' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/RenderErrorResponse' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/RenderErrorResponse' description: Internal Server Error security: - api_key: - VIEWER - tokenizer: - VIEWER summary: Get notification channel by ID tags: - channels put: deprecated: false description: This endpoint updates a notification channel by ID operationId: UpdateChannelByID parameters: - in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ConfigReceiver' responses: '204': description: No Content '400': content: application/json: schema: $ref: '#/components/schemas/RenderErrorResponse' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/RenderErrorResponse' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/RenderErrorResponse' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/RenderErrorResponse' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/RenderErrorResponse' description: Internal Server Error security: - api_key: - ADMIN - tokenizer: - ADMIN summary: Update notification channel tags: - channels /api/v1/channels/test: post: deprecated: false description: This endpoint tests a notification channel by sending a test notification operationId: TestChannel requestBody: content: application/json: schema: $ref: '#/components/schemas/ConfigReceiver' responses: '204': description: No Content '400': content: application/json: schema: $ref: '#/components/schemas/RenderErrorResponse' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/RenderErrorResponse' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/RenderErrorResponse' description: Forbidden '500': content: application/json: schema: $ref: '#/components/schemas/RenderErrorResponse' description: Internal Server Error security: - api_key: - EDITOR - tokenizer: - EDITOR summary: Test notification channel tags: - channels /api/v1/testChannel: post: deprecated: true description: 'Deprecated: use /api/v1/channels/test instead' operationId: TestChannelDeprecated requestBody: content: application/json: schema: $ref: '#/components/schemas/ConfigReceiver' responses: '204': description: No Content '400': content: application/json: schema: $ref: '#/components/schemas/RenderErrorResponse' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/RenderErrorResponse' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/RenderErrorResponse' description: Forbidden '500': content: application/json: schema: $ref: '#/components/schemas/RenderErrorResponse' description: Internal Server Error security: - api_key: - EDITOR - tokenizer: - EDITOR summary: Test notification channel (deprecated) tags: - channels components: schemas: ConfigThreadingConfig: properties: enabled: type: boolean thread_by_date: type: string type: object ConfigURL: type: object ConfigRocketchatAttachmentAction: properties: image_url: type: string is_webview: type: boolean msg: type: string msg_in_chat_window: type: boolean msg_processing_type: type: string text: type: string type: type: string url: type: string webview_height_ratio: type: string type: object ConfigURLType2: type: object ConfigRocketchatConfig: properties: actions: items: $ref: '#/components/schemas/ConfigRocketchatAttachmentAction' type: array api_url: $ref: '#/components/schemas/ConfigURLType2' channel: type: string color: type: string emoji: type: string fields: items: $ref: '#/components/schemas/ConfigRocketchatAttachmentField' type: array http_config: $ref: '#/components/schemas/ConfigHTTPClientConfig' icon_url: type: string image_url: type: string link_names: type: boolean send_resolved: type: boolean short_fields: type: boolean text: type: string thumb_url: type: string title: type: string title_link: type: string token: type: string token_file: type: string token_id: type: string token_id_file: type: string type: object ConfigReceiver: properties: discord_configs: items: $ref: '#/components/schemas/ConfigDiscordConfig' type: array email_configs: items: $ref: '#/components/schemas/ConfigEmailConfig' type: array incidentio_configs: items: $ref: '#/components/schemas/ConfigIncidentioConfig' type: array jira_configs: items: $ref: '#/components/schemas/ConfigJiraConfig' type: array mattermost_configs: items: $ref: '#/components/schemas/ConfigMattermostConfig' type: array msteams_configs: items: $ref: '#/components/schemas/ConfigMSTeamsConfig' type: array msteamsv2_configs: items: $ref: '#/components/schemas/ConfigMSTeamsV2Config' type: array name: type: string opsgenie_configs: items: $ref: '#/components/schemas/ConfigOpsGenieConfig' type: array pagerduty_configs: items: $ref: '#/components/schemas/ConfigPagerdutyConfig' type: array pushover_configs: items: $ref: '#/components/schemas/ConfigPushoverConfig' type: array rocketchat_configs: items: $ref: '#/components/schemas/ConfigRocketchatConfig' type: array slack_configs: items: $ref: '#/components/schemas/ConfigSlackConfig' type: array sns_configs: items: $ref: '#/components/schemas/ConfigSNSConfig' type: array telegram_configs: items: $ref: '#/components/schemas/ConfigTelegramConfig' type: array victorops_configs: items: $ref: '#/components/schemas/ConfigVictorOpsConfig' type: array webex_configs: items: $ref: '#/components/schemas/ConfigWebexConfig' type: array webhook_configs: items: $ref: '#/components/schemas/ConfigWebhookConfig' type: array wechat_configs: items: $ref: '#/components/schemas/ConfigWechatConfig' type: array type: object ConfigMSTeamsV2Config: properties: http_config: $ref: '#/components/schemas/ConfigHTTPClientConfig' send_resolved: type: boolean text: type: string title: type: string webhook_url: $ref: '#/components/schemas/ConfigSecretURL' webhook_url_file: type: string type: object TimeDuration: format: int64 type: integer ConfigSecretURL: type: object ConfigDiscordConfig: properties: avatar_url: type: string content: type: string http_config: $ref: '#/components/schemas/ConfigHTTPClientConfig' message: type: string send_resolved: type: boolean title: type: string username: type: string webhook_url: $ref: '#/components/schemas/ConfigSecretURL' webhook_url_file: type: string type: object ModelDuration: format: int64 type: integer ConfigDuration: format: int64 type: string ConfigSNSConfig: properties: api_url: type: string attributes: additionalProperties: type: string type: object http_config: $ref: '#/components/schemas/ConfigHTTPClientConfig' message: type: string phone_number: type: string send_resolved: type: boolean sigv4: $ref: '#/components/schemas/Sigv4SigV4Config' subject: type: string target_arn: type: string topic_arn: type: string type: object ConfigMattermostPriority: properties: persistent_notifications: type: boolean priority: type: string requested_ack: type: boolean type: object ConfigEmailConfig: properties: auth_identity: type: string auth_password: type: string auth_password_file: type: string auth_secret: type: string auth_secret_file: type: string auth_username: type: string force_implicit_tls: nullable: true type: boolean from: type: string headers: additionalProperties: type: string type: object hello: type: string html: type: string require_tls: nullable: true type: boolean send_resolved: type: boolean smarthost: $ref: '#/components/schemas/ConfigHostPort' text: type: string threading: $ref: '#/components/schemas/ConfigThreadingConfig' tls_config: $ref: '#/components/schemas/ConfigTLSConfig' to: type: string type: object ConfigPushoverConfig: properties: device: type: string expire: $ref: '#/components/schemas/ConfigDuration' html: type: boolean http_config: $ref: '#/components/schemas/ConfigHTTPClientConfig' message: type: string monospace: type: boolean priority: type: string retry: $ref: '#/components/schemas/ConfigDuration' send_resolved: type: boolean sound: type: string title: type: string token: type: string token_file: type: string ttl: $ref: '#/components/schemas/ConfigDuration' url: type: string url_title: type: string user_key: type: string user_key_file: type: string type: object ConfigHostPort: type: object ConfigWebhookConfig: properties: http_config: $ref: '#/components/schemas/ConfigHTTPClientConfig' max_alerts: minimum: 0 type: integer send_resolved: type: boolean timeout: $ref: '#/components/schemas/TimeDuration' url: type: string url_file: type: string type: object ConfigBasicAuth: properties: password: type: string password_file: type: string password_ref: type: string username: type: string username_file: type: string username_ref: type: string type: object ConfigMSTeamsConfig: properties: http_config: $ref: '#/components/schemas/ConfigHTTPClientConfig' send_resolved: type: boolean summary: type: string text: type: string title: type: string webhook_url: $ref: '#/components/schemas/ConfigSecretURL' webhook_url_file: type: string type: object ConfigMattermostConfig: properties: attachments: items: $ref: '#/components/schemas/ConfigMattermostAttachment' type: array channel: type: string http_config: $ref: '#/components/schemas/ConfigHTTPClientConfig' icon_emoji: type: string icon_url: type: string priority: $ref: '#/components/schemas/ConfigMattermostPriority' props: $ref: '#/components/schemas/ConfigMattermostProps' send_resolved: type: boolean text: type: string type: type: string username: type: string webhook_url: $ref: '#/components/schemas/ConfigSecretURL' webhook_url_file: type: string type: object ConfigWechatConfig: properties: agent_id: type: string api_secret: type: string api_secret_file: type: string api_url: $ref: '#/components/schemas/ConfigURLType2' corp_id: type: string http_config: $ref: '#/components/schemas/ConfigHTTPClientConfig' message: type: string message_type: type: string send_resolved: type: boolean to_party: type: string to_tag: type: string to_user: type: string type: object ConfigSlackConfig: properties: actions: items: $ref: '#/components/schemas/ConfigSlackAction' type: array api_url: $ref: '#/components/schemas/ConfigSecretURL' api_url_file: type: string app_token: type: string app_token_file: type: string app_url: $ref: '#/components/schemas/ConfigURLType2' callback_id: type: string channel: type: string color: type: string fallback: type: string fields: items: $ref: '#/components/schemas/ConfigSlackField' type: array footer: type: string http_config: $ref: '#/components/schemas/ConfigHTTPClientConfig' icon_emoji: type: string icon_url: type: string image_url: type: string link_names: type: boolean message_text: type: string mrkdwn_in: items: type: string type: array pretext: type: string send_resolved: type: boolean short_fields: type: boolean text: type: string thumb_url: type: string timeout: $ref: '#/components/schemas/TimeDuration' title: type: string title_link: type: string username: type: string type: object ErrorsResponseerroradditional: properties: message: type: string type: object ConfigRocketchatAttachmentField: properties: short: nullable: true type: boolean title: type: string value: type: string type: object ConfigJiraFieldConfig: properties: enable_update: nullable: true type: boolean template: type: string type: object ConfigOAuth2: properties: audience: type: string claims: additionalProperties: {} type: object client_certificate_key: type: string client_certificate_key_file: type: string client_certificate_key_id: type: string client_certificate_key_ref: type: string client_id: type: string client_secret: type: string client_secret_file: type: string client_secret_ref: type: string endpoint_params: additionalProperties: type: string type: object grant_type: type: string iss: type: string no_proxy: type: string proxy_connect_header: $ref: '#/components/schemas/ConfigProxyHeader' proxy_from_environment: type: boolean proxy_url: $ref: '#/components/schemas/ConfigURL' scopes: items: type: string type: array signature_algorithm: type: string token_url: type: string type: object ConfigPagerdutyImage: properties: alt: type: string href: type: string src: type: string type: object Sigv4SigV4Config: type: object ConfigPagerdutyConfig: properties: class: type: string client: type: string client_url: type: string component: type: string description: type: string details: additionalProperties: {} type: object group: type: string http_config: $ref: '#/components/schemas/ConfigHTTPClientConfig' images: items: $ref: '#/components/schemas/ConfigPagerdutyImage' type: array links: items: $ref: '#/components/schemas/ConfigPagerdutyLink' type: array routing_key: type: string routing_key_file: type: string send_resolved: type: boolean service_key: type: string service_key_file: type: string severity: type: string source: type: string timeout: $ref: '#/components/schemas/TimeDuration' url: $ref: '#/components/schemas/ConfigURLType2' type: object ConfigSlackAction: properties: confirm: $ref: '#/components/schemas/ConfigSlackConfirmationField' name: type: string style: type: string text: type: string type: type: string url: type: string value: type: string type: object ConfigWebexConfig: properties: api_url: $ref: '#/components/schemas/ConfigURLType2' http_config: $ref: '#/components/schemas/ConfigHTTPClientConfig' message: type: string room_id: type: string send_resolved: type: boolean type: object ConfigSlackConfirmationField: properties: dismiss_text: type: string ok_text: type: string text: type: string title: type: string type: object ConfigMattermostAttachment: properties: author_icon: type: string author_link: type: string author_name: type: string color: type: string fallback: type: string fields: items: $ref: '#/components/schemas/ConfigMattermostField' type: array footer: type: string footer_icon: type: string image_url: type: string pretext: type: string text: type: string thumb_url: type: string title: type: string title_link: type: string type: object ConfigJiraConfig: properties: api_type: type: string api_url: $ref: '#/components/schemas/ConfigURLType2' custom_fields: additionalProperties: {} type: object description: $ref: '#/components/schemas/ConfigJiraFieldConfig' http_config: $ref: '#/components/schemas/ConfigHTTPClientConfig' issue_type: type: string labels: items: type: string type: array priority: type: string project: type: string reopen_duration: $ref: '#/components/schemas/ModelDuration' reopen_transition: type: string resolve_transition: type: string send_resolved: type: boolean summary: $ref: '#/components/schemas/ConfigJiraFieldConfig' wont_fix_resolution: type: string type: object ConfigMattermostField: properties: short: nullable: true type: boolean title: type: string value: type: string type: object ConfigTLSConfig: properties: ca: type: string ca_file: type: string ca_ref: type: string cert: type: string cert_file: type: string cert_ref: type: string insecure_skip_verify: type: boolean key: type: string key_file: type: string key_ref: type: string max_version: minimum: 0 type: integer min_version: minimum: 0 type: integer server_name: type: string type: object ConfigOpsGenieConfigResponder: properties: id: type: string name: type: string type: type: string username: type: string type: object ConfigMattermostProps: properties: card: type: string type: object ConfigHeaders: type: object RenderErrorResponse: properties: error: $ref: '#/components/schemas/ErrorsJSON' status: type: string required: - status - error type: object ConfigIncidentioConfig: properties: alert_source_token: type: string alert_source_token_file: type: string http_config: $ref: '#/components/schemas/ConfigHTTPClientConfig' max_alerts: minimum: 0 type: integer send_resolved: type: boolean timeout: $ref: '#/components/schemas/TimeDuration' url: $ref: '#/components/schemas/ConfigURLType2' url_file: type: string type: object ConfigSlackField: properties: short: nullable: true type: boolean title: type: string value: type: string type: object ErrorsJSON: properties: code: type: string errors: items: $ref: '#/components/schemas/ErrorsResponseerroradditional' type: array message: type: string url: type: string required: - code - message type: object ConfigPagerdutyLink: properties: href: type: string text: type: string type: object ConfigOpsGenieConfig: properties: actions: type: string api_key: type: string api_key_file: type: string api_url: $ref: '#/components/schemas/ConfigURLType2' description: type: string details: additionalProperties: type: string type: object entity: type: string http_config: $ref: '#/components/schemas/ConfigHTTPClientConfig' message: type: string note: type: string priority: type: string responders: items: $ref: '#/components/schemas/ConfigOpsGenieConfigResponder' type: array send_resolved: type: boolean source: type: string tags: type: string update_alerts: type: boolean type: object ConfigVictorOpsConfig: properties: api_key: type: string api_key_file: type: string api_url: $ref: '#/components/schemas/ConfigURLType2' custom_fields: additionalProperties: type: string type: object entity_display_name: type: string http_config: $ref: '#/components/schemas/ConfigHTTPClientConfig' message_type: type: string monitoring_tool: type: string routing_key: type: string send_resolved: type: boolean state_message: type: string type: object ConfigProxyHeader: additionalProperties: items: type: string type: array type: object ConfigTelegramConfig: properties: api_url: $ref: '#/components/schemas/ConfigURLType2' chat: format: int64 type: integer chat_file: type: string disable_notifications: type: boolean http_config: $ref: '#/components/schemas/ConfigHTTPClientConfig' message: type: string message_thread_id: type: integer parse_mode: type: string send_resolved: type: boolean token: type: string token_file: type: string type: object ConfigAuthorization: properties: credentials: type: string credentials_file: type: string credentials_ref: type: string type: type: string type: object ConfigHTTPClientConfig: properties: authorization: $ref: '#/components/schemas/ConfigAuthorization' basic_auth: $ref: '#/components/schemas/ConfigBasicAuth' bearer_token: type: string bearer_token_file: type: string enable_http2: type: boolean follow_redirects: type: boolean http_headers: $ref: '#/components/schemas/ConfigHeaders' no_proxy: type: string oauth2: $ref: '#/components/schemas/ConfigOAuth2' proxy_connect_header: $ref: '#/components/schemas/ConfigProxyHeader' proxy_from_environment: type: boolean proxy_url: $ref: '#/components/schemas/ConfigURL' tls_config: $ref: '#/components/schemas/ConfigTLSConfig' type: object AlertmanagertypesChannel: properties: createdAt: format: date-time type: string data: type: string id: type: string name: type: string orgId: type: string type: type: string updatedAt: format: date-time type: string required: - id - name - type - data - orgId type: object securitySchemes: api_key: description: API Keys in: header name: SigNoz-Api-Key type: apiKey tokenizer: bearerFormat: Tokenizer description: Tokens generated by the tokenizer scheme: bearer type: http