Akamai · Example Payload
Akamai Get Onboarding Example

CDNCloudEdge ComputingNetworksPlatformSecurity
Akamai Get Onboarding 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": "get-onboarding",
  "method": "GET",
  "path": "/onboardings/{onboardingId}",
  "summary": "Get an onboarding",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "accountId": "A-CCT1234",
        "activations": [
          {
            "activationId": 105,
            "activationLink": "/appsec/v1/onboardings/101/activations/105",
            "activationStatus": "ACTIVE",
            "completedDate": "2024-05-03T12:34:21Z",
            "createdDate": "2024-05-03T10:38:21Z",
            "network": "STAGING"
          },
          {
            "activationId": 106,
            "activationLink": "/appsec/v1/onboardings/101/activations/106",
            "activationStatus": "ACTIVE",
            "completedDate": "2024-05-04T12:34:21Z",
            "createdDate": "2024-05-04T10:38:21Z",
            "network": "PRODUCTION"
          }
        ],
        "contractId": "C-0N7RAC7",
        "createdBy": "hgildong",
        "createdDate": "2024-05-02T22:08:50Z",
        "currentStep": 3,
        "groupId": 54321,
        "hostnames": [
          "www.example.com",
          "www.example.net"
        ],
        "modifiedBy": "jsmith",
        "modifiedDate": "2024-05-04T12:34:21Z",
        "nextSteps": [
          {
            "stepDescription": "Validate the certificate challenge",
            "stepLink": "/appsec/v1/onboardings/101/certificate-validation",
            "stepName": "certificate-validation"
          },
          {
            "stepDescription": "Validate that the origin is live",
            "stepLink": "/appsec/v1/onboardings/101/origin-validation",
            "stepName": "origin-validation"
          }
        ],
        "onboardingId": 101,
        "onboardingLink": "/appsec/v1/onboardings/101",
        "onboardingStatus": "CREATED",
        "product": "ASM",
        "settings": {
          "certificate": {
            "adminContact": {
              "email": "adminContact@nomail-akamai.com",
              "firstName": "AdminUser",
              "lastName": "User",
              "phone": "+9180460018"
            },
            "certificateType": "CUSTOM_EXISTING",
            "commonName": "www.at.konaqa.com",
            "enrollmentId": 94723,
            "enrollmentLink": "/cps/v2/enrollments/94723"
          },
          "delivery": {
            "origins": [
              {
                "hostname": "www.example.com",
                "origin": "origin-ea0ac1-www.example.com"
              },
              {
                "hostname": "www.example.net",
                "origin": "origin-8eeeba-www.example.net"
              }
            ]
          },
          "security": {
            "cloneVersion": 25,
            "configId": 243359,
            "configLink": "/appsec/v1/configs/12345",
            "configName": "sec-config",
            "configType": "EXISTING",
            "evalRequired": true,
            "policyId": "PLCY_12344",
            "policyLink": "/appsec/v1/configs/12345/versions/25/security-policies/PLCY_12345",
            "policyName": "sec-policy",
            "policyType": "EXISTING",
            "protections": {
              "applyApplicationLayerControls": true,
              "applyBotmanControls": false,
              "applyNetworkLayerControls": true,
              "applyRateControls": true,
              "applyReputationControls": true,
              "applySlowPostControls": true
            }
          },
          "settingsLink": "/appsec/v1/onboardings/101/settings"
        },
        "totalSteps": 5
      }
    },
    {
      "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"
      }
    }
  ]
}