Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Kentik AlertService API

The AlertService API from Kentik — 7 operation(s) for alertservice.

Kentik AlertService API is one of 24 APIs that Kentik publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include AlertService. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 8 operations across 7 paths, and defines 62 schemas. It is described by OpenAPI 3.0.0, at version v202511.

Requests are made against the base URL https://grpc.api.kentik.com.

8 operations 7 paths 62 schemas 2 GET5 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
v202511
Base URL
https://grpc.api.kentik.com
Authentication
API Key, API Key
Resource Areas
1

Authentication & Security 2

Kentik AlertService API declares 2 security schemes for authenticating requests. An API key is passed in the header as X-CH-Auth-Email (email). An API key is passed in the header as X-CH-Auth-API-Token (token). By default, every request must be authenticated.

Paths & Operations 8

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

AlertService 8
POST
/v202505/alerts
List Alerts
List body → 200default
POST
/v202505/alerts/clear
Clear Alerts
Clear body → 200default
GET
/v202505/alerts/{alertId}/comments
List Alert Comments
ListComments 1 param → 200default
POST
/v202505/alerts/{alertId}/comments
Add Alert Comment
AddComment 1 param body → 200default
PUT
/v202505/alerts/{alertId}/external-context
Set External Context for Alert
SetExternalContext 1 param body → 200default
GET
/v202505/alerts/{id}
Get Alert
Get 1 param → 200default
POST
/v202505/alerts/{id}/ack
Ack Alert
Ack 1 param body → 200default
POST
/v202505/alerts/{id}/unack
UnAck Alert
UnAck 1 param body → 200default

Schemas 62

The contract defines 62 schemas that model the data the API accepts and returns. The most detailed are v202505AlertFilters (14 properties), v202505Alert (13 properties), v202303AttributeFilter (8 properties), v202505NmsContext (7 properties). Each schema is shown below with its type and property counts.

AlertServiceUnAckBody
object
v202505JiraCloudContext
object
2 properties 2 required
v202303AttributeFilter
object
8 properties
v202505NmsConditionOperator
string
v202505Source
object
2 properties 2 required
typesv202506SortingConfig
object
1 property
v202303Severity
string
v202505NmsThresholdCondition
object
2 properties
v202505AlertServiceSetExternalContextResponse
object
1 property
FieldBy
string
v202303SimpleAttributeFilterStringArray
object
1 property
FlowContextInterfaceDetails
object
4 properties
v202505FlowContext
object
4 properties
NmsContextDatasetInfo
object
4 properties
v202505NmsStateSet
object
2 properties
v202505AlertServiceGetResponse
object
3 properties
v202303AttributeFilterStringArray
object
1 property
v202303TimeRange
object
2 properties
FlowContextSiteDetails
object
6 properties
v202505AlertServiceClearResponse
object
1 property
v202505AlertFilters
object
14 properties
AlertServiceSetExternalContextBody
object
1 property 1 required
typesv202506PaginationInfo
object
2 properties
v202505AlertState
string
SortingConfigOrder
string
v202505AlertServiceAckResponse
object
1 property
NmsContextAlarmTarget
object
2 properties
v202303KeyValueFilter
object
2 properties
v202505Alert
object
13 properties
v202505Comment
object
7 properties
FlowContextActivationStatus
string
FlowContextMetricValue
object
2 properties
v202505NmsContext
object
7 properties
NmsContextAlarmMetricMap
object
1 property
v202303SimpleAttributeFilter
object
6 properties
rpcStatus
object
3 properties
typesv202506PaginationConfig
object
3 properties
v202505NmsConditionGroup
object
4 properties
v202505ServiceNowContext
object
2 properties 2 required
v202505AlertAcknowledgement
string
v202505AlertServiceClearRequest
object
1 property 1 required
FlowContextAlertKeyDetails
object
4 properties
v202505PolicyType
string
v202505AlertServiceListRequest
object
3 properties
v202505AlertServiceUnAckResponse
object
1 property
v202505NmsCondition
object
5 properties
v202505NmsActivateOrClearConditions
object
2 properties
AlertServiceAckBody
object
1 property
v202505ExternalContext
object
2 properties 2 required
v202505AlertServiceListResponse
object
2 properties
v202303MultiAttributeFilter
object
2 properties
v202505AlertServiceAddCommentResponse
object
1 property
NmsContextActivationInfo
object
4 properties
FlowContextDeviceDetails
object
4 properties
v202505NmsConditionConnector
string
v202505NmsStateChangeCondition
object
2 properties
AlertAcknowledgement
object
4 properties
AlertServiceAddCommentBody
object
1 property 1 required
protobufAny
object
1 property
SortingConfigField
object
2 properties
v202505AlertServiceListCommentsResponse
object
1 property
v202505AlertPhase
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kentik-alertservice-api-openapi.yml Raw ↑

Other APIs Kentik publishes across the network.

Kentik AiAdvisorDataService API
Kentik ASGroupService API
Kentik AuditService API
Kentik BgpMonitoringAdminService API
Kentik BgpMonitoringDataService API
Kentik CapacityPlanService API
Kentik CloudExportAdminService API
Kentik CostService API
Kentik CustomDimensionService API
Kentik DeviceService API
Kentik FlowTagService API
Kentik KmiService API