Akamai · Example Payload

Akamai Get Api Details Example

CDNCloudEdge ComputingNetworksPlatformSecurity

Akamai Get Api Details 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-api-details",
  "method": "GET",
  "path": "/api-discovery/host/{hostname}/basepath/{basePath}",
  "summary": "Get a discovered API",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "apiEndpointIds": [
          320110
        ],
        "basePath": "/routing/checkout/init",
        "discoveryType": "RESOURCE",
        "enrichment": {
          "options": 0,
          "browsers": 1715,
          "clientErrors": 0,
          "clientReputation": 0,
          "dateFirstSeen": "2021-11-30",
          "dateLastModified": "2021-11-30",
          "dateLastSeen": "2021-12-29",
          "deletes": 0,
          "dosAttackers": 0,
          "formats": [
            "JSON"
          ],
          "gets": 0,
          "hostSamples": [
            "example.com"
          ],
          "mobiles": 810,
          "paths": [
            {
              "options": 0,
              "deletes": 0,
              "gets": 0,
              "posts": 1715,
              "puts": 0,
              "samples": [
                ""
              ],
              "template": ""
            }
          ],
          "posts": 1715,
          "puts": 0,
          "redirects": 0,
          "requests": 1715,
          "requestsBadReputation": 0,
          "requestsLastDay": 57,
          "scanningTools": 0,
          "serverErrors": 0,
          "successes": 1715,
          "totalErrors": 0,
          "trend": "DOWN",
          "webAttackers": 0,
          "webScrapers": 0
        },
        "host": "example.com",
        "visibility": "VISIBLE"
      }
    },
    {
      "status": "400",
      "contentType": "application/json",
      "example": {
        "detail": "The request could not be understood by the server due to malformed syntax.",
        "instance": "https://problems.luna.akamaiapis.net/appsec/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749",
        "status": 400,
        "title": "Bad Request",
        "type": "https://problems.luna.akamaiapis.net/appsec/error-types/BAD-REQUEST"
      }
    },
    {
      "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": "Internal Server Error",
        "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no",
        "status": 500,
        "title": "Internal Server Error",
        "type": "internal_server_error"
      }
    }
  ]
}