Skip to content
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Alerts

Acknowledge alert

post
Authorizations
x-api-keystringRequired

API key is a token provided while making the API calls. This is used to authenticate the client at the exposed endpoint.

Path parameters
alertIdstringRequired

Alert ID, e.g. ALERT-123

Query parameters
accountIdstring · min: 1Required

Harness account identifier.

orgIdstring · min: 1Required

Harness organization identifier.

projectIdstring · min: 1Required

Harness project identifier.

Responses
200

Alert acknowledged

application/json
prettyIdstringRequired

Alert pretty id, e.g. ALERT-123

projectIdstringRequired
titlestringRequired
descriptionstringOptional

Alert description

statusstringOptional

Resolved alert status option id (e.g. triggered, resolved)

impactedServicesstring[]Optional

Harness service identifiers for impacted services

environmentsstring[]Optional

Environment labels (e.g. prod, qa)

monitoringLinkstringOptional

Monitoring link for the alert

deduplicationIdstringOptional

Deduplication / correlation key

quietModebooleanOptional

When true, suppresses notifications and on-call pages

createdAtTimestampinteger · int64Optional

Epoch timestamp when created (milliseconds)

startedAtTimestampinteger · int64Optional

Epoch timestamp when the alert started (milliseconds)

acknowledgedAtTimestampinteger · int64Optional

Epoch timestamp when acknowledged (milliseconds)

resolvedAtTimestampinteger · int64Optional

Epoch timestamp when resolved (milliseconds)

closedAtTimestampinteger · int64Optional

Epoch timestamp when closed (milliseconds)

post/api/v1/mc/alerts/{alertId}/acknowledge
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
}

List alerts

get
Authorizations
x-api-keystringRequired

API key is a token provided while making the API calls. This is used to authenticate the client at the exposed endpoint.

Query parameters
accountIdstring · min: 1Required

Harness account identifier.

orgIdstring · min: 1Required

Harness organization identifier.

projectIdstring · min: 1Required

Harness project identifier.

statusstring[]Optional

Filter by status (multi-value, OR-combined). Allowed: triggered, acknowledged, resolved, dismissed.

prioritystring[]Optional

Filter by priority option id (multi-value, OR-combined)

impactedServicestring[]Optional

Filter by service: Harness identifier, name, or ID (multi-value, OR-combined)

environmentstring[]Optional

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.

templateShortIdstring[]Optional

Filter by alert template short id (multi-value, OR-combined), e.g. PALERTAED1EE

textstringOptional

Free-text search across title and description

createdAfterstringOptional

ISO-8601 inclusive lower bound on createdAt, e.g. 2026-05-01T00:00:00Z

createdBeforestringOptional

ISO-8601 inclusive upper bound on createdAt

sortFieldstring · enumOptional

Field to sort alerts by

Possible values:
sortDirectionstring · enumOptional

Sort direction

Possible values:
pageSizeinteger · int32Optional

Page size requested

pageinteger · int32Optional

0-based page number; defaults to 0 (the first page).

Responses
200

Page of alerts

application/json
totalCountinteger · int32Optional
get/api/v1/mc/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: */*
200

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
}

Dismiss alert

post
Authorizations
x-api-keystringRequired

API key is a token provided while making the API calls. This is used to authenticate the client at the exposed endpoint.

Path parameters
alertIdstringRequired

Alert ID, e.g. ALERT-123

Query parameters
accountIdstring · min: 1Required

Harness account identifier.

orgIdstring · min: 1Required

Harness organization identifier.

projectIdstring · min: 1Required

Harness project identifier.

Responses
200

Alert dismissed

application/json
prettyIdstringRequired

Alert pretty id, e.g. ALERT-123

projectIdstringRequired
titlestringRequired
descriptionstringOptional

Alert description

statusstringOptional

Resolved alert status option id (e.g. triggered, resolved)

impactedServicesstring[]Optional

Harness service identifiers for impacted services

environmentsstring[]Optional

Environment labels (e.g. prod, qa)

monitoringLinkstringOptional

Monitoring link for the alert

deduplicationIdstringOptional

Deduplication / correlation key

quietModebooleanOptional

When true, suppresses notifications and on-call pages

createdAtTimestampinteger · int64Optional

Epoch timestamp when created (milliseconds)

startedAtTimestampinteger · int64Optional

Epoch timestamp when the alert started (milliseconds)

acknowledgedAtTimestampinteger · int64Optional

Epoch timestamp when acknowledged (milliseconds)

resolvedAtTimestampinteger · int64Optional

Epoch timestamp when resolved (milliseconds)

closedAtTimestampinteger · int64Optional

Epoch timestamp when closed (milliseconds)

post/api/v1/mc/alerts/{alertId}/dismiss
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
}

Get alert detail

get
Authorizations
x-api-keystringRequired

API key is a token provided while making the API calls. This is used to authenticate the client at the exposed endpoint.

Path parameters
alertIdstringRequired

Alert ID, e.g. ALERT-123

Query parameters
accountIdstring · min: 1Required

Harness account identifier.

orgIdstring · min: 1Required

Harness organization identifier.

projectIdstring · min: 1Required

Harness project identifier.

Responses
200

Alert detail

application/json
prettyIdstringRequired

Alert pretty id, e.g. ALERT-123

projectIdstringRequired
titlestringRequired
descriptionstringOptional

Alert description

statusstringOptional

Resolved alert status option id (e.g. triggered, resolved)

impactedServicesstring[]Optional

Harness service identifiers for impacted services

environmentsstring[]Optional

Environment labels (e.g. prod, qa)

monitoringLinkstringOptional

Monitoring link for the alert

deduplicationIdstringOptional

Deduplication / correlation key

quietModebooleanOptional

When true, suppresses notifications and on-call pages

createdAtTimestampinteger · int64Optional

Epoch timestamp when created (milliseconds)

startedAtTimestampinteger · int64Optional

Epoch timestamp when the alert started (milliseconds)

acknowledgedAtTimestampinteger · int64Optional

Epoch timestamp when acknowledged (milliseconds)

resolvedAtTimestampinteger · int64Optional

Epoch timestamp when resolved (milliseconds)

closedAtTimestampinteger · int64Optional

Epoch timestamp when closed (milliseconds)

get/api/v1/mc/alerts/{alertId}
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
}

Update alert

patch
Authorizations
x-api-keystringRequired

API key is a token provided while making the API calls. This is used to authenticate the client at the exposed endpoint.

Path parameters
alertIdstringRequired

Alert ID, e.g. ALERT-123

Query parameters
accountIdstring · min: 1Required

Harness account identifier.

orgIdstring · min: 1Required

Harness organization identifier.

projectIdstring · min: 1Required

Harness project identifier.

Body

JSON merge-patch body for updating an alert. Omit a field to leave it unchanged; set it to null to clear it.

titlestring · nullableOptional

Alert title

descriptionstring · nullableOptional

Alert description

prioritystring · nullableOptional

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.

statusstring · nullableOptional

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.

impactedServicesstring[] · nullableOptional

Impacted services by Harness identifier, name, or ID (replaces the full list)

environmentsstring[] · nullableOptional

Harness environment identifiers (replaces the full list)

monitoringLinkstring · nullableOptional

Monitoring link for the alert

quietModeboolean · nullableOptional

When true, suppresses user notifications and on-call pages for this alert

Responses
200

Alert updated

application/json
prettyIdstringRequired

Alert pretty id, e.g. ALERT-123

projectIdstringRequired
titlestringRequired
descriptionstringOptional

Alert description

statusstringOptional

Resolved alert status option id (e.g. triggered, resolved)

impactedServicesstring[]Optional

Harness service identifiers for impacted services

environmentsstring[]Optional

Environment labels (e.g. prod, qa)

monitoringLinkstringOptional

Monitoring link for the alert

deduplicationIdstringOptional

Deduplication / correlation key

quietModebooleanOptional

When true, suppresses notifications and on-call pages

createdAtTimestampinteger · int64Optional

Epoch timestamp when created (milliseconds)

startedAtTimestampinteger · int64Optional

Epoch timestamp when the alert started (milliseconds)

acknowledgedAtTimestampinteger · int64Optional

Epoch timestamp when acknowledged (milliseconds)

resolvedAtTimestampinteger · int64Optional

Epoch timestamp when resolved (milliseconds)

closedAtTimestampinteger · int64Optional

Epoch timestamp when closed (milliseconds)

patch/api/v1/mc/alerts/{alertId}
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
}

Resolve alert

post
Authorizations
x-api-keystringRequired

API key is a token provided while making the API calls. This is used to authenticate the client at the exposed endpoint.

Path parameters
alertIdstringRequired

Alert ID, e.g. ALERT-123

Query parameters
accountIdstring · min: 1Required

Harness account identifier.

orgIdstring · min: 1Required

Harness organization identifier.

projectIdstring · min: 1Required

Harness project identifier.

Responses
200

Alert resolved

application/json
prettyIdstringRequired

Alert pretty id, e.g. ALERT-123

projectIdstringRequired
titlestringRequired
descriptionstringOptional

Alert description

statusstringOptional

Resolved alert status option id (e.g. triggered, resolved)

impactedServicesstring[]Optional

Harness service identifiers for impacted services

environmentsstring[]Optional

Environment labels (e.g. prod, qa)

monitoringLinkstringOptional

Monitoring link for the alert

deduplicationIdstringOptional

Deduplication / correlation key

quietModebooleanOptional

When true, suppresses notifications and on-call pages

createdAtTimestampinteger · int64Optional

Epoch timestamp when created (milliseconds)

startedAtTimestampinteger · int64Optional

Epoch timestamp when the alert started (milliseconds)

acknowledgedAtTimestampinteger · int64Optional

Epoch timestamp when acknowledged (milliseconds)

resolvedAtTimestampinteger · int64Optional

Epoch timestamp when resolved (milliseconds)

closedAtTimestampinteger · int64Optional

Epoch timestamp when closed (milliseconds)

post/api/v1/mc/alerts/{alertId}/resolve
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?