Skip to content
Interactive circonus API client - update circonus configuration using your text editor
Find file
Latest commit 6b55f95 @postwait postwait Merge pull request #1 from Ben-Chapman/enable-api-appname
Enabling support for an API Application name


Circonusvi is an interactive command line client for circonus that lets you query the API, edit the results in a text editor, and apply the changes back to the server.


Run the following to install dependencies:

pip install -r requirements.txt


The API token is kept in .circonusapirc. Go to to set up a token.



If you use circonus inside, you can add a [hostnames] section to specify the hostname for the circonus inside API. For example:



  • General usage is:

    ./ [options] [PATTERN]
  • Pattern should be of the form key=pattern, where key is what you want to match on (such as target), and pattern is a regular expression. If any returned piece of data doesn't have the key (e.g. rules don't have targets), then it doesn't match
  • To search on nested keys (such as a check configuration), separate the key names with a underscore. E.g. to match on

    { "config": { "code": "200" ... } ... }

    (the above example is from a http check) you can use 'config_code=200'. If you need to match on list items, use numbers for the key. 0 for the first item, 1 for the second and so on.

  • Options are:
    • -a -- Specify which account to use
    • -d -- Enable debug mode
    • -c -- Don't resolve /broker/XXXX and add json 'comments'. By default, whenever an endpoint is encountered, it is resolved, and a friendly name is added in a comment above the real result. This isn't valid json, and comments are stripped before parsing. If you want to use the json elsewhere, you will want to disable the adding of comment lines.
    • -e -- Specify endpoints to search (can be used multiple times for several endpoints at once)
    • -E -- Specify an alternate editor to use (default: $EDITOR)
    • -l -- Don't query the API. Instead use the previous query results. Filtering still works on the previous results. This is useful if you made a mistake on the filter and want to fix it.
    • -u -- include underscore entries (e.g. _cid) in json output. By default they are hidden.
  • If you don't specify a pattern, then all entries are returned.
  • If you don't specify which endpoint to use, check_bundle is used by default.

In the editor

  • To change a value, just edit it and save the file, the changes will be sent back to circonus
  • To delete an entry, just remove it completely from the file
  • To add a new entry, add it to the end of the file. The key should be the endpoint you want to add, such as '"/check_bundle": { ....'. Unlike with a regular json file, you can repeat the same key multiple times to add several entries at once.
  • Once you exit the editor, you are given the opportunity to review the changes you made and re-edit the file if necessary.


  • View all check bundles on your account:

  • Filter the check bundles returned by name:

    ./ 'name=(foo|bar|baz).com HTTP'
  • Look up rulesets instead (and filter only those that are for metrics with 'duration' in the name:

    ./ -e rule_set metric_name=duration


  • I get the following error: TypeError: __init__() got an unexpected keyword argument 'object_pairs_hook'.
    • If you're using a python version earlier than 2.7, install the simplejson package. Circonusvi makes use of some features of the json parser that are new to Python 2.7, but earlier versions will work with simplejson instead.
Something went wrong with that request. Please try again.