Akamai · Example Payload
Akamai Patch Property Hostnames Example
CDNCloudEdge ComputingNetworksPlatformSecurity
Akamai Patch Property Hostnames 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": "patch-property-hostnames",
"method": "PATCH",
"path": "/properties/{propertyId}/hostnames",
"summary": "Akamai Add or Remove Hostnames for a Property's Hostname Bucket",
"requestExamples": [
{
"contentType": "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"
}
]
}
}
],
"responseExamples": [
{
"status": "201",
"contentType": "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"
}
]
}
},
{
"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": "409",
"contentType": "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"
}
},
{
"status": "413",
"contentType": "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/"
}
},
{
"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": "422",
"contentType": "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"
}
]
}
},
{
"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"
}
}
]
}