Create an incident update - Phare Documentation

curl --request POST \ --url https://api.phare.io/uptime/incidents/{incidentId}/updates \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "content": "We are investigating the issue.", "published_at": "2023-11-07T05:31:56Z" } '

{ "content": "We are investigating the issue.", "id": 1, "published_at": "2023-11-07T05:31:56Z", "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>

required

Available options:

unknown,

investigating,

identified,

monitoring,

resolved

content

string

required

Content of the incident update

Example:

"We are investigating the issue."

published_at

string<date-time>

Date of publication of the incident update

Response

Success, incident update created

state

enum<string>

required

Available options:

unknown,

investigating,

identified,

monitoring,

resolved

content

string

required

Content of the incident update

Example:

"We are investigating the issue."

integer

Incident update ID

Example:

1

published_at

string<date-time>

Date of publication of the incident update

creator

object

Creator of the incident update

Show child attributes

created_at

string<date-time>

Date of creation for the entity

updated_at

string<date-time>

Date of last update for the entity