GET
/
incidents
/
{incident}
curl --request GET \
  --url http://localhost/api/incidents/{incident}
{
  "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": [
          {
            "id": "<string>",
            "type": "components",
            "attributes": {
              "id": 123,
              "name": "<string>",
              "description": "<string>",
              "link": "<string>",
              "order": 123,
              "status": {
                "human": "<string>",
                "value": "<string>"
              },
              "enabled": true,
              "meta": [
                "<any>"
              ],
              "created": {
                "human": "<string>",
                "string": "<string>"
              },
              "updated": {
                "human": "<string>",
                "string": "<string>"
              }
            },
            "relationships": {
              "group": {
                "data": {
                  "type": "componentGroups",
                  "id": "<string>"
                }
              },
              "incidents": {
                "data": [
                  {}
                ]
              }
            }
          }
        ]
      },
      "updates": {
        "data": [
          {
            "id": "<string>",
            "type": "updates",
            "attributes": {
              "id": 123,
              "updateable_id": 123,
              "updateable_type": "<string>",
              "message": "<string>",
              "status": {
                "human": "<string>",
                "value": "<string>"
              },
              "created": {
                "human": "<string>",
                "string": "<string>"
              },
              "updated": {
                "human": "<string>",
                "string": "<string>"
              }
            }
          }
        ]
      },
      "user": {
        "data": {
          "type": "<string>",
          "id": "<string>"
        }
      }
    }
  }
}

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

200
application/json

Incident

The response is of type object.