URL protection policies

akamai_appsec_url_protection_policies

📘

Beta

Hello. Just a note to let you know the underlying API on which this data source is built is general release and has been vetted, but because this is a new feature for our Terraform provider, we've given it beta label.

This status just means we've paused for a bit to get your feedback to make sure this data source works like you need and expect.

Get information about your protection policies.

data "akamai_appsec_url_protection_policies" "my_protection_policies" {
  config_id = 12345

output "my_protection_policies" {
  value = data.akamai_appsec_url_protection_policies.my_protection_policies
}
my_protection_policies = {
  config_id = 12345,
  url_protection_policies = [
    {
      api_definitions = null,
      bypass_conditions = null,
      config_id = 12345,
      create_date = "2026-03-18T17:21:05Z",
      created_by = "jsmith",
      description = null,
      hostname_paths = [
        {
          hostname = "my-url-protections-policy.com",
          paths = [
            "/*"
          ]
        }
      ],
      intelligent_load_shedding = null,
      max_rate_threshold = 50,
      name = "My URL protection policy2",
      update_date = "2026-03-18T17:21:05Z",
      updated_by = "jsmith",
      url_protection_policy_id = 789012,
      used = false
    },
    {
      api_definitions = null,
      bypass_conditions = [
        {
          name_wildcard = null,
          names = null,
          type = "NetworkListCondition",
          value_case_sensitive = null,
          value_wildcard = null,
          values = [
            "119049_GEOBLOCKLIST"
          ]
        }
      ],
      config_id = 12345,
      create_date = "2026-02-27T18:40:02Z",
      created_by = "jsmith",
      description = "My URL protection policy2",
      hostname_paths = [
        {
          hostname = "my-url-protections-policy.com",
          paths = [
            "/*"
          ]
        }
      ],
      intelligent_load_shedding = {
        categories = [
          "BOTS",
          "CLIENT_REPUTATIONS",
          "CLOUD_PROVIDERS",
          "PLATFORM_DDOS_INTELLIGENCE",
          "PROXIES",
          "TOR_EXIT_NODES"
        ],
        custom_criteria = null,
        hits_per_sec = 10
      },
      max_rate_threshold = 20,
      name = "My URL protection policy",
      update_date = "2026-02-27T18:40:02Z",
      updated_by = "jsmith",
      url_protection_policy_id = 987654,
      used = true
    }
  ]
}

Arguments

Pass a security configuration's ID in a config_id argument to get information about your URL protection policies.

Attributes

Returned is the given security configuration's url_protection_policies set with data about each of your policies.

AttributeDescription
nameA URL protection policy's name.
url_protection_policy_idA URL protection policy's ID.
descriptionA human-readable statement about the URL protection policy.
bypass_conditionsA list of bypass conditions for the URL protection policy. Contains:
  • type. The type of condition. Value is either RequestHeaderCondition or NetworkListCondition.
  • names. A list of header names used with RequestHeaderCondition.
  • name_wildcard. When set to true, uses wildcard matching for header names.
  • values. A list of values for the condition.
  • value_case_sensitive. When set to true, uses case-sensitive value matching.
  • value_wildcard. When set to true, uses wildcard matching for values.
max_rate_thresholdThe maximum hits per second in any five-second interval.
api_definitionsA list of API endpoints on which to match incoming requests. Contains:
  • api_definition_id. An API's ID.
  • defined_resources. When set to true, matches on the resources added to your API definition.
  • resource_ids. A list of resource IDs for an endpoint.
  • undefined_resources. When set to true, matches on resources not added to your API definition.
hostname_pathsA list of hostnames on which to match and their path configurations. Contains:
  • hostname. A hostname on which to match.
  • paths. A list of paths associated with the hostname.
intelligent_load_sheddingYour load shedding configuration settings. Contains:
  • hits_per_sec. The number of hits-per-second threshold.
  • categories. The traffic categories on which to perform load shedding. Possible values are:
    • BOTS
    • CLIENT_REPUTATIONS
    • CLOUD_PROVIDERS
    • PLATFORM_DDOS_INTELLIGENCE
    • PROXIES
    • TOR_EXIT_NODES
  • custom_criteria. Any custom criteria for load shedding. Contains:
    • type. The custom criteria type.
    • list_ids. A list of your client list IDs.
    • positive_match. When set to true, sheds on a positive match.
usedWhen set to true, URL protections are active.
create_dateCreation date of the URL protection policy.
created_byThe name of the user who created the URL protection policy.
update_dateDate of the URL protection policy's last change.
updated_byThe name of the user who last changed the URL protection policy.