Communication with Akamai's REST API
node-akamai allows for easy communication with Akamai's REST CCU API to purge/invalidate cached objects.
npm install akamai
var akamai = ;akamai;// ===akamaiinvalidatestaging;
See more examples:
Create a purge request. Returns a promise.
Username of account with access to API.
Password for that account.
Array of strings representing the full urls/cpcodes of the content you wish to be purged. Depending on the options.type value, this array can represent cpcode names to be purged/invalidated.
typeOf urls. They can be urls or cpcodes.
domainThe network to target your request.
In the result of the request's promise, the response will contain a
.status function that is pre-configured to execute a
AkamaiStatus request with the purge request's
This library offers a more readable way to set the options for a API request. See constants.js. At the root level of this library only the following modifiers are available:
All modifier functions only take username, password, and objects as arguments.
Make a request to check the length of the queue. Returns a promise.
Make a request to check status of a given progressUri. Returns a promise.
Note, that if you are using this within a purge request, you will be able to execute
response.status() to retrieve a request's status in Akamai's queue.
.statusat the module level. Thanks @alex-alexandrescu
AkamaiStatusin the response of a purge.
Please use GitHub's issue tracker.
Node-Akamai is available under the MIT license
Copyright (c) 2014 Julian LanniganPermission is hereby granted, free of charge, to any person obtaining a copyof this software and associated documentation files (the "Software"), to dealin the Software without restriction, including without limitation the rightsto use, copy, modify, merge, publish, distribute, sublicense, and/or sellcopies of the Software, and to permit persons to whom the Software isfurnished to do so, subject to the following conditions:The above copyright notice and this permission notice shall be included inall copies or substantial portions of the Software.THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS ORIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THEAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHERLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS INTHE SOFTWARE.