Sift Stack's Rule Service API never deletes a rule; it files a POST you can undo

Sift Stack's Rule Service API never deletes a rule; it files a POST you can undo

The Sift Stack Rule Service API is one of 47 APIs that Sift Stack publishes on apis.io. Sift is an observability platform for mission-critical hardware: rockets, satellites and aircraft. Rules are its alerting layer, the conditions on telemetry channels that mark a test run as failed or an asset as out of bounds. The API has 24 operations on https://api.siftstack.com, all under /api/v1/rules, and none of them uses the HTTP DELETE verb.

What the surface does

The 24 operations fall into four groups:

  • Lifecycle: CreateRule, UpdateRule, GetRule, ListRules, SearchRules, plus batch versions of get and update.
  • Removal, all reversible: ArchiveRule, UnarchiveRule, DeleteRule, UndeleteRule, and four batch variants of the same. Every one of them is a POST.
  • Versions: ListRuleVersions, GetRuleVersion, BatchGetRuleVersions. Each rule keeps its history.
  • Representations: ViewJsonRules, UpdateJsonRules and ValidateJsonRules handle rules as JSON. ViewHumanFriendlyRules and UpdateHumanFriendlyRules handle a readable form of the same rules.

The OpenAPI contract, authentication, error catalog, rate-limit and conventions artifacts are all published on artifacts.apis.io. Human documentation is at docs.siftstack.com.

The observation: removal is two-stage and reversible

A team that has signed off a flight-test campaign against a rule set cannot have a rule disappear. Sift handles this with two levels of retirement. Archive takes a rule out of use. Delete is also a POST to /rules/delete, and /rules/undelete exists alongside it. Together with the version history, this means a rule’s state at any point in time can be reconstructed. In a regulated test environment, that is the requirement, and the API surface shows it.

The cost is a mixed URL style. Some actions are sub-paths (/rules/archive, /rules/search). Others use Google-style colon methods (/rules:batchGet, /rules:validateJson, /rules:viewHumanFriendly). GetRule is a GET on the collection path /api/v1/rules and not on /rules/{id}, while ListRuleVersions does use a {ruleId} path parameter. The surface is generated from gRPC, and the REST mapping shows that.

One thing to watch

Rule evaluation appears in two places. This API has EvaluateRules at /rules/evaluate. The separate Rule Evaluation Service API has two operations, EvaluateRules at /rules/evaluate-rules and a :preview variant. If you are integrating, check which one the current docs point to before you hard-code either. The Sift Stack listing also has paired near-duplicate records, such as channelservice and channel-service, and jobservice and job-service. That is our cleanup to do, not Sift’s.

Takeaway

If an API manages rules that decide whether hardware passed a test, look for archive, undelete and versions before you look for create. This one has all three. The listing is at apis.io/apis/sift-stack/sift-stack-ruleservice-api/.

← Messaging and notifications is led by a service AWS stopped supporting on October 30
Solo.io says JWTs for service auth unravel the API gateway →