ibm 1.78.0, Apr 30 25

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

ibm.getCisRateLimit

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 ratelimit = ibm.getCisRateLimit({
    cisId: data.ibm_cis.cis.id,
    domainId: data.ibm_cis_domain.cis_domain.domain_id,
});

import pulumi
import pulumi_ibm as ibm

ratelimit = ibm.get_cis_rate_limit(cis_id=data["ibm_cis"]["cis"]["id"],
    domain_id=data["ibm_cis_domain"]["cis_domain"]["domain_id"])

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.LookupCisRateLimit(ctx, &ibm.LookupCisRateLimitArgs{
			CisId:    data.Ibm_cis.Cis.Id,
			DomainId: data.Ibm_cis_domain.Cis_domain.Domain_id,
		}, 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 ratelimit = Ibm.GetCisRateLimit.Invoke(new()
    {
        CisId = data.Ibm_cis.Cis.Id,
        DomainId = data.Ibm_cis_domain.Cis_domain.Domain_id,
    });

});

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.GetCisRateLimitArgs;
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 ratelimit = IbmFunctions.getCisRateLimit(GetCisRateLimitArgs.builder()
            .cisId(data.ibm_cis().cis().id())
            .domainId(data.ibm_cis_domain().cis_domain().domain_id())
            .build());

    }
}

variables:
  ratelimit:
    fn::invoke:
      function: ibm:getCisRateLimit
      arguments:
        cisId: ${data.ibm_cis.cis.id}
        domainId: ${data.ibm_cis_domain.cis_domain.domain_id}

Using getCisRateLimit

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 getCisRateLimit(args: GetCisRateLimitArgs, opts?: InvokeOptions): Promise<GetCisRateLimitResult>
function getCisRateLimitOutput(args: GetCisRateLimitOutputArgs, opts?: InvokeOptions): Output<GetCisRateLimitResult>

def get_cis_rate_limit(cis_id: Optional[str] = None,
                       domain_id: Optional[str] = None,
                       id: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetCisRateLimitResult
def get_cis_rate_limit_output(cis_id: Optional[pulumi.Input[str]] = None,
                       domain_id: Optional[pulumi.Input[str]] = None,
                       id: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetCisRateLimitResult]

func LookupCisRateLimit(ctx *Context, args *LookupCisRateLimitArgs, opts ...InvokeOption) (*LookupCisRateLimitResult, error)
func LookupCisRateLimitOutput(ctx *Context, args *LookupCisRateLimitOutputArgs, opts ...InvokeOption) LookupCisRateLimitResultOutput

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

public static class GetCisRateLimit 
{
    public static Task<GetCisRateLimitResult> InvokeAsync(GetCisRateLimitArgs args, InvokeOptions? opts = null)
    public static Output<GetCisRateLimitResult> Invoke(GetCisRateLimitInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetCisRateLimitResult> getCisRateLimit(GetCisRateLimitArgs args, InvokeOptions options)
public static Output<GetCisRateLimitResult> getCisRateLimit(GetCisRateLimitArgs args, InvokeOptions options)

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

The following arguments are supported:

CisId string

The ID of the IBM Cloud Internet Services instance where you created the rate limiting rule.

DomainId string

The ID of the domain where you created the rate limiting rule.

Note

To get a custom rate limit rule the CIS instance must have an enterprise plan.

Id string

(String) The record ID of the rate limiting rule in the format <rule_ID>:<domain_ID>:<cis_ID>.

CisId string

The ID of the IBM Cloud Internet Services instance where you created the rate limiting rule.

DomainId string

The ID of the domain where you created the rate limiting rule.

Note

To get a custom rate limit rule the CIS instance must have an enterprise plan.

Id string

(String) The record ID of the rate limiting rule in the format <rule_ID>:<domain_ID>:<cis_ID>.

cisId String

The ID of the IBM Cloud Internet Services instance where you created the rate limiting rule.

domainId String

The ID of the domain where you created the rate limiting rule.

Note

To get a custom rate limit rule the CIS instance must have an enterprise plan.

id String

(String) The record ID of the rate limiting rule in the format <rule_ID>:<domain_ID>:<cis_ID>.

cisId string

The ID of the IBM Cloud Internet Services instance where you created the rate limiting rule.

domainId string

The ID of the domain where you created the rate limiting rule.

Note

To get a custom rate limit rule the CIS instance must have an enterprise plan.

id string

(String) The record ID of the rate limiting rule in the format <rule_ID>:<domain_ID>:<cis_ID>.

cis_id str

The ID of the IBM Cloud Internet Services instance where you created the rate limiting rule.

domain_id str

The ID of the domain where you created the rate limiting rule.

Note

To get a custom rate limit rule the CIS instance must have an enterprise plan.

id str

(String) The record ID of the rate limiting rule in the format <rule_ID>:<domain_ID>:<cis_ID>.

cisId String

The ID of the IBM Cloud Internet Services instance where you created the rate limiting rule.

domainId String

The ID of the domain where you created the rate limiting rule.

Note

To get a custom rate limit rule the CIS instance must have an enterprise plan.

id String

(String) The record ID of the rate limiting rule in the format <rule_ID>:<domain_ID>:<cis_ID>.

getCisRateLimit Result

The following output properties are available:

CisId string
DomainId string
Id string: (String) The record ID of the rate limiting rule in the format <rule_ID>:<domain_ID>:<cis_ID>.
RateLimits List<GetCisRateLimitRateLimit>

CisId string
DomainId string
Id string: (String) The record ID of the rate limiting rule in the format <rule_ID>:<domain_ID>:<cis_ID>.
RateLimits []GetCisRateLimitRateLimit

cisId String
domainId String
id String: (String) The record ID of the rate limiting rule in the format <rule_ID>:<domain_ID>:<cis_ID>.
rateLimits List<GetCisRateLimitRateLimit>

cisId string
domainId string
id string: (String) The record ID of the rate limiting rule in the format <rule_ID>:<domain_ID>:<cis_ID>.
rateLimits GetCisRateLimitRateLimit[]

cis_id str
domain_id str
id str: (String) The record ID of the rate limiting rule in the format <rule_ID>:<domain_ID>:<cis_ID>.
rate_limits Sequence[GetCisRateLimitRateLimit]

cisId String
domainId String
id String: (String) The record ID of the rate limiting rule in the format <rule_ID>:<domain_ID>:<cis_ID>.
rateLimits List<Property Map>

Supporting Types

GetCisRateLimitRateLimit

Actions List<GetCisRateLimitRateLimitAction>: (List of actions) A list of actions that you want to perform when incoming requests exceed the specified threshold.
Bypasses List<GetCisRateLimitRateLimitBypass>: (List of bypass criteria) A list of key-value pairs that, when matched, allow the rate limiting rule to be ignored.
Correlates List<GetCisRateLimitRateLimitCorrelate>: (List of NAT based rate limits) If provided, NAT-based rate limiting is enabled.
Description string: (String) The description for your rate limiting rule.
Disabled bool: (Bool) If set to true, rate limiting is disabled for the domain.
Matches List<GetCisRateLimitRateLimitMatch>: (List of matching rules) A list of characteristics that incoming network traffic must match to be counted toward the threshold.
Period double: (Integer) The period of time in seconds where incoming requests to a domain are counted. If the number of requests exceeds the threshold, then connections to the domain are refused. The period value can be between 1 and 3600.
RuleId string: (String) The ID of the rate limiting rule.
Threshold double: (Integer) The number of requests received within a specific time period (period) before connections to the domain are refused. The threshold value can be between 2 and 1000000.

Actions []GetCisRateLimitRateLimitAction: (List of actions) A list of actions that you want to perform when incoming requests exceed the specified threshold.
Bypasses []GetCisRateLimitRateLimitBypass: (List of bypass criteria) A list of key-value pairs that, when matched, allow the rate limiting rule to be ignored.
Correlates []GetCisRateLimitRateLimitCorrelate: (List of NAT based rate limits) If provided, NAT-based rate limiting is enabled.
Description string: (String) The description for your rate limiting rule.
Disabled bool: (Bool) If set to true, rate limiting is disabled for the domain.
Matches []GetCisRateLimitRateLimitMatch: (List of matching rules) A list of characteristics that incoming network traffic must match to be counted toward the threshold.
Period float64: (Integer) The period of time in seconds where incoming requests to a domain are counted. If the number of requests exceeds the threshold, then connections to the domain are refused. The period value can be between 1 and 3600.
RuleId string: (String) The ID of the rate limiting rule.
Threshold float64: (Integer) The number of requests received within a specific time period (period) before connections to the domain are refused. The threshold value can be between 2 and 1000000.

actions List<GetCisRateLimitRateLimitAction>: (List of actions) A list of actions that you want to perform when incoming requests exceed the specified threshold.
bypasses List<GetCisRateLimitRateLimitBypass>: (List of bypass criteria) A list of key-value pairs that, when matched, allow the rate limiting rule to be ignored.
correlates List<GetCisRateLimitRateLimitCorrelate>: (List of NAT based rate limits) If provided, NAT-based rate limiting is enabled.
description String: (String) The description for your rate limiting rule.
disabled Boolean: (Bool) If set to true, rate limiting is disabled for the domain.
matches List<GetCisRateLimitRateLimitMatch>: (List of matching rules) A list of characteristics that incoming network traffic must match to be counted toward the threshold.
period Double: (Integer) The period of time in seconds where incoming requests to a domain are counted. If the number of requests exceeds the threshold, then connections to the domain are refused. The period value can be between 1 and 3600.
ruleId String: (String) The ID of the rate limiting rule.
threshold Double: (Integer) The number of requests received within a specific time period (period) before connections to the domain are refused. The threshold value can be between 2 and 1000000.

actions GetCisRateLimitRateLimitAction[]: (List of actions) A list of actions that you want to perform when incoming requests exceed the specified threshold.
bypasses GetCisRateLimitRateLimitBypass[]: (List of bypass criteria) A list of key-value pairs that, when matched, allow the rate limiting rule to be ignored.
correlates GetCisRateLimitRateLimitCorrelate[]: (List of NAT based rate limits) If provided, NAT-based rate limiting is enabled.
description string: (String) The description for your rate limiting rule.
disabled boolean: (Bool) If set to true, rate limiting is disabled for the domain.
matches GetCisRateLimitRateLimitMatch[]: (List of matching rules) A list of characteristics that incoming network traffic must match to be counted toward the threshold.
period number: (Integer) The period of time in seconds where incoming requests to a domain are counted. If the number of requests exceeds the threshold, then connections to the domain are refused. The period value can be between 1 and 3600.
ruleId string: (String) The ID of the rate limiting rule.
threshold number: (Integer) The number of requests received within a specific time period (period) before connections to the domain are refused. The threshold value can be between 2 and 1000000.

actions Sequence[GetCisRateLimitRateLimitAction]: (List of actions) A list of actions that you want to perform when incoming requests exceed the specified threshold.
bypasses Sequence[GetCisRateLimitRateLimitBypass]: (List of bypass criteria) A list of key-value pairs that, when matched, allow the rate limiting rule to be ignored.
correlates Sequence[GetCisRateLimitRateLimitCorrelate]: (List of NAT based rate limits) If provided, NAT-based rate limiting is enabled.
description str: (String) The description for your rate limiting rule.
disabled bool: (Bool) If set to true, rate limiting is disabled for the domain.
matches Sequence[GetCisRateLimitRateLimitMatch]: (List of matching rules) A list of characteristics that incoming network traffic must match to be counted toward the threshold.
period float: (Integer) The period of time in seconds where incoming requests to a domain are counted. If the number of requests exceeds the threshold, then connections to the domain are refused. The period value can be between 1 and 3600.
rule_id str: (String) The ID of the rate limiting rule.
threshold float: (Integer) The number of requests received within a specific time period (period) before connections to the domain are refused. The threshold value can be between 2 and 1000000.

actions List<Property Map>: (List of actions) A list of actions that you want to perform when incoming requests exceed the specified threshold.
bypasses List<Property Map>: (List of bypass criteria) A list of key-value pairs that, when matched, allow the rate limiting rule to be ignored.
correlates List<Property Map>: (List of NAT based rate limits) If provided, NAT-based rate limiting is enabled.
description String: (String) The description for your rate limiting rule.
disabled Boolean: (Bool) If set to true, rate limiting is disabled for the domain.
matches List<Property Map>: (List of matching rules) A list of characteristics that incoming network traffic must match to be counted toward the threshold.
period Number: (Integer) The period of time in seconds where incoming requests to a domain are counted. If the number of requests exceeds the threshold, then connections to the domain are refused. The period value can be between 1 and 3600.
ruleId String: (String) The ID of the rate limiting rule.
threshold Number: (Integer) The number of requests received within a specific time period (period) before connections to the domain are refused. The threshold value can be between 2 and 1000000.

GetCisRateLimitRateLimitAction

Mode string: (String) The type of action that you want to perform. Supported values are simulate, ban, challenge, or js_challenge. For more information, about each type, see Configure response.
Responses List<GetCisRateLimitRateLimitActionResponse>: (List of HTTP responses) A list of HTTP responses that outgoing packets must match before they can be returned to the client. If an incoming request matches the request criteria, but the response does not match the response criteria, then the request packet is not counted toward the threshold.
Timeout double: (Integer) The time to wait in seconds before the action is performed. The timeout must be equal to or greater than the period and is valid only for actions of type simulate or ban. The value can be between 10 and 86400.

Mode string: (String) The type of action that you want to perform. Supported values are simulate, ban, challenge, or js_challenge. For more information, about each type, see Configure response.
Responses []GetCisRateLimitRateLimitActionResponse: (List of HTTP responses) A list of HTTP responses that outgoing packets must match before they can be returned to the client. If an incoming request matches the request criteria, but the response does not match the response criteria, then the request packet is not counted toward the threshold.
Timeout float64: (Integer) The time to wait in seconds before the action is performed. The timeout must be equal to or greater than the period and is valid only for actions of type simulate or ban. The value can be between 10 and 86400.

mode String: (String) The type of action that you want to perform. Supported values are simulate, ban, challenge, or js_challenge. For more information, about each type, see Configure response.
responses List<GetCisRateLimitRateLimitActionResponse>: (List of HTTP responses) A list of HTTP responses that outgoing packets must match before they can be returned to the client. If an incoming request matches the request criteria, but the response does not match the response criteria, then the request packet is not counted toward the threshold.
timeout Double: (Integer) The time to wait in seconds before the action is performed. The timeout must be equal to or greater than the period and is valid only for actions of type simulate or ban. The value can be between 10 and 86400.

mode string: (String) The type of action that you want to perform. Supported values are simulate, ban, challenge, or js_challenge. For more information, about each type, see Configure response.
responses GetCisRateLimitRateLimitActionResponse[]: (List of HTTP responses) A list of HTTP responses that outgoing packets must match before they can be returned to the client. If an incoming request matches the request criteria, but the response does not match the response criteria, then the request packet is not counted toward the threshold.
timeout number: (Integer) The time to wait in seconds before the action is performed. The timeout must be equal to or greater than the period and is valid only for actions of type simulate or ban. The value can be between 10 and 86400.

mode str: (String) The type of action that you want to perform. Supported values are simulate, ban, challenge, or js_challenge. For more information, about each type, see Configure response.
responses Sequence[GetCisRateLimitRateLimitActionResponse]: (List of HTTP responses) A list of HTTP responses that outgoing packets must match before they can be returned to the client. If an incoming request matches the request criteria, but the response does not match the response criteria, then the request packet is not counted toward the threshold.
timeout float: (Integer) The time to wait in seconds before the action is performed. The timeout must be equal to or greater than the period and is valid only for actions of type simulate or ban. The value can be between 10 and 86400.

mode String: (String) The type of action that you want to perform. Supported values are simulate, ban, challenge, or js_challenge. For more information, about each type, see Configure response.
responses List<Property Map>: (List of HTTP responses) A list of HTTP responses that outgoing packets must match before they can be returned to the client. If an incoming request matches the request criteria, but the response does not match the response criteria, then the request packet is not counted toward the threshold.
timeout Number: (Integer) The time to wait in seconds before the action is performed. The timeout must be equal to or greater than the period and is valid only for actions of type simulate or ban. The value can be between 10 and 86400.

GetCisRateLimitRateLimitActionResponse

Body string: (String) The body of the response that you want to return to the client. The information must match the content_type that you specified. The value can have a maximum length of 1024.
ContentType string: (String) The content-type of the body that you want to return. Supported values are text/plain, text/xml, and application/json.

Body string: (String) The body of the response that you want to return to the client. The information must match the content_type that you specified. The value can have a maximum length of 1024.
ContentType string: (String) The content-type of the body that you want to return. Supported values are text/plain, text/xml, and application/json.

body String: (String) The body of the response that you want to return to the client. The information must match the content_type that you specified. The value can have a maximum length of 1024.
contentType String: (String) The content-type of the body that you want to return. Supported values are text/plain, text/xml, and application/json.

body string: (String) The body of the response that you want to return to the client. The information must match the content_type that you specified. The value can have a maximum length of 1024.
contentType string: (String) The content-type of the body that you want to return. Supported values are text/plain, text/xml, and application/json.

body str: (String) The body of the response that you want to return to the client. The information must match the content_type that you specified. The value can have a maximum length of 1024.
content_type str: (String) The content-type of the body that you want to return. Supported values are text/plain, text/xml, and application/json.

body String: (String) The body of the response that you want to return to the client. The information must match the content_type that you specified. The value can have a maximum length of 1024.
contentType String: (String) The content-type of the body that you want to return. Supported values are text/plain, text/xml, and application/json.

GetCisRateLimitRateLimitBypass

Name string: (String) The name of the HTTP response header.
Value string: (String) The value that the HTTP response header must match.

Name string: (String) The name of the HTTP response header.
Value string: (String) The value that the HTTP response header must match.

name String: (String) The name of the HTTP response header.
value String: (String) The value that the HTTP response header must match.

name string: (String) The name of the HTTP response header.
value string: (String) The value that the HTTP response header must match.

name str: (String) The name of the HTTP response header.
value str: (String) The value that the HTTP response header must match.

name String: (String) The name of the HTTP response header.
value String: (String) The value that the HTTP response header must match.

GetCisRateLimitRateLimitCorrelate

By string: (String) If set to nat, NAT-based rate limiting is enabled.

By string: (String) If set to nat, NAT-based rate limiting is enabled.

by String: (String) If set to nat, NAT-based rate limiting is enabled.

by string: (String) If set to nat, NAT-based rate limiting is enabled.

by str: (String) If set to nat, NAT-based rate limiting is enabled.

by String: (String) If set to nat, NAT-based rate limiting is enabled.

GetCisRateLimitRateLimitMatch

Requests List<GetCisRateLimitRateLimitMatchRequest>: (List of request characteristics) A list of characteristics that the incoming request must match to be counted toward the threshold. If no list is provided, all incoming requests are counted toward the threshold.
Responses List<GetCisRateLimitRateLimitMatchResponse>: (List of HTTP responses) A list of HTTP responses that outgoing packets must match before they can be returned to the client. If an incoming request matches the request criteria, but the response does not match the response criteria, then the request packet is not counted toward the threshold.

Requests []GetCisRateLimitRateLimitMatchRequest: (List of request characteristics) A list of characteristics that the incoming request must match to be counted toward the threshold. If no list is provided, all incoming requests are counted toward the threshold.
Responses []GetCisRateLimitRateLimitMatchResponse: (List of HTTP responses) A list of HTTP responses that outgoing packets must match before they can be returned to the client. If an incoming request matches the request criteria, but the response does not match the response criteria, then the request packet is not counted toward the threshold.

requests List<GetCisRateLimitRateLimitMatchRequest>: (List of request characteristics) A list of characteristics that the incoming request must match to be counted toward the threshold. If no list is provided, all incoming requests are counted toward the threshold.
responses List<GetCisRateLimitRateLimitMatchResponse>: (List of HTTP responses) A list of HTTP responses that outgoing packets must match before they can be returned to the client. If an incoming request matches the request criteria, but the response does not match the response criteria, then the request packet is not counted toward the threshold.

requests GetCisRateLimitRateLimitMatchRequest[]: (List of request characteristics) A list of characteristics that the incoming request must match to be counted toward the threshold. If no list is provided, all incoming requests are counted toward the threshold.
responses GetCisRateLimitRateLimitMatchResponse[]: (List of HTTP responses) A list of HTTP responses that outgoing packets must match before they can be returned to the client. If an incoming request matches the request criteria, but the response does not match the response criteria, then the request packet is not counted toward the threshold.

requests Sequence[GetCisRateLimitRateLimitMatchRequest]: (List of request characteristics) A list of characteristics that the incoming request must match to be counted toward the threshold. If no list is provided, all incoming requests are counted toward the threshold.
responses Sequence[GetCisRateLimitRateLimitMatchResponse]: (List of HTTP responses) A list of HTTP responses that outgoing packets must match before they can be returned to the client. If an incoming request matches the request criteria, but the response does not match the response criteria, then the request packet is not counted toward the threshold.

requests List<Property Map>: (List of request characteristics) A list of characteristics that the incoming request must match to be counted toward the threshold. If no list is provided, all incoming requests are counted toward the threshold.
responses List<Property Map>: (List of HTTP responses) A list of HTTP responses that outgoing packets must match before they can be returned to the client. If an incoming request matches the request criteria, but the response does not match the response criteria, then the request packet is not counted toward the threshold.

GetCisRateLimitRateLimitMatchRequest

Methods List<string>: (Set of strings) The HTTP methods that the incoming request can use to be counted toward the threshold. Supported values are GET, POST, PUT, DELETE, PATCH, HEAD, and ALL. You can also combine multiple methods and separate them with a comma. For example POST,PUT.
Schemes List<string>: (Set of strings) The scheme of the request that determines the protocol that you want. Supported values are HTTPS, HTTP,HTTPS, and ALL.
Url string: (String) The URL that the request uses. Wildcard domains are expanded to match applicable traffic, query strings are not matched. If * is returned, the rule is applied to all URLs. The maximum length of this value can be 1024.

Methods []string: (Set of strings) The HTTP methods that the incoming request can use to be counted toward the threshold. Supported values are GET, POST, PUT, DELETE, PATCH, HEAD, and ALL. You can also combine multiple methods and separate them with a comma. For example POST,PUT.
Schemes []string: (Set of strings) The scheme of the request that determines the protocol that you want. Supported values are HTTPS, HTTP,HTTPS, and ALL.
Url string: (String) The URL that the request uses. Wildcard domains are expanded to match applicable traffic, query strings are not matched. If * is returned, the rule is applied to all URLs. The maximum length of this value can be 1024.

methods List<String>: (Set of strings) The HTTP methods that the incoming request can use to be counted toward the threshold. Supported values are GET, POST, PUT, DELETE, PATCH, HEAD, and ALL. You can also combine multiple methods and separate them with a comma. For example POST,PUT.
schemes List<String>: (Set of strings) The scheme of the request that determines the protocol that you want. Supported values are HTTPS, HTTP,HTTPS, and ALL.
url String: (String) The URL that the request uses. Wildcard domains are expanded to match applicable traffic, query strings are not matched. If * is returned, the rule is applied to all URLs. The maximum length of this value can be 1024.

methods string[]: (Set of strings) The HTTP methods that the incoming request can use to be counted toward the threshold. Supported values are GET, POST, PUT, DELETE, PATCH, HEAD, and ALL. You can also combine multiple methods and separate them with a comma. For example POST,PUT.
schemes string[]: (Set of strings) The scheme of the request that determines the protocol that you want. Supported values are HTTPS, HTTP,HTTPS, and ALL.
url string: (String) The URL that the request uses. Wildcard domains are expanded to match applicable traffic, query strings are not matched. If * is returned, the rule is applied to all URLs. The maximum length of this value can be 1024.

methods Sequence[str]: (Set of strings) The HTTP methods that the incoming request can use to be counted toward the threshold. Supported values are GET, POST, PUT, DELETE, PATCH, HEAD, and ALL. You can also combine multiple methods and separate them with a comma. For example POST,PUT.
schemes Sequence[str]: (Set of strings) The scheme of the request that determines the protocol that you want. Supported values are HTTPS, HTTP,HTTPS, and ALL.
url str: (String) The URL that the request uses. Wildcard domains are expanded to match applicable traffic, query strings are not matched. If * is returned, the rule is applied to all URLs. The maximum length of this value can be 1024.

methods List<String>: (Set of strings) The HTTP methods that the incoming request can use to be counted toward the threshold. Supported values are GET, POST, PUT, DELETE, PATCH, HEAD, and ALL. You can also combine multiple methods and separate them with a comma. For example POST,PUT.
schemes List<String>: (Set of strings) The scheme of the request that determines the protocol that you want. Supported values are HTTPS, HTTP,HTTPS, and ALL.
url String: (String) The URL that the request uses. Wildcard domains are expanded to match applicable traffic, query strings are not matched. If * is returned, the rule is applied to all URLs. The maximum length of this value can be 1024.

GetCisRateLimitRateLimitMatchResponse

Headers List<GetCisRateLimitRateLimitMatchResponseHeader>
OriginTraffic bool: (String) The origin traffic.
Statuses List<double>: (Set of integers) The HTTP status code that the response must have so that the request is counted toward the threshold. The value can be between 100 and 999. If you want to use multiple response codes, you must separate them with a comma, such as 401,403.

Headers []GetCisRateLimitRateLimitMatchResponseHeader
OriginTraffic bool: (String) The origin traffic.
Statuses []float64: (Set of integers) The HTTP status code that the response must have so that the request is counted toward the threshold. The value can be between 100 and 999. If you want to use multiple response codes, you must separate them with a comma, such as 401,403.

headers List<GetCisRateLimitRateLimitMatchResponseHeader>
originTraffic Boolean: (String) The origin traffic.
statuses List<Double>: (Set of integers) The HTTP status code that the response must have so that the request is counted toward the threshold. The value can be between 100 and 999. If you want to use multiple response codes, you must separate them with a comma, such as 401,403.

headers GetCisRateLimitRateLimitMatchResponseHeader[]
originTraffic boolean: (String) The origin traffic.
statuses number[]: (Set of integers) The HTTP status code that the response must have so that the request is counted toward the threshold. The value can be between 100 and 999. If you want to use multiple response codes, you must separate them with a comma, such as 401,403.

headers Sequence[GetCisRateLimitRateLimitMatchResponseHeader]
origin_traffic bool: (String) The origin traffic.
statuses Sequence[float]: (Set of integers) The HTTP status code that the response must have so that the request is counted toward the threshold. The value can be between 100 and 999. If you want to use multiple response codes, you must separate them with a comma, such as 401,403.

headers List<Property Map>
originTraffic Boolean: (String) The origin traffic.
statuses List<Number>: (Set of integers) The HTTP status code that the response must have so that the request is counted toward the threshold. The value can be between 100 and 999. If you want to use multiple response codes, you must separate them with a comma, such as 401,403.

GetCisRateLimitRateLimitMatchResponseHeader

Name string: (String) The name of the HTTP response header.
Op string: (String) The operator that applied to your HTTP response header. Supported values are eq (equals) and ne (not equals).
Value string: (String) The value that the HTTP response header must match.

Name string: (String) The name of the HTTP response header.
Op string: (String) The operator that applied to your HTTP response header. Supported values are eq (equals) and ne (not equals).
Value string: (String) The value that the HTTP response header must match.

name String: (String) The name of the HTTP response header.
op String: (String) The operator that applied to your HTTP response header. Supported values are eq (equals) and ne (not equals).
value String: (String) The value that the HTTP response header must match.

name string: (String) The name of the HTTP response header.
op string: (String) The operator that applied to your HTTP response header. Supported values are eq (equals) and ne (not equals).
value string: (String) The value that the HTTP response header must match.

name str: (String) The name of the HTTP response header.
op str: (String) The operator that applied to your HTTP response header. Supported values are eq (equals) and ne (not equals).
value str: (String) The value that the HTTP response header must match.

name String: (String) The name of the HTTP response header.
op String: (String) The operator that applied to your HTTP response header. Supported values are eq (equals) and ne (not equals).
value String: (String) The value that the HTTP response header must match.

Package Details

Repository: ibm ibm-cloud/terraform-provider-ibm
License
Notes: This Pulumi package is based on the ibm Terraform Provider.

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

ibm-cloud/terraform-provider-ibm

ibm.getCisRateLimit

On this page

On this page

Example Usage

Using getCisRateLimit

getCisRateLimit Result

Supporting Types

GetCisRateLimitRateLimit

GetCisRateLimitRateLimitAction

GetCisRateLimitRateLimitActionResponse

GetCisRateLimitRateLimitBypass

GetCisRateLimitRateLimitCorrelate

GetCisRateLimitRateLimitMatch

GetCisRateLimitRateLimitMatchRequest

GetCisRateLimitRateLimitMatchResponse

GetCisRateLimitRateLimitMatchResponseHeader

Package Details

On this page

On this page