# docker-restapi

> A simple API for programmatic access to the Docker RESTful API

Latest version **0.2.2** (published 2015-10-09) · MIT license · 0 weekly downloads

## Install

```sh
npm install docker-restapi
pnpm add docker-restapi
yarn add docker-restapi
bun add docker-restapi
```

## 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 | 2015-10-09 |
| First published | 2015-06-04 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Carl Winkler |
| Maintainers | seikho |
| Keywords | docker, rest, web, api, windows, linux, agnostic, node |

## Links

- npm: https://www.npmjs.com/package/docker-restapi
- Repository: https://github.com/seikho/docker-api
- Issues: https://github.com/seikho/docker-api/issues
- npm.io page: https://npm.io/package/docker-restapi

## Dependencies (1)

- [bluebird](https://npm.io/package/bluebird.md) ^2.9.27

## Alternatives

- [@opentelemetry/exporter-zipkin](https://npm.io/package/@opentelemetry/exporter-zipkin.md) — 14.8M weekly downloads
- [pusher-js](https://npm.io/package/pusher-js.md) — 2.0M weekly downloads
- [browserify](https://npm.io/package/browserify.md) — 1.7M weekly downloads
- [sqs-consumer](https://npm.io/package/sqs-consumer.md) — 1.7M weekly downloads
- [@sanity/eventsource](https://npm.io/package/@sanity/eventsource.md) — 930.8K weekly downloads

## Recent versions

- 0.2.2 (latest) — 2015-10-09
- 0.2.1 — 2015-06-04
- 0.2.0 — 2015-06-04
- 0.1.0 — 2015-06-04

## README

## An API for querying the Docker RESTful API

#### Installation
```
npm install docker-restapi 
```

#### Usage

The API is a function that sends a request to the RESTful API and returns a promise.  
The promise resolves with the JSON parsed result or is rejected if an error was encountered.

```javascript

var docker = require("docker-restapi");
docker.get("/images/json") // GET request by default
  .then(function(images) {
	  // ...
  });
  
docker.post("/containers/create") // Specify POST for POST requests
.then(function(results) {
	  // ...
  });
```

#### TODO

API configuration:
* End-point (url)
* SSL information (path)
* API version target (defaults to v1.18)

JavaScript Wrapper of the v1.18 Docker REST Api

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