ibm 1.78.0, Apr 30 25

ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud

ibm.getCisRulesetEntrypointVersions

Explore with Pulumi AI

ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as ibm from "@pulumi/ibm";

const test = ibm.getCisRulesetEntrypointVersions({
    cisId: ibm_cis.instance.id,
    domainId: data.ibm_cis_domain.cis_domain.domain_id,
    phase: "http_request_firewall_managed",
    version: "2",
    listAll: false,
});

import pulumi
import pulumi_ibm as ibm

test = ibm.get_cis_ruleset_entrypoint_versions(cis_id=ibm_cis["instance"]["id"],
    domain_id=data["ibm_cis_domain"]["cis_domain"]["domain_id"],
    phase="http_request_firewall_managed",
    version="2",
    list_all=False)

package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/ibm"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ibm.GetCisRulesetEntrypointVersions(ctx, &ibm.GetCisRulesetEntrypointVersionsArgs{
			CisId:    ibm_cis.Instance.Id,
			DomainId: pulumi.StringRef(data.Ibm_cis_domain.Cis_domain.Domain_id),
			Phase:    "http_request_firewall_managed",
			Version:  pulumi.StringRef("2"),
			ListAll:  pulumi.BoolRef(false),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;

return await Deployment.RunAsync(() => 
{
    var test = Ibm.GetCisRulesetEntrypointVersions.Invoke(new()
    {
        CisId = ibm_cis.Instance.Id,
        DomainId = data.Ibm_cis_domain.Cis_domain.Domain_id,
        Phase = "http_request_firewall_managed",
        Version = "2",
        ListAll = false,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.IbmFunctions;
import com.pulumi.ibm.inputs.GetCisRulesetEntrypointVersionsArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var test = IbmFunctions.getCisRulesetEntrypointVersions(GetCisRulesetEntrypointVersionsArgs.builder()
            .cisId(ibm_cis.instance().id())
            .domainId(data.ibm_cis_domain().cis_domain().domain_id())
            .phase("http_request_firewall_managed")
            .version("2")
            .listAll(false)
            .build());

    }
}

variables:
  test:
    fn::invoke:
      function: ibm:getCisRulesetEntrypointVersions
      arguments:
        cisId: ${ibm_cis.instance.id}
        domainId: ${data.ibm_cis_domain.cis_domain.domain_id}
        phase: http_request_firewall_managed
        version: '2'
        listAll: false

Attributes reference

In addition to the argument reference list, you can access the following attribute references after your data source is created.

Attribute references when version is not provided.

result - (list)
- id - (string) Ruleset ID.
- description - (string) Description of the ruleset.
- kind - (string) The kind of the ruleset.
- Phase - (string) Phase of the ruleset.
- name - (string) Name of the ruleset.
- last updated - (string) Last update date of the ruleset.
- version - (string) Version of the ruleset.

Extra attributes when version is provide.

rules - (List) This list contains the information of rules associated with the Entry Point ruleset’s version.
Nested scheme of rules
- id (String). ID of the rule.
- version (String). Version of the rule.
- action (String). Action of the rule.
- description (String) Description of the rule.
- enable (Boolean) Enables/Disables the rule.
- expression (String) Expression used by the rule to match the incoming request.
- ref (String) ID of an referrenced rule.
- last_updated (String) Date and time of the last update was made on the rule.
- categories (List) List of categories.
- logging (Map)
  - enabled (Boolean) Logging is enabled or not.
- action_parameters (List) Action Parameters of the rule.
  Nested scheme of action_parameters
  - id (String) ID of the managed ruleset to be deployed.
  - overrides (List) Provides the parameters which are overridden.
    Nested scheme of overrides
    - action (String) Action of the rule. Examples: log, block, skip.
    - enabled (Boolean) Enables/Disables the rule.
    - sensitivity_level (String) Defines the sensitivity level of the rule.
    - rules (Optional, List) List of details of the managed rules which are overridden.
      Nested scheme of rules
      - id (String) ID of the rule.
      - enabled (Boolean) Enables/Disables the rule.
      - action (String) Action of the rule.
      - sensitivity_level (String) Defines the sensitivity level of the rule.
      - score_threshold (Int) Defines the score threshold of the rule.
    - categories (List)
      Nested scheme of categories
      - category (String) Category of the rule.
      - enabled (Boolean) Enables/Disables the rule.
      - action (String) Action of the rule.
  - version (String) Latest version.
  - ruleset (String) ID of the ruleset.
  - rulesets (List) IDs of the rulesets.
  - response (Map) Custom response from the API.
    - content (String) Content of the response.
    - content_type (string) Content type of the response.
    - status_code (Int) Status code returned by the API.

Using getCisRulesetEntrypointVersions

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 getCisRulesetEntrypointVersions(args: GetCisRulesetEntrypointVersionsArgs, opts?: InvokeOptions): Promise<GetCisRulesetEntrypointVersionsResult>
function getCisRulesetEntrypointVersionsOutput(args: GetCisRulesetEntrypointVersionsOutputArgs, opts?: InvokeOptions): Output<GetCisRulesetEntrypointVersionsResult>

def get_cis_ruleset_entrypoint_versions(cis_id: Optional[str] = None,
                                        domain_id: Optional[str] = None,
                                        id: Optional[str] = None,
                                        list_all: Optional[bool] = None,
                                        phase: Optional[str] = None,
                                        ruleset_id: Optional[str] = None,
                                        version: Optional[str] = None,
                                        opts: Optional[InvokeOptions] = None) -> GetCisRulesetEntrypointVersionsResult
def get_cis_ruleset_entrypoint_versions_output(cis_id: Optional[pulumi.Input[str]] = None,
                                        domain_id: Optional[pulumi.Input[str]] = None,
                                        id: Optional[pulumi.Input[str]] = None,
                                        list_all: Optional[pulumi.Input[bool]] = None,
                                        phase: Optional[pulumi.Input[str]] = None,
                                        ruleset_id: Optional[pulumi.Input[str]] = None,
                                        version: Optional[pulumi.Input[str]] = None,
                                        opts: Optional[InvokeOptions] = None) -> Output[GetCisRulesetEntrypointVersionsResult]

func GetCisRulesetEntrypointVersions(ctx *Context, args *GetCisRulesetEntrypointVersionsArgs, opts ...InvokeOption) (*GetCisRulesetEntrypointVersionsResult, error)
func GetCisRulesetEntrypointVersionsOutput(ctx *Context, args *GetCisRulesetEntrypointVersionsOutputArgs, opts ...InvokeOption) GetCisRulesetEntrypointVersionsResultOutput

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

public static class GetCisRulesetEntrypointVersions 
{
    public static Task<GetCisRulesetEntrypointVersionsResult> InvokeAsync(GetCisRulesetEntrypointVersionsArgs args, InvokeOptions? opts = null)
    public static Output<GetCisRulesetEntrypointVersionsResult> Invoke(GetCisRulesetEntrypointVersionsInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetCisRulesetEntrypointVersionsResult> getCisRulesetEntrypointVersions(GetCisRulesetEntrypointVersionsArgs args, InvokeOptions options)
public static Output<GetCisRulesetEntrypointVersionsResult> getCisRulesetEntrypointVersions(GetCisRulesetEntrypointVersionsArgs args, InvokeOptions options)

fn::invoke:
  function: ibm:index/getCisRulesetEntrypointVersions:getCisRulesetEntrypointVersions
  arguments:
    # arguments dictionary

The following arguments are supported:

CisId string: The ID of the CIS service instance.
Phase string: The phase of the ruleset.
DomainId string: The Domain/Zone ID of the CIS service instance. If domain_id is provided the request will be made at the zone/domain level otherwise the request will be made at the instance level.
Id string
ListAll bool: If you provide list_all as true then you will get a list which wil contain the information of all the ruleset's version. In this case you will not get the information of the rules associated with the rulesets. If you do not provide list_all argument or mark it as false then you will get the information of the latest version of the ruleset along with the information of associated rules.
RulesetId string
Version string: If version of the Entry Point ruleset is not provided then will get the information of the latest version of the ruleset along with the information of associated rules. If the version is provided then you will get the information of that particular version of the Entry Point ruleset along with the rules associated with it. If list_all is marked as true then you do not need to provide version. Even if you provide the value of version it won't make any effect on the request.

CisId string: The ID of the CIS service instance.
Phase string: The phase of the ruleset.
DomainId string: The Domain/Zone ID of the CIS service instance. If domain_id is provided the request will be made at the zone/domain level otherwise the request will be made at the instance level.
Id string
ListAll bool: If you provide list_all as true then you will get a list which wil contain the information of all the ruleset's version. In this case you will not get the information of the rules associated with the rulesets. If you do not provide list_all argument or mark it as false then you will get the information of the latest version of the ruleset along with the information of associated rules.
RulesetId string
Version string: If version of the Entry Point ruleset is not provided then will get the information of the latest version of the ruleset along with the information of associated rules. If the version is provided then you will get the information of that particular version of the Entry Point ruleset along with the rules associated with it. If list_all is marked as true then you do not need to provide version. Even if you provide the value of version it won't make any effect on the request.

cisId String: The ID of the CIS service instance.
phase String: The phase of the ruleset.
domainId String: The Domain/Zone ID of the CIS service instance. If domain_id is provided the request will be made at the zone/domain level otherwise the request will be made at the instance level.
id String
listAll Boolean: If you provide list_all as true then you will get a list which wil contain the information of all the ruleset's version. In this case you will not get the information of the rules associated with the rulesets. If you do not provide list_all argument or mark it as false then you will get the information of the latest version of the ruleset along with the information of associated rules.
rulesetId String
version String: If version of the Entry Point ruleset is not provided then will get the information of the latest version of the ruleset along with the information of associated rules. If the version is provided then you will get the information of that particular version of the Entry Point ruleset along with the rules associated with it. If list_all is marked as true then you do not need to provide version. Even if you provide the value of version it won't make any effect on the request.

cisId string: The ID of the CIS service instance.
phase string: The phase of the ruleset.
domainId string: The Domain/Zone ID of the CIS service instance. If domain_id is provided the request will be made at the zone/domain level otherwise the request will be made at the instance level.
id string
listAll boolean: If you provide list_all as true then you will get a list which wil contain the information of all the ruleset's version. In this case you will not get the information of the rules associated with the rulesets. If you do not provide list_all argument or mark it as false then you will get the information of the latest version of the ruleset along with the information of associated rules.
rulesetId string
version string: If version of the Entry Point ruleset is not provided then will get the information of the latest version of the ruleset along with the information of associated rules. If the version is provided then you will get the information of that particular version of the Entry Point ruleset along with the rules associated with it. If list_all is marked as true then you do not need to provide version. Even if you provide the value of version it won't make any effect on the request.

cis_id str: The ID of the CIS service instance.
phase str: The phase of the ruleset.
domain_id str: The Domain/Zone ID of the CIS service instance. If domain_id is provided the request will be made at the zone/domain level otherwise the request will be made at the instance level.
id str
list_all bool: If you provide list_all as true then you will get a list which wil contain the information of all the ruleset's version. In this case you will not get the information of the rules associated with the rulesets. If you do not provide list_all argument or mark it as false then you will get the information of the latest version of the ruleset along with the information of associated rules.
ruleset_id str
version str: If version of the Entry Point ruleset is not provided then will get the information of the latest version of the ruleset along with the information of associated rules. If the version is provided then you will get the information of that particular version of the Entry Point ruleset along with the rules associated with it. If list_all is marked as true then you do not need to provide version. Even if you provide the value of version it won't make any effect on the request.

cisId String: The ID of the CIS service instance.
phase String: The phase of the ruleset.
domainId String: The Domain/Zone ID of the CIS service instance. If domain_id is provided the request will be made at the zone/domain level otherwise the request will be made at the instance level.
id String
listAll Boolean: If you provide list_all as true then you will get a list which wil contain the information of all the ruleset's version. In this case you will not get the information of the rules associated with the rulesets. If you do not provide list_all argument or mark it as false then you will get the information of the latest version of the ruleset along with the information of associated rules.
rulesetId String
version String: If version of the Entry Point ruleset is not provided then will get the information of the latest version of the ruleset along with the information of associated rules. If the version is provided then you will get the information of that particular version of the Entry Point ruleset along with the rules associated with it. If list_all is marked as true then you do not need to provide version. Even if you provide the value of version it won't make any effect on the request.

getCisRulesetEntrypointVersions Result

The following output properties are available:

CisId string
Id string
Phase string
Rulesets List<GetCisRulesetEntrypointVersionsRuleset>
DomainId string
ListAll bool
RulesetId string
Version string

CisId string
Id string
Phase string
Rulesets []GetCisRulesetEntrypointVersionsRuleset
DomainId string
ListAll bool
RulesetId string
Version string

cisId String
id String
phase String
rulesets List<GetCisRulesetEntrypointVersionsRuleset>
domainId String
listAll Boolean
rulesetId String
version String

cisId string
id string
phase string
rulesets GetCisRulesetEntrypointVersionsRuleset[]
domainId string
listAll boolean
rulesetId string
version string

cis_id str
id str
phase str
rulesets Sequence[GetCisRulesetEntrypointVersionsRuleset]
domain_id str
list_all bool
ruleset_id str
version str

cisId String
id String
phase String
rulesets List<Property Map>
domainId String
listAll Boolean
rulesetId String
version String

Supporting Types

GetCisRulesetEntrypointVersionsRuleset

Description string
Kind string
LastUpdated string
Name string
Phase string: The phase of the ruleset.
Rules List<GetCisRulesetEntrypointVersionsRulesetRule>
RulesetId string
Version string: If version of the Entry Point ruleset is not provided then will get the information of the latest version of the ruleset along with the information of associated rules. If the version is provided then you will get the information of that particular version of the Entry Point ruleset along with the rules associated with it. If list_all is marked as true then you do not need to provide version. Even if you provide the value of version it won't make any effect on the request.

Description string
Kind string
LastUpdated string
Name string
Phase string: The phase of the ruleset.
Rules []GetCisRulesetEntrypointVersionsRulesetRule
RulesetId string
Version string: If version of the Entry Point ruleset is not provided then will get the information of the latest version of the ruleset along with the information of associated rules. If the version is provided then you will get the information of that particular version of the Entry Point ruleset along with the rules associated with it. If list_all is marked as true then you do not need to provide version. Even if you provide the value of version it won't make any effect on the request.

description String
kind String
lastUpdated String
name String
phase String: The phase of the ruleset.
rules List<GetCisRulesetEntrypointVersionsRulesetRule>
rulesetId String
version String: If version of the Entry Point ruleset is not provided then will get the information of the latest version of the ruleset along with the information of associated rules. If the version is provided then you will get the information of that particular version of the Entry Point ruleset along with the rules associated with it. If list_all is marked as true then you do not need to provide version. Even if you provide the value of version it won't make any effect on the request.

description string
kind string
lastUpdated string
name string
phase string: The phase of the ruleset.
rules GetCisRulesetEntrypointVersionsRulesetRule[]
rulesetId string
version string: If version of the Entry Point ruleset is not provided then will get the information of the latest version of the ruleset along with the information of associated rules. If the version is provided then you will get the information of that particular version of the Entry Point ruleset along with the rules associated with it. If list_all is marked as true then you do not need to provide version. Even if you provide the value of version it won't make any effect on the request.

description str
kind str
last_updated str
name str
phase str: The phase of the ruleset.
rules Sequence[GetCisRulesetEntrypointVersionsRulesetRule]
ruleset_id str
version str: If version of the Entry Point ruleset is not provided then will get the information of the latest version of the ruleset along with the information of associated rules. If the version is provided then you will get the information of that particular version of the Entry Point ruleset along with the rules associated with it. If list_all is marked as true then you do not need to provide version. Even if you provide the value of version it won't make any effect on the request.

description String
kind String
lastUpdated String
name String
phase String: The phase of the ruleset.
rules List<Property Map>
rulesetId String
version String: If version of the Entry Point ruleset is not provided then will get the information of the latest version of the ruleset along with the information of associated rules. If the version is provided then you will get the information of that particular version of the Entry Point ruleset along with the rules associated with it. If list_all is marked as true then you do not need to provide version. Even if you provide the value of version it won't make any effect on the request.

GetCisRulesetEntrypointVersionsRulesetRule

Action string
ActionParameters List<GetCisRulesetEntrypointVersionsRulesetRuleActionParameter>
Categories List<string>
Description string
Enabled bool
Expression string
Id string
LastUpdatedAt string
Logging Dictionary<string, bool>
Ref string
Version string: If version of the Entry Point ruleset is not provided then will get the information of the latest version of the ruleset along with the information of associated rules. If the version is provided then you will get the information of that particular version of the Entry Point ruleset along with the rules associated with it. If list_all is marked as true then you do not need to provide version. Even if you provide the value of version it won't make any effect on the request.

Action string
ActionParameters []GetCisRulesetEntrypointVersionsRulesetRuleActionParameter
Categories []string
Description string
Enabled bool
Expression string
Id string
LastUpdatedAt string
Logging map[string]bool
Ref string
Version string: If version of the Entry Point ruleset is not provided then will get the information of the latest version of the ruleset along with the information of associated rules. If the version is provided then you will get the information of that particular version of the Entry Point ruleset along with the rules associated with it. If list_all is marked as true then you do not need to provide version. Even if you provide the value of version it won't make any effect on the request.

action String
actionParameters List<GetCisRulesetEntrypointVersionsRulesetRuleActionParameter>
categories List<String>
description String
enabled Boolean
expression String
id String
lastUpdatedAt String
logging Map<String,Boolean>
ref String
version String: If version of the Entry Point ruleset is not provided then will get the information of the latest version of the ruleset along with the information of associated rules. If the version is provided then you will get the information of that particular version of the Entry Point ruleset along with the rules associated with it. If list_all is marked as true then you do not need to provide version. Even if you provide the value of version it won't make any effect on the request.

action string
actionParameters GetCisRulesetEntrypointVersionsRulesetRuleActionParameter[]
categories string[]
description string
enabled boolean
expression string
id string
lastUpdatedAt string
logging {[key: string]: boolean}
ref string
version string: If version of the Entry Point ruleset is not provided then will get the information of the latest version of the ruleset along with the information of associated rules. If the version is provided then you will get the information of that particular version of the Entry Point ruleset along with the rules associated with it. If list_all is marked as true then you do not need to provide version. Even if you provide the value of version it won't make any effect on the request.

action str
action_parameters Sequence[GetCisRulesetEntrypointVersionsRulesetRuleActionParameter]
categories Sequence[str]
description str
enabled bool
expression str
id str
last_updated_at str
logging Mapping[str, bool]
ref str
version str: If version of the Entry Point ruleset is not provided then will get the information of the latest version of the ruleset along with the information of associated rules. If the version is provided then you will get the information of that particular version of the Entry Point ruleset along with the rules associated with it. If list_all is marked as true then you do not need to provide version. Even if you provide the value of version it won't make any effect on the request.

action String
actionParameters List<Property Map>
categories List<String>
description String
enabled Boolean
expression String
id String
lastUpdatedAt String
logging Map<Boolean>
ref String
version String: If version of the Entry Point ruleset is not provided then will get the information of the latest version of the ruleset along with the information of associated rules. If the version is provided then you will get the information of that particular version of the Entry Point ruleset along with the rules associated with it. If list_all is marked as true then you do not need to provide version. Even if you provide the value of version it won't make any effect on the request.

GetCisRulesetEntrypointVersionsRulesetRuleActionParameter

Id string
Overrides List<GetCisRulesetEntrypointVersionsRulesetRuleActionParameterOverride>
Responses List<GetCisRulesetEntrypointVersionsRulesetRuleActionParameterResponse>
Ruleset string
Rulesets List<string>
Version string: If version of the Entry Point ruleset is not provided then will get the information of the latest version of the ruleset along with the information of associated rules. If the version is provided then you will get the information of that particular version of the Entry Point ruleset along with the rules associated with it. If list_all is marked as true then you do not need to provide version. Even if you provide the value of version it won't make any effect on the request.

Id string
Overrides []GetCisRulesetEntrypointVersionsRulesetRuleActionParameterOverride
Responses []GetCisRulesetEntrypointVersionsRulesetRuleActionParameterResponse
Ruleset string
Rulesets []string
Version string: If version of the Entry Point ruleset is not provided then will get the information of the latest version of the ruleset along with the information of associated rules. If the version is provided then you will get the information of that particular version of the Entry Point ruleset along with the rules associated with it. If list_all is marked as true then you do not need to provide version. Even if you provide the value of version it won't make any effect on the request.

id String
overrides List<GetCisRulesetEntrypointVersionsRulesetRuleActionParameterOverride>
responses List<GetCisRulesetEntrypointVersionsRulesetRuleActionParameterResponse>
ruleset String
rulesets List<String>
version String: If version of the Entry Point ruleset is not provided then will get the information of the latest version of the ruleset along with the information of associated rules. If the version is provided then you will get the information of that particular version of the Entry Point ruleset along with the rules associated with it. If list_all is marked as true then you do not need to provide version. Even if you provide the value of version it won't make any effect on the request.

id string
overrides GetCisRulesetEntrypointVersionsRulesetRuleActionParameterOverride[]
responses GetCisRulesetEntrypointVersionsRulesetRuleActionParameterResponse[]
ruleset string
rulesets string[]
version string: If version of the Entry Point ruleset is not provided then will get the information of the latest version of the ruleset along with the information of associated rules. If the version is provided then you will get the information of that particular version of the Entry Point ruleset along with the rules associated with it. If list_all is marked as true then you do not need to provide version. Even if you provide the value of version it won't make any effect on the request.

id str
overrides Sequence[GetCisRulesetEntrypointVersionsRulesetRuleActionParameterOverride]
responses Sequence[GetCisRulesetEntrypointVersionsRulesetRuleActionParameterResponse]
ruleset str
rulesets Sequence[str]
version str: If version of the Entry Point ruleset is not provided then will get the information of the latest version of the ruleset along with the information of associated rules. If the version is provided then you will get the information of that particular version of the Entry Point ruleset along with the rules associated with it. If list_all is marked as true then you do not need to provide version. Even if you provide the value of version it won't make any effect on the request.

id String
overrides List<Property Map>
responses List<Property Map>
ruleset String
rulesets List<String>
version String: If version of the Entry Point ruleset is not provided then will get the information of the latest version of the ruleset along with the information of associated rules. If the version is provided then you will get the information of that particular version of the Entry Point ruleset along with the rules associated with it. If list_all is marked as true then you do not need to provide version. Even if you provide the value of version it won't make any effect on the request.