How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Sift Stack Rule Service API

Service to programmatically interact with rules.

Sift Stack Rule Service API is one of 47 APIs that Sift Stack publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include RuleService. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, authentication docs, and rate-limit docs.

This API exposes 24 operations across 22 paths, and defines 82 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 2 base URLs: https://api.siftstack.com, https://gov.api.siftstack.com.

24 operations 22 paths 82 schemas 6 GET16 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.siftstack.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Sift Stack Rule Service API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuth). By default, every request must be authenticated.

Paths & Operations 24

Across 22 paths, the API surfaces 24 operations — 6 GET, 16 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

RuleService 24

Service to programmatically interact with rules.

GET
/api/v1/rules
GetRule
RuleService_GetRule 2 params → 200default
POST
/api/v1/rules
CreateRule
RuleService_CreateRule body → 200default
PUT
/api/v1/rules
UpdateRule
RuleService_UpdateRule body → 200default
POST
/api/v1/rules/archive
ArchiveRule
RuleService_ArchiveRule body → 200default
POST
/api/v1/rules/batchArchive
BatchArchiveRules
RuleService_BatchArchiveRules body → 200default
POST
/api/v1/rules/batchDelete
BatchDeleteRules
RuleService_BatchDeleteRules body → 200default
POST
/api/v1/rules/batchUnarchive
BatchUnarchiveRules
RuleService_BatchUnarchiveRules body → 200default
POST
/api/v1/rules/batchUndelete
BatchUndeleteRules
RuleService_BatchUndeleteRules body → 200default
POST
/api/v1/rules/delete
DeleteRule
RuleService_DeleteRule body → 200default
POST
/api/v1/rules/evaluate
EvaluateRules
RuleService_EvaluateRules body → 200default
POST
/api/v1/rules/search
SearchRules
RuleService_SearchRules body → 200default
POST
/api/v1/rules/unarchive
UnarchiveRule
RuleService_UnarchiveRule body → 200default
POST
/api/v1/rules/undelete
UndeleteRule
RuleService_UndeleteRule body → 200default
GET
/api/v1/rules/{ruleId}/versions
ListRuleVersions
RuleService_ListRuleVersions 4 params → 200default
POST
/api/v1/rules:batchGet
BatchGetRules
RuleService_BatchGetRules body → 200default
POST
/api/v1/rules:batchGetVersions
BatchGetRuleVersions
RuleService_BatchGetRuleVersions body → 200default
PUT
/api/v1/rules:batchUpdate
BatchUpdateRules
RuleService_BatchUpdateRules body → 200default
GET
/api/v1/rules:list
ListRules
RuleService_ListRules 4 params → 200default
POST
/api/v1/rules:updateHumanFriendly
UpdateHumanFriendlyRules
RuleService_UpdateHumanFriendlyRules body → 200default
POST
/api/v1/rules:updateJson
UpdateJsonRules
RuleService_UpdateJsonRules body → 200default
POST
/api/v1/rules:validateJson
ValidateJsonRules
RuleService_ValidateJsonRules body → 200default
GET
/api/v1/rules:version
GetRuleVersion
RuleService_GetRuleVersion 1 param → 200default
GET
/api/v1/rules:viewHumanFriendly
ViewHumanFriendlyRules
RuleService_ViewHumanFriendlyRules 1 param → 200default
GET
/api/v1/rules:viewJson
ViewJsonRules
RuleService_ViewJsonRules 1 param → 200default

Schemas 82

The contract defines 82 schemas that model the data the API accepts and returns. The most detailed are v1Rule (23 properties), v1UpdateRuleRequest (15 properties), v1SearchRulesRequest (11 properties), v1RuleVersion (10 properties). Each schema is shown below with its type and property counts.

v1BatchGetRulesResponse
object
1 property 1 required
v1BatchArchiveRulesResponse
object
v1RuleAction
object
9 properties 9 required
BatchUpdateRulesResponseRuleIdentifiers
object
3 properties 2 required
v1BatchGetRuleVersionsRequest
object
1 property 1 required
v1BatchGetRuleVersionsResponse
object
1 property 1 required
siftrulesv1EvaluateRulesRequest
object
Deprecated - use RuleEvaluationService instead.
5 properties 1 required
v1CreateRuleResponse
object
1 property 1 required
v1ValidationResult
object
5 properties 1 required
v1BatchUnarchiveRulesResponse
object
v1BatchUnarchiveRulesRequest
object
BatchUnarchiveRulesRequest is used to unarchive a rule by ruleid or clientkey. For each rule if both are provided, only ruleid will be used.
2 properties
v1MetadataValue
object
7 properties 1 required
rulesv1ChannelReference
object
3 properties
v1UpdateRuleRequest
object
UpdateRuleRequest is used to create or update a rule. If the ruleid or clientkey is provided, the rule will be updated. If not, a new rule will be created.
15 properties 4 required
v1UnarchiveRuleResponse
object
v1UpdateJsonRulesRequest
object
1 property 1 required
v1DeleteRuleResponse
object
v1BatchDeleteRulesResponse
object
v1SearchRulesResponse
object
2 properties 2 required
v1JsonRulesResponse
object
6 properties 5 required
v1MetadataRelationValue
object
2 properties 2 required
v1UndeleteRuleResponse
object
v1BatchUndeleteRulesResponse
object
protobufAny
object
Any contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. Protobuf library provides supp…
1 property
v1SingleChannelComparisonExpression
object
Deprecated - use CalculatedChannelConfig.
6 properties 3 required
v1BatchUpdateRulesRequest
object
3 properties 1 required
v1NotificationActionConfiguration
object
1 property 1 required
v1UpdateActionRequest
object
3 properties 2 required
v1JsonRulesRequest
object
3 properties 3 required
v1SearchRulesRequest
object
11 properties
v1RuleActionConfiguration
object
3 properties
v1Names
object
1 property 1 required
v1BatchUpdateRulesResponse
object
6 properties 6 required
v1AnnotationActionConfiguration
object
4 properties 1 required
v1RuleVersion
object
10 properties 8 required
v1RuleConditionExpression
object
2 properties
v1BatchGetRulesRequest
object
BatchGetRulesRequest is used to retrieve rules by ruleids or clientkeys. If both are provided, both will be used to retrieve rules.
2 properties
v1FunctionDependency
object
1 property 1 required
siftrulesv1EvaluateRulesResponse
object
Deprecated - use RuleEvaluationService instead.
4 properties
v1MetadataKeyType
string
Metadata key type. - METADATAKEYTYPESTRING: string - METADATAKEYTYPENUMBER: number - METADATAKEYTYPEBOOLEAN: boolean - METADATAKEYTYPERELATION: relation — refe…
rpcStatus
object
3 properties
v1Ids
object
1 property 1 required
v1CreateRuleRequest
object
1 property 1 required
v1AssetExpressionValidationResult
object
4 properties 2 required
v1ListRulesResponse
object
2 properties 1 required
v1ListRuleVersionsResponse
object
2 properties 1 required
v1GetRuleResponse
object
1 property 1 required
v1ValidateJsonRulesRequest
object
1 property 1 required
v1UpdateConditionRequest
object
3 properties 2 required
v1SearchOrder
string
siftrulesv1CalculatedChannelConfig
object
4 properties 2 required
v1ActionKind
string
v1ArchiveRuleResponse
object
v1UpdateJsonRulesResponse
object
1 property 1 required
v1ViewJsonRulesResponse
object
1 property 1 required
v1UndeleteRuleRequest
object
UndeleteRuleRequest is used to undelete a rule by ruleid or clientkey. If both are provided, only ruleid will be used.
2 properties
v1ContextualChannels
object
1 property 1 required
v1AnnotationType
string
v1WebhookActionConfiguration
object
1 property 1 required
v1MetadataKey
object
4 properties 2 required
v1UpdateHumanFriendlyRulesResponse
object
Deprecated - use UpdateJsonRulesResponse.
3 properties 3 required
v1EvaluatedAnnotationOptions
object
1 property
v1ValidateJsonRulesResponse
object
1 property 1 required
v1UnarchiveRuleRequest
object
UnarchiveRuleRequest is used to unarchive a rule by ruleid or clientkey. If both are provided, only ruleid will be used.
2 properties
v1Rule
object
23 properties 18 required
typev1CalculatedChannelDependency
object
A dependency on another calculated channel.
1 property 1 required
v1DryRunAnnotation
object
5 properties 2 required
v1UpdateHumanFriendlyRulesRequest
object
Deprecated - use UpdateJsonRulesRequest.
3 properties 3 required
v1ConditionComparator
string
v1RuleAssetConfiguration
object
2 properties
v1LastValueThreshold
object
v1RuleCondition
object
9 properties 9 required
v1TimeRangeQuery
object
2 properties
v1BatchArchiveRulesRequest
object
BatchArchiveRulesRequest is used to archive a rule by ruleid or clientkey. For each rule if both are provided, only ruleid will be used.
2 properties
v1DeleteRuleRequest
object
DeleteRuleRequest is used to delete a rule by ruleid or clientkey. If both are provided, only ruleid will be used.
2 properties
v1ViewHumanFriendlyRulesResponse
object
Deprecated - use ViewJsonRulesResponse.
1 property 1 required
v1UpdateRuleResponse
object
1 property 1 required
v1NamedResources
object
2 properties
v1BatchUndeleteRulesRequest
object
BatchUndeleteRulesRequest is used to delete a rule by ruleid or clientkey. For each rule if both are provided, only ruleid will be used.
2 properties
v1BatchDeleteRulesRequest
object
BatchDeleteRulesRequest is used to delete a rule by ruleid or clientkey. For each rule if both are provided, only ruleid will be used.
2 properties
v1ArchiveRuleRequest
object
ArchiveRuleRequest is used to archive a rule by ruleid or clientkey. If both are provided, only ruleid will be used.
2 properties
v1GetRuleVersionResponse
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

sift-stack-ruleservice-api-openapi.yml Raw ↑

Other APIs Sift Stack publishes across the network.

Sift gRPC API
Sift MCP Server
Sift Stack Annotation Log Service API
Sift Stack Annotation Service API
Sift Stack API Key Service API
Sift Stack Asset Service API
Sift Stack Automation Service API
Sift Stack Calculated Channel Service API
Sift Stack Calculated Channels Service API
Sift Stack Campaign Service API
Sift Stack Channel Schema Service API
Sift Stack Channel Service API
Where this information came from

This is an independent, third-party profile of Sift Stack Rule Service API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.