Akamai · Example Payload
Akamai Post Onboarding Domain Validation Example
CDNCloudEdge ComputingNetworksPlatformSecurity
Akamai Post Onboarding Domain Validation 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": "post-onboarding-domain-validation",
"method": "POST",
"path": "/onboardings/{onboardingId}/domain-validation/validate",
"summary": "Validate onboarding domains",
"requestExamples": [],
"responseExamples": [
{
"status": "200",
"contentType": "application/json",
"example": {
"description": "Complete domain validation using one of the following three methods: 1. DNS token validation. Add a DNS entry for each hostname with the given `recordName`, `recordType`, `recordTTL`, and `recordValue` from this response. 2. URL redirect validation. Add the following URL redirect (HTTP status code 301 or 302) to the server hosting this domain from `urlRedirectFrom` to `urlRedirectTo`. 3. HTTP token validation. Create a file with an `httpRecordToken` in it and put the file in the designated `httpRecordFile` folder on your site. Once complete, run [Validate onboarding domains](https://techdocs.akamai.com/application-security/reference/post-onboarding-domain-validation).",
"domainValidationLink": "/appsec/v1/onboardings/101/domain-validation/validate",
"domainValidationStatus": "VALIDATION_NEEDED",
"onboardingLink": "/appsec/v1/onboardings/101",
"records": [
{
"hostname": "www.example.com",
"httpFilePath": "https://www.example.com/.well-known/akamai/akamai-challenge",
"httpToken": "Kvcqs64nHpnKyytmX6ELnga0YM9C9BsJO-ubvXa5UBzR0D65xkOfIA",
"recordName": "_acme-challenge.www.example.com",
"recordStatus": "NOT_VALIDATED",
"recordTtl": 60,
"recordType": "CNAME",
"recordValue": "ac.e5faf53e128860434c9d9e8ec5d0602d.www.example.com.validate-akdv.net",
"urlRedirectFrom": "https://www.example.com/.well-known/akamai/akamai-challenge/DcSTISzoTF35eZET_wDnkg",
"urlRedirectTo": "https://validation.akamai.com/.well-known/akamai/akamai-challenge/Kvcqs64nHpnKyytmX6ELnga0YM9C9BsJO-ubvXa5UBzR0D65xkOfIA"
},
{
"hostname": "www2.example.com",
"httpFilePath": "https://ww2.example.com/.well-known/akamai/akamai-challenge",
"httpToken": "Abcde64nHpnKyytmX6ELnga0YM9C9BsJO-ubvXa5UBzR0D65xkOfYZ",
"recordName": "_acme-challenge.ww2.example.com",
"recordStatus": "VALIDATED",
"recordTtl": 60,
"recordType": "CNAME",
"recordValue": "bc.e5faf53e128860434c9d9e8ec5d0602d.www.example.com.validate-akdv.net",
"urlRedirectFrom": "https://ww2.example.com/.well-known/akamai/akamai-challenge/DcSTISzoTF35eZET_wDnkg",
"urlRedirectTo": "https://validation.akamai.com/.well-known/akamai/akamai-challenge/Kvcqs64nHpnKyytmX6ELnga0YM9C9BsJO-ubvXa5UBzR0D65xkOfIA"
}
]
}
},
{
"status": "207",
"contentType": "application/json",
"example": {
"description": "Complete domain validation using one of the following three methods: 1. DNS token validation. Add a DNS entry for each hostname with the given `recordName`, `recordType`, `recordTTL`, and `recordValue` from this response. 2. URL redirect validation. Add the following URL redirect (HTTP status code 301 or 302) to the server hosting this domain from `urlRedirectFrom` to `urlRedirectTo`. 3. HTTP token validation. Create a file with an `httpRecordToken` in it and put the file in the designated `httpRecordFile` folder on your site. Once complete, run [Validate onboarding domains](https://techdocs.akamai.com/application-security/reference/post-onboarding-domain-validation).",
"domainValidationLink": "/appsec/v1/onboardings/101/domain-validation/validate",
"domainValidationStatus": "VALIDATION_NEEDED",
"onboardingLink": "/appsec/v1/onboardings/101",
"records": [
{
"hostname": "www.example.com",
"httpFilePath": "https://www.example.com/.well-known/akamai/akamai-challenge",
"httpToken": "Kvcqs64nHpnKyytmX6ELnga0YM9C9BsJO-ubvXa5UBzR0D65xkOfIA",
"recordName": "_acme-challenge.www.example.com",
"recordStatus": "NOT_VALIDATED",
"recordTtl": 60,
"recordType": "CNAME",
"recordValue": "ac.e5faf53e128860434c9d9e8ec5d0602d.www.example.com.validate-akdv.net",
"urlRedirectFrom": "https://www.example.com/.well-known/akamai/akamai-challenge/DcSTISzoTF35eZET_wDnkg",
"urlRedirectTo": "https://validation.akamai.com/.well-known/akamai/akamai-challenge/Kvcqs64nHpnKyytmX6ELnga0YM9C9BsJO-ubvXa5UBzR0D65xkOfIA"
},
{
"hostname": "www2.example.com",
"httpFilePath": "https://ww2.example.com/.well-known/akamai/akamai-challenge",
"httpToken": "Abcde64nHpnKyytmX6ELnga0YM9C9BsJO-ubvXa5UBzR0D65xkOfYZ",
"recordName": "_acme-challenge.ww2.example.com",
"recordStatus": "VALIDATED",
"recordTtl": 60,
"recordType": "CNAME",
"recordValue": "bc.e5faf53e128860434c9d9e8ec5d0602d.www.example.com.validate-akdv.net",
"urlRedirectFrom": "https://ww2.example.com/.well-known/akamai/akamai-challenge/DcSTISzoTF35eZET_wDnkg",
"urlRedirectTo": "https://validation.akamai.com/.well-known/akamai/akamai-challenge/Kvcqs64nHpnKyytmX6ELnga0YM9C9BsJO-ubvXa5UBzR0D65xkOfIA"
}
]
}
},
{
"status": "403",
"contentType": "application/problem+json",
"example": {
"detail": "You do not have the necessary access to perform this operation or the requested resource cannot be modified",
"instance": "https://problems.luna.akamaiapis.net/appsec/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749",
"status": 403,
"title": "Forbidden",
"type": "https://problems.luna.akamaiapis.net/appsec-resource/error-types/ACCESS-DENIED"
}
},
{
"status": "404",
"contentType": "application/problem+json",
"example": {
"detail": "The requested resource is not found",
"instance": "https://problems.luna.akamaiapis.net/appsec/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749",
"status": 404,
"title": "Not Found",
"type": "https://problems.luna.akamaiapis.net/appsec/error-types/NOT-FOUND"
}
},
{
"status": "500",
"contentType": "application/problem+json",
"example": {
"detail": "Could not retrieve validation records",
"instance": "https://problems.luna.akamaiapis.net/appsec/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749",
"status": 500,
"title": "Something went wrong",
"type": "https://problems.luna.akamaiapis.net/appsec/error-types/INTERNAL-SERVER-ERROR"
}
}
]
}