How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

SigNoz channels API

The channels API from SigNoz — 4 operation(s) for channels.

SigNoz channels API is one of 29 APIs that SigNoz publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Channels. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a GitHub repository, pricing, and a getting-started guide.

This API exposes 7 operations across 4 paths, and defines 52 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against a single base URL, https://{host}:{port}{base_path}.

7 operations 4 paths 52 schemas 1 DELETE2 GET3 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://{host}:{port}
Authentication
API Key, HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 2

SigNoz channels API declares 2 security schemes for authenticating requests. An API key is passed in the header as SigNoz-Api-Key (api_key). It accepts HTTP bearer tokens (Tokenizer) (tokenizer).

  • api_key — API Keys
  • tokenizer — Tokens generated by the tokenizer

Paths & Operations 7

Across 4 paths, the API surfaces 7 operations — 1 DELETE, 2 GET, 3 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

channels 7
GET
/api/v1/channels
List notification channels
ListChannels → 200401403500
POST
/api/v1/channels
Create notification channel
CreateChannel body → 201400401403500
DELETE
/api/v1/channels/{id}
Delete notification channel
DeleteChannelByID 1 param → 204401403404500
GET
/api/v1/channels/{id}
Get notification channel by ID
GetChannelByID 1 param → 200401403404500
PUT
/api/v1/channels/{id}
Update notification channel
UpdateChannelByID 1 param body → 204400401403404500
POST
/api/v1/channels/test
Test notification channel
TestChannel body → 204400401403500
POST
/api/v1/testChanneldeprecated
Test notification channel (deprecated)
TestChannelDeprecated body → 204400401403500

Schemas 52

The contract defines 52 schemas that model the data the API accepts and returns. The most detailed are ConfigSlackConfig (28 properties), ConfigOAuth2 (20 properties), ConfigRocketchatConfig (20 properties), ConfigPagerdutyConfig (19 properties). Each schema is shown below with its type and property counts.

ConfigIncidentioConfig
object
8 properties
RenderErrorResponse
object
2 properties 2 required
ConfigThreadingConfig
object
2 properties
ConfigMattermostField
object
3 properties
ConfigHeaders
object
ConfigJiraFieldConfig
object
2 properties
AlertmanagertypesChannel
object
7 properties 5 required
ConfigAuthorization
object
4 properties
ConfigPagerdutyImage
object
3 properties
ConfigPagerdutyLink
object
2 properties
ConfigOpsGenieConfig
object
16 properties
ConfigSlackField
object
3 properties
ConfigDuration
string
ErrorsResponseerroradditional
object
1 property
ConfigMSTeamsV2Config
object
6 properties
ConfigTLSConfig
object
13 properties
ConfigTelegramConfig
object
11 properties
ConfigSNSConfig
object
10 properties
ConfigMattermostProps
object
1 property
ConfigDiscordConfig
object
9 properties
ConfigWebhookConfig
object
6 properties
ConfigURLType2
object
ConfigJiraConfig
object
15 properties
ConfigMattermostPriority
object
3 properties
ConfigRocketchatConfig
object
20 properties
ConfigSlackConfirmationField
object
4 properties
ConfigRocketchatAttachmentField
object
3 properties
ConfigSecretURL
object
ConfigEmailConfig
object
18 properties
ConfigHostPort
object
ConfigMattermostAttachment
object
14 properties
ConfigWechatConfig
object
12 properties
ConfigBasicAuth
object
6 properties
ConfigOpsGenieConfigResponder
object
4 properties
ConfigVictorOpsConfig
object
11 properties
ErrorsJSON
object
4 properties 2 required
ConfigSlackAction
object
7 properties
ConfigMSTeamsConfig
object
7 properties
ConfigProxyHeader
object
ConfigSlackConfig
object
28 properties
ConfigURL
object
ConfigReceiver
object
19 properties
ConfigHTTPClientConfig
object
13 properties
ConfigPagerdutyConfig
object
19 properties
TimeDuration
integer
ConfigOAuth2
object
20 properties
ConfigMattermostConfig
object
13 properties
Sigv4SigV4Config
object
ConfigRocketchatAttachmentAction
object
9 properties
ConfigWebexConfig
object
5 properties
ConfigPushoverConfig
object
18 properties
ModelDuration
integer

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

signoz-channels-api-openapi.yml Raw ↑

Other APIs SigNoz publishes across the network.

SigNoz alerts API
SigNoz authdomains API
SigNoz authz API
SigNoz cloudintegration API
SigNoz dashboard API
SigNoz downtimeschedules API
SigNoz features API
SigNoz fields API
SigNoz gateway API
SigNoz global API
SigNoz health API
SigNoz inframonitoring API
Where this information came from

This is an independent, third-party profile of SigNoz channels API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.