---
updatedAt: 2026-03-01T18:01:57.000Z
agentTools:
  siteIndex: https://techdocs.akamai.com/llms.txt
  projectIndex: https://techdocs.akamai.com/terraform/v9.3/llms.txt
---

# Include

akamai_property_include

Create, update, or delete an include and its rule tree.

* To use non-declarative includes without behaviors, your rules and includes can use any supported rule format version as long as both your rules and includes are the same version.
* To use declarative includes with behaviors, your rules and includes must use a rule format no earlier than `v2023-01-05`.  For information on updating to a later version, see [Update rule format](https://techdocs.akamai.com/terraform/docs/set-up-includes#update-rule-format).

<div><p></p></div>

> 📘
>
> To delete an include, run `terraform destroy`.

```json Declaration
resource "akamai_property_include" "my_example" {
    contract_id = "ctr_C-0N7RAC7"
    group_id    = "grp_12345"
    product_id  = "prd_Object_Delivery"
    name        = "my new include"
    rule_format = "v2023-05-30"
    type        = "MICROSERVICES"
    rules       = file("${path.root}/property-snippets/main.json")
}
```

## Arguments

Send your account IDs, a name for your include, and the rule format it follows in the declaration.

[block:parameters]
{
  "data": {
    "h-0": "Argument",
    "h-1": "Required",
    "h-2": "Description",
    "0-0": "`contract_id`",
    "0-1": "✔️",
    "0-2": "Your contract's ID.",
    "1-0": "`group_id`",
    "1-1": "✔️",
    "1-2": "Your group's ID.",
    "2-0": "`product_id`",
    "2-1": "✔️",
    "2-2": "Your product ID to include the `prd_` prefix. See [Common identifiers](https://techdocs.akamai.com/terraform/docs/common-identifiers#product-ids) for a list of product IDs.",
    "3-0": "`name`",
    "3-1": "✔️",
    "3-2": "A human-readable, descriptive name for your include.",
    "4-0": "`rule_format`",
    "4-1": "✔️",
    "4-2": "A versioned rule schema and set of available behaviors and criteria. If not provided, we apply the latest rule format by default.",
    "5-0": "`rules`",
    "5-1": "",
    "5-2": "The location of your rules. Use the path to a local file or a variable that represents the output of the [Rules builder](https://techdocs.akamai.com/terraform/docs/pm-ds-rules-builder) or [Rules template](https://techdocs.akamai.com/terraform/docs/pm-ds-rules-template) data source.",
    "6-0": "`type`",
    "6-1": "",
    "6-2": "Specifies the type of include. Used for filtering. One of:<ul><li><code>MICROSERVICES</code>. Allows different teams to work independently on different parts of a single site.</li><li><code>COMMON_SETTINGS</code>. Use for configurations that share a large number of settings, often managed by a central team.</li></ul>"
  },
  "cols": 3,
  "rows": 7,
  "align": [
    null,
    "center",
    null
  ]
}
[/block]

## Attributes

Setting an output option returns to you a computed set about your include that contains its ID among other details.

| Attribute            | Description                                                                                                                                                                                                                 |
| -------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id`                 | Your include's ID.                                                                                                                                                                                                          |
| `name`               | A human-readable, descriptive name for your include.                                                                                                                                                                        |
| `rule_format`        | Your include's versioned rule schema.                                                                                                                                                                                       |
| `rules`              | The location of your include's JSON formatted rules. Use the path to a local file or a variable that represents the output of the \[rules builder(doc:rules-builder) or [rules-template](pm-ds-rules-template) data source. |
| `rule_errors`        | Any rule validation errors. You need to resolve returned errors as they block an activation. For more on errors, see [Validation errors](https://techdocs.akamai.com/property-mgr/reference/validation-errors)              |
| `rule_warnings`      | Any rule validation warnings. You can activate a version that yields less severe warnings.                                                                                                                                  |
| `latest_version`     | The most recent version of the include.                                                                                                                                                                                     |
| `staging_version`    | The include version currently activated on the staging network.                                                                                                                                                             |
| `production_version` | The include version currently activated on the production network.                                                                                                                                                          |
| `type`               | Your include's type.                                                                                                                                                                                                        |
| `version_notes`      | Additional information about an include version.                                                                                                                                                                            |

# Sibling pages

* [Activation](https://techdocs.akamai.com/terraform/v9.3/docs/pm-rc-activation.md)
* [CP code](https://techdocs.akamai.com/terraform/v9.3/docs/pm-rc-cp-code.md)
* [Domains](https://techdocs.akamai.com/terraform/v9.3/docs/pm-rc-domains.md)
* [Domain validation](https://techdocs.akamai.com/terraform/v9.3/docs/pm-rc-domain-validation.md)
* [Edge hostname](https://techdocs.akamai.com/terraform/v9.3/docs/pm-rc-edge-hostname.md)
* [Hostname bucket](https://techdocs.akamai.com/terraform/v9.3/docs/pm-rc-hostname-bucket.md)
* [Include activation](https://techdocs.akamai.com/terraform/v9.3/docs/pm-rc-include-activation.md)
* [Property](https://techdocs.akamai.com/terraform/v9.3/docs/pm-rc-property.md)