# pm2-list-rest

> Module to expose `pm2 list` (process description list) as a REST API

Latest version **1.2.3** (published 2020-06-21) · WTFPL license · 0 weekly downloads

## Install

```sh
npm install pm2-list-rest
pnpm add pm2-list-rest
yarn add pm2-list-rest
bun add pm2-list-rest
```

## 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.2.3 |
| Published | 2020-06-21 |
| First published | 2020-02-06 |
| Weekly downloads | 0 |
| License | WTFPL |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 7.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Vincent GUILLOU |
| Maintainers | vguillou |

## Links

- npm: https://www.npmjs.com/package/pm2-list-rest
- Repository: https://github.com/vguillou/pm2-list-rest
- Issues: https://github.com/vguillou/pm2-list-rest/issues
- npm.io page: https://npm.io/package/pm2-list-rest

## Dependencies (3)

- [pm2](https://npm.io/package/pm2.md) latest
- [pmx](https://npm.io/package/pmx.md) latest
- [object.pick](https://npm.io/package/object.pick.md) latest

## Recent versions

- 1.2.3 (latest) — 2020-06-21
- 1.2.2 — 2020-02-08
- 1.2.1 — 2020-02-08
- 1.2.0 — 2020-02-08
- 1.1.0 — 2020-02-06
- 1.0.0 — 2020-02-06

## README

# pm2-list-rest

<a href="https://www.npmjs.com/package/pm2-list-rest"><img alt="npm" src="https://img.shields.io/npm/v/pm2-list-rest"></a>

_Module to expose `pm2 list` (process description list) as a REST API_

## Usage

#### Install or update

```pm2 install pm2-list-rest```

#### Call the REST API

```curl http://localhost:3999/pm2/list```

#### Options

- Change port (Default is `3999`)
  
  ```pm2 set pm2-list-rest:port 3999```

- Exclude processes by name (comma separated list. Default is `''`)
  
  ```pm2 set pm2-list-rest:exclude-processes 'pm2-list-rest, other-excluded-process'```

- Include a subset of `pm2_env` properties only (comma separated list. Default is `''`, which includes all properties)
  
  ```pm2 set pm2-list-rest:include-pm2-env-properties 'node_version, version, unstable_restarts'```

- Good defaults:

  ```sh
  pm2 set pm2-list-rest:exclude-processes 'pm2-list-rest'
  pm2 set pm2-list-rest:include-pm2-env-properties 'prev_restart_delay, exit_code, node_version, version, unstable_restarts, restart_time, created_at, pm_uptime, status,instances, exec_mode, pm_exec_path, max_memory_restart, merge_logs, autorestart, kill_retry_time, watch'
  ```

## Contribute

```sh
# Install dependencies
yarn install

# Install the module
pm2 install .

# Test it
curl http://localhost:3999/pm2/list

# Check module logs
pm2 logs pm2-list-rest

# Remove module
pm2 delete pm2-list-rest
```

## License

[WTFPL License](https://github.com/vguillou/pm2-list-rest/blob/master/LICENSE.md)

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