{
"openapi": "3.1.0",
"externalDocs": {
"description": "See documentation for Akamai's Property Manager API",
"url": "https://techdocs.akamai.com/property-mgr/reference"
},
"info": {
"title": "Akamai: Property Manager API",
"version": "v0",
"license": {
"name": "Apache 2.0",
"url": "https://www.apache.org/licenses/LICENSE-2.0.html"
}
},
"paths": {
"/build": {
"get": {
"description": "Gets information about the current API release. Note that available information about version numbers and build dates are unrelated to the overall API version or to various rule format versions. See [API versioning](https://techdocs.akamai.com/property-mgr/reference/api-versioning) for details.",
"operationId": "get-build",
"summary": "Akamai Get Build Details",
"tags": [
"Build"
],
"externalDocs": {
"description": "See documentation for this operation in Akamai's Property Manager API",
"url": "https://techdocs.akamai.com/property-mgr/reference/get-build"
},
"responses": {
"200": {
"description": "The response shows the current build.",
"content": {
"application/json": {
"example": {
"coreVersion": "14.2",
"currentCatalogVersion": "14.2.6",
"catalogGitInfo": {
"branch": "candidate-14.2",
"buildDate": "2014-05-26T23:56:21Z",
"commitDate": "2014-05-26T23:55:53Z",
"commitId": "59a193acdf26ba6de1522486411a749f19efde8c"
},
"coreGitInfo": {
"branch": "14.2",
"buildDate": "2014-04-25T17:02:43Z",
"commitDate": "2014-04-25T17:01:11Z",
"commitId": "22163903cb91a62492dfce745aaa95de991b0653"
}
},
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"additionalProperties": false,
"description": "Provides details on the software build.",
"id": "resource:/descriptors/papi/v1/schemas/GetBuildResponse.json#",
"type": "object",
"required": [
"catalogGitInfo",
"coreGitInfo",
"coreVersion",
"currentCatalogVersion"
],
"properties": {
"catalogGitInfo": {
"additionalProperties": false,
"description": "Specifies internal tracking data.",
"type": "object",
"required": [
"branch",
"buildDate",
"commitDate",
"commitId"
],
"properties": {
"branch": {
"description": "The name of the build's branch.",
"type": "string"
},
"buildDate": {
"description": "When the code was built.",
"type": "string"
},
"commitDate": {
"description": "When the final commit occurred.",
"type": "string"
},
"commitId": {
"description": "An opaque data signature for the final commit.",
"type": "string"
}
}
},
"coreGitInfo": {
"additionalProperties": false,
"description": "Specifies internal tracking data.",
"type": "object",
"required": [
"branch",
"buildDate",
"commitDate",
"commitId"
],
"properties": {
"branch": {
"description": "The name of the build's branch.",
"type": "string"
},
"buildDate": {
"description": "When the code was built.",
"type": "string"
},
"commitDate": {
"description": "When the final commit occurred.",
"type": "string"
},
"commitId": {
"description": "An opaque data signature for the final commit.",
"type": "string"
}
}
},
"coreVersion": {
"description": "The Property Manager version.",
"type": "string"
},
"currentCatalogVersion": {
"description": "The version of the Property Manager catalog that specifies rule [behaviors](https://techdocs.akamai.com/property-mgr/reference/ga-behaviors) and [criteria](https://techdocs.akamai.com/property-mgr/reference/ga-criteria). Note that this _catalog_ isn't the same as the rule format version available in the [List rule formats](https://techdocs.akamai.com/property-mgr/reference/get-rule-formats) operation.",
"type": "string"
}
},
"x-akamai": {
"file-path": "schemas/build-get-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"
}
},
"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": "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"
}
}
]
},
"x-akamai": {
"file-path": "paths/build.yaml",
"path-for-file": "/build"
}
},
"/bulk/activations": {
"post": {
"description": "Bulk activate a set of property versions. Alternately, perform a bulk [fallback](https://techdocs.akamai.com/property-mgr/reference/property-activation-error-handling) to the previous activation within an hour of the previous bulk activation. Base the set of versions to activate on the results of a [bulk patch](https://techdocs.akamai.com/property-mgr/reference/get-bulk-patch) operation, which you use in this operation's request. This operation launches an asynchronous process to update properties. To check its progress, run the [List bulk-activated properties](https://techdocs.akamai.com/property-mgr/reference/get-bulk-activation) operation, whose link is available in the `Location` header or `bulkActivationLink` member of this operation's response. See [Bulk Search and Update](https://techdocs.akamai.com/property-mgr/reference/bulk-search-and-update) for overall guidance on this feature.",
"operationId": "post-bulk-activations",
"summary": "Akamai Bulk Activate a Set of Properties",
"tags": [
"Bulk activations"
],
"externalDocs": {
"description": "See documentation for this operation in Akamai's Property Manager API",
"url": "https://techdocs.akamai.com/property-mgr/reference/post-bulk-activations"
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"example": {
"defaultActivationSettings": {
"acknowledgeAllWarnings": true,
"fastPush": true,
"useFastFallback": false,
"notifyEmails": [
"you@example.com",
"them@example.com"
]
},
"activatePropertyVersions": [
{
"network": "STAGING",
"note": "Some activation note",
"propertyId": "prp_1",
"propertyVersion": 2
},
{
"network": "STAGING",
"note": "Sample activation",
"propertyId": "prp_15",
"propertyVersion": 3,
"notifyEmails": [
"someoneElse@somewhere.com"
]
},
{
"acknowledgeAllWarnings": false,
"network": "PRODUCTION",
"note": "created by xyz",
"propertyId": "prp_3",
"propertyVersion": 11,
"acknowledgeWarnings": [
"msg_123",
"msg_234"
]
}
]
},
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Encapsulates each batch of bulk activations. While essentially a wrapper for an activation object array, this specifies additional settings to apply to all activations within the batch.",
"id": "resource:/descriptors/papi/v1/schemas/CreateNewBulkActivationOrDeactivationRequestV0.json#",
"javaType": "com.akamai.devops.model.BulkPropertyActivationCreateRequest",
"type": "object",
"required": [
"activatePropertyVersions"
],
"properties": {
"activatePropertyVersions": {
"description": "Specifies each property version to include in the bulk activation. Following bulk activation, this reflects the activation state for each property.",
"type": "array",
"items": {
"type": "object",
"required": [
"propertyId",
"propertyVersion",
"network"
],
"properties": {
"acknowledgeWarnings": {
"description": "Lists property warning `messageId` values to acknowledge, unnecessary when `acknowledgeAllWarnings` is enabled.",
"type": "array",
"items": {
"type": "string"
}
},
"network": {
"description": "The network on which to activate this property, either `STAGING` or `PRODUCTION`.",
"type": "string",
"enum": [
"STAGING",
"PRODUCTION"
]
},
"note": {
"description": "An optional log message for this property's activation.",
"type": "string"
},
"propertyId": {
"description": "Identifies each property targeted for activation. 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).",
"pattern": "^(prp_|PRP_)?[0-9]+$",
"type": "string"
},
"propertyVersion": {
"description": "The property version targeted for activation. Once activated, you can no longer modify that version of the property.",
"minimum": 1,
"type": "integer"
}
}
}
},
"defaultActivationSettings": {
"description": "Specifies activation settings to apply to all properties.",
"type": "object",
"properties": {
"acknowledgeAllWarnings": {
"description": "For all activations, skip acknowledging any warnings for all properties within the bulk activation job. Unless this is enabled, you need to specify `acknowledgeWarnings` arrays with `messageId` warning values for each activation.",
"type": "boolean"
},
"fastPush": {
"default": true,
"description": "Enable fast metadata push when bulk activating properties, `true` by default.",
"type": "boolean"
},
"notifyEmails": {
"description": "Email addresses to notify when the activation status changes for any property within the bulk activation. Note that you can supplement additional email addresses for each property you activate.",
"minItems": 0,
"type": "array",
"items": {
"type": "string"
}
},
"useFastFallback": {
"description": "When enabled, rolls back to the previous activation of each property included in the bulk activation job. If you [bulk activate a set of properties](https://techdocs.akamai.com/property-mgr/reference/post-bulk-activations), and then within one hour discover a serious problem you didn't previously detect, enabling this in a follow-up bulk activation request effectively cancels all the activations. See [Revert a property activation](https://techdocs.akamai.com/property-mgr/reference/property-activation-error-handling) for guidance. Note that while the fast fallback option ordinarily doesn't apply to activations that affect a different set of hostnames, this scenario is unlikely when bulk-modifying properties.",
"type": "boolean"
}
}
}
},
"x-akamai": {
"file-path": "schemas/bulk-property-activation-create-request.yaml"
}
}
}
}
},
"responses": {
"202": {
"description": "The response links the bulk activation process.",
"content": {
"application/json": {
"example": {
"bulkActivationLink": "/papi/v0/bulk/activations/311?contractId=ctr_C-0N7RAC7&groupId=grp_15225"
},
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"additionalProperties": false,
"description": "Provides a hypermedia link to a newly created resource. The response's single member name indicates the type of resource.",
"id": "resource:/descriptors/papi/v1/schemas/PostBulkActivationResponse.json#",
"type": "object",
"required": [
"bulkActivationLink"
],
"properties": {
"bulkActivationLink": {
"description": "Links the newly created bulk activation process.",
"type": "string"
}
},
"x-akamai": {
"file-path": "schemas/bulk-property-activation-post-response.yaml"
}
}
}
},
"headers": {
"Location": {
"description": "Provides a URL path you can GET the newly created resource from.",
"schema": {
"type": "string"
},
"x-akamai": {
"file-path": "headers/Location.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": "Optionally filters bulk searches to properties created under the specified contract. For bulk operations, you can specify `contractId` and `groupId` independently from each other.",
"example": "{{contractId}}",
"in": "query",
"name": "contractId",
"required": false,
"schema": {
"example": "ctr_1-1TJZFW",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/contractId-optional-bulk.yaml"
}
},
{
"description": "Optionally filters bulk searches to properties created under the specified group. For bulk operations, you can specify `contractId` and `groupId` independently from each other.",
"example": "{{groupId}}",
"in": "query",
"name": "groupId",
"required": false,
"schema": {
"example": "grp_15166",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/groupId-optional-bulk.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"
}
}
]
},
"x-akamai": {
"file-path": "paths/bulk-activations.yaml",
"path-for-file": "/bulk/activations"
},
"x-akamai-descriptor-tools": {
"displayName": "bulkPropertyActivations",
"group": "Bulk property activations"
}
},
"/bulk/activations/{bulkActivationId}": {
"get": {
"description": "List all activations that result from a [bulk activation request](https://techdocs.akamai.com/property-mgr/reference/post-bulk-activations). Once the overall `bulkActivationStatus` is `COMPLETE`, check each activation's `activationStatus` to confirm it's `ACTIVATED`. See [Bulk Search and Update](https://techdocs.akamai.com/property-mgr/reference/bulk-search-and-update) for overall guidance on this feature.",
"operationId": "get-bulk-activation",
"summary": "Akamai List Bulk-activated Properties",
"tags": [
"Bulk activations"
],
"externalDocs": {
"description": "See documentation for this operation in Akamai's Property Manager API",
"url": "https://techdocs.akamai.com/property-mgr/reference/get-bulk-activation"
},
"responses": {
"200": {
"description": "The response shows the bulk activation job, which proceeds until the `bulkActivationStatus` is `COMPLETE`.",
"content": {
"application/json": {
"example": {
"bulkActivationId": 234,
"bulkActivationStatus": "COMPLETE",
"bulkActivationSubmitDate": "2018-01-18T00:00:00Z",
"bulkActivationUpdateDate": "2018-01-18T01:00:00Z",
"defaultActivationSettings": {
"acknowledgeAllWarnings": true,
"fastPush": true,
"useFastFallback": false
},
"activatePropertyVersions": [
{
"acknowledgeAllWarnings": true,
"activationStatus": "NEW",
"activationSubmitDate": "2018-01-18T00:00:00Z",
"activationUpdateDate": "2018-01-18T00:00:00Z",
"fastPush": true,
"network": "STAGING",
"note": "Some activation note",
"propertyActivationLink": "/papi/v1/properties/prp_1/activations/act_1",
"propertyId": "prp_1",
"propertyVersion": 2,
"taskStatus": "COMPLETE",
"useFastFallback": false,
"notifyEmails": [
"you@example.com",
"them@example.com"
]
},
{
"acknowledgeAllWarnings": true,
"activationStatus": "NEW",
"activationSubmitDate": "2018-01-18T00:00:00Z",
"activationUpdateDate": "2018-01-18T00:00:00Z",
"fastPush": true,
"network": "STAGING",
"note": "Sample activation",
"numberOfWarningsFromActivation": 5,
"propertyActivationLink": "/papi/v1/properties/prp_1/activations/act_1",
"propertyId": "prp_15",
"propertyVersion": 3,
"taskStatus": "COMPLETE",
"useFastFallback": false,
"notifyEmails": [
"someoneElse@somewhere.com"
]
},
{
"acknowledgeAllWarnings": false,
"activationStatus": "NEW",
"activationSubmitDate": "2018-01-18T00:00:00Z",
"activationUpdateDate": "2018-01-18T00:00:00Z",
"fastPush": true,
"network": "PRODUCTION",
"note": "created by xyz",
"propertyActivationLink": "/papi/v1/properties/prp_1/activations/act_1",
"propertyId": "prp_3",
"propertyVersion": 11,
"taskStatus": "COMPLETE",
"useFastFallback": false,
"notifyEmails": [
"you@example.com",
"them@example.com"
]
},
{
"acknowledgeAllWarnings": false,
"activationStatus": "NEW",
"activationSubmitDate": "2018-01-18T00:00:00Z",
"activationUpdateDate": "2018-01-18T00:00:00Z",
"fastPush": true,
"network": "STAGING",
"note": "Some activation note",
"propertyActivationLink": "/papi/v1/properties/prp_1/activations/act_1",
"propertyId": "prp_4",
"propertyVersion": 2,
"taskStatus": "SUBMISSION_ERROR",
"useFastFallback": false,
"notifyEmails": [
"you@example.com",
"them@example.com"
],
"activationWarnings": [
{
"detail": "The CP Code within `Content Provider Code` isn't configured for use with the product used by this property, Dynamic Site Accelerator. Traffic for this property might not show up under the correct traffic reports.",
"messageId": "msg_48d27043qr3r2322781ac6dd06763470987ed7a5d",
"type": "https://problems.luna.akamaiapis.net/papi/v0/validation/product_behavior_issue.cpcode_incorrect_product"
}
]
},
{
"acknowledgeAllWarnings": true,
"activationStatus": "NEW",
"activationSubmitDate": "2018-01-18T00:00:00Z",
"activationUpdateDate": "2018-01-18T00:00:00Z",
"fastPush": true,
"fatalError": "activation requires a valid notifyEmail",
"network": "STAGING",
"note": "Some activation note",
"propertyActivationLink": "/papi/v1/properties/prp_1/activations/act_1",
"propertyId": "prp_5",
"propertyVersion": 3,
"taskStatus": "SUBMISSION_ERROR",
"useFastFallback": false
}
]
},
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"additionalProperties": false,
"description": "Encapsulates each batch of bulk activations. While essentially a wrapper for an activation object array, this specifies additional settings to apply to all activations within the batch. See [Bulk Search and Update](https://techdocs.akamai.com/property-mgr/reference/bulk-search-and-update) for guidance on this feature.",
"id": "resource:/descriptors/papi/v1/schemas/GetBulkActivationResponse.json#",
"javaType": "com.akamai.devops.model.BulkPropertyActivationResourcesResponse",
"type": "object",
"required": [
"bulkActivationId",
"bulkActivationStatus",
"bulkActivationSubmitDate",
"bulkActivationUpdateDate"
],
"properties": {
"activatePropertyVersions": {
"description": "Specifies each property version to include in the bulk activation. Following bulk activation, this reflects the activation state for each property.",
"type": "array",
"items": {
"additionalProperties": false,
"type": "object",
"required": [
"propertyId",
"propertyVersion",
"acknowledgeAllWarnings",
"useFastFallback",
"fastPush",
"network",
"activationStatus",
"activationSubmitDate",
"activationUpdateDate",
"propertyActivationLink"
],
"properties": {
"acknowledgeAllWarnings": {
"description": "Indicates whether you specified `acknowledgeAllWarnings` as part of the bulk activation request's `defaultActivationSettings`. This allows properties to activate despite any warnings.",
"type": "boolean"
},
"activationErrors": {
"description": "Validation errors that prevented a bulk activation.",
"minItems": 0,
"type": "array",
"items": {
"additionalProperties": false,
"type": "object",
"properties": {
"detail": {
"description": "Provides context for the problem that triggered the error.",
"type": "string"
},
"type": {
"description": "A URI that identifies each error case. See the [Errors](https://techdocs.akamai.com/property-mgr/reference/api-errors) section for details on each.",
"type": "string"
}
}
}
},
"activationStatus": {
"description": "This property's initial activation status usually `NEW`. Values are the same as for individual activations: `ACTIVE`, `INACTIVE`, `NEW`, `PENDING`, `ZONE_1`, `ZONE_2`, `ZONE_3`, `ABORTED`, `FAILED`, `PENDING_DEACTIVATION` or `DEACTIVATED`.",
"type": "string",
"enum": [
"ACTIVE",
"INACTIVE",
"PENDING",
"ZONE_1",
"ZONE_2",
"ZONE_3",
"ABORTED",
"FAILED",
"DEACTIVATED",
"PENDING_DEACTIVATION",
"NEW"
]
},
"activationSubmitDate": {
"description": "An ISO 8601 timestamp indicating when activation initiated for this property.",
"type": "string"
},
"activationUpdateDate": {
"description": "An ISO 8601 timestamp indicating when this property's `activationStatus` last changed.",
"type": "string"
},
"activationWarnings": {
"description": "Validation warnings resulting from the bulk activation. You need to acknowledge them when bulk-activating property versions.",
"minItems": 0,
"type": "array",
"items": {
"additionalProperties": false,
"type": "object",
"properties": {
"detail": {
"description": "Provides context for the problem that triggered the warning.",
"type": "string"
},
"messageId": {
"description": "Identifies the validation warnings. You may need it to acknowledge when bulk-activating property versions. Specifying `acknowledgeAllWarnings` avoids the need to acknowledge specific warnings.",
"type": "string"
},
"type": {
"description": "A URI that identifies each warning case. See the [Errors](https://techdocs.akamai.com/property-mgr/reference/api-errors) section for details on each.",
"type": "string"
}
}
}
},
"fastPush": {
"description": "Whether you specified `fastPush` as part of the bulk activation request's `defaultActivationSettings`. This allows properties to rely on fast metadata push.",
"type": "boolean"
},
"fatalError": {
"description": "Indicates an error that prevented this property version from activating.",
"type": "string"
},
"network": {
"description": "The network on which to activate this property, either `STAGING` or `PRODUCTION`.",
"type": "string",
"enum": [
"STAGING",
"PRODUCTION"
]
},
"note": {
"description": "An optional log message for this property's activation.",
"type": "string"
},
"notifyEmails": {
"description": "Email addresses to notify when this property's `activationStatus` changes. Note that these may supplement the set of `notifyEmails` specified within the bulk activation request's `defaultActivationSettings`.",
"minItems": 0,
"type": "array",
"items": {
"type": "string"
}
},
"numberOfWarningsFromActivation": {
"description": "This counts the number of non-blocking warnings present in the activated rule tree.",
"minimum": 0,
"type": "integer"
},
"propertyActivationLink": {
"description": "Provides an API hypermedia link to each activation within the bulk activation job.",
"type": "string"
},
"propertyId": {
"description": "Identifies each property targeted for activation within the bulk activation job. 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": "Identifies the property name targeted for activation within the bulk activation job.",
"type": "string"
},
"propertyVersion": {
"description": "Identifies the property version targeted for activation within the bulk activation job. Once activated, you can no longer modify that version of the property.",
"minimum": 1,
"type": "integer"
},
"taskStatus": {
"description": "This property's initial task status. Values are the same as for individual activations: `PENDING`, `IN_PROGRESS`, `SUBMITTED`, `INTERRUPTED`, `SUBMISSION_ERROR`, and `COMPLETE`.",
"type": "string",
"enum": [
"PENDING",
"IN_PROGRESS",
"SUBMITTED",
"INTERRUPTED",
"SUBMISSION_ERROR",
"COMPLETE"
]
},
"useFastFallback": {
"description": "Indicates whether you sepcified `useFastFallback` as part of the bulk activation request's `defaultActivationSettings`. This allows properties to quickly fall back to the previous activation.",
"type": "boolean"
}
}
}
},
"bulkActivationId": {
"description": "Unique identifier for each bulk activation request.",
"minimum": 1,
"type": "integer"
},
"bulkActivationStatus": {
"description": "Reflects the status of the entire bulk update request, either `PENDING`, `IN_PROGRESS`, or `COMPLETE`.",
"type": "string",
"enum": [
"PENDING",
"COMPLETE",
"IN_PROGRESS"
]
},
"bulkActivationSubmitDate": {
"description": "An ISO 8601 timestamp indicating when the bulk activation process initiated.",
"type": "string"
},
"bulkActivationUpdateDate": {
"description": "An ISO 8601 timestamp indicating when the `bulkActivationStatus` last changed.",
"type": "string"
},
"defaultActivationSettings": {
"additionalProperties": false,
"description": "Common settings to apply to all activations in the batch.",
"type": "object",
"properties": {
"acknowledgeAllWarnings": {
"description": "Indicates whether you specified `acknowledgeAllWarnings` as part of the bulk activation request's `defaultActivationSettings`. This allows properties to activate despite any warnings.",
"type": "boolean"
},
"fastPush": {
"description": "Indicates whether you specified `fastPush` as part of the bulk activation request's `defaultActivationSettings`. This allows properties to rely on fast metadata push.",
"type": "boolean"
},
"notifyEmails": {
"description": "Email addresses to notify when the activation status changes for any property within the bulk activation. Note that you can supplement additional email addresses for each property you activate.",
"minItems": 0,
"type": "array",
"items": {
"type": "string"
}
},
"useFastFallback": {
"description": "Indicates whether you specified `useFastFallback` as part of the bulk activation request's `defaultActivationSettings`. This allows properties to quickly fall back to the previous activation.",
"type": "boolean"
}
}
},
"message": {
"description": "A notification in case the bulk request repeatedly fails to process.",
"type": "string"
}
},
"x-akamai": {
"file-path": "schemas/bulk-property-activation-get-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"
}
},
"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": "Optionally filters bulk searches to properties created under the specified contract. For bulk operations, you can specify `contractId` and `groupId` independently from each other.",
"example": "{{contractId}}",
"in": "query",
"name": "contractId",
"required": false,
"schema": {
"example": "ctr_1-1TJZFW",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/contractId-optional-bulk.yaml"
}
},
{
"description": "Optionally filters bulk searches to properties created under the specified group. For bulk operations, you can specify `contractId` and `groupId` independently from each other.",
"example": "{{groupId}}",
"in": "query",
"name": "groupId",
"required": false,
"schema": {
"example": "grp_15166",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/groupId-optional-bulk.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"
}
}
]
},
"x-akamai": {
"file-path": "paths/bulk-activation.yaml",
"path-for-file": "/bulk/activations/{bulkActivationId}"
},
"x-akamai-descriptor-tools": {
"displayName": "bulkPropertyActivation",
"group": "Bulk property activations"
},
"parameters": [
{
"description": "Identifies each bulk activation job.",
"example": "{{bulkActivationId}}",
"in": "path",
"name": "bulkActivationId",
"required": true,
"schema": {
"example": 234,
"type": "integer"
},
"x-akamai": {
"file-path": "parameters/bulkActivationId-path.yaml"
}
}
]
},
"/bulk/property-version-creations": {
"post": {
"description": "Create new versions of a set of properties based on any previous version. This operation launches an asynchronous process to increment versions. To check its progress, run the [List bulk-versioned properties](https://techdocs.akamai.com/property-mgr/reference/get-bulk-version) operation, whose link is available in the `Location` header or `bulkCreateVersionLink` member of this operation's response. Run this operation only after [bulk searching](https://techdocs.akamai.com/property-mgr/reference/post-bulk-search) a set of properties you want to change, to prepare new versions to bulk patch. See [Bulk Search and Update](https://techdocs.akamai.com/property-mgr/reference/bulk-search-and-update) for guidance on this feature.",
"operationId": "post-bulk-version",
"summary": "Akamai Bulk Version a Set of Properties",
"tags": [
"Bulk versioning"
],
"externalDocs": {
"description": "See documentation for this operation in Akamai's Property Manager API",
"url": "https://techdocs.akamai.com/property-mgr/reference/post-bulk-version"
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"example": {
"createPropertyVersions": [
{
"createFromVersion": 1,
"createFromVersionEtag": "2641910c585cf67b",
"propertyId": "prp_1"
},
{
"createFromVersion": 2,
"createFromVersionEtag": "343410c585cf67fc",
"propertyId": "prp_15"
},
{
"createFromVersion": 10,
"createFromVersionEtag": "6c7v5c65c6cvcv65",
"propertyId": "prp_3"
}
]
},
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Encapsulates a set of properties from which to bulk create new versions.",
"id": "resource:/descriptors/papi/v1/schemas/CreateNewBulkPropertyVersionRequestV0.json#",
"javaType": "com.akamai.devops.model.BulkPropertyVersionCreateRequest",
"type": "object",
"required": [
"createPropertyVersions"
],
"properties": {
"createPropertyVersions": {
"description": "Encapsulates information about each new property version to create.",
"type": "array",
"items": {
"type": "object",
"required": [
"propertyId",
"createFromVersion"
],
"properties": {
"createFromVersion": {
"description": "The property version on which to base the new version.",
"minimum": 1,
"type": "integer"
},
"createFromVersionEtag": {
"description": "The data digest of the version on which to base the new version. If the digest doesn't match the current state of the version, batch-versioning fails for this property. See [Concurrency control](https://techdocs.akamai.com/property-mgr/reference/concurrency-control) for guidance.",
"type": "string"
},
"propertyId": {
"description": "Identifies the property for which to create a new version. 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).",
"pattern": "^(prp_|PRP_)?[0-9]+$",
"type": "string"
}
}
}
}
},
"x-akamai": {
"file-path": "schemas/bulk-property-version-create-request.yaml"
}
}
}
}
},
"responses": {
"202": {
"description": "The response links the bulk-versioning process.",
"content": {
"application/json": {
"example": {
"bulkCreateVersionLink": "/papi/v0/bulk/property-version-creations/737"
},
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"additionalProperties": false,
"description": "Provides a hypermedia link to a newly created resource. The response's single member name indicates the type of resource.",
"id": "resource:/descriptors/papi/v1/schemas/PostBulkPropertyVersionResponse.json#",
"type": "object",
"required": [
"bulkCreateVersionLink"
],
"properties": {
"bulkCreateVersionLink": {
"description": "Links the newly created bulk versioning process.",
"type": "string"
}
},
"x-akamai": {
"file-path": "schemas/bulk-property-version-post-response.yaml"
}
}
}
},
"headers": {
"Location": {
"description": "Provides a URL path you can GET the newly created resource from.",
"schema": {
"type": "string"
},
"x-akamai": {
"file-path": "headers/Location.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": "Optionally filters bulk searches to properties created under the specified contract. For bulk operations, you can specify `contractId` and `groupId` independently from each other.",
"example": "{{contractId}}",
"in": "query",
"name": "contractId",
"required": false,
"schema": {
"example": "ctr_1-1TJZFW",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/contractId-optional-bulk.yaml"
}
},
{
"description": "Optionally filters bulk searches to properties created under the specified group. For bulk operations, you can specify `contractId` and `groupId` independently from each other.",
"example": "{{groupId}}",
"in": "query",
"name": "groupId",
"required": false,
"schema": {
"example": "grp_15166",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/groupId-optional-bulk.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"
}
}
]
},
"x-akamai": {
"file-path": "paths/bulk-versions.yaml",
"path-for-file": "/bulk/property-version-creations"
},
"x-akamai-descriptor-tools": {
"displayName": "bulkPropertyVersions",
"group": "Bulk property versions"
}
},
"/bulk/property-version-creations/{bulkCreateId}": {
"get": {
"description": "List all new property versions that result from a [bulk versioning request](https://techdocs.akamai.com/property-mgr/reference/post-bulk-version). This operation polls the asynchronous process's status. After the `bulkCreateVersionsStatus` is `COMPLETE`, use the new version numbers along with search paths from a [bulk search](https://techdocs.akamai.com/property-mgr/reference/post-bulk-search) operation to [bulk patch](https://techdocs.akamai.com/property-mgr/reference/post-bulk-patch) them. See [Bulk Search and Update](https://techdocs.akamai.com/property-mgr/reference/bulk-search-and-update) for guidance.",
"operationId": "get-bulk-version",
"summary": "Akamai List Bulk-versioned Properties",
"tags": [
"Bulk versioning"
],
"externalDocs": {
"description": "See documentation for this operation in Akamai's Property Manager API",
"url": "https://techdocs.akamai.com/property-mgr/reference/get-bulk-version"
},
"responses": {
"200": {
"description": "The response shows the bulk versioning job, which proceeds until the `bulkCreateVersionsStatus` is `COMPLETE`.",
"content": {
"application/json": {
"example": {
"bulkCreateId": 9,
"bulkCreateVersionSubmitDate": "2018-01-18T00:00:00Z",
"bulkCreateVersionUpdateDate": "2018-01-18T00:00:00Z",
"bulkCreateVersionsStatus": "IN_PROGRESS",
"createPropertyVersions": [
{
"createFromVersion": 1,
"createFromVersionEtag": "343410c585cf67fb",
"createVersionStatus": "PENDING",
"createVersionSubmitDate": "2018-01-18T00:00:00Z",
"createVersionUpdateDate": "2018-01-18T00:00:00Z",
"propertyId": "prp_1",
"propertyVersion": 2,
"propertyVersionLink": "/papi/v1/properties/prp_1/versions/2?contractId=ctr_C-0N7RAC7&groupId=grp_15166"
},
{
"createFromVersion": 2,
"createFromVersionEtag": "343410c585cf67fc",
"createVersionStatus": "IN_PROGRESS",
"createVersionSubmitDate": "2018-01-18T00:00:00Z",
"createVersionUpdateDate": "2018-01-18T00:00:00Z",
"propertyId": "prp_15",
"propertyVersion": 3,
"propertyVersionLink": "/papi/v1/properties/prp_2/versions/3?contractId=ctr_C-0N7RAC7&groupId=grp_15166"
},
{
"createFromVersion": 10,
"createFromVersionEtag": "6c7v5c65c6cvcv65",
"createVersionStatus": "COMPLETE",
"createVersionSubmitDate": "2018-01-18T00:00:00Z",
"createVersionUpdateDate": "2018-01-18T00:00:00Z",
"propertyId": "prp_3",
"propertyVersion": 11,
"propertyVersionLink": "/papi/v1/properties/prp_3/versions/11?contractId=ctr_C-0N7RAC7&groupId=grp_15166"
}
]
},
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"additionalProperties": false,
"description": "Encapsulates a set of properties from which to bulk create new versions. See [Bulk Search and Update](https://techdocs.akamai.com/property-mgr/reference/bulk-search-and-update) for guidance on this feature.",
"id": "resource:/descriptors/papi/v1/schemas/GetBulkPropertyVersionResponse.json#",
"type": "object",
"required": [
"bulkCreateId",
"bulkCreateVersionsStatus",
"bulkCreateVersionSubmitDate",
"bulkCreateVersionUpdateDate"
],
"properties": {
"bulkCreateId": {
"description": "Identifies each bulk-versioning process.",
"minimum": 1,
"type": "integer"
},
"bulkCreateVersionSubmitDate": {
"description": "An ISO 8601 timestamp indicating when the bulk versioning request occurred.",
"type": "string"
},
"bulkCreateVersionUpdateDate": {
"description": "An ISO 8601 timestamp indicating when the bulk versioning request most recently updated with changes to versions' status. The value may be `null` when the bulk version request first occurs.",
"type": [
"string",
"null"
]
},
"bulkCreateVersionsStatus": {
"description": "Tracks the status of the overall bulk versioning request, either `PENDING`, `IN_PROGRESS`, or `COMPLETE`.",
"type": "string",
"enum": [
"PENDING",
"COMPLETE",
"IN_PROGRESS"
]
},
"createPropertyVersions": {
"description": "Encapsulates information about each new property version to create.",
"type": "array",
"items": {
"additionalProperties": false,
"type": "object",
"required": [
"propertyId",
"createFromVersion",
"createVersionStatus",
"createVersionSubmitDate",
"createVersionUpdateDate"
],
"properties": {
"createFromVersion": {
"description": "The property version on which to base the new version.",
"minimum": 1,
"type": "integer"
},
"createFromVersionEtag": {
"description": "The data digest of the version on which to base the new version. If the digest doesn't match the current state of the version, batch-versioning fails for this property. See [Concurrency control](https://techdocs.akamai.com/property-mgr/reference/concurrency-control) for guidance.",
"type": "string"
},
"createVersionStatus": {
"description": "Tracks the status of the versioning request for this property, either `PENDING`, `SUBMITTED`, `IN_PROGRESS`, or `COMPLETE`, indicating success. A `SUBMISSION_ERROR` means the versioning failed, for example, if the `createFromVersionEtag` didn't reflect the version's current state. A value of `INTERRUPTED` indicates a server error.",
"type": "string",
"enum": [
"PENDING",
"SUBMITTED",
"IN_PROGRESS",
"COMPLETE",
"INTERRUPTED",
"SUBMISSION_ERROR"
]
},
"createVersionSubmitDate": {
"description": "An ISO 8601 timestamp indicating when the request for a new version occurred. Note that this occurs asynchronously, and doesn't match when the overall bulk versioning request occurred.",
"type": "string"
},
"createVersionUpdateDate": {
"description": "An ISO 8601 timestamp indicating when the `createVersionStatus` last updated.",
"type": "string"
},
"etag": {
"description": "A digest identifying a specific property version. When making any subsequent modifications, this ensures the integrity of the newly created version's data. See [Concurrency control](https://techdocs.akamai.com/property-mgr/reference/concurrency-control) for guidance. The value may appear as `null` prior to the new version's creation.",
"type": [
"string",
"null"
]
},
"propertyId": {
"description": "Identifies the property for which to create a new version. 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"
},
"propertyVersion": {
"description": "Reflects the new version for this property resulting from the batch-versioning request.",
"minimum": 1,
"type": "integer"
},
"propertyVersionLink": {
"description": "Provides an API hypermedia link to each newly created property version. Prior to creation, the value is `null`.",
"nullable": true,
"type": "string"
}
}
}
},
"message": {
"description": "A notification in case the bulk request repeatedly fails to process.",
"type": "string"
}
},
"x-akamai": {
"file-path": "schemas/bulk-property-version-get-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"
}
},
"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": "Optionally filters bulk searches to properties created under the specified contract. For bulk operations, you can specify `contractId` and `groupId` independently from each other.",
"example": "{{contractId}}",
"in": "query",
"name": "contractId",
"required": false,
"schema": {
"example": "ctr_1-1TJZFW",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/contractId-optional-bulk.yaml"
}
},
{
"description": "Optionally filters bulk searches to properties created under the specified group. For bulk operations, you can specify `contractId` and `groupId` independently from each other.",
"example": "{{groupId}}",
"in": "query",
"name": "groupId",
"required": false,
"schema": {
"example": "grp_15166",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/groupId-optional-bulk.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"
}
}
]
},
"x-akamai": {
"file-path": "paths/bulk-version.yaml",
"path-for-file": "/bulk/property-version-creations/{bulkCreateId}"
},
"x-akamai-descriptor-tools": {
"displayName": "bulkPropertyVersion",
"group": "Bulk property versions"
},
"parameters": [
{
"description": "Identifies each bulk-versioning job.",
"example": "{{bulkCreateId}}",
"in": "path",
"name": "bulkCreateId",
"required": true,
"schema": {
"example": 9,
"type": "integer"
},
"x-akamai": {
"file-path": "parameters/bulkCreateId-path.yaml"
}
}
]
},
"/bulk/rules-patch-requests": {
"post": {
"description": "Apply a series of JSON Patch operations to modify a set of property versions. Form this set of `patches` based on the [JSONPath](http://goessner.net/articles/JsonPath/) locations from a [bulk search](https://techdocs.akamai.com/property-mgr/reference/post-bulk-search) response. Specify a set of new property versions based on the results of a [bulk versioning](https://techdocs.akamai.com/property-mgr/reference/post-bulk-version) operation. The request is a bulk patch object. This operation launches an asynchronous process to update rule trees. To check its progress, run the [List bulk-updated properties](https://techdocs.akamai.com/property-mgr/reference/get-bulk-patch) operation, whose link is available in the `Location` header or `bulkPatchLink` member of this operation's response. See [Bulk Search and Update](https://techdocs.akamai.com/property-mgr/reference/bulk-search-and-update) for overall guidance on this feature.",
"operationId": "post-bulk-patch",
"summary": "Akamai Bulk Patch a Set of Properties",
"tags": [
"Bulk patch"
],
"externalDocs": {
"description": "See documentation for this operation in Akamai's Property Manager API",
"url": "https://techdocs.akamai.com/property-mgr/reference/post-bulk-patch"
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"example": {
"patchPropertyVersions": [
{
"etag": "a87v5c65c6821bc",
"propertyId": "prp_1",
"propertyVersion": 1,
"patches": [
{
"op": "replace",
"path": "/rules/children/1/features/3/option/enabled",
"value": "on"
},
{
"op": "replace",
"path": "/rules/children/1/features/0/option/enabled",
"value": "on"
}
]
},
{
"etag": "6c7v5c65c6cvcv65",
"propertyId": "prp_15",
"propertyVersion": 2,
"patches": [
{
"op": "replace",
"path": "/rules/children/1/children/0/features/1/enabled",
"value": "on"
}
]
},
{
"etag": "1f8903bcde2f3",
"propertyId": "prp_3",
"propertyVersion": 10,
"patches": [
{
"op": "replace",
"path": "/rules/children/0/children/1/children/2/features/1/enabled",
"value": "on"
}
]
}
]
},
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Encapsulates customized JSON patch instructions to run on a set of JSON path locations within various property versions' rule trees. See [Bulk Search and Update](https://techdocs.akamai.com/property-mgr/reference/bulk-search-and-update) for guidance on this feature.",
"id": "resource:/descriptors/papi/v1/schemas/CreateNewBulkPatchRequestV0.json#",
"javaType": "com.akamai.devops.model.BulkPatchRequest",
"type": "object",
"required": [
"patchPropertyVersions"
],
"properties": {
"patchPropertyVersions": {
"description": "Specifies JSON patch instructions to modify each property version.",
"type": "array",
"items": {
"type": "object",
"required": [
"propertyId",
"propertyVersion",
"patches"
],
"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"
},
"patches": {
"description": "A series of JSON Patch operations.",
"type": "array",
"items": {
"description": "A JSON Patch operation.",
"oneOf": [
{
"title": "Replace",
"type": "object",
"required": [
"op",
"path",
"value"
],
"properties": {
"op": {
"description": "The operation to perform: `replace`, `add`, or `test` in this case.",
"enum": [
"replace",
"add",
"test"
]
},
"path": {
"description": "A JSON Path expression that locates the data to replace.",
"pattern": "^(/[^/~]*(~[01][^/~]*)*)*$",
"type": "string"
}
}
},
{
"title": "Remove",
"type": "object",
"required": [
"op",
"path"
],
"properties": {
"op": {
"description": "The operation to perform: `remove` in this case.",
"enum": [
"remove"
]
},
"path": {
"description": "A JSON Path expression that locates the data to remove.",
"pattern": "^(/[^/~]*(~[01][^/~]*)*)*$",
"type": "string"
}
}
}
]
}
},
"propertyId": {
"description": "Identifies the property for this version. See [Data conventions](https://techdocs.akamai.com/property-mgr/reference/data-conventions) 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).",
"pattern": "^(prp_|PRP_)?[0-9]+$",
"type": "string"
},
"propertyVersion": {
"description": "A positive integer identifying the incremental version.",
"minimum": 1,
"type": "integer"
}
}
}
}
},
"x-akamai": {
"file-path": "schemas/bulk-patch-create-request.yaml"
}
}
}
}
},
"responses": {
"202": {
"description": "The response links the bulk patch process.",
"content": {
"application/json": {
"example": {
"bulkPatchLink": "/papi/v0/bulk/rules-patch-requests/42"
},
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"additionalProperties": false,
"description": "Provides a hypermedia link to a newly created resource. The response's single member name indicates the type of resource.",
"id": "resource:/descriptors/papi/v1/schemas/PostBulkPatchResponse.json#",
"type": "object",
"required": [
"bulkPatchLink"
],
"properties": {
"bulkPatchLink": {
"description": "Links the newly created bulk patch process.",
"type": "string"
}
},
"x-akamai": {
"file-path": "schemas/bulk-patch-post-response.yaml"
}
}
}
},
"headers": {
"Location": {
"description": "Provides a URL path you can GET the newly created resource from.",
"schema": {
"type": "string"
},
"x-akamai": {
"file-path": "headers/Location.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": "Optionally filters bulk searches to properties created under the specified contract. For bulk operations, you can specify `contractId` and `groupId` independently from each other.",
"example": "{{contractId}}",
"in": "query",
"name": "contractId",
"required": false,
"schema": {
"example": "ctr_1-1TJZFW",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/contractId-optional-bulk.yaml"
}
},
{
"description": "Optionally filters bulk searches to properties created under the specified group. For bulk operations, you can specify `contractId` and `groupId` independently from each other.",
"example": "{{groupId}}",
"in": "query",
"name": "groupId",
"required": false,
"schema": {
"example": "grp_15166",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/groupId-optional-bulk.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"
}
}
]
},
"x-akamai": {
"file-path": "paths/bulk-patches.yaml",
"path-for-file": "/bulk/rules-patch-requests"
},
"x-akamai-descriptor-tools": {
"displayName": "bulkPatch",
"group": "Bulk patch"
}
},
"/bulk/rules-patch-requests/{bulkPatchId}": {
"get": {
"description": "List all modified property versions that result from a [bulk patch](https://techdocs.akamai.com/property-mgr/reference/post-bulk-patch) request. This operation polls the asynchronous process's status. Once the overall `bulkPatchStatus` is `COMPLETE`, you can feed all successfully updated property versions whose `status` is `UPDATED` into a subsequent request to [bulk activate](https://techdocs.akamai.com/property-mgr/reference/post-bulk-activations) them. See [Bulk Search and Update](https://techdocs.akamai.com/property-mgr/reference/bulk-search-and-update) for overall guidance on this feature.",
"operationId": "get-bulk-patch",
"summary": "Akamai List Bulk-patched Properties",
"tags": [
"Bulk patch"
],
"externalDocs": {
"description": "See documentation for this operation in Akamai's Property Manager API",
"url": "https://techdocs.akamai.com/property-mgr/reference/get-bulk-patch"
},
"responses": {
"200": {
"description": "The response shows the bulk update job, which proceeds until the `bulkPatchStatus` is `COMPLETE`.",
"content": {
"application/json": {
"example": {
"bulkPatchId": 7,
"bulkPatchStatus": "COMPLETE",
"bulkPatchSubmitDate": "2018-01-18T00:00:00Z",
"bulkPatchUpdateDate": "2018-01-18T01:00:00Z",
"patchPropertyVersions": [
{
"etag": "a9dfe78cf93090516bde891d009eaf57",
"patchPropertyId": "prp_1",
"patchPropertyVersion": 2,
"patchPropertyVersionStatus": "COMPLETE",
"patchSubmitDate": "2018-01-18T00:00:00Z",
"patchUpdateDate": "2018-01-18T00:00:00Z",
"propertyVersionRulesLink": "/papi/v1/properties/prp_1/versions/1/rules",
"papiErrors": [
{
"detail": "The Verification Settings option on the `Origin Server` behavior is required.",
"errorLocation": "#/rules/behaviors/0/options/verificationMode",
"instance": "https://control.sqa2.qa.akamai.com/papi/v0/bulk/activations/1?contractId=ctr_C-0N7RAC7&groupId=grp_15225#853080b7-e411-432d-99ae-967e56b50d72",
"title": "Attribute not specified",
"type": "https://problems.luna.akamaiapis.net/papi/v0/validation/attribute_required"
}
],
"papiWarnings": [
{
"detail": "The CP Code within `Content Provider Code` isn't configured for use with the product used by this property, Dynamic Site Accelerator. Traffic for this property might not show up under the correct traffic reports.",
"errorLocation": "#/rules/behaviors/1/options/value",
"instance": "https://control.sqa2.qa.akamai.com/papi/v0/bulk/activations/1?contractId=ctr_C-0N7RAC7&groupId=grp_15225#853080b7-e411-432d-99ae-967e56b50d72",
"title": "Unstable rule format",
"type": "https://problems.luna.akamaiapis.net/papi/v0/validation/product_behavior_issue.cpcode_incorrect_product"
}
],
"patches": [
{
"op": "replace",
"path": "/rules/children/1/features/3/option/enabled",
"value": "on"
},
{
"op": "replace",
"path": "/rules/children/1/features/0/option/enabled",
"value": "on"
}
]
},
{
"fatalError": "BAD SYNTAX UNABLE TO SAVE",
"patchPropertyId": "prp_15",
"patchPropertyVersion": 3,
"patchPropertyVersionStatus": "SUBMISSION_ERROR",
"patchSubmitDate": "2018-01-18T00:00:00Z",
"patchUpdateDate": "2018-01-18T00:00:00Z",
"patches": [
{
"op": "replace",
"path": "/rules/children/1/children/0/features/1/enabled",
"value": "on"
}
]
},
{
"etag": "a9dfe78cf93090516bde891d009eaf57",
"patchPropertyId": "prp_3",
"patchPropertyVersion": 11,
"patchPropertyVersionStatus": "COMPLETE",
"patchSubmitDate": "2018-01-18T00:00:00Z",
"patchUpdateDate": "2018-01-18T00:00:00Z",
"propertyVersionRulesLink": "/papi/v1/properties/prp_3/versions/1/rules",
"patches": [
{
"op": "replace",
"path": "/rules/children/0/children/1/children/2/features/1/enabled",
"value": "on"
}
]
}
]
},
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"additionalProperties": false,
"description": "Encapsulates customized JSON patch instructions to run on a set of JSON path locations within various property versions' rule trees. See [Bulk Search and Update](https://techdocs.akamai.com/property-mgr/reference/bulk-search-and-update) for guidance on this feature.",
"id": "resource:/descriptors/papi/v1/schemas/GetBulkPatchResponse.json#",
"type": "object",
"required": [
"bulkPatchId",
"bulkPatchStatus",
"bulkPatchSubmitDate",
"patchPropertyVersions"
],
"properties": {
"bulkPatchId": {
"description": "Identifies each bulk patch process.",
"minimum": 1,
"type": "integer"
},
"bulkPatchStatus": {
"description": "Reflects the status of the entire bulk update request, either `PENDING`, `IN_PROGRESS`, or `COMPLETE`.",
"type": "string",
"enum": [
"PENDING",
"COMPLETE",
"IN_PROGRESS"
]
},
"bulkPatchSubmitDate": {
"description": "An ISO 8601 timestamp indicating when you first made the bulk patch request.",
"type": "string"
},
"bulkPatchUpdateDate": {
"description": "An ISO 8601 timestamp indicating when any of the property versions `status` value last changed.",
"type": "string"
},
"message": {
"description": "A notification in case the bulk request repeatedly fails to process.",
"type": "string"
},
"patchPropertyVersions": {
"description": "Specifies JSON patch instructions to modify each property version.",
"type": "array",
"items": {
"additionalProperties": false,
"type": "object",
"required": [
"patchPropertyId",
"patchPropertyVersion",
"patches"
],
"properties": {
"etag": {
"description": "When specified as part of the bulk patch request, this property doesn't update if someone else has modified the property since you got the value. See [Concurrency control](https://techdocs.akamai.com/property-mgr/reference/concurrency-control) for guidance on this feature.",
"type": "string"
},
"fatalError": {
"description": "Indicates an error that prevented this property version from updating. For example, malformed JSON Patch instructions or resulting rule tree data formatting. This type of error isn't the same as the `papiErrors` you're allowed to save on a property version, but not to activate.",
"type": "string"
},
"papiErrors": {
"description": "Validation errors resulting from the bulk update. Errors prevent you from including this property version in a bulk activation. These are the same type of validation errors that PAPI saves in a property version, not to be confused with a `fatalError` that prevents it from being saved.",
"minItems": 0,
"type": "array",
"items": {
"additionalProperties": false,
"type": "object",
"properties": {
"detail": {
"description": "Provides context for the problem that triggered the error.",
"type": "string"
},
"errorLocation": {
"description": "A JSON Path expression that locates the rule tree node where the problem occurred.",
"type": "string"
},
"instance": {
"description": "A URI that identifies each error's occurrence. Possibly useful when communicating with Akamai customer support.",
"type": "string"
},
"title": {
"description": "A descriptive label for each type of error.",
"type": "string"
},
"type": {
"description": "A URI that identifies each error case. See the [Errors](https://techdocs.akamai.com/property-mgr/reference/api-errors) section for details on each.",
"type": "string"
}
}
}
},
"papiWarnings": {
"description": "Lists any validation warnings resulting from the bulk update. You need to acknowledge them when bulk-activating property versions.",
"minItems": 0,
"type": "array",
"items": {
"additionalProperties": false,
"type": "object",
"properties": {
"detail": {
"description": "Provides context for the problem that triggered the warning.",
"type": "string"
},
"errorLocation": {
"description": "A JSON Path expression that locates the rule tree node where the problem occurred.",
"type": "string"
},
"instance": {
"description": "A URI that identifies each warning's occurrence. Possibly useful when communicating with Akamai customer support.",
"type": "string"
},
"title": {
"description": "A descriptive label for each type of warning.",
"type": "string"
},
"type": {
"description": "A URI that identifies each warning case. See the [Errors](https://techdocs.akamai.com/property-mgr/reference/api-errors) section for details on each.",
"type": "string"
}
}
}
},
"patchPropertyId": {
"description": "Identifies the property you want to modify as part of the bulk patch.",
"type": "string"
},
"patchPropertyVersion": {
"description": "The version of the property you want to modify as part of the bulk patch.",
"minimum": 1,
"type": "integer"
},
"patchPropertyVersionStatus": {
"description": "Indicates progress for the update to this property version's rule tree, either `PENDING`, `SUBMITTED`, `IN_PROGRESS`, or `COMPLETE` for success. A `SUBMISSION_ERROR` typically indicates that replacement values caused a schema violation, not a new set of `errors` that you'd ordinarily be able to save on rule trees. A value of `INTERRUPTED` indicates a server error.",
"type": "string",
"enum": [
"PENDING",
"SUBMITTED",
"IN_PROGRESS",
"COMPLETE",
"INTERRUPTED",
"SUBMISSION_ERROR"
]
},
"patchSubmitDate": {
"description": "An ISO 8601 timestamp indicating when the request to modify this property version's rule tree occurred.",
"type": "string"
},
"patchUpdateDate": {
"description": "An ISO 8601 timestamp indicating when this property version's `status` last changed. Usually, it also indicates when the update completed.",
"type": "string"
},
"patches": {
"description": "Represents each instruction to modify part of a rule tree.",
"type": "array",
"items": {
"additionalProperties": false,
"type": "object",
"required": [
"op",
"path",
"value"
],
"properties": {
"op": {
"description": "The JSON Patch operation to perform, either `replace`, `add`, `remove`, or `test`. For various techniques to use these operations, see [Bulk Search and Update](https://techdocs.akamai.com/property-mgr/reference/bulk-search-and-update).",
"type": "string",
"enum": [
"replace",
"add",
"remove",
"test"
]
},
"path": {
"description": "A JSONPath expression that locates the value to replace within the rule tree.",
"type": "string"
},
"value": {
"description": "Specifies the replacement value. This needs to correspond to the original matched value's data type, otherwise the rule tree fails to update.",
"anyOf": [
{
"title": "String value",
"type": "string"
},
{
"title": "Numeric value",
"type": "number"
},
{
"title": "Boolean value",
"type": "boolean"
}
]
}
}
}
},
"propertyVersionRulesLink": {
"description": "An API hypermedia link to get specific rule trees after they're updated.",
"type": "string"
}
}
}
}
},
"x-akamai": {
"file-path": "schemas/bulk-patch-get-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"
}
},
"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": "Optionally filters bulk searches to properties created under the specified contract. For bulk operations, you can specify `contractId` and `groupId` independently from each other.",
"example": "{{contractId}}",
"in": "query",
"name": "contractId",
"required": false,
"schema": {
"example": "ctr_1-1TJZFW",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/contractId-optional-bulk.yaml"
}
},
{
"description": "Optionally filters bulk searches to properties created under the specified group. For bulk operations, you can specify `contractId` and `groupId` independently from each other.",
"example": "{{groupId}}",
"in": "query",
"name": "groupId",
"required": false,
"schema": {
"example": "grp_15166",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/groupId-optional-bulk.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"
}
}
]
},
"x-akamai": {
"file-path": "paths/bulk-patch.yaml",
"path-for-file": "/bulk/rules-patch-requests/{bulkPatchId}"
},
"x-akamai-descriptor-tools": {
"displayName": "bulkPatches",
"group": "Bulk patch"
},
"parameters": [
{
"description": "Identifies each bulk patch job.",
"example": "{{bulkPatchId}}",
"in": "path",
"name": "bulkPatchId",
"required": true,
"schema": {
"example": 7,
"type": "integer"
},
"x-akamai": {
"file-path": "parameters/bulkPatchId-path.yaml"
}
}
]
},
"/bulk/rules-search-requests": {
"post": {
"description": "POST a bulk search object to search across all active property or include versions. Specify a [JSONPath](http://goessner.net/articles/JsonPath/) expression to match their rule trees. This operation launches an asynchronous process to gather search results. To check its progress, run the [List bulk search results](https://techdocs.akamai.com/property-mgr/reference/get-bulk-search) operation, whose link is available in the `Location` header or the `bulkSearchLink` member of this operation's response. After gathering completed results, you can create new property versions, bulk patch the rule trees, then activate them. See [Bulk Search and Update](https://techdocs.akamai.com/property-mgr/reference/bulk-search-and-update) for guidance on this feature. Run [Synchronously bulk search a set of properties](https://techdocs.akamai.com/property-mgr/reference/post-bulk-searchsynchronus) as an alternative to get completed search results directly. To perform simpler searches for an include's name or property's name or hostnames to which it applies, run the [Search properties and includes](https://techdocs.akamai.com/property-mgr/reference/post-search-find-by-value) operation instead.",
"operationId": "post-bulk-search",
"summary": "Akamai Bulk Search a Set of Properties or Includes",
"tags": [
"Bulk search"
],
"externalDocs": {
"description": "See documentation for this operation in Akamai's Property Manager API",
"url": "https://techdocs.akamai.com/property-mgr/reference/post-bulk-search"
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"example": {
"bulkSearchQuery": {
"match": "$..conditions[?(@.name == \"ext\" && \"mp3\" in @.options.value && \"mp4\" nin @.options.value)].options.value[?(@ == \"mp3\")]",
"syntax": "JSONPATH",
"bulkSearchQualifiers": [
"$.options[?(@.secure==\"true\")]",
"$..features[?(@.name==\"origin\")].options[?(@.hostname==\"old.origin.example.com\")]"
]
}
},
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "A bulk search job. The request specifies JSONPath search queries, and the response includes JSON path locations within matching rule trees. Check the `searchTargetStatus` of potentially long-running asynchronous jobs for when they're `COMPLETE`. See [Bulk Search and Update](https://techdocs.akamai.com/property-mgr/reference/bulk-search-and-update) for guidance on how to use this object.",
"id": "resource:/descriptors/papi/v1/schemas/CreateNewBulkSearchRequestV0.json#",
"javaType": "com.akamai.devops.model.BulkSearchRequest",
"type": "object",
"required": [
"bulkSearchQuery"
],
"properties": {
"bulkSearchQuery": {
"description": "Specifies the set of bulk search criteria.",
"example": "{{bulkSearchQuery}}",
"required": [
"syntax",
"match"
],
"properties": {
"bulkSearchQualifiers": {
"description": "An additional set of JSON Path test expressions that must all succeed for the main `match` on the rule tree to yield results.",
"type": "array",
"items": {
"type": "string"
}
},
"match": {
"description": "The JSON Path expression to search within available rule trees.",
"type": "string"
},
"syntax": {
"description": "Identifies the query syntax for the search. The only currently supported syntax system is `JSONPATH`.",
"type": "string",
"enum": [
"JSONPATH"
]
}
}
},
"propertyType": {
"description": "Specifies the type of the property, either `TRADITIONAL`, `INCLUDE`, or `HOSTNAME_BUCKET`.",
"example": "{{propertyType}}",
"type": "string",
"enum": [
"TRADITIONAL",
"HOSTNAME_BUCKET",
"INCLUDE"
]
}
},
"x-akamai": {
"file-path": "schemas/bulk-search-create-request.yaml"
}
}
}
}
},
"responses": {
"202": {
"description": "The response links the bulk search process.",
"content": {
"application/json": {
"example": {
"bulkSearchLink": "/papi/v0/bulk/rules-search-requests/737"
},
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"additionalProperties": false,
"description": "Provides a hypermedia link to a newly created resource. The response's single member name indicates the type of resource.",
"id": "resource:/descriptors/papi/v1/schemas/PostBulkSearchResponse.json",
"type": "object",
"required": [
"bulkSearchLink"
],
"properties": {
"bulkSearchLink": {
"description": "Links the newly created bulk search process.",
"type": "string"
}
},
"x-akamai": {
"file-path": "schemas/bulk-search-post-response.yaml"
}
}
}
},
"headers": {
"Location": {
"description": "Provides a URL path you can GET the newly created resource from.",
"schema": {
"type": "string"
},
"x-akamai": {
"file-path": "headers/Location.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": "Optionally filters bulk searches to properties created under the specified contract. For bulk operations, you can specify `contractId` and `groupId` independently from each other.",
"example": "{{contractId}}",
"in": "query",
"name": "contractId",
"required": false,
"schema": {
"example": "ctr_1-1TJZFW",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/contractId-optional-bulk.yaml"
}
},
{
"description": "Optionally filters bulk searches to properties created under the specified group. For bulk operations, you can specify `contractId` and `groupId` independently from each other.",
"example": "{{groupId}}",
"in": "query",
"name": "groupId",
"required": false,
"schema": {
"example": "grp_15166",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/groupId-optional-bulk.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"
}
}
]
},
"x-akamai": {
"file-path": "paths/bulk-searches.yaml",
"path-for-file": "/bulk/rules-search-requests"
},
"x-akamai-descriptor-tools": {
"displayName": "bulkSearches",
"group": "Bulk searches"
}
},
"/bulk/rules-search-requests-synch": {
"post": {
"description": "Provides an alternative to the asynchronous [Bulk search a set of properties or includes](https://techdocs.akamai.com/property-mgr/reference/post-bulk-search) operation. It yields completed bulk search results directly, but with possibly high latency, making it more appropriate to target for small-batch searches. POST a bulk search object to search across all active property or include versions, specifying a [JSONPath](http://goessner.net/articles/JsonPath/) expression to match their rule trees. After gathering results, you can create new property versions, bulk patch the rule trees, then activate them. See [Bulk Search and Update](https://techdocs.akamai.com/property-mgr/reference/bulk-search-and-update) for guidance on this feature. To perform simpler searches for an include's name or property's name or hostnames to which it applies, run the [Search properties and includes](https://techdocs.akamai.com/property-mgr/reference/post-search-find-by-value) operation instead.",
"operationId": "post-bulk-search-synch",
"summary": "Akamai Synchronously Bulk Search a Set of Properties or Includes",
"tags": [
"Bulk search"
],
"externalDocs": {
"description": "See documentation for this operation in Akamai's Property Manager API",
"url": "https://techdocs.akamai.com/property-mgr/reference/post-bulk-search-synch"
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"example": {
"bulkSearchQuery": {
"match": "$..conditions[?(@.name == \"ext\" && \"mp3\" in @.options.value && \"mp4\" nin @.options.value)].options.value[?(@ == \"mp3\")]",
"syntax": "JSONPATH",
"bulkSearchQualifiers": [
"$.options[?(@.secure==\"true\")]",
"$..features[?(@.name==\"origin\")].options[?(@.hostname==\"old.origin.example.com\")]"
]
}
},
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "A bulk search job. The request specifies JSONPath search queries, and the response includes JSON path locations within matching rule trees. Check the `searchTargetStatus` of potentially long-running asynchronous jobs for when they're `COMPLETE`. See [Bulk Search and Update](https://techdocs.akamai.com/property-mgr/reference/bulk-search-and-update) for guidance on how to use this object.",
"id": "resource:/descriptors/papi/v1/schemas/CreateNewBulkSearchRequestV0.json#",
"javaType": "com.akamai.devops.model.BulkSearchRequest",
"type": "object",
"required": [
"bulkSearchQuery"
],
"properties": {
"bulkSearchQuery": {
"description": "Specifies the set of bulk search criteria.",
"example": "{{bulkSearchQuery}}",
"required": [
"syntax",
"match"
],
"properties": {
"bulkSearchQualifiers": {
"description": "An additional set of JSON Path test expressions that must all succeed for the main `match` on the rule tree to yield results.",
"type": "array",
"items": {
"type": "string"
}
},
"match": {
"description": "The JSON Path expression to search within available rule trees.",
"type": "string"
},
"syntax": {
"description": "Identifies the query syntax for the search. The only currently supported syntax system is `JSONPATH`.",
"type": "string",
"enum": [
"JSONPATH"
]
}
}
},
"propertyType": {
"description": "Specifies the type of the property, either `TRADITIONAL`, `INCLUDE`, or `HOSTNAME_BUCKET`.",
"example": "{{propertyType}}",
"type": "string",
"enum": [
"TRADITIONAL",
"HOSTNAME_BUCKET",
"INCLUDE"
]
}
},
"x-akamai": {
"file-path": "schemas/bulk-search-create-request.yaml"
}
}
}
}
},
"responses": {
"202": {
"description": "This delayed response shows the completed bulk search job. Unlike the asynchronous [Bulk search a set of properties or includes](https://techdocs.akamai.com/property-mgr/reference/post-bulk-search) operation, this response's `searchTargetStatus` is always `COMPLETE`.",
"content": {
"application/json": {
"example": {
"bulkSearchId": 5,
"searchSubmitDate": "2018-01-18T00:00:00Z",
"searchTargetStatus": "COMPLETE",
"searchUpdateDate": "2018-01-18T00:01:00Z",
"bulkSearchQuery": {
"match": "$..conditions[?(@.name == \"ext\" && \"mp3\" in @.options.value && \"mp4\" nin @.options.value)].options.value[?(@ == \"mp3\")]",
"syntax": "JSONPATH",
"bulkSearchQualifiers": [
"$.options[?(@.secure==\"true\")]",
"$..features[?(@.name==\"origin\")].options[?(@.hostname==\"old.origin.example.com\")]"
]
},
"results": [
{
"accountId": "act_A-CCT7890",
"isLatest": true,
"isLocked": true,
"isSecure": true,
"lastModifiedTime": "2018-01-18T00:00:00Z",
"productionStatus": "INACTIVE",
"propertyId": "prp_1",
"propertyName": "example1.example.com",
"propertyVersion": 1,
"stagingStatus": "ACTIVE",
"matchLocations": [
"/rules/children/1/features/0",
"/rules/children/1/features/3"
]
},
{
"accountId": "act_A-CCT5678",
"isLatest": false,
"isLocked": false,
"isSecure": true,
"lastModifiedTime": "2018-01-18T00:00:00Z",
"productionStatus": "INACTIVE",
"propertyId": "prp_15",
"propertyName": "example2.example.com",
"propertyVersion": 2,
"stagingStatus": "INACTIVE",
"matchLocations": [
"/rules/children/1/children/0/features/1"
]
},
{
"accountId": "act_A-CCT3456",
"isLatest": true,
"isLocked": true,
"isSecure": true,
"lastModifiedTime": "2018-01-18T00:00:00Z",
"productionStatus": "ACTIVE",
"propertyId": "prp_3",
"propertyName": "example3.example.com",
"propertyVersion": 10,
"stagingStatus": "INACTIVE",
"matchLocations": [
"/rules/children/0/children/1/children/2/features/1"
]
}
]
},
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"additionalProperties": false,
"description": "A bulk search job. The request specifies JSONPath search queries, and the response includes JSON path locations within matching rule trees. Check the `searchTargetStatus` of potentially long-running asynchronous jobs for when they're `COMPLETE`. See [Bulk Search and Update](https://techdocs.akamai.com/property-mgr/reference/bulk-search-and-update) for guidance on how to use this object.",
"id": "resource:/descriptors/papi/v1/schemas/GetBulkSearchResponse.json",
"type": "object",
"required": [
"bulkSearchId",
"searchTargetStatus",
"searchSubmitDate",
"bulkSearchQuery",
"results"
],
"properties": {
"bulkSearchId": {
"description": "Identifies each bulk search process.",
"minimum": 1,
"type": "integer"
},
"bulkSearchQuery": {
"additionalProperties": false,
"description": "Reflects the bulk search request's `bulkSearchQuery` object.",
"type": "object",
"required": [
"syntax",
"match"
],
"properties": {
"bulkSearchQualifiers": {
"description": "Additional JSON Path test expressions specified in the original bulk search request.",
"type": "array",
"items": {
"type": "string"
}
},
"match": {
"description": "Reflects the bulk search request's original JSON Path `match` query.",
"type": "string"
},
"syntax": {
"description": "Reflects the bulk search request's original `syntax` value. The only currently supported query syntax is `JSONPATH`.",
"type": "string",
"enum": [
"JSONPATH"
]
}
}
},
"results": {
"description": "Search results based on the original bulk search request's `bulkSearchQuery`, one for each property version.",
"type": "array",
"items": {
"additionalProperties": false,
"type": "object",
"required": [
"propertyId",
"propertyVersion"
],
"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"
},
"includeId": {
"description": "Identifies the matching include. 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": "Identifies the specific include name whose rule tree matches the search query.",
"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 `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": "Identifies the specific include version whose rule tree matches the search query.",
"minimum": 1,
"type": "integer"
},
"isLatest": {
"description": "Indicates whether this property version is the most recently modified, regardless of whether it's active. The most recently modified version appears along with active versions in bulk search results.",
"type": "boolean"
},
"isLocked": {
"description": "Indicates whether the property version is editable. The value is `false` if it's active or has ever been activated.",
"type": "boolean"
},
"isSecure": {
"description": "Identifies the specific field whose rule tree matches the search result.",
"type": "boolean"
},
"lastModifiedTime": {
"description": "An ISO 8601 timestamp indicating when the matching property version was last modified.",
"type": "string"
},
"matchLocations": {
"description": "JSON path expressions for each matching node in the property version's rule tree.",
"type": "array",
"items": {
"type": "string"
}
},
"productionStatus": {
"description": "The matching property version's activation status on the production network. Bulk search matches property versions currently active on production and staging networks. Values are the same as for individual activations: `ACTIVE`, `INACTIVE`, `NEW`, `PENDING`, `ZONE_1`, `ZONE_2`, `ZONE_3`, `ABORTED`, `FAILED`, `PENDING_DEACTIVATION` or `DEACTIVATED`.",
"type": "string",
"enum": [
"ACTIVE",
"INACTIVE",
"PENDING",
"ZONE_1",
"ZONE_2",
"ZONE_3",
"ABORTED",
"FAILED",
"DEACTIVATED",
"PENDING_DEACTIVATION",
"NEW"
]
},
"propertyId": {
"description": "Identifies the matching property. 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": "Identifies the specific property name whose rule tree matches the search query.",
"type": "string"
},
"propertyType": {
"description": "Whether the search query result is a traditional property or an include. You can reference includes in a property's rule tree with the [include](https://techdocs.akamai.com/property-mgr/reference/ga-include) behavior. The results can show both traditional properties and includes, or you can narrow down your search to either type.",
"type": "string",
"enum": [
"TRADITIONAL",
"INCLUDE"
]
},
"propertyVersion": {
"description": "Identifies the specific property version whose rule tree matches the search query.",
"minimum": 1,
"type": "integer"
},
"stagingStatus": {
"description": "The matching property version's activation status on the staging network. Bulk search matches property versions currently active on production and staging networks. Values are the same as for individual activations: `ACTIVE`, `INACTIVE`, `NEW`, `PENDING`, `ZONE_1`, `ZONE_2`, `ZONE_3`, `ABORTED`, `FAILED`, `PENDING_DEACTIVATION` or `DEACTIVATED`.",
"type": "string",
"enum": [
"ACTIVE",
"INACTIVE",
"PENDING",
"ZONE_1",
"ZONE_2",
"ZONE_3",
"ABORTED",
"FAILED",
"DEACTIVATED",
"PENDING_DEACTIVATION",
"NEW"
]
}
}
}
},
"searchSubmitDate": {
"description": "An ISO 8601 timestamp marking when the bulk search request occurred.",
"type": "string"
},
"searchTargetStatus": {
"description": "Indicates progress for the entire bulk search process, either `PENDING`, `SUBMITTED`, `IN_PROGRESS`, or finally `COMPLETE`. In some cases, progress may fail due to an `ERROR`.",
"type": "string",
"enum": [
"PENDING",
"SUBMITTED",
"COMPLETE",
"IN_PROGRESS",
"ERROR"
]
},
"searchUpdateDate": {
"description": "An ISO 8601 timestamp marking when the `searchTargetStatus` for the bulk search process last changed.",
"type": "string"
}
},
"x-akamai": {
"file-path": "schemas/bulk-search-get-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": "Optionally filters bulk searches to properties created under the specified contract. For bulk operations, you can specify `contractId` and `groupId` independently from each other.",
"example": "{{contractId}}",
"in": "query",
"name": "contractId",
"required": false,
"schema": {
"example": "ctr_1-1TJZFW",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/contractId-optional-bulk.yaml"
}
},
{
"description": "Optionally filters bulk searches to properties created under the specified group. For bulk operations, you can specify `contractId` and `groupId` independently from each other.",
"example": "{{groupId}}",
"in": "query",
"name": "groupId",
"required": false,
"schema": {
"example": "grp_15166",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/groupId-optional-bulk.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"
}
}
]
},
"x-akamai": {
"file-path": "paths/bulk-searches-sync.yaml",
"path-for-file": "/bulk/rules-search-requests-synch"
},
"x-akamai-descriptor-tools": {
"displayName": "bulkSearchesSynchronus",
"group": "Bulk searches synchronus"
}
},
"/bulk/rules-search-requests/{bulkSearchId}": {
"get": {
"description": "List all property or include versions that result from a [bulk search request](https://techdocs.akamai.com/property-mgr/reference/post-bulk-search). Run this operation to poll the asynchronous process's status. Once the `searchTargetStatus` is `COMPLETE`, you can feed the `results` into a [bulk versioning](https://techdocs.akamai.com/property-mgr/reference/post-bulk-version) operation. Also use the JSON path `matchLocations` to run a [bulk patch](https://techdocs.akamai.com/property-mgr/reference/post-bulk-patch) operation over the rule trees. See [Bulk Search and Update](https://techdocs.akamai.com/property-mgr/reference/bulk-search-and-update) for guidance.",
"operationId": "get-bulk-search",
"summary": "Akamai List Bulk Search Results",
"tags": [
"Bulk search"
],
"externalDocs": {
"description": "See documentation for this operation in Akamai's Property Manager API",
"url": "https://techdocs.akamai.com/property-mgr/reference/get-bulk-search"
},
"responses": {
"200": {
"description": "The response shows the bulk search job, which proceeds until the `searchTargetStatus` is `COMPLETE`.",
"content": {
"application/json": {
"example": {
"bulkSearchId": 5,
"searchSubmitDate": "2018-01-18T00:00:00Z",
"searchTargetStatus": "COMPLETE",
"searchUpdateDate": "2018-01-18T00:01:00Z",
"bulkSearchQuery": {
"match": "$..conditions[?(@.name == \"ext\" && \"mp3\" in @.options.value && \"mp4\" nin @.options.value)].options.value[?(@ == \"mp3\")]",
"syntax": "JSONPATH",
"bulkSearchQualifiers": [
"$.options[?(@.secure==\"true\")]",
"$..features[?(@.name==\"origin\")].options[?(@.hostname==\"old.origin.example.com\")]"
]
},
"results": [
{
"accountId": "act_A-CCT1234",
"isLatest": true,
"isLocked": true,
"isSecure": true,
"lastModifiedTime": "2018-01-18T00:00:00Z",
"productionStatus": "INACTIVE",
"propertyId": "prp_1",
"propertyName": "example1.example.com",
"propertyVersion": 1,
"stagingStatus": "ACTIVE",
"matchLocations": [
"/rules/children/1/features/0",
"/rules/children/1/features/3"
]
},
{
"accountId": "act_A-CCT9012",
"isLatest": false,
"isLocked": false,
"isSecure": true,
"lastModifiedTime": "2018-01-18T00:00:00Z",
"productionStatus": "INACTIVE",
"propertyId": "prp_15",
"propertyName": "example2.example.com",
"propertyVersion": 2,
"stagingStatus": "INACTIVE",
"matchLocations": [
"/rules/children/1/children/0/features/1"
]
},
{
"accountId": "act_A-CCT3456",
"isLatest": true,
"isLocked": true,
"isSecure": true,
"lastModifiedTime": "2018-01-18T00:00:00Z",
"productionStatus": "ACTIVE",
"propertyId": "prp_3",
"propertyName": "example3.example.com",
"propertyVersion": 10,
"stagingStatus": "INACTIVE",
"matchLocations": [
"/rules/children/0/children/1/children/2/features/1"
]
}
]
},
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"additionalProperties": false,
"description": "A bulk search job. The request specifies JSONPath search queries, and the response includes JSON path locations within matching rule trees. Check the `searchTargetStatus` of potentially long-running asynchronous jobs for when they're `COMPLETE`. See [Bulk Search and Update](https://techdocs.akamai.com/property-mgr/reference/bulk-search-and-update) for guidance on how to use this object.",
"id": "resource:/descriptors/papi/v1/schemas/GetBulkSearchResponse.json",
"type": "object",
"required": [
"bulkSearchId",
"searchTargetStatus",
"searchSubmitDate",
"bulkSearchQuery",
"results"
],
"properties": {
"bulkSearchId": {
"description": "Identifies each bulk search process.",
"minimum": 1,
"type": "integer"
},
"bulkSearchQuery": {
"additionalProperties": false,
"description": "Reflects the bulk search request's `bulkSearchQuery` object.",
"type": "object",
"required": [
"syntax",
"match"
],
"properties": {
"bulkSearchQualifiers": {
"description": "Additional JSON Path test expressions specified in the original bulk search request.",
"type": "array",
"items": {
"type": "string"
}
},
"match": {
"description": "Reflects the bulk search request's original JSON Path `match` query.",
"type": "string"
},
"syntax": {
"description": "Reflects the bulk search request's original `syntax` value. The only currently supported query syntax is `JSONPATH`.",
"type": "string",
"enum": [
"JSONPATH"
]
}
}
},
"results": {
"description": "Search results based on the original bulk search request's `bulkSearchQuery`, one for each property version.",
"type": "array",
"items": {
"additionalProperties": false,
"type": "object",
"required": [
"propertyId",
"propertyVersion"
],
"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"
},
"includeId": {
"description": "Identifies the matching include. 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": "Identifies the specific include name whose rule tree matches the search query.",
"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 `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": "Identifies the specific include version whose rule tree matches the search query.",
"minimum": 1,
"type": "integer"
},
"isLatest": {
"description": "Indicates whether this property version is the most recently modified, regardless of whether it's active. The most recently modified version appears along with active versions in bulk search results.",
"type": "boolean"
},
"isLocked": {
"description": "Indicates whether the property version is editable. The value is `false` if it's active or has ever been activated.",
"type": "boolean"
},
"isSecure": {
"description": "Identifies the specific field whose rule tree matches the search result.",
"type": "boolean"
},
"lastModifiedTime": {
"description": "An ISO 8601 timestamp indicating when the matching property version was last modified.",
"type": "string"
},
"matchLocations": {
"description": "JSON path expressions for each matching node in the property version's rule tree.",
"type": "array",
"items": {
"type": "string"
}
},
"productionStatus": {
"description": "The matching property version's activation status on the production network. Bulk search matches property versions currently active on production and staging networks. Values are the same as for individual activations: `ACTIVE`, `INACTIVE`, `NEW`, `PENDING`, `ZONE_1`, `ZONE_2`, `ZONE_3`, `ABORTED`, `FAILED`, `PENDING_DEACTIVATION` or `DEACTIVATED`.",
"type": "string",
"enum": [
"ACTIVE",
"INACTIVE",
"PENDING",
"ZONE_1",
"ZONE_2",
"ZONE_3",
"ABORTED",
"FAILED",
"DEACTIVATED",
"PENDING_DEACTIVATION",
"NEW"
]
},
"propertyId": {
"description": "Identifies the matching property. 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": "Identifies the specific property name whose rule tree matches the search query.",
"type": "string"
},
"propertyType": {
"description": "Whether the search query result is a traditional property or an include. You can reference includes in a property's rule tree with the [include](https://techdocs.akamai.com/property-mgr/reference/ga-include) behavior. The results can show both traditional properties and includes, or you can narrow down your search to either type.",
"type": "string",
"enum": [
"TRADITIONAL",
"INCLUDE"
]
},
"propertyVersion": {
"description": "Identifies the specific property version whose rule tree matches the search query.",
"minimum": 1,
"type": "integer"
},
"stagingStatus": {
"description": "The matching property version's activation status on the staging network. Bulk search matches property versions currently active on production and staging networks. Values are the same as for individual activations: `ACTIVE`, `INACTIVE`, `NEW`, `PENDING`, `ZONE_1`, `ZONE_2`, `ZONE_3`, `ABORTED`, `FAILED`, `PENDING_DEACTIVATION` or `DEACTIVATED`.",
"type": "string",
"enum": [
"ACTIVE",
"INACTIVE",
"PENDING",
"ZONE_1",
"ZONE_2",
"ZONE_3",
"ABORTED",
"FAILED",
"DEACTIVATED",
"PENDING_DEACTIVATION",
"NEW"
]
}
}
}
},
"searchSubmitDate": {
"description": "An ISO 8601 timestamp marking when the bulk search request occurred.",
"type": "string"
},
"searchTargetStatus": {
"description": "Indicates progress for the entire bulk search process, either `PENDING`, `SUBMITTED`, `IN_PROGRESS`, or finally `COMPLETE`. In some cases, progress may fail due to an `ERROR`.",
"type": "string",
"enum": [
"PENDING",
"SUBMITTED",
"COMPLETE",
"IN_PROGRESS",
"ERROR"
]
},
"searchUpdateDate": {
"description": "An ISO 8601 timestamp marking when the `searchTargetStatus` for the bulk search process last changed.",
"type": "string"
}
},
"x-akamai": {
"file-path": "schemas/bulk-search-get-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"
}
},
"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": "Optionally filters bulk searches to properties created under the specified contract. For bulk operations, you can specify `contractId` and `groupId` independently from each other.",
"example": "{{contractId}}",
"in": "query",
"name": "contractId",
"required": false,
"schema": {
"example": "ctr_1-1TJZFW",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/contractId-optional-bulk.yaml"
}
},
{
"description": "Optionally filters bulk searches to properties created under the specified group. For bulk operations, you can specify `contractId` and `groupId` independently from each other.",
"example": "{{groupId}}",
"in": "query",
"name": "groupId",
"required": false,
"schema": {
"example": "grp_15166",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/groupId-optional-bulk.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"
}
}
]
},
"x-akamai": {
"file-path": "paths/bulk-search.yaml",
"path-for-file": "/bulk/rules-search-requests/{bulkSearchId}"
},
"x-akamai-descriptor-tools": {
"displayName": "bulkSearch",
"group": "Bulk searches"
},
"parameters": [
{
"description": "Identifies each bulk search job.",
"example": "{{bulkSearchId}}",
"in": "path",
"name": "bulkSearchId",
"required": true,
"schema": {
"example": 5,
"type": "integer"
},
"x-akamai": {
"file-path": "parameters/bulkSearchId-path.yaml"
}
}
]
},
"/client-settings": {
"get": {
"description": "Get the current set of default values that apply to API clients keyed by the current authorization token.",
"operationId": "get-client-settings",
"summary": "Akamai Get Client Settings",
"tags": [
"Client settings"
],
"externalDocs": {
"description": "See documentation for this operation in Akamai's Property Manager API",
"url": "https://techdocs.akamai.com/property-mgr/reference/get-client-settings"
},
"responses": {
"200": {
"description": "The response shows the current client settings.",
"content": {
"application/json": {
"example": {
"ruleFormat": "v2015-08-08",
"usePrefixes": true
},
"schema": {
"$schema": "http://json-schema.org/draft-04-schema#",
"description": "Specifies default settings for an API client.",
"id": "resource:/descriptors/papi/v1/schemas/SetClientSettingsRequestV0.json#",
"javaType": "com.akamai.luna.papi.model.ClientSettingsView",
"type": "object",
"required": [
"ruleFormat",
"usePrefixes"
],
"properties": {
"ruleFormat": {
"description": "A string key indicating the dated version of the API's set of features specified by a rule format schema. This specifies the default rule format version to apply to new properties. See [API versioning](https://techdocs.akamai.com/property-mgr/reference/api-versioning) for more information.",
"type": "string"
},
"usePrefixes": {
"description": "Whether ID values in response data should feature three-letter prefixes to indicate their type. You can set the `PAPI-Use-Prefixes` header to override the client's default for each request.",
"type": "boolean"
}
},
"x-akamai": {
"file-path": "schemas/client-settings-set-request.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"
}
},
"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": "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"
}
}
]
},
"put": {
"description": "Update the current set of default values that apply to API clients keyed by the current authorization token.",
"operationId": "put-client-settings",
"summary": "Akamai Update Client Settings",
"tags": [
"Client settings"
],
"externalDocs": {
"description": "See documentation for this operation in Akamai's Property Manager API",
"url": "https://techdocs.akamai.com/property-mgr/reference/put-client-settings"
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"example": {
"ruleFormat": "v2015-08-08",
"usePrefixes": true
},
"schema": {
"$schema": "http://json-schema.org/draft-04-schema#",
"description": "Specifies default settings for an API client.",
"id": "resource:/descriptors/papi/v1/schemas/SetClientSettingsRequestV0.json#",
"javaType": "com.akamai.luna.papi.model.ClientSettingsView",
"type": "object",
"required": [
"ruleFormat",
"usePrefixes"
],
"properties": {
"ruleFormat": {
"description": "A string key indicating the dated version of the API's set of features specified by a rule format schema. This specifies the default rule format version to apply to new properties. See [API versioning](https://techdocs.akamai.com/property-mgr/reference/api-versioning) for more information.",
"example": "{{ruleFormat}}",
"type": "string"
},
"usePrefixes": {
"description": "Whether ID values in response data should feature three-letter prefixes to indicate their type. You can set the `PAPI-Use-Prefixes` header to override the client's default for each request.",
"example": "{{usePrefixes}}",
"type": "boolean"
}
},
"x-akamai": {
"file-path": "schemas/client-settings-set-request.yaml"
}
}
}
}
},
"responses": {
"200": {
"description": "The response reflects the updated client settings.",
"content": {
"application/json": {
"example": {
"ruleFormat": "v2015-08-08",
"usePrefixes": true
},
"schema": {
"$schema": "http://json-schema.org/draft-04-schema#",
"description": "Specifies default settings for an API client.",
"id": "resource:/descriptors/papi/v1/schemas/SetClientSettingsRequestV0.json#",
"javaType": "com.akamai.luna.papi.model.ClientSettingsView",
"type": "object",
"required": [
"ruleFormat",
"usePrefixes"
],
"properties": {
"ruleFormat": {
"description": "A string key indicating the dated version of the API's set of features specified by a rule format schema. This specifies the default rule format version to apply to new properties. See [API versioning](https://techdocs.akamai.com/property-mgr/reference/api-versioning) for more information.",
"type": "string"
},
"usePrefixes": {
"description": "Whether ID values in response data should feature three-letter prefixes to indicate their type. You can set the `PAPI-Use-Prefixes` header to override the client's default for each request.",
"type": "boolean"
}
},
"x-akamai": {
"file-path": "schemas/client-settings-set-request.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": "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"
}
}
]
},
"x-akamai": {
"file-path": "paths/client-settings.yaml",
"path-for-file": "/client-settings"
}
},
"/contracts": {
"get": {
"description": "You need information about the prevailing contract to access most PAPI interfaces. This operation provides a read-only list of contract names and identifiers. The response provides context on the overall account that enables each contract and keys your API credentials, but you don't need it to access any PAPI objects.",
"operationId": "get-contracts",
"summary": "Akamai List Contracts",
"tags": [
"Contracts"
],
"externalDocs": {
"description": "See documentation for this operation in Akamai's Property Manager API",
"url": "https://techdocs.akamai.com/property-mgr/reference/get-contracts"
},
"responses": {
"200": {
"description": "The response lists contracts available for the account.",
"content": {
"application/json": {
"example": {
"accountId": "act_A-CCT3456",
"contracts": {
"items": [
{
"contractId": "ctr_C-0N7RAC7",
"contractTypeName": "DIRECT_CUSTOMER"
}
]
}
},
"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/GetContractResponse.json#",
"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"
},
"contracts": {
"additionalProperties": false,
"description": "The set of requested contracts, available within an `items` array.",
"type": "object",
"properties": {
"items": {
"description": "Encapsulates information about the contract the property belongs to. Relevant response objects appear within the outer envelope's `contracts.items` array.",
"type": "array",
"items": {
"additionalProperties": false,
"type": "object",
"required": [
"contractId",
"contractTypeName"
],
"properties": {
"contractId": {
"description": "Identifies each contract. 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"
},
"contractTypeName": {
"description": "Distinguishes the type of contract, either `DIRECT_CUSTOMER`, `INDIRECT_CUSTOMER`, `PARENT_CUSTOMER`, `REFERRAL_PARTNER`, `TIER_1_RESELLER`, `VAR_CUSTOMER`, `VALUE_ADDED_RESELLER`, `PARTNER`, `PORTAL_PARTNER`, `STREAMING_RESELLER`, `AKAMAI_INTERNAL`, or `UNKNOWN`.",
"type": "string",
"enum": [
"AKAMAI_INTERNAL",
"DIRECT_CUSTOMER",
"INDIRECT_CUSTOMER",
"PARENT_CUSTOMER",
"REFERRAL_PARTNER",
"TIER_1_RESELLER",
"VAR_CUSTOMER",
"VALUE_ADDED_RESELLER",
"PARTNER",
"PORTAL_PARTNER",
"STREAMING_RESELLER",
"UNKNOWN"
]
}
}
}
}
}
}
},
"x-akamai": {
"file-path": "schemas/contract-get-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"
}
},
"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"
}
}
]
},
"x-akamai": {
"file-path": "paths/contracts.yaml",
"path-for-file": "/contracts"
}
},
"/cpcodes": {
"post": {
"description": "To create a new CP code, you need to associate it with a product. You can assign any CP code within a property's rule tree as detailed in the [Rule Trees](https://techdocs.akamai.com/property-mgr/reference/rule-trees) section. You should match the same `productId` that's assigned to properties that invoke the CP code to the one assigned to the CP code, otherwise you may get a warning.\n\nTo view or update certain CP code data, such as name, time zone, and purgeability, use the [CP Codes and Reporting Groups API](https://techdocs.akamai.com/cp-codes/reference/api).",
"operationId": "post-cpcodes",
"summary": "Akamai Create a New CP Code",
"tags": [
"CP codes"
],
"externalDocs": {
"description": "See documentation for this operation in Akamai's Property Manager API",
"url": "https://techdocs.akamai.com/property-mgr/reference/post-cpcodes"
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"example": {
"cpcodeName": "SME WAA",
"productId": "prd_Web_App_Accel"
},
"schema": {
"$schema": "http://json-schema.org/draft-04-schema#",
"description": "Specifies billing and reporting codes. To make a POST request that creates a new CP code, specify an object with `productId` and `cpcodeName` members. Relevant response objects appear within the outer envelope's `cpcodes.items` array.",
"id": "resource:/descriptors/papi/v1/schemas/CreateNewCPCodeRequestV0.json#",
"javaType": "com.akamai.luna.papi.model.CPCodeCreateRequest",
"type": "object",
"required": [
"productId",
"cpcodeName"
],
"properties": {
"cpcodeName": {
"description": "A descriptive label for the CP code. The name can't include commas, underscores, quotes, or any of these special characters: `^ # %`.",
"example": "{{cpcodeName}}",
"type": "string"
},
"productId": {
"description": "On POST, the product to assign to this CP code. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on how to omit the ID's `prd_` prefix.",
"example": "{{productId}}",
"type": "string"
}
},
"x-akamai": {
"file-path": "schemas/cpcode-create-request.yaml"
}
}
}
}
},
"responses": {
"201": {
"description": "The response provides a URL link to the newly created CP code.",
"content": {
"application/json": {
"example": {
"cpcodeLink": "/papi/v0/cpcodes/cpc_33190?contractId=ctr_C-0N7RAC7&groupId=grp_15166"
},
"schema": {
"$schema": "http://json-schema.org/draft-04-schema#",
"additionalProperties": false,
"description": "Provides a hypermedia link to a newly created resource. The response's single member name indicates the type of resource.",
"id": "resource:/descriptors/papi/v1/schemas/PostCpCodeResponse.json#",
"type": "object",
"required": [
"cpcodeLink"
],
"properties": {
"cpcodeLink": {
"description": "Links the newly created CP code.",
"type": "string"
}
},
"x-akamai": {
"file-path": "schemas/cpcode-post-response.yaml"
}
}
}
},
"headers": {
"Location": {
"description": "Provides a URL path you can GET the newly created resource from.",
"schema": {
"type": "string"
},
"x-akamai": {
"file-path": "headers/Location.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"
}
},
"422": {
"description": "[Unprocessable content](https://techdocs.akamai.com/property-mgr/reference/422).",
"content": {
"application/problem+json": {
"example": {
"instance": "papi/v1/activations/#abc12345abcc02a7",
"messageId": "property_activation_still_pending",
"result": "ERROR",
"status": 422,
"title": "Property Manager Exception",
"type": "https://problems.luna.akamaiapis.net/papi/v1/property_activation_still_pending",
"params": [
"Property 123456",
"Version 1"
],
"details": {},
"errors": [
{
"detail": "property_activation_still_pending",
"title": "Property Manager Exception",
"type": "papi/v1/property_activation_still_pending"
}
]
},
"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",
"instance",
"status",
"errors",
"details",
"messageId",
"params",
"result"
],
"properties": {
"details": {
"description": "Diagnostic instructions to locate and fix the problem.",
"type": "object"
},
"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"
},
"messageId": {
"description": "Summarizes the cause of the problem.",
"minLength": 1,
"type": "string"
},
"params": {
"description": "Details of the property and version where the problem occured.",
"minItems": 0,
"type": "array",
"items": {
"type": "string"
}
},
"result": {
"description": "Indicates the severity of the problem.",
"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-422.yaml"
}
}
}
},
"x-akamai": {
"file-path": "errors/422.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": "Unique identifier for the contract. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting the value's `ctr_` prefix.",
"example": "{{contractId}}",
"in": "query",
"name": "contractId",
"required": true,
"schema": {
"example": "ctr_1-1TJZFW",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/contractId-required.yaml"
}
},
{
"description": "Unique identifier for the group. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting the value's `grp_` prefix.",
"example": "{{groupId}}",
"in": "query",
"name": "groupId",
"required": true,
"schema": {
"example": "grp_15166",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/groupId-required.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"
}
}
]
},
"get": {
"description": "This operation lists CP codes available within your contract and group pairing. You assign CP codes to a property within its rule tree. To list all CP codes in your account at once, without having to filter the request by contracts and groups, use the [CP Codes and Reporting Groups API](https://techdocs.akamai.com/cp-codes/reference/get-cpcodes). CP codes include information about their product assignment. When [creating a new property](https://techdocs.akamai.com/property-mgr/reference/post-properties), you need to apply the same product you specified for the assigned CP code.\n\nTo view or update certain CP code data, such as name, time zone, and purgeability, use the [CP Codes and Reporting Groups API](https://techdocs.akamai.com/cp-codes/reference/api).",
"operationId": "get-cpcodes",
"summary": "Akamai List CP Codes",
"tags": [
"CP codes"
],
"externalDocs": {
"description": "See documentation for this operation in Akamai's Property Manager API",
"url": "https://techdocs.akamai.com/property-mgr/reference/get-cpcodes"
},
"responses": {
"200": {
"description": "The response lists CP codes.",
"content": {
"application/json": {
"example": {
"accountId": "act_A-CCT7890",
"contractId": "ctr_C-0N7RAC7",
"groupId": "grp_15225",
"cpcodes": {
"items": [
{
"cpcodeId": "cpc_1234567",
"cpcodeName": "SME WAA",
"createdDate": "2015-03-02T15:06:13Z",
"productIds": [
"prd_Web_App_Accel"
]
}
]
}
},
"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/GetCpCodeResponse.json#",
"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"
},
"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"
},
"cpcodes": {
"additionalProperties": false,
"description": "The set of requested CP codes, available within an `items` array.",
"type": "object",
"properties": {
"items": {
"description": "Specifies billing and reporting codes. To make a POST request that creates a new CP code, specify an object with `productId` and `cpcodeName` members. Relevant response objects appear within the outer envelope's `cpcodes.items` array.",
"type": "array",
"items": {
"additionalProperties": false,
"type": "object",
"required": [
"cpcodeId",
"cpcodeName",
"createdDate",
"productIds"
],
"properties": {
"cpcodeId": {
"description": "Identifies each CP code. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on how to omit the ID's `cpc_` prefix.",
"type": "string"
},
"cpcodeName": {
"description": "A descriptive label for the CP code. The name can't include commas, underscores, quotes, or any of these special characters: `^ # %`.",
"type": "string"
},
"createdDate": {
"description": "A time stamp for the CP code.",
"type": "string"
},
"productIds": {
"description": "On GET, lists identifiers for products assigned to this CP code, including the one specified by `productId` when you initially POST a new object. Note that PAPI doesn't support Property Manager's ability to assign more than one product to a CP code.",
"minItems": 1,
"type": "array",
"items": {
"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"
}
},
"x-akamai": {
"file-path": "schemas/cpcode-get-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"
}
},
"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": "Unique identifier for the contract. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting the value's `ctr_` prefix.",
"example": "{{contractId}}",
"in": "query",
"name": "contractId",
"required": true,
"schema": {
"example": "ctr_1-1TJZFW",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/contractId-required.yaml"
}
},
{
"description": "Unique identifier for the group. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting the value's `grp_` prefix.",
"example": "{{groupId}}",
"in": "query",
"name": "groupId",
"required": true,
"schema": {
"example": "grp_15166",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/groupId-required.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"
}
}
]
},
"x-akamai": {
"file-path": "paths/cpcodes.yaml",
"path-for-file": "/cpcodes"
},
"x-akamai-descriptor-tools": {
"displayName": "cpCodes",
"group": "CpCodes"
}
},
"/cpcodes/{cpcodeId}": {
"get": {
"description": "This operation gets details about a CP code. To view or update certain CP code data, such as name, time zone, and purgeability, use the [CP Codes and Reporting Groups API](https://techdocs.akamai.com/cp-codes/reference/api).",
"operationId": "get-cpcode",
"summary": "Akamai Get a CP Code",
"tags": [
"CP codes"
],
"externalDocs": {
"description": "See documentation for this operation in Akamai's Property Manager API",
"url": "https://techdocs.akamai.com/property-mgr/reference/get-cpcode"
},
"responses": {
"200": {
"description": "The response lists available CP codes.",
"content": {
"application/json": {
"example": {
"accountId": "act_A-CCT5678",
"contractId": "ctr_K-0N7RAK71",
"groupId": "grp_15166",
"cpcodes": {
"items": [
{
"cpcodeId": "cpc_1234567",
"cpcodeName": "SME WAA",
"createdDate": "2015-03-02T15:06:13Z",
"productIds": [
"prd_Web_App_Accel"
]
}
]
}
},
"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/GetCpCodeResponse.json#",
"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"
},
"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"
},
"cpcodes": {
"additionalProperties": false,
"description": "The set of requested CP codes, available within an `items` array.",
"type": "object",
"properties": {
"items": {
"description": "Specifies billing and reporting codes. To make a POST request that creates a new CP code, specify an object with `productId` and `cpcodeName` members. Relevant response objects appear within the outer envelope's `cpcodes.items` array.",
"type": "array",
"items": {
"additionalProperties": false,
"type": "object",
"required": [
"cpcodeId",
"cpcodeName",
"createdDate",
"productIds"
],
"properties": {
"cpcodeId": {
"description": "Identifies each CP code. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on how to omit the ID's `cpc_` prefix.",
"type": "string"
},
"cpcodeName": {
"description": "A descriptive label for the CP code. The name can't include commas, underscores, quotes, or any of these special characters: `^ # %`.",
"type": "string"
},
"createdDate": {
"description": "A time stamp for the CP code.",
"type": "string"
},
"productIds": {
"description": "On GET, lists identifiers for products assigned to this CP code, including the one specified by `productId` when you initially POST a new object. Note that PAPI doesn't support Property Manager's ability to assign more than one product to a CP code.",
"minItems": 1,
"type": "array",
"items": {
"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"
}
},
"x-akamai": {
"file-path": "schemas/cpcode-get-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"
}
},
"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": "Unique identifier for the contract. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting the value's `ctr_` prefix.",
"example": "{{contractId}}",
"in": "query",
"name": "contractId",
"required": true,
"schema": {
"example": "ctr_1-1TJZFW",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/contractId-required.yaml"
}
},
{
"description": "Unique identifier for the group. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting the value's `grp_` prefix.",
"example": "{{groupId}}",
"in": "query",
"name": "groupId",
"required": true,
"schema": {
"example": "grp_15166",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/groupId-required.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"
}
}
]
},
"x-akamai": {
"file-path": "paths/cpcode.yaml",
"path-for-file": "/cpcodes/{cpcodeId}"
},
"x-akamai-descriptor-tools": {
"displayName": "cpCode",
"group": "CpCodes"
},
"parameters": [
{
"description": "Unique identifier for the CP code. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting the value's `cpc_` prefix.",
"example": "{{cpcodeId}}",
"in": "path",
"name": "cpcodeId",
"required": true,
"schema": {
"example": "cpc_33190",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/cpcodeId-path.yaml"
}
}
]
},
"/custom-behaviors": {
"get": {
"description": "Lists the set of custom XML metadata behaviors configured for you by Akamai representatives. Referencing the relevant `behaviorId` from a [`customBehavior`](https://techdocs.akamai.com/property-mgr/reference/latest-custom-behavior) within the rule tree injects the custom XML within the rest of the rule tree's metadata XML. See [Custom behaviors and overrides](https://techdocs.akamai.com/property-mgr/reference/custom-behaviors-and-overrides) for guidance on custom overrides.",
"operationId": "get-custom-behaviors",
"summary": "Akamai List Custom Behaviors",
"tags": [
"Custom behaviors"
],
"externalDocs": {
"description": "See documentation for this operation in Akamai's Property Manager API",
"url": "https://techdocs.akamai.com/property-mgr/reference/get-custom-behaviors"
},
"responses": {
"200": {
"description": "The response lists custom behaviors.",
"content": {
"application/json": {
"example": {
"accountId": "act_A-CCT3456",
"customBehaviors": {
"items": [
{
"behaviorId": "cbe_12345",
"description": "Setting custom download receipt. Uses PMUSER_LOG variable.",
"displayName": "Custom Download Receipt",
"name": "DLR",
"status": "ACTIVE",
"updatedByUser": "afero",
"updatedDate": "2017-04-24T12:34:56Z"
}
]
}
},
"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/GetCustomBehaviorResponse.json#",
"type": "object",
"properties": {
"accountId": {
"description": "The account under which this custom behavior is available.",
"minLength": 1,
"type": "string"
},
"customBehaviors": {
"additionalProperties": false,
"description": "The set of requested custom behaviors, available within an `items` array.",
"type": "object",
"properties": {
"items": {
"description": "Represents a customized XML metadata Akamai sets up on your behalf. You can invoke it in a [`customBehavior`](https://techdocs.akamai.com/property-mgr/reference/latest-custom-behavior) within a rule tree. Relevant response objects appear within the outer envelope's `customBehaviors.items` array. See [Custom behaviors and overrides](https://techdocs.akamai.com/property-mgr/reference/custom-behaviors-and-overrides) for guidance.",
"type": "array",
"items": {
"additionalProperties": false,
"type": "object",
"required": [
"behaviorId",
"description",
"displayName",
"name",
"status",
"updatedByUser",
"updatedDate"
],
"properties": {
"behaviorId": {
"description": "The unique identifier for the custom XML metadata that you reference from a [`customBehavior`](https://techdocs.akamai.com/property-mgr/reference/latest-custom-behavior) to insert it in a rule tree. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on how to omit the ID's `cbe_` prefix.",
"type": "string"
},
"description": {
"description": "Descriptive text for the custom metadata.",
"type": "string"
},
"displayName": {
"description": "A display label for the custom metadata.",
"type": "string"
},
"name": {
"description": "A name for the custom metadata.",
"type": "string"
},
"status": {
"description": "Current deployment status for the custom metadata. By the time it's available to customers, the only possible value is `ACTIVE`.",
"type": "string",
"enum": [
"ACTIVE"
]
},
"updatedByUser": {
"description": "The name of the Akamai representative who last updated the custom metadata.",
"type": "string"
},
"updatedDate": {
"description": "The date stamp of the custom metadata's latest update.",
"type": "string"
},
"xml": {
"description": "The customized XML metadata to inject within the rule.",
"type": "string"
}
}
}
}
}
}
},
"x-akamai": {
"file-path": "schemas/custom-behavior-get-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"
}
},
"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"
}
}
]
},
"x-akamai": {
"file-path": "paths/custom-behaviors.yaml",
"path-for-file": "/custom-behaviors"
},
"x-akamai-descriptor-tools": {
"displayName": "customBehaviors",
"group": "CustomBehaviors"
}
},
"/custom-behaviors/{behaviorId}": {
"get": {
"description": "Get information for a single custom behavior. Use this operation if you want to examine the custom behavior's XML metadata source.",
"operationId": "get-custom-behavior",
"summary": "Akamai Get a Custom Behavior",
"tags": [
"Custom behaviors"
],
"externalDocs": {
"description": "See documentation for this operation in Akamai's Property Manager API",
"url": "https://techdocs.akamai.com/property-mgr/reference/get-custom-behavior"
},
"responses": {
"200": {
"description": "The response shows the specified custom behavior.",
"content": {
"application/json": {
"example": {
"accountId": "act_A-CCT7890",
"customBehaviors": {
"items": [
{
"behaviorId": "cbe_12345",
"description": "Setting custom download receipt. Uses PMUSER_LOG variable.",
"displayName": "Custom Download Receipt",
"name": "DLR",
"status": "ACTIVE",
"updatedByUser": "adevi",
"updatedDate": "2017-04-24T12:34:56Z",
"xml": "logs.customer.com/dlroffon443stuff=%(PMUSER_LOG)&time=%t&url=%uPOST"
}
]
}
},
"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/GetCustomBehaviorResponse.json#",
"type": "object",
"properties": {
"accountId": {
"description": "The account under which this custom behavior is available.",
"minLength": 1,
"type": "string"
},
"customBehaviors": {
"additionalProperties": false,
"description": "The set of requested custom behaviors, available within an `items` array.",
"type": "object",
"properties": {
"items": {
"description": "Represents a customized XML metadata Akamai sets up on your behalf. You can invoke it in a [`customBehavior`](https://techdocs.akamai.com/property-mgr/reference/latest-custom-behavior) within a rule tree. Relevant response objects appear within the outer envelope's `customBehaviors.items` array. See [Custom behaviors and overrides](https://techdocs.akamai.com/property-mgr/reference/custom-behaviors-and-overrides) for guidance.",
"type": "array",
"items": {
"additionalProperties": false,
"type": "object",
"required": [
"behaviorId",
"description",
"displayName",
"name",
"status",
"updatedByUser",
"updatedDate"
],
"properties": {
"behaviorId": {
"description": "The unique identifier for the custom XML metadata that you reference from a [`customBehavior`](https://techdocs.akamai.com/property-mgr/reference/latest-custom-behavior) to insert it in a rule tree. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on how to omit the ID's `cbe_` prefix.",
"type": "string"
},
"description": {
"description": "Descriptive text for the custom metadata.",
"type": "string"
},
"displayName": {
"description": "A display label for the custom metadata.",
"type": "string"
},
"name": {
"description": "A name for the custom metadata.",
"type": "string"
},
"status": {
"description": "Current deployment status for the custom metadata. By the time it's available to customers, the only possible value is `ACTIVE`.",
"type": "string",
"enum": [
"ACTIVE"
]
},
"updatedByUser": {
"description": "The name of the Akamai representative who last updated the custom metadata.",
"type": "string"
},
"updatedDate": {
"description": "The date stamp of the custom metadata's latest update.",
"type": "string"
},
"xml": {
"description": "The customized XML metadata to inject within the rule.",
"type": "string"
}
}
}
}
}
}
},
"x-akamai": {
"file-path": "schemas/custom-behavior-get-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"
}
},
"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"
}
}
]
},
"x-akamai": {
"file-path": "paths/custom-behavior.yaml",
"path-for-file": "/custom-behaviors/{behaviorId}"
},
"x-akamai-descriptor-tools": {
"displayName": "customBehavior",
"group": "CustomBehaviors"
},
"parameters": [
{
"description": "Unique identifier for the custom behavior.",
"example": "{{behaviorId}}",
"in": "path",
"name": "behaviorId",
"required": true,
"schema": {
"example": "cbe_12345",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/behaviorId-path.yaml"
}
}
]
},
"/custom-overrides": {
"get": {
"description": "Lists the set of custom XML metadata overrides configured for you by Akamai representatives. Referencing the relevant `overrideId` from a `customOverride` object makes the custom XML append to the rest of the metadata XML defined by the rule tree, typically to restore state. See [Custom behaviors and overrides](https://techdocs.akamai.com/property-mgr/reference/custom-behaviors-and-overrides) for guidance on custom overrides.",
"operationId": "get-custom-overrides",
"summary": "Akamai List Custom Overrides",
"tags": [
"Custom overrides"
],
"externalDocs": {
"description": "See documentation for this operation in Akamai's Property Manager API",
"url": "https://techdocs.akamai.com/property-mgr/reference/get-custom-overrides"
},
"responses": {
"200": {
"description": "The response lists custom overrides.",
"content": {
"application/json": {
"example": {
"accountId": "act_A-CCT9012",
"customOverrides": {
"items": [
{
"description": "Multiple Domain Configuration can be used to ...",
"displayName": "MDC Behavior",
"name": "mdc",
"overrideId": "cbo_12345",
"status": "ACTIVE",
"updatedByUser": "jdupont",
"updatedDate": "2017-04-24T12:34:56Z"
}
]
}
},
"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/GetCustomOverrideResponse.json#",
"type": "object",
"properties": {
"accountId": {
"description": "The account under which this custom overrride is available.",
"minLength": 1,
"type": "string"
},
"customOverrides": {
"additionalProperties": false,
"description": "The set of requested custom overrides, available within an `items` array.",
"type": "object",
"properties": {
"items": {
"description": "Represents a customized XML metadata Akamai sets up on your behalf. You can invoke it in a `customOverride` object within the top-level `default` rule tree to make it execute after all other rules, typically to restore a desired state. Relevant response objects appear within the outer envelope's `customOverrides.items` array. See [Custom behaviors and overrides](https://techdocs.akamai.com/property-mgr/reference/custom-behaviors-and-overrides) for guidance on custom overrides.",
"type": "array",
"items": {
"additionalProperties": false,
"type": "object",
"required": [
"description",
"displayName",
"name",
"overrideId",
"status",
"updatedByUser",
"updatedDate"
],
"properties": {
"description": {
"description": "Description for the custom override.",
"type": "string"
},
"displayName": {
"description": "Display label for the custom override.",
"type": "string"
},
"name": {
"description": "Name for the custom override.",
"type": "string"
},
"overrideId": {
"description": "The unique identifier for the custom XML override that you reference from a `customOverride` object to append it to a rule tree. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on how to omit the ID's `cbo_` prefix.",
"type": "string"
},
"status": {
"description": "Current deployment status for the custom override. By the time it's available to customers, the only possible value is `ACTIVE`.",
"type": "string",
"enum": [
"ACTIVE"
]
},
"updatedByUser": {
"description": "The name of the Akamai representative who last updated the custom override.",
"type": "string"
},
"updatedDate": {
"description": "The date stamp of the custom metadata's latest update.",
"type": "string"
},
"xml": {
"description": "The customized XML metadata to append to the rule tree.",
"type": "string"
}
}
}
}
}
}
},
"x-akamai": {
"file-path": "schemas/custom-override-get-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"
}
},
"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"
}
}
]
},
"x-akamai": {
"file-path": "paths/custom-overrides.yaml",
"path-for-file": "/custom-overrides"
},
"x-akamai-descriptor-tools": {
"displayName": "customOverrides",
"group": "CustomOverrides"
}
},
"/custom-overrides/{overrideId}": {
"get": {
"description": "Get information for a single custom override. Use this operation if you want to examine the override's XML metadata.",
"operationId": "get-custom-override",
"summary": "Akamai Get a Custom Override",
"tags": [
"Custom overrides"
],
"externalDocs": {
"description": "See documentation for this operation in Akamai's Property Manager API",
"url": "https://techdocs.akamai.com/property-mgr/reference/get-custom-override"
},
"responses": {
"200": {
"description": "The response shows the specified custom override.",
"content": {
"application/json": {
"example": {
"accountId": "act_A-CCT5678",
"customOverrides": {
"items": [
{
"description": "Multiple Domain Configuration can be used to ...",
"displayName": "MDC Behavior",
"name": "mdc",
"overrideId": "cbo_12345",
"status": "ACTIVE",
"updatedByUser": "tyamada",
"updatedDate": "2017-04-24T12:34:56Z",
"xml": "This is where the XML goes"
}
]
}
},
"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/GetCustomOverrideResponse.json#",
"type": "object",
"properties": {
"accountId": {
"description": "The account under which this custom overrride is available.",
"minLength": 1,
"type": "string"
},
"customOverrides": {
"additionalProperties": false,
"description": "The set of requested custom overrides, available within an `items` array.",
"type": "object",
"properties": {
"items": {
"description": "Represents a customized XML metadata Akamai sets up on your behalf. You can invoke it in a `customOverride` object within the top-level `default` rule tree to make it execute after all other rules, typically to restore a desired state. Relevant response objects appear within the outer envelope's `customOverrides.items` array. See [Custom behaviors and overrides](https://techdocs.akamai.com/property-mgr/reference/custom-behaviors-and-overrides) for guidance on custom overrides.",
"type": "array",
"items": {
"additionalProperties": false,
"type": "object",
"required": [
"description",
"displayName",
"name",
"overrideId",
"status",
"updatedByUser",
"updatedDate"
],
"properties": {
"description": {
"description": "Description for the custom override.",
"type": "string"
},
"displayName": {
"description": "Display label for the custom override.",
"type": "string"
},
"name": {
"description": "Name for the custom override.",
"type": "string"
},
"overrideId": {
"description": "The unique identifier for the custom XML override that you reference from a `customOverride` object to append it to a rule tree. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on how to omit the ID's `cbo_` prefix.",
"type": "string"
},
"status": {
"description": "Current deployment status for the custom override. By the time it's available to customers, the only possible value is `ACTIVE`.",
"type": "string",
"enum": [
"ACTIVE"
]
},
"updatedByUser": {
"description": "The name of the Akamai representative who last updated the custom override.",
"type": "string"
},
"updatedDate": {
"description": "The date stamp of the custom metadata's latest update.",
"type": "string"
},
"xml": {
"description": "The customized XML metadata to append to the rule tree.",
"type": "string"
}
}
}
}
}
}
},
"x-akamai": {
"file-path": "schemas/custom-override-get-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"
}
},
"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"
}
}
]
},
"x-akamai": {
"file-path": "paths/custom-override.yaml",
"path-for-file": "/custom-overrides/{overrideId}"
},
"x-akamai-descriptor-tools": {
"displayName": "customOverride",
"group": "CustomOverrides"
},
"parameters": [
{
"description": "Unique identifier for the custom override.",
"example": "{{overrideId}}",
"in": "path",
"name": "overrideId",
"required": true,
"schema": {
"example": "cbo_12345",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/overrideId-path.yaml"
}
}
]
},
"/edgehostnames": {
"post": {
"description": "**Note:** You can skip this operation if you're using Secure by Default that automatically creates an edge hostname upon activation. \n\nThis POST operation creates a new edge hostname. As detailed in the sections below, you can use three approaches to secure new edge hostnames: Standard TLS, Enhanced TLS, or a Shared Certificate. You can [assign a use case](https://techdocs.akamai.com/property-mgr/reference/modify-property-hostnames) mapping profile to optimize the hostname to serve specific types of traffic. Once the edge hostname is active, you can [Update a property's hostnames](https://techdocs.akamai.com/property-mgr/reference/put-property-version-hostnames) to assign it to a hostname on a property. After you [activate a property](https://techdocs.akamai.com/property-mgr/reference/post-property-activations), modifying your DNS to map the property hostname to the edge hostname ultimately enables traffic on the property. For details, see [Enable traffic for a new hostname](https://techdocs.akamai.com/property-mgr/reference/modify-property-hostnames). Use the [Edge Hostname API](https://techdocs.akamai.com/edge-hostnames/reference/get-edge-hostname-certificate) (HAPI) to modify edge hostnames, or delete any that aren't currently assigned to an active property configuration.",
"operationId": "post-edgehostnames",
"summary": "Akamai Create a New Edge Hostname",
"tags": [
"Edge hostnames"
],
"externalDocs": {
"description": "See documentation for this operation in Akamai's Property Manager API",
"url": "https://techdocs.akamai.com/property-mgr/reference/post-edgehostnames"
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"example": {
"domainPrefix": "www.example.com",
"domainSuffix": "edgesuite.net",
"ipVersionBehavior": "IPV4",
"productId": "prd_Dynamic_Site_Del",
"secureNetwork": "STANDARD_TLS",
"useCases": [
{
"option": "BACKGROUND",
"type": "GLOBAL",
"useCase": "Download_Mode"
}
]
},
"schema": {
"$schema": "http://json-schema.org/draft-04-schema#",
"description": "Specifies a set of available hostnames a property version may use. To POST a new edge hostname, specify a single object with `productId`, `domainPrefix`, and `domainSuffix` members, and optional `ipVersionBehavior` and `secure` members. Relevant response objects appear within the outer envelope's `edgehostnames.items` array.",
"id": "resource:/descriptors/papi/v1/schemas/CreateNewEdgeHostnameRequestV0.json#",
"javaType": "com.akamai.luna.papi.model.EdgeHostnameCreateRequest",
"type": "object",
"required": [
"productId",
"domainPrefix",
"domainSuffix",
"ipVersionBehavior"
],
"properties": {
"certEnrollmentId": {
"description": "When creating an Enhanced TLS edge hostname, this sets the certificate enrollment ID. Specify this on POST, with `secureNetwork` set to `ENHANCED_TLS`. To obtain a value programmatically, run the Certificate Provisioning System API's [List enrollments](https://techdocs.akamai.com/cps/reference/get-enrollments) operation. Choose the appropriate enrollment, strip the leading path expression from its `location` member, and use that value as the `certEnrollmentId`.",
"example": "{{certEnrollmentId}}",
"minimum": 1,
"type": "integer"
},
"domainPrefix": {
"description": "The origin domain portion of the edge hostname. An edge hostname consists of a customer-specific `namePrefix` such as `www.example.com` and an Akamai-specific `domainSuffix` such as `edgesuite.net`. The edge hostname's final DNS CNAME combines the two, for example, `www.example.com.edgesuite.net`.",
"example": "{{domainPrefix}}",
"type": "string"
},
"domainSuffix": {
"description": "The Akamai-specific portion of the edge hostname, for example, `edgesuite.net`.",
"example": "{{domainSuffix}}",
"type": "string"
},
"ipVersionBehavior": {
"default": "IPV4",
"description": "Which version of the IP protocol to use: `IPV4` for version 4 only, or `IPV6_COMPLIANCE` for both 4 and 6. The default value for requests is `IPV4`.",
"example": "{{ipVersionBehavior}}",
"type": "string",
"enum": [
"IPV4",
"IPV6_COMPLIANCE"
]
},
"productId": {
"description": "The product you created the edge hostname for. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on how to omit the ID's `prd_` prefix.",
"example": "{{productId}}",
"type": "string"
},
"secure": {
"default": false,
"description": "Whether to use the edge hostname with SSL. Defaults to `false` for POST requests. Enabling this option for new edge hostnames isn't supported.",
"example": "{{secure}}",
"type": "boolean"
},
"secureNetwork": {
"description": "On POST, specifies the type of security for the new edge hostname. With `STANDARD_TLS` specified, specify a `domainSuffix` of `edgesuite.net`. With `SHARED_CERT` specified, specify a `domainSuffix` of `akamaized.net`. With `ENHANCED_TLS` specified, you need to specify a `certEnrollmentId` value along with a `domainSuffix` of `edgekey.net`.",
"example": "{{secureNetwork}}",
"type": "string",
"enum": [
"ENHANCED_TLS",
"STANDARD_TLS",
"SHARED_CERT"
]
},
"slotNumber": {
"description": "On POST, sets the slot number for secure ESSL properties.",
"example": "{{slotNumber}}",
"minimum": 1,
"type": "integer"
},
"useCases": {
"description": "Optionally when configuring a new edge hostname, this assigns a preset _use case_ that characterizes the type of traffic served. Use cases optimize deployment over the Akamai edge network. To gather values to add to this object, run the [List use cases](https://techdocs.akamai.com/property-mgr/reference/get-product-mapping-use-cases) operation.",
"maxItems": 2,
"minItems": 0,
"type": "array",
"items": {
"type": "object",
"required": [
"useCase",
"option",
"type"
],
"properties": {
"option": {
"description": "Specifies one of the available `options` available in the response object.",
"type": "string"
},
"type": {
"description": "Identifies the type of network over which traffic deploys. The only value currently available is `GLOBAL`. Use this to specify the same member name available in the use case response object.",
"type": "string",
"enum": [
"GLOBAL"
]
},
"useCase": {
"description": "Identifies each mapping use case scenario. Use this to specify the same member name available in the use case response object.",
"type": "string"
}
}
}
}
},
"x-akamai": {
"file-path": "schemas/edgehostname-create-request.yaml"
}
}
}
}
},
"responses": {
"201": {
"description": "The response provides a URL link to the newly created edge hostname.",
"content": {
"application/json": {
"example": {
"edgeHostnameLink": "/papi/v0/edgehostnames/ehn_1332?contractId=ctr_C-0N7RAC7&grp_15225"
},
"schema": {
"$schema": "http://json-schema.org/draft-04-schema#",
"additionalProperties": false,
"description": "Provides a hypermedia link to a newly created resource. The response's single member name indicates the type of resource.",
"id": "resource:/descriptors/papi/v1/schemas/PostEdgeHostnameResponse.json#",
"type": "object",
"required": [
"edgeHostnameLink"
],
"properties": {
"edgeHostnameLink": {
"description": "Links the newly created edge hostname.",
"type": "string"
}
},
"x-akamai": {
"file-path": "schemas/edgehostname-post-response.yaml"
}
}
}
},
"headers": {
"Location": {
"description": "Provides a URL path you can GET the newly created resource from.",
"schema": {
"type": "string"
},
"x-akamai": {
"file-path": "headers/Location.yaml"
}
},
"X-Limit-Edgehostnames-Per-Contract-Limit": {
"description": "Maximum number of edge hostnames per contract.",
"schema": {
"type": "string"
},
"x-akamai": {
"file-path": "headers/X-Limit-Edgehostnames-Per-Contract-Limit.yaml"
}
},
"X-Limit-Edgehostnames-Per-Contract-Remaining": {
"description": "Remaining number of edge hostnames per contract. See [Rate and resource limiting](https://techdocs.akamai.com/property-mgr/reference/rate-and-resource-limiting) for details.",
"schema": {
"type": "string"
},
"x-akamai": {
"file-path": "headers/X-Limit-Edgehostnames-Per-Contract-Remaining.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": "Unique identifier for the contract. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting the value's `ctr_` prefix.",
"example": "{{contractId}}",
"in": "query",
"name": "contractId",
"required": true,
"schema": {
"example": "ctr_1-1TJZFW",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/contractId-required.yaml"
}
},
{
"description": "Unique identifier for the group. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting the value's `grp_` prefix.",
"example": "{{groupId}}",
"in": "query",
"name": "groupId",
"required": true,
"schema": {
"example": "grp_15166",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/groupId-required.yaml"
}
},
{
"description": "Currently the only supported option is `mapDetails` that enables extra mapping-related information. See [Site Shield API](https://techdocs.akamai.com/site-shield/reference/api) for more information.",
"example": "{{options}}",
"in": "query",
"name": "options",
"required": false,
"schema": {
"example": "mapDetails",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/options-query.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"
}
}
]
},
"get": {
"description": "This lists all edge hostnames available under a contract. To assign any of these hostnames to a property, run [Update a property's hostnames](https://techdocs.akamai.com/property-mgr/reference/put-property-version-hostnames). Use the [Edge Hostname API](https://techdocs.akamai.com/edge-hostnames/reference/get-edge-hostname-certificate) (HAPI) to modify edge hostnames, or delete any that aren't currently assigned to an active property configuration.",
"operationId": "get-edgehostnames",
"summary": "Akamai List Edge Hostnames",
"tags": [
"Edge hostnames"
],
"externalDocs": {
"description": "See documentation for this operation in Akamai's Property Manager API",
"url": "https://techdocs.akamai.com/property-mgr/reference/get-edgehostnames"
},
"responses": {
"200": {
"description": "The response lists edge hostnames available under a contract.",
"content": {
"application/json": {
"example": {
"accountId": "act_A-CCT5678",
"contractId": "ctr_C-0N7RAC7",
"groupId": "grp_15225",
"edgeHostnames": {
"items": [
{
"domainPrefix": "example.com",
"domainSuffix": "edgekey.net",
"edgeHostnameDomain": "example.com.edgekey.net",
"edgeHostnameId": "ehn_895822",
"ipVersionBehavior": "IPV4",
"productId": "prd_Alta",
"secure": true,
"status": "PENDING"
},
{
"domainPrefix": "example.com",
"domainSuffix": "edgesuite.net",
"edgeHostnameDomain": "example.com.edgesuite.net",
"edgeHostnameId": "ehn_887436",
"ipVersionBehavior": "IPV4",
"productId": "prd_Alta",
"secure": false
}
]
}
},
"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/GetEdgeHostnameResponse.json#",
"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"
},
"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"
},
"edgeHostnames": {
"additionalProperties": false,
"description": "The set of requested edge hostnames, available within an `items` array.",
"type": "object",
"properties": {
"items": {
"description": "Specifies a set of available hostnames a property version may use. To POST a new edge hostname, specify a single object with `productId`, `domainPrefix`, and `domainSuffix` members, and optional `ipVersionBehavior` and `secure` members. Set `secureNetwork` for a Standard TLS, Enhanced TLS, or a shared certificate edge hostname. Relevant response objects appear within the outer envelope's `edgehostnames.items` array.",
"type": "array",
"items": {
"additionalProperties": false,
"type": "object",
"required": [
"domainPrefix",
"domainSuffix",
"edgeHostnameDomain",
"edgeHostnameId",
"ipVersionBehavior",
"productId",
"secure"
],
"properties": {
"domainPrefix": {
"description": "The origin domain portion of the edge hostname. An edge hostname consists of a customer-specific `namePrefix` such as `www.example.com` and an Akamai-specific `domainSuffix` such as `edgesuite.net`. The edge hostname's final DNS CNAME combines the two, for example, `www.example.com.edgesuite.net`.",
"type": "string"
},
"domainSuffix": {
"description": "The Akamai-specific portion of the edge hostname, for example, `edgesuite.net`.",
"type": "string"
},
"edgeHostnameDomain": {
"description": "The full edge domain name formed from the `domainPrefix` and `domainSuffix`.",
"type": "string"
},
"edgeHostnameId": {
"description": "The edge hostname's unique identifier, which can be assigned to a property. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on how to omit the ID's `ehn_` prefix.",
"type": "string"
},
"ipVersionBehavior": {
"default": "IPV4",
"description": "Which version of the IP protocol to use: `IPV4` for version 4 only, or `IPV6_COMPLIANCE` for both 4 and 6. The default value for requests is `IPV4`.",
"type": "string",
"enum": [
"IPV4",
"IPV6_COMPLIANCE"
]
},
"mappingBehaviors": {
"description": "The behaviors that provide mapping solutions to the edge hostnames",
"minItems": 1,
"type": "array",
"items": {
"additionalProperties": false,
"type": "object",
"required": [
"behaviorName",
"options"
],
"properties": {
"options": {
"description": "Specifies the `options` associated with the mapping behavior",
"minItems": 1,
"type": "array",
"items": {
"additionalProperties": false,
"type": "object",
"required": [
"optionName",
"optionValue"
],
"properties": {
"optionName": {
"description": "The option name of the option associated with the mapping behavior",
"type": "string"
},
"optionValue": {
"description": "The the option values of the option associated with the mapping behavior",
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"behaviorName": {
"description": "The name of the mapping behavior",
"type": "string"
}
}
}
},
"productId": {
"description": "The product you created the edge hostname for. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on how to omit the ID's `prd_` prefix.",
"type": "string"
},
"secure": {
"default": false,
"description": "Whether to use the edge hostname with SSL. Defaults to `false` for POST requests. Enabling this option for new edge hostnames isn't supported.",
"type": "boolean"
},
"status": {
"description": "Appears as `PENDING` for any newly defined hostname whose DNS mapping hasn't yet been distributed across the entire Akamai network. If `status` is omitted, it indicates the edge hostname is active. Note that an edge hostname's status is unrelated to a property activation's deployment status.",
"type": "string",
"enum": [
"PENDING"
]
},
"useCases": {
"description": "Available use cases for edge hostnames assigned to the product. The preset use case scenarios provided by Akamai help optimally map different types of traffic across the Akamai edge network.",
"minItems": 1,
"type": "array",
"items": {
"additionalProperties": false,
"type": "object",
"required": [
"useCase",
"option",
"type"
],
"properties": {
"option": {
"description": "Specifies one of the available `options` available in the response object.",
"type": "string"
},
"type": {
"description": "Identifies the type of network over which traffic deploys. The only value currently available is `GLOBAL`. Use this to specify the same member name available in the use case response object.",
"type": "string",
"enum": [
"GLOBAL"
]
},
"useCase": {
"description": "Identifies each use case.",
"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"
}
},
"x-akamai": {
"file-path": "schemas/edgehostname-get-response.yaml"
}
}
}
},
"headers": {
"X-Limit-Edgehostnames-Per-Contract-Limit": {
"description": "Maximum number of edge hostnames per contract.",
"schema": {
"type": "string"
},
"x-akamai": {
"file-path": "headers/X-Limit-Edgehostnames-Per-Contract-Limit.yaml"
}
},
"X-Limit-Edgehostnames-Per-Contract-Remaining": {
"description": "Remaining number of edge hostnames per contract. See [Rate and resource limiting](https://techdocs.akamai.com/property-mgr/reference/rate-and-resource-limiting) for details.",
"schema": {
"type": "string"
},
"x-akamai": {
"file-path": "headers/X-Limit-Edgehostnames-Per-Contract-Remaining.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"
}
},
"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": "Unique identifier for the contract. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting the value's `ctr_` prefix.",
"example": "{{contractId}}",
"in": "query",
"name": "contractId",
"required": true,
"schema": {
"example": "ctr_1-1TJZFW",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/contractId-required.yaml"
}
},
{
"description": "Unique identifier for the group. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting the value's `grp_` prefix.",
"example": "{{groupId}}",
"in": "query",
"name": "groupId",
"required": true,
"schema": {
"example": "grp_15166",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/groupId-required.yaml"
}
},
{
"description": "Currently the only supported option is `mapDetails` that enables extra mapping-related information. See [Site Shield API](https://techdocs.akamai.com/site-shield/reference/api) for more information.",
"example": "{{options}}",
"in": "query",
"name": "options",
"required": false,
"schema": {
"example": "mapDetails",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/options-query.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"
}
}
]
},
"x-akamai": {
"file-path": "paths/edge-hostnames.yaml",
"path-for-file": "/edgehostnames"
},
"x-akamai-descriptor-tools": {
"displayName": "edgeHostnames",
"group": "EdgeHostnames"
}
},
"/edgehostnames/{edgeHostnameId}": {
"get": {
"description": "This polls the state of an edge hostname, typically after [creating a new edge hostname](https://techdocs.akamai.com/property-mgr/reference/post-edgehostnames). The response tells you whether the CNAME has been fully distributed across the network. If the hostname's `status` is `ACTIVE`, the process is complete. Until then, you typically see values of `ZONE1`, `ZONE2`, `ZONE3`, or simply `PENDING`.",
"operationId": "get-edgehostname",
"summary": "Akamai Get an Edge Hostname",
"tags": [
"Edge hostnames"
],
"externalDocs": {
"description": "See documentation for this operation in Akamai's Property Manager API",
"url": "https://techdocs.akamai.com/property-mgr/reference/get-edgehostname"
},
"responses": {
"200": {
"description": "The response shows the specified edge hostname.",
"content": {
"application/json": {
"example": {
"accountId": "act_A-CCT7890",
"contractId": "ctr_C-0N7RAC7",
"groupId": "grp_15225",
"edgeHostnames": {
"items": [
{
"domainPrefix": "example.com",
"domainSuffix": "edgesuite.net",
"edgeHostnameDomain": "example.com.edgesuite.net",
"edgeHostnameId": "ehn_887436",
"ipVersionBehavior": "IPV4",
"productId": "prd_Alta",
"secure": false,
"useCases": [
{
"option": "BACKGROUND",
"type": "GLOBAL",
"useCase": "Download_Mode"
}
]
}
]
}
},
"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/GetEdgeHostnameResponse.json#",
"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"
},
"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"
},
"edgeHostnames": {
"additionalProperties": false,
"description": "The set of requested edge hostnames, available within an `items` array.",
"type": "object",
"properties": {
"items": {
"description": "Specifies a set of available hostnames a property version may use. To POST a new edge hostname, specify a single object with `productId`, `domainPrefix`, and `domainSuffix` members, and optional `ipVersionBehavior` and `secure` members. Set `secureNetwork` for a Standard TLS, Enhanced TLS, or a shared certificate edge hostname. Relevant response objects appear within the outer envelope's `edgehostnames.items` array.",
"type": "array",
"items": {
"additionalProperties": false,
"type": "object",
"required": [
"domainPrefix",
"domainSuffix",
"edgeHostnameDomain",
"edgeHostnameId",
"ipVersionBehavior",
"productId",
"secure"
],
"properties": {
"domainPrefix": {
"description": "The origin domain portion of the edge hostname. An edge hostname consists of a customer-specific `namePrefix` such as `www.example.com` and an Akamai-specific `domainSuffix` such as `edgesuite.net`. The edge hostname's final DNS CNAME combines the two, for example, `www.example.com.edgesuite.net`.",
"type": "string"
},
"domainSuffix": {
"description": "The Akamai-specific portion of the edge hostname, for example, `edgesuite.net`.",
"type": "string"
},
"edgeHostnameDomain": {
"description": "The full edge domain name formed from the `domainPrefix` and `domainSuffix`.",
"type": "string"
},
"edgeHostnameId": {
"description": "The edge hostname's unique identifier, which can be assigned to a property. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on how to omit the ID's `ehn_` prefix.",
"type": "string"
},
"ipVersionBehavior": {
"default": "IPV4",
"description": "Which version of the IP protocol to use: `IPV4` for version 4 only, or `IPV6_COMPLIANCE` for both 4 and 6. The default value for requests is `IPV4`.",
"type": "string",
"enum": [
"IPV4",
"IPV6_COMPLIANCE"
]
},
"mappingBehaviors": {
"description": "The behaviors that provide mapping solutions to the edge hostnames",
"minItems": 1,
"type": "array",
"items": {
"additionalProperties": false,
"type": "object",
"required": [
"behaviorName",
"options"
],
"properties": {
"options": {
"description": "Specifies the `options` associated with the mapping behavior",
"minItems": 1,
"type": "array",
"items": {
"additionalProperties": false,
"type": "object",
"required": [
"optionName",
"optionValue"
],
"properties": {
"optionName": {
"description": "The option name of the option associated with the mapping behavior",
"type": "string"
},
"optionValue": {
"description": "The the option values of the option associated with the mapping behavior",
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"behaviorName": {
"description": "The name of the mapping behavior",
"type": "string"
}
}
}
},
"productId": {
"description": "The product you created the edge hostname for. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on how to omit the ID's `prd_` prefix.",
"type": "string"
},
"secure": {
"default": false,
"description": "Whether to use the edge hostname with SSL. Defaults to `false` for POST requests. Enabling this option for new edge hostnames isn't supported.",
"type": "boolean"
},
"status": {
"description": "Appears as `PENDING` for any newly defined hostname whose DNS mapping hasn't yet been distributed across the entire Akamai network. If `status` is omitted, it indicates the edge hostname is active. Note that an edge hostname's status is unrelated to a property activation's deployment status.",
"type": "string",
"enum": [
"PENDING"
]
},
"useCases": {
"description": "Available use cases for edge hostnames assigned to the product. The preset use case scenarios provided by Akamai help optimally map different types of traffic across the Akamai edge network.",
"minItems": 1,
"type": "array",
"items": {
"additionalProperties": false,
"type": "object",
"required": [
"useCase",
"option",
"type"
],
"properties": {
"option": {
"description": "Specifies one of the available `options` available in the response object.",
"type": "string"
},
"type": {
"description": "Identifies the type of network over which traffic deploys. The only value currently available is `GLOBAL`. Use this to specify the same member name available in the use case response object.",
"type": "string",
"enum": [
"GLOBAL"
]
},
"useCase": {
"description": "Identifies each use case.",
"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"
}
},
"x-akamai": {
"file-path": "schemas/edgehostname-get-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"
}
},
"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": "Unique identifier for the contract. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting the value's `ctr_` prefix.",
"example": "{{contractId}}",
"in": "query",
"name": "contractId",
"required": true,
"schema": {
"example": "ctr_1-1TJZFW",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/contractId-required.yaml"
}
},
{
"description": "Unique identifier for the group. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting the value's `grp_` prefix.",
"example": "{{groupId}}",
"in": "query",
"name": "groupId",
"required": true,
"schema": {
"example": "grp_15166",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/groupId-required.yaml"
}
},
{
"description": "Currently the only supported option is `mapDetails` that enables extra mapping-related information. See [Site Shield API](https://techdocs.akamai.com/site-shield/reference/api) for more information.",
"example": "{{options}}",
"in": "query",
"name": "options",
"required": false,
"schema": {
"example": "mapDetails",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/options-query.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"
}
}
]
},
"x-akamai": {
"file-path": "paths/edge-hostname.yaml",
"path-for-file": "/edgehostnames/{edgeHostnameId}"
},
"x-akamai-descriptor-tools": {
"displayName": "edgeHostname",
"group": "EdgeHostnames"
},
"parameters": [
{
"description": "Unique identifier for the edge hostname. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting the value's `ehn_` prefix.",
"example": "{{edgeHostnameId}}",
"in": "path",
"name": "edgeHostnameId",
"required": true,
"schema": {
"example": "ehn_887436",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/edgeHostnameId-path.yaml"
}
}
]
},
"/groups": {
"get": {
"description": "You need information about the prevailing group to access most PAPI interfaces. This operation provides a read-only list of groups, which may contain properties. This operation provides a flat list of groups, along with `parentGroupId` information to structure them as a hierarchy. Each group also lists any available contracts that enable property features, but not which group contains a given property. Use the [Identity and Access Management API](https://techdocs.akamai.com/iam-api/reference/api) to assign properties to groups, and modify the group hierarchy.",
"operationId": "get-groups",
"summary": "Akamai List Groups",
"tags": [
"Groups"
],
"externalDocs": {
"description": "See documentation for this operation in Akamai's Property Manager API",
"url": "https://techdocs.akamai.com/property-mgr/reference/get-groups"
},
"responses": {
"200": {
"description": "The response lists available groups.",
"content": {
"application/json": {
"example": {
"accountId": "act_1-1TJZFB",
"accountName": "Digital Company",
"groups": {
"items": [
{
"groupId": "grp_15225",
"groupName": "Example.com-1-1TJZH5",
"contractIds": [
"1-12345"
]
},
{
"groupId": "grp_15231",
"groupName": "Test",
"parentGroupId": "grp_15225",
"contractIds": [
"1-12345"
]
},
{
"groupId": "grp_41443",
"groupName": "TomTest",
"parentGroupId": "grp_15225",
"contractIds": [
"1-12345"
]
}
]
}
},
"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/GetGroupResponse.json#",
"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"
},
"accountName": {
"description": "A descriptive name for the account.",
"type": "string"
},
"groups": {
"additionalProperties": false,
"description": "The set of requested groups, available within an `items` array.",
"type": "object",
"properties": {
"items": {
"description": "Encapsulates information about the group that contains a property. Relevant response objects appear within the outer envelope's `groups.items` array.",
"type": "array",
"items": {
"additionalProperties": false,
"type": "object",
"required": [
"contractIds",
"groupId",
"groupName"
],
"properties": {
"contractIds": {
"description": "A set of string identifiers for contracts whose products can be applied to properties within a group.",
"minItems": 1,
"type": "array",
"items": {
"type": "string"
}
},
"groupId": {
"description": "Identifies each group. 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"
},
"groupName": {
"description": "A descriptive label for the group.",
"type": "string"
},
"parentGroupId": {
"description": "Identifies another group as a parent, defining the relative location of the group within the group hierarchy. If omitted, it's the root-level group at the top of the hierarchy.",
"type": "string"
}
}
}
}
}
}
},
"x-akamai": {
"file-path": "schemas/group-get-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"
}
},
"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"
}
}
]
},
"x-akamai": {
"file-path": "paths/groups.yaml",
"path-for-file": "/groups"
}
},
"/hostnames": {
"get": {
"description": "This operation lists active property hostnames for all properties available in an account. Use the optional query parameters to paginate, sort, and filter the results. You can nest and combine filters to obtain desired results. To view paginated results, use the response's `nextLink` and `previousLink`.",
"operationId": "get-hostnames",
"summary": "Akamai List Hostnames for an Account",
"tags": [
"Property hostnames"
],
"externalDocs": {
"description": "See documentation for this operation in Akamai's Property Manager API",
"url": "https://techdocs.akamai.com/property-mgr/reference/get-hostnames"
},
"responses": {
"200": {
"description": "The response lists property hostnames for properties in a current account.",
"content": {
"application/json": {
"example": {
"accountId": "act_A-CCT3456",
"currentSort": "hostname:a",
"defaultSort": "hostname:a",
"availableSort": [
"hostname:a",
"hostname:d"
],
"hostnames": {
"currentItemCount": 3,
"nextLink": "/papi/v1/hostnames?offset=3&limit=3",
"previousLink": "/papi/v1/hostnames?offset=0&limit=3",
"totalItems": 17,
"items": [
{
"cnameFrom": "www.example.com",
"contractId": "ctr_C-0N7RAC7",
"groupId": "grp_15225",
"propertyId": "prp_123345",
"propertyName": "example.com",
"propertyType": "TRADITIONAL",
"stagingCertType": "CPS_MANAGED",
"stagingCnameTo": "www.example.com.edgekey.net",
"stagingCnameType": "EDGE_HOSTNAME",
"stagingEdgeHostnameId": "ehn_895822"
},
{
"cnameFrom": "www.example2.com",
"contractId": "ctr_C-0N7RAC71",
"groupId": "grp_15225",
"productionCertType": "DEFAULT",
"productionCnameTo": "www.example2.com.edgekey.net",
"productionCnameType": "EDGE_HOSTNAME",
"productionEdgeHostnameId": "ehn_895825",
"propertyId": "prp_123424",
"propertyName": "example2.com",
"propertyType": "TRADITIONAL"
},
{
"cnameFrom": "www.example3.com",
"contractId": "ctr_C-0N7RAC7",
"groupId": "grp_15225",
"productionCertType": "DEFAULT",
"productionCnameTo": "www.example3.com.edgekey.net",
"productionCnameType": "EDGE_HOSTNAME",
"productionEdgeHostnameId": "ehn_895833",
"propertyId": "prp_123424",
"propertyName": "example3.com",
"propertyType": "HOSTNAME_BUCKET"
}
]
}
},
"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, even individual items.",
"id": "resource:/descriptors/papi/v1/schemas/GetAccountHostnamesResponse.json#",
"type": "object",
"required": [
"accountId",
"hostnames",
"currentSort",
"defaultSort",
"availableSort"
],
"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"
},
"availableSort": {
"description": "Available sorting options: `hostname:a` for ascending, and `hostname:d` for descending.",
"minItems": 1,
"type": "array",
"items": {
"type": "string",
"enum": [
"hostname:a",
"hostname:d"
]
}
},
"currentSort": {
"description": "The sorting criteria applied to the response, either `hostname:a` for ascending, or `hostname:d` for descending.",
"type": "string",
"enum": [
"hostname:a",
"hostname:d"
]
},
"defaultSort": {
"default": "hostname:a",
"description": "If you didn't specify any query parameters in the request, this shows the default `hostname:a` sorting criteria.",
"type": "string"
},
"hostnames": {
"additionalProperties": false,
"description": "The set of requested hostnames, available within an `items` array.",
"type": "object",
"required": [
"items",
"nextLink",
"totalItems",
"currentItemCount"
],
"properties": {
"currentItemCount": {
"description": "The number of items present in the current response body view.",
"minimum": 0,
"type": "integer"
},
"items": {
"description": "Each hostname.",
"type": "array",
"items": {
"anyOf": [
{
"additionalProperties": false,
"description": "Active property hostnames within a current account. Relevant response objects appear within the outer envelope's `hostnames.items` array.",
"title": "STAGING",
"type": "object",
"properties": {
"cnameFrom": {
"description": "The hostname that your end users see, indicated by the `Host` header in end user requests.",
"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"
},
"propertyId": {
"description": "Unique identifier for the property. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting the value'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.",
"type": "string"
},
"propertyType": {
"description": "Specifies the type of the property. Either `TRADITIONAL` for properties where you pair property hostnames with the property version, or `HOSTNAME_BUCKET` where you manage property hostnames independently of the property version.",
"type": "string",
"enum": [
"HOSTNAME_BUCKET",
"TRADITIONAL"
]
},
"stagingCertType": {
"description": "Indicates the type of the certificate used in the property hostname. Either the `CPS_MANAGED` for the custom certificates you create with the [Certificate Provisioning System API](https://techdocs.akamai.com/cps/reference) (CPS), or `DEFAULT` for certificates deployed automatically. Note that you can't specify the `DEFAULT` value if your account hostname uses the `akamaized.net` domain suffix.",
"type": "string",
"enum": [
"CPS_MANAGED",
"DEFAULT"
]
},
"stagingCnameTo": {
"description": "The edge hostname you point the property hostname to so that you can start serving traffic through Akamai servers. This member corresponds to the edge hostname object's `edgeHostnameDomain` member.",
"type": "string"
},
"stagingCnameType": {
"description": "Indicates the type of CNAME you used in the staging network, either `EDGE_HOSTNAME` or `CUSTOM`.",
"type": "string",
"enum": [
"EDGE_HOSTNAME",
"CUSTOM"
]
},
"stagingEdgeHostnameId": {
"description": "Identifies the edge hostname you mapped your traffic to on the staging network. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on how to omit the ID's `ehn_` prefix.",
"type": "string"
}
}
},
{
"additionalProperties": false,
"description": "Active property hostnames within a current account. Relevant response objects appear within the outer envelope's `hostnames.items` array.",
"title": "PRODUCTION",
"type": "object",
"properties": {
"cnameFrom": {
"description": "The hostname that your end users see, indicated by the `Host` header in end user requests.",
"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"
},
"productionCertType": {
"description": "Indicates the type of the certificate used in the property hostname. Either the `CPS_MANAGED` for the custom certificates you create with the [Certificate Provisioning System API](https://techdocs.akamai.com/cps/reference) (CPS), or `DEFAULT` for certificates deployed automatically. Note that you can't specify the `DEFAULT` value if your account hostname uses the `akamaized.net` domain suffix.",
"type": "string",
"enum": [
"CPS_MANAGED",
"DEFAULT"
]
},
"productionCnameTo": {
"description": "The edge hostname you point the property hostname to so that you can start serving traffic through Akamai servers. This member corresponds to the edge hostname object's `edgeHostnameDomain` member.",
"type": "string"
},
"productionCnameType": {
"description": "Indicates the type of CNAME you used in the production network, either `EDGE_HOSTNAME` or `CUSTOM`.",
"type": "string",
"enum": [
"EDGE_HOSTNAME",
"CUSTOM"
]
},
"productionEdgeHostnameId": {
"description": "Identifies the edge hostname you mapped your traffic to on the production network. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on how to omit the ID's `ehn_` prefix.",
"type": "string"
},
"propertyId": {
"description": "Unique identifier for the property. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting the value'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.",
"type": "string"
},
"propertyType": {
"description": "Specifies the type of the property. Either `TRADITIONAL` for properties where you pair property hostnames with the property version, or `HOSTNAME_BUCKET` where you manage property hostnames independently of the property version.",
"type": "string",
"enum": [
"HOSTNAME_BUCKET",
"TRADITIONAL"
]
}
}
}
]
}
},
"nextLink": {
"description": "For paginated responses, this links to the next set of response items.",
"type": "string"
},
"previousLink": {
"description": "For paginated responses, this links to the next set of response items.",
"type": "string"
},
"totalItems": {
"description": "The total count of items returned for the requested criteria.",
"minimum": 0,
"type": "integer"
}
}
}
},
"x-akamai": {
"file-path": "schemas/account-hostnames-get-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"
}
},
"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 paginated responses, specifies the page of results you want to navigate to, starting from `0`.",
"example": "{{offset}}",
"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.",
"example": "{{limit}}",
"in": "query",
"name": "limit",
"required": false,
"schema": {
"example": 50,
"minimum": 1,
"type": "integer"
},
"x-akamai": {
"file-path": "parameters/limit-optional.yaml"
}
},
{
"description": "__Enum__ Sort the results based on the `cnameFrom` value, either `hostname:a` for ascending or `hostname:d` for descending order. The default is `hostname:a`.",
"example": "{{sort}}",
"in": "query",
"name": "sort",
"required": false,
"schema": {
"default": "hostname:a",
"example": "hostname:a",
"type": "string",
"enum": [
"hostname:a",
"hostname:d"
]
},
"x-akamai": {
"file-path": "parameters/sort-query.yaml"
}
},
{
"description": "Filter the results by `cnameFrom`. Supports wildcard matches with `*`.",
"example": "{{hostname}}",
"in": "query",
"name": "hostname",
"required": false,
"schema": {
"example": "www.example.com",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/hostname-query.yaml"
}
},
{
"description": "Filter the results by edge hostname. Supports wildcard matches with `*`.",
"example": "{{cnameTo}}",
"in": "query",
"name": "cnameTo",
"schema": {
"example": "example.com.edgekey.net",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/cnameTo-query.yaml"
}
},
{
"description": "__Enum__ Network of activated hostnames, either `STAGING` or `PRODUCTION`.",
"example": "{{network}}",
"in": "query",
"name": "network",
"required": false,
"schema": {
"example": "PRODUCTION",
"type": "string",
"enum": [
"PRODUCTION",
"STAGING"
]
},
"x-akamai": {
"file-path": "parameters/network-query.yaml"
}
},
{
"description": "Unique identifier for the contract. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting the value's `ctr_` prefix.",
"example": "{{contractId}}",
"in": "query",
"name": "contractId",
"required": false,
"schema": {
"example": "ctr_1-1TJZFW",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/contractId-optional-hostnames.yaml"
}
},
{
"description": "Unique identifier for the group. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting the value's `grp_` prefix.",
"example": "{{groupId}}",
"in": "query",
"name": "groupId",
"required": false,
"schema": {
"example": "grp_15166",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/groupId-optional-hostnames.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"
}
}
]
},
"x-akamai": {
"file-path": "paths/hostnames.yaml",
"path-for-file": "/hostnames"
},
"x-akamai-descriptor-tools": {
"displayName": "hostnames",
"group": "Hostnames"
}
},
"/hostnames/certificate-challenges": {
"post": {
"description": "If you're using Secure by Default, you can generate the domain validation challenges ahead of setting hostnames for your property. Ordinarily, you get the challenges when you [add hostnames to a property version](https://techdocs.akamai.com/property-mgr/reference/patch-property-version-hostnames) or [add hostnames to a property's hostname bucket](https://techdocs.akamai.com/property-mgr/reference/patch-property-hostnames). This operation returns the `validationCname` object that you use to validate the certificate's domain. For each requested property hostname, create a new CNAME record in the DNS configuration and map the object's `hostname` to the `target`.\n\n**Note**: If you're using a new account, first register it on the Akamai network by activating any property version on either staging or production. Otherwise, your attempts to generate certificates will fail with a [403](https://techdocs.akamai.com/property-mgr/reference/403) error.",
"operationId": "post-certificate-challenges",
"summary": "Akamai Generate Domain Validation Challenges",
"tags": [
"Property hostnames"
],
"externalDocs": {
"description": "See documentation for this operation in Akamai's Property Manager API",
"url": "https://techdocs.akamai.com/property-mgr/reference/post-certificate-challenges"
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"example": {
"cnamesFrom": [
"www.example1.com",
"www.example2.com"
]
},
"schema": {
"$schema": "http://json-schema.org/draft-04-schema#",
"description": "Creates domain validation challenges to validate the certificate's domain.",
"id": "resource:/descriptors/papi/v1/schemas/PostCertificateChallengesRequestV0.json#",
"javaType": "com.akamai.luna.papi.model.PostCertificateChallengesRequest",
"type": "object",
"required": [
"cnamesFrom"
],
"properties": {
"cnamesFrom": {
"description": "Lists the property hostnames to generate certificate domain validation challenges for. You can only specify property hostnames that you want to deploy using default certificates.",
"minItems": 1,
"type": "array",
"items": {
"type": "string"
}
}
},
"x-akamai": {
"file-path": "schemas/hostnames-certificate-challenges-request.yaml"
}
}
}
}
},
"responses": {
"200": {
"description": "The response shows default certificate's domain validation challenges for the requested property hostnames.",
"content": {
"application/json": {
"example": {
"accountId": "act_A-CCT9012",
"hostnames": {
"items": [
{
"cnameFrom": "www.example1.com",
"validationCname": {
"hostname": "_acme-challenge.www.example1.com",
"target": "ac.afae21b9a98d2d845d8032da0d689252.www.example1.com.validate-akdv.net"
}
},
{
"cnameFrom": "www.example2.com",
"validationCname": {
"hostname": "_acme-challenge.www.example2.com.com",
"target": "ac.afae21b9a98d2d845d8032da0d689252.www.example2.com.validate-akdv.net"
}
}
]
}
},
"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/PostCertificateChallengesResponseV0.json#",
"javaType": "com.akamai.luna.papi.model.PostCertificateChallengesResponse",
"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"
},
"hostnames": {
"additionalProperties": false,
"description": "The set of requested default certificate challenges, available within an `items` array.",
"type": "object",
"properties": {
"items": {
"description": "Specifies the certificate domain validation challenges for your property hostnames. Relevant response objects appear within the outer [Envelope](#envelope) object's `hostnames.items` array.",
"type": "array",
"items": {
"additionalProperties": false,
"type": "object",
"required": [
"cnameFrom",
"validationCname"
],
"properties": {
"cnameFrom": {
"description": "The hostname that your end users see, indicated by the `Host` header in end user requests.",
"type": "string"
},
"validationCname": {
"additionalProperties": false,
"description": "The CNAME record used to validate the certificate's domain.",
"type": "object",
"required": [
"hostname",
"target"
],
"properties": {
"hostname": {
"description": "The hostname part of the CNAME record used to validate the certificate's domain.",
"type": "string"
},
"target": {
"description": "The destination part of the CNAME record used to validate the certificate's domain.",
"type": "string"
}
}
}
}
}
}
}
}
},
"x-akamai": {
"file-path": "schemas/hostnames-certificate-challenges-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": "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"
}
}
]
},
"x-akamai": {
"file-path": "paths/hostname-certificate-challenges.yaml",
"path-for-file": "/hostnames/certificate-challenges"
},
"x-akamai-descriptor-tools": {
"displayName": "certificateChallenges",
"group": "Hostnames"
}
},
"/hostnames/{hostname}/audit-history": {
"get": {
"description": "Gets a detailed record of all modifications made to a property hostname.",
"operationId": "get-hostname-audit-history",
"summary": "Akamai Get Audit History",
"tags": [
"Property hostnames"
],
"externalDocs": {
"description": "See documentation for this operation in Akamai's Property Manager API",
"url": "https://techdocs.akamai.com/property-mgr/reference/get-hostname-audit-history"
},
"responses": {
"200": {
"description": "The response shows the audit history for the requested property hostname. The response includes information when the property hostname was first created and activated, might also show other changes if the item was later edited.",
"content": {
"application/json": {
"example": {
"hostname": "www.example.com",
"history": {
"items": [
{
"action": "ADD",
"certProvisioningType": "CPS_MANAGED",
"cnameTo": "example.com.edgesuite.net",
"contractId": "ctr_K-0N7RAK7",
"edgeHostnameId": "ehn_895824",
"groupId": "grp_15225",
"network": "PRODUCTION",
"propertyId": "prp_175780",
"timestamp": "2020-05-14T17:08:55Z",
"user": "ecole"
},
{
"action": "MOVE",
"certProvisioningType": "CPS_MANAGED",
"cnameTo": "example.com.edgesuite.net",
"contractId": "ctr_K-0N7RAK7",
"edgeHostnameId": "ehn_895824",
"groupId": "grp_15225",
"network": "PRODUCTION",
"propertyId": "prp_175780",
"timestamp": "2020-05-14T17:08:55Z",
"user": "ecole"
},
{
"action": "ACTIVATE",
"certProvisioningType": "CPS_MANAGED",
"cnameTo": "example.com.edgesuite.net",
"contractId": "ctr_C-0N7RAC71",
"edgeHostnameId": "ehn_895824",
"groupId": "grp_15225",
"network": "STAGING",
"propertyId": "prp_175780",
"timestamp": "2020-05-14T17:08:55Z",
"user": "jdoe"
},
{
"action": "REMOVE",
"certProvisioningType": "CPS_MANAGED",
"cnameTo": "example.com.edgesuite.net",
"contractId": "ctr_K-0N7RAK71",
"edgeHostnameId": "ehn_895824",
"groupId": "grp_15225",
"network": "STAGING",
"propertyId": "prp_175780",
"timestamp": "2020-05-14T17:08:55Z",
"user": "jdoe"
},
{
"action": "DEACTIVATE",
"certProvisioningType": "CPS_MANAGED",
"cnameTo": "example.com.edgesuite.net",
"contractId": "ctr_C-0N7RAC7",
"edgeHostnameId": "ehn_895824",
"groupId": "grp_15225",
"network": "STAGING",
"propertyId": "prp_175780",
"timestamp": "2020-05-14T20:00:00Z",
"user": "jdoe"
}
]
}
},
"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/GetHostnameAuditHistoryResponse.json#",
"type": "object",
"properties": {
"history": {
"additionalProperties": false,
"description": "The set of requested property hostname data, available within an `items` array.",
"type": "object",
"properties": {
"items": {
"description": "Each entry specifies a change to the requested property hostname with details about the user who made that modification and the time it happened. Relevant response objects appear in a descending chronological order within the outer envelope's `history.items` array.",
"type": "array",
"items": {
"additionalProperties": false,
"type": "object",
"required": [
"action",
"edgeHostnameId",
"certProvisioningType",
"propertyId",
"groupId",
"contractId",
"user",
"timestamp"
],
"properties": {
"action": {
"description": "The type of action performed to the property hostname, either:\n\n- `ACTIVATE` if the hostname is currently serving traffic,\n- `DEACTIVATE` if the hostname isn't serving traffic,\n- `ADD` if the user requested to add the hostname to a property,\n- `REMOVE` if the user requested to remove the hostname from a property,\n- `MOVE` if the hostname was moved from one property to another,\n- `MODIFY` if the user changed the `edgeHostnameId` or `certProvisioningType` values for an already-activated hostname,\n- `ABORTED` when the user request to cancel the hostname activation,\n- `ERROR` if the hostname activation failed.",
"type": "string",
"enum": [
"ADD",
"ACTIVATE",
"REMOVE",
"DEACTIVATE",
"MOVE",
"MODIFY",
"ABORTED",
"ERROR"
]
},
"certProvisioningType": {
"description": "Indicates the type of the certificate used in the property hostname. Either the `CPS_MANAGED` for the custom certificates you create with the [Certificate Provisioning System API](https://techdocs.akamai.com/cps/reference) (CPS), or `DEFAULT` for certificates deployed automatically. Note that you can't specify the `DEFAULT` value if your account hostname uses the `akamaized.net` domain suffix.",
"type": "string",
"enum": [
"CPS_MANAGED",
"DEFAULT"
]
},
"cnameTo": {
"description": "The edge hostname you point the property hostname to so that you can start serving traffic through Akamai servers. This member corresponds to the edge hostname object's `edgeHostnameDomain` member.",
"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"
},
"edgeHostnameId": {
"description": "Identifies the edge hostname you mapped your traffic to. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on how to omit the ID's `ehn_` prefix.",
"type": "string"
},
"groupId": {
"description": "Identifies the group under which the property activated. 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"
},
"network": {
"description": "The network of activated hostnames, either `STAGING` or `PRODUCTION`.",
"type": "string",
"enum": [
"STAGING",
"PRODUCTION"
]
},
"propertyId": {
"description": "Unique identifier for the property. 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"
},
"timestamp": {
"description": "Indicates when the action occurred.",
"type": "string"
},
"user": {
"description": "The user who initiated the action.",
"type": "string"
}
}
}
}
}
},
"hostname": {
"description": "The `cnameFrom` for the hostname your end users see, indicated by the `Host` header in end user requests.",
"type": "string"
}
},
"x-akamai": {
"file-path": "schemas/hostnames-audit-history-get-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"
}
},
"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"
}
}
]
},
"x-akamai": {
"file-path": "paths/hostname-audit-history.yaml",
"path-for-file": "/hostnames/{hostname}/audit-history"
},
"x-akamai-descriptor-tools": {
"displayName": "hostnameAuditHistory",
"group": "Hostnames"
},
"parameters": [
{
"description": "The `cnameFrom` for the hostname your end users see, indicated by the `Host` header in end user requests.",
"example": "{{hostname}}",
"in": "path",
"name": "hostname",
"required": true,
"schema": {
"example": "www.example.com",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/hostname-path.yaml"
}
}
]
},
"/includes": {
"post": {
"description": "__Limited availability__ This operation either creates a new include from scratch or bases one on another include's rule tree. Version 1 of a new include is created automatically.",
"operationId": "post-includes",
"summary": "Akamai Create or Clone an Include",
"tags": [
"Includes"
],
"externalDocs": {
"description": "See documentation for this operation in Akamai's Property Manager API",
"url": "https://techdocs.akamai.com/property-mgr/reference/post-includes"
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"example": {
"includeName": "my.new.include1.com",
"includeType": "COMMON_SETTINGS",
"productId": "prd_Alta",
"ruleFormat": "v2022-10-18"
},
"schema": {
"$schema": "http://json-schema.org/draft-04-schema#",
"description": "Contains configuration data to apply to edge content. Relevant response objects appear within the outer envelope's `includes.items` array.",
"id": "resource:/descriptors/papi/v1/schemas/CreateOrCloneIncludeRequestV0.json#",
"javaType": "com.akamai.luna.papi.model.IncludeCreateRequest",
"type": "object",
"required": [
"productId",
"includeName",
"includeType"
],
"properties": {
"cloneFrom": {
"description": "Optionally identifies another include instance to clone when making a POST request to create a new include. You need to assign the same contract and group to the cloned include.",
"example": "{{cloneFrom}}",
"required": [
"includeId",
"version"
],
"type": [
"object",
"null"
],
"properties": {
"cloneFromVersionEtag": {
"description": "Performs an ETag data integrity check on the original include. See [Concurrency control](https://techdocs.akamai.com/property-mgr/reference/concurrency-control) for guidance.",
"type": [
"string",
"null"
]
},
"includeId": {
"description": "Specifies the include to clone. 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"
},
"version": {
"description": "Specifies the version of the include to clone.",
"minimum": 1,
"type": "integer"
}
}
},
"includeName": {
"description": "A descriptive name for the include.",
"example": "{{includeName}}",
"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 `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.",
"example": "{{includeType}}",
"type": "string",
"enum": [
"COMMON_SETTINGS",
"MICROSERVICES"
]
},
"productId": {
"description": "Unique identifier for the product. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting the value's `prd_` prefix.",
"example": "{{productId}}",
"type": "string"
},
"ruleFormat": {
"description": "On GET, reflects the include's current format. Otherwise on POST, assigns a specific rule format to the include. Ignored on PUT, since you need to modify the `Content-Type` to change rule formats. For details, see [Update rules to a newer set of features](https://techdocs.akamai.com/property-mgr/reference/manage-rules).",
"example": "{{ruleFormat}}",
"type": [
"string",
"null"
]
}
},
"x-akamai": {
"file-path": "schemas/include-create-request.yaml"
}
}
}
}
},
"responses": {
"201": {
"description": "The response provides a URL link to the newly created or cloned include.",
"content": {
"application/json": {
"example": {
"includeLink": "/papi/v0/includes/inc_243237?contractId=ctr_C-0N7RAC7&groupId=grp_15225"
},
"schema": {
"$schema": "http://json-schema.org/draft-04-schema#",
"additionalProperties": false,
"description": "Provides a hypermedia link to a newly created resource. The response's single member name indicates the type of resource.",
"id": "resource:/descriptors/papi/v1/schemas/PostIncludeResponse.json#",
"type": "object",
"required": [
"includeLink"
],
"properties": {
"includeLink": {
"description": "Links the newly created include.",
"type": "string"
}
},
"x-akamai": {
"file-path": "schemas/include-create-response.yaml"
}
}
}
},
"headers": {
"Location": {
"description": "Provides a URL path you can GET the newly created resource from.",
"schema": {
"type": "string"
},
"x-akamai": {
"file-path": "headers/Location.yaml"
}
},
"X-Limit-Includes-Per-Contract-Limit": {
"description": "Maximum number of includes per contract.",
"schema": {
"type": "string"
},
"x-akamai": {
"file-path": "headers/X-Limit-Includes-Per-Contract-Limit.yaml"
}
},
"X-Limit-Includes-Per-Contract-Remaining": {
"description": "Remaining number of includes per contract. See [Rate and resource limiting](https://techdocs.akamai.com/property-mgr/reference/rate-and-resource-limiting) for details.",
"schema": {
"type": "string"
},
"x-akamai": {
"file-path": "headers/X-Limit-Includes-Per-Contract-Remaining.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"
}
}
},
"x-akamai": {
"status": "LA"
},
"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": "Unique identifier for the contract. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting the value's `ctr_` prefix.",
"example": "{{contractId}}",
"in": "query",
"name": "contractId",
"required": true,
"schema": {
"example": "ctr_1-1TJZFW",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/contractId-required.yaml"
}
},
{
"description": "Unique identifier for the group. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting the value's `grp_` prefix.",
"example": "{{groupId}}",
"in": "query",
"name": "groupId",
"required": true,
"schema": {
"example": "grp_15166",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/groupId-required.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"
}
}
]
},
"get": {
"description": "__Limited availability__ This operation lists includes available for the current contract and group. Use optional query parameters to only show includes that were modified within a specified time range or on a selected network. If you specify the `modifiedSince` parameter, `contractId` and `groupId` become optional. If you don't identify a contract and group, the operation lists all includes you have access to, modified within a specified time range.",
"operationId": "get-includes",
"summary": "Akamai List Includes",
"tags": [
"Includes"
],
"externalDocs": {
"description": "See documentation for this operation in Akamai's Property Manager API",
"url": "https://techdocs.akamai.com/property-mgr/reference/get-includes"
},
"responses": {
"200": {
"description": "The response lists all includes available for the requested contract and group.",
"content": {
"application/json": {
"example": {
"includes": {
"items": [
{
"accountId": "act_A-CCT9012",
"assetId": "aid_101",
"contractId": "ctr_C-0N7RAC71",
"groupId": "grp_15225",
"includeId": "inc_012345678",
"includeName": "my.new.include.com",
"includeType": "COMMON_SETTINGS",
"latestVersion": 1,
"productionVersion": null,
"stagingVersion": null
},
{
"accountId": "act_A-CCT1234",
"assetId": "aid_102",
"contractId": "ctr_C-0N7RAC7",
"groupId": "grp_15225",
"includeId": "inc_087654321",
"includeName": "my.new.include2.com",
"includeType": "MICROSERVICES",
"latestVersion": 1,
"productionVersion": null,
"stagingVersion": null
}
]
}
},
"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/GetIncludeResponse.json#",
"type": "object",
"properties": {
"includes": {
"additionalProperties": false,
"description": "The set of requested includes, available within an `items` array.",
"type": "object",
"properties": {
"items": {
"description": "Configuration data to apply to edge content. Relevant response objects appear within the outer envelope's `include.items` array.",
"type": "array",
"items": {
"additionalProperties": false,
"type": "object",
"required": [
"accountId",
"assetId",
"contractId",
"groupId",
"latestVersion",
"productionVersion",
"stagingVersion"
],
"properties": {
"accountId": {
"description": "Identifies the account the include belongs to. 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 contract the include belongs to. 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 group to which the include is assigned. 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 descriptive name for the include.",
"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 `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": [
"COMMON_SETTINGS",
"MICROSERVICES"
]
},
"latestVersion": {
"description": "Specifies the most recent version of the include.",
"minimum": 1,
"type": "integer"
},
"note": {
"description": "Further descriptive commentary.",
"type": "string"
},
"productionVersion": {
"description": "The most recent version to be activated to the production network, otherwise `null`.",
"minimum": 1,
"nullable": true,
"type": [
"integer",
"null"
]
},
"propertyType": {
"description": "Indicates the type of configuration container, mostly used for the [Bulk Search and Update](https://techdocs.akamai.com/property-mgr/reference/bulk-search-and-update) operation.",
"type": "string",
"enum": [
"INCLUDE"
]
},
"stagingVersion": {
"description": "The most recent version to be activated to the test network, otherwise `null`.",
"minimum": 1,
"nullable": true,
"type": [
"integer",
"null"
]
}
}
}
}
}
}
},
"x-akamai": {
"file-path": "schemas/include-get-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"
}
},
"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"
}
}
},
"x-akamai": {
"status": "LA"
},
"parameters": [
{
"description": "Filters properties or includes that have been modified in a specified time. Accepts duration in the ISO 8601 format.",
"example": "{{modifiedSince}}",
"in": "query",
"name": "modifiedSince",
"required": false,
"schema": {
"example": "P1DT23H6M40S",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/modifiedSince-query.yaml"
}
},
{
"description": "__Enum__ Filters and only shows properties or includes that have been modified within a specified period on a selected network, either `STAGING`, `PRODUCTION`, or `BOTH`. You need to specify it along with the `modifiedSince` query parameter.",
"example": "{{modifiedNetwork}}",
"in": "query",
"name": "modifiedNetwork",
"required": false,
"schema": {
"example": "PRODUCTION",
"type": "string",
"enum": [
"PRODUCTION",
"STAGING",
"BOTH"
]
},
"x-akamai": {
"file-path": "parameters/modifiedNetwork-query.yaml"
}
},
{
"description": "Unique identifier for the contract. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting the value's `ctr_` prefix.",
"example": "{{contractId}}",
"in": "query",
"name": "contractId",
"required": true,
"schema": {
"example": "ctr_1-1TJZFW",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/contractId-required.yaml"
}
},
{
"description": "Unique identifier for the group. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting the value's `grp_` prefix.",
"example": "{{groupId}}",
"in": "query",
"name": "groupId",
"required": true,
"schema": {
"example": "grp_15166",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/groupId-required.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.",
"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"
}
}
]
},
"x-akamai": {
"file-path": "paths/includes.yaml",
"path-for-file": "/includes"
},
"x-akamai-descriptor-tools": {
"displayName": "includes",
"group": "Includes"
}
},
"/includes/validation-results/{activationId}/properties/{propertyId}/versions/{propertyVersion}": {
"get": {
"description": "__Limited availability__ Gets the results of an include validation against the specified parent property version that references the include.",
"operationId": "get-include-validation",
"summary": "Akamai Validate an Include",
"tags": [
"Includes"
],
"externalDocs": {
"description": "See documentation for this operation in Akamai's Property Manager API",
"url": "https://techdocs.akamai.com/property-mgr/reference/get-include-validation"
},
"responses": {
"200": {
"description": "If the validation detected any issues between the specified include and its parent properties, the response shows details of errors and warnings.",
"content": {
"application/json": {
"example": {
"result": "ERROR",
"validationTag": "506ae69b",
"stats": {
"elementsPerInclude": 16,
"numBehaviors": 13,
"numConditions": 3,
"numTopLevelChildren": 3
},
"messages": [
{
"autoIgnored": false,
"id": "51febc9c4c07cdf89eb4d73f17fef1470071ba1a",
"messageId": "disallowed_for_include",
"severity": "ERROR",
"source": "VALIDATION_ENGINE",
"userHidden": false,
"userSignedOff": false,
"messageParams": [
{
"messageType": "disallowed_for_include",
"nodeLocation": "/rules/features/4",
"nodeType": "feature",
"severity": "error",
"node": {
"name": "tieredDistribution",
"uuid": "3a1723a9-d9b3-44bb-a34d-84069957926f"
},
"parentRule": {
"uuid": "default"
}
}
]
}
]
},
"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` narray.",
"id": "resource:/descriptors/papi/v1/schemas/GetIncludeValidationResultsResponse.json#",
"type": "object",
"required": [
"result"
],
"properties": {
"messages": {
"description": "Lists errors and warnings that are a result of an include validation against the parent properties' rule trees.",
"type": "array",
"items": {
"additionalProperties": false,
"description": "Each object specifies details of a validation error or warning. While warnings note less severe, non-blocking issues, errors indicate blocking problems that would prevent activation. You need to fix these to complete an include activation.",
"type": "object",
"required": [
"autoIgnored",
"id",
"messageId",
"messageParams",
"severity",
"source",
"userHidden",
"userSignedOff"
],
"properties": {
"autoIgnored": {
"description": "Whether you can ignore the validation issue, either `true` for warnings or `false` for errors that prevent activation.",
"type": "boolean"
},
"id": {
"description": "A unique identifier for the validation issue.",
"type": "string"
},
"messageId": {
"description": "Indicates the cause of a validation issue.",
"type": "string"
},
"messageParams": {
"description": "Specifies the type of an issue and its location in the parent property's rule tree.",
"type": "array",
"items": {
"additionalProperties": false,
"type": "object",
"required": [
"nodeLocation",
"severity",
"messageType",
"node",
"nodeType",
"parentRule"
],
"properties": {
"messageType": {
"description": "Indicates the cause of a validation issue.",
"type": "string"
},
"node": {
"additionalProperties": false,
"description": "Specifies the location of the issue in the parent property's rule tree.",
"type": "object",
"required": [
"name",
"uuid"
],
"properties": {
"name": {
"description": "The name of the behavior or criteria that triggered the validation issue.",
"type": "string"
},
"uuid": {
"description": "Identifies the behavior or the criteria that triggered the validation issue.",
"type": "string"
}
}
},
"nodeLocation": {
"description": "Specifies the path to the behavior or criteria that triggered the validation issue.",
"type": "string"
},
"nodeType": {
"description": "Indicates the configuration element that triggered the issue, either `feature` for a behavior, `condition` for criteria, or `rule`.",
"type": "string",
"enum": [
"feature",
"condition",
"rule"
]
},
"parentRule": {
"additionalProperties": false,
"description": "Specifies details of the parent rule where the validation issue is located.",
"type": "object",
"required": [
"uuid"
],
"properties": {
"uuid": {
"description": "Unique identifier for the parent rule where the validation issue is located.",
"type": "string"
}
}
},
"severity": {
"description": "The severity of an issue, either a blocking error or non-blocking warning.",
"type": "string"
}
}
}
},
"severity": {
"description": "The severity of an issue, either `INFO`, `WARNING`, `ERROR`, `FATAL`, `OK`, or `UNKNOWN`.",
"type": "string",
"enum": [
"FATAL",
"ERROR",
"WARNING",
"INFO",
"OK",
"UNKNOWN"
]
},
"source": {
"description": "The system that exposed the issue, either `MUI`, `VALIDATION_ENGINE`, `TOOLKIT`, `LOCK_CONSTRAINTS`, `HOSTNAME_CHECK`, `ORIGIN_ACL`, or `API`. Might be helpful for investigation by Akamai professional services.",
"type": "string",
"enum": [
"MUI",
"VALIDATION_ENGINE",
"TOOLKIT",
"LOCK_CONSTRAINTS",
"HOSTNAME_CHECK",
"ORIGIN_ACL",
"API"
]
},
"userHidden": {
"description": "Whether you chose to hide the validation messages in Control Center.",
"type": "boolean"
},
"userSignedOff": {
"description": "Whether you set to acknowledge all warnings in the validation.",
"type": "boolean"
}
}
}
},
"result": {
"description": "Specifies the validation results.",
"type": "string"
},
"stats": {
"additionalProperties": false,
"description": "Provides statistics on the rule tree.",
"type": "object",
"required": [
"numTopLevelChildren",
"numBehaviors",
"numConditions",
"elementsPerInclude"
],
"properties": {
"elementsPerInclude": {
"description": "The total number of `numBehaviors` and `numConditions` used in an include.",
"type": "integer"
},
"numBehaviors": {
"description": "The number of behaviors used in the rule tree.",
"type": "integer"
},
"numConditions": {
"description": "The number of criteria used in the rule tree.",
"type": "integer"
},
"numTopLevelChildren": {
"description": "The number of rules in the rule tree's top children array. Ignores the children nested on deeper levels.",
"type": "integer"
}
}
},
"validationTag": {
"description": "Identifies the validation instance. If the rule tree changes, the tag ID also changes.",
"type": "string"
}
},
"x-akamai": {
"file-path": "schemas/include-validation-results-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"
}
},
"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"
}
}
},
"x-akamai": {
"status": "LA"
},
"parameters": [
{
"description": "For paginated responses, specifies the page of results you want to navigate to, starting from `0`.",
"example": "{{offset}}",
"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.",
"example": "{{limit}}",
"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.",
"example": "{{contractId}}",
"in": "query",
"name": "contractId",
"required": false,
"schema": {
"example": "ctr_1-1TJZFW",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/contractId-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.",
"example": "{{groupId}}",
"in": "query",
"name": "groupId",
"required": false,
"schema": {
"example": "grp_15166",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/groupId-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.",
"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"
}
}
]
},
"x-akamai": {
"file-path": "paths/includes-validation.yaml",
"path-for-file": "/includes/validation-results/{activationId}/properties/{propertyId}/versions/{propertyVersion}"
},
"x-akamai-descriptor-tools": {
"displayName": "validationResults",
"group": "Includes"
},
"parameters": [
{
"description": "Unique identifier for the property or include activation.",
"example": "{{activationId}}",
"in": "path",
"name": "activationId",
"required": true,
"schema": {
"example": "atv_1696855",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/activationId-path.yaml"
}
},
{
"description": "Property's incremental version number.",
"example": "{{propertyVersion}}",
"in": "path",
"name": "propertyVersion",
"required": true,
"schema": {
"example": 3,
"type": "integer"
},
"x-akamai": {
"file-path": "parameters/propertyVersion-path.yaml"
}
},
{
"description": "Unique identifier for the property. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting the value's `prp_` prefix.",
"example": "{{propertyId}}",
"in": "path",
"name": "propertyId",
"required": true,
"schema": {
"example": "prp_12345",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/propertyId-path.yaml"
}
}
]
},
"/includes/{includeId}": {
"get": {
"description": "__Limited availability__ This operation gets a specific include. You can call this operation by specifying any of the `includeId` members from a [list of includes](https://techdocs.akamai.com/property-mgr/reference/get-includes), or by running a GET on the `includeLink` response when [creating a new include](https://techdocs.akamai.com/property-mgr/reference/post-includes).",
"operationId": "get-include",
"summary": "Akamai Get an Include",
"tags": [
"Includes"
],
"externalDocs": {
"description": "See documentation for this operation in Akamai's Property Manager API",
"url": "https://techdocs.akamai.com/property-mgr/reference/get-include"
},
"responses": {
"200": {
"description": "The response shows details for the requested include.",
"content": {
"application/json": {
"example": {
"includes": {
"items": [
{
"accountId": "act_A-CCT3456",
"assetId": "aid_101",
"contractId": "ctr_C-0N7RAC7",
"groupId": "grp_12345",
"includeId": "inc_243237",
"includeName": "my.new.include.com",
"includeType": "COMMON_SETTINGS",
"latestVersion": 2,
"productionVersion": null,
"propertyType": "INCLUDE",
"stagingVersion": 1
}
]
}
},
"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/GetIncludeResponse.json#",
"type": "object",
"properties": {
"includes": {
"additionalProperties": false,
"description": "The set of requested includes, available within an `items` array.",
"type": "object",
"properties": {
"items": {
"description": "Configuration data to apply to edge content. Relevant response objects appear within the outer envelope's `include.items` array.",
"type": "array",
"items": {
"additionalProperties": false,
"type": "object",
"required": [
"accountId",
"assetId",
"contractId",
"groupId",
"latestVersion",
"productionVersion",
"stagingVersion"
],
"properties": {
"accountId": {
"description": "Identifies the account the include belongs to. 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 contract the include belongs to. 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 group to which the include is assigned. 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 descriptive name for the include.",
"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 `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": [
"COMMON_SETTINGS",
"MICROSERVICES"
]
},
"latestVersion": {
"description": "Specifies the most recent version of the include.",
"minimum": 1,
"type": "integer"
},
"note": {
"description": "Further descriptive commentary.",
"type": "string"
},
"productionVersion": {
"description": "The most recent version to be activated to the production network, otherwise `null`.",
"minimum": 1,
"nullable": true,
"type": [
"integer",
"null"
]
},
"propertyType": {
"description": "Indicates the type of configuration container, mostly used for the [Bulk Search and Update](https://techdocs.akamai.com/property-mgr/reference/bulk-search-and-update) operation.",
"type": "string",
"enum": [
"INCLUDE"
]
},
"stagingVersion": {
"description": "The most recent version to be activated to the test network, otherwise `null`.",
"minimum": 1,
"nullable": true,
"type": [
"integer",
"null"
]
}
}
}
}
}
}
},
"x-akamai": {
"file-path": "schemas/include-get-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"
}
},
"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"
}
}
},
"x-akamai": {
"status": "LA"
},
"parameters": [
{
"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.",
"example": "{{contractId}}",
"in": "query",
"name": "contractId",
"required": false,
"schema": {
"example": "ctr_1-1TJZFW",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/contractId-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.",
"example": "{{groupId}}",
"in": "query",
"name": "groupId",
"required": false,
"schema": {
"example": "grp_15166",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/groupId-optional.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"
}
}
]
},
"delete": {
"description": "__Limited availability__ Removes a specific include, which you can only do if none of its versions are currently active. A successful DELETE results in a 200 response and a confirmation message. Attempting to delete an active include results in a 500 error. Attempting to delete an unknown include results in a 404 error.",
"operationId": "delete-include",
"summary": "Akamai Remove an Include",
"tags": [
"Includes"
],
"externalDocs": {
"description": "See documentation for this operation in Akamai's Property Manager API",
"url": "https://techdocs.akamai.com/property-mgr/reference/delete-include"
},
"responses": {
"200": {
"description": "Shows a message confirming the include deletion.",
"content": {
"application/json": {
"example": {
"message": "Deletion Successful."
},
"schema": {
"$schema": "http://json-schema.org/draft-04-schema#",
"additionalProperties": false,
"description": "Specifies the result of the property deletion.",
"id": "resource:/descriptors/papi/v1/schemas/DeletePropertyResponse.json#",
"type": "object",
"required": [
"message"
],
"properties": {
"message": {
"description": "Confirms whether the property was successfully deleted.",
"type": "string"
}
},
"x-akamai": {
"file-path": "schemas/property-delete-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"
}
},
"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"
}
}
},
"x-akamai": {
"status": "LA"
},
"parameters": [
{
"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.",
"example": "{{contractId}}",
"in": "query",
"name": "contractId",
"required": false,
"schema": {
"example": "ctr_1-1TJZFW",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/contractId-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.",
"example": "{{groupId}}",
"in": "query",
"name": "groupId",
"required": false,
"schema": {
"example": "grp_15166",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/groupId-optional.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"
}
}
]
},
"x-akamai": {
"file-path": "paths/include.yaml",
"path-for-file": "/includes/{includeId}"
},
"x-akamai-descriptor-tools": {
"displayName": "include",
"group": "Includes"
},
"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.",
"example": "{{includeId}}",
"in": "path",
"name": "includeId",
"required": true,
"schema": {
"example": "inc_175780",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/includeId-path.yaml"
}
}
]
},
"/includes/{includeId}/activations": {
"post": {
"description": "__Limited availability__ This operation creates a new include activation, which deactivates any current activation. After a necessary delay, this activates your version's rule tree modifying how your edge content responds to end-user requests. To reduce software vulnerability, avoid calling PAPI with separate clients on the same data and frequent polling of status values, progressively increasing the delay.",
"operationId": "post-include-activation",
"summary": "Akamai Activate or Deactivate an Include",
"tags": [
"Include activations"
],
"externalDocs": {
"description": "See documentation for this operation in Akamai's Property Manager API",
"url": "https://techdocs.akamai.com/property-mgr/reference/post-include-activation"
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"example": {
"acknowledgeAllWarnings": false,
"activationType": "ACTIVATE",
"ignoreHttpErrors": true,
"includeVersion": 1,
"network": "STAGING",
"note": "Sample activation",
"acknowledgeWarnings": [
"msg_baa4560881774a45b5fd25f5b1eab021d7c40b4f"
],
"notifyEmails": [
"you@example.com",
"them@example.com"
]
},
"schema": {
"$schema": "http://json-schema.org/draft-04-schema#",
"description": "Activates include versions on a specific network. Relevant response objects appear within the outer envelope's `activations.items` array.",
"id": "resource:/descriptors/papi/v1/schemas/CreateNewIncludeActivationOrDeactivationRequestV0.json#",
"javaType": "com.akamai.luna.papi.model.IncludeActivationRequest",
"type": "object",
"required": [
"includeVersion",
"network",
"notifyEmails"
],
"properties": {
"acknowledgeAllWarnings": {
"default": false,
"description": "When POSTing an activation, you can skip acknowledging each warning. With this enabled, you can omit the `acknowledgeWarnings` array.",
"example": "{{acknowledgeAllWarnings}}",
"type": "boolean"
},
"acknowledgeWarnings": {
"description": "String IDs prefixed with `msg_` to acknowledge any warnings noted in responses to previous activation requests.",
"type": "array",
"items": {
"type": "string"
}
},
"activationType": {
"default": "ACTIVATE",
"description": "Either `ACTIVATE` or `DEACTIVATE`. The default is `ACTIVATE`. Any new activation automatically deactivates the current activation. Note that if you were to POST a `DEACTIVATE` type on an active include, it would no longer serve any traffic. You'd need to modify your DNS configuration and specify a different way to field the traffic.",
"example": "{{activationType}}",
"type": "string",
"enum": [
"ACTIVATE",
"DEACTIVATE"
]
},
"delayValidations": {
"description": "This makes the operation respond with an `activationLink` more quickly. Some time-consuming validations ordinarily result in a direct error response. Enabling this delays them so that any errors appear later once you [Get an include activation](https://techdocs.akamai.com/property-mgr/reference/get-include-activation). In that case, the activation's `status` is `FAILED`.",
"example": "{{delayValidations}}",
"nullalble": true,
"type": "boolean"
},
"ignoreHttpErrors": {
"default": true,
"description": "Ignore any HTTP errors when pushing fast metadata activation, `true` by default.",
"example": "{{ignoreHttpErrors}}",
"type": "boolean"
},
"includeVersion": {
"description": "The version of the include to activate.",
"example": "{{includeVersion}}",
"minimum": 1,
"type": "integer"
},
"network": {
"description": "The network to activate on, either `STAGING` or `PRODUCTION`.",
"example": "{{network}}",
"type": "string",
"enum": [
"STAGING",
"PRODUCTION"
]
},
"note": {
"description": "A descriptive log comment.",
"example": "{{note}}",
"type": "string"
},
"notifyEmails": {
"description": "Email addresses to notify when the activation status changes.",
"minItems": 1,
"type": "array",
"items": {
"type": "string"
}
}
},
"x-akamai": {
"file-path": "schemas/include-activation-create-request.yaml"
}
}
}
}
},
"responses": {
"201": {
"description": "The response provides a URL link to the newly created activation.",
"content": {
"application/json": {
"example": {
"activationLink": "/papi/v0/includes/inc_173136/activations/93797ec9-4381-4553-b400-a4de28ab54ab?contractId=ctr_C-0N7RAC7&groupId=grp_15225"
},
"schema": {
"$schema": "http://json-schema.org/draft-04-schema#",
"additionalProperties": false,
"description": "Provides a hypermedia link to a newly created resource. The response's single member name indicates the type of resource.",
"id": "resource:/descriptors/papi/v1/schemas/PostIncludeActivationResponse.json#",
"type": "object",
"required": [
"activationLink"
],
"properties": {
"activationLink": {
"description": "Links the newly created include.",
"type": "string"
}
},
"x-akamai": {
"file-path": "schemas/include-activation-post-response.yaml"
}
}
}
},
"headers": {
"Location": {
"description": "Provides a URL path you can GET the newly created resource from.",
"schema": {
"type": "string"
},
"x-akamai": {
"file-path": "headers/Location.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"
}
},
"409": {
"description": "[Conflict](https://techdocs.akamai.com/property-mgr/reference/409).",
"content": {
"application/problem+json": {
"example": {
"detail": "Another edit or activation request on same network in progress for this property version.",
"instance": "papi/v1/properties/prp_123456/activations?contractId=ctr_C-0N7RAC7&groupId=grp_12345#abc12345abcc02a7",
"status": 409,
"title": "Operation failed",
"type": "https://problems.luna.akamaiapis.net/papi/v1/resource-busy"
},
"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/409.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"
}
},
"422": {
"description": "[Unprocessable content](https://techdocs.akamai.com/property-mgr/reference/422).",
"content": {
"application/problem+json": {
"example": {
"instance": "papi/v1/activations/#abc12345abcc02a7",
"messageId": "property_activation_still_pending",
"result": "ERROR",
"status": 422,
"title": "Property Manager Exception",
"type": "https://problems.luna.akamaiapis.net/papi/v1/property_activation_still_pending",
"params": [
"Property 123456",
"Version 1"
],
"details": {},
"errors": [
{
"detail": "property_activation_still_pending",
"title": "Property Manager Exception",
"type": "papi/v1/property_activation_still_pending"
}
]
},
"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",
"instance",
"status",
"errors",
"details",
"messageId",
"params",
"result"
],
"properties": {
"details": {
"description": "Diagnostic instructions to locate and fix the problem.",
"type": "object"
},
"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"
},
"messageId": {
"description": "Summarizes the cause of the problem.",
"minLength": 1,
"type": "string"
},
"params": {
"description": "Details of the property and version where the problem occured.",
"minItems": 0,
"type": "array",
"items": {
"type": "string"
}
},
"result": {
"description": "Indicates the severity of the problem.",
"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-422.yaml"
}
}
}
},
"x-akamai": {
"file-path": "errors/422.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"
}
}
},
"x-akamai": {
"status": "LA"
},
"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": "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.",
"example": "{{contractId}}",
"in": "query",
"name": "contractId",
"required": false,
"schema": {
"example": "ctr_1-1TJZFW",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/contractId-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.",
"example": "{{groupId}}",
"in": "query",
"name": "groupId",
"required": false,
"schema": {
"example": "grp_15166",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/groupId-optional.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"
}
}
]
},
"get": {
"description": "__Limited availability__ This lists all activations for all versions of an include, on both production and staging networks.",
"operationId": "get-include-activations",
"summary": "Akamai List Include's Activations",
"tags": [
"Include activations"
],
"externalDocs": {
"description": "See documentation for this operation in Akamai's Property Manager API",
"url": "https://techdocs.akamai.com/property-mgr/reference/get-include-activations"
},
"responses": {
"200": {
"description": "The response lists all activations for the requested include.",
"content": {
"application/json": {
"example": {
"accountId": "act_A-CCT1234",
"contractId": "ctr_K-0N7RAK71",
"groupId": "grp_15225",
"activations": {
"items": [
{
"activationType": "ACTIVATE",
"fmaActivationState": "received",
"includeActivationId": "5e597860-1107-461e-8dbe-4e7526e8dd02",
"includeId": "inc_173036",
"includeName": "example.inc.com",
"includeVersion": 1,
"network": "STAGING",
"note": "Sample activation",
"status": "PENDING",
"submitDate": "2022-03-02T02:22:12Z",
"updateDate": "2022-03-01T21:12:57Z",
"notifyEmails": [
"you@example.com",
"them@example.com"
]
}
]
}
},
"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/GetIncludeActivationListResponse.json#",
"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.",
"minLength": 1,
"type": "string"
},
"activations": {
"additionalProperties": false,
"description": "The set of requested activations, available within an `items` array.",
"type": "object",
"properties": {
"items": {
"description": "Activated include versions on a specific network. Relevant response objects appear within the outer envelope's `activations.items` array.",
"type": "array",
"items": {
"additionalProperties": false,
"type": "object",
"required": [
"includeActivationId",
"activationType",
"network",
"note",
"notifyEmails",
"includeId",
"includeName",
"status",
"submitDate",
"updateDate"
],
"properties": {
"accountId": {
"description": "Identifies the account the activated include belongs to. 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"
},
"activationType": {
"description": "Either `ACTIVATE` or `DEACTIVATE`. The default is `ACTIVATE`. Any new activation automatically deactivates the current activation. Note that if you were to POST a `DEACTIVATE` type on an active include, it would no longer serve any traffic. You'd need to modify your DNS configuration and specify a different way to field the traffic.",
"type": "string",
"enum": [
"ACTIVATE",
"DEACTIVATE"
]
},
"fmaActivationState": {
"description": "Indicates fast metadata activation state. A value of `steady` indicates the include is currently active or has been cancelled. Values of `received`, `lived`, and `deployed` represent progressive stages of activation, while `cancelling` happens either after failing a network safety check or in response to a [DELETE operation](https://techdocs.akamai.com/property-mgr/reference/delete-include-activation). Note that the `status` member indicates whether the activation is live.",
"readOnly": true,
"type": "string",
"enum": [
"steady",
"received",
"lived",
"deployed",
"cancelling"
]
},
"groupId": {
"description": "Identifies the group under which the include activated. 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"
},
"includeActivationId": {
"description": "The activation's unique identifier. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on how to omit the ID's `atv_` prefix.",
"type": "string"
},
"includeId": {
"description": "Identifies include targeted with activation. 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": "The name of the include targeted with activation.",
"type": "string"
},
"includeVersion": {
"description": "The include version targeted with activation. Once activated, you can no longer modify that version of the include.",
"minimum": 1,
"type": "integer"
},
"network": {
"description": "The network to activate on, either `STAGING` or `PRODUCTION`.",
"type": "string",
"enum": [
"STAGING",
"PRODUCTION"
]
},
"note": {
"description": "Assigns a log message to the activation request.",
"type": "string"
},
"notifyEmails": {
"description": "Email addresses to notify when the activation status changes.",
"minItems": 1,
"type": "array",
"items": {
"type": "string"
}
},
"status": {
"description": "The activation's status. `ACTIVE` if currently serving traffic. `INACTIVE` if another activation has superseded this one. `NEW`, `PENDING`, `ZONE_1`, `ZONE_2`, or `ZONE_3` if not yet active. `ABORTED` if the client followed up with a [DELETE request](https://techdocs.akamai.com/property-mgr/reference/delete-include-activation) in time. `FAILED` if the activation causes a range of edge network errors. `PENDING_DEACTIVATION` or `DEACTIVATED` when the `activationType` is `DEACTIVATE` to no longer serve traffic.",
"type": "string",
"enum": [
"ACTIVE",
"INACTIVE",
"PENDING",
"ZONE_1",
"ZONE_2",
"ZONE_3",
"ABORTED",
"FAILED",
"DEACTIVATED",
"PENDING_DEACTIVATION",
"NEW"
]
},
"submitDate": {
"description": "A date stamp marking when the activation initiated.",
"readOnly": true,
"type": "string"
},
"updateDate": {
"description": "A date stamp marking when the `status` last changed.",
"readOnly": true,
"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.",
"minLength": 1,
"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.",
"minLength": 1,
"type": "string"
}
},
"x-akamai": {
"file-path": "schemas/include-activation-list-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"
}
},
"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"
}
}
},
"x-akamai": {
"status": "LA"
},
"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": "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.",
"example": "{{contractId}}",
"in": "query",
"name": "contractId",
"required": false,
"schema": {
"example": "ctr_1-1TJZFW",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/contractId-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.",
"example": "{{groupId}}",
"in": "query",
"name": "groupId",
"required": false,
"schema": {
"example": "grp_15166",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/groupId-optional.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"
}
}
]
},
"x-akamai": {
"file-path": "paths/include-activations.yaml",
"path-for-file": "/includes/{includeId}/activations"
},
"x-akamai-descriptor-tools": {
"displayName": "includeActivations",
"group": "Include activations"
},
"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.",
"example": "{{includeId}}",
"in": "path",
"name": "includeId",
"required": true,
"schema": {
"example": "inc_175780",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/includeId-path.yaml"
}
}
]
},
"/includes/{includeId}/activations/{activationId}": {
"get": {
"description": "__Limited availability__ Gets details about an activation. The response also shows the results of a validation against the rule trees of active parent properties that reference the include. While you can ignore any warnings that indicate non-blocking, logical inconsistencies, you need to resolve all errors to activate an include. You typically get a single activation from an `activationLink` when [launching a new activation](https://techdocs.akamai.com/property-mgr/reference/post-include-activation), and you follow up to poll its `status`. For activations whose `status` is `PENDING`, a `Retry-After` header provides an estimate for when it's likely to go live.",
"operationId": "get-include-activation",
"summary": "Akamai Get an Include Activation",
"tags": [
"Include activations"
],
"externalDocs": {
"description": "See documentation for this operation in Akamai's Property Manager API",
"url": "https://techdocs.akamai.com/property-mgr/reference/get-include-activation"
},
"responses": {
"200": {
"description": "The response shows details for the include validation and activation.",
"content": {
"application/json": {
"example": {
"accountId": "act_A-CCT5678",
"contractId": "ctr_C-0N7RAC7",
"groupId": "grp_15225",
"activations": {
"items": [
{
"activationType": "ACTIVATE",
"fmaActivationState": "received",
"includeActivationId": "5e597860-1107-461e-8dbe-4e7526e8dd02",
"includeId": "inc_173036",
"includeName": "example.inc.com",
"includeVersion": 1,
"network": "STAGING",
"note": "Sample activation",
"status": "PENDING",
"submitDate": "2022-03-02T02:22:12Z",
"updateDate": "2022-03-01T21:12:57Z",
"notifyEmails": [
"you@example.com",
"them@example.com"
]
}
]
},
"validations": {
"network": "STAGING",
"validationErrorItemList": {
"items": [
{
"hasValidationError": true,
"hasValidationWarning": true,
"propertyName": "ng-parent5-for-inc7.com",
"validationResultsLink": "/papi-backend/v0/includes/validation-results/489e0b99-e80a-4cf0-bc44-f29f810c68c0/properties/747628/versions/1?groupId=grp_15225&contractId=ctr_C-0N7RAC7",
"versionId": 185102232,
"versionNumber": 1
},
{
"hasValidationError": true,
"hasValidationWarning": false,
"propertyName": "ng-include.common7",
"validationResultsLink": "/papi-backend/v0/includes/validation-results/489e0b99-e80a-4cf0-bc44-f29f810c68c0/properties/747209/versions/6?groupId=grp_15225&contractId=ctr_C-0N7RAC7",
"versionId": 185107315,
"versionNumber": 6
}
]
},
"validationSummary": {
"completePercent": 100,
"hasClientError": false,
"hasSystemError": false,
"hasValidationError": true,
"hasValidationWarning": false,
"messageState": "SUBMITTED_FOR_ACTIVATION"
}
}
},
"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/GetIncludeActivationResponse.json#",
"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.",
"minLength": 1,
"type": "string"
},
"activations": {
"additionalProperties": false,
"description": "The set of requested activations, available within an `items` array.",
"type": "object",
"properties": {
"items": {
"description": "Activated include versions on a specific network. Relevant response objects appear within the outer envelope's `activations.items` array.",
"type": "array",
"items": {
"additionalProperties": false,
"type": "object",
"required": [
"includeActivationId",
"activationType",
"network",
"note",
"notifyEmails",
"includeId",
"includeName",
"status",
"submitDate",
"updateDate"
],
"properties": {
"accountId": {
"description": "Identifies the account the activated include belongs to. 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"
},
"activationType": {
"description": "Either `ACTIVATE` or `DEACTIVATE`. The default is `ACTIVATE`. Any new activation automatically deactivates the current activation. Note that if you were to POST a `DEACTIVATE` type on an active include, it would no longer serve any traffic. You'd need to modify your DNS configuration and specify a different way to field the traffic.",
"type": "string",
"enum": [
"ACTIVATE",
"DEACTIVATE"
]
},
"failureCause": {
"description": "If the activation's `status` is `FAILED`, this HTTP problem object describes the reason for the failure. This only appears when activating with `delayValidations` enabled.",
"type": "object"
},
"fmaActivationState": {
"description": "Indicates fast metadata activation state. A value of `steady` indicates the include is currently active or has been cancelled. Values of `received`, `lived`, and `deployed` represent progressive stages of activation, while `cancelling` happens either after failing a network safety check or in response to a [DELETE operation](https://techdocs.akamai.com/property-mgr/reference/delete-include-activation). Note that the `status` member indicates whether the activation is live.",
"readOnly": true,
"type": "string",
"enum": [
"steady",
"received",
"lived",
"deployed",
"cancelling"
]
},
"groupId": {
"description": "Identifies the group under which the include activated. 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"
},
"includeActivationId": {
"description": "The activation's unique identifier. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on how to omit the ID's `atv_` prefix.",
"type": "string"
},
"includeId": {
"description": "Identifies include targeted with activation. 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": "The name of the include targeted with activation.",
"type": "string"
},
"includeVersion": {
"description": "The include version targeted with activation. Once activated, you can no longer modify that version of the include.",
"minimum": 1,
"type": "integer"
},
"network": {
"description": "The network to activate on, either `STAGING` or `PRODUCTION`.",
"type": "string",
"enum": [
"STAGING",
"PRODUCTION"
]
},
"note": {
"description": "Assigns a log message to the activation request.",
"type": "string"
},
"notifyEmails": {
"description": "Email addresses to notify when the activation status changes.",
"minItems": 1,
"type": "array",
"items": {
"type": "string"
}
},
"status": {
"description": "The activation's status. `ACTIVE` if currently serving traffic. `INACTIVE` if another activation has superseded this one. `NEW`, `PENDING`, `ZONE_1`, `ZONE_2`, or `ZONE_3` if not yet active. `ABORTED` if the client followed up with a [DELETE request](https://techdocs.akamai.com/property-mgr/reference/delete-include-activation) in time. `FAILED` if the activation causes a range of edge network errors. `PENDING_DEACTIVATION` or `DEACTIVATED` when the `activationType` is `DEACTIVATE` to no longer serve traffic.",
"type": "string",
"enum": [
"ACTIVE",
"INACTIVE",
"PENDING",
"ZONE_1",
"ZONE_2",
"ZONE_3",
"ABORTED",
"FAILED",
"DEACTIVATED",
"PENDING_DEACTIVATION",
"NEW"
]
},
"submitDate": {
"description": "A date stamp marking when the activation initiated.",
"readOnly": true,
"type": "string"
},
"updateDate": {
"description": "A date stamp marking when the `status` last changed.",
"readOnly": true,
"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.",
"minLength": 1,
"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.",
"minLength": 1,
"type": "string"
},
"validations": {
"additionalProperties": false,
"description": "The set of include validations against the active parent properties' rule trees that reference the include.",
"type": "object",
"required": [
"validationSummary",
"validationErrorItemList",
"network"
],
"properties": {
"network": {
"description": "The network to activate on, either `STAGING` or `PRODUCTION`.",
"type": "string",
"enum": [
"STAGING",
"PRODUCTION"
]
},
"validationErrorItemList": {
"additionalProperties": false,
"description": "The set of validation results against specific versions of parent properties' rule tree, available within the `items` array.",
"type": "object",
"required": [
"items"
],
"properties": {
"items": {
"description": "Lists parent property versions that reference the requested include, with information on the validation errors and warnings. If the include doesn't have any parent properties, the array is empty.",
"type": "array",
"items": {
"additionalProperties": false,
"type": "object",
"required": [
"versionId",
"propertyName",
"versionNumber",
"hasValidationError",
"hasValidationWarning",
"validationResultsLink"
],
"properties": {
"hasValidationError": {
"default": true,
"description": "Whether the validation against the rule tree of an active parent property version revealed any blocking problems that would prevent activation. You need to fix these to complete an include activation.",
"type": "boolean"
},
"hasValidationWarning": {
"description": "Whether the validation against the rule tree of an active parent property version revealed any non-blocking issues.",
"type": "boolean"
},
"propertyName": {
"description": "A descriptive name for the property.",
"type": "string"
},
"validationResultsLink": {
"description": "Links the details of validation errors and warnings for you to inspect.",
"type": "string"
},
"versionId": {
"description": "Unique identifier for the property version.",
"minimum": 1,
"type": "integer"
},
"versionNumber": {
"description": "Property's incremental version number.",
"minimum": 1,
"type": "integer"
}
}
}
}
}
},
"validationSummary": {
"additionalProperties": false,
"description": "An overview of the validation against all parent properties' rule trees. Contains the errors that you need to resolve to complete the include activation.",
"type": "object",
"properties": {
"completePercent": {
"description": "The progress of the validation completion. If the include doesn't have any parent properties, this completes right away.",
"maximum": 100,
"minimum": 0,
"type": "number"
},
"errorMessage": {
"description": "Provides details on the error, if it occurs.",
"type": "string"
},
"hasClientError": {
"description": "Whether the validation revealed any 4XX errors on the user's end.",
"type": "boolean"
},
"hasSystemError": {
"description": "Whether the validation revealed any issues on the Akamai side. When `true`, the validation re-launches automatically.",
"type": "boolean"
},
"hasValidationError": {
"default": false,
"description": "Whether the validation against the rule trees of active parent property versions revealed any blocking problems that would prevent activation. You need to fix these to complete an include activation. If the include doesn't have any parent properties, this defaults to `false`.",
"type": "boolean"
},
"hasValidationWarning": {
"description": "Whether the validation against the rule tree of an active parent property version revealed any non-blocking issues. If the include doesn't have any parent properties, this defaults to `false`.",
"type": "boolean"
},
"messageState": {
"description": "The validation status, either:\n\n- `RECEIVED` if the request is received in the provisioning queue,\n- `VALIDATION_IN_PROGRESS` if the validation has begun for a request,\n- `CONFLICT` if a 409 status is received from a downstream service,\n- `CUSTOMER_ABORT` if the user cancelled the request to be processed further,\n- `VALIDATION_ERROR_ABORT` if any of the validation tasks results in an error,\n- `HTTP_CLIENT_ERROR` if there's any bad request from the client side,\n- `HTTP_SYS_ERROR` if there's any system error. This state is eligible for Retry,\n- `HTTP_SYS_ERROR_EXPIRED` if there's any system error. This state isn't eligible for Retry,\n- `RETRY_SUBMITTED` if the user has already sent the Retry request,\n- `SUBMITTED_FOR_ACTIVATION` if the activation request has been successfully submitted,\n- `SUBMITTED_TO_FMA` if the fast metadata activation request has been successfully submitted,\n- `SUBMITTED_TO_FMA_IN_PROGRESS` if the fast metadata activation request has been successfully submitted and received an `OK` response,\n- `VALIDATION_PASSED` if the validation has been successful and returned no validation errors or warnings,\n- `VALIDATION_PASSED_WITH_WARNINGS` if the validation has been successful but returned some validation warnings.",
"type": "string",
"enum": [
"RECEIVED",
"VALIDATION_IN_PROGRESS",
"CONFLICT",
"CUSTOMER_ABORT",
"VALIDATION_ERROR_ABORT",
"HTTP_CLIENT_ERROR",
"HTTP_SYS_ERROR",
"HTTP_SYS_ERROR_EXPIRED",
"RETRY_SUBMITTED",
"SUBMITTED_FOR_ACTIVATION",
"SUBMITTED_TO_FMA",
"SUBMITTED_TO_FMA_IN_PROGRESS",
"VALIDATION_PASSED",
"VALIDATION_PASSED_WITH_WARNINGS"
]
}
}
}
}
}
},
"x-akamai": {
"file-path": "schemas/include-activation-get-response.yaml"
}
}
}
},
"headers": {
"Retry-After": {
"description": "For activations whose `status` remains `PENDING`, this specifies the number of seconds it will likely take to go live.",
"schema": {
"type": "string"
},
"x-akamai": {
"file-path": "headers/Retry-After.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"
}
},
"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"
}
}
},
"x-akamai": {
"status": "LA"
},
"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": "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.",
"example": "{{contractId}}",
"in": "query",
"name": "contractId",
"required": false,
"schema": {
"example": "ctr_1-1TJZFW",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/contractId-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.",
"example": "{{groupId}}",
"in": "query",
"name": "groupId",
"required": false,
"schema": {
"example": "grp_15166",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/groupId-optional.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"
}
}
]
},
"delete": {
"description": "__Limited availability__ If you detect a problem with an include version while its activation is still `PENDING`, use this operation to cancel it. Make a DELETE request on the `activationLink` you get from the [Activate an include](https://techdocs.akamai.com/property-mgr/reference/post-include-activation) operation's response. Once you DELETE the activation, it no longer appears in the [list of activations](https://techdocs.akamai.com/property-mgr/reference/get-include-activations), but you can still [access it individually](https://techdocs.akamai.com/property-mgr/reference/get-include-activation).",
"operationId": "delete-include-activation",
"summary": "Akamai Cancel an Include's Pending Activation",
"tags": [
"Include activations"
],
"externalDocs": {
"description": "See documentation for this operation in Akamai's Property Manager API",
"url": "https://techdocs.akamai.com/property-mgr/reference/delete-include-activation"
},
"responses": {
"200": {
"description": "The response shows details for the cancelled include activation.",
"content": {
"application/json": {
"example": {
"accountId": "act_A-CCT5678",
"contractId": "ctr_C-0N7RAC71",
"groupId": "grp_15225",
"activations": {
"items": [
{
"activationType": "ACTIVATE",
"fmaActivationState": "received",
"includeActivationId": "5e597860-1107-461e-8dbe-4e7526e8dd02",
"includeId": "inc_173036",
"includeName": "example.inc.com",
"includeType": "COMMON_SETTINGS",
"includeVersion": 1,
"network": "STAGING",
"note": "Sample cancellation",
"status": "PENDING_CANCELLATION",
"submitDate": "2022-03-02T02:22:12Z",
"updateDate": "2022-03-01T21:12:57Z",
"notifyEmails": [
"you@example.com",
"them@example.com"
]
}
]
}
},
"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/DeleteActivationResponse.json#",
"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.",
"minLength": 1,
"type": "string"
},
"activations": {
"additionalProperties": false,
"description": "The set of requested activations, available within an `items` array.",
"type": "object",
"properties": {
"items": {
"description": "Activated include versions on a specific network. Relevant response objects appear within the outer envelope's `activations.items` array.",
"type": "array",
"items": {
"additionalProperties": false,
"type": "object",
"required": [
"includeActivationId",
"activationType",
"network",
"note",
"notifyEmails",
"includeId",
"includeName",
"status",
"submitDate",
"updateDate"
],
"properties": {
"activationType": {
"description": "Either `ACTIVATE` or `DEACTIVATE`. The default is `ACTIVATE`. Any new activation automatically deactivates the current activation. Note that if you were to POST a `DEACTIVATE` type on an active include, it would no longer serve any traffic. You'd need to modify your DNS configuration and specify a different way to field the traffic.",
"type": "string",
"enum": [
"ACTIVATE",
"DEACTIVATE"
]
},
"fmaActivationState": {
"description": "Indicates fast metadata activation state. A value of `steady` indicates the include is currently active or has been cancelled. Values of `received`, `lived`, and `deployed` represent progressive stages of activation, while `cancelling` happens either after failing a network safety check or in response to a [DELETE operation](https://techdocs.akamai.com/property-mgr/reference/delete-include-activation). Note that the `status` member indicates whether the activation is live.",
"readOnly": true,
"type": "string",
"enum": [
"steady",
"received",
"lived",
"deployed",
"cancelling"
]
},
"includeActivationId": {
"description": "The activation's unique identifier. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on how to omit the ID's `atv_` prefix.",
"type": "string"
},
"includeId": {
"description": "Identifies include targeted with activation. 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": "The name of the include targeted with activation.",
"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 `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": "The include version targeted with activation. Once activated, you can no longer modify that version of the include.",
"minimum": 1,
"type": "integer"
},
"network": {
"description": "The network to activate on, either `STAGING` or `PRODUCTION`.",
"type": "string",
"enum": [
"STAGING",
"PRODUCTION"
]
},
"note": {
"description": "Assigns a log message to the activation request.",
"type": "string"
},
"notifyEmails": {
"description": "Email addresses to notify when the activation status changes.",
"minItems": 1,
"type": "array",
"items": {
"type": "string"
}
},
"status": {
"description": "The activation's status. `ACTIVE` if currently serving traffic. `INACTIVE` if another activation has superseded this one. `NEW`, `PENDING`, `ZONE_1`, `ZONE_2`, or `ZONE_3` if not yet active. `ABORTED` if the client followed up with a [DELETE request](https://techdocs.akamai.com/property-mgr/reference/delete-include-activation) in time. `FAILED` if the activation causes a range of edge network errors. `PENDING_DEACTIVATION` or `DEACTIVATED` when the `activationType` is `DEACTIVATE` to no longer serve traffic.",
"type": "string",
"enum": [
"ACTIVE",
"INACTIVE",
"PENDING",
"ZONE_1",
"ZONE_2",
"ZONE_3",
"ABORTED",
"FAILED",
"DEACTIVATED",
"PENDING_DEACTIVATION",
"PENDING_CANCELLATION",
"NEW"
]
},
"submitDate": {
"description": "A date stamp marking when the activation initiated.",
"readOnly": true,
"type": "string"
},
"updateDate": {
"description": "A date stamp marking when the `status` last changed.",
"readOnly": true,
"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.",
"minLength": 1,
"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.",
"minLength": 1,
"type": "string"
}
},
"x-akamai": {
"file-path": "schemas/include-activation-delete-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"
}
},
"409": {
"description": "[Conflict](https://techdocs.akamai.com/property-mgr/reference/409).",
"content": {
"application/problem+json": {
"example": {
"detail": "Another edit or activation request on same network in progress for this property version.",
"instance": "papi/v1/properties/prp_123456/activations?contractId=ctr_C-0N7RAC7&groupId=grp_12345#abc12345abcc02a7",
"status": 409,
"title": "Operation failed",
"type": "https://problems.luna.akamaiapis.net/papi/v1/resource-busy"
},
"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/409.yaml"
}
},
"422": {
"description": "[Unprocessable content](https://techdocs.akamai.com/property-mgr/reference/422).",
"content": {
"application/problem+json": {
"example": {
"instance": "papi/v1/activations/#abc12345abcc02a7",
"messageId": "property_activation_still_pending",
"result": "ERROR",
"status": 422,
"title": "Property Manager Exception",
"type": "https://problems.luna.akamaiapis.net/papi/v1/property_activation_still_pending",
"params": [
"Property 123456",
"Version 1"
],
"details": {},
"errors": [
{
"detail": "property_activation_still_pending",
"title": "Property Manager Exception",
"type": "papi/v1/property_activation_still_pending"
}
]
},
"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",
"instance",
"status",
"errors",
"details",
"messageId",
"params",
"result"
],
"properties": {
"details": {
"description": "Diagnostic instructions to locate and fix the problem.",
"type": "object"
},
"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"
},
"messageId": {
"description": "Summarizes the cause of the problem.",
"minLength": 1,
"type": "string"
},
"params": {
"description": "Details of the property and version where the problem occured.",
"minItems": 0,
"type": "array",
"items": {
"type": "string"
}
},
"result": {
"description": "Indicates the severity of the problem.",
"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-422.yaml"
}
}
}
},
"x-akamai": {
"file-path": "errors/422.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"
}
}
},
"x-akamai": {
"status": "LA"
},
"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": "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.",
"example": "{{contractId}}",
"in": "query",
"name": "contractId",
"required": false,
"schema": {
"example": "ctr_1-1TJZFW",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/contractId-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.",
"example": "{{groupId}}",
"in": "query",
"name": "groupId",
"required": false,
"schema": {
"example": "grp_15166",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/groupId-optional.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"
}
}
]
},
"x-akamai": {
"file-path": "paths/include-activation.yaml",
"path-for-file": "/includes/{includeId}/activations/{activationId}"
},
"x-akamai-descriptor-tools": {
"displayName": "includeActivation",
"group": "Include activations"
},
"parameters": [
{
"description": "Unique identifier for the property or include activation.",
"example": "{{activationId}}",
"in": "path",
"name": "activationId",
"required": true,
"schema": {
"example": "atv_1696855",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/activationId-path.yaml"
}
},
{
"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.",
"example": "{{includeId}}",
"in": "path",
"name": "includeId",
"required": true,
"schema": {
"example": "inc_175780",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/includeId-path.yaml"
}
}
]
},
"/includes/{includeId}/parents": {
"get": {
"description": "__Limited availability__ Lists all active properties that reference a specific include. Combine optional query parameters to paginate, sort, and filter the results. Specify any `includeId` you get from a [list of includes](https://techdocs.akamai.com/property-mgr/reference/get-includes).",
"operationId": "get-include-parents",
"summary": "Akamai List Parent Properties",
"tags": [
"Includes"
],
"externalDocs": {
"description": "See documentation for this operation in Akamai's Property Manager API",
"url": "https://techdocs.akamai.com/property-mgr/reference/get-include-parents"
},
"responses": {
"200": {
"description": "The response lists active properties that reference the requested include in their rule trees.",
"content": {
"application/json": {
"example": {
"properties": {
"items": [
{
"accountId": "act_A-CCT3456",
"assetId": "aid_101",
"contractId": "ctr_C-0N7RAC7",
"groupId": "grp_15225",
"latestVersion": 2,
"note": "Notes about example.com",
"productionVersion": null,
"propertyId": "prp_175780",
"propertyName": "example.com",
"stagingVersion": 1
},
{
"accountId": "act_A-CCT5678",
"assetId": "aid_101",
"contractId": "ctr_C-0N7RAC7",
"groupId": "grp_15225",
"latestVersion": 1,
"note": "Notes about m.example.com",
"productionVersion": null,
"propertyId": "prp_175781",
"propertyName": "m.example.com",
"stagingVersion": null
}
]
}
},
"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, even individual items.",
"id": "resource:/descriptors/papi/v1/schemas/GetPropertyResponse.json#",
"type": "object",
"properties": {
"properties": {
"additionalProperties": false,
"description": "The set of requested properties, available within an `items` array.",
"type": "object",
"properties": {
"items": {
"description": "Configuration data to apply to edge content. Relevant response objects appear within the outer envelope's `properties.items` array.",
"type": "array",
"items": {
"additionalProperties": false,
"type": "object",
"required": [
"accountId",
"contractId",
"groupId",
"propertyId",
"propertyName",
"latestVersion",
"stagingVersion",
"productionVersion",
"assetId",
"note"
],
"properties": {
"accountId": {
"description": "Identifies the account the property belongs to. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on how to omit the ID's `act_` prefix.",
"readOnly": true,
"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 the property belongs to. 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 group to which the property is assigned. 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"
},
"latestVersion": {
"description": "Specifies the most recent version of the property.",
"type": "integer"
},
"note": {
"description": "Further descriptive commentary.",
"type": "string"
},
"productId": {
"description": "The product assigned to the property, required when POSTing a new property. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on how to omit the ID's `prd_` prefix.",
"type": "string"
},
"productionVersion": {
"description": "The most recent version to be activated to the production network, otherwise `null`.",
"nullable": true,
"type": [
"integer",
"null"
]
},
"propertyId": {
"description": "The property's unique identifier. 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.",
"type": "string"
},
"propertyType": {
"description": "Specifies the type of the property. Either `TRADITIONAL` for properties where you pair property hostnames with the property version, or `HOSTNAME_BUCKET` where you manage property hostnames independently of the property version.",
"type": "string",
"enum": [
"HOSTNAME_BUCKET",
"TRADITIONAL"
]
},
"ruleFormat": {
"description": "Name of the rule format. The rule format can be frozen to a specific version, or represent the `latest` set of behaviors and criteria.",
"type": "string"
},
"stagingVersion": {
"description": "The most recent version to be activated to the test network, otherwise `null`.",
"nullable": true,
"type": [
"integer",
"null"
]
}
}
}
}
}
}
},
"x-akamai": {
"file-path": "schemas/property-get-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"
}
},
"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"
}
}
},
"x-akamai": {
"status": "LA"
},
"parameters": [
{
"description": "For paginated responses, specifies the page of results you want to navigate to, starting from `0`.",
"example": "{{offset}}",
"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.",
"example": "{{limit}}",
"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.",
"example": "{{contractId}}",
"in": "query",
"name": "contractId",
"required": false,
"schema": {
"example": "ctr_1-1TJZFW",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/contractId-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.",
"example": "{{groupId}}",
"in": "query",
"name": "groupId",
"required": false,
"schema": {
"example": "grp_15166",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/groupId-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.",
"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"
}
}
]
},
"x-akamai": {
"file-path": "paths/include-parents.yaml",
"path-for-file": "/includes/{includeId}/parents"
},
"x-akamai-descriptor-tools": {
"displayName": "parents",
"group": "Includes"
},
"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.",
"example": "{{includeId}}",
"in": "path",
"name": "includeId",
"required": true,
"schema": {
"example": "inc_175780",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/includeId-path.yaml"
}
}
]
},
"/includes/{includeId}/versions": {
"post": {
"description": "__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.",
"operationId": "post-include-versions",
"summary": "Akamai Create a New Include Version",
"tags": [
"Include versions"
],
"externalDocs": {
"description": "See documentation for this operation in Akamai's Property Manager API",
"url": "https://techdocs.akamai.com/property-mgr/reference/post-include-versions"
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"example": {
"createFromVersion": 1,
"createFromVersionEtag": "2641910c585cf67b"
},
"schema": {
"$schema": "http://json-schema.org/draft-04-schema#",
"description": "When [incrementing a new version](https://techdocs.akamai.com/property-mgr/reference/post-include-versions), this POST object's members aren't reflected in subsequent responses.",
"id": "resource:/descriptors/papi/v1/schemas/CreateNewIncludeVersionRequestV0.json#",
"javaType": "com.akamai.luna.papi.model.IncludeVersionCreateRequest",
"type": "object",
"required": [
"createFromVersion"
],
"properties": {
"createFromVersion": {
"description": "The include version on which to base the new version.",
"example": "{{createFromVersion}}",
"minimum": 1,
"type": "integer"
},
"createFromVersionEtag": {
"description": "The data digest of the version on which to base the new version. See [Concurrency control](https://techdocs.akamai.com/property-mgr/reference/concurrency-control) for guidance.",
"example": "{{createFromVersionEtag}}",
"type": "string"
}
},
"x-akamai": {
"file-path": "schemas/include-version-create-request.yaml"
}
}
}
}
},
"responses": {
"201": {
"description": "The response provides a URL link to the newly created include version.",
"content": {
"application/json": {
"example": {
"versionLink": "/papi/v0/includes/inc_173136/versions/2?contractId=ctr_C-0N7RAC7&groupId=grp_15225"
},
"schema": {
"$schema": "http://json-schema.org/draft-04-schema#",
"additionalProperties": false,
"description": "Provides a hypermedia link to a newly created resource. The response's single member name indicates the type of resource.",
"id": "resource:/descriptors/papi/v1/schemas/PostIncludeVersionResponse.json#",
"type": "object",
"required": [
"versionLink"
],
"properties": {
"versionLink": {
"description": "Links the include version.",
"type": "string"
}
},
"x-akamai": {
"file-path": "schemas/include-version-create-response.yaml"
}
}
}
},
"headers": {
"Location": {
"description": "Provides a URL path you can GET the newly created resource from.",
"schema": {
"type": "string"
},
"x-akamai": {
"file-path": "headers/Location.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"
}
}
},
"x-akamai": {
"status": "LA"
},
"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": "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.",
"example": "{{contractId}}",
"in": "query",
"name": "contractId",
"required": false,
"schema": {
"example": "ctr_1-1TJZFW",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/contractId-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.",
"example": "{{groupId}}",
"in": "query",
"name": "groupId",
"required": false,
"schema": {
"example": "grp_15166",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/groupId-optional.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"
}
}
]
},
"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).",
"operationId": "get-include-versions",
"summary": "Akamai List Include Versions",
"tags": [
"Include versions"
],
"externalDocs": {
"description": "See documentation for this operation in Akamai's Property Manager API",
"url": "https://techdocs.akamai.com/property-mgr/reference/get-include-versions"
},
"responses": {
"200": {
"description": "The response lists include versions for the requested include.",
"content": {
"application/json": {
"example": {
"accountId": "act_A-CCT7890",
"assetId": "aid_101",
"contractId": "ctr_C-0N7RAC71",
"groupId": "grp_15225",
"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": "tyamada",
"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": "jkowalski",
"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.",
"id": "resource:/descriptors/papi/v1/schemas/GetIncludeVersionResponse.json#",
"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 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 descriptive name for the include.",
"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 `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": [
"COMMON_SETTINGS",
"MICROSERVICES"
]
},
"versions": {
"additionalProperties": false,
"description": "The set of requested include versions, available within an `items` array.",
"type": "object",
"properties": {
"items": {
"description": "Specifies the version of an include. Relevant response objects appear within the outer envelope's `versions.items` array.",
"type": "array",
"items": {
"additionalProperties": false,
"type": "object",
"required": [
"etag",
"note",
"productId",
"productionStatus",
"includeVersion",
"stagingStatus",
"updatedByUser",
"updatedDate"
],
"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.",
"type": "string",
"enum": [
"ACTIVE",
"INACTIVE",
"PENDING",
"ABORTED",
"DEACTIVATED",
"PENDING_DEACTIVATION",
"PENDING_CANCELLATION"
]
},
"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.",
"type": "string",
"enum": [
"ACTIVE",
"INACTIVE",
"PENDING",
"ABORTED",
"DEACTIVATED",
"PENDING_DEACTIVATION",
"PENDING_CANCELLATION"
]
},
"updatedByUser": {
"description": "The username who last updated the version.",
"type": "string"
},
"updatedDate": {
"description": "The date stamp of the version's latest update.",
"type": "string"
}
}
}
}
}
}
},
"x-akamai": {
"file-path": "schemas/include-version-get-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"
}
},
"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"
}
}
},
"x-akamai": {
"status": "LA"
},
"parameters": [
{
"description": "For paginated responses, specifies the page of results you want to navigate to, starting from `0`.",
"example": "{{offset}}",
"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.",
"example": "{{limit}}",
"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.",
"example": "{{contractId}}",
"in": "query",
"name": "contractId",
"required": false,
"schema": {
"example": "ctr_1-1TJZFW",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/contractId-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.",
"example": "{{groupId}}",
"in": "query",
"name": "groupId",
"required": false,
"schema": {
"example": "grp_15166",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/groupId-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.",
"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"
}
}
]
},
"x-akamai": {
"file-path": "paths/include-versions.yaml",
"path-for-file": "/includes/{includeId}/versions"
},
"x-akamai-descriptor-tools": {
"displayName": "includeVersions",
"group": "Include versions"
},
"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.",
"example": "{{includeId}}",
"in": "path",
"name": "includeId",
"required": true,
"schema": {
"example": "inc_175780",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/includeId-path.yaml"
}
}
]
},
"/includes/{includeId}/versions/latest": {
"get": {
"description": "__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.",
"operationId": "get-latest-include-version",
"summary": "Akamai Get the Latest Include Version",
"tags": [
"Include versions"
],
"externalDocs": {
"description": "See documentation for this operation in Akamai's Property Manager API",
"url": "https://techdocs.akamai.com/property-mgr/reference/get-latest-include-version"
},
"responses": {
"302": {
"description": "The response provides a redirect URL link to the latest version of the requested include.",
"content": {
"application/json": {
"example": {
"versionLink": "/papi/v0/includes/inc_173136/versions/2?contractId=ctr_C-0N7RAC7&groupId=grp_15225"
},
"schema": {
"$schema": "http://json-schema.org/draft-04-schema#",
"additionalProperties": false,
"description": "Provides a hypermedia link to a newly created resource. The response's single member name indicates the type of resource.",
"id": "resource:/descriptors/papi/v1/schemas/PostIncludeVersionResponse.json#",
"type": "object",
"required": [
"versionLink"
],
"properties": {
"versionLink": {
"description": "Links the include version.",
"type": "string"
}
},
"x-akamai": {
"file-path": "schemas/include-version-create-response.yaml"
}
}
}
},
"headers": {
"Location": {
"description": "Provides a URL path you can GET the newly created resource from.",
"schema": {
"type": "string"
},
"x-akamai": {
"file-path": "headers/Location.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"
}
},
"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"
}
}
},
"x-akamai": {
"status": "LA"
},
"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": "__Enum__ If present, returns the latest version activated on the given network, either `STAGING` or `PRODUCTION`.",
"example": "{{activatedOn}}",
"in": "query",
"name": "activatedOn",
"required": false,
"schema": {
"example": "STAGING",
"type": "string",
"enum": [
"STAGING",
"PRODUCTION"
]
},
"x-akamai": {
"file-path": "parameters/activatedOn-query.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.",
"example": "{{contractId}}",
"in": "query",
"name": "contractId",
"required": false,
"schema": {
"example": "ctr_1-1TJZFW",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/contractId-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.",
"example": "{{groupId}}",
"in": "query",
"name": "groupId",
"required": false,
"schema": {
"example": "grp_15166",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/groupId-optional.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"
}
}
]
},
"x-akamai": {
"file-path": "paths/include-versions-latest.yaml",
"path-for-file": "/includes/{includeId}/versions/latest"
},
"x-akamai-descriptor-tools": {
"displayName": "latestIncludeVersion",
"group": "Include versions"
},
"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.",
"example": "{{includeId}}",
"in": "path",
"name": "includeId",
"required": true,
"schema": {
"example": "inc_175780",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/includeId-path.yaml"
}
}
]
},
"/includes/{includeId}/versions/{includeVersion}": {
"get": {
"description": "__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.",
"operationId": "get-include-version",
"summary": "Akamai Get an Include Version",
"tags": [
"Include versions"
],
"externalDocs": {
"description": "See documentation for this operation in Akamai's Property Manager API",
"url": "https://techdocs.akamai.com/property-mgr/reference/get-include-version"
},
"responses": {
"200": {
"description": "The response shows details of the requested include version.",
"content": {
"application/json": {
"example": {
"accountId": "act_A-CCT1234",
"assetId": "aid_101",
"contractId": "ctr_C-0N7RAC7",
"groupId": "grp_12345",
"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": "afero",
"updatedDate": "2022-10-22T19:06:13Z"
}
]
}
},
"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/GetIncludeVersionResponse.json#",
"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 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 descriptive name for the include.",
"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 `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": [
"COMMON_SETTINGS",
"MICROSERVICES"
]
},
"versions": {
"additionalProperties": false,
"description": "The set of requested include versions, available within an `items` array.",
"type": "object",
"properties": {
"items": {
"description": "Specifies the version of an include. Relevant response objects appear within the outer envelope's `versions.items` array.",
"type": "array",
"items": {
"additionalProperties": false,
"type": "object",
"required": [
"etag",
"note",
"productId",
"productionStatus",
"includeVersion",
"stagingStatus",
"updatedByUser",
"updatedDate"
],
"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.",
"type": "string",
"enum": [
"ACTIVE",
"INACTIVE",
"PENDING",
"ABORTED",
"DEACTIVATED",
"PENDING_DEACTIVATION",
"PENDING_CANCELLATION"
]
},
"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.",
"type": "string",
"enum": [
"ACTIVE",
"INACTIVE",
"PENDING",
"ABORTED",
"DEACTIVATED",
"PENDING_DEACTIVATION",
"PENDING_CANCELLATION"
]
},
"updatedByUser": {
"description": "The username who last updated the version.",
"type": "string"
},
"updatedDate": {
"description": "The date stamp of the version's latest update.",
"type": "string"
}
}
}
}
}
}
},
"x-akamai": {
"file-path": "schemas/include-version-get-response.yaml"
}
}
},
"text/xml": {
"example": "\n\n \n \n \n \n \n \n \n \n"
}
},
"headers": {
"ETag": {
"description": "Pass the `ETag` response header back as `If-Match` in write requests to ensure you don't overwrite edits by any other API clients. See [Concurrency control](https://techdocs.akamai.com/property-mgr/reference/concurrency-control) for details.",
"example": "\"a9dfe78cf93090516bde891d009eaf57\"",
"schema": {
"type": "string"
},
"x-akamai": {
"file-path": "headers/Etag.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"
}
},
"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"
}
}
},
"x-akamai": {
"status": "LA"
},
"parameters": [
{
"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.",
"example": "{{contractId}}",
"in": "query",
"name": "contractId",
"required": false,
"schema": {
"example": "ctr_1-1TJZFW",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/contractId-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.",
"example": "{{groupId}}",
"in": "query",
"name": "groupId",
"required": false,
"schema": {
"example": "grp_15166",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/groupId-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.",
"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"
}
}
]
},
"x-akamai": {
"file-path": "paths/include-version.yaml",
"path-for-file": "/includes/{includeId}/versions/{includeVersion}"
},
"x-akamai-descriptor-tools": {
"displayName": "includeVersion",
"group": "Include versions"
},
"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.",
"example": "{{includeId}}",
"in": "path",
"name": "includeId",
"required": true,
"schema": {
"example": "inc_175780",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/includeId-path.yaml"
}
},
{
"description": "Include's incremental version number.",
"example": "{{includeVersion}}",
"in": "path",
"name": "includeVersion",
"required": true,
"schema": {
"example": 3,
"type": "integer"
},
"x-akamai": {
"file-path": "parameters/includeVersion-path.yaml"
}
}
]
},
"/includes/{includeId}/versions/{includeVersion}/available-behaviors": {
"get": {
"description": "__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.",
"operationId": "get-include-available-behaviors",
"summary": "Akamai List Available Behaviors for an Include",
"tags": [
"Include versions"
],
"externalDocs": {
"description": "See documentation for this operation in Akamai's Property Manager API",
"url": "https://techdocs.akamai.com/property-mgr/reference/get-include-available-behaviors"
},
"responses": {
"200": {
"description": "The response lists behaviors available for the requested include version.",
"content": {
"application/json": {
"example": {
"contractId": "ctr_C-0N7RAC71",
"groupId": "grp_15225",
"productId": "prd_Alta",
"ruleFormat": "v2022-10-18",
"behaviors": {
"items": [
{
"name": "cpCode",
"schemaLink": "/papi/v0/schemas/products/prd_Alta/latest#/definitions/catalog/behaviors/cpCode"
},
{
"name": "origin",
"schemaLink": "/papi/v0/schemas/products/prd_Alta/latest#/definitions/catalog/behaviors/origin"
}
]
}
},
"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/GetAvailableBehaviorResponse.json#",
"type": "object",
"properties": {
"behaviors": {
"additionalProperties": false,
"description": "The set of available behaviors, available within an `items` array.",
"type": "object",
"properties": {
"items": {
"description": "Details of available behaviors for [properties](https://techdocs.akamai.com/property-mgr/reference/get-available-behaviors) or [includes](https://techdocs.akamai.com/property-mgr/reference/get-include-available-behaviors) under your current contract.",
"type": "array",
"items": {
"additionalProperties": false,
"type": "object",
"required": [
"name",
"schemaLink"
],
"properties": {
"name": {
"description": "The name of the currently available behavior.",
"type": "string"
},
"schemaLink": {
"description": "A link to the rule format that describes the behavior. Use the file link to [Get a rule format's schema](https://techdocs.akamai.com/property-mgr/reference/get-rule-formats), then use the appended JSON Pointer expression to navigate to the schema that catalogs its options.",
"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"
},
"productId": {
"description": "The product under which these behaviors are available.",
"type": "string"
},
"ruleFormat": {
"description": "The rule format version under which these behaviors are available. See [API versioning](https://techdocs.akamai.com/property-mgr/reference/api-versioning) for more information.",
"type": "string"
}
},
"x-akamai": {
"file-path": "schemas/available-behavior-get-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"
}
},
"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"
}
}
},
"x-akamai": {
"status": "LA"
},
"parameters": [
{
"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.",
"example": "{{contractId}}",
"in": "query",
"name": "contractId",
"required": false,
"schema": {
"example": "ctr_1-1TJZFW",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/contractId-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.",
"example": "{{groupId}}",
"in": "query",
"name": "groupId",
"required": false,
"schema": {
"example": "grp_15166",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/groupId-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.",
"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"
}
}
]
},
"x-akamai": {
"file-path": "paths/include-version-available-behaviors.yaml",
"path-for-file": "/includes/{includeId}/versions/{includeVersion}/available-behaviors"
},
"x-akamai-descriptor-tools": {
"displayName": "availableBehaviors",
"group": "Include versions"
},
"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.",
"example": "{{includeId}}",
"in": "path",
"name": "includeId",
"required": true,
"schema": {
"example": "inc_175780",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/includeId-path.yaml"
}
},
{
"description": "Include's incremental version number.",
"example": "{{includeVersion}}",
"in": "path",
"name": "includeVersion",
"required": true,
"schema": {
"example": 3,
"type": "integer"
},
"x-akamai": {
"file-path": "parameters/includeVersion-path.yaml"
}
}
]
},
"/includes/{includeId}/versions/{includeVersion}/available-criteria": {
"get": {
"description": "__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.",
"operationId": "get-include-available-criteria",
"summary": "Akamai List Available Criteria for an Include",
"tags": [
"Include versions"
],
"externalDocs": {
"description": "See documentation for this operation in Akamai's Property Manager API",
"url": "https://techdocs.akamai.com/property-mgr/reference/get-include-available-criteria"
},
"responses": {
"200": {
"description": "The response lists criteria available for the requested include version.",
"content": {
"application/json": {
"example": {
"contractId": "ctr_K-0N7RAK71",
"groupId": "grp_15225",
"productId": "prd_Alta",
"ruleFormat": "v2022-10-18",
"criteria": {
"items": [
{
"name": "fileExtension",
"schemaLink": "/papi/v0/schemas/products/prd_Alta/latest#/definitions/catalog/criteria/fileExtension"
},
{
"name": "hostname",
"schemaLink": "/papi/v0/schemas/products/prd_Alta/latest#/definitions/catalog/criteria/hostname"
}
]
}
},
"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/GetAvailableCriteriaResponse.json#",
"type": "object",
"properties": {
"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"
},
"criteria": {
"additionalProperties": false,
"description": "The set of available criteria, available within an `items` array.",
"type": "object",
"properties": {
"items": {
"description": "Details of available criteria for [properties](https://techdocs.akamai.com/property-mgr/reference/get-available-criteria) or [includes](https://techdocs.akamai.com/property-mgr/reference/get-include-available-criteria) under your current contract.",
"type": "array",
"items": {
"additionalProperties": false,
"type": "object",
"required": [
"name",
"schemaLink"
],
"properties": {
"name": {
"description": "The name of the currently available criteria.",
"type": "string"
},
"schemaLink": {
"description": "A link to the rule format that describes the criteria. Use the file link to [Get a rule format's schema](https://techdocs.akamai.com/property-mgr/reference/get-rule-formats), then use the appended JSON Pointer expression to navigate to the schema that catalogs its options.",
"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"
},
"productId": {
"description": "The product under which these criteria are available.",
"type": "string"
},
"ruleFormat": {
"description": "The rule format version under which these matches are available. See [API versioning](https://techdocs.akamai.com/property-mgr/reference/api-versioning) for more information.",
"type": "string"
}
},
"x-akamai": {
"file-path": "schemas/available-criteria-get-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"
}
},
"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"
}
}
},
"x-akamai": {
"status": "LA"
},
"parameters": [
{
"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.",
"example": "{{contractId}}",
"in": "query",
"name": "contractId",
"required": false,
"schema": {
"example": "ctr_1-1TJZFW",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/contractId-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.",
"example": "{{groupId}}",
"in": "query",
"name": "groupId",
"required": false,
"schema": {
"example": "grp_15166",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/groupId-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.",
"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"
}
}
]
},
"x-akamai": {
"file-path": "paths/include-version-available-criteria.yaml",
"path-for-file": "/includes/{includeId}/versions/{includeVersion}/available-criteria"
},
"x-akamai-descriptor-tools": {
"displayName": "availableCriteria",
"group": "Include versions"
},
"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.",
"example": "{{includeId}}",
"in": "path",
"name": "includeId",
"required": true,
"schema": {
"example": "inc_175780",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/includeId-path.yaml"
}
},
{
"description": "Include's incremental version number.",
"example": "{{includeVersion}}",
"in": "path",
"name": "includeVersion",
"required": true,
"schema": {
"example": 3,
"type": "integer"
},
"x-akamai": {
"file-path": "parameters/includeVersion-path.yaml"
}
}
]
},
"/includes/{includeId}/versions/{includeVersion}/rules": {
"get": {
"description": "__Limited availability__ Gets the entire rule tree for an include version. See the [Rule Trees](https://techdocs.akamai.com/property-mgr/reference/rule-trees) section for details on the response object's structure. Also use this operation to update from one rule format to another more recent version, incrementing the assigned set of features. See [Update rules to a newer set of features](https://techdocs.akamai.com/property-mgr/reference/rule-format-schemas#update-rules-to-a-newer-set-of-features).",
"operationId": "get-include-version-rules",
"summary": "Akamai Get an Include's Rule Tree",
"tags": [
"Include version rules"
],
"externalDocs": {
"description": "See documentation for this operation in Akamai's Property Manager API",
"url": "https://techdocs.akamai.com/property-mgr/reference/get-include-version-rules"
},
"responses": {
"200": {
"description": "The response shows the rule tree for the requested include version.",
"content": {
"*/*": {
"example": {
"accountId": "act_A-CCT9012",
"contractId": "ctr_C-0N7RAC7",
"etag": "a9dfe78cf93090516bde891d009eaf57",
"groupId": "grp_12345",
"includeId": "inc_173136",
"includeName": "my.new.include.com",
"includeType": "MICROSERVICES",
"includeVersion": 3,
"ruleFormat": "v2022-10-18",
"rules": {
"name": "default",
"children": [],
"criteria": [],
"options": {
"is_secure": false
},
"behaviors": [
{
"name": "origin",
"options": {
"cacheKeyHostname": "ORIGIN_HOSTNAME",
"compress": true,
"enableTrueClientIp": false,
"forwardHostHeader": "REQUEST_HOST_HEADER",
"hostname": "origin.com",
"httpPort": 80,
"originType": "CUSTOMER"
}
},
{
"name": "cpCode",
"options": {
"value": {
"id": 12345,
"name": "my CP code"
}
}
}
]
}
},
"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/GetIncludeRuleResponse.json#",
"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"
},
"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"
},
"etag": {
"description": "A digest with which to check the [data's integrity](https://techdocs.akamai.com/property-mgr/reference/concurrency-control).",
"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": "Unique identifier for an include. 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.",
"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 `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": [
"COMMON_SETTINGS",
"MICROSERVICES"
]
},
"includeVersion": {
"description": "The version of the include that a rule tree represents.",
"minimum": 1,
"type": "integer"
},
"ruleFormat": {
"description": "Indicates the versioned set of features and criteria that are currently applied to a rule tree. See [API versioning](https://techdocs.akamai.com/property-mgr/reference/api-versioning) for more information.",
"type": "string"
},
"rules": {
"additionalProperties": false,
"description": "Specifies the executable logic to apply to cached edge content. The outer envelope's `rules` object specifies the relevant top-level `default` rule object. See the [Rule Trees](https://techdocs.akamai.com/property-mgr/reference/rule-trees) section for guidance on how to structure the data.",
"type": "object",
"required": [
"behaviors",
"name"
],
"properties": {
"options": {
"additionalProperties": false,
"description": "Flags that apply to the top-level rule object.",
"type": "object",
"properties": {
"is_secure": {
"description": "When enabled, serves the include's content over SSL. Doing so may enable additional rule behaviors.",
"type": "boolean"
}
}
},
"advancedOverride": {
"description": "A block of post-processing XML metadata that your Akamai representative can apply on your behalf. You need to configure this separately for each include. Use the more recent `customOverride` member to apply the same XML metadata to more than one include.",
"type": "string"
},
"behaviors": {
"description": "A series of [behavior](https://techdocs.akamai.com/property-mgr/reference/ga-behaviors) objects, which execute after the set of `criteria` evaluates. Behavior and criteria objects are structured identically. Optional on nested rules.",
"type": "array",
"items": {
"additionalProperties": false,
"type": "object",
"required": [
"name",
"options"
],
"properties": {
"options": {
"description": "A variable set of options that configure each behavior. See the [behavior](https://techdocs.akamai.com/property-mgr/reference/ga-behaviors) and [criteria](https://techdocs.akamai.com/property-mgr/reference/ga-criteria) reference for details on each.",
"type": "object"
},
"locked": {
"description": "Indicates a behavior or criteria that you arrange with your Akamai representative to lock. Typically, you prevent further modifications to protect sensitive data from erroneous changes.",
"type": "string"
},
"name": {
"description": "The name of the behavior.",
"type": "string"
},
"uuid": {
"description": "A data hash that indicates an _advanced_ behavior. When present, you may not modify the contents of the behavior, and need to provide the same `uuid` value when modifying the rule tree. See [Advanced and locked features](https://techdocs.akamai.com/property-mgr/reference/advanced-and-locked-features).",
"type": "string"
}
}
}
},
"children": {
"description": "A series of nested rules that execute after the current rule's `criteria` and `behaviors`.",
"minItems": 0,
"type": "array",
"items": {
"type": "object"
}
},
"comment": {
"description": "A descriptive comment to help you track the rule's function.",
"type": "string"
},
"criteria": {
"description": "A series of [criteria](https://techdocs.akamai.com/property-mgr/reference/ga-criteria) objects, which form a set of logical tests that may prevent the rule's `behaviors` from executing. Behavior and criteria objects are structured identically.",
"type": "array",
"items": {
"type": "object"
}
},
"criteriaLocked": {
"description": "Within child rules, this prohibits any modifications to `criteria` objects. Contact your Akamai representative to change the value.",
"type": "boolean"
},
"customOverride": {
"additionalProperties": false,
"description": "Specifies post-processing XML metadata that your Akamai representative can create on your behalf. Once available with the [List custom overrides](https://techdocs.akamai.com/property-mgr/reference/get-custom-overrides) operation, you can assign an `overrideId` to more than one include's `default` rule. See [Custom behaviors and overrides](https://techdocs.akamai.com/property-mgr/reference/custom-behaviors-and-overrides) for guidance.",
"type": "object",
"required": [
"name",
"overrideId"
],
"properties": {
"name": {
"description": "The name of the custom override. It may vary from what appears in the [List custom overrides](https://techdocs.akamai.com/property-mgr/reference/get-custom-overrides) operation's response object.",
"type": "string"
},
"overrideId": {
"description": "Identifies the predefined custom override metadata you want to append to the current rule. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on how to omit the ID's `cbo_` prefix.",
"type": "string"
}
}
},
"name": {
"description": "A description of the rule. The top-level rule needs to be named `default`.",
"type": "string"
},
"uuid": {
"description": "A data hash that indicates the rule contains at least one _advanced_ behavior or criteria, each identified with its own `uuid` member. When this member is present on the rule, you may not remove any advanced features it contains, or change their sequence. You need to provide the same `uuid` value when modifying the rule tree. See [Advanced and locked features](https://techdocs.akamai.com/property-mgr/reference/advanced-and-locked-features).",
"type": "string"
},
"variables": {
"description": "Declares a variable. See [Variables](https://techdocs.akamai.com/property-mgr/reference/variables) for guidance on how variables may appear within a rule tree.",
"type": "array",
"items": {
"additionalProperties": false,
"type": "object",
"required": [
"hidden",
"name",
"sensitive"
],
"properties": {
"description": {
"description": "Text for you to keep track of how you use each variable.",
"type": "string"
},
"hidden": {
"description": "When enabled, the variable is suppressed from session response headers. Useful when testing content as described in the [Debug variables](https://techdocs.akamai.com/property-mgr/reference/debug-variables) section.",
"type": "boolean"
},
"name": {
"description": "The underlying root name of the variable, which needs to be unique within the set of `variables`.",
"type": "string"
},
"sensitive": {
"description": "When enabled, the variable is suppressed from session responses as `hidden` ones, but it also can't be invoked within any behaviors that assign values to cookies or response headers. You also can't assign a `sensitive` variable to another one that isn't `sensitive`, and you can't add it to custom logging fields. Use this more stringent option for any personally identifiable information, typically after initially testing on the staging network.",
"type": "boolean"
},
"value": {
"description": "Initializes a default value. Omitting this member initializes the variable with an empty string.",
"type": "string"
}
}
}
}
}
}
},
"x-akamai": {
"file-path": "schemas/include-version-rules-get-response.yaml"
}
}
}
},
"headers": {
"ETag": {
"description": "Pass the `ETag` response header back as `If-Match` in write requests to ensure you don't overwrite edits by any other API clients. See [Concurrency control](https://techdocs.akamai.com/property-mgr/reference/concurrency-control) for details.",
"example": "\"a9dfe78cf93090516bde891d009eaf57\"",
"schema": {
"type": "string"
},
"x-akamai": {
"file-path": "headers/Etag.yaml"
}
},
"X-Limit-Clientip-Per-Include-Limit": {
"description": "Maximum number of separate [Client IP](https://techdocs.akamai.com/property-mgr/reference/latest-client-ip) matches per include.",
"schema": {
"type": "string"
},
"x-akamai": {
"file-path": "headers/X-Limit-Clientip-Per-Include-Limit.yaml"
}
},
"X-Limit-Clientip-Per-Include-Remaining": {
"description": "Remaining number of separate [Client IP](https://techdocs.akamai.com/property-mgr/reference/latest-client-ip) matches per include. See [Rate and resource limiting](https://techdocs.akamai.com/property-mgr/reference/rate-and-resource-limiting) for details.",
"schema": {
"type": "string"
},
"x-akamai": {
"file-path": "headers/X-Limit-Clientip-Per-Include-Remaining.yaml"
}
},
"X-Limit-Elements-Per-Include-Limit": {
"description": "Maximum number of separate matches and behaviors per include. See [Rate and resource limiting](https://techdocs.akamai.com/property-mgr/reference/rate-and-resource-limiting) for details.",
"schema": {
"type": "string"
},
"x-akamai": {
"file-path": "headers/X-Limit-Elements-Per-Include-Limit.yaml"
}
},
"X-Limit-Elements-Per-Include-Remaining": {
"description": "Remaining number of separate matches and behaviors per include. See [Rate and resource limiting](https://techdocs.akamai.com/property-mgr/reference/rate-and-resource-limiting) for details.",
"schema": {
"type": "string"
},
"x-akamai": {
"file-path": "headers/X-Limit-Elements-Per-Include-Remaining.yaml"
}
},
"X-Limit-Max-Clientip-Per-Match-Limit": {
"description": "Maximum number of separate IP addresses allowed within each [Client IP](https://techdocs.akamai.com/property-mgr/reference/latest-client-ip) match.",
"schema": {
"type": "string"
},
"x-akamai": {
"file-path": "headers/X-Limit-Max-Clientip-Per-Match-Limit.yaml"
}
},
"X-Limit-Max-Clientip-Per-Match-Remaining": {
"description": "Remaining number of separate IP addresses allowed within each [Client IP](https://techdocs.akamai.com/property-mgr/reference/latest-client-ip) match. See [Rate and resource limiting](https://techdocs.akamai.com/property-mgr/reference/rate-and-resource-limiting) for details.",
"schema": {
"type": "string"
},
"x-akamai": {
"file-path": "headers/X-Limit-Max-Clientip-Per-Match-Remaining.yaml"
}
},
"X-Limit-Max-Nested-Rules-Per-Include-Limit": {
"description": "Maximum number of nested rules within any include.",
"schema": {
"type": "string"
},
"x-akamai": {
"file-path": "headers/X-Limit-Max-Nested-Rules-Per-Include-Limit.yaml"
}
},
"X-Limit-Max-Nested-Rules-Per-Include-Remaining": {
"description": "Remaining number of nested child rules within an include to apply conditional logic. See [Rate and resource limiting](https://techdocs.akamai.com/property-mgr/reference/rate-and-resource-limiting) for details.",
"schema": {
"type": "string"
},
"x-akamai": {
"file-path": "headers/X-Limit-Max-Nested-Rules-Per-Include-Remaining.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"
}
},
"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"
}
}
},
"x-akamai": {
"status": "LA"
},
"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": "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.",
"example": "{{contractId}}",
"in": "query",
"name": "contractId",
"required": false,
"schema": {
"example": "ctr_1-1TJZFW",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/contractId-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.",
"example": "{{groupId}}",
"in": "query",
"name": "groupId",
"required": false,
"schema": {
"example": "grp_15166",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/groupId-optional.yaml"
}
},
{
"description": "Set to `true` by default. When `false`, skips validation tests that would identify potential problems within the response object's `errors` and `warnings` arrays. See [Rule tree errors and warnings](https://techdocs.akamai.com/property-mgr/reference/rule-tree-errors-and-warnings) and [Validation errors](https://techdocs.akamai.com/property-mgr/reference/validation-errors) for information on how validation data appears in the response object. See [Validation best practices](https://techdocs.akamai.com/property-mgr/reference/validation-best-practices) for guidance on when to defer validation.",
"example": "{{validateRules}}",
"in": "query",
"name": "validateRules",
"required": false,
"schema": {
"default": true,
"example": true,
"type": "boolean"
},
"x-akamai": {
"file-path": "parameters/validateRules-query.yaml"
}
},
{
"description": "__Enum__ With `validateRules` enabled, setting this to `fast` performs a quick validation check based on the provided JSON. This is faster than the default `full` validation, which performs more extensive checks on the converted XML metadata configuration. See [Validation best practices](https://techdocs.akamai.com/property-mgr/reference/validation-best-practices) for more guidance.",
"example": "{{validateMode}}",
"in": "query",
"name": "validateMode",
"required": false,
"schema": {
"default": "full",
"example": "fast",
"type": "string",
"enum": [
"full",
"fast"
]
},
"x-akamai": {
"file-path": "parameters/validateMode-query.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"
}
}
]
},
"put": {
"description": "__Limited availability__ To write a rule tree to an include version, make a PUT request to the same resource as the GET request that reads it, passing in the rule object in the body of the request. See the [Rule Trees](https://techdocs.akamai.com/property-mgr/reference/rule-trees) section for details on the rule tree's structure. Use this operation also to [freeze a set of rules](https://techdocs.akamai.com/property-mgr/reference/rule-format-schemas#freeze-a-feature-set-for-a-rule-tree) to a rule format version to ensure no change in a deployed activation's behavior. Set the `validateRules` query parameter to `false` to bypass a set of validation tests that may significantly slow this operation's execution time. See [Validation best practices](https://techdocs.akamai.com/property-mgr/reference/validation-best-practices) for guidance on when to defer validation. See [Rule tree errors and warnings](https://techdocs.akamai.com/property-mgr/reference/rule-tree-errors-and-warnings) and [Validation errors](https://techdocs.akamai.com/property-mgr/reference/validation-errors) for information on how validation data is embedded within the response object.",
"operationId": "put-include-version-rules",
"summary": "Akamai Update an Include's Rule Tree",
"tags": [
"Include version rules"
],
"externalDocs": {
"description": "See documentation for this operation in Akamai's Property Manager API",
"url": "https://techdocs.akamai.com/property-mgr/reference/put-include-version-rules"
},
"requestBody": {
"required": true,
"content": {
"*/*": {
"example": {
"rules": {
"name": "default",
"children": [],
"criteria": [],
"options": {
"is_secure": false
},
"behaviors": [
{
"name": "origin",
"options": {
"cacheKeyHostname": "ORIGIN_HOSTNAME",
"compress": true,
"enableTrueClientIp": false,
"forwardHostHeader": "REQUEST_HOST_HEADER",
"hostname": "origin.test.com",
"httpPort": 80,
"originType": "CUSTOMER"
}
},
{
"name": "cpCode",
"options": {
"value": {
"id": 12345,
"name": "my CP code"
}
}
}
]
}
},
"schema": {
"$schema": "http://json-schema.org/draft-04-schema#",
"description": "Specifies the executable logic to apply to cached edge content.",
"id": "resource:/descriptors/papi/v1/schemas/property-version-rules-set-request.json#",
"javaType": "com.fasterxml.jackson.databind.JsonNode",
"type": "object",
"properties": {
"rules": {
"description": "Specifies the executable logic to apply to cached edge content. A common outer wrapping `rules` object specifies the relevant top-level `default` rule object. See the [Rule Trees](https://techdocs.akamai.com/property-mgr/reference/rule-trees) section for guidance on how to structure the data.",
"type": "object",
"required": [
"name",
"behaviors"
],
"properties": {
"options": {
"description": "Flags that apply to the top-level rule object.",
"type": "object",
"properties": {
"is_secure": {
"description": "When enabled, serves the property's content over SSL. Doing so may enable additional rule behaviors.",
"type": "boolean"
}
}
},
"advancedOverride": {
"description": "A block of post-processing XML metadata that your Akamai representative can apply on your behalf. You need to configure this separately for each property. Use the more recent `customOverride` member to apply the same XML metadata to more than one property.",
"type": "string"
},
"behaviors": {
"description": "A series of [behavior](https://techdocs.akamai.com/property-mgr/reference/ga-behaviors) objects, which execute after the set of `criteria` evaluates. Behavior and criteria objects are structured identically. Optional on nested rules.",
"type": "array",
"items": {
"type": "object",
"required": [
"name",
"options"
],
"properties": {
"options": {
"description": "A variable set of options that configure each behavior. See the [PAPI Feature Catalog Reference](https://techdocs.akamai.com/property-mgr/reference/ga-behaviors) for details on each.",
"type": "object"
},
"locked": {
"description": "Indicates a behavior or criteria that you arrange with your Akamai representative to lock. Typically, you prevent further modifications to protect sensitive data from erroneous changes.",
"type": "string"
},
"name": {
"description": "The name of the behavior.",
"type": "string"
},
"uuid": {
"description": "A data hash that indicates an _advanced_ behavior. When present, you may not modify the contents of the behavior, and need to provide the same `uuid` value when modifying the rule tree. See [Advanced and locked features](https://techdocs.akamai.com/property-mgr/reference/advanced-and-locked-features).",
"readOnly": true,
"type": "string"
}
}
}
},
"children": {
"description": "A series of nested rules that execute after the current rule's `criteria` and `behaviors`.",
"type": "array",
"items": {
"description": "A series of nested rules that execute after the current rule's `criteria` and `behaviors`.",
"type": "object"
}
},
"comment": {
"description": "A descriptive comment to help you track the rule's function.",
"type": "string"
},
"criteria": {
"description": "A series of [criteria](https://techdocs.akamai.com/property-mgr/reference/ga-criteria) objects, which form a set of logical tests that may prevent the rule's `behaviors` from executing. Behavior and criteria objects are structured identically.",
"type": "array",
"items": {
"description": "A series of [criteria](https://techdocs.akamai.com/property-mgr/reference/ga-criteria) objects, which form a set of logical tests that may prevent the rule's `behaviors` from executing. Behavior and criteria objects are structured identically.",
"type": "object"
}
},
"criteriaLocked": {
"description": "Within child rules, this prohibits any modifications to `criteria` objects. Contact your Akamai representative to change the value.",
"readOnly": true,
"type": "boolean"
},
"customOverride": {
"description": "Specifies post-processing XML metadata that your Akamai representative can create on your behalf. Once available with the [List custom overrides](https://techdocs.akamai.com/property-mgr/reference/get-custom-overrides) operation, you can assign an `overrideId` to more than one property's `default` rule. See [Custom behaviors and overrides](https://techdocs.akamai.com/property-mgr/reference/custom-behaviors-and-overrides) for guidance.",
"type": "object",
"required": [
"overrideId",
"name"
],
"properties": {
"name": {
"description": "The name of the custom override. It may vary from what appears in the [List custom overrides](https://techdocs.akamai.com/property-mgr/reference/get-custom-overrides) operation's response object.",
"type": "string"
},
"overrideId": {
"description": "Identifies the predefined custom override metadata you want to append to the current rule. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on how to omit the ID's `cbo_` prefix.",
"type": "string"
}
}
},
"name": {
"description": "A description of the rule. The top-level rule needs to be named `default`.",
"type": "string"
},
"uuid": {
"description": "A data hash that indicates the rule contains at least one _advanced_ behavior or criteria, each identified with its own `uuid` member. When this member is present on the rule, you may not remove any advanced features it contains, or change their sequence. You need to provide the same `uuid` value when modifying the rule tree. See [Advanced and locked features](https://techdocs.akamai.com/property-mgr/reference/advanced-and-locked-features).",
"type": "string"
},
"variables": {
"description": "Declares a variable. See [Variables](https://techdocs.akamai.com/property-mgr/reference/variables) for guidance on how variables may appear within a rule tree.",
"type": "array",
"items": {
"type": "object",
"required": [
"name",
"hidden",
"sensitive"
],
"properties": {
"description": {
"description": "Text for you to keep track of how you use each variable.",
"type": "string"
},
"hidden": {
"description": "When enabled, the variable is suppressed from session response headers. Useful when testing content as described in the [Debug variables](https://techdocs.akamai.com/property-mgr/reference/debug-variables) section.",
"type": "boolean"
},
"name": {
"description": "The underlying root name of the variable, which needs to be unique within the set of `variables`.",
"type": "string"
},
"sensitive": {
"description": "When enabled, the variable is suppressed from session responses as `hidden` ones, but it also can't be invoked within any behaviors that assign values to cookies or response headers. You also can't assign a `sensitive` variable to another one that isn't `sensitive`, and you can't add it to custom logging fields. Use this more stringent option for any personally identifiable information, typically after initially testing on the staging network.",
"type": "boolean"
},
"value": {
"description": "Initializes a default value. Omitting this member initializes the variable with an empty string.",
"type": "string"
}
}
}
}
}
}
},
"x-akamai": {
"file-path": "schemas/property-version-rules-set-request.yaml"
}
}
},
"application/json": {
"example": {
"rules": {
"name": "default",
"children": [],
"criteria": [],
"options": {
"is_secure": false
},
"behaviors": [
{
"name": "origin",
"options": {
"cacheKeyHostname": "ORIGIN_HOSTNAME",
"compress": true,
"enableTrueClientIp": false,
"forwardHostHeader": "REQUEST_HOST_HEADER",
"hostname": "origin.test.com",
"httpPort": 80,
"originType": "CUSTOMER"
}
},
{
"name": "cpCode",
"options": {
"value": {
"id": 12345,
"name": "my CP code"
}
}
}
]
}
},
"schema": {
"$schema": "http://json-schema.org/draft-04-schema#",
"description": "Specifies the executable logic to apply to cached edge content.",
"id": "resource:/descriptors/papi/v1/schemas/property-version-rules-set-request.json#",
"javaType": "com.fasterxml.jackson.databind.JsonNode",
"type": "object",
"properties": {
"rules": {
"description": "Specifies the executable logic to apply to cached edge content. A common outer wrapping `rules` object specifies the relevant top-level `default` rule object. See the [Rule Trees](https://techdocs.akamai.com/property-mgr/reference/rule-trees) section for guidance on how to structure the data.",
"type": "object",
"required": [
"name",
"behaviors"
],
"properties": {
"options": {
"description": "Flags that apply to the top-level rule object.",
"type": "object",
"properties": {
"is_secure": {
"description": "When enabled, serves the property's content over SSL. Doing so may enable additional rule behaviors.",
"type": "boolean"
}
}
},
"advancedOverride": {
"description": "A block of post-processing XML metadata that your Akamai representative can apply on your behalf. You need to configure this separately for each property. Use the more recent `customOverride` member to apply the same XML metadata to more than one property.",
"type": "string"
},
"behaviors": {
"description": "A series of [behavior](https://techdocs.akamai.com/property-mgr/reference/ga-behaviors) objects, which execute after the set of `criteria` evaluates. Behavior and criteria objects are structured identically. Optional on nested rules.",
"type": "array",
"items": {
"type": "object",
"required": [
"name",
"options"
],
"properties": {
"options": {
"description": "A variable set of options that configure each behavior. See the [PAPI Feature Catalog Reference](https://techdocs.akamai.com/property-mgr/reference/ga-behaviors) for details on each.",
"type": "object"
},
"locked": {
"description": "Indicates a behavior or criteria that you arrange with your Akamai representative to lock. Typically, you prevent further modifications to protect sensitive data from erroneous changes.",
"type": "string"
},
"name": {
"description": "The name of the behavior.",
"type": "string"
},
"uuid": {
"description": "A data hash that indicates an _advanced_ behavior. When present, you may not modify the contents of the behavior, and need to provide the same `uuid` value when modifying the rule tree. See [Advanced and locked features](https://techdocs.akamai.com/property-mgr/reference/advanced-and-locked-features).",
"readOnly": true,
"type": "string"
}
}
}
},
"children": {
"description": "A series of nested rules that execute after the current rule's `criteria` and `behaviors`.",
"type": "array",
"items": {
"description": "A series of nested rules that execute after the current rule's `criteria` and `behaviors`.",
"type": "object"
}
},
"comment": {
"description": "A descriptive comment to help you track the rule's function.",
"type": "string"
},
"criteria": {
"description": "A series of [criteria](https://techdocs.akamai.com/property-mgr/reference/ga-criteria) objects, which form a set of logical tests that may prevent the rule's `behaviors` from executing. Behavior and criteria objects are structured identically.",
"type": "array",
"items": {
"description": "A series of [criteria](https://techdocs.akamai.com/property-mgr/reference/ga-criteria) objects, which form a set of logical tests that may prevent the rule's `behaviors` from executing. Behavior and criteria objects are structured identically.",
"type": "object"
}
},
"criteriaLocked": {
"description": "Within child rules, this prohibits any modifications to `criteria` objects. Contact your Akamai representative to change the value.",
"readOnly": true,
"type": "boolean"
},
"customOverride": {
"description": "Specifies post-processing XML metadata that your Akamai representative can create on your behalf. Once available with the [List custom overrides](https://techdocs.akamai.com/property-mgr/reference/get-custom-overrides) operation, you can assign an `overrideId` to more than one property's `default` rule. See [Custom behaviors and overrides](https://techdocs.akamai.com/property-mgr/reference/custom-behaviors-and-overrides) for guidance.",
"type": "object",
"required": [
"overrideId",
"name"
],
"properties": {
"name": {
"description": "The name of the custom override. It may vary from what appears in the [List custom overrides](https://techdocs.akamai.com/property-mgr/reference/get-custom-overrides) operation's response object.",
"type": "string"
},
"overrideId": {
"description": "Identifies the predefined custom override metadata you want to append to the current rule. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on how to omit the ID's `cbo_` prefix.",
"type": "string"
}
}
},
"name": {
"description": "A description of the rule. The top-level rule needs to be named `default`.",
"type": "string"
},
"uuid": {
"description": "A data hash that indicates the rule contains at least one _advanced_ behavior or criteria, each identified with its own `uuid` member. When this member is present on the rule, you may not remove any advanced features it contains, or change their sequence. You need to provide the same `uuid` value when modifying the rule tree. See [Advanced and locked features](https://techdocs.akamai.com/property-mgr/reference/advanced-and-locked-features).",
"type": "string"
},
"variables": {
"description": "Declares a variable. See [Variables](https://techdocs.akamai.com/property-mgr/reference/variables) for guidance on how variables may appear within a rule tree.",
"type": "array",
"items": {
"type": "object",
"required": [
"name",
"hidden",
"sensitive"
],
"properties": {
"description": {
"description": "Text for you to keep track of how you use each variable.",
"type": "string"
},
"hidden": {
"description": "When enabled, the variable is suppressed from session response headers. Useful when testing content as described in the [Debug variables](https://techdocs.akamai.com/property-mgr/reference/debug-variables) section.",
"type": "boolean"
},
"name": {
"description": "The underlying root name of the variable, which needs to be unique within the set of `variables`.",
"type": "string"
},
"sensitive": {
"description": "When enabled, the variable is suppressed from session responses as `hidden` ones, but it also can't be invoked within any behaviors that assign values to cookies or response headers. You also can't assign a `sensitive` variable to another one that isn't `sensitive`, and you can't add it to custom logging fields. Use this more stringent option for any personally identifiable information, typically after initially testing on the staging network.",
"type": "boolean"
},
"value": {
"description": "Initializes a default value. Omitting this member initializes the variable with an empty string.",
"type": "string"
}
}
}
}
}
}
},
"x-akamai": {
"file-path": "schemas/property-version-rules-set-request.yaml"
}
}
}
}
},
"responses": {
"200": {
"description": "The response shows updated rule tree for the specified include version.",
"content": {
"*/*": {
"example": {
"accountId": "act_A-CCT7890",
"contractId": "ctr_K-0N7RAK7",
"etag": "a9dfe78cf93090516bde891d009eaf57",
"groupId": "grp_12345",
"includeId": "inc_173136",
"includeName": "my.new.include.com",
"includeType": "MICROSERVICES",
"includeVersion": 3,
"ruleFormat": "v2022-10-18",
"rules": {
"name": "default",
"children": [],
"criteria": [],
"options": {
"is_secure": false
},
"behaviors": [
{
"name": "origin",
"options": {
"cacheKeyHostname": "ORIGIN_HOSTNAME",
"compress": true,
"enableTrueClientIp": false,
"forwardHostHeader": "REQUEST_HOST_HEADER",
"hostname": "origin.com",
"httpPort": 80,
"originType": "CUSTOMER"
}
},
{
"name": "cpCode",
"options": {
"value": {
"id": 12345,
"name": "my CP code"
}
}
}
]
}
},
"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/GetIncludeRuleResponse.json#",
"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"
},
"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"
},
"etag": {
"description": "A digest with which to check the [data's integrity](https://techdocs.akamai.com/property-mgr/reference/concurrency-control).",
"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": "Unique identifier for an include. 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.",
"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 `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": [
"COMMON_SETTINGS",
"MICROSERVICES"
]
},
"includeVersion": {
"description": "The version of the include that a rule tree represents.",
"minimum": 1,
"type": "integer"
},
"ruleFormat": {
"description": "Indicates the versioned set of features and criteria that are currently applied to a rule tree. See [API versioning](https://techdocs.akamai.com/property-mgr/reference/api-versioning) for more information.",
"type": "string"
},
"rules": {
"additionalProperties": false,
"description": "Specifies the executable logic to apply to cached edge content. The outer envelope's `rules` object specifies the relevant top-level `default` rule object. See the [Rule Trees](https://techdocs.akamai.com/property-mgr/reference/rule-trees) section for guidance on how to structure the data.",
"type": "object",
"required": [
"behaviors",
"name"
],
"properties": {
"options": {
"additionalProperties": false,
"description": "Flags that apply to the top-level rule object.",
"type": "object",
"properties": {
"is_secure": {
"description": "When enabled, serves the include's content over SSL. Doing so may enable additional rule behaviors.",
"type": "boolean"
}
}
},
"advancedOverride": {
"description": "A block of post-processing XML metadata that your Akamai representative can apply on your behalf. You need to configure this separately for each include. Use the more recent `customOverride` member to apply the same XML metadata to more than one include.",
"type": "string"
},
"behaviors": {
"description": "A series of [behavior](https://techdocs.akamai.com/property-mgr/reference/ga-behaviors) objects, which execute after the set of `criteria` evaluates. Behavior and criteria objects are structured identically. Optional on nested rules.",
"type": "array",
"items": {
"additionalProperties": false,
"type": "object",
"required": [
"name",
"options"
],
"properties": {
"options": {
"description": "A variable set of options that configure each behavior. See the [behavior](https://techdocs.akamai.com/property-mgr/reference/ga-behaviors) and [criteria](https://techdocs.akamai.com/property-mgr/reference/ga-criteria) reference for details on each.",
"type": "object"
},
"locked": {
"description": "Indicates a behavior or criteria that you arrange with your Akamai representative to lock. Typically, you prevent further modifications to protect sensitive data from erroneous changes.",
"type": "string"
},
"name": {
"description": "The name of the behavior.",
"type": "string"
},
"uuid": {
"description": "A data hash that indicates an _advanced_ behavior. When present, you may not modify the contents of the behavior, and need to provide the same `uuid` value when modifying the rule tree. See [Advanced and locked features](https://techdocs.akamai.com/property-mgr/reference/advanced-and-locked-features).",
"type": "string"
}
}
}
},
"children": {
"description": "A series of nested rules that execute after the current rule's `criteria` and `behaviors`.",
"minItems": 0,
"type": "array",
"items": {
"type": "object"
}
},
"comment": {
"description": "A descriptive comment to help you track the rule's function.",
"type": "string"
},
"criteria": {
"description": "A series of [criteria](https://techdocs.akamai.com/property-mgr/reference/ga-criteria) objects, which form a set of logical tests that may prevent the rule's `behaviors` from executing. Behavior and criteria objects are structured identically.",
"type": "array",
"items": {
"type": "object"
}
},
"criteriaLocked": {
"description": "Within child rules, this prohibits any modifications to `criteria` objects. Contact your Akamai representative to change the value.",
"type": "boolean"
},
"customOverride": {
"additionalProperties": false,
"description": "Specifies post-processing XML metadata that your Akamai representative can create on your behalf. Once available with the [List custom overrides](https://techdocs.akamai.com/property-mgr/reference/get-custom-overrides) operation, you can assign an `overrideId` to more than one include's `default` rule. See [Custom behaviors and overrides](https://techdocs.akamai.com/property-mgr/reference/custom-behaviors-and-overrides) for guidance.",
"type": "object",
"required": [
"name",
"overrideId"
],
"properties": {
"name": {
"description": "The name of the custom override. It may vary from what appears in the [List custom overrides](https://techdocs.akamai.com/property-mgr/reference/get-custom-overrides) operation's response object.",
"type": "string"
},
"overrideId": {
"description": "Identifies the predefined custom override metadata you want to append to the current rule. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on how to omit the ID's `cbo_` prefix.",
"type": "string"
}
}
},
"name": {
"description": "A description of the rule. The top-level rule needs to be named `default`.",
"type": "string"
},
"uuid": {
"description": "A data hash that indicates the rule contains at least one _advanced_ behavior or criteria, each identified with its own `uuid` member. When this member is present on the rule, you may not remove any advanced features it contains, or change their sequence. You need to provide the same `uuid` value when modifying the rule tree. See [Advanced and locked features](https://techdocs.akamai.com/property-mgr/reference/advanced-and-locked-features).",
"type": "string"
},
"variables": {
"description": "Declares a variable. See [Variables](https://techdocs.akamai.com/property-mgr/reference/variables) for guidance on how variables may appear within a rule tree.",
"type": "array",
"items": {
"additionalProperties": false,
"type": "object",
"required": [
"hidden",
"name",
"sensitive"
],
"properties": {
"description": {
"description": "Text for you to keep track of how you use each variable.",
"type": "string"
},
"hidden": {
"description": "When enabled, the variable is suppressed from session response headers. Useful when testing content as described in the [Debug variables](https://techdocs.akamai.com/property-mgr/reference/debug-variables) section.",
"type": "boolean"
},
"name": {
"description": "The underlying root name of the variable, which needs to be unique within the set of `variables`.",
"type": "string"
},
"sensitive": {
"description": "When enabled, the variable is suppressed from session responses as `hidden` ones, but it also can't be invoked within any behaviors that assign values to cookies or response headers. You also can't assign a `sensitive` variable to another one that isn't `sensitive`, and you can't add it to custom logging fields. Use this more stringent option for any personally identifiable information, typically after initially testing on the staging network.",
"type": "boolean"
},
"value": {
"description": "Initializes a default value. Omitting this member initializes the variable with an empty string.",
"type": "string"
}
}
}
}
}
}
},
"x-akamai": {
"file-path": "schemas/include-version-rules-get-response.yaml"
}
}
}
},
"headers": {
"ETag": {
"description": "Pass the `ETag` response header back as `If-Match` in write requests to ensure you don't overwrite edits by any other API clients. See [Concurrency control](https://techdocs.akamai.com/property-mgr/reference/concurrency-control) for details.",
"example": "\"a9dfe78cf93090516bde891d009eaf57\"",
"schema": {
"type": "string"
},
"x-akamai": {
"file-path": "headers/Etag.yaml"
}
},
"X-Limit-Clientip-Per-Property-Limit": {
"description": "Maximum number of separate [Client IP](https://techdocs.akamai.com/property-mgr/reference/latest-client-ip) matches per property rule tree configuration.",
"schema": {
"type": "string"
},
"x-akamai": {
"file-path": "headers/X-Limit-Clientip-Per-Property-Limit.yaml"
}
},
"X-Limit-Clientip-Per-Property-Remaining": {
"description": "Remaining number of separate [Client IP](https://techdocs.akamai.com/property-mgr/reference/latest-client-ip) matches per property rule tree configuration. See [Rate and resource limiting](https://techdocs.akamai.com/property-mgr/reference/rate-and-resource-limiting) for details.",
"schema": {
"type": "string"
},
"x-akamai": {
"file-path": "headers/X-Limit-Clientip-Per-Property-Remaining.yaml"
}
},
"X-Limit-Elements-Per-Property-Limit": {
"description": "Maximum number of separate matches and behaviors per property rule tree configuration. See [Rate and resource limiting](https://techdocs.akamai.com/property-mgr/reference/rate-and-resource-limiting) for details.",
"schema": {
"type": "string"
},
"x-akamai": {
"file-path": "headers/X-Limit-Elements-Per-Property-Limit.yaml"
}
},
"X-Limit-Elements-Per-Property-Remaining": {
"description": "Remaining number of separate matches and behaviors per property rule tree configuration. See [Rate and resource limiting](https://techdocs.akamai.com/property-mgr/reference/rate-and-resource-limiting) for details.",
"schema": {
"type": "string"
},
"x-akamai": {
"file-path": "headers/X-Limit-Elements-Per-Property-Remaining.yaml"
}
},
"X-Limit-Max-Clientip-Per-Match-Limit": {
"description": "Maximum number of separate IP addresses allowed within each [Client IP](https://techdocs.akamai.com/property-mgr/reference/latest-client-ip) match.",
"schema": {
"type": "string"
},
"x-akamai": {
"file-path": "headers/X-Limit-Max-Clientip-Per-Match-Limit.yaml"
}
},
"X-Limit-Max-Clientip-Per-Match-Remaining": {
"description": "Remaining number of separate IP addresses allowed within each [Client IP](https://techdocs.akamai.com/property-mgr/reference/latest-client-ip) match. See [Rate and resource limiting](https://techdocs.akamai.com/property-mgr/reference/rate-and-resource-limiting) for details.",
"schema": {
"type": "string"
},
"x-akamai": {
"file-path": "headers/X-Limit-Max-Clientip-Per-Match-Remaining.yaml"
}
},
"X-Limit-Max-Nested-Rules-Limit": {
"description": "Maximum number of nested child rules in a property to apply conditional logic.",
"schema": {
"type": "string"
},
"x-akamai": {
"file-path": "headers/X-Limit-Max-Nested-Rules-Limit.yaml"
}
},
"X-Limit-Max-Nested-Rules-Remaining": {
"description": "Remaining number of nested child rules in a property to apply conditional logic. See [Rate and resource limiting](https://techdocs.akamai.com/property-mgr/reference/rate-and-resource-limiting) for details.",
"schema": {
"type": "string"
},
"x-akamai": {
"file-path": "headers/X-Limit-Max-Nested-Rules-Remaining.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"
}
},
"412": {
"description": "[Precondition failed](https://techdocs.akamai.com/property-mgr/reference/412).",
"content": {
"application/problem+json": {
"example": {
"detail": "Cannot activate the property at this time, please try again.",
"instance": "papi/v1/properties/prp_123456/activations?contractId=ctr_C-0N7RAC7&groupId=grp_12345#abc12345abcc02a7",
"status": 412,
"title": "Precondition Failed",
"type": "https://problems.luna.akamaiapis.net/papi/v0/toolkit/validation_failed.error.activation.tower_precondition.failed"
},
"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/412.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"
}
}
},
"x-akamai": {
"status": "LA"
},
"parameters": [
{
"description": "This corresponds to the `ETag` response header. Passing this value back as `If-Match` in write requests ensures you don't overwrite edits by any other API clients. See [Concurrency control](https://techdocs.akamai.com/property-mgr/reference/concurrency-control) for details.",
"example": "{{If-Match}}",
"in": "header",
"name": "If-Match",
"required": true,
"schema": {
"example": "\"a9dfe78cf93090516bde891d009eaf57\"",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/If-Match-header.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.",
"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": "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.",
"example": "{{contractId}}",
"in": "query",
"name": "contractId",
"required": false,
"schema": {
"example": "ctr_1-1TJZFW",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/contractId-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.",
"example": "{{groupId}}",
"in": "query",
"name": "groupId",
"required": false,
"schema": {
"example": "grp_15166",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/groupId-optional.yaml"
}
},
{
"description": "Set to `true` by default. When `false`, skips validation tests that would identify potential problems within the response object's `errors` and `warnings` arrays. See [Rule tree errors and warnings](https://techdocs.akamai.com/property-mgr/reference/rule-tree-errors-and-warnings) and [Validation errors](https://techdocs.akamai.com/property-mgr/reference/validation-errors) for information on how validation data appears in the response object. See [Validation best practices](https://techdocs.akamai.com/property-mgr/reference/validation-best-practices) for guidance on when to defer validation.",
"example": "{{validateRules}}",
"in": "query",
"name": "validateRules",
"required": false,
"schema": {
"default": true,
"example": true,
"type": "boolean"
},
"x-akamai": {
"file-path": "parameters/validateRules-query.yaml"
}
},
{
"description": "__Enum__ With `validateRules` enabled, setting this to `fast` performs a quick validation check based on the provided JSON. This is faster than the default `full` validation, which performs more extensive checks on the converted XML metadata configuration. See [Validation best practices](https://techdocs.akamai.com/property-mgr/reference/validation-best-practices) for more guidance.",
"example": "{{validateMode}}",
"in": "query",
"name": "validateMode",
"required": false,
"schema": {
"default": "full",
"example": "fast",
"type": "string",
"enum": [
"full",
"fast"
]
},
"x-akamai": {
"file-path": "parameters/validateMode-query.yaml"
}
},
{
"description": "With the `validateRules` query parameter also enabled, allows for a _dry run_ in order to gather any possible errors without saving the rule tree. See [Validation best practices](https://techdocs.akamai.com/property-mgr/reference/validation-best-practices) for more guidance.",
"example": "{{dryRun}}",
"in": "query",
"name": "dryRun",
"required": false,
"schema": {
"default": false,
"example": true,
"type": "boolean"
},
"x-akamai": {
"file-path": "parameters/dryRun-query.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"
}
}
]
},
"patch": {
"description": "__Limited availability__ Selectively modify a rule tree using [JSON patch](http://jsonpatch.com) syntax. Set the `validateRules` query parameter to `false` to bypass a set of validation tests that may significantly slow this operation's execution time. See [Validation best practices](https://techdocs.akamai.com/property-mgr/reference/validation-best-practices) for guidance on when to defer validation. See [Rule tree errors and warnings](https://techdocs.akamai.com/property-mgr/reference/rule-tree-errors-and-warnings) and [Validation errors](https://techdocs.akamai.com/property-mgr/reference/validation-errors) for information on how validation data is embedded within the response object.",
"operationId": "patch-include-version-rules",
"summary": "Akamai Patch an Include's Rule Tree",
"tags": [
"Include version rules"
],
"externalDocs": {
"description": "See documentation for this operation in Akamai's Property Manager API",
"url": "https://techdocs.akamai.com/property-mgr/reference/patch-include-version-rules"
},
"requestBody": {
"required": true,
"content": {
"application/json-patch+json": {
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "The series of JSON Patch operations.",
"id": "resource:/descriptors/papi/v1/schemas/property-version-rules-patch-request.json#",
"javaType": "com.fasterxml.jackson.databind.JsonNode",
"type": "array",
"items": {
"type": "object",
"required": [
"op",
"path"
],
"x-akamai": {
"file-path": "schemas/operation.yaml"
},
"allOf": [
{
"type": "object",
"properties": {
"path": {
"description": "A JSON Pointer path.",
"type": "string"
}
},
"x-akamai": {
"file-path": "schemas/path.yaml"
}
}
],
"oneOf": [
{
"title": "Replace, add, test",
"required": [
"value"
],
"properties": {
"op": {
"description": "The operation to perform: `replace`, `add`, or `test` in this case.",
"type": "string",
"enum": [
"replace",
"test",
"add"
]
},
"value": {
"description": "The value to replace, test, or add. Specify any data type.",
"oneOf": [
{
"title": "String",
"type": "string"
},
{
"title": "Numeric",
"type": "number"
},
{
"title": "Boolean",
"type": "boolean"
},
{
"title": "Object",
"type": "object"
},
{
"title": "Array",
"type": "array",
"items": {
"anyOf": [
{
"title": "String",
"type": "string"
},
{
"title": "Numeric",
"type": "number"
},
{
"title": "Boolean",
"type": "boolean"
},
{
"title": "Object",
"type": "object"
}
]
}
}
]
}
}
},
{
"title": "Remove",
"properties": {
"op": {
"description": "The operation to perform: `remove` in this case.",
"type": "string",
"enum": [
"remove"
]
}
}
},
{
"title": "Move, copy",
"required": [
"from"
],
"properties": {
"from": {
"description": "A JSON Pointer path pointing to the location to move or copy from.",
"type": "string"
},
"op": {
"description": "The operation to perform: `move` or `copy` in this case.",
"type": "string",
"enum": [
"move",
"copy"
]
}
}
}
]
},
"x-akamai": {
"file-path": "schemas/property-version-rules-patch-request.yaml"
}
},
"example": [
{
"op": "replace",
"path": "/rules/options/is_secure",
"value": true
},
{
"op": "replace",
"path": "/rules/children/0/name",
"value": "Handle /my-path"
}
]
}
}
},
"responses": {
"200": {
"description": "The response shows modified rule tree for the specified include version.",
"content": {
"*/*": {
"example": {
"accountId": "act_A-CCT3456",
"contractId": "ctr_C-0N7RAC7",
"etag": "a9dfe78cf93090516bde891d009eaf57",
"groupId": "grp_12345",
"includeId": "inc_173136",
"includeName": "my.new.include.com",
"includeType": "MICROSERVICES",
"includeVersion": 3,
"ruleFormat": "v2022-10-18",
"rules": {
"name": "default",
"children": [],
"criteria": [],
"options": {
"is_secure": false
},
"behaviors": [
{
"name": "origin",
"options": {
"cacheKeyHostname": "ORIGIN_HOSTNAME",
"compress": true,
"enableTrueClientIp": false,
"forwardHostHeader": "REQUEST_HOST_HEADER",
"hostname": "origin.com",
"httpPort": 80,
"originType": "CUSTOMER"
}
},
{
"name": "cpCode",
"options": {
"value": {
"id": 12345,
"name": "my CP code"
}
}
}
]
}
},
"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/GetIncludeRuleResponse.json#",
"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"
},
"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"
},
"etag": {
"description": "A digest with which to check the [data's integrity](https://techdocs.akamai.com/property-mgr/reference/concurrency-control).",
"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": "Unique identifier for an include. 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.",
"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 `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": [
"COMMON_SETTINGS",
"MICROSERVICES"
]
},
"includeVersion": {
"description": "The version of the include that a rule tree represents.",
"minimum": 1,
"type": "integer"
},
"ruleFormat": {
"description": "Indicates the versioned set of features and criteria that are currently applied to a rule tree. See [API versioning](https://techdocs.akamai.com/property-mgr/reference/api-versioning) for more information.",
"type": "string"
},
"rules": {
"additionalProperties": false,
"description": "Specifies the executable logic to apply to cached edge content. The outer envelope's `rules` object specifies the relevant top-level `default` rule object. See the [Rule Trees](https://techdocs.akamai.com/property-mgr/reference/rule-trees) section for guidance on how to structure the data.",
"type": "object",
"required": [
"behaviors",
"name"
],
"properties": {
"options": {
"additionalProperties": false,
"description": "Flags that apply to the top-level rule object.",
"type": "object",
"properties": {
"is_secure": {
"description": "When enabled, serves the include's content over SSL. Doing so may enable additional rule behaviors.",
"type": "boolean"
}
}
},
"advancedOverride": {
"description": "A block of post-processing XML metadata that your Akamai representative can apply on your behalf. You need to configure this separately for each include. Use the more recent `customOverride` member to apply the same XML metadata to more than one include.",
"type": "string"
},
"behaviors": {
"description": "A series of [behavior](https://techdocs.akamai.com/property-mgr/reference/ga-behaviors) objects, which execute after the set of `criteria` evaluates. Behavior and criteria objects are structured identically. Optional on nested rules.",
"type": "array",
"items": {
"additionalProperties": false,
"type": "object",
"required": [
"name",
"options"
],
"properties": {
"options": {
"description": "A variable set of options that configure each behavior. See the [behavior](https://techdocs.akamai.com/property-mgr/reference/ga-behaviors) and [criteria](https://techdocs.akamai.com/property-mgr/reference/ga-criteria) reference for details on each.",
"type": "object"
},
"locked": {
"description": "Indicates a behavior or criteria that you arrange with your Akamai representative to lock. Typically, you prevent further modifications to protect sensitive data from erroneous changes.",
"type": "string"
},
"name": {
"description": "The name of the behavior.",
"type": "string"
},
"uuid": {
"description": "A data hash that indicates an _advanced_ behavior. When present, you may not modify the contents of the behavior, and need to provide the same `uuid` value when modifying the rule tree. See [Advanced and locked features](https://techdocs.akamai.com/property-mgr/reference/advanced-and-locked-features).",
"type": "string"
}
}
}
},
"children": {
"description": "A series of nested rules that execute after the current rule's `criteria` and `behaviors`.",
"minItems": 0,
"type": "array",
"items": {
"type": "object"
}
},
"comment": {
"description": "A descriptive comment to help you track the rule's function.",
"type": "string"
},
"criteria": {
"description": "A series of [criteria](https://techdocs.akamai.com/property-mgr/reference/ga-criteria) objects, which form a set of logical tests that may prevent the rule's `behaviors` from executing. Behavior and criteria objects are structured identically.",
"type": "array",
"items": {
"type": "object"
}
},
"criteriaLocked": {
"description": "Within child rules, this prohibits any modifications to `criteria` objects. Contact your Akamai representative to change the value.",
"type": "boolean"
},
"customOverride": {
"additionalProperties": false,
"description": "Specifies post-processing XML metadata that your Akamai representative can create on your behalf. Once available with the [List custom overrides](https://techdocs.akamai.com/property-mgr/reference/get-custom-overrides) operation, you can assign an `overrideId` to more than one include's `default` rule. See [Custom behaviors and overrides](https://techdocs.akamai.com/property-mgr/reference/custom-behaviors-and-overrides) for guidance.",
"type": "object",
"required": [
"name",
"overrideId"
],
"properties": {
"name": {
"description": "The name of the custom override. It may vary from what appears in the [List custom overrides](https://techdocs.akamai.com/property-mgr/reference/get-custom-overrides) operation's response object.",
"type": "string"
},
"overrideId": {
"description": "Identifies the predefined custom override metadata you want to append to the current rule. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on how to omit the ID's `cbo_` prefix.",
"type": "string"
}
}
},
"name": {
"description": "A description of the rule. The top-level rule needs to be named `default`.",
"type": "string"
},
"uuid": {
"description": "A data hash that indicates the rule contains at least one _advanced_ behavior or criteria, each identified with its own `uuid` member. When this member is present on the rule, you may not remove any advanced features it contains, or change their sequence. You need to provide the same `uuid` value when modifying the rule tree. See [Advanced and locked features](https://techdocs.akamai.com/property-mgr/reference/advanced-and-locked-features).",
"type": "string"
},
"variables": {
"description": "Declares a variable. See [Variables](https://techdocs.akamai.com/property-mgr/reference/variables) for guidance on how variables may appear within a rule tree.",
"type": "array",
"items": {
"additionalProperties": false,
"type": "object",
"required": [
"hidden",
"name",
"sensitive"
],
"properties": {
"description": {
"description": "Text for you to keep track of how you use each variable.",
"type": "string"
},
"hidden": {
"description": "When enabled, the variable is suppressed from session response headers. Useful when testing content as described in the [Debug variables](https://techdocs.akamai.com/property-mgr/reference/debug-variables) section.",
"type": "boolean"
},
"name": {
"description": "The underlying root name of the variable, which needs to be unique within the set of `variables`.",
"type": "string"
},
"sensitive": {
"description": "When enabled, the variable is suppressed from session responses as `hidden` ones, but it also can't be invoked within any behaviors that assign values to cookies or response headers. You also can't assign a `sensitive` variable to another one that isn't `sensitive`, and you can't add it to custom logging fields. Use this more stringent option for any personally identifiable information, typically after initially testing on the staging network.",
"type": "boolean"
},
"value": {
"description": "Initializes a default value. Omitting this member initializes the variable with an empty string.",
"type": "string"
}
}
}
}
}
}
},
"x-akamai": {
"file-path": "schemas/include-version-rules-get-response.yaml"
}
}
}
},
"headers": {
"ETag": {
"description": "Pass the `ETag` response header back as `If-Match` in write requests to ensure you don't overwrite edits by any other API clients. See [Concurrency control](https://techdocs.akamai.com/property-mgr/reference/concurrency-control) for details.",
"example": "\"a9dfe78cf93090516bde891d009eaf57\"",
"schema": {
"type": "string"
},
"x-akamai": {
"file-path": "headers/Etag.yaml"
}
},
"X-Limit-Clientip-Per-Property-Limit": {
"description": "Maximum number of separate [Client IP](https://techdocs.akamai.com/property-mgr/reference/latest-client-ip) matches per property rule tree configuration.",
"schema": {
"type": "string"
},
"x-akamai": {
"file-path": "headers/X-Limit-Clientip-Per-Property-Limit.yaml"
}
},
"X-Limit-Clientip-Per-Property-Remaining": {
"description": "Remaining number of separate [Client IP](https://techdocs.akamai.com/property-mgr/reference/latest-client-ip) matches per property rule tree configuration. See [Rate and resource limiting](https://techdocs.akamai.com/property-mgr/reference/rate-and-resource-limiting) for details.",
"schema": {
"type": "string"
},
"x-akamai": {
"file-path": "headers/X-Limit-Clientip-Per-Property-Remaining.yaml"
}
},
"X-Limit-Elements-Per-Property-Limit": {
"description": "Maximum number of separate matches and behaviors per property rule tree configuration. See [Rate and resource limiting](https://techdocs.akamai.com/property-mgr/reference/rate-and-resource-limiting) for details.",
"schema": {
"type": "string"
},
"x-akamai": {
"file-path": "headers/X-Limit-Elements-Per-Property-Limit.yaml"
}
},
"X-Limit-Elements-Per-Property-Remaining": {
"description": "Remaining number of separate matches and behaviors per property rule tree configuration. See [Rate and resource limiting](https://techdocs.akamai.com/property-mgr/reference/rate-and-resource-limiting) for details.",
"schema": {
"type": "string"
},
"x-akamai": {
"file-path": "headers/X-Limit-Elements-Per-Property-Remaining.yaml"
}
},
"X-Limit-Max-Clientip-Per-Match-Limit": {
"description": "Maximum number of separate IP addresses allowed within each [Client IP](https://techdocs.akamai.com/property-mgr/reference/latest-client-ip) match.",
"schema": {
"type": "string"
},
"x-akamai": {
"file-path": "headers/X-Limit-Max-Clientip-Per-Match-Limit.yaml"
}
},
"X-Limit-Max-Clientip-Per-Match-Remaining": {
"description": "Remaining number of separate IP addresses allowed within each [Client IP](https://techdocs.akamai.com/property-mgr/reference/latest-client-ip) match. See [Rate and resource limiting](https://techdocs.akamai.com/property-mgr/reference/rate-and-resource-limiting) for details.",
"schema": {
"type": "string"
},
"x-akamai": {
"file-path": "headers/X-Limit-Max-Clientip-Per-Match-Remaining.yaml"
}
},
"X-Limit-Max-Nested-Rules-Limit": {
"description": "Maximum number of nested child rules in a property to apply conditional logic.",
"schema": {
"type": "string"
},
"x-akamai": {
"file-path": "headers/X-Limit-Max-Nested-Rules-Limit.yaml"
}
},
"X-Limit-Max-Nested-Rules-Remaining": {
"description": "Remaining number of nested child rules in a property to apply conditional logic. See [Rate and resource limiting](https://techdocs.akamai.com/property-mgr/reference/rate-and-resource-limiting) for details.",
"schema": {
"type": "string"
},
"x-akamai": {
"file-path": "headers/X-Limit-Max-Nested-Rules-Remaining.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"
}
},
"412": {
"description": "[Precondition failed](https://techdocs.akamai.com/property-mgr/reference/412).",
"content": {
"application/problem+json": {
"example": {
"detail": "Cannot activate the property at this time, please try again.",
"instance": "papi/v1/properties/prp_123456/activations?contractId=ctr_C-0N7RAC7&groupId=grp_12345#abc12345abcc02a7",
"status": 412,
"title": "Precondition Failed",
"type": "https://problems.luna.akamaiapis.net/papi/v0/toolkit/validation_failed.error.activation.tower_precondition.failed"
},
"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/412.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"
}
}
},
"x-akamai": {
"status": "LA"
},
"parameters": [
{
"description": "This corresponds to the `ETag` response header. Passing this value back as `If-Match` in write requests ensures you don't overwrite edits by any other API clients. See [Concurrency control](https://techdocs.akamai.com/property-mgr/reference/concurrency-control) for details.",
"example": "{{If-Match}}",
"in": "header",
"name": "If-Match",
"required": true,
"schema": {
"example": "\"a9dfe78cf93090516bde891d009eaf57\"",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/If-Match-header.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.",
"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": "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.",
"example": "{{contractId}}",
"in": "query",
"name": "contractId",
"required": false,
"schema": {
"example": "ctr_1-1TJZFW",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/contractId-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.",
"example": "{{groupId}}",
"in": "query",
"name": "groupId",
"required": false,
"schema": {
"example": "grp_15166",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/groupId-optional.yaml"
}
},
{
"description": "Set to `true` by default. When `false`, skips validation tests that would identify potential problems within the response object's `errors` and `warnings` arrays. See [Rule tree errors and warnings](https://techdocs.akamai.com/property-mgr/reference/rule-tree-errors-and-warnings) and [Validation errors](https://techdocs.akamai.com/property-mgr/reference/validation-errors) for information on how validation data appears in the response object. See [Validation best practices](https://techdocs.akamai.com/property-mgr/reference/validation-best-practices) for guidance on when to defer validation.",
"example": "{{validateRules}}",
"in": "query",
"name": "validateRules",
"required": false,
"schema": {
"default": true,
"example": true,
"type": "boolean"
},
"x-akamai": {
"file-path": "parameters/validateRules-query.yaml"
}
},
{
"description": "__Enum__ With `validateRules` enabled, setting this to `fast` performs a quick validation check based on the provided JSON. This is faster than the default `full` validation, which performs more extensive checks on the converted XML metadata configuration. See [Validation best practices](https://techdocs.akamai.com/property-mgr/reference/validation-best-practices) for more guidance.",
"example": "{{validateMode}}",
"in": "query",
"name": "validateMode",
"required": false,
"schema": {
"default": "full",
"example": "fast",
"type": "string",
"enum": [
"full",
"fast"
]
},
"x-akamai": {
"file-path": "parameters/validateMode-query.yaml"
}
},
{
"description": "With the `validateRules` query parameter also enabled, allows for a _dry run_ in order to gather any possible errors without saving the rule tree. See [Validation best practices](https://techdocs.akamai.com/property-mgr/reference/validation-best-practices) for more guidance.",
"example": "{{dryRun}}",
"in": "query",
"name": "dryRun",
"required": false,
"schema": {
"default": false,
"example": true,
"type": "boolean"
},
"x-akamai": {
"file-path": "parameters/dryRun-query.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"
}
}
]
},
"head": {
"description": "__Limited availability__ Gets the rule tree's ETag without the rule tree object. Ordinarily when you [get a rule tree](https://techdocs.akamai.com/property-mgr/reference/get-include-version-rules), the response includes a large rule tree object. As discussed in [Concurrency control](https://techdocs.akamai.com/property-mgr/reference/concurrency-control), it includes a top-level `etag` data digest to use when [writing back the data](https://techdocs.akamai.com/property-mgr/reference/put-include-version-rules). Use this operation if you simply want to get the `ETag` as a header without the data.",
"operationId": "head-include-version-rules",
"summary": "Akamai Get a Digest for an Include's Rule Tree",
"tags": [
"Include version rules"
],
"externalDocs": {
"description": "See documentation for this operation in Akamai's Property Manager API",
"url": "https://techdocs.akamai.com/property-mgr/reference/head-include-version-rules"
},
"responses": {
"204": {
"description": "The response provides the `ETag` header representing the current state of the rule tree data. See Concurrency control for guidance.",
"content": {
"*/*": {}
},
"headers": {
"ETag": {
"description": "Pass the `ETag` response header back as `If-Match` in write requests to ensure you don't overwrite edits by any other API clients. See [Concurrency control](https://techdocs.akamai.com/property-mgr/reference/concurrency-control) for details.",
"example": "\"a9dfe78cf93090516bde891d009eaf57\"",
"schema": {
"type": "string"
},
"x-akamai": {
"file-path": "headers/Etag.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"
}
},
"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"
}
}
},
"x-akamai": {
"status": "LA"
},
"parameters": [
{
"description": "A custom JSON type that validates against a dated rule format. When examining metadata from a [property version](https://techdocs.akamai.com/property-mgr/reference/get-property-version) or include, the content type is `text/xml`. See [API versioning](https://techdocs.akamai.com/property-mgr/reference/api-versioning) for guidance.",
"example": "{{Accept}}",
"in": "header",
"name": "Accept",
"required": true,
"schema": {
"example": "application/vnd.akamai.papirules.latest+json",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/Accept-header.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.",
"example": "{{contractId}}",
"in": "query",
"name": "contractId",
"required": false,
"schema": {
"example": "ctr_1-1TJZFW",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/contractId-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.",
"example": "{{groupId}}",
"in": "query",
"name": "groupId",
"required": false,
"schema": {
"example": "grp_15166",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/groupId-optional.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"
}
}
]
},
"x-akamai": {
"file-path": "paths/include-version-rules.yaml",
"path-for-file": "/includes/{includeId}/versions/{includeVersion}/rules"
},
"x-akamai-descriptor-tools": {
"displayName": "includeVersionRules",
"group": "Include version rules"
},
"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.",
"example": "{{includeId}}",
"in": "path",
"name": "includeId",
"required": true,
"schema": {
"example": "inc_175780",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/includeId-path.yaml"
}
},
{
"description": "Include's incremental version number.",
"example": "{{includeVersion}}",
"in": "path",
"name": "includeVersion",
"required": true,
"schema": {
"example": 3,
"type": "integer"
},
"x-akamai": {
"file-path": "parameters/includeVersion-path.yaml"
}
}
]
},
"/products": {
"get": {
"description": "This operation lists the set of products that are available under a given contract. You need a product identifier to create new edge hostnames, CP codes, or properties. The assigned product determines the supported set of rule behaviors available within a property.",
"operationId": "get-products",
"summary": "Akamai List Products",
"tags": [
"Products"
],
"externalDocs": {
"description": "See documentation for this operation in Akamai's Property Manager API",
"url": "https://techdocs.akamai.com/property-mgr/reference/get-products"
},
"responses": {
"200": {
"description": "The response lists products available in a contract.",
"content": {
"application/json": {
"example": {
"accountId": "act_A-CCT7890",
"contractId": "ctr_C-0N7RAC7",
"products": {
"items": [
{
"productId": "prd_Alta",
"productName": "Alta"
}
]
}
},
"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/GetProductResponse.json#",
"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"
},
"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"
},
"products": {
"additionalProperties": false,
"description": "The set of requested products, available within an `items` array.",
"type": "object",
"properties": {
"items": {
"description": "Encapsulates information on the product that determines a property's available range of features. Relevant response objects appear within the outer envelope's `products.items` array.",
"type": "array",
"items": {
"additionalProperties": false,
"type": "object",
"required": [
"productId",
"productName"
],
"properties": {
"productId": {
"description": "Identifies each product. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on how to omit the ID's `prd_` prefix.",
"type": "string"
},
"productName": {
"description": "A descriptive name for the product.",
"type": "string"
}
}
}
}
}
}
},
"x-akamai": {
"file-path": "schemas/product-get-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"
}
},
"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": "Unique identifier for the contract. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting the value's `ctr_` prefix.",
"example": "{{contractId}}",
"in": "query",
"name": "contractId",
"required": true,
"schema": {
"example": "ctr_1-1TJZFW",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/contractId-required.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"
}
}
]
},
"x-akamai": {
"file-path": "paths/products.yaml",
"path-for-file": "/products"
},
"x-akamai-descriptor-tools": {
"displayName": "products",
"group": "Products"
}
},
"/products/{productId}/mapping-use-cases": {
"get": {
"description": "For a given product, this lists Akamai-provided use case scenarios. Use cases help optimally map different types of traffic across the Akamai edge network. Optionally run this operation to gather values before [creating a new edge hostname](https://techdocs.akamai.com/property-mgr/reference/post-edgehostnames).",
"operationId": "get-product-mapping-use-cases",
"summary": "Akamai List Use Cases",
"tags": [
"Products"
],
"externalDocs": {
"description": "See documentation for this operation in Akamai's Property Manager API",
"url": "https://techdocs.akamai.com/property-mgr/reference/get-product-mapping-use-cases"
},
"responses": {
"200": {
"description": "The response lists the provided set of use cases.",
"content": {
"application/json": {
"example": {
"useCases": [
{
"type": "GLOBAL",
"useCase": "Download_Mode",
"options": [
"BACKGROUND",
"FOREGROUND"
]
}
]
},
"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/GetProductUseCasesResponse.json#",
"type": "object",
"properties": {
"useCases": {
"description": "Available use cases for edge hostnames assigned to the product. The preset use case scenarios provided by Akamai help optimally map different types of traffic across the Akamai edge network.",
"minItems": 1,
"type": "array",
"items": {
"additionalProperties": false,
"type": "object",
"required": [
"useCase",
"options",
"type"
],
"properties": {
"options": {
"description": "A set of values you can choose from. For example, a high-priority file may download in the `FOREGROUND`, or as a slower `BACKGROUND` task.",
"type": "array",
"items": {
"type": "string"
}
},
"type": {
"description": "Identifies the Akamai network over which traffic deploys. The only value currently available is the `GLOBAL` network.",
"type": "string",
"enum": [
"GLOBAL"
]
},
"useCase": {
"description": "Identifies each use case.",
"type": "string"
}
}
}
}
},
"x-akamai": {
"file-path": "schemas/product-use-cases-get-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"
}
},
"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": "Unique identifier for the contract. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting the value's `ctr_` prefix.",
"example": "{{contractId}}",
"in": "query",
"name": "contractId",
"required": true,
"schema": {
"example": "ctr_1-1TJZFW",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/contractId-required.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"
}
}
]
},
"x-akamai": {
"file-path": "paths/product-mapping-use-cases.yaml",
"path-for-file": "/products/{productId}/mapping-use-cases"
},
"x-akamai-descriptor-tools": {
"displayName": "useCases",
"group": "Products"
},
"parameters": [
{
"description": "Unique identifier for the product. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting the value's `prd_` prefix.",
"example": "{{productId}}",
"in": "path",
"name": "productId",
"required": true,
"schema": {
"example": "prd_Download_Delivery",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/productId-path.yaml"
}
}
]
},
"/properties": {
"post": {
"description": "This operation either creates a new property from scratch or bases one on another property's rule tree and optionally its set of assigned hostnames. Version 1 of a new property is created automatically. PAPI's ability to create and clone new properties means that you can design a system of rule templates targeted to specific domains, rather than maintain a single set of rules with conditional logic for your full range of domains. Maintaining properties manually within the Control Center interface limited you to that more consolidated approach, but you can deploy rules more efficiently using PAPI. In either case, PAPI makes it much easier for you to support a large, flexible set of domains.",
"operationId": "post-properties",
"summary": "Akamai Create or Clone a Property",
"tags": [
"Properties"
],
"externalDocs": {
"description": "See documentation for this operation in Akamai's Property Manager API",
"url": "https://techdocs.akamai.com/property-mgr/reference/post-properties"
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"example": {
"productId": "prd_Alta",
"propertyName": "my.new.property1.com",
"ruleFormat": "v2018-09-12"
},
"schema": {
"$schema": "http://json-schema.org/draft-04-schema#",
"description": "Contains configuration data to apply to edge content. Relevant response objects appear within the outer envelope's `properties.items` array.",
"id": "resource:/descriptors/papi/v1/schemas/CreateOrClonePropertyRequestV0.json#",
"javaType": "com.akamai.luna.papi.model.PropertyCreateRequest",
"type": "object",
"required": [
"productId",
"propertyName"
],
"properties": {
"cloneFrom": {
"description": "Optionally identifies another property instance to clone when making a POST request to create a new property. You need to assign the same contract and group to the cloned property.",
"type": "object",
"required": [
"propertyId",
"version"
],
"properties": {
"cloneFromVersionEtag": {
"description": "Performs an ETag data integrity check on the original property. See [Concurrency control](https://techdocs.akamai.com/property-mgr/reference/concurrency-control) for guidance.",
"type": "string"
},
"copyHostnames": {
"default": false,
"description": "Assigns the same set of hostnames to the new property, `false` by default.",
"type": "boolean"
},
"propertyId": {
"description": "Specifies the property to clone. 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"
},
"version": {
"description": "Specifies the version of the property to clone.",
"minimum": 1,
"type": "integer"
}
}
},
"productId": {
"description": "Unique identifier for the product. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting the value's `prd_` prefix.",
"example": "{{productId}}",
"type": "string"
},
"propertyName": {
"description": "A descriptive name for the property.",
"example": "{{propertyName}}",
"type": "string"
},
"ruleFormat": {
"description": "On GET, reflects the property's current format. Otherwise on POST, assigns a specific rule format to the property. Ignored on PUT, since you need to modify the `Content-Type` to change rule formats. For details, see [Update rules to a newer set of features](https://techdocs.akamai.com/property-mgr/reference/manage-rules).",
"example": "{{ruleFormat}}",
"type": "string"
},
"useHostnameBucket": {
"default": false,
"description": "Available if you have the `Hostname Bucket` module added to your contract, `false` by default. When enabled, this creates a special type of property where you can add or remove property hostnames without incrementing property versions.",
"example": "{{useHostnameBucket}}",
"type": "boolean"
}
},
"x-akamai": {
"file-path": "schemas/property-create-request.yaml"
}
}
}
}
},
"responses": {
"201": {
"description": "The response provides a URL link to the newly created or cloned property.",
"content": {
"application/json": {
"example": {
"propertyLink": "/papi/v0/properties/prp_173137?contractId=ctr_C-0N7RAC7&groupId=grp_15225"
},
"schema": {
"$schema": "http://json-schema.org/draft-04-schema#",
"additionalProperties": false,
"description": "Provides a hypermedia link to a newly created resource. The response's single member name indicates the type of resource.",
"id": "resource:/descriptors/papi/v1/schemas/PostPropertyResponse.json#",
"type": "object",
"required": [
"propertyLink"
],
"properties": {
"propertyLink": {
"description": "Links the newly created property.",
"type": "string"
}
},
"x-akamai": {
"file-path": "schemas/property-create-response.yaml"
}
}
}
},
"headers": {
"Location": {
"description": "Provides a URL path you can GET the newly created resource from.",
"schema": {
"type": "string"
},
"x-akamai": {
"file-path": "headers/Location.yaml"
}
},
"X-Limit-Properties-Per-Contract-Limit": {
"description": "Maximum number of activated property configurations per contract.",
"schema": {
"type": "string"
},
"x-akamai": {
"file-path": "headers/X-Limit-Properties-Per-Contract-Limit.yaml"
}
},
"X-Limit-Properties-Per-Contract-Remaining": {
"description": "Remaining number of activated property configurations per contract. See [Rate and resource limiting](https://techdocs.akamai.com/property-mgr/reference/rate-and-resource-limiting) for details.",
"schema": {
"type": "string"
},
"x-akamai": {
"file-path": "headers/X-Limit-Properties-Per-Contract-Remaining.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"
}
},
"413": {
"description": "[Request entity too large](https://techdocs.akamai.com/property-mgr/reference/413).",
"content": {
"application/problem+json": {
"example": {
"detail": "TBD",
"instance": "/papi/v1/properties?contractId=ctr_C-0N7RAC7&groupId=grp_12345#abc12345abcc02a7",
"status": 413,
"title": "Request entity too large",
"type": "https://problems.luna.akamaiapis.net/papi/v1/http/"
},
"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/413.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": "Unique identifier for the contract. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting the value's `ctr_` prefix.",
"example": "{{contractId}}",
"in": "query",
"name": "contractId",
"required": true,
"schema": {
"example": "ctr_1-1TJZFW",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/contractId-required.yaml"
}
},
{
"description": "Unique identifier for the group. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting the value's `grp_` prefix.",
"example": "{{groupId}}",
"in": "query",
"name": "groupId",
"required": true,
"schema": {
"example": "grp_15166",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/groupId-required.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"
}
}
]
},
"get": {
"description": "This operation lists properties available for the current contract and group. Use optional query parameters to only show properties that were modified within a specified time range or on a selected network. If you specify the `modifiedSince` parameter, `contractId` and `groupId` become optional. If you don't identify a contract and group, the operation lists all properties you have access to, modified within a specified time range.",
"operationId": "get-properties",
"summary": "Akamai List Properties",
"tags": [
"Properties"
],
"externalDocs": {
"description": "See documentation for this operation in Akamai's Property Manager API",
"url": "https://techdocs.akamai.com/property-mgr/reference/get-properties"
},
"responses": {
"200": {
"description": "The response lists all properties available for the requested contract and group.",
"content": {
"application/json": {
"example": {
"properties": {
"items": [
{
"accountId": "act_A-CCT1234",
"assetId": "aid_101",
"contractId": "ctr_K-0N7RAK71",
"groupId": "grp_15225",
"latestVersion": 2,
"note": "Notes about example.com",
"productionVersion": null,
"propertyId": "prp_175780",
"propertyName": "example.com",
"stagingVersion": 1
},
{
"accountId": "act_A-CCT7890",
"assetId": "aid_101",
"contractId": "ctr_C-0N7RAC71",
"groupId": "grp_15225",
"latestVersion": 1,
"note": "Notes about m.example.com",
"productionVersion": null,
"propertyId": "prp_175781",
"propertyName": "m.example.com",
"stagingVersion": null
}
]
}
},
"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, even individual items.",
"id": "resource:/descriptors/papi/v1/schemas/GetPropertyResponse.json#",
"type": "object",
"properties": {
"properties": {
"additionalProperties": false,
"description": "The set of requested properties, available within an `items` array.",
"type": "object",
"properties": {
"items": {
"description": "Configuration data to apply to edge content. Relevant response objects appear within the outer envelope's `properties.items` array.",
"type": "array",
"items": {
"additionalProperties": false,
"type": "object",
"required": [
"accountId",
"contractId",
"groupId",
"propertyId",
"propertyName",
"latestVersion",
"stagingVersion",
"productionVersion",
"assetId",
"note"
],
"properties": {
"accountId": {
"description": "Identifies the account the property belongs to. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on how to omit the ID's `act_` prefix.",
"readOnly": true,
"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 the property belongs to. 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 group to which the property is assigned. 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"
},
"latestVersion": {
"description": "Specifies the most recent version of the property.",
"type": "integer"
},
"note": {
"description": "Further descriptive commentary.",
"type": "string"
},
"productId": {
"description": "The product assigned to the property, required when POSTing a new property. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on how to omit the ID's `prd_` prefix.",
"type": "string"
},
"productionVersion": {
"description": "The most recent version to be activated to the production network, otherwise `null`.",
"nullable": true,
"type": [
"integer",
"null"
]
},
"propertyId": {
"description": "The property's unique identifier. 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.",
"type": "string"
},
"propertyType": {
"description": "Specifies the type of the property. Either `TRADITIONAL` for properties where you pair property hostnames with the property version, or `HOSTNAME_BUCKET` where you manage property hostnames independently of the property version.",
"type": "string",
"enum": [
"HOSTNAME_BUCKET",
"TRADITIONAL"
]
},
"ruleFormat": {
"description": "Name of the rule format. The rule format can be frozen to a specific version, or represent the `latest` set of behaviors and criteria.",
"type": "string"
},
"stagingVersion": {
"description": "The most recent version to be activated to the test network, otherwise `null`.",
"nullable": true,
"type": [
"integer",
"null"
]
}
}
}
}
}
}
},
"x-akamai": {
"file-path": "schemas/property-get-response.yaml"
}
}
}
},
"headers": {
"X-Limit-Properties-Per-Contract-Limit": {
"description": "Maximum number of activated property configurations per contract.",
"schema": {
"type": "string"
},
"x-akamai": {
"file-path": "headers/X-Limit-Properties-Per-Contract-Limit.yaml"
}
},
"X-Limit-Properties-Per-Contract-Remaining": {
"description": "Remaining number of activated property configurations per contract. See [Rate and resource limiting](https://techdocs.akamai.com/property-mgr/reference/rate-and-resource-limiting) for details.",
"schema": {
"type": "string"
},
"x-akamai": {
"file-path": "headers/X-Limit-Properties-Per-Contract-Remaining.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"
}
},
"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": "Filters properties or includes that have been modified in a specified time. Accepts duration in the ISO 8601 format.",
"example": "{{modifiedSince}}",
"in": "query",
"name": "modifiedSince",
"required": false,
"schema": {
"example": "P1DT23H6M40S",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/modifiedSince-query.yaml"
}
},
{
"description": "__Enum__ Filters and only shows properties or includes that have been modified within a specified period on a selected network, either `STAGING`, `PRODUCTION`, or `BOTH`. You need to specify it along with the `modifiedSince` query parameter.",
"example": "{{modifiedNetwork}}",
"in": "query",
"name": "modifiedNetwork",
"required": false,
"schema": {
"example": "PRODUCTION",
"type": "string",
"enum": [
"PRODUCTION",
"STAGING",
"BOTH"
]
},
"x-akamai": {
"file-path": "parameters/modifiedNetwork-query.yaml"
}
},
{
"description": "Unique identifier for the contract. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting the value's `ctr_` prefix.",
"example": "{{contractId}}",
"in": "query",
"name": "contractId",
"required": true,
"schema": {
"example": "ctr_1-1TJZFW",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/contractId-required.yaml"
}
},
{
"description": "Unique identifier for the group. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting the value's `grp_` prefix.",
"example": "{{groupId}}",
"in": "query",
"name": "groupId",
"required": true,
"schema": {
"example": "grp_15166",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/groupId-required.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.",
"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"
}
}
]
},
"x-akamai": {
"file-path": "paths/properties.yaml",
"path-for-file": "/properties"
},
"x-akamai-descriptor-tools": {
"displayName": "properties",
"group": "Properties"
}
},
"/properties/{propertyId}": {
"get": {
"description": "This operation gets a specific property. You can call this operation by specifying any of the `propertyId` members from a [list of properties](https://techdocs.akamai.com/property-mgr/reference/get-properties), or by running a GET on the `propertyLink` response when [creating a new property](https://techdocs.akamai.com/property-mgr/reference/post-properties).",
"operationId": "get-property",
"summary": "Akamai Get a Property",
"tags": [
"Properties"
],
"externalDocs": {
"description": "See documentation for this operation in Akamai's Property Manager API",
"url": "https://techdocs.akamai.com/property-mgr/reference/get-property"
},
"responses": {
"200": {
"description": "The response shows details for the requested property.",
"content": {
"application/json": {
"example": {
"properties": {
"items": [
{
"accountId": "act_A-CCT9012",
"assetId": "aid_101",
"contractId": "ctr_C-0N7RAC71",
"groupId": "grp_15225",
"latestVersion": 2,
"note": "Notes about example.com",
"productionVersion": null,
"propertyId": "prp_175780",
"propertyName": "example.com",
"stagingVersion": 1
}
]
}
},
"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, even individual items.",
"id": "resource:/descriptors/papi/v1/schemas/GetPropertyResponse.json#",
"type": "object",
"properties": {
"properties": {
"additionalProperties": false,
"description": "The set of requested properties, available within an `items` array.",
"type": "object",
"properties": {
"items": {
"description": "Configuration data to apply to edge content. Relevant response objects appear within the outer envelope's `properties.items` array.",
"type": "array",
"items": {
"additionalProperties": false,
"type": "object",
"required": [
"accountId",
"contractId",
"groupId",
"propertyId",
"propertyName",
"latestVersion",
"stagingVersion",
"productionVersion",
"assetId",
"note"
],
"properties": {
"accountId": {
"description": "Identifies the account the property belongs to. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on how to omit the ID's `act_` prefix.",
"readOnly": true,
"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 the property belongs to. 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 group to which the property is assigned. 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"
},
"latestVersion": {
"description": "Specifies the most recent version of the property.",
"type": "integer"
},
"note": {
"description": "Further descriptive commentary.",
"type": "string"
},
"productId": {
"description": "The product assigned to the property, required when POSTing a new property. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on how to omit the ID's `prd_` prefix.",
"type": "string"
},
"productionVersion": {
"description": "The most recent version to be activated to the production network, otherwise `null`.",
"nullable": true,
"type": [
"integer",
"null"
]
},
"propertyId": {
"description": "The property's unique identifier. 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.",
"type": "string"
},
"propertyType": {
"description": "Specifies the type of the property. Either `TRADITIONAL` for properties where you pair property hostnames with the property version, or `HOSTNAME_BUCKET` where you manage property hostnames independently of the property version.",
"type": "string",
"enum": [
"HOSTNAME_BUCKET",
"TRADITIONAL"
]
},
"ruleFormat": {
"description": "Name of the rule format. The rule format can be frozen to a specific version, or represent the `latest` set of behaviors and criteria.",
"type": "string"
},
"stagingVersion": {
"description": "The most recent version to be activated to the test network, otherwise `null`.",
"nullable": true,
"type": [
"integer",
"null"
]
}
}
}
}
}
}
},
"x-akamai": {
"file-path": "schemas/property-get-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"
}
},
"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": "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.",
"example": "{{contractId}}",
"in": "query",
"name": "contractId",
"required": false,
"schema": {
"example": "ctr_1-1TJZFW",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/contractId-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.",
"example": "{{groupId}}",
"in": "query",
"name": "groupId",
"required": false,
"schema": {
"example": "grp_15166",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/groupId-optional.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"
}
}
]
},
"delete": {
"description": "Removes a specific property, which you can only do if none of its versions are currently active. Activating another property with the same set of hostnames automatically triggers a deactivation on the targeted property. See [Create a new activation](https://techdocs.akamai.com/property-mgr/reference/post-property-activations) for details. A successful DELETE results in a 200 response with the confirmation message. Attempting to delete an active property results in a 500 error. Attempting to delete an unknown property results in a 404 error.",
"operationId": "delete-property",
"summary": "Akamai Remove a Property",
"tags": [
"Properties"
],
"externalDocs": {
"description": "See documentation for this operation in Akamai's Property Manager API",
"url": "https://techdocs.akamai.com/property-mgr/reference/delete-property"
},
"responses": {
"200": {
"description": "Shows a message confirming the property deletion.",
"content": {
"application/json": {
"example": {
"message": "Deletion Successful."
},
"schema": {
"$schema": "http://json-schema.org/draft-04-schema#",
"additionalProperties": false,
"description": "Specifies the result of the property deletion.",
"id": "resource:/descriptors/papi/v1/schemas/DeletePropertyResponse.json#",
"type": "object",
"required": [
"message"
],
"properties": {
"message": {
"description": "Confirms whether the property was successfully deleted.",
"type": "string"
}
},
"x-akamai": {
"file-path": "schemas/property-delete-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"
}
},
"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": "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.",
"example": "{{contractId}}",
"in": "query",
"name": "contractId",
"required": false,
"schema": {
"example": "ctr_1-1TJZFW",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/contractId-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.",
"example": "{{groupId}}",
"in": "query",
"name": "groupId",
"required": false,
"schema": {
"example": "grp_15166",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/groupId-optional.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"
}
}
]
},
"x-akamai": {
"file-path": "paths/property.yaml",
"path-for-file": "/properties/{propertyId}"
},
"x-akamai-descriptor-tools": {
"displayName": "property",
"group": "Properties"
},
"parameters": [
{
"description": "Unique identifier for the property. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting the value's `prp_` prefix.",
"example": "{{propertyId}}",
"in": "path",
"name": "propertyId",
"required": true,
"schema": {
"example": "prp_12345",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/propertyId-path.yaml"
}
}
]
},
"/properties/{propertyId}/activations": {
"post": {
"description": "This operation creates a new property activation, which deactivates any currently active version. After a necessary delay, this activates your property version's rule tree and set of hostnames across Akamai's network of edge servers, modifying how your edge content responds to end-user requests. To reduce software vulnerability, avoid calling PAPI with separate clients on the same data and frequent polling of status values, progressively increasing the delay.\n\nIf there's a problem with the property you activated, you may have the option to fall back to the previous version. To build the request object, go to the `activationLink` from the activation's response and note down the `fallbackVersion` value. Within an hour of activating, POST another activation with `propertyVersion` set to the version you noted down and `useFastFallback` set to `true`. This disables the current activation and falls back to the specified version. A fallback takes a few seconds, but the option is available only if there have been no changes to the set of property hostnames, as indicated by `canFastFallback`.",
"operationId": "post-property-activations",
"summary": "Akamai Activate or Deactivate a Property",
"tags": [
"Property activations"
],
"externalDocs": {
"description": "See documentation for this operation in Akamai's Property Manager API",
"url": "https://techdocs.akamai.com/property-mgr/reference/post-property-activations"
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"example": {
"network": "STAGING",
"note": "Sample activation",
"propertyVersion": 1,
"useFastFallback": false,
"acknowledgeWarnings": [
"msg_baa4560881774a45b5fd25f5b1eab021d7c40b4f"
],
"notifyEmails": [
"you@example.com",
"them@example.com"
]
},
"schema": {
"$schema": "http://json-schema.org/draft-04-schema#",
"description": "Activates property versions on a specific network. Relevant response objects appear within the outer envelope's `activations.items` array.",
"id": "resource:/descriptors/papi/v1/schemas/CreateNewActivationOrDeactivationRequestV0.json#",
"javaType": "com.akamai.luna.papi.model.PropertyActivationRequest",
"type": "object",
"required": [
"propertyVersion",
"network",
"notifyEmails"
],
"properties": {
"acknowledgeAllWarnings": {
"default": false,
"description": "When POSTing an activation, you can skip acknowledging each warning. With this enabled, you can omit the `acknowledgeWarnings` array.",
"example": "{{acknowledgeAllWarnings}}",
"type": "boolean"
},
"acknowledgeWarnings": {
"description": "String IDs prefixed with `msg_` to acknowledge any warnings noted in responses to previous activation requests.",
"type": "array",
"items": {
"type": "string"
}
},
"activationType": {
"default": "ACTIVATE",
"description": "Either `ACTIVATE` or `DEACTIVATE`. The default is `ACTIVATE`. Any new activation automatically deactivates the current activation. Note that if you were to POST a `DEACTIVATE` type on an active property, it would no longer serve any traffic. You'd need to modify your DNS configuration and specify a different way to field the traffic.",
"example": "{{activationType}}",
"type": "string",
"enum": [
"ACTIVATE",
"DEACTIVATE"
]
},
"delayValidations": {
"description": "This makes the operation respond with an `activationLink` more quickly. Some time-consuming validations ordinarily result in a direct error response. Enabling this delays them so that any errors appear later once you [Get a property activation](https://techdocs.akamai.com/property-mgr/reference/get-property-activation). In that case, the activation's `status` is `FAILED`.",
"example": "{{delayValidations}}",
"nullable": true,
"type": "boolean"
},
"fastPush": {
"default": true,
"description": "Enable a fast metadata push when activating a new property, `true` by default.",
"example": "{{fastPush}}",
"type": "boolean"
},
"ignoreHttpErrors": {
"default": true,
"description": "Ignore any HTTP errors when pushing fast metadata activation, `true` by default.",
"example": "{{ignoreHttpErrors}}",
"type": "boolean"
},
"network": {
"description": "The network to activate on, either `STAGING` or `PRODUCTION`.",
"example": "{{network}}",
"type": "string",
"enum": [
"STAGING",
"PRODUCTION"
]
},
"note": {
"description": "A descriptive log comment.",
"example": "{{note}}",
"type": "string"
},
"notifyEmails": {
"description": "Email addresses to notify when the activation status changes.",
"minItems": 1,
"type": "array",
"items": {
"type": "string"
}
},
"propertyVersion": {
"description": "The version of the property to activate.",
"example": "{{propertyVersion}}",
"minimum": 1,
"type": "integer"
},
"useFastFallback": {
"default": false,
"description": "After activating a property and finding it causes problems, POSTing another activation within one hour with `useFastFallback` enabled quickly rolls back to the previous version. This option is only available for activations where `canFastFallback` is `true`.",
"example": "{{useFastFallback}}",
"type": "boolean"
}
},
"x-akamai": {
"file-path": "schemas/property-activation-create-request.yaml"
}
}
}
}
},
"responses": {
"201": {
"description": "The response provides a URL link to the newly created activation.",
"content": {
"application/json": {
"example": {
"activationLink": "/papi/v0/properties/prp_173136/activations/atv_67037?contractId=ctr_C-0N7RAC7&groupId=grp_15225"
},
"schema": {
"$schema": "http://json-schema.org/draft-04-schema#",
"additionalProperties": false,
"description": "Provides a hypermedia link to a newly created resource. The response's single member name indicates the type of resource.",
"id": "resource:/descriptors/papi/v1/schemas/PostPropertyActivationResponse.json#",
"type": "object",
"required": [
"activationLink"
],
"properties": {
"activationLink": {
"description": "Links the new activation.",
"type": "string"
}
},
"x-akamai": {
"file-path": "schemas/property-activation-post-response.yaml"
}
}
}
},
"headers": {
"Location": {
"description": "Provides a URL path you can GET the newly created resource from.",
"schema": {
"type": "string"
},
"x-akamai": {
"file-path": "headers/Location.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"
}
},
"409": {
"description": "[Conflict](https://techdocs.akamai.com/property-mgr/reference/409).",
"content": {
"application/problem+json": {
"example": {
"detail": "Another edit or activation request on same network in progress for this property version.",
"instance": "papi/v1/properties/prp_123456/activations?contractId=ctr_C-0N7RAC7&groupId=grp_12345#abc12345abcc02a7",
"status": 409,
"title": "Operation failed",
"type": "https://problems.luna.akamaiapis.net/papi/v1/resource-busy"
},
"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/409.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"
}
},
"422": {
"description": "[Unprocessable content](https://techdocs.akamai.com/property-mgr/reference/422).",
"content": {
"application/problem+json": {
"example": {
"instance": "papi/v1/activations/#abc12345abcc02a7",
"messageId": "property_activation_still_pending",
"result": "ERROR",
"status": 422,
"title": "Property Manager Exception",
"type": "https://problems.luna.akamaiapis.net/papi/v1/property_activation_still_pending",
"params": [
"Property 123456",
"Version 1"
],
"details": {},
"errors": [
{
"detail": "property_activation_still_pending",
"title": "Property Manager Exception",
"type": "papi/v1/property_activation_still_pending"
}
]
},
"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",
"instance",
"status",
"errors",
"details",
"messageId",
"params",
"result"
],
"properties": {
"details": {
"description": "Diagnostic instructions to locate and fix the problem.",
"type": "object"
},
"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"
},
"messageId": {
"description": "Summarizes the cause of the problem.",
"minLength": 1,
"type": "string"
},
"params": {
"description": "Details of the property and version where the problem occured.",
"minItems": 0,
"type": "array",
"items": {
"type": "string"
}
},
"result": {
"description": "Indicates the severity of the problem.",
"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-422.yaml"
}
}
}
},
"x-akamai": {
"file-path": "errors/422.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": "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.",
"example": "{{contractId}}",
"in": "query",
"name": "contractId",
"required": false,
"schema": {
"example": "ctr_1-1TJZFW",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/contractId-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.",
"example": "{{groupId}}",
"in": "query",
"name": "groupId",
"required": false,
"schema": {
"example": "grp_15166",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/groupId-optional.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"
}
}
]
},
"get": {
"description": "This lists all activations for all versions of a property, on both production and staging networks.",
"operationId": "get-property-activations",
"summary": "Akamai List Property's Activations",
"tags": [
"Property activations"
],
"externalDocs": {
"description": "See documentation for this operation in Akamai's Property Manager API",
"url": "https://techdocs.akamai.com/property-mgr/reference/get-property-activations"
},
"responses": {
"200": {
"description": "The response lists all activations for the requested property.",
"content": {
"application/json": {
"example": {
"accountId": "act_A-CCT3456",
"contractId": "ctr_K-0N7RAK71",
"groupId": "grp_15225",
"activations": {
"items": [
{
"activationId": "atv_1696985",
"activationType": "ACTIVATE",
"fmaActivationState": "steady",
"network": "STAGING",
"note": "Sample activation",
"propertyId": "prp_173136",
"propertyName": "example.com",
"propertyVersion": 1,
"status": "PENDING",
"submitDate": "2014-03-02T02:22:12Z",
"updateDate": "2014-03-01T21:12:57Z",
"notifyEmails": [
"you@example.com",
"them@example.com"
],
"fallbackInfo": {
"canFastFallback": true,
"fallbackVersion": 10,
"fastFallbackAttempted": false,
"fastFallbackExpirationTime": 1506451772,
"fastFallbackRecoveryState": null,
"steadyStateTime": 1506448172
}
}
]
}
},
"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/GetActivationResponse.json#",
"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.",
"minLength": 1,
"type": "string"
},
"activations": {
"additionalProperties": false,
"description": "The set of requested activations, available within an `items` array.",
"type": "object",
"properties": {
"items": {
"description": "Activated property versions on a specific network. Relevant response objects appear within the outer envelope's `activations.items` array.",
"type": "array",
"items": {
"additionalProperties": false,
"type": "object",
"required": [
"activationId",
"activationType",
"network",
"note",
"notifyEmails",
"propertyId",
"propertyName",
"status",
"submitDate",
"updateDate"
],
"properties": {
"accountId": {
"description": "Identifies the account under which the property activated. 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"
},
"activationId": {
"description": "The activation's unique identifier. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on how to omit the ID's `atv_` prefix.",
"type": "string"
},
"activationType": {
"description": "Either `ACTIVATE` or `DEACTIVATE`. The default is `ACTIVATE`. Any new activation automatically deactivates the current activation. Note that if you were to POST a `DEACTIVATE` type on an active property, it would no longer serve any traffic. You'd need to modify your DNS configuration and specify a different way to field the traffic.",
"type": "string",
"enum": [
"ACTIVATE",
"DEACTIVATE"
]
},
"failureCause": {
"description": "If the activation's `status` is `FAILED`, this HTTP problem object describes the reason for the failure. This only appears when activating with `delayValidations` enabled.",
"type": "object"
},
"fallbackInfo": {
"additionalProperties": false,
"description": "Encapsulates information about fast fallback. You can use it to fall back to a previous activation when POSTing an activation with `useFastFallback` enabled.",
"type": "object",
"required": [
"canFastFallback",
"fallbackVersion",
"fastFallbackAttempted",
"fastFallbackExpirationTime",
"fastFallbackRecoveryState",
"steadyStateTime"
],
"properties": {
"canFastFallback": {
"description": "Whether the current activation can fallback to a previous version. This is typically `false` for new properties, or for property versions whose set of hostnames has changed.",
"type": "boolean"
},
"fallbackVersion": {
"description": "Indicates the property version that activates when a fast fallback succeeds.",
"minimum": 1,
"type": "integer"
},
"fastFallbackAttempted": {
"description": "Whether a fast fallback has already been attempted on this activation.",
"type": "boolean"
},
"fastFallbackExpirationTime": {
"description": "Epoch second timestamp marking when fast fallback is no longer possible for this activation.",
"type": "integer"
},
"fastFallbackRecoveryState": {
"description": "Represents additional information available for any attempted fallback.",
"nullable": true,
"type": [
"string",
"null"
]
},
"propertyVersion": {
"description": "The version for which fast fallback may be available.",
"minimum": 1,
"type": "integer"
},
"steadyStateTime": {
"description": "Epoch second timestamp marking when the activation completed, signaled by an `fmaActivationState` of `steady`.",
"type": "integer"
}
}
},
"fmaActivationState": {
"description": "Indicates fast metadata activation state. A value of `steady` indicates the property is currently active or has been cancelled. Values of `received`, `lived`, and `deployed` represent progressive stages of activation, while `cancelling` happens either after failing a network safety check or in response to a [DELETE operation](https://techdocs.akamai.com/property-mgr/reference/delete-property-activation). Note that the `status` member indicates whether the activation is live.",
"type": "string",
"enum": [
"steady",
"received",
"lived",
"deployed",
"cancelling"
]
},
"groupId": {
"description": "Identifies the group under which the property activated. 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"
},
"network": {
"description": "The network to activate on, either `STAGING` or `PRODUCTION`.",
"type": "string",
"enum": [
"STAGING",
"PRODUCTION"
]
},
"note": {
"description": "Assigns a log message to the activation request.",
"type": "string"
},
"notifyEmails": {
"description": "Email addresses to notify when the activation status changes.",
"minItems": 0,
"type": "array",
"items": {
"type": "string"
}
},
"propertyId": {
"description": "Identifies property targeted with activation. 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": "The name of the property targeted with activation.",
"type": "string"
},
"propertyVersion": {
"description": "The property version targeted with activation. Once activated, you can no longer modify that version of the property.",
"minimum": 1,
"type": "integer"
},
"status": {
"description": "The activation's status. `ACTIVE` if currently serving traffic. `INACTIVE` if another activation has superseded this one. `NEW`, `PENDING`, `ZONE_1`, `ZONE_2`, or `ZONE_3` if not yet active. `ABORTED` if the client followed up with a [DELETE request](https://techdocs.akamai.com/property-mgr/reference/delete-property-activation) in time. `FAILED` if the activation causes a range of edge network errors that [may cause a fallback to the previous activation](https://techdocs.akamai.com/property-mgr/reference/property-activation-error-handling). `PENDING_DEACTIVATION` or `DEACTIVATED` when the `activationType` is `DEACTIVATE` to no longer serve traffic.",
"type": "string",
"enum": [
"ACTIVE",
"INACTIVE",
"PENDING",
"ZONE_1",
"ZONE_2",
"ZONE_3",
"ABORTED",
"FAILED",
"DEACTIVATED",
"PENDING_DEACTIVATION",
"NEW"
]
},
"submitDate": {
"description": "A date stamp marking when the activation initiated.",
"type": "string"
},
"updateDate": {
"description": "A date stamp marking when the `status` last changed.",
"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.",
"minLength": 1,
"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.",
"minLength": 1,
"type": "string"
}
},
"x-akamai": {
"file-path": "schemas/property-activation-get-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"
}
},
"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": "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.",
"example": "{{contractId}}",
"in": "query",
"name": "contractId",
"required": false,
"schema": {
"example": "ctr_1-1TJZFW",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/contractId-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.",
"example": "{{groupId}}",
"in": "query",
"name": "groupId",
"required": false,
"schema": {
"example": "grp_15166",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/groupId-optional.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"
}
}
]
},
"x-akamai": {
"file-path": "paths/property-activations.yaml",
"path-for-file": "/properties/{propertyId}/activations"
},
"x-akamai-descriptor-tools": {
"displayName": "propertyActivations",
"group": "Property activations"
},
"parameters": [
{
"description": "Unique identifier for the property. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting the value's `prp_` prefix.",
"example": "{{propertyId}}",
"in": "path",
"name": "propertyId",
"required": true,
"schema": {
"example": "prp_12345",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/propertyId-path.yaml"
}
}
]
},
"/properties/{propertyId}/activations/{activationId}": {
"get": {
"description": "Gets details about an activation. You typically get a single activation from an `activationLink` when [launching a new activation](https://techdocs.akamai.com/property-mgr/reference/post-property-activations) and following up to poll its `status`. For activations whose `status` is `PENDING`, a `Retry-After` header provides an estimate for when it's likely to change.",
"operationId": "get-property-activation",
"summary": "Akamai Get a Property Activation",
"tags": [
"Property activations"
],
"externalDocs": {
"description": "See documentation for this operation in Akamai's Property Manager API",
"url": "https://techdocs.akamai.com/property-mgr/reference/get-property-activation"
},
"responses": {
"200": {
"description": "The response shows the property activation details.",
"content": {
"application/json": {
"example": {
"accountId": "act_A-CCT9012",
"contractId": "ctr_C-0N7RAC7",
"groupId": "grp_15225",
"activations": {
"items": [
{
"activationId": "atv_1696985",
"activationType": "ACTIVATE",
"fmaActivationState": "steady",
"network": "STAGING",
"note": "Sample activation",
"propertyId": "prp_173136",
"propertyName": "example.com",
"propertyVersion": 1,
"status": "PENDING",
"submitDate": "2014-03-02T02:22:12Z",
"updateDate": "2014-03-01T21:12:57Z",
"notifyEmails": [
"you@example.com",
"them@example.com"
],
"fallbackInfo": {
"canFastFallback": true,
"fallbackVersion": 10,
"fastFallbackAttempted": false,
"fastFallbackExpirationTime": 1506451772,
"fastFallbackRecoveryState": null,
"steadyStateTime": 1506448172
}
}
]
}
},
"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/GetActivationResponse.json#",
"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.",
"minLength": 1,
"type": "string"
},
"activations": {
"additionalProperties": false,
"description": "The set of requested activations, available within an `items` array.",
"type": "object",
"properties": {
"items": {
"description": "Activated property versions on a specific network. Relevant response objects appear within the outer envelope's `activations.items` array.",
"type": "array",
"items": {
"additionalProperties": false,
"type": "object",
"required": [
"activationId",
"activationType",
"network",
"note",
"notifyEmails",
"propertyId",
"propertyName",
"status",
"submitDate",
"updateDate"
],
"properties": {
"accountId": {
"description": "Identifies the account under which the property activated. 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"
},
"activationId": {
"description": "The activation's unique identifier. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on how to omit the ID's `atv_` prefix.",
"type": "string"
},
"activationType": {
"description": "Either `ACTIVATE` or `DEACTIVATE`. The default is `ACTIVATE`. Any new activation automatically deactivates the current activation. Note that if you were to POST a `DEACTIVATE` type on an active property, it would no longer serve any traffic. You'd need to modify your DNS configuration and specify a different way to field the traffic.",
"type": "string",
"enum": [
"ACTIVATE",
"DEACTIVATE"
]
},
"failureCause": {
"description": "If the activation's `status` is `FAILED`, this HTTP problem object describes the reason for the failure. This only appears when activating with `delayValidations` enabled.",
"type": "object"
},
"fallbackInfo": {
"additionalProperties": false,
"description": "Encapsulates information about fast fallback. You can use it to fall back to a previous activation when POSTing an activation with `useFastFallback` enabled.",
"type": "object",
"required": [
"canFastFallback",
"fallbackVersion",
"fastFallbackAttempted",
"fastFallbackExpirationTime",
"fastFallbackRecoveryState",
"steadyStateTime"
],
"properties": {
"canFastFallback": {
"description": "Whether the current activation can fallback to a previous version. This is typically `false` for new properties, or for property versions whose set of hostnames has changed.",
"type": "boolean"
},
"fallbackVersion": {
"description": "Indicates the property version that activates when a fast fallback succeeds.",
"minimum": 1,
"type": "integer"
},
"fastFallbackAttempted": {
"description": "Whether a fast fallback has already been attempted on this activation.",
"type": "boolean"
},
"fastFallbackExpirationTime": {
"description": "Epoch second timestamp marking when fast fallback is no longer possible for this activation.",
"type": "integer"
},
"fastFallbackRecoveryState": {
"description": "Represents additional information available for any attempted fallback.",
"nullable": true,
"type": [
"string",
"null"
]
},
"propertyVersion": {
"description": "The version for which fast fallback may be available.",
"minimum": 1,
"type": "integer"
},
"steadyStateTime": {
"description": "Epoch second timestamp marking when the activation completed, signaled by an `fmaActivationState` of `steady`.",
"type": "integer"
}
}
},
"fmaActivationState": {
"description": "Indicates fast metadata activation state. A value of `steady` indicates the property is currently active or has been cancelled. Values of `received`, `lived`, and `deployed` represent progressive stages of activation, while `cancelling` happens either after failing a network safety check or in response to a [DELETE operation](https://techdocs.akamai.com/property-mgr/reference/delete-property-activation). Note that the `status` member indicates whether the activation is live.",
"type": "string",
"enum": [
"steady",
"received",
"lived",
"deployed",
"cancelling"
]
},
"groupId": {
"description": "Identifies the group under which the property activated. 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"
},
"network": {
"description": "The network to activate on, either `STAGING` or `PRODUCTION`.",
"type": "string",
"enum": [
"STAGING",
"PRODUCTION"
]
},
"note": {
"description": "Assigns a log message to the activation request.",
"type": "string"
},
"notifyEmails": {
"description": "Email addresses to notify when the activation status changes.",
"minItems": 0,
"type": "array",
"items": {
"type": "string"
}
},
"propertyId": {
"description": "Identifies property targeted with activation. 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": "The name of the property targeted with activation.",
"type": "string"
},
"propertyVersion": {
"description": "The property version targeted with activation. Once activated, you can no longer modify that version of the property.",
"minimum": 1,
"type": "integer"
},
"status": {
"description": "The activation's status. `ACTIVE` if currently serving traffic. `INACTIVE` if another activation has superseded this one. `NEW`, `PENDING`, `ZONE_1`, `ZONE_2`, or `ZONE_3` if not yet active. `ABORTED` if the client followed up with a [DELETE request](https://techdocs.akamai.com/property-mgr/reference/delete-property-activation) in time. `FAILED` if the activation causes a range of edge network errors that [may cause a fallback to the previous activation](https://techdocs.akamai.com/property-mgr/reference/property-activation-error-handling). `PENDING_DEACTIVATION` or `DEACTIVATED` when the `activationType` is `DEACTIVATE` to no longer serve traffic.",
"type": "string",
"enum": [
"ACTIVE",
"INACTIVE",
"PENDING",
"ZONE_1",
"ZONE_2",
"ZONE_3",
"ABORTED",
"FAILED",
"DEACTIVATED",
"PENDING_DEACTIVATION",
"NEW"
]
},
"submitDate": {
"description": "A date stamp marking when the activation initiated.",
"type": "string"
},
"updateDate": {
"description": "A date stamp marking when the `status` last changed.",
"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.",
"minLength": 1,
"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.",
"minLength": 1,
"type": "string"
}
},
"x-akamai": {
"file-path": "schemas/property-activation-get-response.yaml"
}
}
}
},
"headers": {
"Retry-After": {
"description": "For activations whose `status` remains `PENDING`, this specifies the number of seconds it will likely take to go live.",
"schema": {
"type": "string"
},
"x-akamai": {
"file-path": "headers/Retry-After.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"
}
},
"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": "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.",
"example": "{{contractId}}",
"in": "query",
"name": "contractId",
"required": false,
"schema": {
"example": "ctr_1-1TJZFW",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/contractId-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.",
"example": "{{groupId}}",
"in": "query",
"name": "groupId",
"required": false,
"schema": {
"example": "grp_15166",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/groupId-optional.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"
}
}
]
},
"delete": {
"description": "If you detect a problem with a property version while its activation is still `PENDING`, use this operation to cancel it. Make a DELETE request on the `activationLink` you get from the [Activate a property](https://techdocs.akamai.com/property-mgr/reference/post-property-activations) operation's response. Once you DELETE the activation, it no longer appears in the [list of activations](https://techdocs.akamai.com/property-mgr/reference/get-property-activations), but you can still [access it individually](https://techdocs.akamai.com/property-mgr/reference/get-property-activation). If there are unexpected problems with an activation that goes live before you're able to cancel it, you often have a one-hour window to quickly fall back to a previous activation. See [Activate or deactivate a property](https://techdocs.akamai.com/property-mgr/reference/post-property-activations) for details.",
"operationId": "delete-property-activation",
"summary": "Akamai Cancel a Property's Pending Activation",
"tags": [
"Property activations"
],
"externalDocs": {
"description": "See documentation for this operation in Akamai's Property Manager API",
"url": "https://techdocs.akamai.com/property-mgr/reference/delete-property-activation"
},
"responses": {
"200": {
"description": "The response shows details for the cancelled property activation.",
"content": {
"application/json": {
"example": {
"activations": {
"items": [
{
"accountId": "act_A-CCT5678",
"activationId": "atv_1696985",
"activationType": "ACTIVATE",
"groupId": "grp_15225",
"network": "STAGING",
"note": "Sample activation cancellation",
"propertyId": "prp_173136",
"propertyName": "example.com",
"propertyVersion": 1,
"status": "ABORTED",
"submitDate": "2014-03-02T02:22:12Z",
"updateDate": "2014-03-01T21:12:57Z",
"notifyEmails": [
"you@example.com",
"them@example.com"
]
}
]
}
},
"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/GetActivationResponse.json#",
"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.",
"minLength": 1,
"type": "string"
},
"activations": {
"additionalProperties": false,
"description": "The set of requested activations, available within an `items` array.",
"type": "object",
"properties": {
"items": {
"description": "Activated property versions on a specific network. Relevant response objects appear within the outer envelope's `activations.items` array.",
"type": "array",
"items": {
"additionalProperties": false,
"type": "object",
"required": [
"activationId",
"activationType",
"network",
"note",
"notifyEmails",
"propertyId",
"propertyName",
"status",
"submitDate",
"updateDate"
],
"properties": {
"accountId": {
"description": "Identifies the account under which the property activated. 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"
},
"activationId": {
"description": "The activation's unique identifier. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on how to omit the ID's `atv_` prefix.",
"type": "string"
},
"activationType": {
"description": "Either `ACTIVATE` or `DEACTIVATE`. The default is `ACTIVATE`. Any new activation automatically deactivates the current activation. Note that if you were to POST a `DEACTIVATE` type on an active property, it would no longer serve any traffic. You'd need to modify your DNS configuration and specify a different way to field the traffic.",
"type": "string",
"enum": [
"ACTIVATE",
"DEACTIVATE"
]
},
"failureCause": {
"description": "If the activation's `status` is `FAILED`, this HTTP problem object describes the reason for the failure. This only appears when activating with `delayValidations` enabled.",
"type": "object"
},
"fallbackInfo": {
"additionalProperties": false,
"description": "Encapsulates information about fast fallback. You can use it to fall back to a previous activation when POSTing an activation with `useFastFallback` enabled.",
"type": "object",
"required": [
"canFastFallback",
"fallbackVersion",
"fastFallbackAttempted",
"fastFallbackExpirationTime",
"fastFallbackRecoveryState",
"steadyStateTime"
],
"properties": {
"canFastFallback": {
"description": "Whether the current activation can fallback to a previous version. This is typically `false` for new properties, or for property versions whose set of hostnames has changed.",
"type": "boolean"
},
"fallbackVersion": {
"description": "Indicates the property version that activates when a fast fallback succeeds.",
"minimum": 1,
"type": "integer"
},
"fastFallbackAttempted": {
"description": "Whether a fast fallback has already been attempted on this activation.",
"type": "boolean"
},
"fastFallbackExpirationTime": {
"description": "Epoch second timestamp marking when fast fallback is no longer possible for this activation.",
"type": "integer"
},
"fastFallbackRecoveryState": {
"description": "Represents additional information available for any attempted fallback.",
"nullable": true,
"type": [
"string",
"null"
]
},
"propertyVersion": {
"description": "The version for which fast fallback may be available.",
"minimum": 1,
"type": "integer"
},
"steadyStateTime": {
"description": "Epoch second timestamp marking when the activation completed, signaled by an `fmaActivationState` of `steady`.",
"type": "integer"
}
}
},
"fmaActivationState": {
"description": "Indicates fast metadata activation state. A value of `steady` indicates the property is currently active or has been cancelled. Values of `received`, `lived`, and `deployed` represent progressive stages of activation, while `cancelling` happens either after failing a network safety check or in response to a [DELETE operation](https://techdocs.akamai.com/property-mgr/reference/delete-property-activation). Note that the `status` member indicates whether the activation is live.",
"type": "string",
"enum": [
"steady",
"received",
"lived",
"deployed",
"cancelling"
]
},
"groupId": {
"description": "Identifies the group under which the property activated. 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"
},
"network": {
"description": "The network to activate on, either `STAGING` or `PRODUCTION`.",
"type": "string",
"enum": [
"STAGING",
"PRODUCTION"
]
},
"note": {
"description": "Assigns a log message to the activation request.",
"type": "string"
},
"notifyEmails": {
"description": "Email addresses to notify when the activation status changes.",
"minItems": 0,
"type": "array",
"items": {
"type": "string"
}
},
"propertyId": {
"description": "Identifies property targeted with activation. 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": "The name of the property targeted with activation.",
"type": "string"
},
"propertyVersion": {
"description": "The property version targeted with activation. Once activated, you can no longer modify that version of the property.",
"minimum": 1,
"type": "integer"
},
"status": {
"description": "The activation's status. `ACTIVE` if currently serving traffic. `INACTIVE` if another activation has superseded this one. `NEW`, `PENDING`, `ZONE_1`, `ZONE_2`, or `ZONE_3` if not yet active. `ABORTED` if the client followed up with a [DELETE request](https://techdocs.akamai.com/property-mgr/reference/delete-property-activation) in time. `FAILED` if the activation causes a range of edge network errors that [may cause a fallback to the previous activation](https://techdocs.akamai.com/property-mgr/reference/property-activation-error-handling). `PENDING_DEACTIVATION` or `DEACTIVATED` when the `activationType` is `DEACTIVATE` to no longer serve traffic.",
"type": "string",
"enum": [
"ACTIVE",
"INACTIVE",
"PENDING",
"ZONE_1",
"ZONE_2",
"ZONE_3",
"ABORTED",
"FAILED",
"DEACTIVATED",
"PENDING_DEACTIVATION",
"NEW"
]
},
"submitDate": {
"description": "A date stamp marking when the activation initiated.",
"type": "string"
},
"updateDate": {
"description": "A date stamp marking when the `status` last changed.",
"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.",
"minLength": 1,
"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.",
"minLength": 1,
"type": "string"
}
},
"x-akamai": {
"file-path": "schemas/property-activation-get-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"
}
},
"409": {
"description": "[Conflict](https://techdocs.akamai.com/property-mgr/reference/409).",
"content": {
"application/problem+json": {
"example": {
"detail": "Another edit or activation request on same network in progress for this property version.",
"instance": "papi/v1/properties/prp_123456/activations?contractId=ctr_C-0N7RAC7&groupId=grp_12345#abc12345abcc02a7",
"status": 409,
"title": "Operation failed",
"type": "https://problems.luna.akamaiapis.net/papi/v1/resource-busy"
},
"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/409.yaml"
}
},
"422": {
"description": "[Unprocessable content](https://techdocs.akamai.com/property-mgr/reference/422).",
"content": {
"application/problem+json": {
"example": {
"instance": "papi/v1/activations/#abc12345abcc02a7",
"messageId": "property_activation_still_pending",
"result": "ERROR",
"status": 422,
"title": "Property Manager Exception",
"type": "https://problems.luna.akamaiapis.net/papi/v1/property_activation_still_pending",
"params": [
"Property 123456",
"Version 1"
],
"details": {},
"errors": [
{
"detail": "property_activation_still_pending",
"title": "Property Manager Exception",
"type": "papi/v1/property_activation_still_pending"
}
]
},
"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",
"instance",
"status",
"errors",
"details",
"messageId",
"params",
"result"
],
"properties": {
"details": {
"description": "Diagnostic instructions to locate and fix the problem.",
"type": "object"
},
"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"
},
"messageId": {
"description": "Summarizes the cause of the problem.",
"minLength": 1,
"type": "string"
},
"params": {
"description": "Details of the property and version where the problem occured.",
"minItems": 0,
"type": "array",
"items": {
"type": "string"
}
},
"result": {
"description": "Indicates the severity of the problem.",
"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-422.yaml"
}
}
}
},
"x-akamai": {
"file-path": "errors/422.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": "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.",
"example": "{{contractId}}",
"in": "query",
"name": "contractId",
"required": false,
"schema": {
"example": "ctr_1-1TJZFW",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/contractId-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.",
"example": "{{groupId}}",
"in": "query",
"name": "groupId",
"required": false,
"schema": {
"example": "grp_15166",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/groupId-optional.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"
}
}
]
},
"x-akamai": {
"file-path": "paths/property-activation.yaml",
"path-for-file": "/properties/{propertyId}/activations/{activationId}"
},
"x-akamai-descriptor-tools": {
"displayName": "propertyActivation",
"group": "Property activations"
},
"parameters": [
{
"description": "Unique identifier for the property. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting the value's `prp_` prefix.",
"example": "{{propertyId}}",
"in": "path",
"name": "propertyId",
"required": true,
"schema": {
"example": "prp_12345",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/propertyId-path.yaml"
}
},
{
"description": "Unique identifier for the property or include activation.",
"example": "{{activationId}}",
"in": "path",
"name": "activationId",
"required": true,
"schema": {
"example": "atv_1696855",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/activationId-path.yaml"
}
}
]
},
"/properties/{propertyId}/hostname-activations": {
"get": {
"description": "For a property with `useHostnameBucket` set to `true` at [creation](https://techdocs.akamai.com/property-mgr/reference/post-properties), this lists the activations for all hostnames in the property's hostname bucket, on both production and staging networks. To view paginated results, use the response's `nextLink` and `previousLink`.",
"operationId": "get-property-hostname-activations",
"summary": "Akamai List Property Hostname Activations",
"tags": [
"Hostname buckets"
],
"externalDocs": {
"description": "See documentation for this operation in Akamai's Property Manager API",
"url": "https://techdocs.akamai.com/property-mgr/reference/get-property-hostname-activations"
},
"responses": {
"200": {
"description": "The response lists activations of all hostnames in the property's hostname bucket.",
"content": {
"application/json": {
"example": {
"accountId": "act_A-CCT9012",
"contractId": "ctr_K-0N7RAK71",
"currentItemCount": 2,
"groupId": "grp_15225",
"nextLink": "/papi/v1/properties/prp_173136/hostnames-activation?offset=2&groupId=grp_15225&contractId=ctr_C-0N7RAC7&limit=2",
"totalItems": 4,
"hostnameActivations": {
"items": [
{
"activationType": "ACTIVATE",
"hostnameActivationId": "atv_1696985",
"network": "STAGING",
"note": "Sample activation",
"propertyId": "prp_173136",
"propertyName": "example.com",
"propertyVersion": 1,
"status": "ACTIVE",
"submitDate": "2014-03-05T02:22:12Z",
"updateDate": "2014-03-04T21:12:57Z",
"notifyEmails": [
"you@example.com",
"them@example.com"
]
},
{
"activationType": "ACTIVATE",
"hostnameActivationId": "atv_1696986",
"network": "PRODUCTION",
"note": "Sample activation",
"propertyId": "prp_173136",
"propertyName": "example.com",
"propertyVersion": 1,
"status": "PENDING",
"submitDate": "2014-03-02T02:22:12Z",
"updateDate": "2014-03-01T21:12:57Z",
"notifyEmails": [
"you@example.com",
"them@example.com"
]
}
]
}
},
"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/GetHostnameActivationListResponse.json#",
"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.",
"minLength": 1,
"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.",
"minLength": 1,
"type": "string"
},
"currentItemCount": {
"description": "The total count of items present in the current response body for requested criteria.",
"type": "integer"
},
"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.",
"minLength": 1,
"type": "string"
},
"hostnameActivations": {
"additionalProperties": false,
"description": "The set of requested property hostname activations, available within an `items` array.",
"type": "object",
"properties": {
"currentItemCount": {
"description": "The number of items present in the current response body view.",
"minimum": 0,
"type": "integer"
},
"items": {
"description": "Activated property hostnames on a specific network. Relevant response objects appear within the outer envelope's `activations.items` array.",
"type": "array",
"items": {
"additionalProperties": false,
"required": [
"hostnameActivationId",
"activationType",
"network",
"note",
"notifyEmails",
"propertyId",
"propertyName",
"status",
"submitDate",
"updateDate"
],
"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"
},
"activationType": {
"default": "ACTIVATE",
"description": "Either `ACTIVATE` or `DEACTIVATE`. The default is `ACTIVATE`. Any new activation automatically deactivates the current activation. Note that if you were to POST a `DEACTIVATE` type on an active property hostname, it would no longer serve any traffic. You'd need to modify your DNS configuration and specify a different way to field the traffic.",
"type": "string",
"enum": [
"ACTIVATE",
"DEACTIVATE"
]
},
"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"
},
"hostnameActivationId": {
"description": "The property hostname activation's unique identifier. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on how to omit the ID's `atv_` prefix.",
"type": "string"
},
"network": {
"description": "The network to activate on, either `STAGING` or `PRODUCTION`.",
"type": "string",
"enum": [
"STAGING",
"PRODUCTION"
]
},
"note": {
"description": "Assigns a log message to the activation request.",
"type": "string"
},
"notifyEmails": {
"description": "Email addresses to notify when the activation status changes.",
"minItems": 0,
"type": "array",
"items": {
"type": "string"
}
},
"propertyId": {
"description": "Unique identifier for the property with the hostname bucket the activated property hostnames belong to. 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 with the hostname bucket the activated property hostnames belong to.",
"type": "string"
},
"propertyVersion": {
"description": "The version of the property to activate hostnames for.",
"minimum": 1,
"type": "integer"
},
"status": {
"description": "The activation's status. `ACTIVE` if currently serving traffic. `INACTIVE` if another activation has superseded this one. `PENDING` if not yet active. `ABORTED` if the client followed up with a [DELETE request](https://techdocs.akamai.com/property-mgr/reference/delete-property-hostname-activations) in time. `FAILED` if the activation causes a range of edge network errors that [may cause a fallback to the previous activation](https://techdocs.akamai.com/property-mgr/reference/property-activation-error-handling). `PENDING_DEACTIVATION` or `DEACTIVATED` when the `activationType` is `DEACTIVATE` to no longer serve traffic.",
"type": "string",
"enum": [
"ACTIVE",
"INACTIVE",
"PENDING",
"ABORTED",
"FAILED",
"DEACTIVATED",
"PENDING_DEACTIVATION"
]
},
"submitDate": {
"description": "A date stamp marking when the activation initiated.",
"readOnly": true,
"type": "string"
},
"updateDate": {
"description": "A date stamp marking when the `status` last changed.",
"readOnly": true,
"type": "string"
}
}
}
},
"nextLink": {
"description": "For paginated responses, this links to the next set of response items.",
"type": "string"
},
"previousLink": {
"description": "For paginated responses, this links to the next set of response items.",
"type": "string"
},
"totalItems": {
"description": "The total count of items returned for the requested criteria.",
"minimum": 0,
"type": "integer"
}
}
},
"nextLink": {
"description": "The link to next set of response items for paginated response.",
"minLength": 1,
"type": "string"
},
"prevLink": {
"description": "The link to previous set of response items for paginated response.",
"minLength": 1,
"type": "string"
},
"totalItems": {
"description": "The total count of items for requested criteria.",
"type": "integer"
}
},
"x-akamai": {
"file-path": "schemas/property-hostnames-activation-list-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"
}
},
"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 paginated responses, specifies the page of results you want to navigate to, starting from `0`.",
"example": "{{offset}}",
"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.",
"example": "{{limit}}",
"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.",
"example": "{{contractId}}",
"in": "query",
"name": "contractId",
"required": false,
"schema": {
"example": "ctr_1-1TJZFW",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/contractId-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.",
"example": "{{groupId}}",
"in": "query",
"name": "groupId",
"required": false,
"schema": {
"example": "grp_15166",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/groupId-optional.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"
}
}
]
},
"x-akamai": {
"file-path": "paths/property-hostname-activations.yaml",
"path-for-file": "/properties/{propertyId}/hostname-activations"
},
"x-akamai-descriptor-tools": {
"displayName": "hostnameActivations",
"group": "Hostname activations"
},
"parameters": [
{
"description": "Unique identifier for the property. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting the value's `prp_` prefix.",
"example": "{{propertyId}}",
"in": "path",
"name": "propertyId",
"required": true,
"schema": {
"example": "prp_12345",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/propertyId-path.yaml"
}
}
]
},
"/properties/{propertyId}/hostname-activations/{hostnameActivationId}": {
"get": {
"description": "For a property with `useHostnameBucket` set to `true` at [creation](https://techdocs.akamai.com/property-mgr/reference/post-properties), this operation gets details about a specific property hostname activation. You typically get a single activation from an `activationLink` when [launching a new property hostname activation](https://techdocs.akamai.com/property-mgr/reference/patch-property-hostnames) and following up to poll its `status`. For property hostname activations whose `status` is `PENDING`, a `Retry-After` header provides an estimate for when it's likely to change.",
"operationId": "get-property-hostname-activation",
"summary": "Akamai Get a Property Hostname Activation",
"tags": [
"Hostname buckets"
],
"externalDocs": {
"description": "See documentation for this operation in Akamai's Property Manager API",
"url": "https://techdocs.akamai.com/property-mgr/reference/get-property-hostname-activation"
},
"responses": {
"200": {
"description": "The response shows the property hostname activation details.",
"content": {
"application/json": {
"example": {
"accountId": "act_A-CCT1234",
"contractId": "ctr_C-0N7RAC71",
"groupId": "grp_15225",
"activations": {
"items": [
{
"activationId": "atv_1696985",
"activationType": "ACTIVATE",
"fmaActivationState": "steady",
"network": "STAGING",
"note": "Sample activation",
"propertyId": "prp_173136",
"propertyName": "example.com",
"propertyVersion": 1,
"status": "PENDING",
"submitDate": "2014-03-02T02:22:12Z",
"updateDate": "2014-03-01T21:12:57Z",
"notifyEmails": [
"you@example.com",
"them@example.com"
],
"fallbackInfo": {
"canFastFallback": true,
"fallbackVersion": 10,
"fastFallbackAttempted": false,
"fastFallbackExpirationTime": 1506451772,
"fastFallbackRecoveryState": null,
"steadyStateTime": 1506448172
}
}
]
}
},
"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/GetHostnamesBucketActivationResponse.json#",
"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.",
"minLength": 1,
"type": "string"
},
"activations": {
"description": "The set of activated hostnames.",
"type": "object"
},
"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.",
"minLength": 1,
"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.",
"minLength": 1,
"type": "string"
},
"hostnameActivations": {
"additionalProperties": false,
"description": "The set of requested property hostname activations, available within an `items` array.",
"type": "object",
"properties": {
"currentItemCount": {
"description": "The number of items present in the current response body view.",
"minimum": 0,
"type": "integer"
},
"items": {
"description": "Activated property hostnames on a specific network. Relevant response objects appear within the outer envelope's `activations.items` array.",
"type": "array",
"items": {
"additionalProperties": false,
"type": "object",
"required": [
"activationType",
"network",
"note",
"notifyEmails",
"propertyId",
"propertyName",
"status",
"submitDate",
"updateDate"
],
"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"
},
"activationId": {
"description": "The property hostname activation's unique identifier. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on how to omit the ID's `atv_` prefix.",
"type": "string"
},
"activationType": {
"default": "ACTIVATE",
"description": "Either `ACTIVATE` or `DEACTIVATE`. The default is `ACTIVATE`. Any new activation automatically deactivates the current activation. Note that if you were to POST a `DEACTIVATE` type on an active property hostname, it would no longer serve any traffic. You'd need to modify your DNS configuration and specify a different way to field the traffic.",
"type": "string",
"enum": [
"ACTIVATE",
"DEACTIVATE"
]
},
"fallbackInfo": {
"additionalProperties": false,
"description": "Encapsulates information about fast fallback. You can use it to fall back to a previous activation when POSTing an activation with `useFastFallback` enabled.",
"type": "object",
"required": [
"canFastFallback",
"fallbackVersion",
"fastFallbackAttempted",
"fastFallbackExpirationTime",
"fastFallbackRecoveryState",
"steadyStateTime"
],
"properties": {
"canFastFallback": {
"description": "Whether the current activation can fallback to a previous version. This is typically `false` for new properties, or for property versions whose set of hostnames has changed.",
"type": "boolean"
},
"fallbackVersion": {
"description": "Indicates the property version that activates when a fast fallback succeeds.",
"minimum": 1,
"type": "integer"
},
"fastFallbackAttempted": {
"description": "Whether a fast fallback has already been attempted on this activation.",
"type": "boolean"
},
"fastFallbackExpirationTime": {
"description": "Epoch second timestamp marking when fast fallback is no longer possible for this activation.",
"type": "integer"
},
"fastFallbackRecoveryState": {
"description": "Represents additional information available for any attempted fallback.",
"nullable": true,
"type": [
"string",
"null"
]
},
"propertyVersion": {
"description": "The version for which fast fallback may be available.",
"minimum": 1,
"type": "integer"
},
"steadyStateTime": {
"description": "Epoch second timestamp marking when the activation completed, signaled by an `fmaActivationState` of `steady`.",
"type": "integer"
}
}
},
"fmaActivationState": {
"description": "Indicates fast metadata activation state. A value of `steady` indicates the property is currently active or has been cancelled. Values of `received`, `lived`, and `deployed` represent progressive stages of activation, while `cancelling` happens either after failing a network safety check or in response to a [DELETE operation](https://techdocs.akamai.com/property-mgr/reference/delete-property-activation). Note that the `status` member indicates whether the activation is live.",
"type": "string",
"enum": [
"steady",
"received",
"lived",
"deployed",
"cancelling"
]
},
"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"
},
"hostnameActivationId": {
"description": "The property hostname activation's unique identifier. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on how to omit the ID's `atv_` prefix.",
"type": "string"
},
"network": {
"description": "The network to activate on, either `STAGING` or `PRODUCTION`.",
"type": "string",
"enum": [
"STAGING",
"PRODUCTION"
]
},
"note": {
"description": "Assigns a log message to the activation request.",
"type": "string"
},
"notifyEmails": {
"description": "Email addresses to notify when the activation status changes.",
"minItems": 0,
"type": "array",
"items": {
"type": "string"
}
},
"propertyId": {
"description": "Unique identifier for the property with the hostname bucket the activated property hostnames belong to. 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 with the hostname bucket the activated property hostnames belong to.",
"type": "string"
},
"propertyVersion": {
"description": "The property version targeted with activation. Once activated, you can no longer modify that version of the property.",
"minimum": 1,
"type": "integer"
},
"status": {
"description": "The activation's status. `ACTIVE` if currently serving traffic. `INACTIVE` if another activation has superseded this one. `PENDING` if not yet active. `ABORTED` if the client followed up with a [DELETE request](https://techdocs.akamai.com/property-mgr/reference/delete-property-hostname-activations) in time. `FAILED` if the activation causes a range of edge network errors that [may cause a fallback to the previous activation](https://techdocs.akamai.com/property-mgr/reference/property-activation-error-handling). `PENDING_DEACTIVATION` or `DEACTIVATED` when the `activationType` is `DEACTIVATE` to no longer serve traffic.",
"type": "string",
"enum": [
"ACTIVE",
"INACTIVE",
"PENDING",
"ABORTED",
"FAILED",
"DEACTIVATED",
"PENDING_DEACTIVATION"
]
},
"submitDate": {
"description": "A date stamp marking when the activation initiated.",
"readOnly": true,
"type": "string"
},
"updateDate": {
"description": "A date stamp marking when the `status` last changed.",
"readOnly": true,
"type": "string"
}
}
}
},
"nextLink": {
"description": "For paginated responses, this links to the next set of response items.",
"type": "string"
},
"previousLink": {
"description": "For paginated responses, this links to the next set of response items.",
"type": "string"
},
"totalItems": {
"description": "The total count of items returned for the requested criteria.",
"minimum": 0,
"type": "integer"
}
}
}
},
"x-akamai": {
"file-path": "schemas/property-hostnames-activation-get-response.yaml"
}
}
}
},
"headers": {
"Retry-After": {
"description": "For activations whose `status` remains `PENDING`, this specifies the number of seconds it will likely take to go live.",
"schema": {
"type": "string"
},
"x-akamai": {
"file-path": "headers/Retry-After.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"
}
},
"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": "Whether the response should include the property hostnames associated with an activation and the related certificate status on staging and production networks.",
"example": "{{includeHostnames}}",
"in": "query",
"name": "includeHostnames",
"required": false,
"schema": {
"default": false,
"example": false,
"type": "boolean"
},
"x-akamai": {
"file-path": "parameters/includeHostnames-query.yaml"
}
},
{
"description": "Unique identifier for the contract. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting the value's `ctr_` prefix.",
"example": "{{contractId}}",
"in": "query",
"name": "contractId",
"required": true,
"schema": {
"example": "ctr_1-1TJZFW",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/contractId-required.yaml"
}
},
{
"description": "Unique identifier for the group. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting the value's `grp_` prefix.",
"example": "{{groupId}}",
"in": "query",
"name": "groupId",
"required": true,
"schema": {
"example": "grp_15166",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/groupId-required.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"
}
}
]
},
"delete": {
"description": "For a property with `useHostnameBucket` set to `true` [when created](https://techdocs.akamai.com/property-mgr/reference/post-properties), if you detect a problem with a property hostname while its activation is still `PENDING`, use this operation to cancel it. Make a DELETE request on the `activationLink` you get from the [Add or remove hostnames for a property](https://techdocs.akamai.com/property-mgr/reference/patch-property-hostnames) operation's response. Once you DELETE the activation, it no longer appears in the [list of activations](https://techdocs.akamai.com/property-mgr/reference/get-property-hostname-activations), but you can still [access it individually](https://techdocs.akamai.com/property-mgr/reference/get-property-hostname-activation).",
"operationId": "delete-property-hostname-activations",
"summary": "Akamai Cancel a Pending Property Hostname Activation",
"tags": [
"Hostname buckets"
],
"externalDocs": {
"description": "See documentation for this operation in Akamai's Property Manager API",
"url": "https://techdocs.akamai.com/property-mgr/reference/delete-property-hostname-activations"
},
"responses": {
"200": {
"description": "The response shows a status of the cancelled hostname activation for the specified property.",
"content": {
"application/json": {
"example": {
"hostnameActivations": {
"items": [
{
"accountId": "act_A-CCT7890",
"activationType": "ACTIVATE",
"groupId": "grp_15225",
"hostnameActivationId": "atv_1696985",
"network": "STAGING",
"note": "Sample activation cancellation",
"propertyId": "prp_173136",
"propertyName": "example.com",
"propertyVersion": 1,
"status": "ABORTED",
"submitDate": "2014-03-02T02:22:12Z",
"updateDate": "2014-03-01T21:12:57Z",
"notifyEmails": [
"you@example.com",
"them@example.com"
]
}
]
}
},
"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/GetHostnamesBucketActivationResponse.json#",
"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.",
"minLength": 1,
"type": "string"
},
"activations": {
"description": "The set of activated hostnames.",
"type": "object"
},
"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.",
"minLength": 1,
"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.",
"minLength": 1,
"type": "string"
},
"hostnameActivations": {
"additionalProperties": false,
"description": "The set of requested property hostname activations, available within an `items` array.",
"type": "object",
"properties": {
"currentItemCount": {
"description": "The number of items present in the current response body view.",
"minimum": 0,
"type": "integer"
},
"items": {
"description": "Activated property hostnames on a specific network. Relevant response objects appear within the outer envelope's `activations.items` array.",
"type": "array",
"items": {
"additionalProperties": false,
"type": "object",
"required": [
"activationType",
"network",
"note",
"notifyEmails",
"propertyId",
"propertyName",
"status",
"submitDate",
"updateDate"
],
"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"
},
"activationId": {
"description": "The property hostname activation's unique identifier. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on how to omit the ID's `atv_` prefix.",
"type": "string"
},
"activationType": {
"default": "ACTIVATE",
"description": "Either `ACTIVATE` or `DEACTIVATE`. The default is `ACTIVATE`. Any new activation automatically deactivates the current activation. Note that if you were to POST a `DEACTIVATE` type on an active property hostname, it would no longer serve any traffic. You'd need to modify your DNS configuration and specify a different way to field the traffic.",
"type": "string",
"enum": [
"ACTIVATE",
"DEACTIVATE"
]
},
"fallbackInfo": {
"additionalProperties": false,
"description": "Encapsulates information about fast fallback. You can use it to fall back to a previous activation when POSTing an activation with `useFastFallback` enabled.",
"type": "object",
"required": [
"canFastFallback",
"fallbackVersion",
"fastFallbackAttempted",
"fastFallbackExpirationTime",
"fastFallbackRecoveryState",
"steadyStateTime"
],
"properties": {
"canFastFallback": {
"description": "Whether the current activation can fallback to a previous version. This is typically `false` for new properties, or for property versions whose set of hostnames has changed.",
"type": "boolean"
},
"fallbackVersion": {
"description": "Indicates the property version that activates when a fast fallback succeeds.",
"minimum": 1,
"type": "integer"
},
"fastFallbackAttempted": {
"description": "Whether a fast fallback has already been attempted on this activation.",
"type": "boolean"
},
"fastFallbackExpirationTime": {
"description": "Epoch second timestamp marking when fast fallback is no longer possible for this activation.",
"type": "integer"
},
"fastFallbackRecoveryState": {
"description": "Represents additional information available for any attempted fallback.",
"nullable": true,
"type": [
"string",
"null"
]
},
"propertyVersion": {
"description": "The version for which fast fallback may be available.",
"minimum": 1,
"type": "integer"
},
"steadyStateTime": {
"description": "Epoch second timestamp marking when the activation completed, signaled by an `fmaActivationState` of `steady`.",
"type": "integer"
}
}
},
"fmaActivationState": {
"description": "Indicates fast metadata activation state. A value of `steady` indicates the property is currently active or has been cancelled. Values of `received`, `lived`, and `deployed` represent progressive stages of activation, while `cancelling` happens either after failing a network safety check or in response to a [DELETE operation](https://techdocs.akamai.com/property-mgr/reference/delete-property-activation). Note that the `status` member indicates whether the activation is live.",
"type": "string",
"enum": [
"steady",
"received",
"lived",
"deployed",
"cancelling"
]
},
"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"
},
"hostnameActivationId": {
"description": "The property hostname activation's unique identifier. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on how to omit the ID's `atv_` prefix.",
"type": "string"
},
"network": {
"description": "The network to activate on, either `STAGING` or `PRODUCTION`.",
"type": "string",
"enum": [
"STAGING",
"PRODUCTION"
]
},
"note": {
"description": "Assigns a log message to the activation request.",
"type": "string"
},
"notifyEmails": {
"description": "Email addresses to notify when the activation status changes.",
"minItems": 0,
"type": "array",
"items": {
"type": "string"
}
},
"propertyId": {
"description": "Unique identifier for the property with the hostname bucket the activated property hostnames belong to. 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 with the hostname bucket the activated property hostnames belong to.",
"type": "string"
},
"propertyVersion": {
"description": "The property version targeted with activation. Once activated, you can no longer modify that version of the property.",
"minimum": 1,
"type": "integer"
},
"status": {
"description": "The activation's status. `ACTIVE` if currently serving traffic. `INACTIVE` if another activation has superseded this one. `PENDING` if not yet active. `ABORTED` if the client followed up with a [DELETE request](https://techdocs.akamai.com/property-mgr/reference/delete-property-hostname-activations) in time. `FAILED` if the activation causes a range of edge network errors that [may cause a fallback to the previous activation](https://techdocs.akamai.com/property-mgr/reference/property-activation-error-handling). `PENDING_DEACTIVATION` or `DEACTIVATED` when the `activationType` is `DEACTIVATE` to no longer serve traffic.",
"type": "string",
"enum": [
"ACTIVE",
"INACTIVE",
"PENDING",
"ABORTED",
"FAILED",
"DEACTIVATED",
"PENDING_DEACTIVATION"
]
},
"submitDate": {
"description": "A date stamp marking when the activation initiated.",
"readOnly": true,
"type": "string"
},
"updateDate": {
"description": "A date stamp marking when the `status` last changed.",
"readOnly": true,
"type": "string"
}
}
}
},
"nextLink": {
"description": "For paginated responses, this links to the next set of response items.",
"type": "string"
},
"previousLink": {
"description": "For paginated responses, this links to the next set of response items.",
"type": "string"
},
"totalItems": {
"description": "The total count of items returned for the requested criteria.",
"minimum": 0,
"type": "integer"
}
}
}
},
"x-akamai": {
"file-path": "schemas/property-hostnames-activation-get-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"
}
},
"409": {
"description": "[Conflict](https://techdocs.akamai.com/property-mgr/reference/409).",
"content": {
"application/problem+json": {
"example": {
"detail": "Another edit or activation request on same network in progress for this property version.",
"instance": "papi/v1/properties/prp_123456/activations?contractId=ctr_C-0N7RAC7&groupId=grp_12345#abc12345abcc02a7",
"status": 409,
"title": "Operation failed",
"type": "https://problems.luna.akamaiapis.net/papi/v1/resource-busy"
},
"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/409.yaml"
}
},
"422": {
"description": "[Unprocessable content](https://techdocs.akamai.com/property-mgr/reference/422).",
"content": {
"application/problem+json": {
"example": {
"instance": "papi/v1/activations/#abc12345abcc02a7",
"messageId": "property_activation_still_pending",
"result": "ERROR",
"status": 422,
"title": "Property Manager Exception",
"type": "https://problems.luna.akamaiapis.net/papi/v1/property_activation_still_pending",
"params": [
"Property 123456",
"Version 1"
],
"details": {},
"errors": [
{
"detail": "property_activation_still_pending",
"title": "Property Manager Exception",
"type": "papi/v1/property_activation_still_pending"
}
]
},
"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",
"instance",
"status",
"errors",
"details",
"messageId",
"params",
"result"
],
"properties": {
"details": {
"description": "Diagnostic instructions to locate and fix the problem.",
"type": "object"
},
"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"
},
"messageId": {
"description": "Summarizes the cause of the problem.",
"minLength": 1,
"type": "string"
},
"params": {
"description": "Details of the property and version where the problem occured.",
"minItems": 0,
"type": "array",
"items": {
"type": "string"
}
},
"result": {
"description": "Indicates the severity of the problem.",
"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-422.yaml"
}
}
}
},
"x-akamai": {
"file-path": "errors/422.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": "Unique identifier for the contract. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting the value's `ctr_` prefix.",
"example": "{{contractId}}",
"in": "query",
"name": "contractId",
"required": true,
"schema": {
"example": "ctr_1-1TJZFW",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/contractId-required.yaml"
}
},
{
"description": "Unique identifier for the group. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting the value's `grp_` prefix.",
"example": "{{groupId}}",
"in": "query",
"name": "groupId",
"required": true,
"schema": {
"example": "grp_15166",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/groupId-required.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"
}
}
]
},
"x-akamai": {
"file-path": "paths/property-hostname-activation.yaml",
"path-for-file": "/properties/{propertyId}/hostname-activations/{hostnameActivationId}"
},
"x-akamai-descriptor-tools": {
"displayName": "hostnameActivation",
"group": "Hostname activations"
},
"parameters": [
{
"description": "Unique identifier for the property. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting the value's `prp_` prefix.",
"example": "{{propertyId}}",
"in": "path",
"name": "propertyId",
"required": true,
"schema": {
"example": "prp_12345",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/propertyId-path.yaml"
}
},
{
"description": "Unique identifier for the hostname activation.",
"example": "{{hostnameActivationId}}",
"in": "path",
"name": "hostnameActivationId",
"required": true,
"schema": {
"example": "atv_1696985",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/hostnameActivationId-path.yaml"
}
}
]
},
"/properties/{propertyId}/hostnames": {
"get": {
"description": "This operation lists active property hostnames assigned to a specific property. Use the optional query parameters to paginate, sort, and filter the results. You can nest and combine filters to obtain desired results. To view paginated results, use the response's `nextLink` and `previousLink`. You can call this operation by specifying any of the `propertyId` members from a [list of properties](https://techdocs.akamai.com/property-mgr/reference/get-properties), or by running a GET on the `propertyLink` response when [creating a new property](https://techdocs.akamai.com/property-mgr/reference/post-properties).",
"operationId": "get-property-hostnames",
"summary": "Akamai List Hostnames for a Property",
"tags": [
"Active property hostnames"
],
"externalDocs": {
"description": "See documentation for this operation in Akamai's Property Manager API",
"url": "https://techdocs.akamai.com/property-mgr/reference/get-property-hostnames"
},
"responses": {
"200": {
"description": "The response lists active property hostnames for the requested property.",
"content": {
"application/json": {
"example": {
"accountId": "act_A-CCT3456",
"contractId": "ctr_K-0N7RAK71",
"currentSort": "hostname:a",
"defaultSort": "hostname:a",
"groupId": "grp_15225",
"propertyId": "prp_175780",
"availableSort": [
"hostname:a",
"hostname:d"
],
"hostnames": {
"currentItemCount": 3,
"nextLink": "/papi/v1/properties/prp_175780/hostnames?offset=1&groupId=grp_15225&contractId=ctr_C-0N7RAC7&limit=3",
"totalItems": 4,
"items": [
{
"cnameFrom": "example.com",
"cnameType": "EDGE_HOSTNAME",
"productionCertType": "DEFAULT",
"productionCnameTo": "example.com.edgekey.net",
"productionEdgeHostnameId": "ehn_895822"
},
{
"cnameFrom": "m-example.com",
"cnameType": "EDGE_HOSTNAME",
"stagingCertType": "DEFAULT",
"stagingCnameTo": "m-example.com.edgekey.net",
"stagingEdgeHostnameId": "ehn_293412"
},
{
"cnameFrom": "example2.com",
"cnameType": "EDGE_HOSTNAME",
"stagingCertType": "DEFAULT",
"stagingCnameTo": "example2.com.edgekey.net",
"stagingEdgeHostnameId": "ehn_895822",
"certStatus": {
"validationCname": {
"hostname": "_acme-challenge.www.example.com",
"target": "{token}.www.example.com.akamai-domain.com"
},
"production": [
{
"status": "PENDING"
}
],
"staging": [
{
"status": "PENDING"
}
]
}
}
]
}
},
"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, even individual items. See [ID prefixes](#prefixes) for more information.",
"id": "resource:/descriptors/papi/v1/schemas/GetPropertyHostnamesResponse.json#",
"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"
},
"availableSort": {
"description": "Available sorting options: `hostname:a` for ascending, and `hostname:d` for descending.",
"minItems": 1,
"type": "array",
"items": {
"type": "string",
"enum": [
"hostname:a",
"hostname:d"
]
}
},
"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"
},
"currentSort": {
"description": "The sorting criteria applied to the response, either `hostname:a` for ascending, or `hostname:d` for descending.",
"type": "string",
"enum": [
"hostname:a",
"hostname:d"
]
},
"defaultSort": {
"default": "hostname:a",
"description": "If no query parameters were specified in the request, this shows the default `hostname:a` sorting criteria.",
"type": "string"
},
"groupId": {
"description": "Identifies the 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"
},
"hostnames": {
"additionalProperties": false,
"description": "The set of requested property hostnames, available within an `items` array.",
"type": "object",
"required": [
"items",
"totalItems",
"currentItemCount"
],
"properties": {
"currentItemCount": {
"description": "The total count of items present in the current response body for requested criteria.",
"type": "integer"
},
"items": {
"description": "Each entry specifies an active property hostname.",
"type": "array",
"items": {
"allOf": [
{
"additionalProperties": false,
"description": "Specifies a property hostname that's applied to a property. Writing data to this resource requires that you PUT an array of _all_ the hostname objects, each containing `edgeHostnameId`, `cnameFrom`, and `cnameTo` members. This request array matches the `hostnames.items` in the response.",
"type": "object",
"required": [
"cnameFrom"
],
"properties": {
"certStatus": {
"additionalProperties": false,
"description": "__Limited availability__ With the `includeCertStatus` parameter set to `true`, determines whether a hostname is capable of serving secure content over the staging or production network.",
"type": "object",
"properties": {
"production": {
"description": "__Limited availability__ The certificate status for the hostname on the production network.",
"minItems": 1,
"type": "array",
"items": {
"oneOf": [
{
"additionalProperties": false,
"description": "__Limited availability__ The certificate status for the hostname on the production network.",
"title": "Certificate status",
"type": "object",
"properties": {
"status": {
"description": "__Limited availability__ The status of the certificate deployment on the production network.\n\n\nExpand for details on possible values.\n
\n\nDEPLOYING indicates the deployment is in progress.\nPENDING indicates you need to add the validation challenge to your DNS and activate the property version on staging or production to deploy your certificate to that network. If you've done that already, run the operation again later to check if the deployment succeeded.\nNEEDS_ACTIVATION indicates the validation is complete and the status on the `production` network is either `DEPLOYING` or `DEPLOYED`. You need to activate the property version on staging to deploy the certificate to that network.\nDEPLOYED indicates the certificate is successfully validated on the network and ready to handle secure traffic.\nSTALLED indicates a problem with validation or deployment of your certificate. To try again, re-launch a certificate validation or contact Akamai Professional Services for help.\nPROHIBITED_DOMAIN_FAILURE indicates the hostname isn't in the Let's Encrypt Certificate Authority domain allow list. Fix the underlying issue and re-launch a certificate validation, or contact Akamai Professional Services for help.\nCAA_MISMATCH_RETRYING or CAA_MISMATCH_FAILURE indicate you need to configure your Certification Authority Authorization (CAA) policy to allow Let's Encrypt. Fix the underlying issue and re-launch a certificate validation, or contact Akamai Professional Services for help.\nEXPIRING_SOON_NEEDS_VALIDATION indicates your certificate is due to expire or already expired, and you need to add the _acme-challenge validation CNAME record in your DNS again.\nCNAME_MISSING_FAILURE indicates you removed the validation record from your DNS. Add the CNAME record to your DNS again and re-launch a certificate validation, or contact Akamai Professional Services for help.\nUNKNOWN_FAILURE To try again, re-launch a certificate validation or contact Akamai Professional Services for help.
",
"type": "string",
"enum": [
"DEPLOYING",
"PENDING",
"NEEDS_ACTIVATION",
"DEPLOYED",
"STALLED",
"PROHIBITED_DOMAIN_FAILURE",
"CAA_MISMATCH_RETRYING",
"CAA_MISMATCH_FAILURE",
"EXPIRING_SOON_NEEDS_VALIDATION",
"EXPIRED_NEEDS_VALIDATION",
"CNAME_MISSING_FAILURE",
"UNKNOWN_FAILURE"
],
"x-akamai": {
"status": "LA"
}
}
},
"x-akamai": {
"status": "LA"
}
}
]
},
"x-akamai": {
"status": "LA"
}
},
"staging": {
"description": "__Limited availability__ The certificate status for the hostname on the staging network.",
"minItems": 1,
"type": "array",
"items": {
"oneOf": [
{
"additionalProperties": false,
"description": "__Limited availability__ The certificate status for the hostname on the staging network.",
"title": "Certificate status",
"type": "object",
"properties": {
"status": {
"description": "__Limited availability__ The status of the certificate deployment on the staging network.\n\n\nExpand for details on possible values.\n
\n\nDEPLOYING indicates the deployment is in progress.\nPENDING indicates you need to add the validation challenge to your DNS and activate the property version on staging or production to deploy your certificate to that network. If you've done that already, run the operation again later to check if the deployment succeeded.\nNEEDS_ACTIVATION indicates the validation is complete and the status on the `production` network is either `DEPLOYING` or `DEPLOYED`. You need to activate the property version on staging to deploy the certificate to that network.\nDEPLOYED indicates the certificate is successfully validated on the network and ready to handle secure traffic.\nSTALLED indicates a problem with validation or deployment of your certificate. To try again, re-launch a certificate validation or contact Akamai Professional Services for help.\nPROHIBITED_DOMAIN_FAILURE indicates the hostname isn't in the Let's Encrypt Certificate Authority domain allow list. Fix the underlying issue and re-launch a certificate validation, or contact Akamai Professional Services for help.\nCAA_MISMATCH_RETRYING or CAA_MISMATCH_FAILURE indicate you need to configure your Certification Authority Authorization (CAA) policy to allow Let's Encrypt. Fix the underlying issue and re-launch a certificate validation, or contact Akamai Professional Services for help.\nEXPIRING_SOON_NEEDS_VALIDATION indicates your certificate is due to expire or already expired, and you need to add the _acme-challenge validation CNAME record in your DNS again.\nCNAME_MISSING_FAILURE indicates you removed the validation record from your DNS. Add the CNAME record to your DNS again and re-launch a certificate validation, or contact Akamai Professional Services for help.\nUNKNOWN_FAILURE To try again, re-launch a certificate validation or contact Akamai Professional Services for help.
",
"type": "string",
"enum": [
"DEPLOYING",
"PENDING",
"NEEDS_ACTIVATION",
"DEPLOYED",
"STALLED",
"PROHIBITED_DOMAIN_FAILURE",
"CAA_MISMATCH_RETRYING",
"CAA_MISMATCH_FAILURE",
"EXPIRING_SOON_NEEDS_VALIDATION",
"EXPIRED_NEEDS_VALIDATION",
"CNAME_MISSING_FAILURE",
"UNKNOWN_FAILURE"
],
"x-akamai": {
"status": "LA"
}
}
},
"x-akamai": {
"status": "LA"
}
}
]
},
"x-akamai": {
"status": "LA"
}
},
"validationCname": {
"additionalProperties": false,
"description": "__Limited availability__ The CNAME record used to validate the certificate's domain.",
"type": "object",
"required": [
"hostname",
"target"
],
"properties": {
"hostname": {
"description": "__Limited availability__ The hostname part of the CNAME record used to validate the certificate's domain.",
"type": "string",
"x-akamai": {
"status": "LA"
}
},
"target": {
"description": "__Limited availability__ The destination part of the CNAME record used to validate the certificate's domain.",
"type": "string",
"x-akamai": {
"status": "LA"
}
}
},
"x-akamai": {
"status": "LA"
}
}
},
"x-akamai": {
"status": "LA"
}
},
"cnameFrom": {
"description": "The hostname that your end users see, indicated by the `Host` header in end user requests.",
"type": "string"
},
"cnameType": {
"description": "Only one supported `EDGE_HOSTNAME` value.",
"type": "string",
"enum": [
"EDGE_HOSTNAME"
]
},
"productionCertType": {
"description": "Indicates the certificate's provisioning type. Either the `CPS_MANAGED` type for the custom certificates you create with the [Certificate Provisioning System API](https://developer.akamai.com/api/core_features/certificate_provisioning_system/v2.html) (CPS), or `DEFAULT` for certificates created automatically. Note that you can't specify the `DEFAULT` value if your property hostname uses the `akamaized.net` domain suffix.",
"type": "string",
"enum": [
"CPS_MANAGED",
"DEFAULT"
]
},
"productionCnameTo": {
"description": "The edge hostname you point the property hostname to so that you can start serving traffic through Akamai servers. This member corresponds to the edge hostname object's `edgeHostnameDomain` member.",
"type": "string"
},
"productionEdgeHostnameId": {
"description": "Identifies each edge hostname. See [ID prefixes](#prefixes) for details on how to omit the ID's `ehn_` prefix.",
"type": "string"
},
"stagingCertType": {
"description": "Indicates the certificate's provisioning type. Either the `CPS_MANAGED` type for the custom certificates you create with the [Certificate Provisioning System API](https://developer.akamai.com/api/core_features/certificate_provisioning_system/v2.html) (CPS), or `DEFAULT` for certificates created automatically. Note that you can't specify the `DEFAULT` value if your property hostname uses the `akamaized.net` domain suffix.",
"type": "string",
"enum": [
"CPS_MANAGED",
"DEFAULT"
]
},
"stagingCnameTo": {
"description": "The edge hostname you point the property hostname to so that you can start serving traffic through Akamai servers. This member corresponds to the edge hostname object's `edgeHostnameDomain` member.",
"type": "string"
},
"stagingEdgeHostnameId": {
"description": "Identifies each edge hostname. See [ID prefixes](#prefixes) for details on how to omit the ID's `ehn_` prefix.",
"type": "string"
}
}
}
]
}
},
"nextLink": {
"description": "The link to next set of response items for paginated response.",
"type": "string"
},
"previousLink": {
"description": "The link to previous set of response items for paginated response.",
"type": "string"
},
"totalItems": {
"description": "The total count of items for requested criteria.",
"type": "integer"
}
}
},
"propertyId": {
"description": "Unique identifier for the property. 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"
}
},
"x-akamai": {
"file-path": "schemas/property-hostnames-get-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"
}
},
"422": {
"description": "[Unprocessable content](https://techdocs.akamai.com/property-mgr/reference/422).",
"content": {
"application/problem+json": {
"example": {
"instance": "papi/v1/activations/#abc12345abcc02a7",
"messageId": "property_activation_still_pending",
"result": "ERROR",
"status": 422,
"title": "Property Manager Exception",
"type": "https://problems.luna.akamaiapis.net/papi/v1/property_activation_still_pending",
"params": [
"Property 123456",
"Version 1"
],
"details": {},
"errors": [
{
"detail": "property_activation_still_pending",
"title": "Property Manager Exception",
"type": "papi/v1/property_activation_still_pending"
}
]
},
"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",
"instance",
"status",
"errors",
"details",
"messageId",
"params",
"result"
],
"properties": {
"details": {
"description": "Diagnostic instructions to locate and fix the problem.",
"type": "object"
},
"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"
},
"messageId": {
"description": "Summarizes the cause of the problem.",
"minLength": 1,
"type": "string"
},
"params": {
"description": "Details of the property and version where the problem occured.",
"minItems": 0,
"type": "array",
"items": {
"type": "string"
}
},
"result": {
"description": "Indicates the severity of the problem.",
"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-422.yaml"
}
}
}
},
"x-akamai": {
"file-path": "errors/422.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": "For paginated responses, specifies the page of results you want to navigate to, starting from `0`.",
"example": "{{offset}}",
"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.",
"example": "{{limit}}",
"in": "query",
"name": "limit",
"required": false,
"schema": {
"example": 50,
"minimum": 1,
"type": "integer"
},
"x-akamai": {
"file-path": "parameters/limit-optional.yaml"
}
},
{
"description": "__Enum__ Sort the results based on the `cnameFrom` value, either `hostname:a` for ascending or `hostname:d` for descending order. The default is `hostname:a`.",
"example": "{{sort}}",
"in": "query",
"name": "sort",
"required": false,
"schema": {
"default": "hostname:a",
"example": "hostname:a",
"type": "string",
"enum": [
"hostname:a",
"hostname:d"
]
},
"x-akamai": {
"file-path": "parameters/sort-query.yaml"
}
},
{
"description": "Filter the results by `cnameFrom`. Supports wildcard matches with `*`.",
"example": "{{hostname}}",
"in": "query",
"name": "hostname",
"required": false,
"schema": {
"example": "www.example.com",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/hostname-query.yaml"
}
},
{
"description": "Filter the results by edge hostname. Supports wildcard matches with `*`.",
"example": "{{cnameTo}}",
"in": "query",
"name": "cnameTo",
"schema": {
"example": "example.com.edgekey.net",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/cnameTo-query.yaml"
}
},
{
"description": "__Enum__ Network of activated hostnames, either `STAGING` or `PRODUCTION`.",
"example": "{{network}}",
"in": "query",
"name": "network",
"required": false,
"schema": {
"example": "PRODUCTION",
"type": "string",
"enum": [
"PRODUCTION",
"STAGING"
]
},
"x-akamai": {
"file-path": "parameters/network-query.yaml"
}
},
{
"description": "__Limited availability__ Whether the response should include the certificate status for the hostname on staging and production networks.",
"example": "{{includeCertStatus}}",
"in": "query",
"name": "includeCertStatus",
"required": false,
"schema": {
"default": false,
"example": true,
"type": "boolean"
},
"x-akamai": {
"file-path": "parameters/includeCertStatus-query.yaml",
"status": "LA"
}
},
{
"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.",
"example": "{{contractId}}",
"in": "query",
"name": "contractId",
"required": false,
"schema": {
"example": "ctr_1-1TJZFW",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/contractId-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.",
"example": "{{groupId}}",
"in": "query",
"name": "groupId",
"required": false,
"schema": {
"example": "grp_15166",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/groupId-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.",
"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"
}
}
]
},
"patch": {
"description": "For a property with `useHostnameBucket` set to `true` [when created](https://techdocs.akamai.com/property-mgr/reference/post-properties), this operation adds or removes up to 1000 property hostnames without incrementing the property version. Changes automatically activate on the selected network. If a property doesn't have hostname buckets enabled, this operation returns a [403](https://techdocs.akamai.com/property-mgr/reference/403) error. If another activation is in progress, whether it's a hostname activation or a property version activation, the operation fails with a [409](https://techdocs.akamai.com/property-mgr/reference/409) error. Once you perform this operation, it blocks subsequent requests until all the property hostnames are active. Note that to build the request body, you need to first obtain the `edgeHostnameId` either from an existing edge hostname or a new one you create by running the [Create a new edge hostname](https://techdocs.akamai.com/property-mgr/reference/post-edgehostnames) operation.\n\n**Note**: If you're using a new account, first register it on the Akamai network by activating any property version on either staging or production. Otherwise, your attempts to create or specify certificates will fail with a [403](https://techdocs.akamai.com/property-mgr/reference/403) error.",
"operationId": "patch-property-hostnames",
"summary": "Akamai Add or Remove Hostnames for a Property's Hostname Bucket",
"tags": [
"Hostname buckets"
],
"externalDocs": {
"description": "See documentation for this operation in Akamai's Property Manager API",
"url": "https://techdocs.akamai.com/property-mgr/reference/patch-property-hostnames"
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"example": {
"network": "PRODUCTION",
"note": "Sample hostname activation",
"notifyEmails": [
"you@example.com",
"them@example.com"
],
"remove": [
"www.example.com",
"m.example3.com"
],
"add": [
{
"certProvisioningType": "DEFAULT",
"cnameFrom": "m.example.com",
"cnameType": "EDGE_HOSTNAME",
"edgeHostnameId": "ehn_895824"
},
{
"certProvisioningType": "CPS_MANAGED",
"cnameFrom": "www.example3.com",
"cnameType": "EDGE_HOSTNAME",
"edgeHostnameId": "ehn_895824"
}
]
},
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Adds and removes up to 1000 property hostnames per single request without incrementing the property version. Changes are automatically activated on the selected network. You remove each hostname by specifying its custom domain name that your end users see as a string value. For additions, you need to specify a fuller object.",
"id": "resource:/descriptors/papi/v1/schemas/CreateOrDeleteHostnameBucketV0.json#",
"javaType": "com.akamai.luna.papi.model.AddRemoveHostnameBucketRequest",
"type": "object",
"required": [
"network"
],
"properties": {
"add": {
"description": "The property hostnames you want to add to a hostname bucket. You can specify up to 1000 new property hostnames in a single request.",
"type": "array",
"items": {
"type": "object",
"required": [
"cnameType",
"edgeHostnameId",
"cnameFrom",
"certProvisioningType"
],
"properties": {
"certProvisioningType": {
"description": "Indicates the type of the certificate used in the property hostname. Either the `CPS_MANAGED` for the custom certificates you create with the [Certificate Provisioning System API](https://techdocs.akamai.com/cps/reference) (CPS), or `DEFAULT` for certificates deployed automatically. Note that you can't specify the `DEFAULT` value if your account hostname uses the `akamaized.net` domain suffix.",
"type": "string",
"enum": [
"CPS_MANAGED",
"DEFAULT"
]
},
"cnameFrom": {
"description": "The hostname that your end users see, indicated by the `Host` header in end user requests.",
"type": "string"
},
"cnameType": {
"description": "Only one supported `EDGE_HOSTNAME` value.",
"type": "string",
"enum": [
"EDGE_HOSTNAME"
]
},
"edgeHostnameId": {
"description": "Identifies the edge hostname you mapped your traffic to on the production network. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on how to omit the ID's `ehn_` prefix.",
"type": "string"
}
}
}
},
"network": {
"description": "The network to activate on, either `STAGING` or `PRODUCTION`.",
"example": "{{network}}",
"enum": [
"STAGING",
"PRODUCTION"
]
},
"note": {
"description": "Assigns a log message to the request.",
"example": "{{note}}",
"type": "string"
},
"notifyEmails": {
"description": "Email addresses to notify when the activation status changes.",
"minItems": 1,
"type": "array",
"items": {
"type": "string"
}
},
"remove": {
"description": "The property hostnames you want to delete from the current set in the hostname bucket.",
"type": "array",
"items": {
"type": "string"
}
}
},
"x-akamai": {
"file-path": "schemas/property-hostnames-bucket-add-remove-request.yaml"
}
}
}
}
},
"responses": {
"201": {
"description": "The response lists hostnames added or removed from the property.",
"content": {
"application/json": {
"example": {
"activationId": "atv_67037",
"activationLink": "/papi/v1/properties/prp_173136/hostname-activations/atv_67037?contractId=ctr_C-0N7RAC7&groupId=grp_15225",
"hostnames": [
{
"certProvisioningType": "DEFAULT",
"cnameFrom": "example.com",
"cnameTo": "example.com.edgekey.net",
"cnameType": "EDGE_HOSTNAME",
"edgeHostnameId": "ehn_895822",
"certStatus": {
"validationCname": {
"hostname": "_acme-challenge.www.example.com",
"target": "{token}.www.example.com.akamai-domain.com"
},
"production": [
{
"status": "PENDING"
}
],
"staging": [
{
"status": "PENDING"
}
]
}
},
{
"certProvisioningType": "CPS_MANAGED",
"cnameFrom": "m.example.com",
"cnameTo": "m.example.com.edgesuite.net",
"cnameType": "EDGE_HOSTNAME",
"edgeHostnameId": "ehn_895833"
}
]
},
"schema": {
"$schema": "http://json-schema.org/draft-04-schema#",
"additionalProperties": false,
"description": "Provides a hypermedia link to a newly created resource. The response's single member name indicates the type of resource.",
"id": "resource:/descriptors/papi/v1/schemas/PostHostnameBucketResponse.json#",
"type": "object",
"required": [
"activationLink",
"activationId"
],
"properties": {
"activationId": {
"description": "Unique identifier for the hostname bucket activation. This is common for all property hostnames in a hostname bucket.",
"type": "string"
},
"activationLink": {
"description": "Links the newly created hostname bucket activation. This is common for all property hostnames in a hostname bucket.",
"type": "string"
},
"hostnames": {
"description": "Specifies property hostnames activated in a hostname bucket.",
"type": "array",
"items": {
"additionalProperties": false,
"type": "object",
"required": [
"cnameFrom",
"cnameType",
"edgeHostnameId",
"certProvisioningType"
],
"properties": {
"certProvisioningType": {
"description": "Indicates the type of the certificate used in the property hostname. Either the `CPS_MANAGED` for the custom certificates you create with the [Certificate Provisioning System API](https://techdocs.akamai.com/cps/reference) (CPS), or `DEFAULT` for certificates deployed automatically. Note that you can't specify the `DEFAULT` value if your account hostname uses the `akamaized.net` domain suffix.",
"type": "string",
"enum": [
"CPS_MANAGED",
"DEFAULT"
]
},
"certStatus": {
"additionalProperties": false,
"description": "__Limited availability__ With the `includeCertStatus` parameter set to `true`, determines whether a hostname is capable of serving secure content over the staging or production network.",
"type": "object",
"properties": {
"production": {
"description": "__Limited availability__ The certificate status for the hostname on the production network.",
"minItems": 0,
"type": "array",
"items": {
"additionalProperties": false,
"type": "object",
"properties": {
"status": {
"description": "__Limited availability__ The status of the certificate deployment on the production network.\n\n\nExpand for details on possible values.\n
\n\nDEPLOYING indicates the deployment is in progress.\nPENDING indicates you need to add the validation challenge to your DNS and activate the property version on staging or production to deploy your certificate to that network. If you've done that already, run the operation again later to check if the deployment succeeded.\nNEEDS_ACTIVATION indicates the validation is complete and the status on the `production` network is either `DEPLOYING` or `DEPLOYED`. You need to activate the property version on staging to deploy the certificate to that network.\nDEPLOYED indicates the certificate is successfully validated on the network and ready to handle secure traffic.\nSTALLED indicates a problem with validation or deployment of your certificate. To try again, re-launch a certificate validation or contact Akamai Professional Services for help.\nPROHIBITED_DOMAIN_FAILURE indicates the hostname isn't in the Let's Encrypt Certificate Authority domain allow list. Fix the underlying issue and re-launch a certificate validation, or contact Akamai Professional Services for help.\nCAA_MISMATCH_RETRYING or CAA_MISMATCH_FAILURE indicate you need to configure your Certification Authority Authorization (CAA) policy to allow Let's Encrypt. Fix the underlying issue and re-launch a certificate validation, or contact Akamai Professional Services for help.\nEXPIRING_SOON_NEEDS_VALIDATION indicates your certificate is due to expire or already expired, and you need to add the _acme-challenge validation CNAME record in your DNS again.\nCNAME_MISSING_FAILURE indicates you removed the validation record from your DNS. Add the CNAME record to your DNS again and re-launch a certificate validation, or contact Akamai Professional Services for help.\nUNKNOWN_FAILURE To try again, re-launch a certificate validation or contact Akamai Professional Services for help.
",
"type": "string",
"enum": [
"DEPLOYING",
"PENDING",
"NEEDS_ACTIVATION",
"DEPLOYED",
"STALLED",
"PROHIBITED_DOMAIN_FAILURE",
"CAA_MISMATCH_RETRYING",
"CAA_MISMATCH_FAILURE",
"EXPIRING_SOON_NEEDS_VALIDATION",
"EXPIRED_NEEDS_VALIDATION",
"CNAME_MISSING_FAILURE",
"UNKNOWN_FAILURE"
],
"x-akamai": {
"status": "LA"
}
}
}
},
"x-akamai": {
"status": "LA"
}
},
"staging": {
"description": "__Limited availability__ The certificate status for the hostname on the staging network.",
"minItems": 0,
"type": "array",
"items": {
"additionalProperties": false,
"type": "object",
"properties": {
"status": {
"description": "__Limited availability__ The status of the certificate deployment on the staging network.\n\n\nExpand for details on possible values.\n
\n\nDEPLOYING indicates the deployment is in progress.\nPENDING indicates you need to add the validation challenge to your DNS and activate the property version on staging or production to deploy your certificate to that network. If you've done that already, run the operation again later to check if the deployment succeeded.\nNEEDS_ACTIVATION indicates the validation is complete and the status on the `production` network is either `DEPLOYING` or `DEPLOYED`. You need to activate the property version on staging to deploy the certificate to that network.\nDEPLOYED indicates the certificate is successfully validated on the network and ready to handle secure traffic.\nSTALLED indicates a problem with validation or deployment of your certificate. To try again, re-launch a certificate validation or contact Akamai Professional Services for help.\nPROHIBITED_DOMAIN_FAILURE indicates the hostname isn't in the Let's Encrypt Certificate Authority domain allow list. Fix the underlying issue and re-launch a certificate validation, or contact Akamai Professional Services for help.\nCAA_MISMATCH_RETRYING or CAA_MISMATCH_FAILURE indicate you need to configure your Certification Authority Authorization (CAA) policy to allow Let's Encrypt. Fix the underlying issue and re-launch a certificate validation, or contact Akamai Professional Services for help.\nEXPIRING_SOON_NEEDS_VALIDATION indicates your certificate is due to expire or already expired, and you need to add the _acme-challenge validation CNAME record in your DNS again.\nCNAME_MISSING_FAILURE indicates you removed the validation record from your DNS. Add the CNAME record to your DNS again and re-launch a certificate validation, or contact Akamai Professional Services for help.\nUNKNOWN_FAILURE To try again, re-launch a certificate validation or contact Akamai Professional Services for help.
",
"type": "string",
"enum": [
"DEPLOYING",
"PENDING",
"NEEDS_ACTIVATION",
"DEPLOYED",
"STALLED",
"PROHIBITED_DOMAIN_FAILURE",
"CAA_MISMATCH_RETRYING",
"CAA_MISMATCH_FAILURE",
"EXPIRING_SOON_NEEDS_VALIDATION",
"EXPIRED_NEEDS_VALIDATION",
"CNAME_MISSING_FAILURE",
"UNKNOWN_FAILURE"
],
"x-akamai": {
"status": "LA"
}
}
}
},
"x-akamai": {
"status": "LA"
}
},
"validationCname": {
"additionalProperties": false,
"description": "__Limited availability__ The CNAME record used to validate the certificate's domain.",
"type": "object",
"required": [
"hostname",
"target"
],
"properties": {
"hostname": {
"description": "__Limited availability__ The hostname part of the CNAME record used to validate the certificate's domain.",
"type": "string",
"x-akamai": {
"status": "LA"
}
},
"target": {
"description": "__Limited availability__ The destination part of the CNAME record used to validate the certificate's domain.",
"type": "string",
"x-akamai": {
"status": "LA"
}
}
},
"x-akamai": {
"status": "LA"
}
}
},
"x-akamai": {
"status": "LA"
}
},
"cnameFrom": {
"description": "The hostname that your end users see, indicated by the `Host` header in end user requests.",
"type": "string"
},
"cnameTo": {
"description": "The edge hostname you point the property hostname to so that you can start serving traffic through Akamai servers. This member corresponds to the edge hostname object's `edgeHostnameDomain` member.",
"type": "string"
},
"cnameType": {
"description": "Only one supported `EDGE_HOSTNAME` value.",
"type": "string",
"enum": [
"EDGE_HOSTNAME"
]
},
"edgeHostnameId": {
"description": "Identifies the edge hostname you mapped your traffic to on the staging network. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on how to omit the ID's `ehn_` prefix.",
"type": "string"
}
}
}
}
},
"x-akamai": {
"file-path": "schemas/property-hostnames-bucket-add-remove-response.yaml"
}
}
}
},
"headers": {
"X-Limit-Default-Certs-Per-Contract-Limit": {
"description": "The total number of default certificates per contract. This header only appears if you have any hostnames with default certificates assigned to the property version.",
"schema": {
"type": "string"
},
"x-akamai": {
"file-path": "headers/X-Limit-Default-Certs-Per-Contract-Limit.yaml"
}
},
"X-Limit-Default-Certs-Per-Contract-Remaining": {
"description": "The number of remaining default certificates per contract. This header only appears if you have any hostnames with default certificates assigned to the property version.",
"schema": {
"type": "string"
},
"x-akamai": {
"file-path": "headers/X-Limit-Default-Certs-Per-Contract-Remaining.yaml"
}
},
"X-Limit-Hosts-Per-Account-Limit": {
"description": "Maximum number of hostnames you can assign to all properties under an account.",
"schema": {
"type": "string"
},
"x-akamai": {
"file-path": "headers/X-Limit-Hosts-Per-Account-Limit.yaml"
}
},
"X-Limit-Hosts-Per-Account-Remaining": {
"description": "Remaining number of hostnames you can assign to all properties under an account. See [Rate and resource limiting](https://techdocs.akamai.com/property-mgr/reference/rate-and-resource-limiting) for details.",
"schema": {
"type": "string"
},
"x-akamai": {
"file-path": "headers/X-Limit-Hosts-Per-Account-Remaining.yaml"
}
},
"X-Limit-Hosts-Per-Property-Limit": {
"description": "Maximum number of hostnames you can assign to a property configuration.",
"schema": {
"type": "string"
},
"x-akamai": {
"file-path": "headers/X-Limit-Hosts-Per-Property-Limit.yaml"
}
},
"X-Limit-Hosts-Per-Property-Remaining": {
"description": "Remaining number of hostnames you can assign to a property configuration. See [Rate and resource limiting](https://techdocs.akamai.com/property-mgr/reference/rate-and-resource-limiting) for details.",
"schema": {
"type": "string"
},
"x-akamai": {
"file-path": "headers/X-Limit-Hosts-Per-Property-Remaining.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"
}
},
"409": {
"description": "[Conflict](https://techdocs.akamai.com/property-mgr/reference/409).",
"content": {
"application/problem+json": {
"example": {
"detail": "Another edit or activation request on same network in progress for this property version.",
"instance": "papi/v1/properties/prp_123456/activations?contractId=ctr_C-0N7RAC7&groupId=grp_12345#abc12345abcc02a7",
"status": 409,
"title": "Operation failed",
"type": "https://problems.luna.akamaiapis.net/papi/v1/resource-busy"
},
"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/409.yaml"
}
},
"413": {
"description": "[Request entity too large](https://techdocs.akamai.com/property-mgr/reference/413).",
"content": {
"application/problem+json": {
"example": {
"detail": "TBD",
"instance": "/papi/v1/properties?contractId=ctr_C-0N7RAC7&groupId=grp_12345#abc12345abcc02a7",
"status": 413,
"title": "Request entity too large",
"type": "https://problems.luna.akamaiapis.net/papi/v1/http/"
},
"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/413.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"
}
},
"422": {
"description": "[Unprocessable content](https://techdocs.akamai.com/property-mgr/reference/422).",
"content": {
"application/problem+json": {
"example": {
"instance": "papi/v1/activations/#abc12345abcc02a7",
"messageId": "property_activation_still_pending",
"result": "ERROR",
"status": 422,
"title": "Property Manager Exception",
"type": "https://problems.luna.akamaiapis.net/papi/v1/property_activation_still_pending",
"params": [
"Property 123456",
"Version 1"
],
"details": {},
"errors": [
{
"detail": "property_activation_still_pending",
"title": "Property Manager Exception",
"type": "papi/v1/property_activation_still_pending"
}
]
},
"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",
"instance",
"status",
"errors",
"details",
"messageId",
"params",
"result"
],
"properties": {
"details": {
"description": "Diagnostic instructions to locate and fix the problem.",
"type": "object"
},
"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"
},
"messageId": {
"description": "Summarizes the cause of the problem.",
"minLength": 1,
"type": "string"
},
"params": {
"description": "Details of the property and version where the problem occured.",
"minItems": 0,
"type": "array",
"items": {
"type": "string"
}
},
"result": {
"description": "Indicates the severity of the problem.",
"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-422.yaml"
}
}
}
},
"x-akamai": {
"file-path": "errors/422.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": "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.",
"example": "{{contractId}}",
"in": "query",
"name": "contractId",
"required": false,
"schema": {
"example": "ctr_1-1TJZFW",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/contractId-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.",
"example": "{{groupId}}",
"in": "query",
"name": "groupId",
"required": false,
"schema": {
"example": "grp_15166",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/groupId-optional.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"
}
}
]
},
"x-akamai": {
"file-path": "paths/property-hostnames.yaml",
"path-for-file": "/properties/{propertyId}/hostnames"
},
"x-akamai-descriptor-tools": {
"displayName": "propertyHostnames",
"group": "Property Hostnames"
},
"parameters": [
{
"description": "Unique identifier for the property. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting the value's `prp_` prefix.",
"example": "{{propertyId}}",
"in": "path",
"name": "propertyId",
"required": true,
"schema": {
"example": "prp_12345",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/propertyId-path.yaml"
}
}
]
},
"/properties/{propertyId}/hostnames/diff": {
"get": {
"description": "This operation lists active property hostnames whose details differ between the staging and production networks. Optionally paginate the results. You can run this operation by specifying any of the `propertyId` members from a [list of properties](https://techdocs.akamai.com/property-mgr/reference/get-properties), or by running a GET on the `propertyLink` response when [creating a new property](https://techdocs.akamai.com/property-mgr/reference/post-properties).",
"operationId": "get-property-hostnames-diff",
"summary": "Akamai Get Property Hostnames Diff",
"tags": [
"Active property hostnames"
],
"externalDocs": {
"description": "See documentation for this operation in Akamai's Property Manager API",
"url": "https://techdocs.akamai.com/property-mgr/reference/get-property-hostnames-diff"
},
"responses": {
"200": {
"description": "The response lists active property hostnames that differ in staging and production networks.",
"content": {
"application/json": {
"example": {
"accountId": "act_A-CCT5678",
"contractId": "ctr_K-0N7RAK71",
"groupId": "grp_15225",
"propertyId": "prp_175780",
"hostnames": {
"currentItemCount": 1,
"nextLink": "/papi/v1/properties/prp_175780/hostnames/diff?offset=1&limit=1",
"totalItems": 1,
"items": [
{
"cnameFrom": "example.com",
"productionCertType": "DEFAULT",
"productionCnameTo": "m.example.com.edgesuite.net",
"productionCnameType": "EDGE_HOSTNAME",
"productionEdgeHostnameId": "ehn_293412",
"stagingCertType": "CPS_MANAGED",
"stagingCnameTo": "example.com.edgesuite-staging.net",
"stagingCnameType": "EDGE_HOSTNAME",
"stagingEdgeHostnameId": "ehn_895822"
}
]
}
},
"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/GetPropertyHostnamesDiffResponse.json#",
"type": "object",
"required": [
"accountId",
"contractId",
"groupId",
"propertyId"
],
"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"
},
"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"
},
"hostnames": {
"additionalProperties": false,
"description": "Active property hostnames that differ in staging and production networks.",
"type": "object",
"properties": {
"currentItemCount": {
"description": "The total count of items present in the current response body for requested criteria.",
"type": "integer"
},
"items": {
"description": "Details of the active property hostnames that differ in staging and production networks. Relevant response objects appear within the outer envelope's `hostnames.items` array.",
"type": "array",
"items": {
"additionalProperties": false,
"required": [
"cnameFrom",
"stagingCnameType",
"stagingCertType",
"stagingEdgeHostnameId",
"stagingCnameTo",
"productionCnameType",
"productionCertType",
"productionEdgeHostnameId",
"productionCnameTo"
],
"properties": {
"cnameFrom": {
"description": "The hostname that your end users see, indicated by the `Host` header in end user requests.",
"type": "string"
},
"productionCertType": {
"description": "Indicates the type of the certificate used in the property hostname. Either the `CPS_MANAGED` for the custom certificates you create with the [Certificate Provisioning System API](https://techdocs.akamai.com/cps/reference) (CPS), or `DEFAULT` for certificates deployed automatically. Note that you can't specify the `DEFAULT` value if your account hostname uses the `akamaized.net` domain suffix.",
"type": "string",
"enum": [
"CPS_MANAGED",
"DEFAULT"
]
},
"productionCnameTo": {
"description": "The edge hostname you point the property hostname to so that you can start serving traffic through Akamai servers. This member corresponds to the edge hostname object's `edgeHostnameDomain` member.",
"type": "string"
},
"productionCnameType": {
"description": "Indicates the type of CNAME you used in the production network, either `EDGE_HOSTNAME` or `CUSTOM`.",
"type": "string",
"enum": [
"EDGE_HOSTNAME",
"CUSTOM"
]
},
"productionEdgeHostnameId": {
"description": "Identifies the edge hostname you mapped your traffic to on the production network. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on how to omit the ID's `ehn_` prefix.",
"type": "string"
},
"stagingCertType": {
"description": "Indicates the type of the certificate used in the property hostname. Either the `CPS_MANAGED` for the custom certificates you create with the [Certificate Provisioning System API](https://techdocs.akamai.com/cps/reference) (CPS), or `DEFAULT` for certificates deployed automatically. Note that you can't specify the `DEFAULT` value if your account hostname uses the `akamaized.net` domain suffix.",
"type": "string",
"enum": [
"CPS_MANAGED",
"DEFAULT"
]
},
"stagingCnameTo": {
"description": "The edge hostname you point the property hostname to so that you can start serving traffic through Akamai servers. This member corresponds to the edge hostname object's `edgeHostnameDomain` member.",
"type": "string"
},
"stagingCnameType": {
"description": "Indicates the type of CNAME you used in the staging network, either `EDGE_HOSTNAME` or `CUSTOM`.",
"type": "string",
"enum": [
"EDGE_HOSTNAME",
"CUSTOM"
]
},
"stagingEdgeHostnameId": {
"description": "Identifies the edge hostname you mapped your traffic to on the production network. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on how to omit the ID's `ehn_` prefix.",
"type": "string"
}
}
}
},
"nextLink": {
"description": "The link to next set of response items for paginated response.",
"type": "string"
},
"previousLink": {
"description": "The link to previous set of response items for paginated response.",
"type": "string"
},
"totalItems": {
"description": "The total count of items for requested criteria.",
"type": "integer"
}
}
},
"propertyId": {
"description": "Unique identifier for a property. 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"
}
},
"x-akamai": {
"file-path": "schemas/property-hostnames-diff-get-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"
}
},
"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 paginated responses, specifies the page of results you want to navigate to, starting from `0`.",
"example": "{{offset}}",
"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.",
"example": "{{limit}}",
"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.",
"example": "{{contractId}}",
"in": "query",
"name": "contractId",
"required": false,
"schema": {
"example": "ctr_1-1TJZFW",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/contractId-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.",
"example": "{{groupId}}",
"in": "query",
"name": "groupId",
"required": false,
"schema": {
"example": "grp_15166",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/groupId-optional.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"
}
}
]
},
"x-akamai": {
"file-path": "paths/property-hostnames-diff.yaml",
"path-for-file": "/properties/{propertyId}/hostnames/diff"
},
"x-akamai-descriptor-tools": {
"displayName": "propertyHostnames diff",
"group": "Property Hostnames"
},
"parameters": [
{
"description": "Unique identifier for the property. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting the value's `prp_` prefix.",
"example": "{{propertyId}}",
"in": "path",
"name": "propertyId",
"required": true,
"schema": {
"example": "prp_12345",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/propertyId-path.yaml"
}
}
]
},
"/properties/{propertyId}/versions": {
"post": {
"description": "Create a new property version based on any previous version. All data from the `createFromVersion` populates the new version, including its rules and hostnames. Specify `createFromVersionEtag` if you want to ensure you're creating from a version that hasn't changed since you fetched it.",
"operationId": "post-property-versions",
"summary": "Akamai Create a New Property Version",
"tags": [
"Property versions"
],
"externalDocs": {
"description": "See documentation for this operation in Akamai's Property Manager API",
"url": "https://techdocs.akamai.com/property-mgr/reference/post-property-versions"
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"example": {
"createFromVersion": 1,
"createFromVersionEtag": "2641910c585cf67b"
},
"schema": {
"$schema": "http://json-schema.org/draft-04-schema#",
"description": "When [incrementing a new version](https://techdocs.akamai.com/property-mgr/reference/post-property-versions), this POST object's members aren't reflected in subsequent responses.",
"id": "resource:/descriptors/papi/v1/schemas/CreateNewPropertyVersionRequestV0.json#",
"javaType": "com.akamai.luna.papi.model.PropertyVersionCreateRequest",
"type": "object",
"required": [
"createFromVersion"
],
"properties": {
"createFromVersion": {
"description": "The property version on which to base the new version.",
"example": "{{createFromVersion}}",
"minimum": 1,
"type": "integer"
},
"createFromVersionEtag": {
"description": "The data digest of the version on which to base the new version. See [Concurrency control](https://techdocs.akamai.com/property-mgr/reference/concurrency-control) for guidance.",
"example": "{{createFromVersionEtag}}",
"type": "string"
}
},
"x-akamai": {
"file-path": "schemas/property-version-create-request.yaml"
}
}
}
}
},
"responses": {
"201": {
"description": "The response provides a URL link to the newly created property version.",
"content": {
"application/json": {
"example": {
"versionLink": "/papi/v0/properties/prp_173136/versions/2?contractId=ctr_C-0N7RAC7&groupId=grp_15225"
},
"schema": {
"$schema": "http://json-schema.org/draft-04-schema#",
"additionalProperties": false,
"description": "Provides a hypermedia link to a newly created resource. The response's single member name indicates the type of resource.",
"id": "resource:/descriptors/papi/v1/schemas/PostVersionResponse.json#",
"type": "object",
"required": [
"versionLink"
],
"properties": {
"versionLink": {
"description": "Links the property version.",
"type": "string"
}
},
"x-akamai": {
"file-path": "schemas/property-version-create-response.yaml"
}
}
}
},
"headers": {
"Location": {
"description": "Provides a URL path you can GET the newly created resource from.",
"schema": {
"type": "string"
},
"x-akamai": {
"file-path": "headers/Location.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": "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.",
"example": "{{contractId}}",
"in": "query",
"name": "contractId",
"required": false,
"schema": {
"example": "ctr_1-1TJZFW",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/contractId-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.",
"example": "{{groupId}}",
"in": "query",
"name": "groupId",
"required": false,
"schema": {
"example": "grp_15166",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/groupId-optional.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"
}
}
]
},
"get": {
"description": "Lists the property's versions, with results limited to the 500 most recent versions. Optionally paginate the results. Each property version indicates activation status on different networks, and an `etag` digest useful when [cloning the property](https://techdocs.akamai.com/property-mgr/reference/post-properties).",
"operationId": "get-property-versions",
"summary": "Akamai List Property Versions",
"tags": [
"Property versions"
],
"externalDocs": {
"description": "See documentation for this operation in Akamai's Property Manager API",
"url": "https://techdocs.akamai.com/property-mgr/reference/get-property-versions"
},
"responses": {
"200": {
"description": "The response lists property versions for the requested property.",
"content": {
"application/json": {
"example": {
"accountId": "act_A-CCT7890",
"assetId": "aid_101",
"contractId": "ctr_K-0N7RAK7",
"groupId": "grp_15225",
"propertyId": "prp_173136",
"propertyName": "981.catalog.amenai.net",
"versions": {
"items": [
{
"etag": "5891b5b522d5df08",
"note": "updated caching",
"productId": "prd_Alta",
"productionStatus": "INACTIVE",
"propertyVersion": 2,
"stagingStatus": "ACTIVE",
"updatedByUser": "jdupont",
"updatedDate": "2014-05-10T19:06:13Z"
},
{
"etag": "71573b922a87abc3",
"note": "initial version",
"productId": "prd_Alta",
"productionStatus": "ACTIVE",
"propertyVersion": 1,
"stagingStatus": "INACTIVE",
"updatedByUser": "adevi",
"updatedDate": "2013-05-04T21: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.",
"id": "resource:/descriptors/papi/v1/schemas/GetVersionResponse.json#",
"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"
},
"propertyId": {
"description": "Identifies this version's property, 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 for this version.",
"type": "string"
},
"versions": {
"additionalProperties": false,
"description": "The set of requested property versions, available within an `items` array.",
"type": "object",
"properties": {
"items": {
"description": "Specifies the version of a property. Relevant response objects appear within the outer envelope's `versions.items` array.",
"type": "array",
"items": {
"additionalProperties": false,
"type": "object",
"required": [
"etag",
"note",
"productId",
"productionStatus",
"propertyVersion",
"stagingStatus",
"updatedByUser",
"updatedDate"
],
"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"
},
"note": {
"description": "A descriptive log comment.",
"type": "string"
},
"productId": {
"description": "The product assigned to the property when versioned. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on how to omit the ID's `prd_` prefix.",
"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"
]
},
"propertyVersion": {
"description": "A positive integer identifying the incremental version.",
"minimum": 1,
"type": "integer"
},
"ruleFormat": {
"description": "Identifies the rule format currently assigned to the property 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 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 version.",
"type": "string"
},
"updatedDate": {
"description": "The date stamp of the version's latest update.",
"type": "string"
}
}
}
}
}
}
},
"x-akamai": {
"file-path": "schemas/property-version-get-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"
}
},
"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": "For paginated responses, specifies the page of results you want to navigate to, starting from `0`.",
"example": "{{offset}}",
"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.",
"example": "{{limit}}",
"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.",
"example": "{{contractId}}",
"in": "query",
"name": "contractId",
"required": false,
"schema": {
"example": "ctr_1-1TJZFW",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/contractId-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.",
"example": "{{groupId}}",
"in": "query",
"name": "groupId",
"required": false,
"schema": {
"example": "grp_15166",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/groupId-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.",
"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"
}
}
]
},
"x-akamai": {
"file-path": "paths/property-versions.yaml",
"path-for-file": "/properties/{propertyId}/versions"
},
"x-akamai-descriptor-tools": {
"displayName": "propertyVersions",
"group": "Property versions"
},
"parameters": [
{
"description": "Unique identifier for the property. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting the value's `prp_` prefix.",
"example": "{{propertyId}}",
"in": "path",
"name": "propertyId",
"required": true,
"schema": {
"example": "prp_12345",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/propertyId-path.yaml"
}
}
]
},
"/properties/{propertyId}/versions/latest": {
"get": {
"description": "This operation provides either the latest property version overall, or the latest one active on the production or staging networks. By default, the response yields the property version with the highest number. Specifying an `activatedOn` of `STAGING` or `PRODUCTION` yields the version that's currently active on either network.",
"operationId": "get-latest-property-version",
"summary": "Akamai Get the Latest Property Version",
"tags": [
"Property versions"
],
"externalDocs": {
"description": "See documentation for this operation in Akamai's Property Manager API",
"url": "https://techdocs.akamai.com/property-mgr/reference/get-latest-property-version"
},
"responses": {
"302": {
"description": "The response provides a redirect URL link to the latest version of the requested property.",
"content": {
"application/json": {
"example": {
"versionLink": "/papi/v0/properties/prp_173136/versions/2?contractId=ctr_C-0N7RAC7&groupId=grp_15225"
},
"schema": {
"$schema": "http://json-schema.org/draft-04-schema#",
"additionalProperties": false,
"description": "Provides a hypermedia link to a newly created resource. The response's single member name indicates the type of resource.",
"id": "resource:/descriptors/papi/v1/schemas/PostVersionResponse.json#",
"type": "object",
"required": [
"versionLink"
],
"properties": {
"versionLink": {
"description": "Links the property version.",
"type": "string"
}
},
"x-akamai": {
"file-path": "schemas/property-version-create-response.yaml"
}
}
}
},
"headers": {
"Location": {
"description": "Provides a URL path you can GET the newly created resource from.",
"schema": {
"type": "string"
},
"x-akamai": {
"file-path": "headers/Location.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"
}
},
"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": "__Enum__ If present, returns the latest version activated on the given network, either `STAGING` or `PRODUCTION`.",
"example": "{{activatedOn}}",
"in": "query",
"name": "activatedOn",
"required": false,
"schema": {
"example": "STAGING",
"type": "string",
"enum": [
"STAGING",
"PRODUCTION"
]
},
"x-akamai": {
"file-path": "parameters/activatedOn-query.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.",
"example": "{{contractId}}",
"in": "query",
"name": "contractId",
"required": false,
"schema": {
"example": "ctr_1-1TJZFW",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/contractId-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.",
"example": "{{groupId}}",
"in": "query",
"name": "groupId",
"required": false,
"schema": {
"example": "grp_15166",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/groupId-optional.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"
}
}
]
},
"x-akamai": {
"file-path": "paths/property-versions-latest.yaml",
"path-for-file": "/properties/{propertyId}/versions/latest"
},
"x-akamai-descriptor-tools": {
"displayName": "latestVersion",
"group": "Property versions"
},
"parameters": [
{
"description": "Unique identifier for the property. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting the value's `prp_` prefix.",
"example": "{{propertyId}}",
"in": "path",
"name": "propertyId",
"required": true,
"schema": {
"example": "prp_12345",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/propertyId-path.yaml"
}
}
]
},
"/properties/{propertyId}/versions/{propertyVersion}": {
"get": {
"description": "This polls the state of a specific property 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 a property version. This XML data encapsulates the property version's component rules and hostnames, and is available on a read-only basis. Contact your Akamai representative if you need help interpreting it.",
"operationId": "get-property-version",
"summary": "Akamai Get a Property Version",
"tags": [
"Property versions"
],
"externalDocs": {
"description": "See documentation for this operation in Akamai's Property Manager API",
"url": "https://techdocs.akamai.com/property-mgr/reference/get-property-version"
},
"responses": {
"200": {
"description": "The response shows details of the requested property version.",
"content": {
"application/json": {
"example": {
"accountId": "act_A-CCT7890",
"assetId": "aid_101",
"contractId": "ctr_C-0N7RAC7",
"groupId": "grp_15225",
"propertyId": "prp_173136",
"propertyName": "981.catalog.amenai.net",
"versions": {
"items": [
{
"etag": "71573b922a87abc3",
"note": "initial version",
"productId": "prd_Alta",
"productionStatus": "ACTIVE",
"propertyVersion": 1,
"ruleFormat": "latest",
"stagingStatus": "INACTIVE",
"updatedByUser": "mrossi",
"updatedDate": "2014-03-04T21: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.",
"id": "resource:/descriptors/papi/v1/schemas/GetVersionResponse.json#",
"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"
},
"propertyId": {
"description": "Identifies this version's property, 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 for this version.",
"type": "string"
},
"versions": {
"additionalProperties": false,
"description": "The set of requested property versions, available within an `items` array.",
"type": "object",
"properties": {
"items": {
"description": "Specifies the version of a property. Relevant response objects appear within the outer envelope's `versions.items` array.",
"type": "array",
"items": {
"additionalProperties": false,
"type": "object",
"required": [
"etag",
"note",
"productId",
"productionStatus",
"propertyVersion",
"stagingStatus",
"updatedByUser",
"updatedDate"
],
"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"
},
"note": {
"description": "A descriptive log comment.",
"type": "string"
},
"productId": {
"description": "The product assigned to the property when versioned. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on how to omit the ID's `prd_` prefix.",
"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"
]
},
"propertyVersion": {
"description": "A positive integer identifying the incremental version.",
"minimum": 1,
"type": "integer"
},
"ruleFormat": {
"description": "Identifies the rule format currently assigned to the property 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 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 version.",
"type": "string"
},
"updatedDate": {
"description": "The date stamp of the version's latest update.",
"type": "string"
}
}
}
}
}
}
},
"x-akamai": {
"file-path": "schemas/property-version-get-response.yaml"
}
}
},
"text/xml": {
"example": "\n\n \n \n \n \n \n \n \n \n"
}
},
"headers": {
"ETag": {
"description": "Pass the `ETag` response header back as `If-Match` in write requests to ensure you don't overwrite edits by any other API clients. See [Concurrency control](https://techdocs.akamai.com/property-mgr/reference/concurrency-control) for details.",
"example": "\"a9dfe78cf93090516bde891d009eaf57\"",
"schema": {
"type": "string"
},
"x-akamai": {
"file-path": "headers/Etag.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"
}
},
"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": "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.",
"example": "{{contractId}}",
"in": "query",
"name": "contractId",
"required": false,
"schema": {
"example": "ctr_1-1TJZFW",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/contractId-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.",
"example": "{{groupId}}",
"in": "query",
"name": "groupId",
"required": false,
"schema": {
"example": "grp_15166",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/groupId-optional.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"
}
}
]
},
"x-akamai": {
"file-path": "paths/property-version.yaml",
"path-for-file": "/properties/{propertyId}/versions/{propertyVersion}"
},
"x-akamai-descriptor-tools": {
"displayName": "propertyVersion",
"group": "Property versions"
},
"parameters": [
{
"description": "Property's incremental version number.",
"example": "{{propertyVersion}}",
"in": "path",
"name": "propertyVersion",
"required": true,
"schema": {
"example": 3,
"type": "integer"
},
"x-akamai": {
"file-path": "parameters/propertyVersion-path.yaml"
}
},
{
"description": "Unique identifier for the property. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting the value's `prp_` prefix.",
"example": "{{propertyId}}",
"in": "path",
"name": "propertyId",
"required": true,
"schema": {
"example": "prp_12345",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/propertyId-path.yaml"
}
}
]
},
"/properties/{propertyId}/versions/{propertyVersion}/available-behaviors": {
"get": {
"description": "Lists the set of [behaviors](https://techdocs.akamai.com/property-mgr/reference/ga-behaviors) you may apply within a property version's rules. The available set depends on the product under which you created the property and any additional modules enabled under your account.",
"operationId": "get-available-behaviors",
"summary": "Akamai List Available Behaviors for a Property",
"tags": [
"Property versions"
],
"externalDocs": {
"description": "See documentation for this operation in Akamai's Property Manager API",
"url": "https://techdocs.akamai.com/property-mgr/reference/get-available-behaviors"
},
"responses": {
"200": {
"description": "The response lists behaviors available for the requested property version.",
"content": {
"application/json": {
"example": {
"contractId": "ctr_C-0N7RAC71",
"groupId": "grp_15225",
"productId": "prd_Alta",
"ruleFormat": "v2022-10-18",
"behaviors": {
"items": [
{
"name": "cpCode",
"schemaLink": "/papi/v0/schemas/products/prd_Alta/latest#/definitions/catalog/behaviors/cpCode"
},
{
"name": "origin",
"schemaLink": "/papi/v0/schemas/products/prd_Alta/latest#/definitions/catalog/behaviors/origin"
}
]
}
},
"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/GetAvailableBehaviorResponse.json#",
"type": "object",
"properties": {
"behaviors": {
"additionalProperties": false,
"description": "The set of available behaviors, available within an `items` array.",
"type": "object",
"properties": {
"items": {
"description": "Details of available behaviors for [properties](https://techdocs.akamai.com/property-mgr/reference/get-available-behaviors) or [includes](https://techdocs.akamai.com/property-mgr/reference/get-include-available-behaviors) under your current contract.",
"type": "array",
"items": {
"additionalProperties": false,
"type": "object",
"required": [
"name",
"schemaLink"
],
"properties": {
"name": {
"description": "The name of the currently available behavior.",
"type": "string"
},
"schemaLink": {
"description": "A link to the rule format that describes the behavior. Use the file link to [Get a rule format's schema](https://techdocs.akamai.com/property-mgr/reference/get-rule-formats), then use the appended JSON Pointer expression to navigate to the schema that catalogs its options.",
"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"
},
"productId": {
"description": "The product under which these behaviors are available.",
"type": "string"
},
"ruleFormat": {
"description": "The rule format version under which these behaviors are available. See [API versioning](https://techdocs.akamai.com/property-mgr/reference/api-versioning) for more information.",
"type": "string"
}
},
"x-akamai": {
"file-path": "schemas/available-behavior-get-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"
}
},
"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": "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.",
"example": "{{contractId}}",
"in": "query",
"name": "contractId",
"required": false,
"schema": {
"example": "ctr_1-1TJZFW",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/contractId-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.",
"example": "{{groupId}}",
"in": "query",
"name": "groupId",
"required": false,
"schema": {
"example": "grp_15166",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/groupId-optional.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"
}
}
]
},
"x-akamai": {
"file-path": "paths/property-version-available-behaviors.yaml",
"path-for-file": "/properties/{propertyId}/versions/{propertyVersion}/available-behaviors"
},
"x-akamai-descriptor-tools": {
"displayName": "availableBehaviors",
"group": "Property versions"
},
"parameters": [
{
"description": "Property's incremental version number.",
"example": "{{propertyVersion}}",
"in": "path",
"name": "propertyVersion",
"required": true,
"schema": {
"example": 3,
"type": "integer"
},
"x-akamai": {
"file-path": "parameters/propertyVersion-path.yaml"
}
},
{
"description": "Unique identifier for the property. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting the value's `prp_` prefix.",
"example": "{{propertyId}}",
"in": "path",
"name": "propertyId",
"required": true,
"schema": {
"example": "prp_12345",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/propertyId-path.yaml"
}
}
]
},
"/properties/{propertyId}/versions/{propertyVersion}/available-criteria": {
"get": {
"description": "Lists the set of [criteria](https://techdocs.akamai.com/property-mgr/reference/ga-criteria) you may apply within a property version's rules. The available set depends on the product under which you created the property and any additional modules enabled under your account.",
"operationId": "get-available-criteria",
"summary": "Akamai List Available Criteria for a Property",
"tags": [
"Property versions"
],
"externalDocs": {
"description": "See documentation for this operation in Akamai's Property Manager API",
"url": "https://techdocs.akamai.com/property-mgr/reference/get-available-criteria"
},
"responses": {
"200": {
"description": "The response lists criteria available for the requested property version.",
"content": {
"application/json": {
"example": {
"contractId": "ctr_C-0N7RAC7",
"groupId": "grp_15225",
"productId": "prd_Alta",
"ruleFormat": "v2022-10-18",
"criteria": {
"items": [
{
"name": "fileExtension",
"schemaLink": "/papi/v0/schemas/products/prd_Alta/latest#/definitions/catalog/criteria/fileExtension"
},
{
"name": "hostname",
"schemaLink": "/papi/v0/schemas/products/prd_Alta/latest#/definitions/catalog/criteria/hostname"
}
]
}
},
"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/GetAvailableCriteriaResponse.json#",
"type": "object",
"properties": {
"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"
},
"criteria": {
"additionalProperties": false,
"description": "The set of available criteria, available within an `items` array.",
"type": "object",
"properties": {
"items": {
"description": "Details of available criteria for [properties](https://techdocs.akamai.com/property-mgr/reference/get-available-criteria) or [includes](https://techdocs.akamai.com/property-mgr/reference/get-include-available-criteria) under your current contract.",
"type": "array",
"items": {
"additionalProperties": false,
"type": "object",
"required": [
"name",
"schemaLink"
],
"properties": {
"name": {
"description": "The name of the currently available criteria.",
"type": "string"
},
"schemaLink": {
"description": "A link to the rule format that describes the criteria. Use the file link to [Get a rule format's schema](https://techdocs.akamai.com/property-mgr/reference/get-rule-formats), then use the appended JSON Pointer expression to navigate to the schema that catalogs its options.",
"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"
},
"productId": {
"description": "The product under which these criteria are available.",
"type": "string"
},
"ruleFormat": {
"description": "The rule format version under which these matches are available. See [API versioning](https://techdocs.akamai.com/property-mgr/reference/api-versioning) for more information.",
"type": "string"
}
},
"x-akamai": {
"file-path": "schemas/available-criteria-get-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"
}
},
"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": "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.",
"example": "{{contractId}}",
"in": "query",
"name": "contractId",
"required": false,
"schema": {
"example": "ctr_1-1TJZFW",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/contractId-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.",
"example": "{{groupId}}",
"in": "query",
"name": "groupId",
"required": false,
"schema": {
"example": "grp_15166",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/groupId-optional.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"
}
}
]
},
"x-akamai": {
"file-path": "paths/property-version-available-criteria.yaml",
"path-for-file": "/properties/{propertyId}/versions/{propertyVersion}/available-criteria"
},
"x-akamai-descriptor-tools": {
"displayName": "availableCriteria",
"group": "Property versions"
},
"parameters": [
{
"description": "Property's incremental version number.",
"example": "{{propertyVersion}}",
"in": "path",
"name": "propertyVersion",
"required": true,
"schema": {
"example": 3,
"type": "integer"
},
"x-akamai": {
"file-path": "parameters/propertyVersion-path.yaml"
}
},
{
"description": "Unique identifier for the property. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting the value's `prp_` prefix.",
"example": "{{propertyId}}",
"in": "path",
"name": "propertyId",
"required": true,
"schema": {
"example": "prp_12345",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/propertyId-path.yaml"
}
}
]
},
"/properties/{propertyId}/versions/{propertyVersion}/hostnames": {
"get": {
"description": "List all hostnames whose requests are handled by the rules in this property version.",
"operationId": "get-property-version-hostnames",
"summary": "Akamai List Hostnames for a Property Version",
"tags": [
"Property version hostnames"
],
"externalDocs": {
"description": "See documentation for this operation in Akamai's Property Manager API",
"url": "https://techdocs.akamai.com/property-mgr/reference/get-property-version-hostnames"
},
"responses": {
"200": {
"description": "The response lists hostnames for a specified property version.",
"content": {
"application/json": {
"example": {
"accountId": "act_A-CCT9012",
"contractId": "ctr_K-0N7RAK7",
"etag": "6aed418629b4e5c0",
"groupId": "grp_15225",
"propertyId": "prp_175780",
"propertyVersion": 1,
"hostnames": {
"items": [
{
"certProvisioningType": "DEFAULT",
"cnameFrom": "example.com",
"cnameTo": "example.com.edgekey.net",
"cnameType": "EDGE_HOSTNAME",
"edgeHostnameId": "ehn_895822",
"certStatus": {
"validationCname": {
"hostname": "_acme-challenge.www.example.com",
"target": "{token}.www.example.com.akamai-domain.com"
},
"production": [
{
"status": "PENDING"
}
],
"staging": [
{
"status": "PENDING"
}
]
}
},
{
"certProvisioningType": "CPS_MANAGED",
"cnameFrom": "m.example.com",
"cnameTo": "m.example.com.edgesuite.net",
"cnameType": "EDGE_HOSTNAME",
"edgeHostnameId": "ehn_895833"
}
]
}
},
"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/GetHostnameResponse.json#",
"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"
},
"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"
},
"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"
},
"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"
},
"hostnames": {
"additionalProperties": false,
"description": "The set of requested property hostnames, available within an `items` array.",
"type": "object",
"properties": {
"items": {
"description": "Each entry specifies a property hostname that's assigned to the requested property version. Writing data to this resource requires that you PUT an array of _all_ the hostname objects, each containing `edgeHostnameId`, `cnameFrom`, and `cnameTo` members. This request array matches the `hostnames.items` in the response.",
"type": "array",
"items": {
"additionalProperties": false,
"type": "object",
"required": [
"cnameFrom",
"cnameType",
"edgeHostnameId",
"certProvisioningType"
],
"properties": {
"certProvisioningType": {
"description": "Indicates the certificate's provisioning type. Either the `CPS_MANAGED` type for the custom certificates you create with the [Certificate Provisioning System API](https://techdocs.akamai.com/cps/reference) (CPS), or `DEFAULT` for certificates created automatically. Note that you can't specify the `DEFAULT` value if your property hostname uses the `akamaized.net` domain suffix.",
"type": "string",
"enum": [
"CPS_MANAGED",
"DEFAULT"
]
},
"certStatus": {
"additionalProperties": false,
"description": "__Limited availability__ With the `includeCertStatus` parameter set to `true`, determines whether a hostname is capable of serving secure content over the staging or production network.",
"type": "object",
"properties": {
"production": {
"description": "__Limited availability__ The certificate status for the hostname on the production network.",
"minItems": 0,
"type": "array",
"items": {
"additionalProperties": false,
"type": "object",
"properties": {
"status": {
"description": "__Limited availability__ The status of the certificate deployment on the production network.\n\n\nExpand for details on possible values.\n
\n\nDEPLOYING indicates the deployment is in progress.\nPENDING indicates you need to add the validation challenge to your DNS and activate the property version on staging or production to deploy your certificate to that network. If you've done that already, run the operation again later to check if the deployment succeeded.\nNEEDS_ACTIVATION indicates the validation is complete and the status on the `production` network is either `DEPLOYING` or `DEPLOYED`. You need to activate the property version on staging to deploy the certificate to that network.\nDEPLOYED indicates the certificate is successfully validated on the network and ready to handle secure traffic.\nSTALLED indicates a problem with validation or deployment of your certificate. To try again, re-launch a certificate validation or contact Akamai Professional Services for help.\nPROHIBITED_DOMAIN_FAILURE indicates the hostname isn't in the Let's Encrypt Certificate Authority domain allow list. Fix the underlying issue and re-launch a certificate validation, or contact Akamai Professional Services for help.\nCAA_MISMATCH_RETRYING or CAA_MISMATCH_FAILURE indicate you need to configure your Certification Authority Authorization (CAA) policy to allow Let's Encrypt. Fix the underlying issue and re-launch a certificate validation, or contact Akamai Professional Services for help.\nEXPIRING_SOON_NEEDS_VALIDATION indicates your certificate is due to expire or already expired, and you need to add the _acme-challenge validation CNAME record in your DNS again.\nCNAME_MISSING_FAILURE indicates you removed the validation record from your DNS. Add the CNAME record to your DNS again and re-launch a certificate validation, or contact Akamai Professional Services for help.\nUNKNOWN_FAILURE To try again, re-launch a certificate validation or contact Akamai Professional Services for help.
",
"type": "string",
"enum": [
"DEPLOYING",
"PENDING",
"NEEDS_ACTIVATION",
"DEPLOYED",
"STALLED",
"PROHIBITED_DOMAIN_FAILURE",
"CAA_MISMATCH_RETRYING",
"CAA_MISMATCH_FAILURE",
"EXPIRING_SOON_NEEDS_VALIDATION",
"EXPIRED_NEEDS_VALIDATION",
"CNAME_MISSING_FAILURE",
"UNKNOWN_FAILURE"
],
"x-akamai": {
"status": "LA"
}
}
}
},
"x-akamai": {
"status": "LA"
}
},
"staging": {
"description": "__Limited availability__ The certificate status for the hostname on the staging network.",
"minItems": 0,
"type": "array",
"items": {
"additionalProperties": false,
"type": "object",
"properties": {
"status": {
"description": "__Limited availability__ The status of the certificate deployment on the staging network.\n\n\nDetails on possible values.\n
\n ",
"type": "string",
"enum": [
"DEPLOYING",
"PENDING",
"NEEDS_ACTIVATION",
"DEPLOYED",
"STALLED",
"PROHIBITED_DOMAIN_FAILURE",
"CAA_MISMATCH_RETRYING",
"CAA_MISMATCH_FAILURE",
"EXPIRING_SOON_NEEDS_VALIDATION",
"EXPIRED_NEEDS_VALIDATION",
"CNAME_MISSING_FAILURE",
"UNKNOWN_FAILURE"
],
"x-akamai": {
"status": "LA"
}
}
}
},
"x-akamai": {
"status": "LA"
}
},
"validationCname": {
"additionalProperties": false,
"description": "__Limited availability__ The CNAME record used to validate the certificate's domain.",
"type": "object",
"required": [
"hostname",
"target"
],
"properties": {
"hostname": {
"description": "__Limited availability__ The hostname part of the CNAME record used to validate the certificate's domain.",
"type": "string",
"x-akamai": {
"status": "LA"
}
},
"target": {
"description": "__Limited availability__ The destination part of the CNAME record used to validate the certificate's domain.",
"type": "string",
"x-akamai": {
"status": "LA"
}
}
},
"x-akamai": {
"status": "LA"
}
}
},
"x-akamai": {
"status": "LA"
}
},
"cnameFrom": {
"description": "The hostname that your end users see, indicated by the `Host` header in end user requests.",
"type": "string"
},
"cnameTo": {
"description": "The edge hostname you point the property hostname to so that you can start serving traffic through Akamai servers. This member corresponds to the edge hostname object's `edgeHostnameDomain` member.",
"type": "string"
},
"cnameType": {
"description": "Only one supported `EDGE_HOSTNAME` value.",
"type": "string",
"enum": [
"EDGE_HOSTNAME"
]
},
"edgeHostnameId": {
"description": "Identifies each edge hostname. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on how to omit the ID's `ehn_` prefix.",
"type": "string"
}
}
}
}
}
},
"propertyId": {
"description": "Identifies the property this set of hostnames represents. 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"
},
"propertyVersion": {
"description": "The version of the property this set of hostnames represents.",
"minimum": 1,
"type": "integer"
}
},
"x-akamai": {
"file-path": "schemas/property-version-hostnames-get-response.yaml"
}
}
}
},
"headers": {
"ETag": {
"description": "Pass the `ETag` response header back as `If-Match` in write requests to ensure you don't overwrite edits by any other API clients. See [Concurrency control](https://techdocs.akamai.com/property-mgr/reference/concurrency-control) for details.",
"example": "\"a9dfe78cf93090516bde891d009eaf57\"",
"schema": {
"type": "string"
},
"x-akamai": {
"file-path": "headers/Etag.yaml"
}
},
"X-Limit-Hosts-Per-Property-Limit": {
"description": "Maximum number of hostnames you can assign to a property configuration.",
"schema": {
"type": "string"
},
"x-akamai": {
"file-path": "headers/X-Limit-Hosts-Per-Property-Limit.yaml"
}
},
"X-Limit-Hosts-Per-Property-Remaining": {
"description": "Remaining number of hostnames you can assign to a property configuration. See [Rate and resource limiting](https://techdocs.akamai.com/property-mgr/reference/rate-and-resource-limiting) for details.",
"schema": {
"type": "string"
},
"x-akamai": {
"file-path": "headers/X-Limit-Hosts-Per-Property-Remaining.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"
}
},
"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": "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.",
"example": "{{contractId}}",
"in": "query",
"name": "contractId",
"required": false,
"schema": {
"example": "ctr_1-1TJZFW",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/contractId-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.",
"example": "{{groupId}}",
"in": "query",
"name": "groupId",
"required": false,
"schema": {
"example": "grp_15166",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/groupId-optional.yaml"
}
},
{
"description": "When `false`, skips validation tests that would identify potential hostname-related problems within the response object's `errors` and `warnings` arrays. See [Property hostname errors](https://techdocs.akamai.com/property-mgr/reference/validation-errors) for details on relevant error feedback. See [Validation best practices](https://techdocs.akamai.com/property-mgr/reference/validation-best-practices) for guidance on when to defer validation.",
"example": "{{validateHostnames}}",
"in": "query",
"name": "validateHostnames",
"required": false,
"schema": {
"default": false,
"example": true,
"type": "boolean"
},
"x-akamai": {
"file-path": "parameters/validateHostnames-query.yaml"
}
},
{
"description": "__Limited availability__ Whether the response should include the certificate status for the hostname on staging and production networks.",
"example": "{{includeCertStatus}}",
"in": "query",
"name": "includeCertStatus",
"required": false,
"schema": {
"default": false,
"example": true,
"type": "boolean"
},
"x-akamai": {
"file-path": "parameters/includeCertStatus-query.yaml",
"status": "LA"
}
},
{
"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"
}
}
]
},
"put": {
"description": "Modify the set of hostnames for a property version. For each hostname entry, set headers indicating their [limits](https://techdocs.akamai.com/property-mgr/reference/rate-and-resource-limiting).\n\n**Note**: If you're using a new account, first register it on the Akamai network by activating any property version on either staging or production. Otherwise, your attempts to create or specify certificates will fail with a [403](https://techdocs.akamai.com/property-mgr/reference/403) error.",
"operationId": "put-property-version-hostnames",
"summary": "Akamai Update Hostnames for a Property Version",
"tags": [
"Property version hostnames"
],
"externalDocs": {
"description": "See documentation for this operation in Akamai's Property Manager API",
"url": "https://techdocs.akamai.com/property-mgr/reference/put-property-version-hostnames"
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$schema": "http://json-schema.org/draft-04-schema#",
"description": "Updates the set of property hostnames that apply to a property version.",
"id": "resource:/descriptors/papi/v1/schemas/SetPropertyVersionsHostnamesRequestV0.json#",
"javaType": "java.util.List",
"type": "array",
"items": {
"type": "object",
"properties": {
"certProvisioningType": {
"description": "Indicates the certificate's provisioning type. Either the `CPS_MANAGED` type for the custom certificates you create with the [Certificate Provisioning System API](https://techdocs.akamai.com/cps/reference) (CPS), or `DEFAULT` for certificates created automatically. Note that you can't specify the `DEFAULT` value if your property hostname uses the `akamaized.net` domain suffix.",
"type": "string",
"enum": [
"DEFAULT",
"CPS_MANAGED"
]
},
"cnameFrom": {
"description": "The hostname that your end users see, indicated by the `Host` header in end user requests.",
"type": "string"
},
"cnameTo": {
"description": "The edge hostname you point the property hostname to so that you can start serving traffic through Akamai servers. This member corresponds to the edge hostname object's `edgeHostnameDomain` member.",
"type": "string"
},
"cnameType": {
"description": "Only one supported `EDGE_HOSTNAME` value.",
"type": "string",
"enum": [
"EDGE_HOSTNAME"
]
},
"edgeHostnameId": {
"description": "Identifies each edge hostname. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on how to omit the ID's `ehn_` prefix.",
"type": "string"
}
}
},
"x-akamai": {
"file-path": "schemas/property-version-hostnames-set-request.yaml"
}
},
"example": [
{
"certProvisioningType": "DEFAULT",
"cnameFrom": "m.example.com",
"cnameTo": "example.com.edgekey.net",
"cnameType": "EDGE_HOSTNAME"
},
{
"certProvisioningType": "CPS_MANAGED",
"cnameFrom": "example3.com",
"cnameType": "EDGE_HOSTNAME",
"edgeHostnameId": "ehn_895824"
}
]
}
}
},
"responses": {
"200": {
"description": "The response lists the property version's updated set of hostnames.",
"content": {
"application/json": {
"example": {
"accountId": "act_A-CCT7890",
"contractId": "ctr_K-0N7RAK71",
"etag": "6aed418629b4e5c0",
"groupId": "grp_15225",
"propertyId": "prp_175780",
"propertyVersion": 1,
"hostnames": {
"items": [
{
"certProvisioningType": "DEFAULT",
"cnameFrom": "example.com",
"cnameTo": "example.com.edgekey.net",
"cnameType": "EDGE_HOSTNAME",
"edgeHostnameId": "ehn_895822",
"certStatus": {
"validationCname": {
"hostname": "_acme-challenge.www.example.com",
"target": "{token}.www.example.com.akamai-domain.com"
},
"production": [
{
"status": "PENDING"
}
],
"staging": [
{
"status": "PENDING"
}
]
}
},
{
"certProvisioningType": "CPS_MANAGED",
"cnameFrom": "m.example.com",
"cnameTo": "m.example.com.edgesuite.net",
"cnameType": "EDGE_HOSTNAME",
"edgeHostnameId": "ehn_895833"
}
]
}
},
"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/GetHostnameResponse.json#",
"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"
},
"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"
},
"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"
},
"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"
},
"hostnames": {
"additionalProperties": false,
"description": "The set of requested property hostnames, available within an `items` array.",
"type": "object",
"properties": {
"items": {
"description": "Each entry specifies a property hostname that's assigned to the requested property version. Writing data to this resource requires that you PUT an array of _all_ the hostname objects, each containing `edgeHostnameId`, `cnameFrom`, and `cnameTo` members. This request array matches the `hostnames.items` in the response.",
"type": "array",
"items": {
"additionalProperties": false,
"type": "object",
"required": [
"cnameFrom",
"cnameType",
"edgeHostnameId",
"certProvisioningType"
],
"properties": {
"certProvisioningType": {
"description": "Indicates the certificate's provisioning type. Either the `CPS_MANAGED` type for the custom certificates you create with the [Certificate Provisioning System API](https://techdocs.akamai.com/cps/reference) (CPS), or `DEFAULT` for certificates created automatically. Note that you can't specify the `DEFAULT` value if your property hostname uses the `akamaized.net` domain suffix.",
"type": "string",
"enum": [
"CPS_MANAGED",
"DEFAULT"
]
},
"certStatus": {
"additionalProperties": false,
"description": "__Limited availability__ With the `includeCertStatus` parameter set to `true`, determines whether a hostname is capable of serving secure content over the staging or production network.",
"type": "object",
"properties": {
"production": {
"description": "__Limited availability__ The certificate status for the hostname on the production network.",
"minItems": 0,
"type": "array",
"items": {
"additionalProperties": false,
"type": "object",
"properties": {
"status": {
"description": "__Limited availability__ The status of the certificate deployment on the production network.\n\n\nExpand for details on possible values.\n
\n\nDEPLOYING indicates the deployment is in progress.\nPENDING indicates you need to add the validation challenge to your DNS and activate the property version on staging or production to deploy your certificate to that network. If you've done that already, run the operation again later to check if the deployment succeeded.\nNEEDS_ACTIVATION indicates the validation is complete and the status on the `production` network is either `DEPLOYING` or `DEPLOYED`. You need to activate the property version on staging to deploy the certificate to that network.\nDEPLOYED indicates the certificate is successfully validated on the network and ready to handle secure traffic.\nSTALLED indicates a problem with validation or deployment of your certificate. To try again, re-launch a certificate validation or contact Akamai Professional Services for help.\nPROHIBITED_DOMAIN_FAILURE indicates the hostname isn't in the Let's Encrypt Certificate Authority domain allow list. Fix the underlying issue and re-launch a certificate validation, or contact Akamai Professional Services for help.\nCAA_MISMATCH_RETRYING or CAA_MISMATCH_FAILURE indicate you need to configure your Certification Authority Authorization (CAA) policy to allow Let's Encrypt. Fix the underlying issue and re-launch a certificate validation, or contact Akamai Professional Services for help.\nEXPIRING_SOON_NEEDS_VALIDATION indicates your certificate is due to expire or already expired, and you need to add the _acme-challenge validation CNAME record in your DNS again.\nCNAME_MISSING_FAILURE indicates you removed the validation record from your DNS. Add the CNAME record to your DNS again and re-launch a certificate validation, or contact Akamai Professional Services for help.\nUNKNOWN_FAILURE To try again, re-launch a certificate validation or contact Akamai Professional Services for help.
",
"type": "string",
"enum": [
"DEPLOYING",
"PENDING",
"NEEDS_ACTIVATION",
"DEPLOYED",
"STALLED",
"PROHIBITED_DOMAIN_FAILURE",
"CAA_MISMATCH_RETRYING",
"CAA_MISMATCH_FAILURE",
"EXPIRING_SOON_NEEDS_VALIDATION",
"EXPIRED_NEEDS_VALIDATION",
"CNAME_MISSING_FAILURE",
"UNKNOWN_FAILURE"
],
"x-akamai": {
"status": "LA"
}
}
}
},
"x-akamai": {
"status": "LA"
}
},
"staging": {
"description": "__Limited availability__ The certificate status for the hostname on the staging network.",
"minItems": 0,
"type": "array",
"items": {
"additionalProperties": false,
"type": "object",
"properties": {
"status": {
"description": "__Limited availability__ The status of the certificate deployment on the staging network.\n\n\nDetails on possible values.\n
\n ",
"type": "string",
"enum": [
"DEPLOYING",
"PENDING",
"NEEDS_ACTIVATION",
"DEPLOYED",
"STALLED",
"PROHIBITED_DOMAIN_FAILURE",
"CAA_MISMATCH_RETRYING",
"CAA_MISMATCH_FAILURE",
"EXPIRING_SOON_NEEDS_VALIDATION",
"EXPIRED_NEEDS_VALIDATION",
"CNAME_MISSING_FAILURE",
"UNKNOWN_FAILURE"
],
"x-akamai": {
"status": "LA"
}
}
}
},
"x-akamai": {
"status": "LA"
}
},
"validationCname": {
"additionalProperties": false,
"description": "__Limited availability__ The CNAME record used to validate the certificate's domain.",
"type": "object",
"required": [
"hostname",
"target"
],
"properties": {
"hostname": {
"description": "__Limited availability__ The hostname part of the CNAME record used to validate the certificate's domain.",
"type": "string",
"x-akamai": {
"status": "LA"
}
},
"target": {
"description": "__Limited availability__ The destination part of the CNAME record used to validate the certificate's domain.",
"type": "string",
"x-akamai": {
"status": "LA"
}
}
},
"x-akamai": {
"status": "LA"
}
}
},
"x-akamai": {
"status": "LA"
}
},
"cnameFrom": {
"description": "The hostname that your end users see, indicated by the `Host` header in end user requests.",
"type": "string"
},
"cnameTo": {
"description": "The edge hostname you point the property hostname to so that you can start serving traffic through Akamai servers. This member corresponds to the edge hostname object's `edgeHostnameDomain` member.",
"type": "string"
},
"cnameType": {
"description": "Only one supported `EDGE_HOSTNAME` value.",
"type": "string",
"enum": [
"EDGE_HOSTNAME"
]
},
"edgeHostnameId": {
"description": "Identifies each edge hostname. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on how to omit the ID's `ehn_` prefix.",
"type": "string"
}
}
}
}
}
},
"propertyId": {
"description": "Identifies the property this set of hostnames represents. 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"
},
"propertyVersion": {
"description": "The version of the property this set of hostnames represents.",
"minimum": 1,
"type": "integer"
}
},
"x-akamai": {
"file-path": "schemas/property-version-hostnames-get-response.yaml"
}
}
}
},
"headers": {
"ETag": {
"description": "Pass the `ETag` response header back as `If-Match` in write requests to ensure you don't overwrite edits by any other API clients. See [Concurrency control](https://techdocs.akamai.com/property-mgr/reference/concurrency-control) for details.",
"example": "\"a9dfe78cf93090516bde891d009eaf57\"",
"schema": {
"type": "string"
},
"x-akamai": {
"file-path": "headers/Etag.yaml"
}
},
"X-Limit-Default-Certs-Per-Contract-Limit": {
"description": "The total number of default certificates per contract. This header only appears if you have any hostnames with default certificates assigned to the property version.",
"schema": {
"type": "string"
},
"x-akamai": {
"file-path": "headers/X-Limit-Default-Certs-Per-Contract-Limit.yaml"
}
},
"X-Limit-Default-Certs-Per-Contract-Remaining": {
"description": "The number of remaining default certificates per contract. This header only appears if you have any hostnames with default certificates assigned to the property version.",
"schema": {
"type": "string"
},
"x-akamai": {
"file-path": "headers/X-Limit-Default-Certs-Per-Contract-Remaining.yaml"
}
},
"X-Limit-Hosts-Per-Property-Limit": {
"description": "Maximum number of hostnames you can assign to a property configuration.",
"schema": {
"type": "string"
},
"x-akamai": {
"file-path": "headers/X-Limit-Hosts-Per-Property-Limit.yaml"
}
},
"X-Limit-Hosts-Per-Property-Remaining": {
"description": "Remaining number of hostnames you can assign to a property configuration. See [Rate and resource limiting](https://techdocs.akamai.com/property-mgr/reference/rate-and-resource-limiting) for details.",
"schema": {
"type": "string"
},
"x-akamai": {
"file-path": "headers/X-Limit-Hosts-Per-Property-Remaining.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"
}
},
"412": {
"description": "[Precondition failed](https://techdocs.akamai.com/property-mgr/reference/412).",
"content": {
"application/problem+json": {
"example": {
"detail": "Cannot activate the property at this time, please try again.",
"instance": "papi/v1/properties/prp_123456/activations?contractId=ctr_C-0N7RAC7&groupId=grp_12345#abc12345abcc02a7",
"status": 412,
"title": "Precondition Failed",
"type": "https://problems.luna.akamaiapis.net/papi/v0/toolkit/validation_failed.error.activation.tower_precondition.failed"
},
"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/412.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": "This corresponds to the `ETag` response header. Passing this value back as `If-Match` in write requests ensures you don't overwrite edits by any other API clients. See [Concurrency control](https://techdocs.akamai.com/property-mgr/reference/concurrency-control) for details.",
"example": "{{If-Match}}",
"in": "header",
"name": "If-Match",
"required": true,
"schema": {
"example": "\"a9dfe78cf93090516bde891d009eaf57\"",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/If-Match-header.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.",
"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": "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.",
"example": "{{contractId}}",
"in": "query",
"name": "contractId",
"required": false,
"schema": {
"example": "ctr_1-1TJZFW",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/contractId-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.",
"example": "{{groupId}}",
"in": "query",
"name": "groupId",
"required": false,
"schema": {
"example": "grp_15166",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/groupId-optional.yaml"
}
},
{
"description": "When `false`, skips validation tests that would identify potential hostname-related problems within the response object's `errors` and `warnings` arrays. See [Property hostname errors](https://techdocs.akamai.com/property-mgr/reference/validation-errors) for details on relevant error feedback. See [Validation best practices](https://techdocs.akamai.com/property-mgr/reference/validation-best-practices) for guidance on when to defer validation.",
"example": "{{validateHostnames}}",
"in": "query",
"name": "validateHostnames",
"required": false,
"schema": {
"default": false,
"example": true,
"type": "boolean"
},
"x-akamai": {
"file-path": "parameters/validateHostnames-query.yaml"
}
},
{
"description": "__Limited availability__ Whether the response should include the certificate status for the hostname on staging and production networks.",
"example": "{{includeCertStatus}}",
"in": "query",
"name": "includeCertStatus",
"required": false,
"schema": {
"default": false,
"example": true,
"type": "boolean"
},
"x-akamai": {
"file-path": "parameters/includeCertStatus-query.yaml",
"status": "LA"
}
},
{
"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"
}
}
]
},
"patch": {
"description": "Modify the set of hostnames for a property version. For new entries, specify an `add` array with a `cnameFrom` set to the hostname your end users see as `Host` headers. In either `cnameTo` or `edgeHostnameId`, specify an existing edge hostname you want to redirect your hostname to. If you're using Secure by Default, you can set the `cnameTo` to an edge hostname that doesn't exist yet, and PAPI creates it automatically when you activate the property version. To remove a hostname, specify a `remove` array with the address of the hostname you don't want to use with this property version anymore. If you remove an edge hostname from an active property configuration, use the [Edge Hostname API](https://techdocs.akamai.com/edge-hostnames/reference/delete-edgehostname) (HAPI) to delete it entirely. If you modify hostnames with default certificates, the response includes additional `X-Limit-Default-Certs-Per-Contract-Limit` and `X-Limit-Default-Certs-Per-Contract-Remaining` headers indicating their [limits](https://techdocs.akamai.com/property-mgr/reference/rate-and-resource-limiting).\n\n**Note**: If you're using a new account, first register it on the Akamai network by activating any property version on either staging or production. Otherwise, your attempts to create or specify certificates will fail with a [403](https://techdocs.akamai.com/property-mgr/reference/403) error.",
"operationId": "patch-property-version-hostnames",
"summary": "Akamai Add or Remove Hostnames for a Property Version",
"tags": [
"Property version hostnames"
],
"externalDocs": {
"description": "See documentation for this operation in Akamai's Property Manager API",
"url": "https://techdocs.akamai.com/property-mgr/reference/patch-property-version-hostnames"
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"example": {
"remove": [
"m.example.com",
"example4.com"
],
"add": [
{
"cnameFrom": "m.example.com",
"cnameTo": "example.com.edgesuite.net",
"cnameType": "EDGE_HOSTNAME"
},
{
"cnameFrom": "example3.com",
"cnameType": "EDGE_HOSTNAME",
"edgeHostnameId": "ehn_895824"
}
]
},
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Updates the set of property hostnames that apply to a property version. You delete each hostname by specifying its string value. For additions, you need to specify a fuller object.",
"id": "resource:/descriptors/papi/v1/schemas/EditPropertyVersionsHostnamesRequestV0.json#",
"javaType": "com.akamai.luna.papi.model.EditHostnameItem",
"type": "object",
"properties": {
"add": {
"description": "Adds new hostnames to a property version's current set of hostnames.",
"type": "array",
"items": {
"type": "object",
"required": [
"cnameFrom"
],
"properties": {
"certProvisioningType": {
"description": "Indicates the certificate's provisioning type. Either the `CPS_MANAGED` type for the custom certificates you create with the [Certificate Provisioning System API](https://techdocs.akamai.com/cps/reference) (CPS), or `DEFAULT` for certificates created automatically. Note that you can't specify the `DEFAULT` value if your property hostname uses the `akamaized.net` domain suffix.",
"type": "string",
"enum": [
"DEFAULT",
"CPS_MANAGED"
]
},
"cnameFrom": {
"description": "The hostname that your end users see, indicated by the `Host` header in end user requests.",
"type": "string"
},
"cnameTo": {
"description": "The edge hostname you point the property hostname to so that you can start serving traffic through Akamai servers. This member corresponds to the edge hostname object's `edgeHostnameDomain` member.",
"type": "string"
},
"cnameType": {
"description": "Only one supported `EDGE_HOSTNAME` value.",
"type": "string",
"enum": [
"EDGE_HOSTNAME"
]
},
"edgeHostnameId": {
"description": "Identifies each edge hostname. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on how to omit the ID's `ehn_` prefix.",
"type": "string"
}
}
}
},
"remove": {
"description": "Removes property hostnames from a property version's current set of hostnames.",
"type": "array",
"items": {
"type": "string"
}
}
},
"x-akamai": {
"file-path": "schemas/property-version-hostnames-edit-request.yaml"
}
}
}
}
},
"responses": {
"200": {
"description": "The response lists the property version's updated set of hostnames.",
"content": {
"application/json": {
"example": {
"accountId": "act_A-CCT3456",
"contractId": "ctr_C-0N7RAC7",
"etag": "6aed418629b4e5c0",
"groupId": "grp_15225",
"propertyId": "prp_175780",
"propertyVersion": 1,
"hostnames": {
"items": [
{
"certProvisioningType": "DEFAULT",
"cnameFrom": "example.com",
"cnameTo": "example.com.edgekey.net",
"cnameType": "EDGE_HOSTNAME",
"edgeHostnameId": "ehn_895822",
"certStatus": {
"validationCname": {
"hostname": "_acme-challenge.www.example.com",
"target": "{token}.www.example.com.akamai-domain.com"
},
"production": [
{
"status": "PENDING"
}
],
"staging": [
{
"status": "PENDING"
}
]
}
},
{
"certProvisioningType": "CPS_MANAGED",
"cnameFrom": "m.example.com",
"cnameTo": "m.example.com.edgesuite.net",
"cnameType": "EDGE_HOSTNAME",
"edgeHostnameId": "ehn_895833"
}
]
}
},
"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/GetHostnameResponse.json#",
"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"
},
"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"
},
"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"
},
"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"
},
"hostnames": {
"additionalProperties": false,
"description": "The set of requested property hostnames, available within an `items` array.",
"type": "object",
"properties": {
"items": {
"description": "Each entry specifies a property hostname that's assigned to the requested property version. Writing data to this resource requires that you PUT an array of _all_ the hostname objects, each containing `edgeHostnameId`, `cnameFrom`, and `cnameTo` members. This request array matches the `hostnames.items` in the response.",
"type": "array",
"items": {
"additionalProperties": false,
"type": "object",
"required": [
"cnameFrom",
"cnameType",
"edgeHostnameId",
"certProvisioningType"
],
"properties": {
"certProvisioningType": {
"description": "Indicates the certificate's provisioning type. Either the `CPS_MANAGED` type for the custom certificates you create with the [Certificate Provisioning System API](https://techdocs.akamai.com/cps/reference) (CPS), or `DEFAULT` for certificates created automatically. Note that you can't specify the `DEFAULT` value if your property hostname uses the `akamaized.net` domain suffix.",
"type": "string",
"enum": [
"CPS_MANAGED",
"DEFAULT"
]
},
"certStatus": {
"additionalProperties": false,
"description": "__Limited availability__ With the `includeCertStatus` parameter set to `true`, determines whether a hostname is capable of serving secure content over the staging or production network.",
"type": "object",
"properties": {
"production": {
"description": "__Limited availability__ The certificate status for the hostname on the production network.",
"minItems": 0,
"type": "array",
"items": {
"additionalProperties": false,
"type": "object",
"properties": {
"status": {
"description": "__Limited availability__ The status of the certificate deployment on the production network.\n\n\nExpand for details on possible values.\n
\n\nDEPLOYING indicates the deployment is in progress.\nPENDING indicates you need to add the validation challenge to your DNS and activate the property version on staging or production to deploy your certificate to that network. If you've done that already, run the operation again later to check if the deployment succeeded.\nNEEDS_ACTIVATION indicates the validation is complete and the status on the `production` network is either `DEPLOYING` or `DEPLOYED`. You need to activate the property version on staging to deploy the certificate to that network.\nDEPLOYED indicates the certificate is successfully validated on the network and ready to handle secure traffic.\nSTALLED indicates a problem with validation or deployment of your certificate. To try again, re-launch a certificate validation or contact Akamai Professional Services for help.\nPROHIBITED_DOMAIN_FAILURE indicates the hostname isn't in the Let's Encrypt Certificate Authority domain allow list. Fix the underlying issue and re-launch a certificate validation, or contact Akamai Professional Services for help.\nCAA_MISMATCH_RETRYING or CAA_MISMATCH_FAILURE indicate you need to configure your Certification Authority Authorization (CAA) policy to allow Let's Encrypt. Fix the underlying issue and re-launch a certificate validation, or contact Akamai Professional Services for help.\nEXPIRING_SOON_NEEDS_VALIDATION indicates your certificate is due to expire or already expired, and you need to add the _acme-challenge validation CNAME record in your DNS again.\nCNAME_MISSING_FAILURE indicates you removed the validation record from your DNS. Add the CNAME record to your DNS again and re-launch a certificate validation, or contact Akamai Professional Services for help.\nUNKNOWN_FAILURE To try again, re-launch a certificate validation or contact Akamai Professional Services for help.
",
"type": "string",
"enum": [
"DEPLOYING",
"PENDING",
"NEEDS_ACTIVATION",
"DEPLOYED",
"STALLED",
"PROHIBITED_DOMAIN_FAILURE",
"CAA_MISMATCH_RETRYING",
"CAA_MISMATCH_FAILURE",
"EXPIRING_SOON_NEEDS_VALIDATION",
"EXPIRED_NEEDS_VALIDATION",
"CNAME_MISSING_FAILURE",
"UNKNOWN_FAILURE"
],
"x-akamai": {
"status": "LA"
}
}
}
},
"x-akamai": {
"status": "LA"
}
},
"staging": {
"description": "__Limited availability__ The certificate status for the hostname on the staging network.",
"minItems": 0,
"type": "array",
"items": {
"additionalProperties": false,
"type": "object",
"properties": {
"status": {
"description": "__Limited availability__ The status of the certificate deployment on the staging network.\n\n\nDetails on possible values.\n
\n ",
"type": "string",
"enum": [
"DEPLOYING",
"PENDING",
"NEEDS_ACTIVATION",
"DEPLOYED",
"STALLED",
"PROHIBITED_DOMAIN_FAILURE",
"CAA_MISMATCH_RETRYING",
"CAA_MISMATCH_FAILURE",
"EXPIRING_SOON_NEEDS_VALIDATION",
"EXPIRED_NEEDS_VALIDATION",
"CNAME_MISSING_FAILURE",
"UNKNOWN_FAILURE"
],
"x-akamai": {
"status": "LA"
}
}
}
},
"x-akamai": {
"status": "LA"
}
},
"validationCname": {
"additionalProperties": false,
"description": "__Limited availability__ The CNAME record used to validate the certificate's domain.",
"type": "object",
"required": [
"hostname",
"target"
],
"properties": {
"hostname": {
"description": "__Limited availability__ The hostname part of the CNAME record used to validate the certificate's domain.",
"type": "string",
"x-akamai": {
"status": "LA"
}
},
"target": {
"description": "__Limited availability__ The destination part of the CNAME record used to validate the certificate's domain.",
"type": "string",
"x-akamai": {
"status": "LA"
}
}
},
"x-akamai": {
"status": "LA"
}
}
},
"x-akamai": {
"status": "LA"
}
},
"cnameFrom": {
"description": "The hostname that your end users see, indicated by the `Host` header in end user requests.",
"type": "string"
},
"cnameTo": {
"description": "The edge hostname you point the property hostname to so that you can start serving traffic through Akamai servers. This member corresponds to the edge hostname object's `edgeHostnameDomain` member.",
"type": "string"
},
"cnameType": {
"description": "Only one supported `EDGE_HOSTNAME` value.",
"type": "string",
"enum": [
"EDGE_HOSTNAME"
]
},
"edgeHostnameId": {
"description": "Identifies each edge hostname. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on how to omit the ID's `ehn_` prefix.",
"type": "string"
}
}
}
}
}
},
"propertyId": {
"description": "Identifies the property this set of hostnames represents. 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"
},
"propertyVersion": {
"description": "The version of the property this set of hostnames represents.",
"minimum": 1,
"type": "integer"
}
},
"x-akamai": {
"file-path": "schemas/property-version-hostnames-get-response.yaml"
}
}
}
},
"headers": {
"ETag": {
"description": "Pass the `ETag` response header back as `If-Match` in write requests to ensure you don't overwrite edits by any other API clients. See [Concurrency control](https://techdocs.akamai.com/property-mgr/reference/concurrency-control) for details.",
"example": "\"a9dfe78cf93090516bde891d009eaf57\"",
"schema": {
"type": "string"
},
"x-akamai": {
"file-path": "headers/Etag.yaml"
}
},
"X-Limit-Default-Certs-Per-Contract-Limit": {
"description": "The total number of default certificates per contract. This header only appears if you have any hostnames with default certificates assigned to the property version.",
"schema": {
"type": "string"
},
"x-akamai": {
"file-path": "headers/X-Limit-Default-Certs-Per-Contract-Limit.yaml"
}
},
"X-Limit-Default-Certs-Per-Contract-Remaining": {
"description": "The number of remaining default certificates per contract. This header only appears if you have any hostnames with default certificates assigned to the property version.",
"schema": {
"type": "string"
},
"x-akamai": {
"file-path": "headers/X-Limit-Default-Certs-Per-Contract-Remaining.yaml"
}
},
"X-Limit-Hosts-Per-Property-Limit": {
"description": "Maximum number of hostnames you can assign to a property configuration.",
"schema": {
"type": "string"
},
"x-akamai": {
"file-path": "headers/X-Limit-Hosts-Per-Property-Limit.yaml"
}
},
"X-Limit-Hosts-Per-Property-Remaining": {
"description": "Remaining number of hostnames you can assign to a property configuration. See [Rate and resource limiting](https://techdocs.akamai.com/property-mgr/reference/rate-and-resource-limiting) for details.",
"schema": {
"type": "string"
},
"x-akamai": {
"file-path": "headers/X-Limit-Hosts-Per-Property-Remaining.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"
}
},
"412": {
"description": "[Precondition failed](https://techdocs.akamai.com/property-mgr/reference/412).",
"content": {
"application/problem+json": {
"example": {
"detail": "Cannot activate the property at this time, please try again.",
"instance": "papi/v1/properties/prp_123456/activations?contractId=ctr_C-0N7RAC7&groupId=grp_12345#abc12345abcc02a7",
"status": 412,
"title": "Precondition Failed",
"type": "https://problems.luna.akamaiapis.net/papi/v0/toolkit/validation_failed.error.activation.tower_precondition.failed"
},
"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/412.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": "This corresponds to the `ETag` response header. Passing this value back as `If-Match` in write requests ensures you don't overwrite edits by any other API clients. See [Concurrency control](https://techdocs.akamai.com/property-mgr/reference/concurrency-control) for details.",
"example": "{{If-Match}}",
"in": "header",
"name": "If-Match",
"required": true,
"schema": {
"example": "\"a9dfe78cf93090516bde891d009eaf57\"",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/If-Match-header.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.",
"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": "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.",
"example": "{{contractId}}",
"in": "query",
"name": "contractId",
"required": false,
"schema": {
"example": "ctr_1-1TJZFW",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/contractId-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.",
"example": "{{groupId}}",
"in": "query",
"name": "groupId",
"required": false,
"schema": {
"example": "grp_15166",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/groupId-optional.yaml"
}
},
{
"description": "When `false`, skips validation tests that would identify potential hostname-related problems within the response object's `errors` and `warnings` arrays. See [Property hostname errors](https://techdocs.akamai.com/property-mgr/reference/validation-errors) for details on relevant error feedback. See [Validation best practices](https://techdocs.akamai.com/property-mgr/reference/validation-best-practices) for guidance on when to defer validation.",
"example": "{{validateHostnames}}",
"in": "query",
"name": "validateHostnames",
"required": false,
"schema": {
"default": false,
"example": true,
"type": "boolean"
},
"x-akamai": {
"file-path": "parameters/validateHostnames-query.yaml"
}
},
{
"description": "__Limited availability__ Whether the response should include the certificate status for the hostname on staging and production networks.",
"example": "{{includeCertStatus}}",
"in": "query",
"name": "includeCertStatus",
"required": false,
"schema": {
"default": false,
"example": true,
"type": "boolean"
},
"x-akamai": {
"file-path": "parameters/includeCertStatus-query.yaml",
"status": "LA"
}
},
{
"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"
}
}
]
},
"x-akamai": {
"file-path": "paths/property-version-hostnames.yaml",
"path-for-file": "/properties/{propertyId}/versions/{propertyVersion}/hostnames"
},
"x-akamai-descriptor-tools": {
"displayName": "propertyVersionHostnames",
"group": "Property version hostnames"
},
"parameters": [
{
"description": "Unique identifier for the property. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting the value's `prp_` prefix.",
"example": "{{propertyId}}",
"in": "path",
"name": "propertyId",
"required": true,
"schema": {
"example": "prp_12345",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/propertyId-path.yaml"
}
},
{
"description": "Property's incremental version number.",
"example": "{{propertyVersion}}",
"in": "path",
"name": "propertyVersion",
"required": true,
"schema": {
"example": 3,
"type": "integer"
},
"x-akamai": {
"file-path": "parameters/propertyVersion-path.yaml"
}
}
]
},
"/properties/{propertyId}/versions/{propertyVersion}/includes": {
"get": {
"description": "__Limited availability__ Lists the set of includes referenced in the property version's rule tree.",
"operationId": "get-property-version-includes",
"summary": "Akamai List Property's Includes",
"tags": [
"Property version includes"
],
"externalDocs": {
"description": "See documentation for this operation in Akamai's Property Manager API",
"url": "https://techdocs.akamai.com/property-mgr/reference/get-property-version-includes"
},
"responses": {
"200": {
"description": "The response lists includes that are referenced in the requested property version's rule tree.",
"content": {
"application/json": {
"example": {
"includes": {
"items": [
{
"accountId": "act_A-CCT1234",
"assetId": "aid_101",
"contractId": "ctr_C-0N7RAC7",
"groupId": "grp_12345",
"includeId": "inc_243237",
"includeName": "my.new.include.com",
"includeType": "COMMON_SETTINGS",
"latestVersion": 2,
"productionVersion": null,
"propertyType": "INCLUDE",
"stagingVersion": 1
}
]
}
},
"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/GetIncludesResponse.json#",
"type": "object",
"properties": {
"includes": {
"additionalProperties": false,
"description": "The set of requested includes, available within an `items` array.",
"type": "object",
"properties": {
"items": {
"description": "Configuration data to apply to edge content. Relevant response objects appear within the outer envelope's `include.items` array.",
"type": "array",
"items": {
"additionalProperties": false,
"type": "object",
"required": [
"accountId",
"assetId",
"contractId",
"groupId",
"latestVersion",
"productionVersion",
"includeName",
"includeId",
"stagingVersion",
"includeType"
],
"properties": {
"accountId": {
"description": "Identifies the account the include belongs to. 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 contract the include belongs to. 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 group to which the include is assigned. 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 descriptive name for the include.",
"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 `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": [
"COMMON_SETTINGS",
"MICROSERVICES"
]
},
"latestVersion": {
"description": "Specifies the most recent version of the include.",
"minimum": 1,
"type": "integer"
},
"note": {
"description": "Further descriptive commentary.",
"type": "string"
},
"productionVersion": {
"description": "The most recent version to be activated to the production network, otherwise `null`.",
"minimum": 1,
"type": [
"integer",
"null"
]
},
"propertyType": {
"description": "Specifies the type of the property, either `TRADITIONAL`, `INCLUDE`, or `HOSTNAME_BUCKET`.",
"type": "string",
"enum": [
"TRADITIONAL",
"HOSTNAME_BUCKET",
"INCLUDE"
]
},
"stagingVersion": {
"description": "The most recent version to be activated to the test network, otherwise `null`.",
"minimum": 1,
"type": [
"integer",
"null"
]
}
}
}
}
}
}
},
"x-akamai": {
"file-path": "schemas/includes-list-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"
}
},
"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"
}
}
},
"x-akamai": {
"status": "LA"
},
"parameters": [
{
"description": "For paginated responses, specifies the page of results you want to navigate to, starting from `0`.",
"example": "{{offset}}",
"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.",
"example": "{{limit}}",
"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.",
"example": "{{contractId}}",
"in": "query",
"name": "contractId",
"required": false,
"schema": {
"example": "ctr_1-1TJZFW",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/contractId-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.",
"example": "{{groupId}}",
"in": "query",
"name": "groupId",
"required": false,
"schema": {
"example": "grp_15166",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/groupId-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.",
"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"
}
}
]
},
"x-akamai": {
"file-path": "paths/property-version-includes.yaml",
"path-for-file": "/properties/{propertyId}/versions/{propertyVersion}/includes"
},
"x-akamai-descriptor-tools": {
"displayName": "propertyVersionIncludes",
"group": "Property versions"
},
"parameters": [
{
"description": "Property's incremental version number.",
"example": "{{propertyVersion}}",
"in": "path",
"name": "propertyVersion",
"required": true,
"schema": {
"example": 3,
"type": "integer"
},
"x-akamai": {
"file-path": "parameters/propertyVersion-path.yaml"
}
},
{
"description": "Unique identifier for the property. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting the value's `prp_` prefix.",
"example": "{{propertyId}}",
"in": "path",
"name": "propertyId",
"required": true,
"schema": {
"example": "prp_12345",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/propertyId-path.yaml"
}
}
]
},
"/properties/{propertyId}/versions/{propertyVersion}/rules": {
"get": {
"description": "Gets the entire rule tree for a property version. See the [Rule Trees](https://techdocs.akamai.com/property-mgr/reference/rule-trees) section for details on the response object's structure. Also use this operation to update from one rule format to another more recent version, incrementing the assigned set of features. See [Update rules to a newer set of features](https://techdocs.akamai.com/property-mgr/reference/rule-format-schemas#update-rules-to-a-newer-set-of-features).",
"operationId": "get-property-version-rules",
"summary": "Akamai Get a Property's Rule Tree",
"tags": [
"Property version rules"
],
"externalDocs": {
"description": "See documentation for this operation in Akamai's Property Manager API",
"url": "https://techdocs.akamai.com/property-mgr/reference/get-property-version-rules"
},
"responses": {
"200": {
"description": "The response shows the rule tree for the requested property version.",
"content": {
"*/*": {
"example": {
"accountId": "act_A-CCT5678",
"contractId": "ctr_C-0N7RAC71",
"etag": "a9dfe78cf93090516bde891d009eaf57",
"groupId": "grp_15225",
"propertyId": "prp_173136",
"propertyVersion": 3,
"ruleFormat": "v2015-08-08",
"rules": {
"name": "default",
"children": [],
"criteria": [],
"options": {
"is_secure": false
},
"behaviors": [
{
"name": "origin",
"options": {
"cacheKeyHostname": "ORIGIN_HOSTNAME",
"compress": true,
"enableTrueClientIp": false,
"forwardHostHeader": "REQUEST_HOST_HEADER",
"hostname": "origin.test.com",
"httpPort": 80,
"originType": "CUSTOMER"
}
},
{
"name": "cpCode",
"options": {
"value": {
"id": 12345,
"name": "my CP code"
}
}
}
]
}
},
"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.",
"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"
},
"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"
},
"etag": {
"description": "A digest with which to check the [data's integrity](https://techdocs.akamai.com/property-mgr/reference/concurrency-control).",
"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"
},
"propertyId": {
"description": "Identifies the property a rule tree represents. 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"
},
"propertyVersion": {
"description": "The version of the property that a rule tree represents.",
"minimum": 1,
"type": "integer"
},
"ruleFormat": {
"description": "Indicates the versioned set of features and criteria that are currently applied to a rule tree. See [API versioning](https://techdocs.akamai.com/property-mgr/reference/api-versioning) for more information.",
"type": "string"
},
"rules": {
"additionalProperties": false,
"description": "Specifies the executable logic to apply to cached edge content. The outer envelope's `rules` object specifies the relevant top-level `default` rule object. See the [Rule Trees](https://techdocs.akamai.com/property-mgr/reference/rule-trees) section for guidance on how to structure the data.",
"type": "object",
"required": [
"behaviors",
"name"
],
"properties": {
"options": {
"additionalProperties": false,
"description": "Flags that apply to the top-level rule object.",
"type": "object",
"properties": {
"is_secure": {
"description": "When enabled, serves the property's content over SSL. Doing so may enable additional rule behaviors.",
"type": "boolean"
}
}
},
"advancedOverride": {
"description": "A block of post-processing XML metadata that your Akamai representative can apply on your behalf. You need to configure this separately for each property. Use the more recent `customOverride` member to apply the same XML metadata to more than one property.",
"type": "string"
},
"behaviors": {
"description": "A series of [behavior](https://techdocs.akamai.com/property-mgr/reference/ga-behaviors) objects, which execute after the set of `criteria` evaluates. Behavior and criteria objects are structured identically. Optional on nested rules.",
"type": "array",
"items": {
"additionalProperties": false,
"type": "object",
"required": [
"name",
"options"
],
"properties": {
"options": {
"description": "A variable set of options that configure each behavior. See the [behavior](https://techdocs.akamai.com/property-mgr/reference/ga-behaviors) and [criteria](https://techdocs.akamai.com/property-mgr/reference/ga-criteria) reference for details on each.",
"type": "object"
},
"locked": {
"description": "Indicates a behavior or criteria that you arrange with your Akamai representative to lock. Typically, you prevent further modifications to protect sensitive data from erroneous changes.",
"type": "string"
},
"name": {
"description": "The name of the behavior.",
"type": "string"
},
"uuid": {
"description": "A data hash that indicates an _advanced_ behavior. When present, you may not modify the contents of the behavior, and need to provide the same `uuid` value when modifying the rule tree. See [Advanced and locked features](https://techdocs.akamai.com/property-mgr/reference/advanced-and-locked-features).",
"type": "string"
}
}
}
},
"children": {
"description": "A series of nested rules that execute after the current rule's `criteria` and `behaviors`.",
"minItems": 0,
"type": "array",
"items": {
"type": "object"
}
},
"comment": {
"description": "A descriptive comment to help you track the rule's function.",
"type": "string"
},
"criteria": {
"description": "A series of [criteria](https://techdocs.akamai.com/property-mgr/reference/ga-criteria) objects, which form a set of logical tests that may prevent the rule's `behaviors` from executing. Behavior and criteria objects are structured identically.",
"type": "array",
"items": {
"type": "object"
}
},
"criteriaLocked": {
"description": "Within child rules, this prohibits any modifications to `criteria` objects. Contact your Akamai representative to change the value.",
"type": "boolean"
},
"customOverride": {
"additionalProperties": false,
"description": "Specifies post-processing XML metadata that your Akamai representative can create on your behalf. Once available with the [List custom overrides](https://techdocs.akamai.com/property-mgr/reference/get-custom-overrides) operation, you can assign an `overrideId` to more than one property's `default` rule. See [Custom behaviors and overrides](https://techdocs.akamai.com/property-mgr/reference/custom-behaviors-and-overrides) for guidance.",
"type": "object",
"required": [
"name",
"overrideId"
],
"properties": {
"name": {
"description": "The name of the custom override. It may vary from what appears in the [List custom overrides](https://techdocs.akamai.com/property-mgr/reference/get-custom-overrides) operation's response object.",
"type": "string"
},
"overrideId": {
"description": "Identifies the predefined custom override metadata you want to append to the current rule. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on how to omit the ID's `cbo_` prefix.",
"type": "string"
}
}
},
"name": {
"description": "A description of the rule. The top-level rule needs to be named `default`.",
"type": "string"
},
"uuid": {
"description": "A data hash that indicates the rule contains at least one _advanced_ behavior or criteria, each identified with its own `uuid` member. When this member is present on the rule, you may not remove any advanced features it contains, or change their sequence. You need to provide the same `uuid` value when modifying the rule tree. See [Advanced and locked features](https://techdocs.akamai.com/property-mgr/reference/advanced-and-locked-features).",
"type": "string"
},
"variables": {
"description": "Declares a variable. See [Variables](https://techdocs.akamai.com/property-mgr/reference/variables) for guidance on how variables may appear within a rule tree.",
"minItems": 0,
"type": "array",
"items": {
"additionalProperties": false,
"type": "object",
"required": [
"hidden",
"name",
"sensitive"
],
"properties": {
"description": {
"description": "Text for you to keep track of how you use each variable.",
"type": "string"
},
"hidden": {
"description": "When enabled, the variable is suppressed from session response headers. Useful when testing content as described in the [Debug variables](https://techdocs.akamai.com/property-mgr/reference/debug-variables) section.",
"type": "boolean"
},
"name": {
"description": "The underlying root name of the variable, which needs to be unique within the set of `variables`.",
"type": "string"
},
"sensitive": {
"description": "When enabled, the variable is suppressed from session responses as `hidden` ones, but it also can't be invoked within any behaviors that assign values to cookies or response headers. You also can't assign a `sensitive` variable to another one that isn't `sensitive`, and you can't add it to custom logging fields. Use this more stringent option for any personally identifiable information, typically after initially testing on the staging network.",
"type": "boolean"
},
"value": {
"description": "Initializes a default value. Omitting this member initializes the variable with an empty string.",
"type": "string"
}
}
}
}
}
}
},
"x-akamai": {
"file-path": "schemas/property-version-rules-get-response.yaml"
}
}
}
},
"headers": {
"ETag": {
"description": "Pass the `ETag` response header back as `If-Match` in write requests to ensure you don't overwrite edits by any other API clients. See [Concurrency control](https://techdocs.akamai.com/property-mgr/reference/concurrency-control) for details.",
"example": "\"a9dfe78cf93090516bde891d009eaf57\"",
"schema": {
"type": "string"
},
"x-akamai": {
"file-path": "headers/Etag.yaml"
}
},
"X-Limit-Clientip-Per-Property-Limit": {
"description": "Maximum number of separate [Client IP](https://techdocs.akamai.com/property-mgr/reference/latest-client-ip) matches per property rule tree configuration.",
"schema": {
"type": "string"
},
"x-akamai": {
"file-path": "headers/X-Limit-Clientip-Per-Property-Limit.yaml"
}
},
"X-Limit-Clientip-Per-Property-Remaining": {
"description": "Remaining number of separate [Client IP](https://techdocs.akamai.com/property-mgr/reference/latest-client-ip) matches per property rule tree configuration. See [Rate and resource limiting](https://techdocs.akamai.com/property-mgr/reference/rate-and-resource-limiting) for details.",
"schema": {
"type": "string"
},
"x-akamai": {
"file-path": "headers/X-Limit-Clientip-Per-Property-Remaining.yaml"
}
},
"X-Limit-Elements-Per-Property-Limit": {
"description": "Maximum number of separate matches and behaviors per property rule tree configuration. See [Rate and resource limiting](https://techdocs.akamai.com/property-mgr/reference/rate-and-resource-limiting) for details.",
"schema": {
"type": "string"
},
"x-akamai": {
"file-path": "headers/X-Limit-Elements-Per-Property-Limit.yaml"
}
},
"X-Limit-Elements-Per-Property-Remaining": {
"description": "Remaining number of separate matches and behaviors per property rule tree configuration. See [Rate and resource limiting](https://techdocs.akamai.com/property-mgr/reference/rate-and-resource-limiting) for details.",
"schema": {
"type": "string"
},
"x-akamai": {
"file-path": "headers/X-Limit-Elements-Per-Property-Remaining.yaml"
}
},
"X-Limit-Max-Clientip-Per-Match-Limit": {
"description": "Maximum number of separate IP addresses allowed within each [Client IP](https://techdocs.akamai.com/property-mgr/reference/latest-client-ip) match.",
"schema": {
"type": "string"
},
"x-akamai": {
"file-path": "headers/X-Limit-Max-Clientip-Per-Match-Limit.yaml"
}
},
"X-Limit-Max-Clientip-Per-Match-Remaining": {
"description": "Remaining number of separate IP addresses allowed within each [Client IP](https://techdocs.akamai.com/property-mgr/reference/latest-client-ip) match. See [Rate and resource limiting](https://techdocs.akamai.com/property-mgr/reference/rate-and-resource-limiting) for details.",
"schema": {
"type": "string"
},
"x-akamai": {
"file-path": "headers/X-Limit-Max-Clientip-Per-Match-Remaining.yaml"
}
},
"X-Limit-Max-Nested-Rules-Limit": {
"description": "Maximum number of nested child rules in a property to apply conditional logic.",
"schema": {
"type": "string"
},
"x-akamai": {
"file-path": "headers/X-Limit-Max-Nested-Rules-Limit.yaml"
}
},
"X-Limit-Max-Nested-Rules-Remaining": {
"description": "Remaining number of nested child rules in a property to apply conditional logic. See [Rate and resource limiting](https://techdocs.akamai.com/property-mgr/reference/rate-and-resource-limiting) for details.",
"schema": {
"type": "string"
},
"x-akamai": {
"file-path": "headers/X-Limit-Max-Nested-Rules-Remaining.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"
}
},
"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": "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.",
"example": "{{contractId}}",
"in": "query",
"name": "contractId",
"required": false,
"schema": {
"example": "ctr_1-1TJZFW",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/contractId-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.",
"example": "{{groupId}}",
"in": "query",
"name": "groupId",
"required": false,
"schema": {
"example": "grp_15166",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/groupId-optional.yaml"
}
},
{
"description": "Set to `true` by default. When `false`, skips validation tests that would identify potential problems within the response object's `errors` and `warnings` arrays. See [Rule tree errors and warnings](https://techdocs.akamai.com/property-mgr/reference/rule-tree-errors-and-warnings) and [Validation errors](https://techdocs.akamai.com/property-mgr/reference/validation-errors) for information on how validation data appears in the response object. See [Validation best practices](https://techdocs.akamai.com/property-mgr/reference/validation-best-practices) for guidance on when to defer validation.",
"example": "{{validateRules}}",
"in": "query",
"name": "validateRules",
"required": false,
"schema": {
"default": true,
"example": true,
"type": "boolean"
},
"x-akamai": {
"file-path": "parameters/validateRules-query.yaml"
}
},
{
"description": "__Enum__ With `validateRules` enabled, setting this to `fast` performs a quick validation check based on the provided JSON. This is faster than the default `full` validation, which performs more extensive checks on the converted XML metadata configuration. See [Validation best practices](https://techdocs.akamai.com/property-mgr/reference/validation-best-practices) for more guidance.",
"example": "{{validateMode}}",
"in": "query",
"name": "validateMode",
"required": false,
"schema": {
"default": "full",
"example": "fast",
"type": "string",
"enum": [
"full",
"fast"
]
},
"x-akamai": {
"file-path": "parameters/validateMode-query.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"
}
}
]
},
"put": {
"description": "To write a rule tree to a property version, make a PUT request to the same resource as the GET request that reads it. Pass in the rule object in the body of the request. See the [Rule Trees](https://techdocs.akamai.com/property-mgr/reference/rule-trees) section for details on the rule tree's structure. Use this operation also to [freeze a set of rules](https://techdocs.akamai.com/property-mgr/reference/rule-format-schemas#freeze-a-feature-set-for-a-rule-tree) to a rule format version to ensure no change in a deployed activation's behavior. Set the `validateRules` query parameter to `false` to bypass a set of validation tests that may significantly slow this operation's execution time. See [Validation best practices](https://techdocs.akamai.com/property-mgr/reference/validation-best-practices) for guidance on when to defer validation. See [Rule tree errors and warnings](https://techdocs.akamai.com/property-mgr/reference/rule-tree-errors-and-warnings) and [Validation errors](https://techdocs.akamai.com/property-mgr/reference/validation-errors) for information on how validation data is embedded within the response object.",
"operationId": "put-property-version-rules",
"summary": "Akamai Update a Property's Rule Tree",
"tags": [
"Property version rules"
],
"externalDocs": {
"description": "See documentation for this operation in Akamai's Property Manager API",
"url": "https://techdocs.akamai.com/property-mgr/reference/put-property-version-rules"
},
"requestBody": {
"required": true,
"content": {
"*/*": {
"example": {
"rules": {
"name": "default",
"children": [],
"criteria": [],
"options": {
"is_secure": false
},
"behaviors": [
{
"name": "origin",
"options": {
"cacheKeyHostname": "ORIGIN_HOSTNAME",
"compress": true,
"enableTrueClientIp": false,
"forwardHostHeader": "REQUEST_HOST_HEADER",
"hostname": "origin.test.com",
"httpPort": 80,
"originType": "CUSTOMER"
}
},
{
"name": "cpCode",
"options": {
"value": {
"id": 12345,
"name": "my CP code"
}
}
}
]
}
},
"schema": {
"$schema": "http://json-schema.org/draft-04-schema#",
"description": "Specifies the executable logic to apply to cached edge content.",
"id": "resource:/descriptors/papi/v1/schemas/property-version-rules-set-request.json#",
"javaType": "com.fasterxml.jackson.databind.JsonNode",
"type": "object",
"properties": {
"rules": {
"description": "Specifies the executable logic to apply to cached edge content. A common outer wrapping `rules` object specifies the relevant top-level `default` rule object. See the [Rule Trees](https://techdocs.akamai.com/property-mgr/reference/rule-trees) section for guidance on how to structure the data.",
"type": "object",
"required": [
"name",
"behaviors"
],
"properties": {
"options": {
"description": "Flags that apply to the top-level rule object.",
"type": "object",
"properties": {
"is_secure": {
"description": "When enabled, serves the property's content over SSL. Doing so may enable additional rule behaviors.",
"type": "boolean"
}
}
},
"advancedOverride": {
"description": "A block of post-processing XML metadata that your Akamai representative can apply on your behalf. You need to configure this separately for each property. Use the more recent `customOverride` member to apply the same XML metadata to more than one property.",
"type": "string"
},
"behaviors": {
"description": "A series of [behavior](https://techdocs.akamai.com/property-mgr/reference/ga-behaviors) objects, which execute after the set of `criteria` evaluates. Behavior and criteria objects are structured identically. Optional on nested rules.",
"type": "array",
"items": {
"type": "object",
"required": [
"name",
"options"
],
"properties": {
"options": {
"description": "A variable set of options that configure each behavior. See the [PAPI Feature Catalog Reference](https://techdocs.akamai.com/property-mgr/reference/ga-behaviors) for details on each.",
"type": "object"
},
"locked": {
"description": "Indicates a behavior or criteria that you arrange with your Akamai representative to lock. Typically, you prevent further modifications to protect sensitive data from erroneous changes.",
"type": "string"
},
"name": {
"description": "The name of the behavior.",
"type": "string"
},
"uuid": {
"description": "A data hash that indicates an _advanced_ behavior. When present, you may not modify the contents of the behavior, and need to provide the same `uuid` value when modifying the rule tree. See [Advanced and locked features](https://techdocs.akamai.com/property-mgr/reference/advanced-and-locked-features).",
"readOnly": true,
"type": "string"
}
}
}
},
"children": {
"description": "A series of nested rules that execute after the current rule's `criteria` and `behaviors`.",
"type": "array",
"items": {
"description": "A series of nested rules that execute after the current rule's `criteria` and `behaviors`.",
"type": "object"
}
},
"comment": {
"description": "A descriptive comment to help you track the rule's function.",
"type": "string"
},
"criteria": {
"description": "A series of [criteria](https://techdocs.akamai.com/property-mgr/reference/ga-criteria) objects, which form a set of logical tests that may prevent the rule's `behaviors` from executing. Behavior and criteria objects are structured identically.",
"type": "array",
"items": {
"description": "A series of [criteria](https://techdocs.akamai.com/property-mgr/reference/ga-criteria) objects, which form a set of logical tests that may prevent the rule's `behaviors` from executing. Behavior and criteria objects are structured identically.",
"type": "object"
}
},
"criteriaLocked": {
"description": "Within child rules, this prohibits any modifications to `criteria` objects. Contact your Akamai representative to change the value.",
"readOnly": true,
"type": "boolean"
},
"customOverride": {
"description": "Specifies post-processing XML metadata that your Akamai representative can create on your behalf. Once available with the [List custom overrides](https://techdocs.akamai.com/property-mgr/reference/get-custom-overrides) operation, you can assign an `overrideId` to more than one property's `default` rule. See [Custom behaviors and overrides](https://techdocs.akamai.com/property-mgr/reference/custom-behaviors-and-overrides) for guidance.",
"type": "object",
"required": [
"overrideId",
"name"
],
"properties": {
"name": {
"description": "The name of the custom override. It may vary from what appears in the [List custom overrides](https://techdocs.akamai.com/property-mgr/reference/get-custom-overrides) operation's response object.",
"type": "string"
},
"overrideId": {
"description": "Identifies the predefined custom override metadata you want to append to the current rule. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on how to omit the ID's `cbo_` prefix.",
"type": "string"
}
}
},
"name": {
"description": "A description of the rule. The top-level rule needs to be named `default`.",
"type": "string"
},
"uuid": {
"description": "A data hash that indicates the rule contains at least one _advanced_ behavior or criteria, each identified with its own `uuid` member. When this member is present on the rule, you may not remove any advanced features it contains, or change their sequence. You need to provide the same `uuid` value when modifying the rule tree. See [Advanced and locked features](https://techdocs.akamai.com/property-mgr/reference/advanced-and-locked-features).",
"type": "string"
},
"variables": {
"description": "Declares a variable. See [Variables](https://techdocs.akamai.com/property-mgr/reference/variables) for guidance on how variables may appear within a rule tree.",
"type": "array",
"items": {
"type": "object",
"required": [
"name",
"hidden",
"sensitive"
],
"properties": {
"description": {
"description": "Text for you to keep track of how you use each variable.",
"type": "string"
},
"hidden": {
"description": "When enabled, the variable is suppressed from session response headers. Useful when testing content as described in the [Debug variables](https://techdocs.akamai.com/property-mgr/reference/debug-variables) section.",
"type": "boolean"
},
"name": {
"description": "The underlying root name of the variable, which needs to be unique within the set of `variables`.",
"type": "string"
},
"sensitive": {
"description": "When enabled, the variable is suppressed from session responses as `hidden` ones, but it also can't be invoked within any behaviors that assign values to cookies or response headers. You also can't assign a `sensitive` variable to another one that isn't `sensitive`, and you can't add it to custom logging fields. Use this more stringent option for any personally identifiable information, typically after initially testing on the staging network.",
"type": "boolean"
},
"value": {
"description": "Initializes a default value. Omitting this member initializes the variable with an empty string.",
"type": "string"
}
}
}
}
}
}
},
"x-akamai": {
"file-path": "schemas/property-version-rules-set-request.yaml"
}
}
},
"application/json": {
"example": {
"rules": {
"name": "default",
"children": [],
"criteria": [],
"options": {
"is_secure": false
},
"behaviors": [
{
"name": "origin",
"options": {
"cacheKeyHostname": "ORIGIN_HOSTNAME",
"compress": true,
"enableTrueClientIp": false,
"forwardHostHeader": "REQUEST_HOST_HEADER",
"hostname": "origin.test.com",
"httpPort": 80,
"originType": "CUSTOMER"
}
},
{
"name": "cpCode",
"options": {
"value": {
"id": 12345,
"name": "my CP code"
}
}
}
]
}
},
"schema": {
"$schema": "http://json-schema.org/draft-04-schema#",
"description": "Specifies the executable logic to apply to cached edge content.",
"id": "resource:/descriptors/papi/v1/schemas/property-version-rules-set-request.json#",
"javaType": "com.fasterxml.jackson.databind.JsonNode",
"type": "object",
"properties": {
"rules": {
"description": "Specifies the executable logic to apply to cached edge content. A common outer wrapping `rules` object specifies the relevant top-level `default` rule object. See the [Rule Trees](https://techdocs.akamai.com/property-mgr/reference/rule-trees) section for guidance on how to structure the data.",
"type": "object",
"required": [
"name",
"behaviors"
],
"properties": {
"options": {
"description": "Flags that apply to the top-level rule object.",
"type": "object",
"properties": {
"is_secure": {
"description": "When enabled, serves the property's content over SSL. Doing so may enable additional rule behaviors.",
"type": "boolean"
}
}
},
"advancedOverride": {
"description": "A block of post-processing XML metadata that your Akamai representative can apply on your behalf. You need to configure this separately for each property. Use the more recent `customOverride` member to apply the same XML metadata to more than one property.",
"type": "string"
},
"behaviors": {
"description": "A series of [behavior](https://techdocs.akamai.com/property-mgr/reference/ga-behaviors) objects, which execute after the set of `criteria` evaluates. Behavior and criteria objects are structured identically. Optional on nested rules.",
"type": "array",
"items": {
"type": "object",
"required": [
"name",
"options"
],
"properties": {
"options": {
"description": "A variable set of options that configure each behavior. See the [PAPI Feature Catalog Reference](https://techdocs.akamai.com/property-mgr/reference/ga-behaviors) for details on each.",
"type": "object"
},
"locked": {
"description": "Indicates a behavior or criteria that you arrange with your Akamai representative to lock. Typically, you prevent further modifications to protect sensitive data from erroneous changes.",
"type": "string"
},
"name": {
"description": "The name of the behavior.",
"type": "string"
},
"uuid": {
"description": "A data hash that indicates an _advanced_ behavior. When present, you may not modify the contents of the behavior, and need to provide the same `uuid` value when modifying the rule tree. See [Advanced and locked features](https://techdocs.akamai.com/property-mgr/reference/advanced-and-locked-features).",
"readOnly": true,
"type": "string"
}
}
}
},
"children": {
"description": "A series of nested rules that execute after the current rule's `criteria` and `behaviors`.",
"type": "array",
"items": {
"description": "A series of nested rules that execute after the current rule's `criteria` and `behaviors`.",
"type": "object"
}
},
"comment": {
"description": "A descriptive comment to help you track the rule's function.",
"type": "string"
},
"criteria": {
"description": "A series of [criteria](https://techdocs.akamai.com/property-mgr/reference/ga-criteria) objects, which form a set of logical tests that may prevent the rule's `behaviors` from executing. Behavior and criteria objects are structured identically.",
"type": "array",
"items": {
"description": "A series of [criteria](https://techdocs.akamai.com/property-mgr/reference/ga-criteria) objects, which form a set of logical tests that may prevent the rule's `behaviors` from executing. Behavior and criteria objects are structured identically.",
"type": "object"
}
},
"criteriaLocked": {
"description": "Within child rules, this prohibits any modifications to `criteria` objects. Contact your Akamai representative to change the value.",
"readOnly": true,
"type": "boolean"
},
"customOverride": {
"description": "Specifies post-processing XML metadata that your Akamai representative can create on your behalf. Once available with the [List custom overrides](https://techdocs.akamai.com/property-mgr/reference/get-custom-overrides) operation, you can assign an `overrideId` to more than one property's `default` rule. See [Custom behaviors and overrides](https://techdocs.akamai.com/property-mgr/reference/custom-behaviors-and-overrides) for guidance.",
"type": "object",
"required": [
"overrideId",
"name"
],
"properties": {
"name": {
"description": "The name of the custom override. It may vary from what appears in the [List custom overrides](https://techdocs.akamai.com/property-mgr/reference/get-custom-overrides) operation's response object.",
"type": "string"
},
"overrideId": {
"description": "Identifies the predefined custom override metadata you want to append to the current rule. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on how to omit the ID's `cbo_` prefix.",
"type": "string"
}
}
},
"name": {
"description": "A description of the rule. The top-level rule needs to be named `default`.",
"type": "string"
},
"uuid": {
"description": "A data hash that indicates the rule contains at least one _advanced_ behavior or criteria, each identified with its own `uuid` member. When this member is present on the rule, you may not remove any advanced features it contains, or change their sequence. You need to provide the same `uuid` value when modifying the rule tree. See [Advanced and locked features](https://techdocs.akamai.com/property-mgr/reference/advanced-and-locked-features).",
"type": "string"
},
"variables": {
"description": "Declares a variable. See [Variables](https://techdocs.akamai.com/property-mgr/reference/variables) for guidance on how variables may appear within a rule tree.",
"type": "array",
"items": {
"type": "object",
"required": [
"name",
"hidden",
"sensitive"
],
"properties": {
"description": {
"description": "Text for you to keep track of how you use each variable.",
"type": "string"
},
"hidden": {
"description": "When enabled, the variable is suppressed from session response headers. Useful when testing content as described in the [Debug variables](https://techdocs.akamai.com/property-mgr/reference/debug-variables) section.",
"type": "boolean"
},
"name": {
"description": "The underlying root name of the variable, which needs to be unique within the set of `variables`.",
"type": "string"
},
"sensitive": {
"description": "When enabled, the variable is suppressed from session responses as `hidden` ones, but it also can't be invoked within any behaviors that assign values to cookies or response headers. You also can't assign a `sensitive` variable to another one that isn't `sensitive`, and you can't add it to custom logging fields. Use this more stringent option for any personally identifiable information, typically after initially testing on the staging network.",
"type": "boolean"
},
"value": {
"description": "Initializes a default value. Omitting this member initializes the variable with an empty string.",
"type": "string"
}
}
}
}
}
}
},
"x-akamai": {
"file-path": "schemas/property-version-rules-set-request.yaml"
}
}
}
}
},
"responses": {
"200": {
"description": "The response shows updated rule tree for the specified property version.",
"content": {
"*/*": {
"example": {
"accountId": "act_A-CCT9012",
"contractId": "ctr_K-0N7RAK71",
"etag": "a9dfe78cf93090516bde891d009eaf57",
"groupId": "grp_15225",
"propertyId": "prp_173136",
"propertyVersion": 3,
"ruleFormat": "v2015-08-08",
"rules": {
"name": "default",
"children": [],
"criteria": [],
"options": {
"is_secure": false
},
"behaviors": [
{
"name": "origin",
"options": {
"cacheKeyHostname": "ORIGIN_HOSTNAME",
"compress": true,
"enableTrueClientIp": false,
"forwardHostHeader": "REQUEST_HOST_HEADER",
"hostname": "origin.test.com",
"httpPort": 80,
"originType": "CUSTOMER"
}
},
{
"name": "cpCode",
"options": {
"value": {
"id": 12345,
"name": "my CP code"
}
}
}
]
}
},
"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.",
"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"
},
"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"
},
"etag": {
"description": "A digest with which to check the [data's integrity](https://techdocs.akamai.com/property-mgr/reference/concurrency-control).",
"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"
},
"propertyId": {
"description": "Identifies the property a rule tree represents. 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"
},
"propertyVersion": {
"description": "The version of the property that a rule tree represents.",
"minimum": 1,
"type": "integer"
},
"ruleFormat": {
"description": "Indicates the versioned set of features and criteria that are currently applied to a rule tree. See [API versioning](https://techdocs.akamai.com/property-mgr/reference/api-versioning) for more information.",
"type": "string"
},
"rules": {
"additionalProperties": false,
"description": "Specifies the executable logic to apply to cached edge content. The outer envelope's `rules` object specifies the relevant top-level `default` rule object. See the [Rule Trees](https://techdocs.akamai.com/property-mgr/reference/rule-trees) section for guidance on how to structure the data.",
"type": "object",
"required": [
"behaviors",
"name"
],
"properties": {
"options": {
"additionalProperties": false,
"description": "Flags that apply to the top-level rule object.",
"type": "object",
"properties": {
"is_secure": {
"description": "When enabled, serves the property's content over SSL. Doing so may enable additional rule behaviors.",
"type": "boolean"
}
}
},
"advancedOverride": {
"description": "A block of post-processing XML metadata that your Akamai representative can apply on your behalf. You need to configure this separately for each property. Use the more recent `customOverride` member to apply the same XML metadata to more than one property.",
"type": "string"
},
"behaviors": {
"description": "A series of [behavior](https://techdocs.akamai.com/property-mgr/reference/ga-behaviors) objects, which execute after the set of `criteria` evaluates. Behavior and criteria objects are structured identically. Optional on nested rules.",
"type": "array",
"items": {
"additionalProperties": false,
"type": "object",
"required": [
"name",
"options"
],
"properties": {
"options": {
"description": "A variable set of options that configure each behavior. See the [behavior](https://techdocs.akamai.com/property-mgr/reference/ga-behaviors) and [criteria](https://techdocs.akamai.com/property-mgr/reference/ga-criteria) reference for details on each.",
"type": "object"
},
"locked": {
"description": "Indicates a behavior or criteria that you arrange with your Akamai representative to lock. Typically, you prevent further modifications to protect sensitive data from erroneous changes.",
"type": "string"
},
"name": {
"description": "The name of the behavior.",
"type": "string"
},
"uuid": {
"description": "A data hash that indicates an _advanced_ behavior. When present, you may not modify the contents of the behavior, and need to provide the same `uuid` value when modifying the rule tree. See [Advanced and locked features](https://techdocs.akamai.com/property-mgr/reference/advanced-and-locked-features).",
"type": "string"
}
}
}
},
"children": {
"description": "A series of nested rules that execute after the current rule's `criteria` and `behaviors`.",
"minItems": 0,
"type": "array",
"items": {
"type": "object"
}
},
"comment": {
"description": "A descriptive comment to help you track the rule's function.",
"type": "string"
},
"criteria": {
"description": "A series of [criteria](https://techdocs.akamai.com/property-mgr/reference/ga-criteria) objects, which form a set of logical tests that may prevent the rule's `behaviors` from executing. Behavior and criteria objects are structured identically.",
"type": "array",
"items": {
"type": "object"
}
},
"criteriaLocked": {
"description": "Within child rules, this prohibits any modifications to `criteria` objects. Contact your Akamai representative to change the value.",
"type": "boolean"
},
"customOverride": {
"additionalProperties": false,
"description": "Specifies post-processing XML metadata that your Akamai representative can create on your behalf. Once available with the [List custom overrides](https://techdocs.akamai.com/property-mgr/reference/get-custom-overrides) operation, you can assign an `overrideId` to more than one property's `default` rule. See [Custom behaviors and overrides](https://techdocs.akamai.com/property-mgr/reference/custom-behaviors-and-overrides) for guidance.",
"type": "object",
"required": [
"name",
"overrideId"
],
"properties": {
"name": {
"description": "The name of the custom override. It may vary from what appears in the [List custom overrides](https://techdocs.akamai.com/property-mgr/reference/get-custom-overrides) operation's response object.",
"type": "string"
},
"overrideId": {
"description": "Identifies the predefined custom override metadata you want to append to the current rule. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on how to omit the ID's `cbo_` prefix.",
"type": "string"
}
}
},
"name": {
"description": "A description of the rule. The top-level rule needs to be named `default`.",
"type": "string"
},
"uuid": {
"description": "A data hash that indicates the rule contains at least one _advanced_ behavior or criteria, each identified with its own `uuid` member. When this member is present on the rule, you may not remove any advanced features it contains, or change their sequence. You need to provide the same `uuid` value when modifying the rule tree. See [Advanced and locked features](https://techdocs.akamai.com/property-mgr/reference/advanced-and-locked-features).",
"type": "string"
},
"variables": {
"description": "Declares a variable. See [Variables](https://techdocs.akamai.com/property-mgr/reference/variables) for guidance on how variables may appear within a rule tree.",
"minItems": 0,
"type": "array",
"items": {
"additionalProperties": false,
"type": "object",
"required": [
"hidden",
"name",
"sensitive"
],
"properties": {
"description": {
"description": "Text for you to keep track of how you use each variable.",
"type": "string"
},
"hidden": {
"description": "When enabled, the variable is suppressed from session response headers. Useful when testing content as described in the [Debug variables](https://techdocs.akamai.com/property-mgr/reference/debug-variables) section.",
"type": "boolean"
},
"name": {
"description": "The underlying root name of the variable, which needs to be unique within the set of `variables`.",
"type": "string"
},
"sensitive": {
"description": "When enabled, the variable is suppressed from session responses as `hidden` ones, but it also can't be invoked within any behaviors that assign values to cookies or response headers. You also can't assign a `sensitive` variable to another one that isn't `sensitive`, and you can't add it to custom logging fields. Use this more stringent option for any personally identifiable information, typically after initially testing on the staging network.",
"type": "boolean"
},
"value": {
"description": "Initializes a default value. Omitting this member initializes the variable with an empty string.",
"type": "string"
}
}
}
}
}
}
},
"x-akamai": {
"file-path": "schemas/property-version-rules-get-response.yaml"
}
}
}
},
"headers": {
"ETag": {
"description": "Pass the `ETag` response header back as `If-Match` in write requests to ensure you don't overwrite edits by any other API clients. See [Concurrency control](https://techdocs.akamai.com/property-mgr/reference/concurrency-control) for details.",
"example": "\"a9dfe78cf93090516bde891d009eaf57\"",
"schema": {
"type": "string"
},
"x-akamai": {
"file-path": "headers/Etag.yaml"
}
},
"X-Limit-Clientip-Per-Property-Limit": {
"description": "Maximum number of separate [Client IP](https://techdocs.akamai.com/property-mgr/reference/latest-client-ip) matches per property rule tree configuration.",
"schema": {
"type": "string"
},
"x-akamai": {
"file-path": "headers/X-Limit-Clientip-Per-Property-Limit.yaml"
}
},
"X-Limit-Clientip-Per-Property-Remaining": {
"description": "Remaining number of separate [Client IP](https://techdocs.akamai.com/property-mgr/reference/latest-client-ip) matches per property rule tree configuration. See [Rate and resource limiting](https://techdocs.akamai.com/property-mgr/reference/rate-and-resource-limiting) for details.",
"schema": {
"type": "string"
},
"x-akamai": {
"file-path": "headers/X-Limit-Clientip-Per-Property-Remaining.yaml"
}
},
"X-Limit-Elements-Per-Property-Limit": {
"description": "Maximum number of separate matches and behaviors per property rule tree configuration. See [Rate and resource limiting](https://techdocs.akamai.com/property-mgr/reference/rate-and-resource-limiting) for details.",
"schema": {
"type": "string"
},
"x-akamai": {
"file-path": "headers/X-Limit-Elements-Per-Property-Limit.yaml"
}
},
"X-Limit-Elements-Per-Property-Remaining": {
"description": "Remaining number of separate matches and behaviors per property rule tree configuration. See [Rate and resource limiting](https://techdocs.akamai.com/property-mgr/reference/rate-and-resource-limiting) for details.",
"schema": {
"type": "string"
},
"x-akamai": {
"file-path": "headers/X-Limit-Elements-Per-Property-Remaining.yaml"
}
},
"X-Limit-Max-Clientip-Per-Match-Limit": {
"description": "Maximum number of separate IP addresses allowed within each [Client IP](https://techdocs.akamai.com/property-mgr/reference/latest-client-ip) match.",
"schema": {
"type": "string"
},
"x-akamai": {
"file-path": "headers/X-Limit-Max-Clientip-Per-Match-Limit.yaml"
}
},
"X-Limit-Max-Clientip-Per-Match-Remaining": {
"description": "Remaining number of separate IP addresses allowed within each [Client IP](https://techdocs.akamai.com/property-mgr/reference/latest-client-ip) match. See [Rate and resource limiting](https://techdocs.akamai.com/property-mgr/reference/rate-and-resource-limiting) for details.",
"schema": {
"type": "string"
},
"x-akamai": {
"file-path": "headers/X-Limit-Max-Clientip-Per-Match-Remaining.yaml"
}
},
"X-Limit-Max-Nested-Rules-Limit": {
"description": "Maximum number of nested child rules in a property to apply conditional logic.",
"schema": {
"type": "string"
},
"x-akamai": {
"file-path": "headers/X-Limit-Max-Nested-Rules-Limit.yaml"
}
},
"X-Limit-Max-Nested-Rules-Remaining": {
"description": "Remaining number of nested child rules in a property to apply conditional logic. See [Rate and resource limiting](https://techdocs.akamai.com/property-mgr/reference/rate-and-resource-limiting) for details.",
"schema": {
"type": "string"
},
"x-akamai": {
"file-path": "headers/X-Limit-Max-Nested-Rules-Remaining.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"
}
},
"412": {
"description": "[Precondition failed](https://techdocs.akamai.com/property-mgr/reference/412).",
"content": {
"application/problem+json": {
"example": {
"detail": "Cannot activate the property at this time, please try again.",
"instance": "papi/v1/properties/prp_123456/activations?contractId=ctr_C-0N7RAC7&groupId=grp_12345#abc12345abcc02a7",
"status": 412,
"title": "Precondition Failed",
"type": "https://problems.luna.akamaiapis.net/papi/v0/toolkit/validation_failed.error.activation.tower_precondition.failed"
},
"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/412.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": "This corresponds to the `ETag` response header. Passing this value back as `If-Match` in write requests ensures you don't overwrite edits by any other API clients. See [Concurrency control](https://techdocs.akamai.com/property-mgr/reference/concurrency-control) for details.",
"example": "{{If-Match}}",
"in": "header",
"name": "If-Match",
"required": true,
"schema": {
"example": "\"a9dfe78cf93090516bde891d009eaf57\"",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/If-Match-header.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.",
"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": "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.",
"example": "{{contractId}}",
"in": "query",
"name": "contractId",
"required": false,
"schema": {
"example": "ctr_1-1TJZFW",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/contractId-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.",
"example": "{{groupId}}",
"in": "query",
"name": "groupId",
"required": false,
"schema": {
"example": "grp_15166",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/groupId-optional.yaml"
}
},
{
"description": "Set to `true` by default. When `false`, skips validation tests that would identify potential problems within the response object's `errors` and `warnings` arrays. See [Rule tree errors and warnings](https://techdocs.akamai.com/property-mgr/reference/rule-tree-errors-and-warnings) and [Validation errors](https://techdocs.akamai.com/property-mgr/reference/validation-errors) for information on how validation data appears in the response object. See [Validation best practices](https://techdocs.akamai.com/property-mgr/reference/validation-best-practices) for guidance on when to defer validation.",
"example": "{{validateRules}}",
"in": "query",
"name": "validateRules",
"required": false,
"schema": {
"default": true,
"example": true,
"type": "boolean"
},
"x-akamai": {
"file-path": "parameters/validateRules-query.yaml"
}
},
{
"description": "__Enum__ With `validateRules` enabled, setting this to `fast` performs a quick validation check based on the provided JSON. This is faster than the default `full` validation, which performs more extensive checks on the converted XML metadata configuration. See [Validation best practices](https://techdocs.akamai.com/property-mgr/reference/validation-best-practices) for more guidance.",
"example": "{{validateMode}}",
"in": "query",
"name": "validateMode",
"required": false,
"schema": {
"default": "full",
"example": "fast",
"type": "string",
"enum": [
"full",
"fast"
]
},
"x-akamai": {
"file-path": "parameters/validateMode-query.yaml"
}
},
{
"description": "With the `validateRules` query parameter also enabled, allows for a _dry run_ in order to gather any possible errors without saving the rule tree. See [Validation best practices](https://techdocs.akamai.com/property-mgr/reference/validation-best-practices) for more guidance.",
"example": "{{dryRun}}",
"in": "query",
"name": "dryRun",
"required": false,
"schema": {
"default": false,
"example": true,
"type": "boolean"
},
"x-akamai": {
"file-path": "parameters/dryRun-query.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"
}
}
]
},
"patch": {
"description": "Selectively modify a rule tree using [JSON patch](http://jsonpatch.com) syntax. As a component of the larger [Bulk patch a set of properties](https://techdocs.akamai.com/property-mgr/reference/post-bulk-patch), this operation patches an individual rule tree. See [Bulk Search and Update](https://techdocs.akamai.com/property-mgr/reference/bulk-search-and-update) for more information. To bypass a set of validation tests that may significantly slow this operation's execution time, set the `validateRules` query parameter to `false` or `validateMode` to `fast`. See [Validation best practices](https://techdocs.akamai.com/property-mgr/reference/validation-best-practices) for guidance on when to defer validation. See [Rule tree errors and warnings](https://techdocs.akamai.com/property-mgr/reference/rule-tree-errors-and-warnings) and [Validation errors](https://techdocs.akamai.com/property-mgr/reference/validation-errors) for information on how validation data is embedded within the response object.",
"operationId": "patch-property-version-rules",
"summary": "Akamai Patch a Property's Rule Tree",
"tags": [
"Property version rules"
],
"externalDocs": {
"description": "See documentation for this operation in Akamai's Property Manager API",
"url": "https://techdocs.akamai.com/property-mgr/reference/patch-property-version-rules"
},
"requestBody": {
"required": true,
"content": {
"application/json-patch+json": {
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "The series of JSON Patch operations.",
"id": "resource:/descriptors/papi/v1/schemas/property-version-rules-patch-request.json#",
"javaType": "com.fasterxml.jackson.databind.JsonNode",
"type": "array",
"items": {
"type": "object",
"required": [
"op",
"path"
],
"x-akamai": {
"file-path": "schemas/operation.yaml"
},
"allOf": [
{
"type": "object",
"properties": {
"path": {
"description": "A JSON Pointer path.",
"type": "string"
}
},
"x-akamai": {
"file-path": "schemas/path.yaml"
}
}
],
"oneOf": [
{
"title": "Replace, add, test",
"required": [
"value"
],
"properties": {
"op": {
"description": "The operation to perform: `replace`, `add`, or `test` in this case.",
"type": "string",
"enum": [
"replace",
"test",
"add"
]
},
"value": {
"description": "The value to replace, test, or add. Specify any data type.",
"oneOf": [
{
"title": "String",
"type": "string"
},
{
"title": "Numeric",
"type": "number"
},
{
"title": "Boolean",
"type": "boolean"
},
{
"title": "Object",
"type": "object"
},
{
"title": "Array",
"type": "array",
"items": {
"anyOf": [
{
"title": "String",
"type": "string"
},
{
"title": "Numeric",
"type": "number"
},
{
"title": "Boolean",
"type": "boolean"
},
{
"title": "Object",
"type": "object"
}
]
}
}
]
}
}
},
{
"title": "Remove",
"properties": {
"op": {
"description": "The operation to perform: `remove` in this case.",
"type": "string",
"enum": [
"remove"
]
}
}
},
{
"title": "Move, copy",
"required": [
"from"
],
"properties": {
"from": {
"description": "A JSON Pointer path pointing to the location to move or copy from.",
"type": "string"
},
"op": {
"description": "The operation to perform: `move` or `copy` in this case.",
"type": "string",
"enum": [
"move",
"copy"
]
}
}
}
]
},
"x-akamai": {
"file-path": "schemas/property-version-rules-patch-request.yaml"
}
},
"example": [
{
"op": "replace",
"path": "/rules/options/is_secure",
"value": true
},
{
"op": "replace",
"path": "/rules/children/0/name",
"value": "Handle /my-path"
}
]
}
}
},
"responses": {
"200": {
"description": "The response shows modified rule tree for the specified property version.",
"content": {
"*/*": {
"example": {
"accountId": "act_A-CCT5678",
"contractId": "ctr_K-0N7RAK7",
"etag": "a9dfe78cf93090516bde891d009eaf57",
"groupId": "grp_15225",
"propertyId": "prp_173136",
"propertyVersion": 3,
"ruleFormat": "v2015-08-08",
"rules": {
"name": "default",
"children": [],
"criteria": [],
"options": {
"is_secure": false
},
"behaviors": [
{
"name": "origin",
"options": {
"cacheKeyHostname": "ORIGIN_HOSTNAME",
"compress": true,
"enableTrueClientIp": false,
"forwardHostHeader": "REQUEST_HOST_HEADER",
"hostname": "origin.test.com",
"httpPort": 80,
"originType": "CUSTOMER"
}
},
{
"name": "cpCode",
"options": {
"value": {
"id": 12345,
"name": "my CP code"
}
}
}
]
}
},
"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.",
"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"
},
"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"
},
"etag": {
"description": "A digest with which to check the [data's integrity](https://techdocs.akamai.com/property-mgr/reference/concurrency-control).",
"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"
},
"propertyId": {
"description": "Identifies the property a rule tree represents. 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"
},
"propertyVersion": {
"description": "The version of the property that a rule tree represents.",
"minimum": 1,
"type": "integer"
},
"ruleFormat": {
"description": "Indicates the versioned set of features and criteria that are currently applied to a rule tree. See [API versioning](https://techdocs.akamai.com/property-mgr/reference/api-versioning) for more information.",
"type": "string"
},
"rules": {
"additionalProperties": false,
"description": "Specifies the executable logic to apply to cached edge content. The outer envelope's `rules` object specifies the relevant top-level `default` rule object. See the [Rule Trees](https://techdocs.akamai.com/property-mgr/reference/rule-trees) section for guidance on how to structure the data.",
"type": "object",
"required": [
"behaviors",
"name"
],
"properties": {
"options": {
"additionalProperties": false,
"description": "Flags that apply to the top-level rule object.",
"type": "object",
"properties": {
"is_secure": {
"description": "When enabled, serves the property's content over SSL. Doing so may enable additional rule behaviors.",
"type": "boolean"
}
}
},
"advancedOverride": {
"description": "A block of post-processing XML metadata that your Akamai representative can apply on your behalf. You need to configure this separately for each property. Use the more recent `customOverride` member to apply the same XML metadata to more than one property.",
"type": "string"
},
"behaviors": {
"description": "A series of [behavior](https://techdocs.akamai.com/property-mgr/reference/ga-behaviors) objects, which execute after the set of `criteria` evaluates. Behavior and criteria objects are structured identically. Optional on nested rules.",
"type": "array",
"items": {
"additionalProperties": false,
"type": "object",
"required": [
"name",
"options"
],
"properties": {
"options": {
"description": "A variable set of options that configure each behavior. See the [behavior](https://techdocs.akamai.com/property-mgr/reference/ga-behaviors) and [criteria](https://techdocs.akamai.com/property-mgr/reference/ga-criteria) reference for details on each.",
"type": "object"
},
"locked": {
"description": "Indicates a behavior or criteria that you arrange with your Akamai representative to lock. Typically, you prevent further modifications to protect sensitive data from erroneous changes.",
"type": "string"
},
"name": {
"description": "The name of the behavior.",
"type": "string"
},
"uuid": {
"description": "A data hash that indicates an _advanced_ behavior. When present, you may not modify the contents of the behavior, and need to provide the same `uuid` value when modifying the rule tree. See [Advanced and locked features](https://techdocs.akamai.com/property-mgr/reference/advanced-and-locked-features).",
"type": "string"
}
}
}
},
"children": {
"description": "A series of nested rules that execute after the current rule's `criteria` and `behaviors`.",
"minItems": 0,
"type": "array",
"items": {
"type": "object"
}
},
"comment": {
"description": "A descriptive comment to help you track the rule's function.",
"type": "string"
},
"criteria": {
"description": "A series of [criteria](https://techdocs.akamai.com/property-mgr/reference/ga-criteria) objects, which form a set of logical tests that may prevent the rule's `behaviors` from executing. Behavior and criteria objects are structured identically.",
"type": "array",
"items": {
"type": "object"
}
},
"criteriaLocked": {
"description": "Within child rules, this prohibits any modifications to `criteria` objects. Contact your Akamai representative to change the value.",
"type": "boolean"
},
"customOverride": {
"additionalProperties": false,
"description": "Specifies post-processing XML metadata that your Akamai representative can create on your behalf. Once available with the [List custom overrides](https://techdocs.akamai.com/property-mgr/reference/get-custom-overrides) operation, you can assign an `overrideId` to more than one property's `default` rule. See [Custom behaviors and overrides](https://techdocs.akamai.com/property-mgr/reference/custom-behaviors-and-overrides) for guidance.",
"type": "object",
"required": [
"name",
"overrideId"
],
"properties": {
"name": {
"description": "The name of the custom override. It may vary from what appears in the [List custom overrides](https://techdocs.akamai.com/property-mgr/reference/get-custom-overrides) operation's response object.",
"type": "string"
},
"overrideId": {
"description": "Identifies the predefined custom override metadata you want to append to the current rule. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on how to omit the ID's `cbo_` prefix.",
"type": "string"
}
}
},
"name": {
"description": "A description of the rule. The top-level rule needs to be named `default`.",
"type": "string"
},
"uuid": {
"description": "A data hash that indicates the rule contains at least one _advanced_ behavior or criteria, each identified with its own `uuid` member. When this member is present on the rule, you may not remove any advanced features it contains, or change their sequence. You need to provide the same `uuid` value when modifying the rule tree. See [Advanced and locked features](https://techdocs.akamai.com/property-mgr/reference/advanced-and-locked-features).",
"type": "string"
},
"variables": {
"description": "Declares a variable. See [Variables](https://techdocs.akamai.com/property-mgr/reference/variables) for guidance on how variables may appear within a rule tree.",
"minItems": 0,
"type": "array",
"items": {
"additionalProperties": false,
"type": "object",
"required": [
"hidden",
"name",
"sensitive"
],
"properties": {
"description": {
"description": "Text for you to keep track of how you use each variable.",
"type": "string"
},
"hidden": {
"description": "When enabled, the variable is suppressed from session response headers. Useful when testing content as described in the [Debug variables](https://techdocs.akamai.com/property-mgr/reference/debug-variables) section.",
"type": "boolean"
},
"name": {
"description": "The underlying root name of the variable, which needs to be unique within the set of `variables`.",
"type": "string"
},
"sensitive": {
"description": "When enabled, the variable is suppressed from session responses as `hidden` ones, but it also can't be invoked within any behaviors that assign values to cookies or response headers. You also can't assign a `sensitive` variable to another one that isn't `sensitive`, and you can't add it to custom logging fields. Use this more stringent option for any personally identifiable information, typically after initially testing on the staging network.",
"type": "boolean"
},
"value": {
"description": "Initializes a default value. Omitting this member initializes the variable with an empty string.",
"type": "string"
}
}
}
}
}
}
},
"x-akamai": {
"file-path": "schemas/property-version-rules-get-response.yaml"
}
}
}
},
"headers": {
"ETag": {
"description": "Pass the `ETag` response header back as `If-Match` in write requests to ensure you don't overwrite edits by any other API clients. See [Concurrency control](https://techdocs.akamai.com/property-mgr/reference/concurrency-control) for details.",
"example": "\"a9dfe78cf93090516bde891d009eaf57\"",
"schema": {
"type": "string"
},
"x-akamai": {
"file-path": "headers/Etag.yaml"
}
},
"X-Limit-Clientip-Per-Property-Limit": {
"description": "Maximum number of separate [Client IP](https://techdocs.akamai.com/property-mgr/reference/latest-client-ip) matches per property rule tree configuration.",
"schema": {
"type": "string"
},
"x-akamai": {
"file-path": "headers/X-Limit-Clientip-Per-Property-Limit.yaml"
}
},
"X-Limit-Clientip-Per-Property-Remaining": {
"description": "Remaining number of separate [Client IP](https://techdocs.akamai.com/property-mgr/reference/latest-client-ip) matches per property rule tree configuration. See [Rate and resource limiting](https://techdocs.akamai.com/property-mgr/reference/rate-and-resource-limiting) for details.",
"schema": {
"type": "string"
},
"x-akamai": {
"file-path": "headers/X-Limit-Clientip-Per-Property-Remaining.yaml"
}
},
"X-Limit-Elements-Per-Property-Limit": {
"description": "Maximum number of separate matches and behaviors per property rule tree configuration. See [Rate and resource limiting](https://techdocs.akamai.com/property-mgr/reference/rate-and-resource-limiting) for details.",
"schema": {
"type": "string"
},
"x-akamai": {
"file-path": "headers/X-Limit-Elements-Per-Property-Limit.yaml"
}
},
"X-Limit-Elements-Per-Property-Remaining": {
"description": "Remaining number of separate matches and behaviors per property rule tree configuration. See [Rate and resource limiting](https://techdocs.akamai.com/property-mgr/reference/rate-and-resource-limiting) for details.",
"schema": {
"type": "string"
},
"x-akamai": {
"file-path": "headers/X-Limit-Elements-Per-Property-Remaining.yaml"
}
},
"X-Limit-Max-Clientip-Per-Match-Limit": {
"description": "Maximum number of separate IP addresses allowed within each [Client IP](https://techdocs.akamai.com/property-mgr/reference/latest-client-ip) match.",
"schema": {
"type": "string"
},
"x-akamai": {
"file-path": "headers/X-Limit-Max-Clientip-Per-Match-Limit.yaml"
}
},
"X-Limit-Max-Clientip-Per-Match-Remaining": {
"description": "Remaining number of separate IP addresses allowed within each [Client IP](https://techdocs.akamai.com/property-mgr/reference/latest-client-ip) match. See [Rate and resource limiting](https://techdocs.akamai.com/property-mgr/reference/rate-and-resource-limiting) for details.",
"schema": {
"type": "string"
},
"x-akamai": {
"file-path": "headers/X-Limit-Max-Clientip-Per-Match-Remaining.yaml"
}
},
"X-Limit-Max-Nested-Rules-Limit": {
"description": "Maximum number of nested child rules in a property to apply conditional logic.",
"schema": {
"type": "string"
},
"x-akamai": {
"file-path": "headers/X-Limit-Max-Nested-Rules-Limit.yaml"
}
},
"X-Limit-Max-Nested-Rules-Remaining": {
"description": "Remaining number of nested child rules in a property to apply conditional logic. See [Rate and resource limiting](https://techdocs.akamai.com/property-mgr/reference/rate-and-resource-limiting) for details.",
"schema": {
"type": "string"
},
"x-akamai": {
"file-path": "headers/X-Limit-Max-Nested-Rules-Remaining.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"
}
},
"412": {
"description": "[Precondition failed](https://techdocs.akamai.com/property-mgr/reference/412).",
"content": {
"application/problem+json": {
"example": {
"detail": "Cannot activate the property at this time, please try again.",
"instance": "papi/v1/properties/prp_123456/activations?contractId=ctr_C-0N7RAC7&groupId=grp_12345#abc12345abcc02a7",
"status": 412,
"title": "Precondition Failed",
"type": "https://problems.luna.akamaiapis.net/papi/v0/toolkit/validation_failed.error.activation.tower_precondition.failed"
},
"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/412.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": "This corresponds to the `ETag` response header. Passing this value back as `If-Match` in write requests ensures you don't overwrite edits by any other API clients. See [Concurrency control](https://techdocs.akamai.com/property-mgr/reference/concurrency-control) for details.",
"example": "{{If-Match}}",
"in": "header",
"name": "If-Match",
"required": true,
"schema": {
"example": "\"a9dfe78cf93090516bde891d009eaf57\"",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/If-Match-header.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.",
"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": "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.",
"example": "{{contractId}}",
"in": "query",
"name": "contractId",
"required": false,
"schema": {
"example": "ctr_1-1TJZFW",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/contractId-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.",
"example": "{{groupId}}",
"in": "query",
"name": "groupId",
"required": false,
"schema": {
"example": "grp_15166",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/groupId-optional.yaml"
}
},
{
"description": "Set to `true` by default. When `false`, skips validation tests that would identify potential problems within the response object's `errors` and `warnings` arrays. See [Rule tree errors and warnings](https://techdocs.akamai.com/property-mgr/reference/rule-tree-errors-and-warnings) and [Validation errors](https://techdocs.akamai.com/property-mgr/reference/validation-errors) for information on how validation data appears in the response object. See [Validation best practices](https://techdocs.akamai.com/property-mgr/reference/validation-best-practices) for guidance on when to defer validation.",
"example": "{{validateRules}}",
"in": "query",
"name": "validateRules",
"required": false,
"schema": {
"default": true,
"example": true,
"type": "boolean"
},
"x-akamai": {
"file-path": "parameters/validateRules-query.yaml"
}
},
{
"description": "__Enum__ With `validateRules` enabled, setting this to `fast` performs a quick validation check based on the provided JSON. This is faster than the default `full` validation, which performs more extensive checks on the converted XML metadata configuration. See [Validation best practices](https://techdocs.akamai.com/property-mgr/reference/validation-best-practices) for more guidance.",
"example": "{{validateMode}}",
"in": "query",
"name": "validateMode",
"required": false,
"schema": {
"default": "full",
"example": "fast",
"type": "string",
"enum": [
"full",
"fast"
]
},
"x-akamai": {
"file-path": "parameters/validateMode-query.yaml"
}
},
{
"description": "With the `validateRules` query parameter also enabled, allows for a _dry run_ in order to gather any possible errors without saving the rule tree. See [Validation best practices](https://techdocs.akamai.com/property-mgr/reference/validation-best-practices) for more guidance.",
"example": "{{dryRun}}",
"in": "query",
"name": "dryRun",
"required": false,
"schema": {
"default": false,
"example": true,
"type": "boolean"
},
"x-akamai": {
"file-path": "parameters/dryRun-query.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"
}
}
]
},
"head": {
"description": "Gets the rule tree's ETag without the rule tree object. Ordinarily when you [get a rule tree](https://techdocs.akamai.com/property-mgr/reference/get-property-version-rules), the response includes a large rule tree object. As discussed in [Concurrency control](https://techdocs.akamai.com/property-mgr/reference/concurrency-control), it includes a top-level `etag` data digest to use when [writing back the data](https://techdocs.akamai.com/property-mgr/reference/put-property-version-rules). Use this operation if you simply want to get the `ETag` as a header without the data.",
"operationId": "head-property-version-rules",
"summary": "Akamai Get a Digest for a Property's Rule Tree",
"tags": [
"Property version rules"
],
"externalDocs": {
"description": "See documentation for this operation in Akamai's Property Manager API",
"url": "https://techdocs.akamai.com/property-mgr/reference/head-property-version-rules"
},
"responses": {
"204": {
"description": "The response provides the `ETag` header representing the current state of the rule tree data. See Concurrency control for guidance.",
"content": {
"*/*": {}
},
"headers": {
"ETag": {
"description": "Pass the `ETag` response header back as `If-Match` in write requests to ensure you don't overwrite edits by any other API clients. See [Concurrency control](https://techdocs.akamai.com/property-mgr/reference/concurrency-control) for details.",
"example": "\"a9dfe78cf93090516bde891d009eaf57\"",
"schema": {
"type": "string"
},
"x-akamai": {
"file-path": "headers/Etag.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"
}
},
"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": "A custom JSON type that validates against a dated rule format. When examining metadata from a [property version](https://techdocs.akamai.com/property-mgr/reference/get-property-version) or include, the content type is `text/xml`. See [API versioning](https://techdocs.akamai.com/property-mgr/reference/api-versioning) for guidance.",
"example": "{{Accept}}",
"in": "header",
"name": "Accept",
"required": true,
"schema": {
"example": "application/vnd.akamai.papirules.latest+json",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/Accept-header.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.",
"example": "{{contractId}}",
"in": "query",
"name": "contractId",
"required": false,
"schema": {
"example": "ctr_1-1TJZFW",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/contractId-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.",
"example": "{{groupId}}",
"in": "query",
"name": "groupId",
"required": false,
"schema": {
"example": "grp_15166",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/groupId-optional.yaml"
}
},
{
"description": "Set to `true` by default. When `false`, skips validation tests that would identify potential problems within the response object's `errors` and `warnings` arrays. See [Rule tree errors and warnings](https://techdocs.akamai.com/property-mgr/reference/rule-tree-errors-and-warnings) and [Validation errors](https://techdocs.akamai.com/property-mgr/reference/validation-errors) for information on how validation data appears in the response object. See [Validation best practices](https://techdocs.akamai.com/property-mgr/reference/validation-best-practices) for guidance on when to defer validation.",
"example": "{{validateRules}}",
"in": "query",
"name": "validateRules",
"required": false,
"schema": {
"default": true,
"example": true,
"type": "boolean"
},
"x-akamai": {
"file-path": "parameters/validateRules-query.yaml"
}
},
{
"description": "__Enum__ With `validateRules` enabled, setting this to `fast` performs a quick validation check based on the provided JSON. This is faster than the default `full` validation, which performs more extensive checks on the converted XML metadata configuration. See [Validation best practices](https://techdocs.akamai.com/property-mgr/reference/validation-best-practices) for more guidance.",
"example": "{{validateMode}}",
"in": "query",
"name": "validateMode",
"required": false,
"schema": {
"default": "full",
"example": "fast",
"type": "string",
"enum": [
"full",
"fast"
]
},
"x-akamai": {
"file-path": "parameters/validateMode-query.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"
}
}
]
},
"x-akamai": {
"file-path": "paths/property-version-rules.yaml",
"path-for-file": "/properties/{propertyId}/versions/{propertyVersion}/rules"
},
"x-akamai-descriptor-tools": {
"displayName": "propertyVersionRules",
"group": "Property version rules"
},
"parameters": [
{
"description": "Unique identifier for the property. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting the value's `prp_` prefix.",
"example": "{{propertyId}}",
"in": "path",
"name": "propertyId",
"required": true,
"schema": {
"example": "prp_12345",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/propertyId-path.yaml"
}
},
{
"description": "Property's incremental version number.",
"example": "{{propertyVersion}}",
"in": "path",
"name": "propertyVersion",
"required": true,
"schema": {
"example": 3,
"type": "integer"
},
"x-akamai": {
"file-path": "parameters/propertyVersion-path.yaml"
}
}
]
},
"/rule-formats": {
"get": {
"description": "Gets a list of available rule formats. Use these dated version strings available in the response's `ruleFormats.items` array to control the set of behaviors and criteria you invoke within an include's rules to apply to edge content, either [freezing](https://techdocs.akamai.com/property-mgr/reference/rule-format-schemas#freeze-a-feature-set-for-a-rule-tree) a rule tree or [updating](https://techdocs.akamai.com/property-mgr/reference/rule-format-schemas#update-rules-to-a-newer-set-of-features) to a new rule format. To validate a rule tree to the requirements of a specific rule format, see [Get a rule format's schema](https://techdocs.akamai.com/property-mgr/reference/get-schemas-product-rule-format).",
"operationId": "get-rule-formats",
"summary": "Akamai List Rule Formats",
"tags": [
"Rule formats"
],
"externalDocs": {
"description": "See documentation for this operation in Akamai's Property Manager API",
"url": "https://techdocs.akamai.com/property-mgr/reference/get-rule-formats"
},
"responses": {
"200": {
"description": "The response lists available rule format version strings.",
"content": {
"application/json": {
"example": {
"ruleFormats": {
"items": [
"latest",
"v2015-08-08"
]
}
},
"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/GetRuleFormatResponse.json#",
"type": "object",
"properties": {
"ruleFormats": {
"additionalProperties": false,
"description": "The set of requested rule formats, strings available within an `items` array.",
"type": "object",
"properties": {
"items": {
"description": "The supported rule formats.",
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"x-akamai": {
"file-path": "schemas/rule-format-get-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"
}
},
"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"
}
}
]
},
"x-akamai": {
"file-path": "paths/rule-formats.yaml",
"path-for-file": "/rule-formats"
},
"x-descriptor-tools": {
"displayName": "ruleFormats",
"group": "Rule formats"
}
},
"/schemas/products/{productId}/{ruleFormat}": {
"get": {
"description": "Get the JSON schema for the given product and rule format, which you can use to validate a rule tree object. Note that your rule tree may still fail to activate if you specify features that are optional within the schema for a product but not currently supported on your contract. To validate the set of currently available features you want to activate, run [List available behaviors](https://techdocs.akamai.com/property-mgr/reference/get-available-behaviors) and [List available criteria](https://techdocs.akamai.com/property-mgr/reference/get-available-criteria).",
"operationId": "get-schemas-product-rule-format",
"summary": "Akamai Get a Schema for a Rule Format",
"tags": [
"Schemas"
],
"externalDocs": {
"description": "See documentation for this operation in Akamai's Property Manager API",
"url": "https://techdocs.akamai.com/property-mgr/reference/get-schemas-product-rule-format"
},
"responses": {
"200": {
"description": "The response provides a JSON schema for the specified rule format.",
"content": {
"application/json": {
"example": {
"type": "object",
"required": [
"rules"
],
"properties": {
"rules": {
"type": "object"
}
}
},
"schema": {
"description": "A JSON schema for a rule format.",
"type": "object",
"x-akamai": {
"file-path": "schemas/schemas-product-rule-format-get-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"
}
},
"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": "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"
}
}
]
},
"x-akamai": {
"file-path": "paths/schemas-rule-format.yaml",
"path-for-file": "/schemas/products/{productId}/{ruleFormat}"
},
"x-akamai-descriptor-tools": {
"displayName": "ruleFormatSchema",
"group": "Schemas"
},
"parameters": [
{
"description": "Unique identifier for the product. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting the value's `prd_` prefix.",
"example": "{{productId}}",
"in": "path",
"name": "productId",
"required": true,
"schema": {
"example": "prd_Download_Delivery",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/productId-path.yaml"
}
},
{
"description": "Name of the rule format. The rule format can be frozen to a specific version, or represent the `latest` set of behaviors and criteria.",
"example": "{{ruleFormat}}",
"in": "path",
"name": "ruleFormat",
"required": true,
"schema": {
"example": "v2021-07-30",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/ruleFormat-path.yaml"
}
}
]
},
"/schemas/request/{filename}": {
"get": {
"description": "Fetch the JSON schema for a particular request. Error messages about schema mismatches typically link the schema filename.",
"operationId": "get-schemas-request-filename",
"summary": "Akamai Get a Schema for a Request",
"tags": [
"Schemas"
],
"externalDocs": {
"description": "See documentation for this operation in Akamai's Property Manager API",
"url": "https://techdocs.akamai.com/property-mgr/reference/get-schemas-request-filename"
},
"responses": {
"200": {
"description": "The response provides a JSON request schema.",
"content": {
"application/json": {
"example": {
"$schema": "http://json-schema.org/draft-04-schema#",
"description": "Specifies a set of available hostnames to which a property version may be applied. To POST a new edge hostname, specify a single object with `productId`, `domainPrefix`, and `domainSuffix` members, and optional `ipVersionBehavior` and `secure` members. Relevant response objects appear within the outer [Envelope](#envelope) object's `edgehostnames.items` array.",
"id": "resource:/descriptors/papi/v0/schemas/CreateNewEdgeHostnameRequestV0.json#",
"javaType": "com.akamai.luna.papi.model.EdgeHostnameCreateRequest",
"type": "object",
"required": [
"domainPrefix",
"domainSuffix",
"ipVersionBehavior",
"productId"
],
"properties": {
"certEnrollmentId": {
"description": "When creating an Enhanced TLS edge hostname, this sets the certificate enrollment ID. Specify this on POST, with `secureNetwork` set to `ENHANCED_TLS`. To obtain a value programmatically, run the Certificate Provisioning System API's [List enrollments](https://developer.akamai.com/api/core_features/certificate_provisioning_system/v2.html#getenrollments) operation. Choose the appropriate enrollment, strip the leading path expression from its `location` member, and use that value as the `certEnrollmentId`.",
"type": "integer"
},
"domainPrefix": {
"type": "string"
},
"domainSuffix": {
"type": "string"
},
"ipVersionBehavior": {
"type": "string",
"enum": [
"IPV4",
"IPV6_COMPLIANCE"
]
},
"productId": {
"type": "string"
},
"secure": {
"type": "boolean"
},
"secureNetwork": {
"description": "On POST, specifies the type of security for the new edge hostname. With `STANDARD_TLS` specified, specify a `domainSuffix` of `edgesuite.net`. With `SHARED_CERT` specified, specify a `domainSuffix` of `akamaized.net`. With `ENHANCED_TLS` specified, you need to specify a `certEnrollmentId` value along with a `domainSuffix` of `edgekey.net`.",
"type": "string",
"enum": [
"ENHANCED_TLS",
"STANDARD_TLS",
"SHARED_CERT"
]
},
"slotNumber": {
"description": "On POST, sets the slot number for secure ESSL properties.",
"type": "integer"
},
"useCases": {
"maxItems": 2,
"type": "array",
"items": {
"description": "Optionally when configuring a new edge hostname, this assigns a preset _use case_ that characterizes the type of traffic served, to help optimize deployment over the Akamai edge network. To gather values to add to this object, run the [List use cases](#getusecases) operation.",
"type": "object",
"required": [
"useCase",
"option",
"type"
],
"properties": {
"option": {
"description": "Specifies one of the available `options` available in the [UseCase](#84c668bb) response object.",
"type": "string"
},
"type": {
"description": "Identifies the type of network over which traffic deploys. The only value currently available is `GLOBAL`. Use this to specify the same member name available in the [UseCase](#84c668bb) response object.",
"type": "string",
"enum": [
"GLOBAL"
]
},
"useCase": {
"description": "Uniquely identifies each mapping use case scenario. Use this to specify the same member name available in the [UseCase](#84c668bb) response object.",
"type": "string"
}
}
}
}
}
},
"schema": {
"description": "The structure of the schema depends on the requested file.",
"type": "object",
"x-akamai": {
"file-path": "schemas/schemas-request-filename-get-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"
}
},
"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": "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"
}
}
]
},
"x-akamai": {
"file-path": "paths/schemas-request-filename.yaml",
"path-for-file": "/schemas/request/{filename}"
},
"x-akamai-descriptor-tools": {
"displayName": "requestSchema",
"group": "Schemas"
},
"parameters": [
{
"description": "Schema's filename.",
"example": "{{filename}}",
"in": "path",
"name": "filename",
"required": true,
"schema": {
"example": "CreateNewEdgeHostnameRequestV0.json",
"type": "string"
},
"x-akamai": {
"file-path": "parameters/filename-path.yaml"
}
}
]
},
"/search/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"
}
}
]
},
"x-akamai": {
"file-path": "paths/search.yaml",
"path-for-file": "/search/find-by-value"
},
"x-akamai-descriptor-tools": {
"displayName": "findByValue",
"group": "Find by Value"
}
}
},
"x-readme": {
"samples-languages": [
"curl",
"python",
"node"
]
},
"servers": [
{
"url": "https://{hostname}/papi/v1"
}
]
}