# heroku-api-plugin

> access the Heroku API directly

Latest version **2.1.7** (published 2018-04-25) · ISC license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install heroku-api-plugin
pnpm add heroku-api-plugin
yarn add heroku-api-plugin
bun add heroku-api-plugin
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 2.1.7 |
| Published | 2018-04-25 |
| First published | 2015-07-01 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 11 |
| Unpacked size | 9.2 KB |
| Known vulnerabilities | 0 (+2 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 33 |
| Author | Jeff Dickey @dickeyxxx |
| Maintainers | dickeyxxx, markpundsack, ransombriggs, rasphilco, rwz, uhoh-itsmaciek |
| Keywords | heroku-plugin |

## Links

- npm: https://www.npmjs.com/package/heroku-api-plugin
- Repository: https://github.com/heroku/heroku-api-plugin
- Issues: https://github.com/heroku/heroku-api-plugin/issues
- npm.io page: https://npm.io/package/heroku-api-plugin

## Dependencies (11)

- [tmp](https://npm.io/package/tmp.md) 0.0.33
- [cli-ux](https://npm.io/package/cli-ux.md) ^3.3.23
- [fs-extra](https://npm.io/package/fs-extra.md) 5.0.0
- [get-stdin](https://npm.io/package/get-stdin.md) 5.0.1
- [http-call](https://npm.io/package/http-call.md) ^5.0.2
- [edit-string](https://npm.io/package/edit-string.md) 1.1.5
- [@oclif/config](https://npm.io/package/@oclif/config.md) ^1.3.55
- [@oclif/errors](https://npm.io/package/@oclif/errors.md) ^1.0.2
- [@oclif/command](https://npm.io/package/@oclif/command.md) ^1.3.1
- [@heroku-cli/color](https://npm.io/package/@heroku-cli/color.md) ^1.1.3
- [@heroku-cli/command](https://npm.io/package/@heroku-cli/command.md) ^8.0.0-oclif.2

## Recent versions

- 2.1.7 (latest) — 2018-04-25
- 2.1.6 — 2018-02-17
- 2.1.5 — 2018-02-16
- 2.1.4 — 2017-10-12
- 2.1.3 — 2017-08-03
- 2.1.2 — 2017-07-21
- 2.1.1 — 2017-07-19
- 2.1.0 — 2017-07-07
- 2.0.1 — 2017-07-07
- 2.0.0 — 2017-07-07
- 1.2.3 — 2017-07-07
- 1.2.2 — 2017-06-23
- 1.1.2 — 2017-05-30
- 1.1.1 — 2017-05-22
- 1.1.0 — 2017-03-27
- … 4 more at https://npm.io/package/heroku-api-plugin/versions

## README

# API Plugin for Heroku Toolbelt [![Circle CI](https://circleci.com/gh/heroku/heroku-api-plugin/tree/master.svg?style=svg)](https://circleci.com/gh/heroku/heroku-api-plugin/tree/master)

[![npm version](https://badge.fury.io/js/heroku-api-plugin.svg)](http://badge.fury.io/js/heroku-api-plugin)
[![codecov](https://codecov.io/gh/heroku/heroku-api-plugin/branch/master/graph/badge.svg)](https://codecov.io/gh/heroku/heroku-api-plugin)
[![CircleCI](https://circleci.com/gh/heroku/heroku-api-plugin/tree/master.svg?style=svg)](https://circleci.com/gh/heroku/heroku-api-plugin/tree/master)
[![Build status](https://ci.appveyor.com/api/projects/status/9i6wk4i1pe2hsss0/branch/master?svg=true)](https://ci.appveyor.com/project/Heroku/heroku-api-plugin/branch/master)

## How to install this plugin

```shell
$ heroku plugins:install heroku-api-plugin
```

## Usage

```shell
$ heroku api [--version VERSION] METHOD PATH
```

  The api command is a convenient but low-level way to send requests
  to the Heroku API. It sends an HTTP request to the Heroku API
  using the given method on the given path. For methods PUT, PATCH,
  and POST, it uses stdin unmodified as the request body. It prints
  the response unmodified on stdout.

  Method name input will be upcased, so both 'heroku api GET /apps' and
  'heroku api get /apps' are valid commands.

  Examples:

      $ heroku api GET /apps/myapp
      { created_at: "2011-11-11T04:17:13-00:00",
        id: "12345678-9abc-def0-1234-456789012345",
        name: "myapp",
        …
      }

      $ heroku api -v 3.variant /apps
      # Something different

      $ export HEROKU_HEADERS
      $ HEROKU_HEADERS='
      Content-Type: application/x-www-form-urlencoded
      Accept: application/json
      '
      $ printf 'type=web&qty=2' | heroku api POST /apps/myapp/ps/scale
      2

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