PUT
/
incidents
/
{incident}
curl --request PUT \
  --url http://localhost/api/incidents/{incident} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "message": "<string>",
  "status": 0,
  "visible": true,
  "stickied": true,
  "notifications": true,
  "occurred_at": "<string>"
}'
{
  "data": {
    "id": "<string>",
    "type": "incidents",
    "attributes": {
      "id": "<string>",
      "guid": "<string>",
      "name": "<string>",
      "message": "<string>",
      "component_id": "<string>",
      "visible": "<string>",
      "stickied": "<string>",
      "notifications": "<string>",
      "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": "<string>",
              "name": "<string>",
              "description": "<string>",
              "link": "<string>",
              "order": "<string>",
              "status": {
                "human": "<string>",
                "value": "<string>"
              },
              "enabled": "<string>",
              "meta": "<string>",
              "created": {
                "human": "<string>",
                "string": "<string>"
              },
              "updated": {
                "human": "<string>",
                "string": "<string>"
              }
            },
            "relationships": {
              "group": {
                "data": {
                  "id": "<string>",
                  "type": "componentGroups",
                  "attributes": {
                    "id": "<string>",
                    "name": "<string>",
                    "order": "<string>",
                    "visible": "<string>",
                    "created": {
                      "human": "<string>",
                      "string": "<string>"
                    },
                    "updated": {
                      "human": "<string>",
                      "string": "<string>"
                    }
                  },
                  "relationships": {
                    "components": {
                      "data": [
                        {}
                      ]
                    }
                  }
                }
              },
              "incidents": {
                "data": [
                  {}
                ]
              }
            }
          }
        ]
      },
      "updates": {
        "data": [
          {
            "id": "<string>",
            "type": "updates",
            "attributes": {
              "id": "<string>",
              "updateable_id": "<string>",
              "updateable_type": "<string>",
              "message": "<string>",
              "status": {
                "human": "<string>",
                "value": "<string>"
              },
              "created": {
                "human": "<string>",
                "string": "<string>"
              },
              "updated": {
                "human": "<string>",
                "string": "<string>"
              }
            }
          }
        ]
      },
      "user": {
        "data": {
          "id": "<string>",
          "type": "<string>",
          "attributes": {
            "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

Body

application/json
`UpdateIncidentRequestData`
name
string
Maximum length: 255
message
string | null
status
enum<integer> | null
Available options:
0,
1,
2,
3,
4
visible
boolean | null
stickied
boolean | null
notifications
boolean | null
occurred_at
string | null

Response

200
application/json
`Incident`
data
object
required