Incidents
Soda Cloud API Incidents Endpoints
This endpoint enables you to gather information about the incidents that exist in your organization's Soda Cloud account.
Each incident carries a hasRcaReport flag indicating whether a structured root cause analysis report has been published for it; retrieve the report itself from GET /api/v1/incidents/{incidentId}/rcaReport. hasRcaReport is in private preview: it is true or false only when the root cause analysis report preview is enabled for your organization, and null otherwise.
This GET is a paginated API that uses the following parameters to request specific details:
size: Supply an integer value between 1 and 1000, inclusive. The default value is 10.page: Supply an integer value. The default value is 0.status: Optionally, use this parameter to collect only the incidents with a specific status. One ofreported,investigating,fixing,resolved.severity: Optionally, use this parameter to collect only the incidents with a specific severity. One ofminor,major,critical.datasetId: Optionally, use this parameter to collect only the incidents associated with a specific dataset. Find thedatasetIdin the URL of the dataset page in Soda Cloud.incidentIds: Optionally, use this parameter to collect only a specific batch of incidents. Provide multiple values as a comma-separated list of incident IDs, which you can find on the individual incident pages in Soda Cloud. This query parameter is limited to 1000 incident IDs and can be combined with the other query parameters (status,severity,datasetId,page,size), which are all applied together.leadId: Optionally, use this parameter to collect only the incidents assigned to a specific lead user. Provide the user id of the incident lead.from: Optionally, use this parameter to collect only the incidents created on or after this moment, compared against each incident's created timestamp. Supply an ISO8601 timestamp value. Example:2026-08-01T00:00:00+01:00to: Optionally, use this parameter to collect only the incidents created on or before this moment, compared against each incident's created timestamp. Supply an ISO8601 timestamp value. Example:2026-08-01T23:59:59+01:00
The leadId, from, and to parameters can be combined with the other query parameters, which are all applied together (AND).
If not specified, the query gathers information for all incidents in the account and sorts the results by incident number in ascending order.
Authorization
Soda only returns the incidents linked to datasets to which the user has View dataset permissions. Soda Cloud Admins have access to all incidents.See Manage dataset roles for more information.
Authentication
User authentication required: true
This endpoint accepts authentication via API keys in the Basic authentication header, or a pre-authenticated token in HTTP cookie token. Cookie sessions extend automatically on each request.
Tags
Incidents
Rate limiting
60 requests/60 seconds
Successful response
Bad request
Unauthorized
Forbidden
Not found
Too many requests
Internal server error
GET /api/v1/incidents HTTP/1.1
Host: cloud.soda.io
Authorization: Basic username:password
Accept: */*
{
"content": [
{
"hasRcaReport": true,
"description": "text",
"resolutionNotes": "text",
"severity": "minor",
"cloudUrl": "text",
"id": "text",
"name": "text",
"number": 1,
"status": "reported"
}
],
"first": true,
"last": true,
"number": 1,
"size": 1,
"totalElements": 1,
"totalPages": 1
}This endpoint enables you to create a new incident linked to one or more monitor results in your organization's Soda Cloud account. The authenticated user becomes the incident reporter.
Authorization
Only users with Manage incident permission can create incidents. Soda Cloud Admins have permission to create incidents on all datasets.See Manage dataset roles for more information.
Authentication
User authentication required: true
This endpoint accepts authentication via API keys in the Basic authentication header, or a pre-authenticated token in HTTP cookie token. Cookie sessions extend automatically on each request.
Tags
Incidents
Rate limiting
10 requests/60 seconds
Successful response
Bad request
Unauthorized
Forbidden
Not found
Too many requests
Internal server error
POST /api/v1/incidents HTTP/1.1
Host: cloud.soda.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 145
{
"description": "text",
"leadId": "text",
"monitorResultIds": [
"text"
],
"resolutionNotes": "text",
"severity": "minor",
"status": "reported",
"title": "text"
}{
"description": "text",
"resolutionNotes": "text",
"severity": "minor",
"cloudUrl": "text",
"id": "text",
"name": "text",
"number": 1,
"status": "reported"
}This endpoint enables you to update an existing incident title, severity, status, or description in your organization's Soda Cloud account.
Authorization
Only users with Manage incident permission can update incidents. Soda Cloud Admins have permission to update all incidents.See Manage dataset roles for more information.
Authentication
User authentication required: true
This endpoint accepts authentication via API keys in the Basic authentication header, or a pre-authenticated token in HTTP cookie token. Cookie sessions extend automatically on each request.
Tags
Incidents
Rate limiting
10 requests/60 seconds
Successful response
Bad request
Unauthorized
Forbidden
Not found
Too many requests
Internal server error
POST /api/v1/incidents/{incidentId} HTTP/1.1
Host: cloud.soda.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 101
{
"description": "text",
"resolutionNotes": "text",
"severity": "minor",
"status": "reported",
"title": "text"
}{
"description": "text",
"resolutionNotes": "text",
"severity": "minor",
"cloudUrl": "text",
"id": "text",
"name": "text",
"number": 1,
"status": "reported"
}This endpoint returns the structured root cause analysis and impact assessment published on an incident in your organization's Soda Cloud account.
Returns 404 if the incident does not exist or has no RCA report published yet.
Authorization
Unlike the incident list, this endpoint requires View dataset permission on every dataset the incident touches. Soda Cloud Admins have access to all incidents. See Manage dataset roles for more information.
Authentication
User authentication required: true
This endpoint accepts authentication via API keys in the Basic authentication header, or a pre-authenticated token in HTTP cookie token. Cookie sessions extend automatically on each request.
Tags
Incidents
Rate limiting
60 requests/60 seconds
Successful response
Bad request
Unauthorized
Forbidden
Not found
Too many requests
Internal server error
GET /api/v1/incidents/{incidentId}/rcaReport HTTP/1.1
Host: cloud.soda.io
Authorization: Basic username:password
Accept: */*
{
"agentName": "text",
"blastRadiusAssetType": "dataset",
"blastRadiusCount": 1,
"confidence": "high",
"durationSeconds": 1,
"generatedAt": "2026-01-01T00:00:00.000Z",
"id": "text",
"impactSummary": "text",
"incidentId": "text",
"publishedAt": "2026-01-01T00:00:00.000Z",
"rootCauseSummary": "text",
"status": "completed"
}This endpoint publishes a structured root cause analysis and impact assessment onto an existing incident in your organization's Soda Cloud account. The report is additive and does not mutate the incident's own fields (title, severity, status, description).
There is one report per incident: publishing replaces any previous report. Publishing to a resolved incident is rejected.
Authorization
Only users with Manage incident permission can publish incident RCA reports. Soda Cloud Admins have permission to publish reports on all incidents.See Manage dataset roles for more information.
Authentication
User authentication required: true
This endpoint accepts authentication via API keys in the Basic authentication header, or a pre-authenticated token in HTTP cookie token. Cookie sessions extend automatically on each request.
Tags
Incidents
Rate limiting
10 requests/60 seconds
Successful response
Bad request
Unauthorized
Forbidden
Not found
Too many requests
Internal server error
POST /api/v1/incidents/{incidentId}/rcaReport HTTP/1.1
Host: cloud.soda.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 1003
{
"agent": {
"model": "text",
"name": "text",
"sessionId": "text",
"version": "text"
},
"impactAssessment": {
"affectedResources": [
{
"description": "text",
"metrics": [
{
"label": "text",
"value": "text"
}
],
"resource": {
"id": "text",
"name": "text",
"type": "dataset",
"url": "text"
}
}
],
"blastRadius": {
"assetType": "dataset",
"count": 1
},
"summary": "text"
},
"rootCauseAnalysis": {
"confidence": "high",
"durationSeconds": 1,
"generatedAt": "2026-01-01T00:00:00.000Z",
"investigation": [
{
"detail": "text",
"evidence": [
{
"kind": "text",
"resource": {
"id": "text",
"name": "text",
"type": "dataset",
"url": "text"
},
"text": "text"
}
],
"order": 1,
"title": "text"
}
],
"lineage": {
"edges": [
{
"from": "text",
"to": "text"
}
],
"nodes": [
{
"id": "text",
"incidentAsset": true,
"name": "text",
"namespace": "text",
"platform": "text",
"sodaResource": {
"id": "text",
"name": "text",
"type": "dataset",
"url": "text"
},
"status": "rootCause"
}
]
},
"remediation": [
{
"action": "text",
"priority": "low"
}
],
"rootCauseResource": {
"id": "text",
"name": "text",
"type": "dataset",
"url": "text"
},
"status": "completed",
"summary": "text"
}
}{
"agentName": "text",
"blastRadiusAssetType": "dataset",
"blastRadiusCount": 1,
"confidence": "high",
"durationSeconds": 1,
"generatedAt": "2026-01-01T00:00:00.000Z",
"id": "text",
"impactSummary": "text",
"incidentId": "text",
"publishedAt": "2026-01-01T00:00:00.000Z",
"rootCauseSummary": "text",
"status": "completed"
}Last updated
Was this helpful?