Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Incapsula Provider
  3. API Docs
  4. ApiSecuritySiteConfig
incapsula 3.32.1 published on Monday, Apr 14, 2025 by imperva
imperva/terraform-provider-incapsula

incapsula.ApiSecuritySiteConfig

Explore with Pulumi AI

incapsula 3.32.1 published on Monday, Apr 14, 2025 by imperva
imperva/terraform-provider-incapsula

Provides an Incapsula API Security Site Config resource.

Example Usage

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

const demo_terraform_api_security_site_config = new incapsula.ApiSecuritySiteConfig("demo-terraform-api-security-site-config", {
    siteId: incapsula_site["example-site"].id,
    isAutomaticDiscoveryApiIntegrationEnabled: false,
    isApiOnlySite: true,
    nonApiRequestViolationAction: "ALERT_ONLY",
    invalidUrlViolationAction: "BLOCK_IP",
    invalidMethodViolationAction: "BLOCK_REQUEST",
    missingParamViolationAction: "BLOCK_IP",
    invalidParamValueViolationAction: "IGNORE",
    invalidParamNameViolationAction: "ALERT_ONLY",
});
Copy
import pulumi
import pulumi_incapsula as incapsula

demo_terraform_api_security_site_config = incapsula.ApiSecuritySiteConfig("demo-terraform-api-security-site-config",
    site_id=incapsula_site["example-site"]["id"],
    is_automatic_discovery_api_integration_enabled=False,
    is_api_only_site=True,
    non_api_request_violation_action="ALERT_ONLY",
    invalid_url_violation_action="BLOCK_IP",
    invalid_method_violation_action="BLOCK_REQUEST",
    missing_param_violation_action="BLOCK_IP",
    invalid_param_value_violation_action="IGNORE",
    invalid_param_name_violation_action="ALERT_ONLY")
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := incapsula.NewApiSecuritySiteConfig(ctx, "demo-terraform-api-security-site-config", &incapsula.ApiSecuritySiteConfigArgs{
			SiteId: pulumi.Any(incapsula_site.ExampleSite.Id),
			IsAutomaticDiscoveryApiIntegrationEnabled: pulumi.Bool(false),
			IsApiOnlySite:                    pulumi.Bool(true),
			NonApiRequestViolationAction:     pulumi.String("ALERT_ONLY"),
			InvalidUrlViolationAction:        pulumi.String("BLOCK_IP"),
			InvalidMethodViolationAction:     pulumi.String("BLOCK_REQUEST"),
			MissingParamViolationAction:      pulumi.String("BLOCK_IP"),
			InvalidParamValueViolationAction: pulumi.String("IGNORE"),
			InvalidParamNameViolationAction:  pulumi.String("ALERT_ONLY"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Incapsula = Pulumi.Incapsula;

return await Deployment.RunAsync(() => 
{
    var demo_terraform_api_security_site_config = new Incapsula.ApiSecuritySiteConfig("demo-terraform-api-security-site-config", new()
    {
        SiteId = incapsula_site.Example_site.Id,
        IsAutomaticDiscoveryApiIntegrationEnabled = false,
        IsApiOnlySite = true,
        NonApiRequestViolationAction = "ALERT_ONLY",
        InvalidUrlViolationAction = "BLOCK_IP",
        InvalidMethodViolationAction = "BLOCK_REQUEST",
        MissingParamViolationAction = "BLOCK_IP",
        InvalidParamValueViolationAction = "IGNORE",
        InvalidParamNameViolationAction = "ALERT_ONLY",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.incapsula.ApiSecuritySiteConfig;
import com.pulumi.incapsula.ApiSecuritySiteConfigArgs;
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) {
        var demo_terraform_api_security_site_config = new ApiSecuritySiteConfig("demo-terraform-api-security-site-config", ApiSecuritySiteConfigArgs.builder()
            .siteId(incapsula_site.example-site().id())
            .isAutomaticDiscoveryApiIntegrationEnabled(false)
            .isApiOnlySite(true)
            .nonApiRequestViolationAction("ALERT_ONLY")
            .invalidUrlViolationAction("BLOCK_IP")
            .invalidMethodViolationAction("BLOCK_REQUEST")
            .missingParamViolationAction("BLOCK_IP")
            .invalidParamValueViolationAction("IGNORE")
            .invalidParamNameViolationAction("ALERT_ONLY")
            .build());

    }
}
Copy
resources:
  demo-terraform-api-security-site-config:
    type: incapsula:ApiSecuritySiteConfig
    properties:
      siteId: ${incapsula_site"example-site"[%!s(MISSING)].id}
      isAutomaticDiscoveryApiIntegrationEnabled: false
      isApiOnlySite: true
      nonApiRequestViolationAction: ALERT_ONLY
      invalidUrlViolationAction: BLOCK_IP
      invalidMethodViolationAction: BLOCK_REQUEST
      missingParamViolationAction: BLOCK_IP
      invalidParamValueViolationAction: IGNORE
      invalidParamNameViolationAction: ALERT_ONLY
Copy

Create ApiSecuritySiteConfig Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new ApiSecuritySiteConfig(name: string, args: ApiSecuritySiteConfigArgs, opts?: CustomResourceOptions);
@overload
def ApiSecuritySiteConfig(resource_name: str,
                          args: ApiSecuritySiteConfigArgs,
                          opts: Optional[ResourceOptions] = None)

@overload
def ApiSecuritySiteConfig(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          site_id: Optional[float] = None,
                          api_security_site_config_id: Optional[str] = None,
                          invalid_method_violation_action: Optional[str] = None,
                          invalid_param_name_violation_action: Optional[str] = None,
                          invalid_param_value_violation_action: Optional[str] = None,
                          invalid_url_violation_action: Optional[str] = None,
                          is_api_only_site: Optional[bool] = None,
                          is_automatic_discovery_api_integration_enabled: Optional[bool] = None,
                          missing_param_violation_action: Optional[str] = None,
                          non_api_request_violation_action: Optional[str] = None)
func NewApiSecuritySiteConfig(ctx *Context, name string, args ApiSecuritySiteConfigArgs, opts ...ResourceOption) (*ApiSecuritySiteConfig, error)
public ApiSecuritySiteConfig(string name, ApiSecuritySiteConfigArgs args, CustomResourceOptions? opts = null)
public ApiSecuritySiteConfig(String name, ApiSecuritySiteConfigArgs args)
public ApiSecuritySiteConfig(String name, ApiSecuritySiteConfigArgs args, CustomResourceOptions options)

type: incapsula:ApiSecuritySiteConfig
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. ApiSecuritySiteConfigArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. ApiSecuritySiteConfigArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. ApiSecuritySiteConfigArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. ApiSecuritySiteConfigArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ApiSecuritySiteConfigArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var apiSecuritySiteConfigResource = new Incapsula.ApiSecuritySiteConfig("apiSecuritySiteConfigResource", new()
{
    SiteId = 0,
    ApiSecuritySiteConfigId = "string",
    InvalidMethodViolationAction = "string",
    InvalidParamNameViolationAction = "string",
    InvalidParamValueViolationAction = "string",
    InvalidUrlViolationAction = "string",
    IsApiOnlySite = false,
    IsAutomaticDiscoveryApiIntegrationEnabled = false,
    MissingParamViolationAction = "string",
    NonApiRequestViolationAction = "string",
});
Copy
example, err := incapsula.NewApiSecuritySiteConfig(ctx, "apiSecuritySiteConfigResource", &incapsula.ApiSecuritySiteConfigArgs{
	SiteId:                                    pulumi.Float64(0),
	ApiSecuritySiteConfigId:                   pulumi.String("string"),
	InvalidMethodViolationAction:              pulumi.String("string"),
	InvalidParamNameViolationAction:           pulumi.String("string"),
	InvalidParamValueViolationAction:          pulumi.String("string"),
	InvalidUrlViolationAction:                 pulumi.String("string"),
	IsApiOnlySite:                             pulumi.Bool(false),
	IsAutomaticDiscoveryApiIntegrationEnabled: pulumi.Bool(false),
	MissingParamViolationAction:               pulumi.String("string"),
	NonApiRequestViolationAction:              pulumi.String("string"),
})
Copy
var apiSecuritySiteConfigResource = new ApiSecuritySiteConfig("apiSecuritySiteConfigResource", ApiSecuritySiteConfigArgs.builder()
    .siteId(0)
    .apiSecuritySiteConfigId("string")
    .invalidMethodViolationAction("string")
    .invalidParamNameViolationAction("string")
    .invalidParamValueViolationAction("string")
    .invalidUrlViolationAction("string")
    .isApiOnlySite(false)
    .isAutomaticDiscoveryApiIntegrationEnabled(false)
    .missingParamViolationAction("string")
    .nonApiRequestViolationAction("string")
    .build());
Copy
api_security_site_config_resource = incapsula.ApiSecuritySiteConfig("apiSecuritySiteConfigResource",
    site_id=0,
    api_security_site_config_id="string",
    invalid_method_violation_action="string",
    invalid_param_name_violation_action="string",
    invalid_param_value_violation_action="string",
    invalid_url_violation_action="string",
    is_api_only_site=False,
    is_automatic_discovery_api_integration_enabled=False,
    missing_param_violation_action="string",
    non_api_request_violation_action="string")
Copy
const apiSecuritySiteConfigResource = new incapsula.ApiSecuritySiteConfig("apiSecuritySiteConfigResource", {
    siteId: 0,
    apiSecuritySiteConfigId: "string",
    invalidMethodViolationAction: "string",
    invalidParamNameViolationAction: "string",
    invalidParamValueViolationAction: "string",
    invalidUrlViolationAction: "string",
    isApiOnlySite: false,
    isAutomaticDiscoveryApiIntegrationEnabled: false,
    missingParamViolationAction: "string",
    nonApiRequestViolationAction: "string",
});
Copy
type: incapsula:ApiSecuritySiteConfig
properties:
    apiSecuritySiteConfigId: string
    invalidMethodViolationAction: string
    invalidParamNameViolationAction: string
    invalidParamValueViolationAction: string
    invalidUrlViolationAction: string
    isApiOnlySite: false
    isAutomaticDiscoveryApiIntegrationEnabled: false
    missingParamViolationAction: string
    nonApiRequestViolationAction: string
    siteId: 0
Copy

ApiSecuritySiteConfig Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The ApiSecuritySiteConfig resource accepts the following input properties:

SiteId This property is required. double
Numeric identifier of the site to operate on.
ApiSecuritySiteConfigId string
Unique identifier in the API for the API Security Site Configuration.
InvalidMethodViolationAction string
The action taken when an invalid method Violation occurs. Possible values: ALERT_ONLY (default value), BLOCK_REQUEST, BLOCK_USER, BLOCK_IP, IGNORE.
InvalidParamNameViolationAction string

The action taken when an invalid parameter value Violation occurs. Possible values: ALERT_ONLY (default value), BLOCK_REQUEST, BLOCK_USER, BLOCK_IP, IGNORE.

NOTE: invalid_param_name_violation_action parameter is currently not supported. Please do not use/change value.

InvalidParamValueViolationAction string
The action taken when an invalid parameter value Violation occurs. Possible values: ALERT_ONLY (default value), BLOCK_REQUEST, BLOCK_USER, BLOCK_IP, IGNORE.
InvalidUrlViolationAction string
The action taken when an invalid URL Violation occurs. Possible values: ALERT_ONLY (default value), BLOCK_REQUEST, BLOCK_USER, BLOCK_IP, IGNORE.
IsApiOnlySite bool
Apply positive security model for all traffic on the site. Applying the positive security model for all traffic on the site may lead to undesired request blocking.
IsAutomaticDiscoveryApiIntegrationEnabled bool
Parameter shows whether automatic API discovery API Integration is enabled. This field should not be set if API Security Add-On subscription is not available.
MissingParamViolationAction string
The action taken when a missing parameter Violation occurs. Possible values: ALERT_ONLY (default value), BLOCK_REQUEST, BLOCK_USER, BLOCK_IP, IGNORE.
NonApiRequestViolationAction string
Action to be taken for traffic on the site that does not target the uploaded APIs. Possible values: ALERT_ONLY, BLOCK_REQUEST, BLOCK_USER, BLOCK_IP, IGNORE. This parameter is required when is_api_only_site is set true. Possible values: ALERT_ONLY, BLOCK_REQUEST, BLOCK_USER , BLOCK_IP, IGNORE.
SiteId This property is required. float64
Numeric identifier of the site to operate on.
ApiSecuritySiteConfigId string
Unique identifier in the API for the API Security Site Configuration.
InvalidMethodViolationAction string
The action taken when an invalid method Violation occurs. Possible values: ALERT_ONLY (default value), BLOCK_REQUEST, BLOCK_USER, BLOCK_IP, IGNORE.
InvalidParamNameViolationAction string

The action taken when an invalid parameter value Violation occurs. Possible values: ALERT_ONLY (default value), BLOCK_REQUEST, BLOCK_USER, BLOCK_IP, IGNORE.

NOTE: invalid_param_name_violation_action parameter is currently not supported. Please do not use/change value.

InvalidParamValueViolationAction string
The action taken when an invalid parameter value Violation occurs. Possible values: ALERT_ONLY (default value), BLOCK_REQUEST, BLOCK_USER, BLOCK_IP, IGNORE.
InvalidUrlViolationAction string
The action taken when an invalid URL Violation occurs. Possible values: ALERT_ONLY (default value), BLOCK_REQUEST, BLOCK_USER, BLOCK_IP, IGNORE.
IsApiOnlySite bool
Apply positive security model for all traffic on the site. Applying the positive security model for all traffic on the site may lead to undesired request blocking.
IsAutomaticDiscoveryApiIntegrationEnabled bool
Parameter shows whether automatic API discovery API Integration is enabled. This field should not be set if API Security Add-On subscription is not available.
MissingParamViolationAction string
The action taken when a missing parameter Violation occurs. Possible values: ALERT_ONLY (default value), BLOCK_REQUEST, BLOCK_USER, BLOCK_IP, IGNORE.
NonApiRequestViolationAction string
Action to be taken for traffic on the site that does not target the uploaded APIs. Possible values: ALERT_ONLY, BLOCK_REQUEST, BLOCK_USER, BLOCK_IP, IGNORE. This parameter is required when is_api_only_site is set true. Possible values: ALERT_ONLY, BLOCK_REQUEST, BLOCK_USER , BLOCK_IP, IGNORE.
siteId This property is required. Double
Numeric identifier of the site to operate on.
apiSecuritySiteConfigId String
Unique identifier in the API for the API Security Site Configuration.
invalidMethodViolationAction String
The action taken when an invalid method Violation occurs. Possible values: ALERT_ONLY (default value), BLOCK_REQUEST, BLOCK_USER, BLOCK_IP, IGNORE.
invalidParamNameViolationAction String

The action taken when an invalid parameter value Violation occurs. Possible values: ALERT_ONLY (default value), BLOCK_REQUEST, BLOCK_USER, BLOCK_IP, IGNORE.

NOTE: invalid_param_name_violation_action parameter is currently not supported. Please do not use/change value.

invalidParamValueViolationAction String
The action taken when an invalid parameter value Violation occurs. Possible values: ALERT_ONLY (default value), BLOCK_REQUEST, BLOCK_USER, BLOCK_IP, IGNORE.
invalidUrlViolationAction String
The action taken when an invalid URL Violation occurs. Possible values: ALERT_ONLY (default value), BLOCK_REQUEST, BLOCK_USER, BLOCK_IP, IGNORE.
isApiOnlySite Boolean
Apply positive security model for all traffic on the site. Applying the positive security model for all traffic on the site may lead to undesired request blocking.
isAutomaticDiscoveryApiIntegrationEnabled Boolean
Parameter shows whether automatic API discovery API Integration is enabled. This field should not be set if API Security Add-On subscription is not available.
missingParamViolationAction String
The action taken when a missing parameter Violation occurs. Possible values: ALERT_ONLY (default value), BLOCK_REQUEST, BLOCK_USER, BLOCK_IP, IGNORE.
nonApiRequestViolationAction String
Action to be taken for traffic on the site that does not target the uploaded APIs. Possible values: ALERT_ONLY, BLOCK_REQUEST, BLOCK_USER, BLOCK_IP, IGNORE. This parameter is required when is_api_only_site is set true. Possible values: ALERT_ONLY, BLOCK_REQUEST, BLOCK_USER , BLOCK_IP, IGNORE.
siteId This property is required. number
Numeric identifier of the site to operate on.
apiSecuritySiteConfigId string
Unique identifier in the API for the API Security Site Configuration.
invalidMethodViolationAction string
The action taken when an invalid method Violation occurs. Possible values: ALERT_ONLY (default value), BLOCK_REQUEST, BLOCK_USER, BLOCK_IP, IGNORE.
invalidParamNameViolationAction string

The action taken when an invalid parameter value Violation occurs. Possible values: ALERT_ONLY (default value), BLOCK_REQUEST, BLOCK_USER, BLOCK_IP, IGNORE.

NOTE: invalid_param_name_violation_action parameter is currently not supported. Please do not use/change value.

invalidParamValueViolationAction string
The action taken when an invalid parameter value Violation occurs. Possible values: ALERT_ONLY (default value), BLOCK_REQUEST, BLOCK_USER, BLOCK_IP, IGNORE.
invalidUrlViolationAction string
The action taken when an invalid URL Violation occurs. Possible values: ALERT_ONLY (default value), BLOCK_REQUEST, BLOCK_USER, BLOCK_IP, IGNORE.
isApiOnlySite boolean
Apply positive security model for all traffic on the site. Applying the positive security model for all traffic on the site may lead to undesired request blocking.
isAutomaticDiscoveryApiIntegrationEnabled boolean
Parameter shows whether automatic API discovery API Integration is enabled. This field should not be set if API Security Add-On subscription is not available.
missingParamViolationAction string
The action taken when a missing parameter Violation occurs. Possible values: ALERT_ONLY (default value), BLOCK_REQUEST, BLOCK_USER, BLOCK_IP, IGNORE.
nonApiRequestViolationAction string
Action to be taken for traffic on the site that does not target the uploaded APIs. Possible values: ALERT_ONLY, BLOCK_REQUEST, BLOCK_USER, BLOCK_IP, IGNORE. This parameter is required when is_api_only_site is set true. Possible values: ALERT_ONLY, BLOCK_REQUEST, BLOCK_USER , BLOCK_IP, IGNORE.
site_id This property is required. float
Numeric identifier of the site to operate on.
api_security_site_config_id str
Unique identifier in the API for the API Security Site Configuration.
invalid_method_violation_action str
The action taken when an invalid method Violation occurs. Possible values: ALERT_ONLY (default value), BLOCK_REQUEST, BLOCK_USER, BLOCK_IP, IGNORE.
invalid_param_name_violation_action str

The action taken when an invalid parameter value Violation occurs. Possible values: ALERT_ONLY (default value), BLOCK_REQUEST, BLOCK_USER, BLOCK_IP, IGNORE.

NOTE: invalid_param_name_violation_action parameter is currently not supported. Please do not use/change value.

invalid_param_value_violation_action str
The action taken when an invalid parameter value Violation occurs. Possible values: ALERT_ONLY (default value), BLOCK_REQUEST, BLOCK_USER, BLOCK_IP, IGNORE.
invalid_url_violation_action str
The action taken when an invalid URL Violation occurs. Possible values: ALERT_ONLY (default value), BLOCK_REQUEST, BLOCK_USER, BLOCK_IP, IGNORE.
is_api_only_site bool
Apply positive security model for all traffic on the site. Applying the positive security model for all traffic on the site may lead to undesired request blocking.
is_automatic_discovery_api_integration_enabled bool
Parameter shows whether automatic API discovery API Integration is enabled. This field should not be set if API Security Add-On subscription is not available.
missing_param_violation_action str
The action taken when a missing parameter Violation occurs. Possible values: ALERT_ONLY (default value), BLOCK_REQUEST, BLOCK_USER, BLOCK_IP, IGNORE.
non_api_request_violation_action str
Action to be taken for traffic on the site that does not target the uploaded APIs. Possible values: ALERT_ONLY, BLOCK_REQUEST, BLOCK_USER, BLOCK_IP, IGNORE. This parameter is required when is_api_only_site is set true. Possible values: ALERT_ONLY, BLOCK_REQUEST, BLOCK_USER , BLOCK_IP, IGNORE.
siteId This property is required. Number
Numeric identifier of the site to operate on.
apiSecuritySiteConfigId String
Unique identifier in the API for the API Security Site Configuration.
invalidMethodViolationAction String
The action taken when an invalid method Violation occurs. Possible values: ALERT_ONLY (default value), BLOCK_REQUEST, BLOCK_USER, BLOCK_IP, IGNORE.
invalidParamNameViolationAction String

The action taken when an invalid parameter value Violation occurs. Possible values: ALERT_ONLY (default value), BLOCK_REQUEST, BLOCK_USER, BLOCK_IP, IGNORE.

NOTE: invalid_param_name_violation_action parameter is currently not supported. Please do not use/change value.

invalidParamValueViolationAction String
The action taken when an invalid parameter value Violation occurs. Possible values: ALERT_ONLY (default value), BLOCK_REQUEST, BLOCK_USER, BLOCK_IP, IGNORE.
invalidUrlViolationAction String
The action taken when an invalid URL Violation occurs. Possible values: ALERT_ONLY (default value), BLOCK_REQUEST, BLOCK_USER, BLOCK_IP, IGNORE.
isApiOnlySite Boolean
Apply positive security model for all traffic on the site. Applying the positive security model for all traffic on the site may lead to undesired request blocking.
isAutomaticDiscoveryApiIntegrationEnabled Boolean
Parameter shows whether automatic API discovery API Integration is enabled. This field should not be set if API Security Add-On subscription is not available.
missingParamViolationAction String
The action taken when a missing parameter Violation occurs. Possible values: ALERT_ONLY (default value), BLOCK_REQUEST, BLOCK_USER, BLOCK_IP, IGNORE.
nonApiRequestViolationAction String
Action to be taken for traffic on the site that does not target the uploaded APIs. Possible values: ALERT_ONLY, BLOCK_REQUEST, BLOCK_USER, BLOCK_IP, IGNORE. This parameter is required when is_api_only_site is set true. Possible values: ALERT_ONLY, BLOCK_REQUEST, BLOCK_USER , BLOCK_IP, IGNORE.

Outputs

All input properties are implicitly available as output properties. Additionally, the ApiSecuritySiteConfig resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
LastModified double
The last modified timestamp.
Id string
The provider-assigned unique ID for this managed resource.
LastModified float64
The last modified timestamp.
id String
The provider-assigned unique ID for this managed resource.
lastModified Double
The last modified timestamp.
id string
The provider-assigned unique ID for this managed resource.
lastModified number
The last modified timestamp.
id str
The provider-assigned unique ID for this managed resource.
last_modified float
The last modified timestamp.
id String
The provider-assigned unique ID for this managed resource.
lastModified Number
The last modified timestamp.

Look up Existing ApiSecuritySiteConfig Resource

Get an existing ApiSecuritySiteConfig resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: ApiSecuritySiteConfigState, opts?: CustomResourceOptions): ApiSecuritySiteConfig
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        api_security_site_config_id: Optional[str] = None,
        invalid_method_violation_action: Optional[str] = None,
        invalid_param_name_violation_action: Optional[str] = None,
        invalid_param_value_violation_action: Optional[str] = None,
        invalid_url_violation_action: Optional[str] = None,
        is_api_only_site: Optional[bool] = None,
        is_automatic_discovery_api_integration_enabled: Optional[bool] = None,
        last_modified: Optional[float] = None,
        missing_param_violation_action: Optional[str] = None,
        non_api_request_violation_action: Optional[str] = None,
        site_id: Optional[float] = None) -> ApiSecuritySiteConfig
func GetApiSecuritySiteConfig(ctx *Context, name string, id IDInput, state *ApiSecuritySiteConfigState, opts ...ResourceOption) (*ApiSecuritySiteConfig, error)
public static ApiSecuritySiteConfig Get(string name, Input<string> id, ApiSecuritySiteConfigState? state, CustomResourceOptions? opts = null)
public static ApiSecuritySiteConfig get(String name, Output<String> id, ApiSecuritySiteConfigState state, CustomResourceOptions options)
resources:  _:    type: incapsula:ApiSecuritySiteConfig    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
ApiSecuritySiteConfigId string
Unique identifier in the API for the API Security Site Configuration.
InvalidMethodViolationAction string
The action taken when an invalid method Violation occurs. Possible values: ALERT_ONLY (default value), BLOCK_REQUEST, BLOCK_USER, BLOCK_IP, IGNORE.
InvalidParamNameViolationAction string

The action taken when an invalid parameter value Violation occurs. Possible values: ALERT_ONLY (default value), BLOCK_REQUEST, BLOCK_USER, BLOCK_IP, IGNORE.

NOTE: invalid_param_name_violation_action parameter is currently not supported. Please do not use/change value.

InvalidParamValueViolationAction string
The action taken when an invalid parameter value Violation occurs. Possible values: ALERT_ONLY (default value), BLOCK_REQUEST, BLOCK_USER, BLOCK_IP, IGNORE.
InvalidUrlViolationAction string
The action taken when an invalid URL Violation occurs. Possible values: ALERT_ONLY (default value), BLOCK_REQUEST, BLOCK_USER, BLOCK_IP, IGNORE.
IsApiOnlySite bool
Apply positive security model for all traffic on the site. Applying the positive security model for all traffic on the site may lead to undesired request blocking.
IsAutomaticDiscoveryApiIntegrationEnabled bool
Parameter shows whether automatic API discovery API Integration is enabled. This field should not be set if API Security Add-On subscription is not available.
LastModified double
The last modified timestamp.
MissingParamViolationAction string
The action taken when a missing parameter Violation occurs. Possible values: ALERT_ONLY (default value), BLOCK_REQUEST, BLOCK_USER, BLOCK_IP, IGNORE.
NonApiRequestViolationAction string
Action to be taken for traffic on the site that does not target the uploaded APIs. Possible values: ALERT_ONLY, BLOCK_REQUEST, BLOCK_USER, BLOCK_IP, IGNORE. This parameter is required when is_api_only_site is set true. Possible values: ALERT_ONLY, BLOCK_REQUEST, BLOCK_USER , BLOCK_IP, IGNORE.
SiteId double
Numeric identifier of the site to operate on.
ApiSecuritySiteConfigId string
Unique identifier in the API for the API Security Site Configuration.
InvalidMethodViolationAction string
The action taken when an invalid method Violation occurs. Possible values: ALERT_ONLY (default value), BLOCK_REQUEST, BLOCK_USER, BLOCK_IP, IGNORE.
InvalidParamNameViolationAction string

The action taken when an invalid parameter value Violation occurs. Possible values: ALERT_ONLY (default value), BLOCK_REQUEST, BLOCK_USER, BLOCK_IP, IGNORE.

NOTE: invalid_param_name_violation_action parameter is currently not supported. Please do not use/change value.

InvalidParamValueViolationAction string
The action taken when an invalid parameter value Violation occurs. Possible values: ALERT_ONLY (default value), BLOCK_REQUEST, BLOCK_USER, BLOCK_IP, IGNORE.
InvalidUrlViolationAction string
The action taken when an invalid URL Violation occurs. Possible values: ALERT_ONLY (default value), BLOCK_REQUEST, BLOCK_USER, BLOCK_IP, IGNORE.
IsApiOnlySite bool
Apply positive security model for all traffic on the site. Applying the positive security model for all traffic on the site may lead to undesired request blocking.
IsAutomaticDiscoveryApiIntegrationEnabled bool
Parameter shows whether automatic API discovery API Integration is enabled. This field should not be set if API Security Add-On subscription is not available.
LastModified float64
The last modified timestamp.
MissingParamViolationAction string
The action taken when a missing parameter Violation occurs. Possible values: ALERT_ONLY (default value), BLOCK_REQUEST, BLOCK_USER, BLOCK_IP, IGNORE.
NonApiRequestViolationAction string
Action to be taken for traffic on the site that does not target the uploaded APIs. Possible values: ALERT_ONLY, BLOCK_REQUEST, BLOCK_USER, BLOCK_IP, IGNORE. This parameter is required when is_api_only_site is set true. Possible values: ALERT_ONLY, BLOCK_REQUEST, BLOCK_USER , BLOCK_IP, IGNORE.
SiteId float64
Numeric identifier of the site to operate on.
apiSecuritySiteConfigId String
Unique identifier in the API for the API Security Site Configuration.
invalidMethodViolationAction String
The action taken when an invalid method Violation occurs. Possible values: ALERT_ONLY (default value), BLOCK_REQUEST, BLOCK_USER, BLOCK_IP, IGNORE.
invalidParamNameViolationAction String

The action taken when an invalid parameter value Violation occurs. Possible values: ALERT_ONLY (default value), BLOCK_REQUEST, BLOCK_USER, BLOCK_IP, IGNORE.

NOTE: invalid_param_name_violation_action parameter is currently not supported. Please do not use/change value.

invalidParamValueViolationAction String
The action taken when an invalid parameter value Violation occurs. Possible values: ALERT_ONLY (default value), BLOCK_REQUEST, BLOCK_USER, BLOCK_IP, IGNORE.
invalidUrlViolationAction String
The action taken when an invalid URL Violation occurs. Possible values: ALERT_ONLY (default value), BLOCK_REQUEST, BLOCK_USER, BLOCK_IP, IGNORE.
isApiOnlySite Boolean
Apply positive security model for all traffic on the site. Applying the positive security model for all traffic on the site may lead to undesired request blocking.
isAutomaticDiscoveryApiIntegrationEnabled Boolean
Parameter shows whether automatic API discovery API Integration is enabled. This field should not be set if API Security Add-On subscription is not available.
lastModified Double
The last modified timestamp.
missingParamViolationAction String
The action taken when a missing parameter Violation occurs. Possible values: ALERT_ONLY (default value), BLOCK_REQUEST, BLOCK_USER, BLOCK_IP, IGNORE.
nonApiRequestViolationAction String
Action to be taken for traffic on the site that does not target the uploaded APIs. Possible values: ALERT_ONLY, BLOCK_REQUEST, BLOCK_USER, BLOCK_IP, IGNORE. This parameter is required when is_api_only_site is set true. Possible values: ALERT_ONLY, BLOCK_REQUEST, BLOCK_USER , BLOCK_IP, IGNORE.
siteId Double
Numeric identifier of the site to operate on.
apiSecuritySiteConfigId string
Unique identifier in the API for the API Security Site Configuration.
invalidMethodViolationAction string
The action taken when an invalid method Violation occurs. Possible values: ALERT_ONLY (default value), BLOCK_REQUEST, BLOCK_USER, BLOCK_IP, IGNORE.
invalidParamNameViolationAction string

The action taken when an invalid parameter value Violation occurs. Possible values: ALERT_ONLY (default value), BLOCK_REQUEST, BLOCK_USER, BLOCK_IP, IGNORE.

NOTE: invalid_param_name_violation_action parameter is currently not supported. Please do not use/change value.

invalidParamValueViolationAction string
The action taken when an invalid parameter value Violation occurs. Possible values: ALERT_ONLY (default value), BLOCK_REQUEST, BLOCK_USER, BLOCK_IP, IGNORE.
invalidUrlViolationAction string
The action taken when an invalid URL Violation occurs. Possible values: ALERT_ONLY (default value), BLOCK_REQUEST, BLOCK_USER, BLOCK_IP, IGNORE.
isApiOnlySite boolean
Apply positive security model for all traffic on the site. Applying the positive security model for all traffic on the site may lead to undesired request blocking.
isAutomaticDiscoveryApiIntegrationEnabled boolean
Parameter shows whether automatic API discovery API Integration is enabled. This field should not be set if API Security Add-On subscription is not available.
lastModified number
The last modified timestamp.
missingParamViolationAction string
The action taken when a missing parameter Violation occurs. Possible values: ALERT_ONLY (default value), BLOCK_REQUEST, BLOCK_USER, BLOCK_IP, IGNORE.
nonApiRequestViolationAction string
Action to be taken for traffic on the site that does not target the uploaded APIs. Possible values: ALERT_ONLY, BLOCK_REQUEST, BLOCK_USER, BLOCK_IP, IGNORE. This parameter is required when is_api_only_site is set true. Possible values: ALERT_ONLY, BLOCK_REQUEST, BLOCK_USER , BLOCK_IP, IGNORE.
siteId number
Numeric identifier of the site to operate on.
api_security_site_config_id str
Unique identifier in the API for the API Security Site Configuration.
invalid_method_violation_action str
The action taken when an invalid method Violation occurs. Possible values: ALERT_ONLY (default value), BLOCK_REQUEST, BLOCK_USER, BLOCK_IP, IGNORE.
invalid_param_name_violation_action str

The action taken when an invalid parameter value Violation occurs. Possible values: ALERT_ONLY (default value), BLOCK_REQUEST, BLOCK_USER, BLOCK_IP, IGNORE.

NOTE: invalid_param_name_violation_action parameter is currently not supported. Please do not use/change value.

invalid_param_value_violation_action str
The action taken when an invalid parameter value Violation occurs. Possible values: ALERT_ONLY (default value), BLOCK_REQUEST, BLOCK_USER, BLOCK_IP, IGNORE.
invalid_url_violation_action str
The action taken when an invalid URL Violation occurs. Possible values: ALERT_ONLY (default value), BLOCK_REQUEST, BLOCK_USER, BLOCK_IP, IGNORE.
is_api_only_site bool
Apply positive security model for all traffic on the site. Applying the positive security model for all traffic on the site may lead to undesired request blocking.
is_automatic_discovery_api_integration_enabled bool
Parameter shows whether automatic API discovery API Integration is enabled. This field should not be set if API Security Add-On subscription is not available.
last_modified float
The last modified timestamp.
missing_param_violation_action str
The action taken when a missing parameter Violation occurs. Possible values: ALERT_ONLY (default value), BLOCK_REQUEST, BLOCK_USER, BLOCK_IP, IGNORE.
non_api_request_violation_action str
Action to be taken for traffic on the site that does not target the uploaded APIs. Possible values: ALERT_ONLY, BLOCK_REQUEST, BLOCK_USER, BLOCK_IP, IGNORE. This parameter is required when is_api_only_site is set true. Possible values: ALERT_ONLY, BLOCK_REQUEST, BLOCK_USER , BLOCK_IP, IGNORE.
site_id float
Numeric identifier of the site to operate on.
apiSecuritySiteConfigId String
Unique identifier in the API for the API Security Site Configuration.
invalidMethodViolationAction String
The action taken when an invalid method Violation occurs. Possible values: ALERT_ONLY (default value), BLOCK_REQUEST, BLOCK_USER, BLOCK_IP, IGNORE.
invalidParamNameViolationAction String

The action taken when an invalid parameter value Violation occurs. Possible values: ALERT_ONLY (default value), BLOCK_REQUEST, BLOCK_USER, BLOCK_IP, IGNORE.

NOTE: invalid_param_name_violation_action parameter is currently not supported. Please do not use/change value.

invalidParamValueViolationAction String
The action taken when an invalid parameter value Violation occurs. Possible values: ALERT_ONLY (default value), BLOCK_REQUEST, BLOCK_USER, BLOCK_IP, IGNORE.
invalidUrlViolationAction String
The action taken when an invalid URL Violation occurs. Possible values: ALERT_ONLY (default value), BLOCK_REQUEST, BLOCK_USER, BLOCK_IP, IGNORE.
isApiOnlySite Boolean
Apply positive security model for all traffic on the site. Applying the positive security model for all traffic on the site may lead to undesired request blocking.
isAutomaticDiscoveryApiIntegrationEnabled Boolean
Parameter shows whether automatic API discovery API Integration is enabled. This field should not be set if API Security Add-On subscription is not available.
lastModified Number
The last modified timestamp.
missingParamViolationAction String
The action taken when a missing parameter Violation occurs. Possible values: ALERT_ONLY (default value), BLOCK_REQUEST, BLOCK_USER, BLOCK_IP, IGNORE.
nonApiRequestViolationAction String
Action to be taken for traffic on the site that does not target the uploaded APIs. Possible values: ALERT_ONLY, BLOCK_REQUEST, BLOCK_USER, BLOCK_IP, IGNORE. This parameter is required when is_api_only_site is set true. Possible values: ALERT_ONLY, BLOCK_REQUEST, BLOCK_USER , BLOCK_IP, IGNORE.
siteId Number
Numeric identifier of the site to operate on.

Import

API Security Site Configuration can be imported using the site_id

$ pulumi import incapsula:index/apiSecuritySiteConfig:ApiSecuritySiteConfig demo_site_config 1234
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
incapsula imperva/terraform-provider-incapsula
License
Notes
This Pulumi package is based on the incapsula Terraform Provider.
incapsula 3.32.1 published on Monday, Apr 14, 2025 by imperva
imperva/terraform-provider-incapsula