Skip to content
Ruby client library for the Circonus API
Ruby
Find file
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
bin
lib
.gitignore
Gemfile
LICENSE.txt
README.md
Rakefile
circonus-api.gemspec

README.md

Circonus::Api

This is a gem for interacting with the Circonus API.

Installation

Add this line to your application's Gemfile:

gem 'circonus-api'

And then execute:

$ bundle

Or install it yourself as:

$ gem install circonus-api

Usage

This gem provides a pretty simple interface to the Circonus API.

# you can also set CIRCONUS_APP_NAME and CIRCONUS_API_TOKEN env vars and
# not pass any arguments.
api = Circonus::Api.new(app_name, api_token)

# Each resource has the following methods, using Accounts as an example
api.list_accounts
api.show_account(id)
api.create_account(json_data)
api.update_account(id, json_data)
api.delete_account(id)

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request
Something went wrong with that request. Please try again.