# @pixul/node-kong-api

> Kong Api Client in NodeJS

Latest version **1.0.2** (published 2017-11-06) · ISC license · 0 weekly downloads

## Install

```sh
npm install @pixul/node-kong-api
pnpm add @pixul/node-kong-api
yarn add @pixul/node-kong-api
bun add @pixul/node-kong-api
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.2 |
| Published | 2017-11-06 |
| First published | 2017-11-06 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Known vulnerabilities | 0 (+2 in 2 direct dependencies) |
| Install scripts | no |
| Author | Daniel Cole |
| Maintainers | optii, yoannma |

## Links

- npm: https://www.npmjs.com/package/@pixul/node-kong-api
- npm.io page: https://npm.io/package/@pixul/node-kong-api

## Dependencies (5)

- [joi](https://npm.io/package/joi.md) ^13.0.1
- [lodash](https://npm.io/package/lodash.md) ^4.17.4
- [request](https://npm.io/package/request.md) ^2.83.0
- [querystring](https://npm.io/package/querystring.md) ^0.2.0
- [request-promise](https://npm.io/package/request-promise.md) ^4.2.2

## Recent versions

- 1.0.2 (latest) — 2017-11-06
- 1.0.1 — 2017-11-06
- 1.0.0 — 2017-11-06

## README

# Kong Node Client

A Node Kong Api Client using Promises

## Installation

```
 npm i -s node-kong-api
```

## Usage


```javascript
    const Kong = require('javascript-kong-api');


    let kong = new Kong({
        url: 'http://10.42.79.233:8001'
    });


    kong.listApis({}).then(data => {
        // do Something with the data
    }).catch(err => {
        // do something with the error
    });

```

## Available methods

```javascript
kong.getjavascriptInformation()
```

```javascript
kong.getjavascriptStatus()
```

```javascript
kong.addApi(api)
```

```javascript
kong.getApi(nameOrId)
```

```javascript
kong.listApis(query)
```

```javascript
kong.updateApi(nameOrId, api)
```

```javascript
kong.updateOrCreateApi(api)
```

```javascript
kong.deleteApi(nameOrId)
```

```javascript
kong.addConsumer(consumer)
```

```javascript
kong.getConsumer(nameOrId)
```

```javascript
kong.listConsumers(query)
```

```javascript
kong.updateConsumer(usernameOrId, consumer)
```

```javascript
kong.updateOrCreateConsumer(consumer)
```

```javascript
kong.deleteConsumer(usernameOrId)
```

```javascript
kong.addPluginToApi(apiNameOrId, plugin)
```

```javascript
kong.addPluginToAllApis(plugin)
```

```javascript
kong.getPlugin(id)
```

```javascript
kong.listPlugins(query)
```

```javascript
kong.listPluginsForApi(nameOrId, query)
```

```javascript
kong.updatePlugin(apiNameOrId, pluginNameOrId, plugin)
```

```javascript
kong.updateOrCreatePlugin(apiNameOrId, plugin)
```

```javascript
kong.deletePlugin(apiNameOrId, pluginNameOrId)
```

```javascript
kong.getEnabledPlugins()
```

```javascript
kong.getPluginSchema(pluginName)
```

```javascript
kong.addCertificate(certificate)
```

```javascript
kong.getCertificate(sniOrId)
```

```javascript
kong.listCertificates()
```

```javascript
kong.updateCertificate(sniOrId, certificate)
```

```javascript
kong.updateOrCreateCertificate(certificate)
```

```javascript
kong.deleteCertificate(sniOrId)
```

```javascript
kong.addSNI(sni)
```

```javascript
kong.getSNI(name)
```

```javascript
kong.listSNIs()
```

```javascript
kong.updateSNI(name, sni)
```

```javascript
kong.updateOrCreateSNI(sni)
```

```javascript
kong.deleteSNI(name)
```

```javascript
kong.addUpstream(upstream)
```

```javascript
kong.getUpstream(nameOrId)
```

```javascript
kong.listUpstreams(query)
```

```javascript
kong.updateUpstream(nameOrId, upstream)
```

```javascript
kong.updateOrCreateUpstream(upstream)
```

```javascript
kong.deleteUpstream(nameOrId)
```

```javascript
kong.addTarget(upstreamNameOrId, target)
```

```javascript
kong.listTargets(upstreamNameOrId, query)
```

```javascript
kong.listActiveTargets(upstreamNameOrId)
```

```javascript
kong.deleteTarget(upstreamNameOrId, targetOrId)
```

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