PUT
/
api
/
v1
/
incidents
import dateutil.parser
import os
from syllable_sdk import SyllableSDK


with SyllableSDK(
    api_key_header=os.getenv("SYLLABLESDK_API_KEY_HEADER", ""),
) as ss_client:

    res = ss_client.incidents.update(request={
        "description": "Service outage in region X",
        "start_datetime": dateutil.parser.isoparse("2023-10-01T08:00:00Z"),
        "resolution_datetime": dateutil.parser.isoparse("2023-10-01T12:00:00Z"),
        "impact_category": "High",
        "sessions_impacted": 1500,
        "markdown": "**Incident Details**",
        "organization_id": 123,
        "sub_organization_id": 456,
        "sub_organization": "SubOrg A",
        "id": 1,
        "created_at": dateutil.parser.isoparse("2023-10-01T08:00:00Z"),
        "updated_at": dateutil.parser.isoparse("2023-10-01T08:00:00Z"),
    })

    # Handle response
    print(res)
{
  "description": "Service outage in region X",
  "start_datetime": "2023-10-01T08:00:00Z",
  "resolution_datetime": "2023-10-01T12:00:00Z",
  "impact_category": "High",
  "sessions_impacted": 1500,
  "markdown": "**Incident Details**",
  "organization_id": 123,
  "sub_organization_id": 456,
  "sub_organization": "SubOrg A",
  "id": 1,
  "created_at": "2023-10-01T08:00:00Z",
  "updated_at": "2023-10-01T08:00:00Z",
  "last_updated_by": "user@mail.com"
}

Authorizations

​
Syllable-API-Key
string
header
required

Body

application/json

Request model to update an existing service incident.

​
description
string
required

Description of the service incident

Example:

"Service outage in region X"

​
start_datetime
string
required

Start time of the incident

Example:

"2023-10-01T08:00:00Z"

​
resolution_datetime
string
required

Resolution time of the incident

Example:

"2023-10-01T12:00:00Z"

​
impact_category
string
required

Category of the impact

Example:

"High"

​
sessions_impacted
integer
required

Number of sessions impacted

Example:

1500

​
markdown
string
required

Detailed markdown description of the incident

Example:

"**Incident Details**"

​
id
integer
required

The ID of the incident to update

Example:

1

​
organization_id
integer | null

The ID of the organization

Example:

123

​
sub_organization_id
integer | null

The ID of the sub-organization

Example:

456

​
sub_organization
string | null

The name of the sub-organization

Example:

"SubOrg A"

​
created_at
string | null

Creation time of the incident

Example:

"2023-10-01T08:00:00Z"

​
updated_at
string | null

Last update time of the incident

Example:

"2023-10-01T08:00:00Z"

Response

200
application/json
Successful Response

Response model for service incident operations.

​
description
string
required

Description of the service incident

Example:

"Service outage in region X"

​
start_datetime
string
required

Start time of the incident

Example:

"2023-10-01T08:00:00Z"

​
resolution_datetime
string
required

Resolution time of the incident

Example:

"2023-10-01T12:00:00Z"

​
impact_category
string
required

Category of the impact

Example:

"High"

​
sessions_impacted
integer
required

Number of sessions impacted

Example:

1500

​
markdown
string
required

Detailed markdown description of the incident

Example:

"**Incident Details**"

​
id
integer
required

The ID of the incident to update

Example:

1

​
last_updated_by
string | null
required

The email of the user who last updated the incident

Example:

"user@mail.com"

​
organization_id
integer | null

The ID of the organization

Example:

123

​
sub_organization_id
integer | null

The ID of the sub-organization

Example:

456

​
sub_organization
string | null

The name of the sub-organization

Example:

"SubOrg A"

​
created_at
string | null

Creation time of the incident

Example:

"2023-10-01T08:00:00Z"

​
updated_at
string | null

Last update time of the incident

Example:

"2023-10-01T08:00:00Z"