Merge pull request #37 from CheckPointSW/rate-limit-practice

Author: chkp-omerma

docs/index.md

@@ -17,7 +17,7 @@ terraform {
   required_providers {
     inext = {
       source  = "CheckPointSW/infinity-next"
-      version = "1.1.7"
+      version = "1.2.0"
     }
   }
 }

docs/resources/inext_appsec_gateway_profile.md

@@ -17,7 +17,7 @@ terraform {
   required_providers {
     inext = {
       source  = "CheckPointSW/infinity-next"
-      version = "1.1.7"
+      version = "1.2.0"
     }
   }
 }

docs/resources/inext_docker_profile.md

@@ -17,7 +17,7 @@ terraform {
   required_providers {
     inext = {
       source  = "CheckPointSW/infinity-next"
-      version = "~>1.1.7"
+      version = "~>1.2.0"
     }
   }
 }

docs/resources/inext_embedded_profile.md

@@ -17,7 +17,7 @@ terraform {
   required_providers {
     inext = {
       source  = "CheckPointSW/infinity-next"
-      version = "~>1.1.7"
+      version = "~>1.2.0"
     }
   }
 }

docs/resources/inext_exceptions.md

@@ -17,7 +17,7 @@ terraform {
   required_providers {
     inext = {
       source  = "CheckPointSW/infinity-next"
-      version = "~>1.1.7"
+      version = "~>1.2.0"
     }
   }
 }

docs/resources/inext_kubernetes_profile.md

@@ -17,7 +17,7 @@ terraform {
   required_providers {
     inext = {
       source  = "CheckPointSW/infinity-next"
-      version = "~>1.1.7"
+      version = "~>1.2.0"
     }
   }
 }

docs/resources/inext_log_trigger.md

@@ -17,7 +17,7 @@ terraform {
   required_providers {
     inext = {
       source  = "CheckPointSW/infinity-next"
-      version = "~>1.1.7"
+      version = "~>1.2.0"
     }
   }
 }

docs/resources/inext_rate_limit_practice.md

@@ -0,0 +1,110 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "inext_rate_limit_practice Resource - terraform-provider-infinity-next"
+subcategory: ""
+description: |-
+  Rate limit Practice
+---
+
+# inext_rate_limit_practice (Resource)
+
+Rate limit Practice
+
+## Example Usage
+
+```terraform
+terraform {
+  required_providers {
+    inext = {
+      source  = "CheckPointSW/infinity-next"
+      version = "~>1.2.0"
+    }
+  }
+}
+
+provider "inext" {
+  region = "eu"
+  # client_id  = ""  // can be set with env var INEXT_CLIENT_ID
+  # access_key = "" // can be set with env var INEXT_ACCESS_KEY
+}
+
+resource "inext_rate_limit_practice" "my_rate_limit_practice" {
+  name       = "my rate limit practice"
+  visibility = "Shared" # Optional: "Shared" (default) or "Local"
+
+  # Multiple rate limit rules
+  rule {
+    uri     = "/api/v1/users"
+    scope   = "Minute"              # Required: "Minute" or "Second"
+    limit   = 100                   # Required: number of requests allowed
+    action  = "Detect"              # Optional: "Detect", "Prevent", or "AccordingToPractice" (default)
+    comment = "User API rate limit" # Optional: description of the rule
+  }
+
+  rule {
+    uri     = "/api/v1/login"
+    scope   = "Second"
+    limit   = 5
+    action  = "Prevent"
+    comment = "Login endpoint strict rate limit"
+  }
+
+  rule {
+    uri     = "/api/v1/search"
+    scope   = "Minute"
+    limit   = 200
+    action  = "AccordingToPractice"
+    comment = "Search API with higher limit"
+  }
+}
+
+# Example with minimal configuration (only required fields)
+resource "inext_rate_limit_practice" "minimal_example" {
+  name = "minimal rate limit practice"
+
+  rule {
+    uri   = "/api/minimal"
+    scope = "Minute"
+    limit = 50
+  }
+}
+```
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Required
+
+- `name` (String) The name of the resource, also acts as its unique ID
+
+### Optional
+
+- `rule` (Block Set) Rate limit rules (see [below for nested schema](#nestedblock--rule))
+- `visibility` (String) The visibility of the resource, Shared or Local
+
+### Read-Only
+
+- `category` (String)
+- `default` (Boolean)
+- `id` (String) The ID of this resource.
+- `practice_type` (String)
+
+<a id="nestedblock--rule"></a>
+### Nested Schema for `rule`
+
+Required:
+
+- `limit` (Number) The actual number of requests to enable
+- `scope` (String) The time unit during which the rate limit is enfrorced. Must be one of: Minute, Second
+- `uri` (String)
+
+Optional:
+
+- `action` (String) The action to perform upon a request which crosses the rate limit. Must be one of: Detect, Prevent, AccordingToPractice (case sensitive!!). Defaults to AccordingToPractice
+- `comment` (String) A general comment which describes the rate limit rule
+
+Read-Only:
+
+- `id` (String) The ID of this resource.
+
+

docs/resources/inext_trusted_sources.md

@@ -17,7 +17,7 @@ terraform {
   required_providers {
     inext = {
       source  = "CheckPointSW/infinity-next"
-      version = "1.1.7"
+      version = "1.2.0"
     }
   }
 }

docs/resources/inext_web_api_asset.md

@@ -17,7 +17,7 @@ terraform {
   required_providers {
     inext = {
       source  = "CheckPointSW/infinity-next"
-      version = "1.1.7"
+      version = "1.2.0"
     }
   }
 }
@@ -37,9 +37,10 @@ resource "inext_web_api_asset" "my-webapi-asset" {
   practice {
     main_mode = "Learn" # enum of ["Prevent", "Inactive", "Disabled", "Learn"]
     sub_practices_modes = {
-      IPS    = "AccordingToPractice" # enum of ["Detect", "Prevent", "Inactive", "AccordingToPractice", "Disabled", "Learn", "Active"]
-      WebBot = "AccordingToPractice" # enum of ["Detect", "Prevent", "Inactive", "AccordingToPractice", "Disabled", "Learn", "Active"]
-      Snort  = "Disabled"            # enum of ["Detect", "Prevent", "Inactive", "AccordingToPractice", "Disabled", "Learn", "Active"]
+      IPS          = "AccordingToPractice" # enum of ["Detect", "Prevent", "Inactive", "AccordingToPractice", "Disabled", "Learn", "Active"]
+      WebBot       = "AccordingToPractice" # enum of ["Detect", "Prevent", "Inactive", "AccordingToPractice", "Disabled", "Learn", "Active"]
+      Snort        = "Disabled"            # enum of ["Detect", "Prevent", "Inactive", "AccordingToPractice", "Disabled", "Learn", "Active"]
+      APIDiscovery = "Active"              # enum of ["Active", "Disabled"]
     }
     id       = inext_web_api_practice.my-webapi-practice.id # required
     triggers = [inext_log_trigger.mytrigger.id]