Akamai · Example Payload

Akamai Get Property Version Example

CDNCloudEdge ComputingNetworksPlatformSecurity

Akamai Get Property Version 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-version",
  "method": "GET",
  "path": "/properties/{propertyId}/versions/{propertyVersion}",
  "summary": "Akamai Get a Property Version",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "accountId": "act_A-CCT7890",
        "assetId": "aid_101",
        "contractId": "ctr_C-0N7RAC7",
        "groupId": "grp_15225",
        "propertyId": "prp_173136",
        "propertyName": "981.catalog.amenai.net",
        "versions": {
          "items": [
            {
              "etag": "71573b922a87abc3",
              "note": "initial version",
              "productId": "prd_Alta",
              "productionStatus": "ACTIVE",
              "propertyVersion": 1,
              "ruleFormat": "latest",
              "stagingStatus": "INACTIVE",
              "updatedByUser": "mrossi",
              "updatedDate": "2014-03-04T21:12:57Z"
            }
          ]
        }
      }
    },
    {
      "status": "200",
      "contentType": "text/xml",
      "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<configs xmlns:cache=\"uri:akamai.com/metadata/cache/5.0\" xmlns:edgeservices=\"uri:akamai.com/metadata/edgeservices/5.0\" xmlns:config=\"uri:akamai.com/metadata/config/5.0\" xmlns:network=\"uri:akamai.com/metadata/network/5.0\" xmlns:auth=\"uri:akamai.com/metadata/auth/5.0\" xmlns:match=\"uri:akamai.com/metadata/match/5.0\" xmlns:forward=\"uri:akamai.com/metadata/forward/5.0\" xmlns:comment=\"uri:akamai.com/metadata/comment/5.0\" xmlns:akamai=\"uri:akamai.com/metadata/akamai/5.0\" xmlns:security=\"uri:akamai.com/metadata/security/5.0\" xmlns:reporting=\"uri:akamai.com/metadata/reporting/5.0\" xmlns:edgecomputing=\"uri:akamai.com/metadata/edgecomputing/5.0\" xmlns:assign=\"uri:akamai.com/metadata/assign/5.0\">\n    <comment:note value=\"Property Manager generated metadata. XML engine version: 14.2.1\"/>\n    <comment:note value=\"Catalog version: 14.4.4\"/>\n    <comment:note value=\"Product name: Site_Accel\"/>\n    <comment:note value=\"Property name: example.com, version: 33\"/>\n    <comment:note value=\"Asset ID: 99999\"/>\n    <comment:note value=\"AcgID: \"/>\n    <comment:note value=\"AccountId: A-CCT3456\"/>\n    <comment:note value=\"Hostnames: www.example.com\"/>\n</configs>"
    },
    {
      "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"
      }
    }
  ]
}