Skip to main content
POST
/
uptime
/
incidents
/
{incidentId}
/
updates
Create an incident update
curl --request POST \
  --url https://api.phare.io/uptime/incidents/{incidentId}/updates \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "state": "unknown",
  "content": "We are investigating the issue."
}
'
{
  "id": 1,
  "state": "unknown",
  "content": "We are investigating the issue.",
  "creator": {
    "id": 1,
    "type": "user",
    "label": "nicolas@phare.io"
  },
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Use a user token to access authenticated routes. The token must be specified in the Authorization HTTP header with the following format 'Authorization: Bearer '.

Headers

​
X-Phare-Project-Id
integer

A project header is required when using an organization-scoped API key.

Example:

1

​
X-Phare-Project-Slug
string

A project header is required when using an organization-scoped API key.

Example:

"luminous-guiding-tower"

Path Parameters

​
incidentId
integer
required

ID of the incident

Body

application/json

Incident update request

​
state
enum<string>
Available options:
unknown,
investigating,
identified,
monitoring,
resolved
​
content
string

Content of the incident update

Example:

"We are investigating the issue."

Response

Success, incident update created

​
id
integer

Incident update ID

Example:

1

​
state
enum<string>
Available options:
unknown,
investigating,
identified,
monitoring,
resolved
​
content
string

Content of the incident update

Example:

"We are investigating the issue."

​
creator
object

Project settings

​
created_at
string<date-time>

Date of creation for the entity

​
updated_at
string<date-time>

Date of last update for the entity