Incidents

Soda Cloud API Incidents Endpoints

Update incident

post

/api/v1/incidents/{incidentId}

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

Authorizations

AuthorizationstringRequired

Path parameters

incidentIdstringRequired

Body

descriptionstringOptional

resolutionNotesstringOptional

severityobject · enumOptionalPossible values:

statusobject · enumOptionalPossible values:

titlestringOptional

Responses

200

Successful response

application/json

descriptionstringRequired

resolutionNotesstringOptional

severityobject · enumRequiredPossible values:

cloudUrlstringOptional

idstringOptional

namestringOptional

numberinteger · int32Optional

statusobject · enumOptionalPossible values:

400

Bad request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

429

Too many requests

application/json

500

Internal server error

application/json

post/api/v1/incidents/{incidentId}

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"
}