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.
The identity and technical contract details declared by the specification.
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
siftrulesv1CalculatedChannelConfig
object
4 properties
2 required
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
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
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Sift Stack publishes across the network.