Akamai · Example Payload

Akamai Get Onboardings Example

CDNCloudEdge ComputingNetworksPlatformSecurity

Akamai Get Onboardings 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-onboardings",
  "method": "GET",
  "path": "/onboardings",
  "summary": "List onboardings",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "onboardings": [
          {
            "createdBy": "jdupont",
            "createdTime": "2024-05-07T22:08:50Z",
            "hostnames": [
              "www.example.com"
            ],
            "modifiedBy": "asingh",
            "modifiedTime": "2024-07-09T15:03:29Z",
            "onboardingId": 101,
            "onboardingLink": "/appsec/v1/onboardings/101",
            "onboardingStatus": "VALIDATION_PENDING"
          },
          {
            "createdBy": "jsmith",
            "createdTime": "2024-05-03T22:08:51Z",
            "hostnames": [
              "www.example.net",
              "test.example.net"
            ],
            "modifiedBy": "jsmith",
            "modifiedTime": "2024-07-05T12:34:21Z",
            "onboardingId": 102,
            "onboardingLink": "/appsec/v1/onboardings/102",
            "onboardingStatus": "CREATED"
          }
        ]
      }
    },
    {
      "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"
      }
    }
  ]
}