ScalixScalix Docs
Sign up

Glitches API

REST API endpoints for Glitches.

REST API endpoints for Glitches. 5 operations.

Project glitch summary

plaintext
GET /v1/glitches

Aggregated tenant-side edge faults in the window, sorted by frequency: group class, key, counts, first/last seen, and a bounded sample of real paths. The default classes are the platform's starting point — the tenant's own rules (see the glitch rules endpoints) override them per project, and custom groups carry the tenant's own labels. Served only once the org enables Glitch Tracker (free base, 7-day retention) or Glitch Tracker Plus (2026-10-07): orgs that have not opted in receive an empty feed. Requires the glitches:read scope and a project-scoped credential.

Auth: Bearer API key

Parameters

NameInTypeRequiredDescription
window_daysqueryinteger (int64)YesLook-back window in days (1-30, default 7)

Responses

StatusDescription
200Project glitch summary
401Missing or invalid API key
403Token lacks the glitches:read scope or is not project-scoped
500Internal error

operationId: getGlitchSummary

List project glitch events

plaintext
GET /v1/glitches/events

Recent glitch events for the caller's project, newest first — metadata only (status, route, host, class). Events recorded under a tenant-defined rule appear with class custom and the tenant's own label as the group key. Served only once the org enables Glitch Tracker (free base, 7-day retention) or Glitch Tracker Plus (2026-10-07): orgs that have not opted in receive an empty list. Requires the glitches:read scope and a project-scoped credential.

Auth: Bearer API key

Parameters

NameInTypeRequiredDescription
limitqueryinteger (int64)YesMax events to return (1-200, default 50)

Responses

StatusDescription
200List project glitch events
401Missing or invalid API key
403Token lacks the glitches:read scope or is not project-scoped
500Internal error

operationId: listGlitchEvents

List this project's glitch rules

plaintext
GET /v1/glitches/rules

The tenant owns the definition of "glitch" (2026-10-05): rules are evaluated at the edge record sites BEFORE the platform's default classification. First matching rule (creation order) wins — ignore suppresses the observation entirely, track records it under the tenant's own label even for statuses the platform does not classify by default. Rules apply within a minute. Requires the glitches:read scope and a project-scoped credential.

Auth: Bearer API key

Responses

StatusDescription
200Tenant-defined glitch rules for this project, in evaluation order
401Missing or invalid API key
403Token lacks the glitches:read scope or is not project-scoped
500Internal error

operationId: listGlitchRules

Create one glitch rule for this project

plaintext
POST /v1/glitches/rules

The tenant decides what counts as a glitch for their own app. action: "ignore" suppresses matching observations; action: "track" records them under label (the tenant's own category name, which becomes the group key, class custom) with an optional tenant-authored remediation hint. At most 50 rules per project; at most 32 statuses per rule; path_prefix must start with /; host is a bare hostname. Rules apply within a minute, and only affect FUTURE observations. Requires the glitches:write scope and a project-scoped credential.

Auth: Bearer API key

Request body

application/json (required) — schema GlitchRuleCreate.

Responses

StatusDescription
201Rule created
400Invalid rule (bad action, statuses, label, prefix or host)
401Missing or invalid API key
403Token lacks the glitches:write scope or is not project-scoped
500Internal error

operationId: createGlitchRule

Delete one glitch rule by id

plaintext
DELETE /v1/glitches/rules/{id}

Deleting a rule never rewrites recorded events — past observations keep the class they were recorded with; matching traffic resumes the platform's default classification within a minute. A rule id from another project reports 404. Requires the glitches:write scope and a project-scoped credential.

Auth: Bearer API key

Parameters

NameInTypeRequiredDescription
idpathstringYesRule id (UUID)

Responses

StatusDescription
200Rule deleted
401Missing or invalid API key
403Token lacks the glitches:write scope or is not project-scoped
404No such rule in this project
500Internal error

operationId: deleteGlitchRule