Akamai · Example Payload
Akamai Put Include Version Rules Example
CDNCloudEdge ComputingNetworksPlatformSecurity
Akamai Put Include Version Rules Example is an example object payload from Akamai, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.
Top-level fields
operationIdmethodpathsummaryrequestExamplesresponseExamples
Example Payload
{
"operationId": "put-include-version-rules",
"method": "PUT",
"path": "/includes/{includeId}/versions/{includeVersion}/rules",
"summary": "Akamai Update an Include's Rule Tree",
"requestExamples": [
{
"contentType": "*/*",
"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"
}
}
}
]
}
}
},
{
"contentType": "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"
}
}
}
]
}
}
}
],
"responseExamples": [
{
"status": "200",
"contentType": "*/*",
"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"
}
}
}
]
}
}
},
{
"status": "400",
"contentType": "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"
}
},
{
"status": "401",
"contentType": "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"
}
},
{
"status": "403",
"contentType": "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"
}
},
{
"status": "404",
"contentType": "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"
}
},
{
"status": "405",
"contentType": "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"
}
},
{
"status": "406",
"contentType": "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"
}
},
{
"status": "412",
"contentType": "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"
}
},
{
"status": "415",
"contentType": "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"
}
},
{
"status": "429",
"contentType": "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"
}
},
{
"status": "500",
"contentType": "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"
}
}
]
}