Create Incident

Create a new incident

POST/api/v1/incidents/

Authentication

Syllable-API-Keyrequired

Send Syllable-API-Key in the header.

Need a credential? Create or manage an API token in the Syllable Console.

Parameters

This endpoint has no declared parameters.

Request body

application/json

body IncidentCreateRequest required

9 fields

descriptionstringrequired

Description of the service incident

start_datetimestring (date-time)required

Start time of the incident

resolution_datetimestring (date-time)required

Resolution time of the incident

impact_categorystringrequired

Category of the impact

sessions_impactedintegerrequired

Number of sessions impacted

markdownstringrequired

Detailed markdown description of the incident

organization_idinteger | nulloptional

The ID of the organization

sub_organization_idinteger | nulloptional

The ID of the sub-organization

sub_organizationstring | nulloptional

The name of the sub-organization (DEPRECATED)

Request example

{
  "description": "string",
  "start_datetime": "string",
  "resolution_datetime": "string",
  "impact_category": "string",
  "sessions_impacted": 0,
  "markdown": "string",
  "organization_id": "string",
  "sub_organization_id": "string",
  "sub_organization": "string"
}

Responses

200Successful Response

application/json

response IncidentResponse required

13 fields

descriptionstringrequired

Description of the service incident

start_datetimestring (date-time)required

Start time of the incident

resolution_datetimestring (date-time)required

Resolution time of the incident

impact_categorystringrequired

Category of the impact

sessions_impactedintegerrequired

Number of sessions impacted

markdownstringrequired

Detailed markdown description of the incident

organization_idinteger | nulloptional

The ID of the organization

sub_organization_idinteger | nulloptional

The ID of the sub-organization

sub_organizationstring | nulloptional

The name of the sub-organization (DEPRECATED)

idintegerrequired

The ID of the incident to update

created_atstring (date-time) | nulloptional

Creation time of the incident

updated_atstring (date-time) | nulloptional

Last update time of the incident

last_updated_bystring | nullrequired

The email of the user who last updated the incident

Response example

{
  "description": "string",
  "start_datetime": "string",
  "resolution_datetime": "string",
  "impact_category": "string",
  "sessions_impacted": 0,
  "markdown": "string",
  "organization_id": "string",
  "sub_organization_id": "string",
  "sub_organization": "string",
  "id": 0,
  "created_at": "string",
  "updated_at": "string",
  "last_updated_by": "string"
}

422Validation Error

application/json

response HTTPValidationError required

1 field

detailValidationError[]optional

Item schema

itemsValidationErrorrequired

3 fields

locstring | integer[]required

Item schema

itemsstring | integerrequired

2 options

Option 1stringrequired

Option 2integerrequired

msgstringrequired

typestringrequired

Response example

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Code examples

import { SyllableSDK } from "syllable-sdk";

const syllableSDK = new SyllableSDK({
  apiKeyHeader: process.env["SYLLABLE_API_KEY"] ?? "",
});

async function run() {
  const result = await syllableSDK.incidents.create({
    description: "Service outage in region X",
    startDatetime: new Date("2023-10-01T08:00:00Z"),
    resolutionDatetime: new Date("2023-10-01T12:00:00Z"),
    impactCategory: "High",
    sessionsImpacted: 1500,
    markdown: "**Incident Details**",
    organizationId: 123,
    subOrganizationId: 456,
  });

  console.log(result);
}

run();

import os
from syllable_sdk import SyllableSDK
from syllable_sdk.utils import parse_datetime


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

    res = ss_client.incidents.create(request={
        "description": "Service outage in region X",
        "start_datetime": parse_datetime("2023-10-01T08:00:00Z"),
        "resolution_datetime": parse_datetime("2023-10-01T12:00:00Z"),
        "impact_category": "High",
        "sessions_impacted": 1500,
        "markdown": "**Incident Details**",
        "organization_id": 123,
        "sub_organization_id": 456,
    })

    # Handle response
    print(res)

curl --request POST \
  --url 'https://api.syllable.cloud/api/v1/incidents/' \
  --header 'content-type: application/json' \
  --data '{
  "description": "string",
  "start_datetime": "string",
  "resolution_datetime": "string",
  "impact_category": "string",
  "sessions_impacted": 0,
  "markdown": "string",
  "organization_id": "string",
  "sub_organization_id": "string",
  "sub_organization": "string"
}'