# circle-cli-api

> access the CircleCI API directly

Latest version **0.3.0** (published 2016-01-29) · ISC license · 0 weekly downloads

## Install

```sh
npm install circle-cli-api
pnpm add circle-cli-api
yarn add circle-cli-api
bun add circle-cli-api
```

## 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.3.0 |
| Published | 2016-01-29 |
| First published | 2016-01-19 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Author | Mark Pundsack @markpundsack |
| Maintainers | markpundsack |
| Keywords | circle-plugin |

## Links

- npm: https://www.npmjs.com/package/circle-cli-api
- Repository: https://github.com/circleci/circle-cli-api
- Homepage: https://github.com/circleci/circle-cli-api#readme
- Issues: https://github.com/circleci/circle-cli-api/issues
- npm.io page: https://npm.io/package/circle-cli-api

## Dependencies (4)

- [co](https://npm.io/package/co.md) ^4.6.0
- [co-fs](https://npm.io/package/co-fs.md) ^1.2.0
- [request](https://npm.io/package/request.md) ^2.67.0
- [circle-cli-util](https://npm.io/package/circle-cli-util.md) ^1.2.0

## Recent versions

- 0.3.0 (latest) — 2016-01-29
- 0.2.0 — 2016-01-19

## README

# API Plugin for CircleCI CLI [![Circle CI](https://circleci.com/gh/circleci/circle-cli-api/tree/master.svg?style=svg)](https://circleci.com/gh/circleci/circle-cli-api/tree/master)

[![npm version](https://badge.fury.io/js/circle-cli-api.svg)](http://badge.fury.io/js/circle-cli-api)

## How to install this plugin

```
$ circle plugins:install circle-cli-api
```

## Usage

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

  The api command is a convenient but low-level way to send requests
  to the CircleCI API. It sends an HTTP request to the CircleCI 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 up-cased, so both 'circle api GET /apps' and
  'circle api get /apps' are valid commands.

  Examples:

      $ circle api GET /projects
      [ {
        "vcs_url": "https://github.com/circleci/mongofinil",
        "followed": true, // true if you follow this project in CircleCI
        "username": "circleci",
        "reponame": "mongofinil",
        "branches" : {
          "master" : {
            "pusher_logins" : [ "pbiggar", "arohner" ], // users who have pushed
            "last_non_success" : { // last failed build on this branch
              "pushed_at" : "2013-02-12T21:33:14Z",
              "vcs_revision" : "1d231626ba1d2838e599c5c598d28e2306ad4e48",
              "build_num" : 22,
              "outcome" : "failed",
              },
            "last_success" : { // last successful build on this branch
              "pushed_at" : "2012-08-09T03:59:53Z",
              "vcs_revision" : "384211bbe72b2a22997116a78788117b3922d570",
              "build_num" : 15,
              "outcome" : "success",
              },
            "recent_builds" : [ { // last 5 builds, ordered by pushed_at (decreasing)
              "pushed_at" : "2013-02-12T21:33:14Z",
              "vcs_revision" : "1d231626ba1d2838e599c5c598d28e2306ad4e48",
              "build_num" : 22,
              "outcome" : "failed",
              }, {
              "pushed_at" : "2013-02-11T03:09:54Z",
              "vcs_revision" : "0553ba86b35a97e22ead78b0d568f6a7c79b838d",

              "build_num" : 21,
              "outcome" : "failed",
              }, ... ],
            "running_builds" : [ ] // currently running builds
          }
        }
      }, ... ]

      $ circle api -v 2 /projects
      # Something different

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

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