Akamai · Example Payload

Akamai Get Property Hostnames Diff Example

CDNCloudEdge ComputingNetworksPlatformSecurity

Akamai Get Property Hostnames Diff 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-property-hostnames-diff",
  "method": "GET",
  "path": "/properties/{propertyId}/hostnames/diff",
  "summary": "Akamai Get Property Hostnames Diff",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "accountId": "act_A-CCT5678",
        "contractId": "ctr_K-0N7RAK71",
        "groupId": "grp_15225",
        "propertyId": "prp_175780",
        "hostnames": {
          "currentItemCount": 1,
          "nextLink": "/papi/v1/properties/prp_175780/hostnames/diff?offset=1&limit=1",
          "totalItems": 1,
          "items": [
            {
              "cnameFrom": "example.com",
              "productionCertType": "DEFAULT",
              "productionCnameTo": "m.example.com.edgesuite.net",
              "productionCnameType": "EDGE_HOSTNAME",
              "productionEdgeHostnameId": "ehn_293412",
              "stagingCertType": "CPS_MANAGED",
              "stagingCnameTo": "example.com.edgesuite-staging.net",
              "stagingCnameType": "EDGE_HOSTNAME",
              "stagingEdgeHostnameId": "ehn_895822"
            }
          ]
        }
      }
    },
    {
      "status": "400",
      "contentType": "application/problem+json",
      "example": {
        "detail": "The system cannot understand your request.  Please check the syntax and correct any problems.",
        "instance": "/papi/v1/properties?contractId=ctr_C-0N7RAC7&groupId=grp_12345#abc12345abcc02a7",
        "status": 400,
        "title": "Bad Request",
        "type": "https://problems.luna.akamaiapis.net/papi/v0/http/bad-request"
      }
    },
    {
      "status": "401",
      "contentType": "application/problem+json",
      "example": {
        "detail": "The request requires authentication.",
        "instance": "/papi/v1/properties?contractId=ctr_C-0N7RAC7&groupId=grp_12345#abc12345abcc02a7",
        "status": 401,
        "title": "Unauthorized",
        "type": "https://problems.luna.akamaiapis.net/papi/v0/http/unauthorized"
      }
    },
    {
      "status": "403",
      "contentType": "application/problem+json",
      "example": {
        "detail": "The authorization token you provided does not allow access to this resource.",
        "instance": "/papi/v1/properties?contractId=ctr_C-0N7RAC7&groupId=grp_12345#abc12345abcc02a7",
        "status": 403,
        "title": "Forbidden",
        "type": "https://problems.luna.akamaiapis.net/papi/v1/http/forbidden"
      }
    },
    {
      "status": "404",
      "contentType": "application/problem+json",
      "example": {
        "detail": "The system was unable to locate the requested resource.",
        "instance": "/papi/v1/properties?contractId=ctr_C-0N7RAC7&groupId=grp_12345#abc12345abcc02a7",
        "status": 404,
        "title": "Not Found",
        "type": "https://problems.luna.akamaiapis.net/papi/v1/http/not-found"
      }
    },
    {
      "status": "405",
      "contentType": "application/problem+json",
      "example": {
        "detail": "The system does not support the method you provided for this resource.",
        "instance": "/papi/v1/properties?contractId=ctr_C-0N7RAC7&groupId=grp_12345#abc12345abcc02a7",
        "status": 405,
        "title": "Method not allowed",
        "type": "https://problems.luna.akamaiapis.net/papi/v1/http/method-not-allowed"
      }
    },
    {
      "status": "406",
      "contentType": "application/problem+json",
      "example": {
        "detail": "The system does not support the content-type restrictions provided by your 'Accept' header.",
        "instance": "papi/v1/build#abc12345abcc02a7",
        "status": 406,
        "title": "Not Acceptable",
        "type": "https://problems.luna.akamaiapis.net/papi/v1/http/not-acceptable"
      }
    },
    {
      "status": "429",
      "contentType": "application/problem+json",
      "example": {
        "detail": "Too many includes exist on contract ctr_1-12345.  You must delete an include before continuing.",
        "instance": "/papi/v1/includes?contractId=ctr_C-0N7RAC7&groupId=grp_12345#abc12345abcc02a7",
        "instanceKey": "1-12345",
        "limit": 500,
        "limitKey": "INCLUDES_PER_CONTRACT",
        "remaining": 0,
        "status": 429,
        "title": "Too many includes",
        "type": "https://problems.luna.akamaiapis.net/papi/v1/limit-exceeded"
      }
    },
    {
      "status": "500",
      "contentType": "application/problem+json",
      "example": {
        "detail": "Our system is experiencing errors. We''ll get this fixed as soon as possible.",
        "instance": "/papi/v1/properties/12345/activations#abc12345abcc02a7",
        "status": 500,
        "title": "Internal Server Error",
        "type": "https://problems.luna.akamaiapis.net/papi/proxy/internal-server-error"
      }
    }
  ]
}