List onboarding certificate challenges

get https://{hostname}/appsec/v1/onboardings/{onboardingId}/certificate-validation

All products Returns the information you need to validate your certificate. Add the TXT DNS record listed in the response to your DNS record. Adding the TXT record won't affect your website. Once you've added the TXT record, and before the token expires, run Validate onboarding certificate to validate the certificate.

Responses

Response body

object

certificateValidateLink

uri

required

The URL to call to validate your certificate.

certificateValidationStatus

string

required

length ≥ 1

The cumulative status for all certificate validation. If there is more than one certificate and each is valid, you'll see a value of VALIDATION_SUCCESS. If one certificate is valid but another is not, it will say VALIDATION_NEEDED.

VALIDATION_SUCCESS VALIDATION_NEEDED

description

string

required

length ≥ 1

Details the steps you need to perform to validate your certificate.

onboardingLink

uri

required

The URL to get the onboarding's details.

records

array of objects

required

Lists all hostname record information you need to validate your certificate.

records*

object

hostname

string

required

length ≥ 1

The hostname the certificate secures.

httpFilePath

string

required

length ≥ 1

The path to the http file when validating your certificate with an HTTP token.

httpToken

string

required

length ≥ 1

The domain record's HTTP token you'll use to validate your certificate.

recordName

string

required

length ≥ 1

The fully qualified domain name (FQDN) of this record.

recordStatus

string

required

length ≥ 1

The status of your certificate. When VALIDATED, you can proceed to the next step in the onboarding process. When NOT_VALIDATED, you may need to validate your site manually.

VALIDATED NOT_VALIDATED

recordTtl

integer

required

The number of seconds that this record should live in cache before being re-fetched.

recordType

string

required

length ≥ 1

The type of domain record. For example, A, TXT, or CNAME.

recordValue

string

required

length ≥ 1

The resource record's IP address.

urlRedirectFrom

string

required

length ≥ 1

The URL for the site you are redirecting from when you validate your origin using a redirect.

urlRedirectTo

string

required

length ≥ 1

The URL you are redirecting to when you validate your origin using a redirect.

`onboardingId` was not found.

Language

Authentication

Remember to add your authentication credentials to run this code.

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://hostname/appsec/v1/onboardings/onboardingId/certificate-validation \
3
     --header 'accept: application/json'


xxxxxxxxxx
32
}
1
{
2
  "certificateValidateLink": "/appsec/v1/onboardings/101/certificate-validation/validate",
3
  "certificateValidationStatus": "VALIDATION_SUCCESS",
4
  "description": "Certificate Validation is complete.Please proceed with next steps.",
5
  "onboardingLink": "/appsec/v1/onboardings/101",
6
  "records": [
7
    {
8
      "hostname": "www.test.com",
9
      "httpFilePath": "http://www.test.com/.well-known/acme-challenge/FXdQ7d5o-4n156mUdKoWSA7VSsL5RCVbWiAVDUH0YBA",
10
      "httpToken": "FXdQ7d5o-4n156mUdKoWSA7VSsL5RCVbWiAVDUH0YBA.Q09uXf7yi3IHfsXvV6hGMNKJWtRyUFmUjzd_iQ1vVL0",
11
      "recordName": "_acme-challenge.www.test.com.",
12
      "recordStatus": "VALIDATED",
13
      "recordTtl": 60,
14
      "recordType": "TXT",
15
      "recordValue": "jSwlQYgkF9Tus6C1us4ysx6QxCB95o3fXHKh9TvqiII",
16
      "urlRedirectFrom": "http://www.test.com/.well-known/acme-challenge/FXdQ7d5o-4n156mUdKoWSA7VSsL5RCVbWiAVDUH0YBA",
17
      "urlRedirectTo": "http://dcv.akamai.com/.well-known/acme-challenge/FXdQ7d5o-4n156mUdKoWSA7VSsL5RCVbWiAVDUH0YBA"
18
    },
19
    {
20
      "hostname": "www.test1.com",
21
      "httpFilePath": "http://www.test1.com/.well-known/acme-challenge/FXdQ7d5o-4n156mUdKoWSA7VSsL5RCVbWiAVDUH0YBA",
22
      "httpToken": "FXdQ7d5o-4n156mUdKoWSA7VSsL5RCVbWiAVDUH0YBA.Q09uXf7yi3IHfsXvV6hGMNKJWtRyUFmUjzd_iQ1vVL0",
23
      "recordName": "_acme-challenge.www.test1.com.",
24
      "recordStatus": "VALIDATED",
25
      "recordTtl": 60,

200Successfully retrieved certificate Challenges.

403Forbidden. You are not authorized to use this API.

404Not found. The onboardingId was not found.

500Conflict. Failure to retrieve certificate challenges.

`onboardingId` was not found.