# keycdn

> Node.js package for the KeyCDN API

Latest version **0.2.2** (published 2018-08-29) · MIT license · 0 weekly downloads

## Install

```sh
npm install keycdn
pnpm add keycdn
yarn add keycdn
bun add keycdn
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.2 |
| Published | 2018-08-29 |
| First published | 2015-04-06 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 12.6 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 16 |
| Author | KeyCDN |
| Maintainers | keycdn |
| Keywords | cdn, keycdn, content delivery network |

## Links

- npm: https://www.npmjs.com/package/keycdn
- Repository: https://github.com/keycdn/node-keycdn-api
- Homepage: https://www.keycdn.com
- Issues: https://github.com/keycdn/node-keycdn-api/issues
- npm.io page: https://npm.io/package/keycdn

## Dependencies (1)

- [request](https://npm.io/package/request.md) 2.x.x

## Recent versions

- 0.2.2 (latest) — 2018-08-29
- 0.2.1 — 2018-08-29
- 0.2.0 — 2015-11-21
- 0.1.2 — 2015-04-13
- 0.1.1 — 2015-04-06
- 0.1.0 — 2015-04-06

## README

# node-keycdn-api

Node.js package for the KeyCDN API

## Install

```
$ npm install keycdn
```

## Usage

#### Initialize

```
var KeyCDN = require('keycdn');
var keycdn = new KeyCDN('your_api_key');
```

#### `keycdn.get`

```
// get all zones
keycdn.get('zones.json', function(err, results) {
    if (err) {
        console.trace(err);
        return;
    }
    console.dir(results);
});

// purge zone cache
keycdn.get('zones/purge/' + zoneId + '.json', function(err, res) {
    console.log('GET zones/purge/' + zoneId + '.json');
    if (err) {
        // error handling
        console.trace(err);
    } else {
        // print results
        console.dir(res);
    }
});
```

#### `keycdn.put`

```
var zone = {
    name: 'node01',
    expire: 1440
};
keycdn.put('zones/<zoneId>.json', zone, function(err, res) {
    if (err) {
        console.trace(err);
        return;
    }
    console.dir(res);
});
```

#### `keycdn.post`

```
var zone = {
    name: 'node01',
    type: 'push'
};
keycdn.post('zones.json', zone, function(err, res) {
    if (err) {
        console.trace(err);
        return;
    }
    console.dir(res);
});
```

#### `keycdn.del`

```
var zoneId = '1234';

// delete zone
keycdn.del('zones/' + zoneId + '.json', function(err, res) {
    if (err) {
        console.trace(err);
        return;
    }
    if (res.status === 'success') {
        console.log('API call successful.');
    }
});

var purgeurl = {
    urls: [ 'demo-1.kxcdn.com/lorem.css', 'demo-1.kxcdn.com/lorem.jpg' ]
};

// purge single or multiple URLs
keycdn.del('zones/purgeurl/' + zoneId + '.json', purgeurl , function(err, res) {
    console.log('DEL zones/purgeurl/' + zoneId + '.json');
    if (err) {
        // error handling
        console.trace(err);
    } else {
        // print results
        console.dir(res);
    }
});

```


For more details visit https://www.keycdn.com

---
_Source: https://npm.io/package/keycdn · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._