checkpoint.getManagementThreatRulebase

checkpoint 3.0.0, Mar 30 26

Viewing docs for checkpoint 3.0.0
published on Monday, Mar 30, 2026 by checkpointsw

checkpointsw/terraform-provider-checkpoint

Viewing docs for checkpoint 3.0.0
published on Monday, Mar 30, 2026 by checkpointsw

checkpointsw/terraform-provider-checkpoint

Using getManagementThreatRulebase

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getManagementThreatRulebase(args: GetManagementThreatRulebaseArgs, opts?: InvokeOptions): Promise<GetManagementThreatRulebaseResult>
function getManagementThreatRulebaseOutput(args: GetManagementThreatRulebaseOutputArgs, opts?: InvokeOptions): Output<GetManagementThreatRulebaseResult>

def get_management_threat_rulebase(dereference_group_members: Optional[bool] = None,
                                   filter: Optional[str] = None,
                                   filter_settings: Optional[GetManagementThreatRulebaseFilterSettings] = None,
                                   hits_settings: Optional[GetManagementThreatRulebaseHitsSettings] = None,
                                   id: Optional[str] = None,
                                   limit: Optional[float] = None,
                                   name: Optional[str] = None,
                                   offset: Optional[float] = None,
                                   orders: Optional[Sequence[GetManagementThreatRulebaseOrder]] = None,
                                   package: Optional[str] = None,
                                   show_as_ranges: Optional[bool] = None,
                                   show_hits: Optional[bool] = None,
                                   show_membership: Optional[bool] = None,
                                   uid: Optional[str] = None,
                                   opts: Optional[InvokeOptions] = None) -> GetManagementThreatRulebaseResult
def get_management_threat_rulebase_output(dereference_group_members: Optional[pulumi.Input[bool]] = None,
                                   filter: Optional[pulumi.Input[str]] = None,
                                   filter_settings: Optional[pulumi.Input[GetManagementThreatRulebaseFilterSettingsArgs]] = None,
                                   hits_settings: Optional[pulumi.Input[GetManagementThreatRulebaseHitsSettingsArgs]] = None,
                                   id: Optional[pulumi.Input[str]] = None,
                                   limit: Optional[pulumi.Input[float]] = None,
                                   name: Optional[pulumi.Input[str]] = None,
                                   offset: Optional[pulumi.Input[float]] = None,
                                   orders: Optional[pulumi.Input[Sequence[pulumi.Input[GetManagementThreatRulebaseOrderArgs]]]] = None,
                                   package: Optional[pulumi.Input[str]] = None,
                                   show_as_ranges: Optional[pulumi.Input[bool]] = None,
                                   show_hits: Optional[pulumi.Input[bool]] = None,
                                   show_membership: Optional[pulumi.Input[bool]] = None,
                                   uid: Optional[pulumi.Input[str]] = None,
                                   opts: Optional[InvokeOptions] = None) -> Output[GetManagementThreatRulebaseResult]

func GetManagementThreatRulebase(ctx *Context, args *GetManagementThreatRulebaseArgs, opts ...InvokeOption) (*GetManagementThreatRulebaseResult, error)
func GetManagementThreatRulebaseOutput(ctx *Context, args *GetManagementThreatRulebaseOutputArgs, opts ...InvokeOption) GetManagementThreatRulebaseResultOutput

> Note: This function is named GetManagementThreatRulebase in the Go SDK.

public static class GetManagementThreatRulebase 
{
    public static Task<GetManagementThreatRulebaseResult> InvokeAsync(GetManagementThreatRulebaseArgs args, InvokeOptions? opts = null)
    public static Output<GetManagementThreatRulebaseResult> Invoke(GetManagementThreatRulebaseInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetManagementThreatRulebaseResult> getManagementThreatRulebase(GetManagementThreatRulebaseArgs args, InvokeOptions options)
public static Output<GetManagementThreatRulebaseResult> getManagementThreatRulebase(GetManagementThreatRulebaseArgs args, InvokeOptions options)

fn::invoke:
  function: checkpoint:index/getManagementThreatRulebase:getManagementThreatRulebase
  arguments:
    # arguments dictionary

The following arguments are supported:

DereferenceGroupMembers bool: Indicates whether to dereference "members" field by details level for every object in reply.
Filter string: Search expression to filter the rulebase. The provided text should be exactly the same as it would be given in Smart Console. The logical operators in the expression ('AND', 'OR') should be provided in capital letters. If an operator is not used, the default OR operator applies.
FilterSettings GetManagementThreatRulebaseFilterSettings: Enable enforce end user domain. filter_settings blocks are documented below.
HitsSettings GetManagementThreatRulebaseHitsSettings
Id string
Limit double: The maximal number of returned results.
Name string: Object name. Must be unique in the domain.
Offset double: Number of the results to initially skip.
Orders List<GetManagementThreatRulebaseOrder>: Sorts the results by search criteria. Automatically sorts the results by Name, in the ascending order. orders blocks are documented below.
Package string: Name of the package.
ShowAsRanges bool
ShowHits bool
ShowMembership bool: Indicates whether to calculate and show "groups" field for every object in reply.
Uid string: Object unique identifier.

DereferenceGroupMembers bool: Indicates whether to dereference "members" field by details level for every object in reply.
Filter string: Search expression to filter the rulebase. The provided text should be exactly the same as it would be given in Smart Console. The logical operators in the expression ('AND', 'OR') should be provided in capital letters. If an operator is not used, the default OR operator applies.
FilterSettings GetManagementThreatRulebaseFilterSettings: Enable enforce end user domain. filter_settings blocks are documented below.
HitsSettings GetManagementThreatRulebaseHitsSettings
Id string
Limit float64: The maximal number of returned results.
Name string: Object name. Must be unique in the domain.
Offset float64: Number of the results to initially skip.
Orders []GetManagementThreatRulebaseOrder: Sorts the results by search criteria. Automatically sorts the results by Name, in the ascending order. orders blocks are documented below.
Package string: Name of the package.
ShowAsRanges bool
ShowHits bool
ShowMembership bool: Indicates whether to calculate and show "groups" field for every object in reply.
Uid string: Object unique identifier.

dereferenceGroupMembers Boolean: Indicates whether to dereference "members" field by details level for every object in reply.
filter String: Search expression to filter the rulebase. The provided text should be exactly the same as it would be given in Smart Console. The logical operators in the expression ('AND', 'OR') should be provided in capital letters. If an operator is not used, the default OR operator applies.
filterSettings GetManagementThreatRulebaseFilterSettings: Enable enforce end user domain. filter_settings blocks are documented below.
hitsSettings GetManagementThreatRulebaseHitsSettings
id String
limit Double: The maximal number of returned results.
name String: Object name. Must be unique in the domain.
offset Double: Number of the results to initially skip.
orders List<GetManagementThreatRulebaseOrder>: Sorts the results by search criteria. Automatically sorts the results by Name, in the ascending order. orders blocks are documented below.
package_ String: Name of the package.
showAsRanges Boolean
showHits Boolean
showMembership Boolean: Indicates whether to calculate and show "groups" field for every object in reply.
uid String: Object unique identifier.

dereferenceGroupMembers boolean: Indicates whether to dereference "members" field by details level for every object in reply.
filter string: Search expression to filter the rulebase. The provided text should be exactly the same as it would be given in Smart Console. The logical operators in the expression ('AND', 'OR') should be provided in capital letters. If an operator is not used, the default OR operator applies.
filterSettings GetManagementThreatRulebaseFilterSettings: Enable enforce end user domain. filter_settings blocks are documented below.
hitsSettings GetManagementThreatRulebaseHitsSettings
id string
limit number: The maximal number of returned results.
name string: Object name. Must be unique in the domain.
offset number: Number of the results to initially skip.
orders GetManagementThreatRulebaseOrder[]: Sorts the results by search criteria. Automatically sorts the results by Name, in the ascending order. orders blocks are documented below.
package string: Name of the package.
showAsRanges boolean
showHits boolean
showMembership boolean: Indicates whether to calculate and show "groups" field for every object in reply.
uid string: Object unique identifier.

dereference_group_members bool: Indicates whether to dereference "members" field by details level for every object in reply.
filter str: Search expression to filter the rulebase. The provided text should be exactly the same as it would be given in Smart Console. The logical operators in the expression ('AND', 'OR') should be provided in capital letters. If an operator is not used, the default OR operator applies.
filter_settings GetManagementThreatRulebaseFilterSettings: Enable enforce end user domain. filter_settings blocks are documented below.
hits_settings GetManagementThreatRulebaseHitsSettings
id str
limit float: The maximal number of returned results.
name str: Object name. Must be unique in the domain.
offset float: Number of the results to initially skip.
orders Sequence[GetManagementThreatRulebaseOrder]: Sorts the results by search criteria. Automatically sorts the results by Name, in the ascending order. orders blocks are documented below.
package str: Name of the package.
show_as_ranges bool
show_hits bool
show_membership bool: Indicates whether to calculate and show "groups" field for every object in reply.
uid str: Object unique identifier.

dereferenceGroupMembers Boolean: Indicates whether to dereference "members" field by details level for every object in reply.
filter String: Search expression to filter the rulebase. The provided text should be exactly the same as it would be given in Smart Console. The logical operators in the expression ('AND', 'OR') should be provided in capital letters. If an operator is not used, the default OR operator applies.
filterSettings Property Map: Enable enforce end user domain. filter_settings blocks are documented below.
hitsSettings Property Map
id String
limit Number: The maximal number of returned results.
name String: Object name. Must be unique in the domain.
offset Number: Number of the results to initially skip.
orders List<Property Map>: Sorts the results by search criteria. Automatically sorts the results by Name, in the ascending order. orders blocks are documented below.
package String: Name of the package.
showAsRanges Boolean
showHits Boolean
showMembership Boolean: Indicates whether to calculate and show "groups" field for every object in reply.
uid String: Object unique identifier.

getManagementThreatRulebase Result

The following output properties are available:

Id string
Rulebases List<GetManagementThreatRulebaseRulebase>
DereferenceGroupMembers bool
Filter string
FilterSettings GetManagementThreatRulebaseFilterSettings
HitsSettings GetManagementThreatRulebaseHitsSettings
Limit double
Name string
Offset double
Orders List<GetManagementThreatRulebaseOrder>
Package string
ShowAsRanges bool
ShowHits bool
ShowMembership bool
Uid string

Id string
Rulebases []GetManagementThreatRulebaseRulebase
DereferenceGroupMembers bool
Filter string
FilterSettings GetManagementThreatRulebaseFilterSettings
HitsSettings GetManagementThreatRulebaseHitsSettings
Limit float64
Name string
Offset float64
Orders []GetManagementThreatRulebaseOrder
Package string
ShowAsRanges bool
ShowHits bool
ShowMembership bool
Uid string

id String
rulebases List<GetManagementThreatRulebaseRulebase>
dereferenceGroupMembers Boolean
filter String
filterSettings GetManagementThreatRulebaseFilterSettings
hitsSettings GetManagementThreatRulebaseHitsSettings
limit Double
name String
offset Double
orders List<GetManagementThreatRulebaseOrder>
package_ String
showAsRanges Boolean
showHits Boolean
showMembership Boolean
uid String

id string
rulebases GetManagementThreatRulebaseRulebase[]
dereferenceGroupMembers boolean
filter string
filterSettings GetManagementThreatRulebaseFilterSettings
hitsSettings GetManagementThreatRulebaseHitsSettings
limit number
name string
offset number
orders GetManagementThreatRulebaseOrder[]
package string
showAsRanges boolean
showHits boolean
showMembership boolean
uid string

id str
rulebases Sequence[GetManagementThreatRulebaseRulebase]
dereference_group_members bool
filter str
filter_settings GetManagementThreatRulebaseFilterSettings
hits_settings GetManagementThreatRulebaseHitsSettings
limit float
name str
offset float
orders Sequence[GetManagementThreatRulebaseOrder]
package str
show_as_ranges bool
show_hits bool
show_membership bool
uid str

id String
rulebases List<Property Map>
dereferenceGroupMembers Boolean
filter String
filterSettings Property Map
hitsSettings Property Map
limit Number
name String
offset Number
orders List<Property Map>
package String
showAsRanges Boolean
showHits Boolean
showMembership Boolean
uid String

Supporting Types

GetManagementThreatRulebaseFilterSettings

ExpandGroupMembers bool: When true, if the search expression contains a UID or a name of a group object, results will include rules that match on at least one member of the group.
ExpandGroupWithExclusionMembers bool: When true, if the search expression contains a UID or a name of a group-with-exclusion object, results will include rules that match at least one member of the "include" part and is not a member of the "except" part.
MatchOnAny bool: Whether to match on 'Any' object.
MatchOnGroupWithExclusion bool: Whether to match on a group-with-exclusion.
MatchOnNegate bool: Whether to match on a negated cell.
SearchMode string: When set to 'general', both the Full Text Search and Packet Search are enabled. In this mode, Packet Search will not match on 'Any' object, a negated cell or a group-with-exclusion. When the search-mode is set to 'packet', by default, the match on 'Any' object, a negated cell or a group-with-exclusion are enabled. packet-search-settings may be provided to change the default behavior.

ExpandGroupMembers bool: When true, if the search expression contains a UID or a name of a group object, results will include rules that match on at least one member of the group.
ExpandGroupWithExclusionMembers bool: When true, if the search expression contains a UID or a name of a group-with-exclusion object, results will include rules that match at least one member of the "include" part and is not a member of the "except" part.
MatchOnAny bool: Whether to match on 'Any' object.
MatchOnGroupWithExclusion bool: Whether to match on a group-with-exclusion.
MatchOnNegate bool: Whether to match on a negated cell.
SearchMode string: When set to 'general', both the Full Text Search and Packet Search are enabled. In this mode, Packet Search will not match on 'Any' object, a negated cell or a group-with-exclusion. When the search-mode is set to 'packet', by default, the match on 'Any' object, a negated cell or a group-with-exclusion are enabled. packet-search-settings may be provided to change the default behavior.

expandGroupMembers Boolean: When true, if the search expression contains a UID or a name of a group object, results will include rules that match on at least one member of the group.
expandGroupWithExclusionMembers Boolean: When true, if the search expression contains a UID or a name of a group-with-exclusion object, results will include rules that match at least one member of the "include" part and is not a member of the "except" part.
matchOnAny Boolean: Whether to match on 'Any' object.
matchOnGroupWithExclusion Boolean: Whether to match on a group-with-exclusion.
matchOnNegate Boolean: Whether to match on a negated cell.
searchMode String: When set to 'general', both the Full Text Search and Packet Search are enabled. In this mode, Packet Search will not match on 'Any' object, a negated cell or a group-with-exclusion. When the search-mode is set to 'packet', by default, the match on 'Any' object, a negated cell or a group-with-exclusion are enabled. packet-search-settings may be provided to change the default behavior.

expandGroupMembers boolean: When true, if the search expression contains a UID or a name of a group object, results will include rules that match on at least one member of the group.
expandGroupWithExclusionMembers boolean: When true, if the search expression contains a UID or a name of a group-with-exclusion object, results will include rules that match at least one member of the "include" part and is not a member of the "except" part.
matchOnAny boolean: Whether to match on 'Any' object.
matchOnGroupWithExclusion boolean: Whether to match on a group-with-exclusion.
matchOnNegate boolean: Whether to match on a negated cell.
searchMode string: When set to 'general', both the Full Text Search and Packet Search are enabled. In this mode, Packet Search will not match on 'Any' object, a negated cell or a group-with-exclusion. When the search-mode is set to 'packet', by default, the match on 'Any' object, a negated cell or a group-with-exclusion are enabled. packet-search-settings may be provided to change the default behavior.

expand_group_members bool: When true, if the search expression contains a UID or a name of a group object, results will include rules that match on at least one member of the group.
expand_group_with_exclusion_members bool: When true, if the search expression contains a UID or a name of a group-with-exclusion object, results will include rules that match at least one member of the "include" part and is not a member of the "except" part.
match_on_any bool: Whether to match on 'Any' object.
match_on_group_with_exclusion bool: Whether to match on a group-with-exclusion.
match_on_negate bool: Whether to match on a negated cell.
search_mode str: When set to 'general', both the Full Text Search and Packet Search are enabled. In this mode, Packet Search will not match on 'Any' object, a negated cell or a group-with-exclusion. When the search-mode is set to 'packet', by default, the match on 'Any' object, a negated cell or a group-with-exclusion are enabled. packet-search-settings may be provided to change the default behavior.

expandGroupMembers Boolean: When true, if the search expression contains a UID or a name of a group object, results will include rules that match on at least one member of the group.
expandGroupWithExclusionMembers Boolean: When true, if the search expression contains a UID or a name of a group-with-exclusion object, results will include rules that match at least one member of the "include" part and is not a member of the "except" part.
matchOnAny Boolean: Whether to match on 'Any' object.
matchOnGroupWithExclusion Boolean: Whether to match on a group-with-exclusion.
matchOnNegate Boolean: Whether to match on a negated cell.
searchMode String: When set to 'general', both the Full Text Search and Packet Search are enabled. In this mode, Packet Search will not match on 'Any' object, a negated cell or a group-with-exclusion. When the search-mode is set to 'packet', by default, the match on 'Any' object, a negated cell or a group-with-exclusion are enabled. packet-search-settings may be provided to change the default behavior.