SPspice
Reactions

Update a data reaction

Updates reaction fields supplied in the request. Requires reactions:write and organization membership.

patch/v1/projects/{projectId}/reactions/{alertId}

Request

  • Base URL
    https://api.spice.ai
  • Auth
    HTTP bearer

Path parameters

projectIdinteger required
alertIdstring uuid required

Headers

X-Org-Namestring

The organization to act on, by handle. Omit it to act on the organization the credential is bound to; sending it blank is a 400, not the same as omitting it. A user credential may name any organization its owner belongs to; a machine credential is pinned to its own. A portal session token is bound to none, so it must send this header on every route but GET /v1/orgs (400 org_assertion_required otherwise).

Request body

namestring
descriptionstring nullable
status'active' | 'disabled'
templateIdstring
specobject
recipientUserIdsinteger[]

Response

Reaction updated

idstring uuid required

Identifier of the monitor or reaction. This is the value the get, update and delete operations take.

org_idinteger required

Organization that owns the project

app_idinteger required

Project the monitor or reaction belongs to

created_byinteger nullable required

User who created it, when it was created by a user credential

namestring required

Display name, unique case-insensitively among the project's live monitors and data reactions

descriptionstring nullable required
kind'data' required

The reactions endpoints only ever return data.

status'active' | 'disabled' required

Whether it is evaluating

template_idstring required

Template it was created from

specobject required

Reaction parameters, normalized for the response: a reaction whose model transform is still held on target is returned with that transform copied into spec.model. Which properties are meaningful is decided by template_id. The create operation's request body lists the properties each template reads.

recipient_user_idsinteger[] required

Organization members emailed when it fires. Empty when there is no email sink, and for an email sink addressed only by emails. When a created email sink named no recipients at all, the API stores the creating user.

last_fired_atstring date-time nullable required

When it last fired, or null if it never has

last_resolved_atstring date-time nullable required

When it last resolved, or null if it never has

created_atstring date-time required
updated_atstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.