From 2251c3825938414d07fcb07d34034a1d9c557cd3 Mon Sep 17 00:00:00 2001 From: brettlangdon Date: Sat, 21 Mar 2015 09:39:16 -0400 Subject: [PATCH] remove docs from readme --- README.md | 91 ------------------------------------------------------- 1 file changed, 91 deletions(-) diff --git a/README.md b/README.md index 26d7293..b3cc743 100644 --- a/README.md +++ b/README.md @@ -45,97 +45,6 @@ var app = new dogapi(options); DD_API_KEY=YOUR_KEY_HERE DD_APP_KEY=YOUR_KEY_HERE node app.js ``` -## API - -`dogapi` implements all available functions in the official datadog api, http://docs.datadoghq.com/api/. - -* `dogapi.constants.STATUSES` - * `OK`, `WARNING`, `CRITICAL`, `UNKNOWN` -* `dogapi.stream(start, end, [[filter], callback])` - * function used to retrieve all events that have occured between -* `dogapi.polling_stream(interval, [[filter], callback])` - * function used to continuously call `stream` for new events -* `dogapi.get_event(event_id, callback)` - * method used to retrieve a single event's data -* `dogapi.add_event(event, callback)` - * method used to add a new event to datadog -* `dogapi.add_comment(comment, [callback])` - * method used to add a new comment to datadog -* `dogapi.update_comment(comment_id, comment, callback)` - * method used to update a comment that already exists in datadog -* `dogapi.delete_comment(comment_id, callback)` - * method used to remove a comment from datadog -* `dogapi.add_alert(alert, [callback])` - * add a new alert to datadog -* `dogapi.update_alert(alert_id, alert, [callback])` - * update an existing alert -* `dogapi.get_alert(alert_id, [callback])` - * get the details of an alert from the given id -* `dogapi.delete_alert(alert_id, [callback])` - * delete the given alert from datadog -* `dogapi.get_all_alerts([callback])` - * get the details of all alerts in datadog -* `dogapi.mute_alerts([callback])` - * mute all alerts -* `dogapi.unmute_alerts([callback])` - * unmute all alerts -* `dogapi.get_dashboard(dash_id, [callback])` - * method to get a single dashboard information -* `dogapi.get_all_dashboards([callback])` - * method to retrieve all dashboards in datadog -* `dogapi.create_dashboard(dashboard, [callback])` - * method used to create a new dashboard in datadog -* `dogapi.update_dashboard(dash_id, dashboard, [callback])` - * method used to update the dashboard with the provided `dash_id` -* `dogapi.delete_dashboard(dash_id, [callback])` - * method to remove a dashboard from datadog -* `dogapi.get_screenboard(screen_id, [callback])` - * method to get a single screenboard information -* `dogapi.get_all_screenboards([callback])` - * method to retrieve all screenboards in datadog -* `dogapi.create_screenboard(screenboard, [callback])` - * method used to create a new screenboard in datadog -* `dogapi.update_screenboard(screen_id, screenboard, [callback])` - * method used to update the screenboard with the provided `screen_id` -* `dogapi.delete_screenboard(screen_id, [callback])` - * method to remove a screenboard from datadog -* `dogapi.search(query, [callback])` - * method used to query the api for `metrics` or `hosts` -* `dogapi.add_metric(metric, [callback])` - * method used to add a single metric to datadog -* `dogapi.add_metrics(metrics, [callback])` - * method used to add multiple metrics to datadog -* `dogapi.all_tags([[source], callback])` - * method to get all the tags in datadog -* `dogapi.host_tags(host, [[source], callback])` - * method to get the tags associated with a given `host` -* `dogapi.host_tags_by_source(host, [[source], callback])` - * method to return the tags associated with a host, arranged by source -* `dogapi.add_tags(host, tags, [[source], callback])` - * add new tags to given `host` -* `dogapi.update_tags(host, tags, [[source], callback])` - * update the tags associated with the given `host` -* `dogapi.detach_tags(host, [[source], callback])` - * method to remove tags for a given `host` -* `dogapi.add_snapshot(snapshot, [callback])` - * method used to take a snapshot of a datadog graph -* `dogapi.add_snapshot_from_def(snapshot, [callback])` - * method used to take a snapshot of a datadog graph -* `dogapi.snapshot_status(snapshot_url, [callback])` - * method used to check the status of a datadog snapshot -* `dogapi.service_check(status, check, host, [[extra], [callback]])` - * method used to post a new service check (see `dogapi.constants.STATUSES`) -* `dogapi.schedule_downtime(scope, [options], [callback])` - * method to schedule a new downtime -* `dogapi.update_downtime(downtime_id, [options], [callback])` - * method to update an existing downtime -* `dogapi.cancel_downtime(downtime_id, [callback])` - * method to cancel an existing downtime -* `dogapi.get_downtime(downtime_id, [callback])` - * method to get an existing downtime -* `dogapi.get_all_downtimes([current_only], [callback])` - * method to get all downtimes - ## Sample Usage: **Example:** get all events since this time yesterday: