Suppress

Suppress a trace signature.

This will suppress a trace signature for an org

  • Requires the actions org:SuppressTrace, org:CreateAnalyticsPolicy, org:UpdateAnalyticsPolicy on the organization
post/api/v1/org/{orgUID}/suppress/trace

Request

  • Base URL: https://api.prod.spyderbat.com
  • URL: https://api.prod.spyderbat.com/api/v1/org/{orgUID}/suppress/trace
  • Auth: HTTP bearer

Path parameters

orgUIDstring required

Organization UID to query

Request body

ignore_warningsboolean

If true, the suppression policy will be created even if there are warnings. If false, the suppression policy will not be created if there are warnings and a preview will be returned.

namestring

Name of the suppression policy (overrides the auto-generated name)

previewboolean

If true, the traces within scope will not be suppressed. Instead, the Trace Suppression Policy will be returned. If there are any warnings, this API will return a preview and list of warnings.

scope_by_clusterboolean

If true, the suppression policy will be scoped by the cluster the trace is a part of (if applicable). Will generate a warning if the trace is not part of a cluster.

scope_by_containerboolean

If true, the suppression policy will be scoped by the container the trace is a part of (if applicable). Will generate a warning if the trace is not part of a container.

scope_by_linux_serviceboolean

If true, the suppression policy will be scoped by the Linux service the trace is a part of (if applicable). Will generate a warning if the trace is not part of a Linux service.

scope_by_machineboolean

If true, the suppression policy will be scoped by the machine the trace is a part of.

scope_by_namespaceboolean

If true, the suppression policy will be scoped by the namespace the trace is a part of (if applicable). Will generate a warning if the trace is not part of a namespace.

scope_by_userboolean

If true, the suppression policy will be scoped by the user who triggered the trace

trace_uidstring required

The UID of the trace signature to suppress. Does not suppress the trace itself, but all traces that match the signature going forward.

Response

OK

matching_policy_existsboolean

Indicates if a suppression policy already exists for the trace signature

update_performedboolean

Indicates if an existing suppression policy was updated instead of a new one being created

warningsstring[]

Changes

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