Spyctl

Build a new Suppression Policy document

This will build and return a new Suppression Policy document which can then be applied via the AnalyticsPolicy API.

  • Requires the user have the action *spyctl:SuppressionPolicyBuild
post/api/v1/org/{orgUID}/spyctl/suppressionpolicy/build/

Request

  • Base URL: https://api.prod.spyderbat.com
  • URL: https://api.prod.spyderbat.com/api/v1/org/{orgUID}/spyctl/suppressionpolicy/build/
  • Auth: HTTP bearer

Path parameters

orgUIDstring required

Request body

namestring

Custom name for the suppression policy

object_uidstring

The uid of the object to suppress

scope_to_usersboolean

If set to true, the policy will automatically be scoped to the users associated with the object referenced by ObjUID; unless overwritten by the selectors.

selectorsobject

The way to define a custom scope for the policy. Possible keys are: trigger-class, trigger-ancestors, users, interactive-users, non-interactive-users. Values may be wildcarded with '*'.

typestring required

Response

OK

context_uidstring

Context UID for this query, it's used to track the query as it flows through the system

Changes

No recorded changes to this operation across all 1 revision of this API.