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

Incidents

Add a root-cause theory

post

Appends a root-cause theory, authored by the caller; calls authenticated as the project's Agent Account are recorded as AI-generated. Items the theory cites in relatedActivities are checked against the incident's project; any that can't be found are returned in notLinked and the theory is still added. Items may be cited by web URL, including PRs outside Harness Code; those with no activity in the incident's project are linked as cited and returned in unverified. If a theory with the same message already exists, no duplicate is created and the cited items are added to the existing theory.

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
incidentIdstringRequired

Incident ID, e.g. INC-123

Query parameters
accountIdstring · min: 1Required

Harness account identifier.

orgIdstring · min: 1Required

Harness organization identifier.

projectIdstring · min: 1Required

Harness project identifier.

Body

Request body for adding a root-cause theory

messagestringRequired

The root-cause theory text

statusstringOptional

Theory status: INVESTIGATING (default), CONFIRMED, or RULED_OUT

confidenceinteger · int32Optional

Confidence level (0-100); defaults based on status when omitted

Responses
200

A theory with this message already exists

application/json

Result of adding a root-cause theory to an incident

createdbooleanOptional

False when a theory with the same message already existed

post/api/v1/mc/incidents/{incidentId}/root-cause-theories
POST /gateway/ir/tp/api/v1/mc/incidents/{incidentId}/root-cause-theories?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: 99

{
  "message": "text",
  "status": "text",
  "confidence": 1,
  "relatedActivities": [
    {
      "type": "text",
      "id": "text"
    }
  ]
}
{
  "theory": {
    "id": "text",
    "message": "text",
    "status": "text",
    "confidence": 1,
    "aiGenerated": true,
    "relatedActivities": [
      {
        "type": "text",
        "displayId": "text",
        "url": "text"
      }
    ]
  },
  "created": true,
  "notLinked": [
    {
      "reference": {
        "type": "text",
        "id": "text"
      },
      "reason": "text"
    }
  ],
  "unverified": [
    {
      "reference": {
        "type": "text",
        "id": "text"
      },
      "reason": "text"
    }
  ]
}

Close incident

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
incidentIdstringRequired

Incident ID, e.g. INC-123

Query parameters
accountIdstring · min: 1Required

Harness account identifier.

orgIdstring · min: 1Required

Harness organization identifier.

projectIdstring · min: 1Required

Harness project identifier.

Responses
200

Incident closed

application/json
prettyIdstringRequired
projectIdstringRequired
titlestringRequired
summarystringOptional

Incident summary

statusstring · enumRequired

Incident status

Possible values:
impactedServicesstring[]Optional

Harness service identifiers for impacted services

environmentsstring[]Optional

Environment labels (e.g. prod, qa)

rootCauseTheoriesShastringOptional

Fingerprint of rootCauseTheories. Clients send this back when confirming, ruling out, or undoing a theory so a stale write is rejected.

videoConferenceLinkstringOptional

Video conference link for the incident

acknowledgedAtTimestampinteger · int64Optional

Epoch timestamp when acknowledged (milliseconds)

startedAtTimestampinteger · int64Optional

Epoch timestamp when work started (milliseconds)

resolvedAtTimestampinteger · int64Optional

Epoch timestamp when resolved (milliseconds)

closedAtTimestampinteger · int64Optional

Epoch timestamp when closed (milliseconds)

reportedAtTimestampinteger · int64Optional

Epoch timestamp when reported (milliseconds)

mitigatedAtTimestampinteger · int64Optional

Epoch timestamp when mitigated (milliseconds)

responderAssignedAtTimestampinteger · int64Optional

Epoch timestamp when responder assigned (milliseconds)

post/api/v1/mc/incidents/{incidentId}/close
POST /gateway/ir/tp/api/v1/mc/incidents/{incidentId}/close?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",
  "summary": "text",
  "status": "NEW",
  "reporter": {
    "userId": "text",
    "displayName": "text",
    "email": "text"
  },
  "commander": {
    "userId": "text",
    "displayName": "text",
    "email": "text"
  },
  "impactedServices": [
    "text"
  ],
  "environments": [
    "text"
  ],
  "severity": {
    "id": "text",
    "label": "text"
  },
  "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"
    }
  ],
  "rootCauseTheories": [
    {
      "id": "text",
      "message": "text",
      "status": "text",
      "confidence": 1,
      "aiGenerated": true,
      "relatedActivities": [
        {
          "type": "text",
          "displayId": "text",
          "url": "text"
        }
      ]
    }
  ],
  "rootCauseTheoriesSha": "text",
  "commsLinks": [
    {
      "url": "text",
      "linkType": "WEB"
    }
  ],
  "videoConferenceLink": "text",
  "acknowledgedAtTimestamp": 1,
  "startedAtTimestamp": 1,
  "resolvedAtTimestamp": 1,
  "closedAtTimestamp": 1,
  "reportedAtTimestamp": 1,
  "mitigatedAtTimestamp": 1,
  "responderAssignedAtTimestamp": 1,
  "pagedResponders": [
    {
      "userId": "text",
      "displayName": "text",
      "email": "text"
    }
  ]
}

Confirm a root-cause theory

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
incidentIdstringRequired

Incident ID, e.g. INC-123

theoryIdstringRequired

Root-cause theory id

Query parameters
accountIdstring · min: 1Required

Harness account identifier.

orgIdstring · min: 1Required

Harness organization identifier.

projectIdstring · min: 1Required

Harness project identifier.

Body

Request body for confirming, ruling out, or undoing a root-cause theory

expectedOldRcaShastringRequired

Fingerprint from GET incident (rootCauseTheoriesSha). A blank value is rejected.

Responses
200

Theory confirmed

application/json
prettyIdstringRequired
projectIdstringRequired
titlestringRequired
summarystringOptional

Incident summary

statusstring · enumRequired

Incident status

Possible values:
impactedServicesstring[]Optional

Harness service identifiers for impacted services

environmentsstring[]Optional

Environment labels (e.g. prod, qa)

rootCauseTheoriesShastringOptional

Fingerprint of rootCauseTheories. Clients send this back when confirming, ruling out, or undoing a theory so a stale write is rejected.

videoConferenceLinkstringOptional

Video conference link for the incident

acknowledgedAtTimestampinteger · int64Optional

Epoch timestamp when acknowledged (milliseconds)

startedAtTimestampinteger · int64Optional

Epoch timestamp when work started (milliseconds)

resolvedAtTimestampinteger · int64Optional

Epoch timestamp when resolved (milliseconds)

closedAtTimestampinteger · int64Optional

Epoch timestamp when closed (milliseconds)

reportedAtTimestampinteger · int64Optional

Epoch timestamp when reported (milliseconds)

mitigatedAtTimestampinteger · int64Optional

Epoch timestamp when mitigated (milliseconds)

responderAssignedAtTimestampinteger · int64Optional

Epoch timestamp when responder assigned (milliseconds)

post/api/v1/mc/incidents/{incidentId}/root-cause-theories/{theoryId}/confirm
POST /gateway/ir/tp/api/v1/mc/incidents/{incidentId}/root-cause-theories/{theoryId}/confirm?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: 28

{
  "expectedOldRcaSha": "text"
}
{
  "prettyId": "text",
  "projectId": "text",
  "title": "text",
  "summary": "text",
  "status": "NEW",
  "reporter": {
    "userId": "text",
    "displayName": "text",
    "email": "text"
  },
  "commander": {
    "userId": "text",
    "displayName": "text",
    "email": "text"
  },
  "impactedServices": [
    "text"
  ],
  "environments": [
    "text"
  ],
  "severity": {
    "id": "text",
    "label": "text"
  },
  "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"
    }
  ],
  "rootCauseTheories": [
    {
      "id": "text",
      "message": "text",
      "status": "text",
      "confidence": 1,
      "aiGenerated": true,
      "relatedActivities": [
        {
          "type": "text",
          "displayId": "text",
          "url": "text"
        }
      ]
    }
  ],
  "rootCauseTheoriesSha": "text",
  "commsLinks": [
    {
      "url": "text",
      "linkType": "WEB"
    }
  ],
  "videoConferenceLink": "text",
  "acknowledgedAtTimestamp": 1,
  "startedAtTimestamp": 1,
  "resolvedAtTimestamp": 1,
  "closedAtTimestamp": 1,
  "reportedAtTimestamp": 1,
  "mitigatedAtTimestamp": 1,
  "responderAssignedAtTimestamp": 1,
  "pagedResponders": [
    {
      "userId": "text",
      "displayName": "text",
      "email": "text"
    }
  ]
}

List incidents

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: new, investigating, fixing, monitoring, closed.

severitystring[]Optional

Filter by severity 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.

commanderstringOptional

Filter by commander Harness user id

textstringOptional

Free-text search across title and summary

reportedAfterstringOptional

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

reportedBeforestringOptional

ISO-8601 inclusive upper bound on reportedAt

sortFieldstring · enumOptional

Field to sort incidents 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 incidents

application/json
totalCountinteger · int32Optional
get/api/v1/mc/incidents
GET /gateway/ir/tp/api/v1/mc/incidents?accountId=text&orgId=text&projectId=text HTTP/1.1
Host: app.harness.io
x-api-key: YOUR_API_KEY
Accept: */*
200

Page of incidents

{
  "entities": [
    {
      "prettyId": "text",
      "projectId": "text",
      "title": "text",
      "summary": "text",
      "status": "NEW",
      "reporter": {
        "userId": "text",
        "displayName": "text",
        "email": "text"
      },
      "commander": {
        "userId": "text",
        "displayName": "text",
        "email": "text"
      },
      "impactedServices": [
        "text"
      ],
      "environments": [
        "text"
      ],
      "severity": {
        "id": "text",
        "label": "text"
      },
      "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"
        }
      ],
      "rootCauseTheories": [
        {
          "id": "text",
          "message": "text",
          "status": "text",
          "confidence": 1,
          "aiGenerated": true,
          "relatedActivities": [
            {
              "type": "text",
              "displayId": "text",
              "url": "text"
            }
          ]
        }
      ],
      "rootCauseTheoriesSha": "text",
      "commsLinks": [
        {
          "url": "text",
          "linkType": "WEB"
        }
      ],
      "videoConferenceLink": "text",
      "acknowledgedAtTimestamp": 1,
      "startedAtTimestamp": 1,
      "resolvedAtTimestamp": 1,
      "closedAtTimestamp": 1,
      "reportedAtTimestamp": 1,
      "mitigatedAtTimestamp": 1,
      "responderAssignedAtTimestamp": 1,
      "pagedResponders": [
        {
          "userId": "text",
          "displayName": "text",
          "email": "text"
        }
      ]
    }
  ],
  "totalCount": 1
}

Create incident

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.

Query parameters
accountIdstring · min: 1Required

Harness account identifier.

orgIdstring · min: 1Required

Harness organization identifier.

projectIdstring · min: 1Required

Harness project identifier.

Body

Request body for creating an incident

templateShortIdstringRequired

Short id of the incident type to create from (e.g. "INC").

titlestringRequired

Incident title

summarystringOptional

Incident summary

severitystringOptional

Severity option id or label (e.g. "1" or "SEV1: Major"). Matched case-insensitively against the template's severity field options.

statusstringOptional

Incident status option id or label (e.g. "new" or "Investigating"). Matched case-insensitively against the template's status field options.

impactedServicesstring[]Optional

Impacted services by Harness identifier, name, or ID

environmentsstring[]Optional

Environments, 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.

commanderHarnessUserIdstringOptional

Harness user id of the incident commander

videoConferenceLinkstringOptional

Video conference link for the incident

slackChannelUrlstringOptional

URL of an existing Slack channel to associate with the incident

reportedAtTimestampinteger · int64Optional

Reported-at timestamp in epoch milliseconds. Defaults to now.

labelsstring[]Optional

Incident labels

pageOnCallbooleanOptional

When true, page the on-call owner of the primary impacted service after the incident is created. Defaults to false when omitted.

pipelineContextTimelineMessagestringOptional

When set, adds a timeline key event with this text after the incident is created.

Responses
201

Incident created

application/json
prettyIdstringRequired
projectIdstringRequired
titlestringRequired
summarystringOptional

Incident summary

statusstring · enumRequired

Incident status

Possible values:
impactedServicesstring[]Optional

Harness service identifiers for impacted services

environmentsstring[]Optional

Environment labels (e.g. prod, qa)

rootCauseTheoriesShastringOptional

Fingerprint of rootCauseTheories. Clients send this back when confirming, ruling out, or undoing a theory so a stale write is rejected.

videoConferenceLinkstringOptional

Video conference link for the incident

acknowledgedAtTimestampinteger · int64Optional

Epoch timestamp when acknowledged (milliseconds)

startedAtTimestampinteger · int64Optional

Epoch timestamp when work started (milliseconds)

resolvedAtTimestampinteger · int64Optional

Epoch timestamp when resolved (milliseconds)

closedAtTimestampinteger · int64Optional

Epoch timestamp when closed (milliseconds)

reportedAtTimestampinteger · int64Optional

Epoch timestamp when reported (milliseconds)

mitigatedAtTimestampinteger · int64Optional

Epoch timestamp when mitigated (milliseconds)

responderAssignedAtTimestampinteger · int64Optional

Epoch timestamp when responder assigned (milliseconds)

post/api/v1/mc/incidents
POST /gateway/ir/tp/api/v1/mc/incidents?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: 376

{
  "templateShortId": "text",
  "title": "text",
  "summary": "text",
  "severity": "text",
  "status": "text",
  "impactedServices": [
    "text"
  ],
  "environments": [
    "text"
  ],
  "commanderHarnessUserId": "text",
  "videoConferenceLink": "text",
  "slackChannelUrl": "text",
  "reportedAtTimestamp": 1,
  "labels": [
    "text"
  ],
  "customFields": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "pageOnCall": true,
  "pipelineContextTimelineMessage": "text"
}
{
  "prettyId": "text",
  "projectId": "text",
  "title": "text",
  "summary": "text",
  "status": "NEW",
  "reporter": {
    "userId": "text",
    "displayName": "text",
    "email": "text"
  },
  "commander": {
    "userId": "text",
    "displayName": "text",
    "email": "text"
  },
  "impactedServices": [
    "text"
  ],
  "environments": [
    "text"
  ],
  "severity": {
    "id": "text",
    "label": "text"
  },
  "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"
    }
  ],
  "rootCauseTheories": [
    {
      "id": "text",
      "message": "text",
      "status": "text",
      "confidence": 1,
      "aiGenerated": true,
      "relatedActivities": [
        {
          "type": "text",
          "displayId": "text",
          "url": "text"
        }
      ]
    }
  ],
  "rootCauseTheoriesSha": "text",
  "commsLinks": [
    {
      "url": "text",
      "linkType": "WEB"
    }
  ],
  "videoConferenceLink": "text",
  "acknowledgedAtTimestamp": 1,
  "startedAtTimestamp": 1,
  "resolvedAtTimestamp": 1,
  "closedAtTimestamp": 1,
  "reportedAtTimestamp": 1,
  "mitigatedAtTimestamp": 1,
  "responderAssignedAtTimestamp": 1,
  "pagedResponders": [
    {
      "userId": "text",
      "displayName": "text",
      "email": "text"
    }
  ]
}

Get incident 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
incidentIdstringRequired

Incident ID, e.g. INC-123

Query parameters
accountIdstring · min: 1Required

Harness account identifier.

orgIdstring · min: 1Required

Harness organization identifier.

projectIdstring · min: 1Required

Harness project identifier.

Responses
200

Incident detail

application/json
prettyIdstringRequired
projectIdstringRequired
titlestringRequired
summarystringOptional

Incident summary

statusstring · enumRequired

Incident status

Possible values:
impactedServicesstring[]Optional

Harness service identifiers for impacted services

environmentsstring[]Optional

Environment labels (e.g. prod, qa)

rootCauseTheoriesShastringOptional

Fingerprint of rootCauseTheories. Clients send this back when confirming, ruling out, or undoing a theory so a stale write is rejected.

videoConferenceLinkstringOptional

Video conference link for the incident

acknowledgedAtTimestampinteger · int64Optional

Epoch timestamp when acknowledged (milliseconds)

startedAtTimestampinteger · int64Optional

Epoch timestamp when work started (milliseconds)

resolvedAtTimestampinteger · int64Optional

Epoch timestamp when resolved (milliseconds)

closedAtTimestampinteger · int64Optional

Epoch timestamp when closed (milliseconds)

reportedAtTimestampinteger · int64Optional

Epoch timestamp when reported (milliseconds)

mitigatedAtTimestampinteger · int64Optional

Epoch timestamp when mitigated (milliseconds)

responderAssignedAtTimestampinteger · int64Optional

Epoch timestamp when responder assigned (milliseconds)

get/api/v1/mc/incidents/{incidentId}
GET /gateway/ir/tp/api/v1/mc/incidents/{incidentId}?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",
  "summary": "text",
  "status": "NEW",
  "reporter": {
    "userId": "text",
    "displayName": "text",
    "email": "text"
  },
  "commander": {
    "userId": "text",
    "displayName": "text",
    "email": "text"
  },
  "impactedServices": [
    "text"
  ],
  "environments": [
    "text"
  ],
  "severity": {
    "id": "text",
    "label": "text"
  },
  "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"
    }
  ],
  "rootCauseTheories": [
    {
      "id": "text",
      "message": "text",
      "status": "text",
      "confidence": 1,
      "aiGenerated": true,
      "relatedActivities": [
        {
          "type": "text",
          "displayId": "text",
          "url": "text"
        }
      ]
    }
  ],
  "rootCauseTheoriesSha": "text",
  "commsLinks": [
    {
      "url": "text",
      "linkType": "WEB"
    }
  ],
  "videoConferenceLink": "text",
  "acknowledgedAtTimestamp": 1,
  "startedAtTimestamp": 1,
  "resolvedAtTimestamp": 1,
  "closedAtTimestamp": 1,
  "reportedAtTimestamp": 1,
  "mitigatedAtTimestamp": 1,
  "responderAssignedAtTimestamp": 1,
  "pagedResponders": [
    {
      "userId": "text",
      "displayName": "text",
      "email": "text"
    }
  ]
}

Update incident

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
incidentIdstringRequired

Incident ID, e.g. INC-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 incident. Omit a field to leave it unchanged; set it to null to clear it.

titlestring · nullableOptional

Incident title

summarystring · nullableOptional

Incident summary

severitystring · nullableOptional

Severity option id or label (e.g. "1" or "SEV1: Major"). Matched case-insensitively against the template's severity field options.

statusstring · nullableOptional

Incident status option id or label (e.g. "investigating"). To close an incident, use POST /api/v1/mc/incidents/{incidentId}/close instead.

impactedServicesstring[] · nullableOptional

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

environmentsstring[] · nullableOptional

Environments (replaces the full list), 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.

commanderHarnessUserIdstring · nullableOptional

Harness user id of the incident commander

videoConferenceLinkstring · nullableOptional

Video conference link for the incident

Responses
200

Incident updated

application/json
prettyIdstringRequired
projectIdstringRequired
titlestringRequired
summarystringOptional

Incident summary

statusstring · enumRequired

Incident status

Possible values:
impactedServicesstring[]Optional

Harness service identifiers for impacted services

environmentsstring[]Optional

Environment labels (e.g. prod, qa)

rootCauseTheoriesShastringOptional

Fingerprint of rootCauseTheories. Clients send this back when confirming, ruling out, or undoing a theory so a stale write is rejected.

videoConferenceLinkstringOptional

Video conference link for the incident

acknowledgedAtTimestampinteger · int64Optional

Epoch timestamp when acknowledged (milliseconds)

startedAtTimestampinteger · int64Optional

Epoch timestamp when work started (milliseconds)

resolvedAtTimestampinteger · int64Optional

Epoch timestamp when resolved (milliseconds)

closedAtTimestampinteger · int64Optional

Epoch timestamp when closed (milliseconds)

reportedAtTimestampinteger · int64Optional

Epoch timestamp when reported (milliseconds)

mitigatedAtTimestampinteger · int64Optional

Epoch timestamp when mitigated (milliseconds)

responderAssignedAtTimestampinteger · int64Optional

Epoch timestamp when responder assigned (milliseconds)

patch/api/v1/mc/incidents/{incidentId}
PATCH /gateway/ir/tp/api/v1/mc/incidents/{incidentId}?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: 226

{
  "title": "text",
  "summary": "text",
  "severity": "text",
  "status": "text",
  "impactedServices": [
    "text"
  ],
  "environments": [
    "text"
  ],
  "commanderHarnessUserId": "text",
  "videoConferenceLink": "text",
  "customFields": {
    "ANY_ADDITIONAL_PROPERTY": {}
  }
}
{
  "prettyId": "text",
  "projectId": "text",
  "title": "text",
  "summary": "text",
  "status": "NEW",
  "reporter": {
    "userId": "text",
    "displayName": "text",
    "email": "text"
  },
  "commander": {
    "userId": "text",
    "displayName": "text",
    "email": "text"
  },
  "impactedServices": [
    "text"
  ],
  "environments": [
    "text"
  ],
  "severity": {
    "id": "text",
    "label": "text"
  },
  "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"
    }
  ],
  "rootCauseTheories": [
    {
      "id": "text",
      "message": "text",
      "status": "text",
      "confidence": 1,
      "aiGenerated": true,
      "relatedActivities": [
        {
          "type": "text",
          "displayId": "text",
          "url": "text"
        }
      ]
    }
  ],
  "rootCauseTheoriesSha": "text",
  "commsLinks": [
    {
      "url": "text",
      "linkType": "WEB"
    }
  ],
  "videoConferenceLink": "text",
  "acknowledgedAtTimestamp": 1,
  "startedAtTimestamp": 1,
  "resolvedAtTimestamp": 1,
  "closedAtTimestamp": 1,
  "reportedAtTimestamp": 1,
  "mitigatedAtTimestamp": 1,
  "responderAssignedAtTimestamp": 1,
  "pagedResponders": [
    {
      "userId": "text",
      "displayName": "text",
      "email": "text"
    }
  ]
}

Rule out a root-cause theory

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
incidentIdstringRequired

Incident ID, e.g. INC-123

theoryIdstringRequired

Root-cause theory id

Query parameters
accountIdstring · min: 1Required

Harness account identifier.

orgIdstring · min: 1Required

Harness organization identifier.

projectIdstring · min: 1Required

Harness project identifier.

Body

Request body for confirming, ruling out, or undoing a root-cause theory

expectedOldRcaShastringRequired

Fingerprint from GET incident (rootCauseTheoriesSha). A blank value is rejected.

Responses
200

Theory ruled out

application/json
prettyIdstringRequired
projectIdstringRequired
titlestringRequired
summarystringOptional

Incident summary

statusstring · enumRequired

Incident status

Possible values:
impactedServicesstring[]Optional

Harness service identifiers for impacted services

environmentsstring[]Optional

Environment labels (e.g. prod, qa)

rootCauseTheoriesShastringOptional

Fingerprint of rootCauseTheories. Clients send this back when confirming, ruling out, or undoing a theory so a stale write is rejected.

videoConferenceLinkstringOptional

Video conference link for the incident

acknowledgedAtTimestampinteger · int64Optional

Epoch timestamp when acknowledged (milliseconds)

startedAtTimestampinteger · int64Optional

Epoch timestamp when work started (milliseconds)

resolvedAtTimestampinteger · int64Optional

Epoch timestamp when resolved (milliseconds)

closedAtTimestampinteger · int64Optional

Epoch timestamp when closed (milliseconds)

reportedAtTimestampinteger · int64Optional

Epoch timestamp when reported (milliseconds)

mitigatedAtTimestampinteger · int64Optional

Epoch timestamp when mitigated (milliseconds)

responderAssignedAtTimestampinteger · int64Optional

Epoch timestamp when responder assigned (milliseconds)

post/api/v1/mc/incidents/{incidentId}/root-cause-theories/{theoryId}/rule-out
POST /gateway/ir/tp/api/v1/mc/incidents/{incidentId}/root-cause-theories/{theoryId}/rule-out?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: 28

{
  "expectedOldRcaSha": "text"
}
{
  "prettyId": "text",
  "projectId": "text",
  "title": "text",
  "summary": "text",
  "status": "NEW",
  "reporter": {
    "userId": "text",
    "displayName": "text",
    "email": "text"
  },
  "commander": {
    "userId": "text",
    "displayName": "text",
    "email": "text"
  },
  "impactedServices": [
    "text"
  ],
  "environments": [
    "text"
  ],
  "severity": {
    "id": "text",
    "label": "text"
  },
  "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"
    }
  ],
  "rootCauseTheories": [
    {
      "id": "text",
      "message": "text",
      "status": "text",
      "confidence": 1,
      "aiGenerated": true,
      "relatedActivities": [
        {
          "type": "text",
          "displayId": "text",
          "url": "text"
        }
      ]
    }
  ],
  "rootCauseTheoriesSha": "text",
  "commsLinks": [
    {
      "url": "text",
      "linkType": "WEB"
    }
  ],
  "videoConferenceLink": "text",
  "acknowledgedAtTimestamp": 1,
  "startedAtTimestamp": 1,
  "resolvedAtTimestamp": 1,
  "closedAtTimestamp": 1,
  "reportedAtTimestamp": 1,
  "mitigatedAtTimestamp": 1,
  "responderAssignedAtTimestamp": 1,
  "pagedResponders": [
    {
      "userId": "text",
      "displayName": "text",
      "email": "text"
    }
  ]
}

Undo a root-cause theory status

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
incidentIdstringRequired

Incident ID, e.g. INC-123

theoryIdstringRequired

Root-cause theory id

Query parameters
accountIdstring · min: 1Required

Harness account identifier.

orgIdstring · min: 1Required

Harness organization identifier.

projectIdstring · min: 1Required

Harness project identifier.

Body

Request body for confirming, ruling out, or undoing a root-cause theory

expectedOldRcaShastringRequired

Fingerprint from GET incident (rootCauseTheoriesSha). A blank value is rejected.

Responses
200

Theory returned to investigating

application/json
prettyIdstringRequired
projectIdstringRequired
titlestringRequired
summarystringOptional

Incident summary

statusstring · enumRequired

Incident status

Possible values:
impactedServicesstring[]Optional

Harness service identifiers for impacted services

environmentsstring[]Optional

Environment labels (e.g. prod, qa)

rootCauseTheoriesShastringOptional

Fingerprint of rootCauseTheories. Clients send this back when confirming, ruling out, or undoing a theory so a stale write is rejected.

videoConferenceLinkstringOptional

Video conference link for the incident

acknowledgedAtTimestampinteger · int64Optional

Epoch timestamp when acknowledged (milliseconds)

startedAtTimestampinteger · int64Optional

Epoch timestamp when work started (milliseconds)

resolvedAtTimestampinteger · int64Optional

Epoch timestamp when resolved (milliseconds)

closedAtTimestampinteger · int64Optional

Epoch timestamp when closed (milliseconds)

reportedAtTimestampinteger · int64Optional

Epoch timestamp when reported (milliseconds)

mitigatedAtTimestampinteger · int64Optional

Epoch timestamp when mitigated (milliseconds)

responderAssignedAtTimestampinteger · int64Optional

Epoch timestamp when responder assigned (milliseconds)

post/api/v1/mc/incidents/{incidentId}/root-cause-theories/{theoryId}/undo
POST /gateway/ir/tp/api/v1/mc/incidents/{incidentId}/root-cause-theories/{theoryId}/undo?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: 28

{
  "expectedOldRcaSha": "text"
}
{
  "prettyId": "text",
  "projectId": "text",
  "title": "text",
  "summary": "text",
  "status": "NEW",
  "reporter": {
    "userId": "text",
    "displayName": "text",
    "email": "text"
  },
  "commander": {
    "userId": "text",
    "displayName": "text",
    "email": "text"
  },
  "impactedServices": [
    "text"
  ],
  "environments": [
    "text"
  ],
  "severity": {
    "id": "text",
    "label": "text"
  },
  "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"
    }
  ],
  "rootCauseTheories": [
    {
      "id": "text",
      "message": "text",
      "status": "text",
      "confidence": 1,
      "aiGenerated": true,
      "relatedActivities": [
        {
          "type": "text",
          "displayId": "text",
          "url": "text"
        }
      ]
    }
  ],
  "rootCauseTheoriesSha": "text",
  "commsLinks": [
    {
      "url": "text",
      "linkType": "WEB"
    }
  ],
  "videoConferenceLink": "text",
  "acknowledgedAtTimestamp": 1,
  "startedAtTimestamp": 1,
  "resolvedAtTimestamp": 1,
  "closedAtTimestamp": 1,
  "reportedAtTimestamp": 1,
  "mitigatedAtTimestamp": 1,
  "responderAssignedAtTimestamp": 1,
  "pagedResponders": [
    {
      "userId": "text",
      "displayName": "text",
      "email": "text"
    }
  ]
}

Last updated

Was this helpful?