Skip to main content
POST
Create error

Authorizations

Authorization
string
header
required

Use an Observe API key from the management console. The key selects the project and must grant the permission listed on the operation. Keep this key on your server.

Body

application/json
name
string
required

Human-readable error name.

description
string

Optional longer description of the error.

type
enum<string>

Error type; defaults to project-specific.

Available options:
general,
project-specific
severity
enum<string>

Triage severity; defaults to error.

Available options:
error,
warn,
info
flavourIDs
string[]

Optional initial set of flavours to assign to the new error (format erf-<number>). Must all share one subflow type, which becomes the error's auto-stamped scope.

Maximum array length: 1000
assignSource
enum<string>

Provenance of the initial flavour assignment (defaults to manual). Only allowed together with flavourIDs.

Available options:
manual,
kb,
agent
assignReason
string

Human-readable explanation of why the initial flavours belong to this error; stored per flavour. Only allowed together with flavourIDs.

Response

Error created.

id
string
required

Error ID (format err-<number>).

name
string
required

Human-readable error name.

type
enum<string>
required

Whether the error is a general (cross-deployment) or project-specific one.

Available options:
general,
project-specific
severity
enum<string>
required

User-declared triage severity of an occurrence of this error.

Available options:
error,
warn,
info
createdMs
integer<int64>
required

Creation time in milliseconds since epoch.

updatedMs
integer<int64>
required

Last update time in milliseconds since epoch.

description
string

Optional longer description of the error.

subFlowType
string

Auto-managed subflow scope — stamped from the first assigned flavours, enforced on every later assignment (an error never mixes subflow types), cleared when the last member is unassigned. Never user input. Absent while the error has no members.

recommendation
object

Curated guidance attached to an error (at most one per error): what the error is and how to reproduce it, the recommended handling (ignore / observe / fix), and — for fix — the fix in detail. Human-created like the error itself; classification never writes it. Free-text fields are markdown.

lastImpact
object

Result of the most recent impact analysis run for this error: the completion-rate and completed-duration comparison against the baseline, plus when it ran and over which range. Stored when the impact endpoint is called with the error's ID; absent while no analysis ran (or the error lost its last member flavour since). Numbers describe the member set at analysis time — analyzedAtMs says how current they are.