Akamai · Example Payload

Akamai Get Onboarding Settings Example

CDNCloudEdge ComputingNetworksPlatformSecurity

Akamai Get Onboarding Settings 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

Raw ↑ 
{
  "operationId": "get-onboarding-settings",
  "method": "GET",
  "path": "/onboardings/{onboardingId}/settings",
  "summary": "Get onboarding settings",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "certificate": {
          "adminContact": {
            "email": "adminContact@nomail-akamai.com",
            "firstName": "AdminUser",
            "lastName": "User",
            "phone": "+919090909090"
          },
          "certificateType": "CUSTOM_EXISTING",
          "commonName": "www.commonName.com",
          "enrollmentId": 87902,
          "enrollmentLink": "/cps/v2/enrollments/87902"
        },
        "delivery": {
          "origins": [
            {
              "hostname": "www.example.com",
              "origin": "origin-ea0ac1-.www.example.com"
            },
            {
              "hostname": "www.example.net",
              "origin": "origin-8eeeba-.www.example.net"
            }
          ]
        },
        "onboardingLink": "/appsec/v1/onboardings/101",
        "security": {
          "cloneVersion": 25,
          "configId": 24335,
          "configLink": "/appsec/v1/configs/24335",
          "configName": "sec-config",
          "configType": "EXISTING",
          "evalRequired": true,
          "policyId": "000Q_475674",
          "policyLink": "/appsec/v1/configs/243359/versions/25/security-policies/000Q_475674",
          "policyName": "sec-policy",
          "policyType": "EXISTING",
          "protections": {
            "applyApplicationLayerControls": true,
            "applyBotmanControls": false,
            "applyNetworkLayerControls": true,
            "applyRateControls": true,
            "applyReputationControls": true,
            "applySlowPostControls": true
          }
        },
        "settingsLink": "/appsec/v1/onboardings/101/settings"
      }
    },
    {
      "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"
      }
    }
  ]
}