Get Incident

curl --request GET \
  --url http://localhost/api/incidents/{incident} \
  --header 'Authorization: Bearer <token>'

{
  "data": {
    "id": "<string>",
    "type": "incidents",
    "attributes": {
      "id": 123,
      "guid": "<string>",
      "name": "<string>",
      "message": "<string>",
      "component_id": 123,
      "visible": 0,
      "stickied": true,
      "notifications": 123,
      "status": {
        "human": "<string>",
        "value": "<string>"
      },
      "occurred": {
        "human": "<string>",
        "string": "<string>"
      },
      "created": {
        "human": "<string>",
        "string": "<string>"
      },
      "updated": {
        "human": "<string>",
        "string": "<string>"
      }
    },
    "relationships": {
      "components": {
        "data": [
          {
            "type": "components",
            "id": "<string>"
          }
        ]
      },
      "updates": {
        "data": [
          {
            "type": "updates",
            "id": "<string>"
          }
        ]
      },
      "user": {
        "data": {
          "type": "<string>",
          "id": "<string>"
        }
      }
    }
  }
}

GET

incidents

{incident}

Get Incident

curl --request GET \
  --url http://localhost/api/incidents/{incident} \
  --header 'Authorization: Bearer <token>'

{
  "data": {
    "id": "<string>",
    "type": "incidents",
    "attributes": {
      "id": 123,
      "guid": "<string>",
      "name": "<string>",
      "message": "<string>",
      "component_id": 123,
      "visible": 0,
      "stickied": true,
      "notifications": 123,
      "status": {
        "human": "<string>",
        "value": "<string>"
      },
      "occurred": {
        "human": "<string>",
        "string": "<string>"
      },
      "created": {
        "human": "<string>",
        "string": "<string>"
      },
      "updated": {
        "human": "<string>",
        "string": "<string>"
      }
    },
    "relationships": {
      "components": {
        "data": [
          {
            "type": "components",
            "id": "<string>"
          }
        ]
      },
      "updates": {
        "data": [
          {
            "type": "updates",
            "id": "<string>"
          }
        ]
      },
      "user": {
        "data": {
          "type": "<string>",
          "id": "<string>"
        }
      }
    }
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

incident

integer

required

The incident ID

Query Parameters

include

string

Available includes are components, componentsCount, componentsExists, updates, updatesCount, updatesExists, user, userCount, userExists. You can include multiple options by separating them with a comma.

Response

Incident

data

Incident · object

required

Show child attributes

data.id

string

required

data.type

enum<string>

required

Available options:

incidents

data.attributes

object

Show child attributes

data.attributes.id

integer

required

data.attributes.guid

string

required

data.attributes.name

string

required

data.attributes.message

string

required

data.attributes.component_id

integer | null

required

data.attributes.visible

enum<integer>

required

Available options:

0,

1,

2

data.attributes.stickied

boolean

required

data.attributes.notifications

integer

required

data.attributes.status

object

required

Show child attributes

data.attributes.status.human

string

required

data.attributes.status.value

string

required

data.attributes.occurred

object

required

Show child attributes

data.attributes.occurred.human

string

required

data.attributes.occurred.string

string

required

data.attributes.created

object

required

Show child attributes

data.attributes.created.human

string

required

data.attributes.created.string

string

required

data.attributes.updated

object

required

Show child attributes

data.attributes.updated.human

string

required

data.attributes.updated.string

string

required

data.relationships

object

Show child attributes

data.relationships.components

object

Show child attributes

data.relationships.components.data

ComponentIdentifier · object[]

required

Show child attributes

data.relationships.components.data.type

enum<string>

required

Available options:

components

data.relationships.components.data.id

string

required

data.relationships.updates

object

Show child attributes

data.relationships.updates.data

UpdateIdentifier · object[]

required

Show child attributes

data.relationships.updates.data.type

enum<string>

required

Available options:

updates

data.relationships.updates.data.id

string

required

data.relationships.user

object

Show child attributes

data.relationships.user.data

UserIdentifier · object

required

Show child attributes

data.relationships.user.data.type

string

required

data.relationships.user.data.id

string

required

Create Incident Update Incident

⌘I

API Documentation

Cachet

Components

Component Groups

Incidents

Incident Updates

Incident Templates

Metrics

Metric Points

Schedules

Schedule Updates

Get Incident

Authorizations

Path Parameters

Query Parameters

Response