Communication with Akamai's REST API

Akamai API for Node.js

node-akamai allows for easy communication with Akamai's REST CCU API to purge/invalidate cached objects.

npm install akamai
var akamai = require('akamai');
akamai.purge('john@example.com', '...', [
], {domain: 'staging', action: 'invalidate'}).then(function (response) {
}).catch(function (err) {
// === 
akamai.invalidate.staging.url('john@example.com', '...', [
]).then(function (response) {
}).catch(function (err) {

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.

  • type Of urls. They can be urls or cpcodes.
    • arl [Default]
    • cpcode
  • domain The network to target your request.
    • production [Default]
    • staging
  • action
    • remove [Default]
    • invalidate

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 progressUri.

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:

  • remove
  • invalidate
  • purge

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.

  • Exposed AkamaiStatus as .status at the module level. Thanks @alex-alexandrescu
  • Updated documentation to better explain the usage of AkamaiStatus in the response of a purge.

Please use GitHub's issue tracker.

Node-Akamai is available under the MIT license

Copyright (c) 2014 Julian Lannigan
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.