openapi: 3.0.0 info: title: 'Akamai: API Endpoint Definition Access tokens Search API' version: '2' license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html servers: - url: https://{hostname}/api-definitions/v2 tags: - name: Search paths: /search/find-by-value: x-akamai: file-path: paths/search.yaml path-for-file: /search/find-by-value x-akamai-descriptor-tools: displayName: findByValue group: Find by Value post: description: This operation searches includes by name, or properties either by name, hostname, or edge hostname for which they're currently active. Specify a search request object with a single query member. The response lists the matching set of currently active property or include versions, and also the latest version if inactive. Each of the response's versions features additional context for the property or include in which it appears, or the account, contract, or group under which it's deployed. Note that to perform more complex searches for content within a rule tree, run [Bulk search a set of properties or includes](https://techdocs.akamai.com/property-mgr/reference/post-bulk-search) instead. operationId: post-search-find-by-value summary: Akamai Search Properties or Includes tags: - Search externalDocs: description: See documentation for this operation in Akamai's Property Manager API url: https://techdocs.akamai.com/property-mgr/reference/post-search-find-by-value requestBody: required: true content: application/json: example: propertyName: www.example.com_pm schema: $schema: http://json-schema.org/draft-04-schema# description: A query to search currently active properties or includes. You can only include one query member in the POST request. id: resource:/descriptors/papi/v1/schemas/SearchPropertyVersionsBySingleValueRequestV0.json# javaType: com.akamai.luna.papi.model.SearchFindByValueRequest maxProperties: 1 minProperties: 1 type: object properties: edgeHostname: description: Search for property versions active on a specific edge hostname. example: '{{edgeHostname}}' type: string hostname: description: Search for property versions active on a specific hostname. example: '{{hostname}}' type: string includeName: description: Search for includes by name. example: '{{includeName}}' type: string propertyName: description: Search for properties by name. example: '{{propertyName}}' type: string x-akamai: file-path: schemas/search-include-or-property-versions.yaml responses: '200': description: The response lists matching property versions or includes. content: application/json: example: versions: items: - accountId: act_A-CCT1234 assetId: aid_10333526 contractId: ctr_C-0N7RAC71 groupId: grp_41443 productionStatus: INACTIVE propertyId: prp_243865 propertyName: fifi2 propertyVersion: 6 stagingStatus: INACTIVE updatedByUser: mrossi updatedDate: '2017-08-07T15:39:49Z' - accountId: act_A-CCT1234 assetId: aid_10333526 contractId: ctr_C-0N7RAC7 groupId: grp_41443 productionStatus: ACTIVE propertyId: prp_243865 propertyName: fifi2 propertyVersion: 1 stagingStatus: INACTIVE updatedByUser: afero updatedDate: '2015-06-27T20:37:16Z' 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. id: resource:/descriptors/papi/v1/schemas/PostSearchResponse.json# type: object required: - versions properties: versions: additionalProperties: false description: The full set of property or include versions. type: object required: - items properties: items: description: Each property or include version. type: array items: additionalProperties: false type: object 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 property. Use this value to key the property 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: Identifies the include for the version yielded in search results. 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 descriptive name for the include whose version appears in search results. type: string productionStatus: description: Whether the version has been activated to the production network. If `ACTIVE`, the version is read-only and currently serving traffic. 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-property-activations) is in progress. It's `PENDING_CANCELLATION` or `ABORTED` if the client [cancelled a pending activation](https://techdocs.akamai.com/property-mgr/reference/delete-property-activation) in time. It's `PENDING_DEACTIVATION` or `DEACTIVATED` when set to no longer serve traffic. type: string enum: - ACTIVE - INACTIVE - PENDING - ABORTED - DEACTIVATED - PENDING_DEACTIVATION - PENDING_CANCELLATION propertyId: description: Identifies the property for the version yielded in search results, or its component rules or hostnames. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on how to omit the ID's `prp_` prefix. Don't use this value if you want to exchange data with the Identity and Access Manager API. See [Manage properties and includes](https://techdocs.akamai.com/iam-api/reference/manage-access-to-properties-and-includes). type: string propertyName: description: A descriptive name for the property whose version appears in search results. type: string propertyVersion: description: When searching for properties, this provides a positive integer identifying the incremental version. minimum: 1 type: integer stagingStatus: description: Whether the version has been activated to the test network. If `ACTIVE`, the version is read-only and currently serving traffic. 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-property-activations) is in progress. It's `PENDING_CANCELLATION` or `ABORTED` if the client [cancelled a pending activation](https://techdocs.akamai.com/property-mgr/reference/delete-property-activation) in time. It's `PENDING_DEACTIVATION` or `DEACTIVATED` when set to no longer serve traffic. type: string enum: - ACTIVE - INACTIVE - PENDING - ABORTED - DEACTIVATED - PENDING_DEACTIVATION - PENDING_CANCELLATION updatedByUser: description: The username who last updated the new version. type: string updatedDate: description: The date stamp of the version's latest update. type: string versions: additionalProperties: false description: The set of requested property or include versions, available within an `items` array. type: object properties: items: description: Specifies the version of an include or property. Relevant response objects appear within the outer envelope's `versions.items` array. Additional contextual members appear in POST response listings when [searching include or property versions](https://techdocs.akamai.com/property-mgr/reference/post-search-find-by-value). type: array items: additionalProperties: false type: object required: - accountId - assetId - contractId - groupId - productionStatus - stagingStatus - updatedByUser - updatedDate properties: accountId: description: Identifies the account under which the property version is active. 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 property. Use this value to key the property 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 contract under which the property version is active. 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 edgeHostname: description: When searching for `hostname` or `edgeHostname`, this shows the relevant edge hostname to which the active version currently applies. type: string groupId: description: Identifies the group under which the property version is active. 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 hostname: description: When searching for `hostname` or `edgeHostname`, this shows the relevant property hostname to which the active version currently applies. type: string includeId: description: When searching for includes, this identifies the include to which the listed version belongs. 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: When searching for includes, this provides the name of the include to which the listed version belongs. type: string includeType: description: When searching for includes, provides the type of the include for the listed version. `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 `MICROSERVICE` 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. type: string enum: - MICROSERVICES - COMMON_SETTINGS includeVersion: description: When searching for includes, this provides a positive integer identifying the incremental version. minimum: 1 type: integer productionStatus: description: Whether the version has been activated to the production network. If `ACTIVE`, the version is read-only and currently serving traffic. It's `INACTIVE` if another version has superseded this one. It's `PENDING` if the [property activation request](https://techdocs.akamai.com/property-mgr/reference/post-property-activations) or [include 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 [property activation](https://techdocs.akamai.com/property-mgr/reference/delete-property-activation) or [include 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. type: string enum: - ACTIVE - INACTIVE - PENDING - ABORTED - DEACTIVATED - PENDING_DEACTIVATION - PENDING_CANCELLATION propertyId: description: When searching for properties, this identifies the property to which the listed version belongs. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on how to omit the ID's `prp_` prefix. Don't use this value if you want to exchange data with the Identity and Access Manager API. See [Manage properties and includes](https://techdocs.akamai.com/iam-api/reference/manage-access-to-properties-and-includes). type: string propertyName: description: When searching for properties, this provides the name of the property to which the listed version belongs. type: string propertyVersion: description: When searching for properties, this provides a positive integer identifying the incremental version. minimum: 1 type: integer stagingStatus: description: Whether the version has been activated to the test network. If `ACTIVE`, the version is read-only and currently serving traffic. It's `INACTIVE` if another version has superseded this one. It's `PENDING` if the [property activation request](https://techdocs.akamai.com/property-mgr/reference/post-property-activations) or [include 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 [property activation](https://techdocs.akamai.com/property-mgr/reference/delete-property-activation) or [include 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. type: string enum: - ACTIVE - INACTIVE - PENDING - ABORTED - DEACTIVATED - PENDING_DEACTIVATION - PENDING_CANCELLATION updatedByUser: description: The username who last updated the new version. type: string updatedDate: description: The date stamp of the version's latest update. type: string x-akamai: file-path: schemas/search-post-response.yaml '400': description: '[Bad request](https://techdocs.akamai.com/property-mgr/reference/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_C-0N7RAC7&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. type: object required: - type - title - status - detail - instance 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. minItems: 0 type: array uniqueItems: true items: additionalProperties: false description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format. type: object required: - type - title - detail 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 x-akamai: file-path: schemas/problem-nested.yaml 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 x-akamai: file-path: schemas/problem.yaml x-akamai: file-path: errors/400.yaml '401': description: '[Unauthorized](https://techdocs.akamai.com/property-mgr/reference/401).' content: application/problem+json: example: detail: The request requires authentication. instance: /papi/v1/properties?contractId=ctr_C-0N7RAC7&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. type: object required: - type - title - status - detail - instance 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. minItems: 0 type: array uniqueItems: true items: additionalProperties: false description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format. type: object required: - type - title - detail 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 x-akamai: file-path: schemas/problem-nested.yaml 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 x-akamai: file-path: schemas/problem.yaml x-akamai: file-path: errors/401.yaml '403': description: '[Forbidden](https://techdocs.akamai.com/property-mgr/reference/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-0N7RAC7&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. type: object required: - type - title - status - detail - instance 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. minItems: 0 type: array uniqueItems: true items: additionalProperties: false description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format. type: object required: - type - title - detail 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 x-akamai: file-path: schemas/problem-nested.yaml 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 x-akamai: file-path: schemas/problem.yaml x-akamai: file-path: errors/403.yaml '404': description: '[Not found](https://techdocs.akamai.com/property-mgr/reference/404).' content: application/problem+json: example: detail: The system was unable to locate the requested resource. instance: /papi/v1/properties?contractId=ctr_C-0N7RAC7&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. type: object required: - type - title - status - detail - instance 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. minItems: 0 type: array uniqueItems: true items: additionalProperties: false description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format. type: object required: - type - title - detail 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 x-akamai: file-path: schemas/problem-nested.yaml 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 x-akamai: file-path: schemas/problem.yaml x-akamai: file-path: errors/404.yaml '405': description: '[Method not allowed](https://techdocs.akamai.com/property-mgr/reference/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-0N7RAC7&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. type: object required: - type - title - status - detail - instance 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. minItems: 0 type: array uniqueItems: true items: additionalProperties: false description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format. type: object required: - type - title - detail 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 x-akamai: file-path: schemas/problem-nested.yaml 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 x-akamai: file-path: schemas/problem.yaml x-akamai: file-path: errors/405.yaml '406': description: '[Not acceptable](https://techdocs.akamai.com/property-mgr/reference/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. type: object required: - type - title - status - detail - instance 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. minItems: 0 type: array uniqueItems: true items: additionalProperties: false description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format. type: object required: - type - title - detail 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 x-akamai: file-path: schemas/problem-nested.yaml 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 x-akamai: file-path: schemas/problem.yaml x-akamai: file-path: errors/406.yaml '415': description: '[Unsupported media type](https://techdocs.akamai.com/property-mgr/reference/415).' content: application/problem+json: example: detail: Our system does not support requests in the format you're sending. instance: /papi/v1/properties?contractId=ctr_C-0N7RAC7&groupId=grp_12345#abc12345abcc02a7 status: 415 title: Unsupported Media Type type: https://problems.luna.akamaiapis.net/papi/v1/http/unsupported-media-type schema: additionalProperties: false description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format. type: object required: - type - title - status - detail - instance 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. minItems: 0 type: array uniqueItems: true items: additionalProperties: false description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format. type: object required: - type - title - detail 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 x-akamai: file-path: schemas/problem-nested.yaml 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 x-akamai: file-path: schemas/problem.yaml x-akamai: file-path: errors/415.yaml '429': description: '[Too many requests](https://techdocs.akamai.com/property-mgr/reference/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_C-0N7RAC7&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. type: object required: - type - title - status - detail - instance - limitKey - instanceKey - limit - remaining 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. minItems: 0 type: array uniqueItems: true items: additionalProperties: false description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format. type: object required: - type - title - detail 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 x-akamai: file-path: schemas/problem-nested.yaml 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 x-akamai: file-path: schemas/problem-429.yaml x-akamai: file-path: errors/429.yaml '500': description: '[Internal server error](https://techdocs.akamai.com/property-mgr/reference/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. type: object required: - type - title - status - detail - instance 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. minItems: 0 type: array uniqueItems: true items: additionalProperties: false description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format. type: object required: - type - title - detail 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 x-akamai: file-path: schemas/problem-nested.yaml 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 x-akamai: file-path: schemas/problem.yaml x-akamai: file-path: errors/500.yaml parameters: - 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. example: '{{PAPI-Use-Prefixes}}' in: header name: PAPI-Use-Prefixes required: true schema: example: 'false' type: string enum: - 'true' - 'false' 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). example: '{{accountSwitchKey}}' in: query name: accountSwitchKey required: false schema: example: 1-5C0YLB:1-8BYUX type: string externalDocs: description: See documentation for Akamai's API Endpoint Definition API url: https://techdocs.akamai.com/api-definitions/reference x-readme: samples-languages: - curl - python - node