# vault-api

> Axios-like NodeJS API for Hashicorp Vault.

Latest version **1.1.2** (published 2023-10-03) · MIT License license · 0 weekly downloads

## Install

```sh
npm install vault-api
pnpm add vault-api
yarn add vault-api
bun add vault-api
```

## Health

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

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.2 |
| Published | 2023-10-03 |
| First published | 2021-11-04 |
| Weekly downloads | 0 |
| License | MIT License |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 21.1 KB |
| Known vulnerabilities | 0 (+23 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 11 |
| Author | Sai Hemanth Bheemreddy |
| Maintainers | saihemanthbr |
| Keywords | vault, secrets, manage, hashicorp, hashicorp-vault, vault-api, secrets-management, vaultproject, hashivault |

## Links

- npm: https://www.npmjs.com/package/vault-api
- Repository: https://github.com/SaiHemanthBR/vault-api
- Homepage: https://github.com/SaiHemanthBR/vault-api/wiki
- Issues: https://github.com/SaiHemanthBR/vault-api/issues
- npm.io page: https://npm.io/package/vault-api

## Dependencies (1)

- [axios](https://npm.io/package/axios.md) ^0.21.4

## Alternatives

- [@gemini-wallet/core](https://npm.io/package/@gemini-wallet/core.md) — 515.6K weekly downloads
- [utility](https://npm.io/package/utility.md) — 416.6K weekly downloads
- [@primno/dpapi](https://npm.io/package/@primno/dpapi.md) — 7.2K weekly downloads
- [pi-readseek](https://npm.io/package/pi-readseek.md) — 3.7K weekly downloads
- [@emilia-protocol/verify](https://npm.io/package/@emilia-protocol/verify.md) — 1.1K weekly downloads

## Recent versions

- 1.1.2 (latest) — 2023-10-03
- 1.1.1 — 2022-09-18
- 1.1.0 — 2021-12-28
- 1.0.0 — 2021-11-04

## README

# Vault-API

Axios-like NodeJS API for Hashicorp Vault.

## Installation

`vault-api` require Node.js >= v8.17.0.

```bash
npm install vault-api
```

## Basic Usage

Requests can be made by passing the relevant config to `vault` function.

##### Importing
```ts
import vault from 'vault-api';

// (or)
// import {vault} from 'vault-api';
// const {vault} = require('vault-api');
```

##### vault(config)
```ts
// Write data to vault
vault({
    method: 'write',
    path: 'secret/apiKey',
    data: {
        webApp: '5cfdf55e-cfa9-5da8-b2b2-64f30a462a09value'
    }
});
```

```ts
// Read data from vault
vault({
    method: 'read',
    path: 'secret/apiKey'
});
```

## Docs
  Documentation and guides are available at [Repo's Github Wiki](https://github.com/SaiHemanthBR/vault-api)

## Supported Secrets Engines
  * Key/Value Version 1
  * Key/Value Version 2

## Contributing
  See [CONTRIBUTING.md](./CONTRIBUTING.md) for Contributing guidelines.

## Code of Conduct
  See [CODE_OF_CONDUCT.md](./CODE_OF_CONDUCT.md) for Code of Conduct guidelines.

## License
  [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](./LICENSE.md)

  Checkout the project license at [LICENSE.md](./LICENSE.md).

## Credits
`vault-api` is heavily inspired by [`axios`](https://github.com/axios/axios). I was inspired by the simplicity of the `axios` and wanted to make a similar library for [Hashicorp Vault](https://www.vaultproject.io/). The ultimate goal of this library is to provide a simple, easy to use, extensible API for interacting with Hashicorp Vault. I hope you enjoy using it!

## Resources

* [Changelog](https://github.com/SaiHemanthBR/vault-api/blob/master/CHANGELOG.md)
* [Contributing Guide](https://github.com/SaiHemanthBR/vault-api/blob/master/CONTRIBUTING.md)
* [Code of Conduct](https://github.com/SaiHemanthBR/vault-api/blob/master/CODE_OF_CONDUCT.md)

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