Alerts
API key is a token provided while making the API calls. This is used to authenticate the client at the exposed endpoint.
Alert ID, e.g. ALERT-123
Harness account identifier.
Harness organization identifier.
Harness project identifier.
Alert acknowledged
Alert pretty id, e.g. ALERT-123
Alert description
Resolved alert status option id (e.g. triggered, resolved)
Harness service identifiers for impacted services
Environment labels (e.g. prod, qa)
Monitoring link for the alert
Deduplication / correlation key
When true, suppresses notifications and on-call pages
Epoch timestamp when created (milliseconds)
Epoch timestamp when the alert started (milliseconds)
Epoch timestamp when acknowledged (milliseconds)
Epoch timestamp when resolved (milliseconds)
Epoch timestamp when closed (milliseconds)
Alert not found
POST /gateway/ir/tp/api/v1/mc/alerts/{alertId}/acknowledge?accountId=text&orgId=text&projectId=text HTTP/1.1
Host: app.harness.io
x-api-key: YOUR_API_KEY
Accept: */*
{
"prettyId": "text",
"projectId": "text",
"title": "text",
"description": "text",
"status": "text",
"priority": {
"id": "text",
"label": "text"
},
"impactedServices": [
"text"
],
"environments": [
"text"
],
"monitoringLink": "text",
"deduplicationId": "text",
"quietMode": true,
"keyEvents": [
{
"timestamp": 1,
"status": "text",
"details": "text"
}
],
"relatedActivities": [
{
"name": "text",
"templateTypeName": "INCIDENT",
"prettyId": "text",
"globalId": "text",
"title": "text"
}
],
"relatedExternalEntities": [
{
"relationshipGlobalId": "text",
"name": "text",
"type": "DEPLOYMENT",
"provider": "HARNESS",
"externalId": "text",
"url": "text",
"displayName": "text"
}
],
"commsLinks": [
{
"url": "text",
"linkType": "WEB"
}
],
"createdAtTimestamp": 1,
"startedAtTimestamp": 1,
"acknowledgedAtTimestamp": 1,
"resolvedAtTimestamp": 1,
"closedAtTimestamp": 1
}API key is a token provided while making the API calls. This is used to authenticate the client at the exposed endpoint.
Harness account identifier.
Harness organization identifier.
Harness project identifier.
Filter by status (multi-value, OR-combined). Allowed: triggered, acknowledged, resolved, dismissed.
Filter by priority option id (multi-value, OR-combined)
Filter by service: Harness identifier, name, or ID (multi-value, OR-combined)
Filter by environment (multi-value, OR-combined), each a Harness environment identifier, name, or serialized HarnessEnvironmentId. Identifiers are matched before names. A reference shared by several scopes resolves to the closest: this project, then its org, then the account, then other projects in (org, project) order.
Filter by alert template short id (multi-value, OR-combined), e.g. PALERTAED1EE
Free-text search across title and description
ISO-8601 inclusive lower bound on createdAt, e.g. 2026-05-01T00:00:00Z
ISO-8601 inclusive upper bound on createdAt
Field to sort alerts by
Sort direction
Page size requested
0-based page number; defaults to 0 (the first page).
Page of alerts
GET /gateway/ir/tp/api/v1/mc/alerts?accountId=text&orgId=text&projectId=text HTTP/1.1
Host: app.harness.io
x-api-key: YOUR_API_KEY
Accept: */*
Page of alerts
{
"entities": [
{
"prettyId": "text",
"projectId": "text",
"title": "text",
"description": "text",
"status": "text",
"priority": {
"id": "text",
"label": "text"
},
"impactedServices": [
"text"
],
"environments": [
"text"
],
"monitoringLink": "text",
"deduplicationId": "text",
"quietMode": true,
"keyEvents": [
{
"timestamp": 1,
"status": "text",
"details": "text"
}
],
"relatedActivities": [
{
"name": "text",
"templateTypeName": "INCIDENT",
"prettyId": "text",
"globalId": "text",
"title": "text"
}
],
"relatedExternalEntities": [
{
"relationshipGlobalId": "text",
"name": "text",
"type": "DEPLOYMENT",
"provider": "HARNESS",
"externalId": "text",
"url": "text",
"displayName": "text"
}
],
"commsLinks": [
{
"url": "text",
"linkType": "WEB"
}
],
"createdAtTimestamp": 1,
"startedAtTimestamp": 1,
"acknowledgedAtTimestamp": 1,
"resolvedAtTimestamp": 1,
"closedAtTimestamp": 1
}
],
"totalCount": 1
}API key is a token provided while making the API calls. This is used to authenticate the client at the exposed endpoint.
Alert ID, e.g. ALERT-123
Harness account identifier.
Harness organization identifier.
Harness project identifier.
Alert dismissed
Alert pretty id, e.g. ALERT-123
Alert description
Resolved alert status option id (e.g. triggered, resolved)
Harness service identifiers for impacted services
Environment labels (e.g. prod, qa)
Monitoring link for the alert
Deduplication / correlation key
When true, suppresses notifications and on-call pages
Epoch timestamp when created (milliseconds)
Epoch timestamp when the alert started (milliseconds)
Epoch timestamp when acknowledged (milliseconds)
Epoch timestamp when resolved (milliseconds)
Epoch timestamp when closed (milliseconds)
Alert not found
POST /gateway/ir/tp/api/v1/mc/alerts/{alertId}/dismiss?accountId=text&orgId=text&projectId=text HTTP/1.1
Host: app.harness.io
x-api-key: YOUR_API_KEY
Accept: */*
{
"prettyId": "text",
"projectId": "text",
"title": "text",
"description": "text",
"status": "text",
"priority": {
"id": "text",
"label": "text"
},
"impactedServices": [
"text"
],
"environments": [
"text"
],
"monitoringLink": "text",
"deduplicationId": "text",
"quietMode": true,
"keyEvents": [
{
"timestamp": 1,
"status": "text",
"details": "text"
}
],
"relatedActivities": [
{
"name": "text",
"templateTypeName": "INCIDENT",
"prettyId": "text",
"globalId": "text",
"title": "text"
}
],
"relatedExternalEntities": [
{
"relationshipGlobalId": "text",
"name": "text",
"type": "DEPLOYMENT",
"provider": "HARNESS",
"externalId": "text",
"url": "text",
"displayName": "text"
}
],
"commsLinks": [
{
"url": "text",
"linkType": "WEB"
}
],
"createdAtTimestamp": 1,
"startedAtTimestamp": 1,
"acknowledgedAtTimestamp": 1,
"resolvedAtTimestamp": 1,
"closedAtTimestamp": 1
}API key is a token provided while making the API calls. This is used to authenticate the client at the exposed endpoint.
Alert ID, e.g. ALERT-123
Harness account identifier.
Harness organization identifier.
Harness project identifier.
Alert detail
Alert pretty id, e.g. ALERT-123
Alert description
Resolved alert status option id (e.g. triggered, resolved)
Harness service identifiers for impacted services
Environment labels (e.g. prod, qa)
Monitoring link for the alert
Deduplication / correlation key
When true, suppresses notifications and on-call pages
Epoch timestamp when created (milliseconds)
Epoch timestamp when the alert started (milliseconds)
Epoch timestamp when acknowledged (milliseconds)
Epoch timestamp when resolved (milliseconds)
Epoch timestamp when closed (milliseconds)
Alert not found
GET /gateway/ir/tp/api/v1/mc/alerts/{alertId}?accountId=text&orgId=text&projectId=text HTTP/1.1
Host: app.harness.io
x-api-key: YOUR_API_KEY
Accept: */*
{
"prettyId": "text",
"projectId": "text",
"title": "text",
"description": "text",
"status": "text",
"priority": {
"id": "text",
"label": "text"
},
"impactedServices": [
"text"
],
"environments": [
"text"
],
"monitoringLink": "text",
"deduplicationId": "text",
"quietMode": true,
"keyEvents": [
{
"timestamp": 1,
"status": "text",
"details": "text"
}
],
"relatedActivities": [
{
"name": "text",
"templateTypeName": "INCIDENT",
"prettyId": "text",
"globalId": "text",
"title": "text"
}
],
"relatedExternalEntities": [
{
"relationshipGlobalId": "text",
"name": "text",
"type": "DEPLOYMENT",
"provider": "HARNESS",
"externalId": "text",
"url": "text",
"displayName": "text"
}
],
"commsLinks": [
{
"url": "text",
"linkType": "WEB"
}
],
"createdAtTimestamp": 1,
"startedAtTimestamp": 1,
"acknowledgedAtTimestamp": 1,
"resolvedAtTimestamp": 1,
"closedAtTimestamp": 1
}API key is a token provided while making the API calls. This is used to authenticate the client at the exposed endpoint.
Alert ID, e.g. ALERT-123
Harness account identifier.
Harness organization identifier.
Harness project identifier.
JSON merge-patch body for updating an alert. Omit a field to leave it unchanged; set it to null to clear it.
Alert title
Alert description
Alert priority option id (p1_critical, p2_error, p3_warning, p4_info). To acknowledge, resolve, or dismiss an alert, use the dedicated lifecycle endpoints instead.
Alert status option id. To acknowledge, resolve, or dismiss, use POST /api/v1/mc/alerts/{alertId}/acknowledge|resolve|dismiss. Reopening to triggered is allowed here.
Impacted services by Harness identifier, name, or ID (replaces the full list)
Harness environment identifiers (replaces the full list)
Monitoring link for the alert
When true, suppresses user notifications and on-call pages for this alert
Alert updated
Alert pretty id, e.g. ALERT-123
Alert description
Resolved alert status option id (e.g. triggered, resolved)
Harness service identifiers for impacted services
Environment labels (e.g. prod, qa)
Monitoring link for the alert
Deduplication / correlation key
When true, suppresses notifications and on-call pages
Epoch timestamp when created (milliseconds)
Epoch timestamp when the alert started (milliseconds)
Epoch timestamp when acknowledged (milliseconds)
Epoch timestamp when resolved (milliseconds)
Epoch timestamp when closed (milliseconds)
Invalid request
Alert not found
PATCH /gateway/ir/tp/api/v1/mc/alerts/{alertId}?accountId=text&orgId=text&projectId=text HTTP/1.1
Host: app.harness.io
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 164
{
"title": "text",
"description": "text",
"priority": "text",
"status": "text",
"impactedServices": [
"text"
],
"environments": [
"text"
],
"monitoringLink": "text",
"quietMode": true
}{
"prettyId": "text",
"projectId": "text",
"title": "text",
"description": "text",
"status": "text",
"priority": {
"id": "text",
"label": "text"
},
"impactedServices": [
"text"
],
"environments": [
"text"
],
"monitoringLink": "text",
"deduplicationId": "text",
"quietMode": true,
"keyEvents": [
{
"timestamp": 1,
"status": "text",
"details": "text"
}
],
"relatedActivities": [
{
"name": "text",
"templateTypeName": "INCIDENT",
"prettyId": "text",
"globalId": "text",
"title": "text"
}
],
"relatedExternalEntities": [
{
"relationshipGlobalId": "text",
"name": "text",
"type": "DEPLOYMENT",
"provider": "HARNESS",
"externalId": "text",
"url": "text",
"displayName": "text"
}
],
"commsLinks": [
{
"url": "text",
"linkType": "WEB"
}
],
"createdAtTimestamp": 1,
"startedAtTimestamp": 1,
"acknowledgedAtTimestamp": 1,
"resolvedAtTimestamp": 1,
"closedAtTimestamp": 1
}API key is a token provided while making the API calls. This is used to authenticate the client at the exposed endpoint.
Alert ID, e.g. ALERT-123
Harness account identifier.
Harness organization identifier.
Harness project identifier.
Alert resolved
Alert pretty id, e.g. ALERT-123
Alert description
Resolved alert status option id (e.g. triggered, resolved)
Harness service identifiers for impacted services
Environment labels (e.g. prod, qa)
Monitoring link for the alert
Deduplication / correlation key
When true, suppresses notifications and on-call pages
Epoch timestamp when created (milliseconds)
Epoch timestamp when the alert started (milliseconds)
Epoch timestamp when acknowledged (milliseconds)
Epoch timestamp when resolved (milliseconds)
Epoch timestamp when closed (milliseconds)
Alert not found
POST /gateway/ir/tp/api/v1/mc/alerts/{alertId}/resolve?accountId=text&orgId=text&projectId=text HTTP/1.1
Host: app.harness.io
x-api-key: YOUR_API_KEY
Accept: */*
{
"prettyId": "text",
"projectId": "text",
"title": "text",
"description": "text",
"status": "text",
"priority": {
"id": "text",
"label": "text"
},
"impactedServices": [
"text"
],
"environments": [
"text"
],
"monitoringLink": "text",
"deduplicationId": "text",
"quietMode": true,
"keyEvents": [
{
"timestamp": 1,
"status": "text",
"details": "text"
}
],
"relatedActivities": [
{
"name": "text",
"templateTypeName": "INCIDENT",
"prettyId": "text",
"globalId": "text",
"title": "text"
}
],
"relatedExternalEntities": [
{
"relationshipGlobalId": "text",
"name": "text",
"type": "DEPLOYMENT",
"provider": "HARNESS",
"externalId": "text",
"url": "text",
"displayName": "text"
}
],
"commsLinks": [
{
"url": "text",
"linkType": "WEB"
}
],
"createdAtTimestamp": 1,
"startedAtTimestamp": 1,
"acknowledgedAtTimestamp": 1,
"resolvedAtTimestamp": 1,
"closedAtTimestamp": 1
}Last updated
Was this helpful?