Configuration Integration API

Project Status:



January 1, 2020

Estimated Completion:

November 1, 2020
  • Home
  • Configuration Integration API

Share this page:

Share on facebook
Share on twitter
Share on linkedin
Share on email
Share on print

Problem Statement

Managing caching configurations for both CDN providers and Open Caching Nodes introduces the potential for errors (i.e., mismatched configurations). A single, unifying method to manage configurations across all delivery providers can not only mitigate potential errors but also reduce the required time to deploy configurations to multiple networks.

Project Description

Cache configurations must be made on a per-CDN basis. This can result in a lot of duplicative effort as well as introduce the potential for errors. For example, what if a configuration is applied to the wrong CDN? It is critical for network operations personnel to be able to ensure that the correct CDN configuration is applied to the caches of each delivery partner. To make that happen, the mechanism to push configurations must be unified and programmatic. The best way to accomplish that would be through an Application Programming Interface (API) that handles a majority of the features necessary to configure a caching solution for content providers. Enabling cache configuration deployment in this manner would enable configurations to be applied to CDNs and Open Caching Nodes simultaneously and in a manner that mitigates the potential for human error.

Current Document

There is not a document currently associated with this project.

Goals and Objectives

This project has the following goals and objectives:
  • To define an API specification that provides for the deployment and management of cache configurations across multiple CDN providers and Open Caching Nodes.

Project Scope

The API specification produced by this project will PROVIDE:
  • A list of supported cache configuration features
  • Description of a programmatic method by which to deploy configurations to different caching systems
  • Programmatic methods for error detection and error correction in configuration deployment
  • A data structure and recommended container for configuration representation
The API specification will NOT PROVIDE:
  • Any specific programming languages that should be used to extract metrics
  • Any support for configuration features not specifically listed and addressed by methods within the API


The following members have contributed to this project. Click on their name to visit their profile. If the have not published their profile, the link will redirect to their LinkedIn profile.

Additional References


The following presentations delivered during Open Caching working group sessions may provide additional information about this project.
Scroll to Top