--- updatedAt: 2026-03-01T18:48:48.000Z agentTools: siteIndex: https://techdocs.akamai.com/llms.txt projectIndex: https://techdocs.akamai.com/property-mgr/llms.txt --- # List include 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](ref:post-includes). # OpenAPI definition ```json { "externalDocs": { "description": "See documentation for Akamai's Property Manager API", "url": "https://techdocs.akamai.com/property-mgr/reference" }, "info": { "license": { "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, "title": "Includes", "version": "v0" }, "openapi": "3.1.0", "paths": { "/includes/{includeId}/versions": { "get": { "description": "__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).", "externalDocs": { "description": "See documentation for this operation in Akamai's Property Manager API", "url": "https://techdocs.akamai.com/property-mgr/reference/get-include-versions" }, "operationId": "get-include-versions", "parameters": [ { "description": "For paginated responses, specifies the page of results you want to navigate to, starting from `0`.", "in": "query", "name": "offset", "required": false, "schema": { "example": 10, "minimum": 0, "type": "integer" }, "x-akamai": { "file-path": "parameters/offset-query.yaml" } }, { "description": "For paginated responses, specifies the number of `hostnames` objects to include on each page.", "in": "query", "name": "limit", "required": false, "schema": { "example": 50, "minimum": 1, "type": "integer" }, "x-akamai": { "file-path": "parameters/limit-optional.yaml" } }, { "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.", "in": "query", "name": "contractId", "required": false, "schema": { "example": "ctr_K-0N7RAK71", "type": "string" }, "x-akamai": { "file-path": "parameters/contract-id-optional.yaml" } }, { "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.", "in": "query", "name": "groupId", "required": false, "schema": { "example": "grp_54321", "type": "string" }, "x-akamai": { "file-path": "parameters/group-id-optional.yaml" } }, { "description": "__Enum__ Sets whether to represent [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) in response data. Set to `false` when exchanging PAPI data with other APIs.", "in": "header", "name": "PAPI-Use-Prefixes", "required": true, "schema": { "enum": [ "true", "false" ], "example": "false", "type": "string" }, "x-akamai": { "file-path": "parameters/papi-use-prefixes-header.yaml" } }, { "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).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "accountId": "act_A-CCT7890", "assetId": "aid_101", "contractId": "ctr_K-0N7RAK71", "groupId": "grp_32145", "includeId": "inc_173136", "includeName": "my.new.include.com", "includeType": "COMMON_SETTINGS", "versions": { "items": [ { "etag": "5891b5b522d5df08", "includeVersion": 2, "note": "updated caching", "productId": "prd_Alta", "productionStatus": "INACTIVE", "ruleFormat": "v2022-10-18", "stagingStatus": "ACTIVE", "updatedByUser": "jsmith", "updatedDate": "2022-10-22T19:06:13Z" }, { "etag": "71573b922a87abc3", "includeVersion": 1, "note": "initial version", "productId": "prd_Alta", "productionStatus": "ACTIVE", "ruleFormat": "v2022-10-18", "stagingStatus": "INACTIVE", "updatedByUser": "jsmith", "updatedDate": "2022-10-22T21:12:57Z" } ] } }, "schema": { "$schema": "http://json-schema.org/draft-04/schema#", "additionalProperties": false, "description": "A common outer wrapping object structure. It provides additional contextual details for a set of requested data. The data itself is available under various inner members' `items` array.", "existingJavaType": "java.lang.Object", "id": "resource:/descriptors/papi/v1/schemas/GetIncludeVersionResponse.json#", "properties": { "accountId": { "description": "Identifies the prevailing account under which you requested the data. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on how to omit the ID's `act_` prefix.", "type": "string" }, "assetId": { "description": "An alternative identifier for the include. Use this value to key the include in the Identity and Access Management API. See [Manage properties and includes](https://techdocs.akamai.com/iam-api/reference/manage-access-to-properties-and-includes).", "type": "string" }, "contractId": { "description": "Identifies the prevailing contract under which you requested the data. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on how to omit the ID's `ctr_` prefix.", "type": "string" }, "groupId": { "description": "Identifies the prevailing group under which you requested the data. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on how to omit the ID's `grp_` prefix.", "type": "string" }, "includeId": { "description": "The include's unique identifier. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on how to omit the ID's `inc_` prefix.", "type": "string" }, "includeName": { "description": "A unique, descriptive name for the include. It's not modifiable after you initially create it on a [POST](https://techdocs.akamai.com/property-mgr/reference/post-includes) request.", "pattern": "^[A-Za-z0-9._-]+$", "type": "string" }, "includeType": { "description": "The type of an include. `MICROSERVICES` specifies includes with a separate access control and activation flow, which allows different teams to work independently on different parts of a single site. In a parent property's rule tree, you add the `MICROSERVICES` includes to rules with mutually exclusive path matches. `COMMON_SETTINGS` specifies includes used across different properties that share a significant number of settings. In a parent property's rule tree, you add the `COMMON_SETTINGS` includes to the default rule or rules without any matches. By updating or activating a single `COMMON_SETTINGS` include, the changes take effect immediately across all sites that use this include. You can use this member for filtering and grouping similar includes together.", "enum": [ "COMMON_SETTINGS", "MICROSERVICES" ], "type": "string" }, "versions": { "additionalProperties": false, "description": "The set of requested include versions, available within an `items` array.", "properties": { "items": { "description": "Specifies the version of an include. Relevant response objects appear within the outer envelope's `versions.items` array.", "items": { "additionalProperties": false, "properties": { "etag": { "description": "A digest with which to check the data's integrity. See [Concurrency control](https://techdocs.akamai.com/property-mgr/reference/concurrency-control) for guidance.", "type": "string" }, "includeVersion": { "description": "A positive integer identifying the incremental version.", "minimum": 1, "type": "integer" }, "note": { "description": "A descriptive log comment.", "type": "string" }, "productId": { "description": "The product assigned to the include when versioned. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on how to omit the ID's `inc_` prefix.", "type": "string" }, "productionStatus": { "description": "Whether the version has been activated to the production network. If `ACTIVE`, the version is read-only. It's `INACTIVE` if another version has superseded this one. It's `PENDING` if the [activation request](https://techdocs.akamai.com/property-mgr/reference/post-include-activation) is in progress. It's `PENDING_CANCELLATION` or `ABORTED` if the client [cancelled a pending activation](https://techdocs.akamai.com/property-mgr/reference/delete-include-activation) in time. It's `PENDING_DEACTIVATION` or `DEACTIVATED` when set to no longer serve traffic.", "enum": [ "ACTIVE", "INACTIVE", "PENDING", "ABORTED", "DEACTIVATED", "PENDING_DEACTIVATION", "PENDING_CANCELLATION" ], "type": "string" }, "ruleFormat": { "description": "Identifies the rule format currently assigned to the include version's rule tree.", "type": "string" }, "stagingStatus": { "description": "Whether the version has been activated to the test network. If `ACTIVE`, the version is read-only. It's `INACTIVE` if another version has superseded this one. It's `PENDING` if the [activation request](https://techdocs.akamai.com/property-mgr/reference/post-include-activation) is in progress. It's `PENDING_CANCELLATION` or `ABORTED` if the client [cancelled a pending activation](https://techdocs.akamai.com/property-mgr/reference/delete-include-activation) in time. It's `PENDING_DEACTIVATION` or `DEACTIVATED` when set to no longer serve traffic.", "enum": [ "ACTIVE", "INACTIVE", "PENDING", "ABORTED", "DEACTIVATED", "PENDING_DEACTIVATION", "PENDING_CANCELLATION" ], "type": "string" }, "updatedByUser": { "description": "The username who last updated the version.", "type": "string" }, "updatedDate": { "description": "The date stamp of the version's latest update.", "type": "string" } }, "required": [ "etag", "note", "productId", "productionStatus", "includeVersion", "stagingStatus", "updatedByUser", "updatedDate" ], "type": "object" }, "type": "array" } }, "type": "object" } }, "type": "object", "x-akamai": { "file-path": "schemas/include-version-get-response.yaml" } } } }, "description": "The response lists include versions for the requested include.", "headers": { "X-RateLimit-Limit": { "description": "Maximum sustainable number of request allowed each minute per account. This rate limit protects PAPI resources from being exhausted by single users. Once you exceed the limit, you receive the [429](https://techdocs.akamai.com/property-mgr/reference/429) error. If you call PAPI using multiple API clients within the same account, the rate limit applies globally to all API clients.\n\nThis API also provides a burst limit that specifies how many requests you can make in excess of the imposed rate limit. The one-time burst limit is 1000 requests. Once you consume all available resources, the burst capacity increases steadily by 100 requests every minute, until it reaches its initial maximum limit of 1000.", "schema": { "type": "integer" }, "x-akamai": { "file-path": "headers/x-rate-limit-limit.yaml" } }, "X-RateLimit-Remaining": { "description": "Remaining number of requests allowed each minute per account. See [Rate and resource limiting](https://techdocs.akamai.com/property-mgr/reference/rate-and-resource-limiting) for details.", "schema": { "type": "integer" }, "x-akamai": { "file-path": "headers/x-rate-limit-remaining.yaml" } } } }, "400": { "content": { "application/problem+json": { "example": { "detail": "The system cannot understand your request. Please check the syntax and correct any problems.", "instance": "/papi/v1/properties?contractId=ctr_K-0N7RAK71&groupId=grp_12345#abc12345abcc02a7", "status": 400, "title": "Bad Request", "type": "https://problems.luna.akamaiapis.net/papi/v0/http/bad-request" }, "schema": { "additionalProperties": false, "description": "Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.", "items": { "additionalProperties": false, "description": "Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "format": "uri", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "format": "uri", "type": "string" } }, "required": [ "type", "title", "status", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Bad request](https://techdocs.akamai.com/property-mgr/reference/400).", "x-akamai": { "file-path": "errors/400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "detail": "The request requires authentication.", "instance": "/papi/v1/properties?contractId=ctr_C-0N7RAC71&groupId=grp_12345#abc12345abcc02a7", "status": 401, "title": "Unauthorized", "type": "https://problems.luna.akamaiapis.net/papi/v0/http/unauthorized" }, "schema": { "additionalProperties": false, "description": "Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.", "items": { "additionalProperties": false, "description": "Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "format": "uri", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "format": "uri", "type": "string" } }, "required": [ "type", "title", "status", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Unauthorized](https://techdocs.akamai.com/property-mgr/reference/401).", "x-akamai": { "file-path": "errors/401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "The authorization token you provided does not allow access to this resource.", "instance": "/papi/v1/properties?contractId=ctr_C-0N7RAC71&groupId=grp_12345#abc12345abcc02a7", "status": 403, "title": "Forbidden", "type": "https://problems.luna.akamaiapis.net/papi/v1/http/forbidden" }, "schema": { "additionalProperties": false, "description": "Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.", "items": { "additionalProperties": false, "description": "Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "format": "uri", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "format": "uri", "type": "string" } }, "required": [ "type", "title", "status", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Forbidden](https://techdocs.akamai.com/property-mgr/reference/403).", "x-akamai": { "file-path": "errors/403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "The system was unable to locate the requested resource.", "instance": "/papi/v1/properties?contractId=ctr_K-0N7RAK7&groupId=grp_12345#abc12345abcc02a7", "status": 404, "title": "Not Found", "type": "https://problems.luna.akamaiapis.net/papi/v1/http/not-found" }, "schema": { "additionalProperties": false, "description": "Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.", "items": { "additionalProperties": false, "description": "Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "format": "uri", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "format": "uri", "type": "string" } }, "required": [ "type", "title", "status", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Not found](https://techdocs.akamai.com/property-mgr/reference/404).", "x-akamai": { "file-path": "errors/404.yaml" } }, "405": { "content": { "application/problem+json": { "example": { "detail": "The system does not support the method you provided for this resource.", "instance": "/papi/v1/properties?contractId=ctr_C-0N7RAC71&groupId=grp_12345#abc12345abcc02a7", "status": 405, "title": "Method not allowed", "type": "https://problems.luna.akamaiapis.net/papi/v1/http/method-not-allowed" }, "schema": { "additionalProperties": false, "description": "Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.", "items": { "additionalProperties": false, "description": "Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "format": "uri", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "format": "uri", "type": "string" } }, "required": [ "type", "title", "status", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Method not allowed](https://techdocs.akamai.com/property-mgr/reference/405).", "x-akamai": { "file-path": "errors/405.yaml" } }, "406": { "content": { "application/problem+json": { "example": { "detail": "The system does not support the content-type restrictions provided by your 'Accept' header.", "instance": "papi/v1/build#abc12345abcc02a7", "status": 406, "title": "Not Acceptable", "type": "https://problems.luna.akamaiapis.net/papi/v1/http/not-acceptable" }, "schema": { "additionalProperties": false, "description": "Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.", "items": { "additionalProperties": false, "description": "Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "format": "uri", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "format": "uri", "type": "string" } }, "required": [ "type", "title", "status", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Not acceptable](https://techdocs.akamai.com/property-mgr/reference/406).", "x-akamai": { "file-path": "errors/406.yaml" } }, "429": { "content": { "application/problem+json": { "example": { "detail": "Too many includes exist on contract ctr_1-12345. You must delete an include before continuing.", "instance": "/papi/v1/includes?contractId=ctr_K-0N7RAK7&groupId=grp_12345#abc12345abcc02a7", "instanceKey": "1-12345", "limit": 500, "limitKey": "INCLUDES_PER_CONTRACT", "remaining": 0, "status": 429, "title": "Too many includes", "type": "https://problems.luna.akamaiapis.net/papi/v1/limit-exceeded" }, "schema": { "additionalProperties": false, "description": "Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.", "items": { "additionalProperties": false, "description": "Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "format": "uri", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "instanceKey": { "description": "Identifies the resource the limit is imposed on.", "minLength": 1, "type": "string" }, "limit": { "description": "The overall limit.", "type": "integer" }, "limitKey": { "description": "The limit that got exceeded with the operation.", "minLength": 1, "type": "string" }, "remaining": { "description": "Number of items left to deploy.", "type": "integer" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "format": "uri", "type": "string" } }, "required": [ "type", "title", "status", "detail", "instance", "limitKey", "instanceKey", "limit", "remaining" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-429.yaml" } } } }, "description": "[Too many requests](https://techdocs.akamai.com/property-mgr/reference/429).", "x-akamai": { "file-path": "errors/429.yaml" } }, "500": { "content": { "application/problem+json": { "example": { "detail": "Our system is experiencing errors. We''ll get this fixed as soon as possible.", "instance": "/papi/v1/properties/12345/activations#abc12345abcc02a7", "status": 500, "title": "Internal Server Error", "type": "https://problems.luna.akamaiapis.net/papi/proxy/internal-server-error" }, "schema": { "additionalProperties": false, "description": "Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.", "items": { "additionalProperties": false, "description": "Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "format": "uri", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "format": "uri", "type": "string" } }, "required": [ "type", "title", "status", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Internal server error](https://techdocs.akamai.com/property-mgr/reference/500).", "x-akamai": { "file-path": "errors/500.yaml" } } }, "summary": "List include versions", "tags": [ "Include versions" ], "x-akamai": { "status": "LA" } }, "parameters": [ { "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.", "in": "path", "name": "includeId", "required": true, "schema": { "example": "inc_175780", "type": "string" }, "x-akamai": { "file-path": "parameters/include-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/include-versions.yaml", "path-for-file": "/includes/{includeId}/versions" }, "x-akamai-descriptor-tools": { "displayName": "includeVersions", "group": "Include versions" } } }, "servers": [ { "url": "https://{hostname}/papi/v1" } ], "x-akamai": { "auth-type": "EDGE_GRID", "file-path": "02-includes.yaml" }, "x-readme": { "samples-languages": [ "curl", "python", "node" ], "explorer-enabled": true, "proxy-enabled": true } } ``` # Sibling pages * [Create a new include version](https://techdocs.akamai.com/property-mgr/reference/post-include-versions.md) * [Get the latest include version](https://techdocs.akamai.com/property-mgr/reference/get-latest-include-version.md) * [Get an include version](https://techdocs.akamai.com/property-mgr/reference/get-include-version.md) * [List available behaviors for an include](https://techdocs.akamai.com/property-mgr/reference/get-include-available-behaviors.md) * [List available criteria for an include](https://techdocs.akamai.com/property-mgr/reference/get-include-available-criteria.md)