circle-cli-api

API Plugin for CircleCI CLI

How to install this plugin

$ circle plugins:install circle-cli-api

Usage

$ 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