Akamai · Example Payload

Akamai Post Property Activations Example

CDNCloudEdge ComputingNetworksPlatformSecurity

Akamai Post Property Activations 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": "post-property-activations",
  "method": "POST",
  "path": "/properties/{propertyId}/activations",
  "summary": "Akamai Activate or Deactivate a Property",
  "requestExamples": [
    {
      "contentType": "application/json",
      "example": {
        "network": "STAGING",
        "note": "Sample activation",
        "propertyVersion": 1,
        "useFastFallback": false,
        "acknowledgeWarnings": [
          "msg_baa4560881774a45b5fd25f5b1eab021d7c40b4f"
        ],
        "notifyEmails": [
          "you@example.com",
          "them@example.com"
        ]
      }
    }
  ],
  "responseExamples": [
    {
      "status": "201",
      "contentType": "application/json",
      "example": {
        "activationLink": "/papi/v0/properties/prp_173136/activations/atv_67037?contractId=ctr_C-0N7RAC7&groupId=grp_15225"
      }
    },
    {
      "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": "409",
      "contentType": "application/problem+json",
      "example": {
        "detail": "Another edit or activation request on same network in progress for this property version.",
        "instance": "papi/v1/properties/prp_123456/activations?contractId=ctr_C-0N7RAC7&groupId=grp_12345#abc12345abcc02a7",
        "status": 409,
        "title": "Operation failed",
        "type": "https://problems.luna.akamaiapis.net/papi/v1/resource-busy"
      }
    },
    {
      "status": "415",
      "contentType": "application/problem+json",
      "example": {
        "detail": "Our system does not support requests in the format you're sending.",
        "instance": "/papi/v1/properties?contractId=ctr_C-0N7RAC7&groupId=grp_12345#abc12345abcc02a7",
        "status": 415,
        "title": "Unsupported Media Type",
        "type": "https://problems.luna.akamaiapis.net/papi/v1/http/unsupported-media-type"
      }
    },
    {
      "status": "422",
      "contentType": "application/problem+json",
      "example": {
        "instance": "papi/v1/activations/#abc12345abcc02a7",
        "messageId": "property_activation_still_pending",
        "result": "ERROR",
        "status": 422,
        "title": "Property Manager Exception",
        "type": "https://problems.luna.akamaiapis.net/papi/v1/property_activation_still_pending",
        "params": [
          "Property 123456",
          "Version 1"
        ],
        "details": {},
        "errors": [
          {
            "detail": "property_activation_still_pending",
            "title": "Property Manager Exception",
            "type": "papi/v1/property_activation_still_pending"
          }
        ]
      }
    },
    {
      "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"
      }
    }
  ]
}