Akamai · Example Payload

Akamai Get Selectable Hostnames Example

CDNCloudEdge ComputingNetworksPlatformSecurity

Akamai Get Selectable Hostnames 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-selectable-hostnames",
  "method": "GET",
  "path": "/configs/{configId}/versions/{versionNumber}/selectable-hostnames",
  "summary": "List selectable hostnames",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "availableSet": [
          {
            "activeInProduction": true,
            "activeInStaging": true,
            "arlInclusion": true,
            "configIdInProduction": 77653,
            "configNameInProduction": "WAF Security File",
            "hostname": "example.com"
          },
          {
            "activeInProduction": false,
            "activeInStaging": true,
            "arlInclusion": true,
            "configIdInProduction": 51074,
            "configNameInProduction": "A PUBLIC CONFIG",
            "hostname": "www.example.com"
          },
          {
            "activeInProduction": true,
            "activeInStaging": true,
            "arlInclusion": true,
            "configIdInProduction": 65473,
            "configNameInProduction": "Other Security Configuration",
            "hostname": "www.example-123.com"
          }
        ],
        "configId": 123,
        "configVersion": 2,
        "errorSet": [
          {
            "hostname": "*.example.net",
            "reason": "property is not active in either production or staging",
            "reasonCode": 400
          },
          {
            "hostname": "test-example.net",
            "reason": "You don't have access to this property",
            "reasonCode": 403
          }
        ],
        "protectARLInclusionHost": true,
        "selectedSet": [
          {
            "activeInProduction": true,
            "activeInStaging": true,
            "arlInclusion": false,
            "configIdInProduction": 11887,
            "configNameInProduction": "Rbac Test Config",
            "hostname": "m.example.com"
          },
          {
            "activeInProduction": true,
            "activeInStaging": true,
            "arlInclusion": false,
            "configIdInProduction": null,
            "configNameInProduction": null,
            "hostname": "m.example-123.com"
          }
        ]
      }
    },
    {
      "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": "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"
      }
    }
  ]
}