Akamai · Example Payload

Akamai Put Routing Settings Example

CDNCloudEdge ComputingNetworksPlatformSecurity

Akamai Put Routing 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

{
  "operationId": "put-routing-settings",
  "method": "PUT",
  "path": "/endpoints/{apiEndPointId}/versions/{versionNumber}/settings/routing",
  "summary": "Edit routing settings",
  "requestExamples": [
    {
      "contentType": "application/json",
      "example": {
        "rules": [
          {
            "customForwardPath": null,
            "description": null,
            "forwardHostHeader": null,
            "forwardPath": "DEFAULT_PATH",
            "forwardPort": null,
            "name": "/test.html",
            "origin": "rapidzik.hereokuapp.com",
            "conditions": [
              {
                "operator": "IS",
                "type": "METHOD",
                "value": "GET"
              },
              {
                "operator": "IS",
                "type": "HOSTNAME",
                "value": "*.www.sqa.rapid.com"
              }
            ]
          }
        ],
        "sureRoute": [
          {
            "forceSslForward": false,
            "origin": "rapidzik.hereokuapp.com",
            "raceKey": "some-custom-key.com",
            "raceKeyMode": "CUSTOM",
            "testObjectPath": "/test.html",
            "raceStatTtl": {
              "duration": 30,
              "unit": "MINUTES"
            }
          }
        ]
      }
    }
  ],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "bodyParamName": "body-param-name",
        "cacheOrigin": false,
        "cacheResponseOnError": null,
        "detectError": false,
        "enabled": true,
        "maxQuerySize": null,
        "nestingLevel": null,
        "queryParamName": "query-param-name",
        "serveStale": null,
        "downstreamCaching": {
          "headers": "SAME_AS_ORIGIN",
          "lifetime": "SMALLER_VALUE",
          "markAsPrivate": false,
          "option": "ALLOW_CACHING"
        },
        "maxAge": {
          "duration": 420,
          "unit": "HOURS"
        },
        "preRefreshing": {
          "enabled": true,
          "value": 50
        }
      }
    }
  ]
}