{
  "opencollection": "1.0.0",
  "info": {
    "name": "Akamai: API Endpoint Definition Access tokens Include versions API",
    "version": "2"
  },
  "items": [
    {
      "info": {
        "name": "Include versions",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Akamai List Include Versions",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{hostname}/api-definitions/v2/includes/:includeId/versions",
            "headers": [
              {
                "name": "PAPI-Use-Prefixes",
                "value": "{{PAPI-Use-Prefixes}}"
              }
            ],
            "params": [
              {
                "name": "includeId",
                "value": "{{includeId}}",
                "type": "path",
                "description": "Unique identifier for the include. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting the value's `inc_` prefix."
              },
              {
                "name": "offset",
                "value": "{{offset}}",
                "type": "query",
                "description": "For paginated responses, specifies the page of results you want to navigate to, starting from `0`."
              },
              {
                "name": "limit",
                "value": "{{limit}}",
                "type": "query",
                "description": "For paginated responses, specifies the number of `hostnames` objects to include on each page."
              },
              {
                "name": "contractId",
                "value": "{{contractId}}",
                "type": "query",
                "description": "Unique identifier for the contract. The parameter is optional if a property belongs to only one contract. Otherwise you need to specify it along with the `groupId`. In other operations that don't specify a `propertyId` URL parameter, this parameter is always required. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting the value's `ctr_` prefix."
              },
              {
                "name": "groupId",
                "value": "{{groupId}}",
                "type": "query",
                "description": "Unique identifier for the group. The parameter is optional if a property belongs to only one group. Otherwise you need to specify it along with the `contractId`. In other operations that don't specify a `propertyId` URL parameter, this parameter is always required. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting the value's `grp_` prefix."
              },
              {
                "name": "accountSwitchKey",
                "value": "{{accountSwitchKey}}",
                "type": "query",
                "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys)."
              }
            ]
          },
          "docs": "__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](https://techdocs.akamai.com/property-mgr/reference/post-includes)."
        },
        {
          "info": {
            "name": "Akamai Create a New Include Version",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{hostname}/api-definitions/v2/includes/:includeId/versions",
            "headers": [
              {
                "name": "PAPI-Use-Prefixes",
                "value": "{{PAPI-Use-Prefixes}}"
              }
            ],
            "params": [
              {
                "name": "includeId",
                "value": "{{includeId}}",
                "type": "path",
                "description": "Unique identifier for the include. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting the value's `inc_` prefix."
              },
              {
                "name": "contractId",
                "value": "{{contractId}}",
                "type": "query",
                "description": "Unique identifier for the contract. The parameter is optional if a property belongs to only one contract. Otherwise you need to specify it along with the `groupId`. In other operations that don't specify a `propertyId` URL parameter, this parameter is always required. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting the value's `ctr_` prefix."
              },
              {
                "name": "groupId",
                "value": "{{groupId}}",
                "type": "query",
                "description": "Unique identifier for the group. The parameter is optional if a property belongs to only one group. Otherwise you need to specify it along with the `contractId`. In other operations that don't specify a `propertyId` URL parameter, this parameter is always required. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting the value's `grp_` prefix."
              },
              {
                "name": "accountSwitchKey",
                "value": "{{accountSwitchKey}}",
                "type": "query",
                "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys)."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "__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."
        },
        {
          "info": {
            "name": "Akamai Get the Latest Include Version",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{hostname}/api-definitions/v2/includes/:includeId/versions/latest",
            "headers": [
              {
                "name": "PAPI-Use-Prefixes",
                "value": "{{PAPI-Use-Prefixes}}"
              }
            ],
            "params": [
              {
                "name": "includeId",
                "value": "{{includeId}}",
                "type": "path",
                "description": "Unique identifier for the include. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting the value's `inc_` prefix."
              },
              {
                "name": "activatedOn",
                "value": "{{activatedOn}}",
                "type": "query",
                "description": "__Enum__ If present, returns the latest version activated on the given network, either `STAGING` or `PRODUCTION`."
              },
              {
                "name": "contractId",
                "value": "{{contractId}}",
                "type": "query",
                "description": "Unique identifier for the contract. The parameter is optional if a property belongs to only one contract. Otherwise you need to specify it along with the `groupId`. In other operations that don't specify a `propertyId` URL parameter, this parameter is always required. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting the value's `ctr_` prefix."
              },
              {
                "name": "groupId",
                "value": "{{groupId}}",
                "type": "query",
                "description": "Unique identifier for the group. The parameter is optional if a property belongs to only one group. Otherwise you need to specify it along with the `contractId`. In other operations that don't specify a `propertyId` URL parameter, this parameter is always required. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting the value's `grp_` prefix."
              },
              {
                "name": "accountSwitchKey",
                "value": "{{accountSwitchKey}}",
                "type": "query",
                "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys)."
              }
            ]
          },
          "docs": "__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."
        },
        {
          "info": {
            "name": "Akamai Get an Include Version",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{hostname}/api-definitions/v2/includes/:includeId/versions/:includeVersion",
            "headers": [
              {
                "name": "PAPI-Use-Prefixes",
                "value": "{{PAPI-Use-Prefixes}}"
              }
            ],
            "params": [
              {
                "name": "includeId",
                "value": "{{includeId}}",
                "type": "path",
                "description": "Unique identifier for the include. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting the value's `inc_` prefix."
              },
              {
                "name": "includeVersion",
                "value": "{{includeVersion}}",
                "type": "path",
                "description": "Include's incremental version number."
              },
              {
                "name": "contractId",
                "value": "{{contractId}}",
                "type": "query",
                "description": "Unique identifier for the contract. The parameter is optional if a property belongs to only one contract. Otherwise you need to specify it along with the `groupId`. In other operations that don't specify a `propertyId` URL parameter, this parameter is always required. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting the value's `ctr_` prefix."
              },
              {
                "name": "groupId",
                "value": "{{groupId}}",
                "type": "query",
                "description": "Unique identifier for the group. The parameter is optional if a property belongs to only one group. Otherwise you need to specify it along with the `contractId`. In other operations that don't specify a `propertyId` URL parameter, this parameter is always required. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting the value's `grp_` prefix."
              },
              {
                "name": "accountSwitchKey",
                "value": "{{accountSwitchKey}}",
                "type": "query",
                "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys)."
              }
            ]
          },
          "docs": "__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."
        },
        {
          "info": {
            "name": "Akamai List Available Behaviors for an Include",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{hostname}/api-definitions/v2/includes/:includeId/versions/:includeVersion/available-behaviors",
            "headers": [
              {
                "name": "PAPI-Use-Prefixes",
                "value": "{{PAPI-Use-Prefixes}}"
              }
            ],
            "params": [
              {
                "name": "includeId",
                "value": "{{includeId}}",
                "type": "path",
                "description": "Unique identifier for the include. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting the value's `inc_` prefix."
              },
              {
                "name": "includeVersion",
                "value": "{{includeVersion}}",
                "type": "path",
                "description": "Include's incremental version number."
              },
              {
                "name": "contractId",
                "value": "{{contractId}}",
                "type": "query",
                "description": "Unique identifier for the contract. The parameter is optional if a property belongs to only one contract. Otherwise you need to specify it along with the `groupId`. In other operations that don't specify a `propertyId` URL parameter, this parameter is always required. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting the value's `ctr_` prefix."
              },
              {
                "name": "groupId",
                "value": "{{groupId}}",
                "type": "query",
                "description": "Unique identifier for the group. The parameter is optional if a property belongs to only one group. Otherwise you need to specify it along with the `contractId`. In other operations that don't specify a `propertyId` URL parameter, this parameter is always required. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting the value's `grp_` prefix."
              },
              {
                "name": "accountSwitchKey",
                "value": "{{accountSwitchKey}}",
                "type": "query",
                "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys)."
              }
            ]
          },
          "docs": "__Limited availability__ Lists the set of [behaviors](https://techdocs.akamai.com/property-mgr/reference/ga-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."
        },
        {
          "info": {
            "name": "Akamai List Available Criteria for an Include",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{hostname}/api-definitions/v2/includes/:includeId/versions/:includeVersion/available-criteria",
            "headers": [
              {
                "name": "PAPI-Use-Prefixes",
                "value": "{{PAPI-Use-Prefixes}}"
              }
            ],
            "params": [
              {
                "name": "includeId",
                "value": "{{includeId}}",
                "type": "path",
                "description": "Unique identifier for the include. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting the value's `inc_` prefix."
              },
              {
                "name": "includeVersion",
                "value": "{{includeVersion}}",
                "type": "path",
                "description": "Include's incremental version number."
              },
              {
                "name": "contractId",
                "value": "{{contractId}}",
                "type": "query",
                "description": "Unique identifier for the contract. The parameter is optional if a property belongs to only one contract. Otherwise you need to specify it along with the `groupId`. In other operations that don't specify a `propertyId` URL parameter, this parameter is always required. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting the value's `ctr_` prefix."
              },
              {
                "name": "groupId",
                "value": "{{groupId}}",
                "type": "query",
                "description": "Unique identifier for the group. The parameter is optional if a property belongs to only one group. Otherwise you need to specify it along with the `contractId`. In other operations that don't specify a `propertyId` URL parameter, this parameter is always required. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting the value's `grp_` prefix."
              },
              {
                "name": "accountSwitchKey",
                "value": "{{accountSwitchKey}}",
                "type": "query",
                "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys)."
              }
            ]
          },
          "docs": "__Limited availability__ Lists the set of [criteria](https://techdocs.akamai.com/property-mgr/reference/ga-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."
        }
      ]
    }
  ],
  "bundled": true
}