Include versions

Number of APIs: 6

1. Create a new include version

POST https://{{host}}/papi/v1/includes/:includeId/versions

Limited availability Create a new include version based on any previous version. All data from the createFromVersion populates the new version. Specify createFromVersionEtag if you want to ensure you're creating from a version that hasn't changed since you fetched it.

---

2. List include versions

GET https://{{host}}/papi/v1/includes/:includeId/versions

Limited availability Lists the include's versions, with results limited to the 500 most recent versions. Optionally paginate the results. Each include version indicates an activation status on different networks, and an etag digest useful when cloning the include.

---

3. Get the latest include version

GET https://{{host}}/papi/v1/includes/:includeId/versions/latest

Limited availability This operation provides either the latest include version overall, or the latest one active on the production or staging networks. By default, the response yields the include version with the highest number. Specifying an activatedOn of STAGING or PRODUCTION yields the version that's currently active on either network.

---

4. Get an include version

GET https://{{host}}/papi/v1/includes/:includeId/versions/:includeVersion

Limited availability This polls the state of a specific include version, for example to check its activation status. When specifying Accept: text/xml, this operation provides the Akamai metadata configuration data that's distributed to edge servers when you activate an include version. This XML data encapsulates the include version's component rules and is available on a read-only basis. Contact your Akamai representative if you need help interpreting it.

---

5. List available behaviors for an include

GET https://{{host}}/papi/v1/includes/:includeId/versions/:includeVersion/available-behaviors

Limited availability Lists the set of behaviors you may apply within an include version's rules. The available set depends on the product under which you created the property and any additional modules enabled under your account.

---

6. List available criteria for an include

GET https://{{host}}/papi/v1/includes/:includeId/versions/:includeVersion/available-criteria

Limited availability Lists the set of criteria you may apply within an include version's rules. The available set depends on the product under which you created the property and any additional modules enabled under your account.

---