Akamai · Example Payload

Akamai Get Maps Example

CDNCloudEdge ComputingNetworksPlatformSecurity

Akamai Get Maps 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-maps",
  "method": "GET",
  "path": "/maps",
  "summary": "List maps",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "siteShieldMaps": [
          {
            "acknowledgeRequiredBy": 1679661685000,
            "acknowledged": true,
            "acknowledgedBy": "jsmith",
            "acknowledgedOn": 1649661984000,
            "contacts": [
              "jsmith@example.com"
            ],
            "currentCidrs": [
              "192.0.2.29/24",
              "192.0.2.71/24",
              "192.0.2.0/24",
              "192.0.2.140/24",
              "192.0.2.212/24"
            ],
            "id": 123456789,
            "latestTicketId": 2456,
            "mapAlias": "ABC Company",
            "mcmMapRuleId": 12345,
            "proposedCidrs": [
              "192.0.2.232/24",
              "192.0.2.228/24",
              "192.0.2.115/24",
              "192.0.2.16/24",
              "192.0.2.154/24"
            ],
            "ruleName": "ss.akamai.net",
            "service": "S",
            "shared": false,
            "sureRouteName": "route.name.example.com",
            "type": "Production"
          },
          {
            "acknowledgeRequiredBy": 1569661685000,
            "acknowledged": true,
            "acknowledgedBy": "adevi",
            "acknowledgedOn": 1569661984000,
            "contacts": [
              "luna@akamai.com",
              "new@email.com"
            ],
            "currentCidrs": [
              "192.0.2.51/24",
              "192.0.2.16/24",
              "192.0.2.76/24",
              "192.0.2.70/24",
              "192.0.2.251/24",
              "192.0.2.57/24",
              "192.0.2.153/24",
              "192.0.2.40/24",
              "192.0.2.49/24"
            ],
            "id": 7964,
            "latestTicketId": 5884,
            "mapAlias": "Capybara Corp",
            "mcmMapRuleId": 957,
            "proposedCidrs": [],
            "ruleName": "e;s9.akamaiedge.net",
            "service": "S",
            "shared": false,
            "type": "Production"
          },
          {
            "acknowledgeRequiredBy": 1684661685000,
            "acknowledged": true,
            "acknowledgedBy": "afero",
            "acknowledgedOn": 1647261984000,
            "contacts": [
              "pulse@akamai.com"
            ],
            "currentCidrs": [],
            "id": 65,
            "latestTicketId": 883,
            "mapAlias": "Kookaburra Inc secure",
            "mcmMapRuleId": 4255,
            "proposedCidrs": [
              "192.0.2.205/24",
              "192.0.2.226/24",
              "192.0.2.228/24",
              "192.0.2.191/24",
              "192.0.2.157/24",
              "192.0.2.33/24",
              "192.0.2.25/24",
              "192.0.2.41/24",
              "192.0.2.146/24",
              "192.0.2.174/24",
              "192.0.2.25/24",
              "192.0.2.239/24",
              "192.0.2.186/24",
              "192.0.2.115/24",
              "192.0.2.207/24",
              "192.0.2.132/24",
              "192.0.2.117/24",
              "192.0.2.231/24",
              "192.0.2.166/24",
              "192.0.2.22/24",
              "192.0.2.121/24",
              "192.0.2.160/24",
              "192.0.2.174/24",
              "192.0.2.58/24"
            ],
            "ruleName": "e;s1.akamaiedge.net",
            "service": "S",
            "shared": false,
            "sureRouteName": "route.name.example.com",
            "type": "Production"
          }
        ]
      }
    },
    {
      "status": "400",
      "contentType": "application/problem+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": "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": "Invalid map: 12345677",
        "instance": "https://problems.luna.akamaiapis.net/siteshield/error-instances/666929c8-c53f-4ac6-88ad-a157310eef79",
        "problemId": "95bfad29-c2aa-4531-b324-d33806665ba0",
        "status": 404,
        "title": "Invalid map id",
        "type": "https://problems.luna.akamaiapis.net/siteshield/not-found"
      }
    }
  ]
}