DocumentationDynamic Media Image Production System API

cdnCacheInvalidation

Last update: Fri Nov 03 2023 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • Developer
  • Admin

Forwards the supplied list of URLs to the Dynamic Media CDN (Content Distribution Network) provider to invalidate their existing cache of HTTP responses.

cdnCacheInvalidation: About

CDN cache invalidation forces all HTTP requests for these URLs to be revalidated against the current published data on the Dynamic Media network after this invalidation request is processed through the CDN network. Any URLs that are not connected to the Dynamic Media service URL structure and directly matching the Dynamic Media company root ID assigned when the company is created result in an API fault for the entire request. Any invalid URLs that the CDN does not support that it considers invalid also results in an API fault for the entire request.

Frequency of Use: Rules

The rules governing the frequency of the use of this feature are controlled by Dynamic Media’s CDN partners. The CDN retains the discretion to degrade the responsiveness of these invalidations to maintain optimum performance of its service to its users. Should Dynamic Media be notified of overuse of this feature, Adobe must resort to disabling the feature on either a per company basis or entirely across the service.

Confirmation Emails

Confirmation emails from the Dynamic Media CDN partner can be sent to the list’s creator or up to 5 other email addresses. The API sends the confirmation when the entire CDN network has been notified that the URLs referenced in the email have been cleared. A single call to cdnCacheInvalidation can send multiple emails if the number of URLs supplied exceed the number that Dynamic Media can deliver to the CDN partner on a single notification. Currently, that would be if the request exceeds 100 URLs, but is subject to change based at the request of the CDN partner.

Supported Since

6.0

Authorized User Types

  • IpsAdmin
  • IpsCompanyAdmin

Parameters

Input ( cdnCacheInvalidationParam)

Name
Type
Required
Description
companyHandle
xsd:string
Yes
The handle to the company connected with the URLs to invalidate.
urlArray
types:UrlArray
Yes
List of up to 1000 URLs to invalidate from the CDN cache. All URLS must contain the Dynamic Media company root ID to be invalidated.

Output( cdnCacheInvalidationReturn)

Name
Type
Required
Description
invalidationHandle
xsd:string
Yes

A handle referencing the purge request.

The cdnCacheInvalidation API now invalidates the cache almost immediately (~5 seconds). As such, polling for invalidation status is generally no longer required.

estimatedSeconds
xsd:int
Yes
Estimated seconds to completion of the purge request. Clients should wait for this time before polling status.

Example

This example requests four URLs to be invalidated in the CDN cache. The response contains summary counts of the success of the operations and a list of error details supplied directly from the CDN to assist the client in use of this feature.

getCdnCacheInvalidationStatus operation.

Request

<cdnCacheInvalidationParam xmlns="http://www.scene7.com/IpsApi/xsd/2012-02-14">
   <companyHandle>c|6</companyHandle>
   <urlArray>
       <items>http://s7d7.scene7.com/is/image/JJEsquire/11008047?$thumbnail$</items>
       <items>http://s7d7.scene7.com/is/image/JJEsquire/11008047?$product$</items>
       <items>http://s7d7.scene7.com/is/image/JJEsquire/11008047?$large$</items>
       <items>http://s7d7.scene7.com/is/image/JJEsquire/ImageSetConfigDefaults?req=userdata</items>
    </urlArray>
</cdnCacheInvalidationParam>

Response

<cdnCacheInvalidationReturn xmlns="http://www.scene7.com/IpsApi/xsd/2012-02-14">
   <successCount>4</successCount>
   <warningCount>0</warningCount>
   <errorCount>0</errorCount>
</cdnCacheInvalidationReturn>
4e9b9d8c-5839-4215-aa35-01b652869681