• Home
  • History
  • Annotate
Name Date Size #Lines LOC

..20-Dec-2019-

config/H20-Dec-2019-539168

README.mdH A D20-Dec-20195.2 KiB164155

account.goH A D20-Dec-20195 KiB182132

acknowledgement.goH A D20-Dec-20195.3 KiB191137

alert.goH A D20-Dec-20193.8 KiB13295

annotation.goH A D20-Dec-20195.6 KiB224162

api.goH A D20-Dec-20199.9 KiB407299

broker.goH A D20-Dec-20193.7 KiB13294

check.goH A D20-Dec-20193 KiB12082

check_bundle.goH A D20-Dec-20197.8 KiB256186

check_bundle_metrics.goH A D20-Dec-20192.6 KiB9665

contact_group.goH A D20-Dec-20197.5 KiB264193

dashboard.goH A D20-Dec-201916.7 KiB401313

doc.goH A D20-Dec-20193.4 KiB641

graph.goH A D20-Dec-201913.9 KiB350273

maintenance.goH A D20-Dec-20195.8 KiB221160

metric.goH A D20-Dec-20194.3 KiB163118

metric_cluster.goH A D20-Dec-20196.5 KiB262193

outlier_report.goH A D20-Dec-20195.7 KiB222161

provision_broker.goH A D20-Dec-20194.9 KiB152109

rule_set.goH A D20-Dec-20196.2 KiB235172

rule_set_group.goH A D20-Dec-20196.1 KiB232167

user.goH A D20-Dec-20193.7 KiB160112

worksheet.goH A D20-Dec-20195.9 KiB235170

README.md

1## Circonus API package
2
3Full api documentation (for using *this* package) is available at [godoc.org](https://godoc.org/github.com/circonus-labs/circonus-gometrics/api). Links in the lists below go directly to the generic Circonus API documentation for the endpoint.
4
5### Straight [raw] API access
6
7* Get
8* Post (for creates)
9* Put (for updates)
10* Delete
11
12### Helpers for currently supported API endpoints
13
14> Note, these interfaces are still being actively developed. For example, many of the `New*` methods only return an empty struct; sensible defaults will be added going forward. Other, common helper methods for the various endpoints may be added as use cases emerge. The organization
15of the API may change if common use contexts would benefit significantly.
16
17* [Account](https://login.circonus.com/resources/api/calls/account)
18    * FetchAccount
19    * FetchAccounts
20    * UpdateAccount
21    * SearchAccounts
22* [Acknowledgement](https://login.circonus.com/resources/api/calls/acknowledgement)
23    * NewAcknowledgement
24    * FetchAcknowledgement
25    * FetchAcknowledgements
26    * UpdateAcknowledgement
27    * CreateAcknowledgement
28    * DeleteAcknowledgement
29    * DeleteAcknowledgementByCID
30    * SearchAcknowledgements
31* [Alert](https://login.circonus.com/resources/api/calls/alert)
32    * FetchAlert
33    * FetchAlerts
34    * SearchAlerts
35* [Annotation](https://login.circonus.com/resources/api/calls/annotation)
36    * NewAnnotation
37    * FetchAnnotation
38    * FetchAnnotations
39    * UpdateAnnotation
40    * CreateAnnotation
41    * DeleteAnnotation
42    * DeleteAnnotationByCID
43    * SearchAnnotations
44* [Broker](https://login.circonus.com/resources/api/calls/broker)
45    * FetchBroker
46    * FetchBrokers
47    * SearchBrokers
48* [Check Bundle](https://login.circonus.com/resources/api/calls/check_bundle)
49    * NewCheckBundle
50    * FetchCheckBundle
51    * FetchCheckBundles
52    * UpdateCheckBundle
53    * CreateCheckBundle
54    * DeleteCheckBundle
55    * DeleteCheckBundleByCID
56    * SearchCheckBundles
57* [Check Bundle Metrics](https://login.circonus.com/resources/api/calls/check_bundle_metrics)
58    * FetchCheckBundleMetrics
59    * UpdateCheckBundleMetrics
60* [Check](https://login.circonus.com/resources/api/calls/check)
61    * FetchCheck
62    * FetchChecks
63    * SearchChecks
64* [Contact Group](https://login.circonus.com/resources/api/calls/contact_group)
65    * NewContactGroup
66    * FetchContactGroup
67    * FetchContactGroups
68    * UpdateContactGroup
69    * CreateContactGroup
70    * DeleteContactGroup
71    * DeleteContactGroupByCID
72    * SearchContactGroups
73* [Dashboard](https://login.circonus.com/resources/api/calls/dashboard) -- note, this is a work in progress, the methods/types may still change
74    * NewDashboard
75    * FetchDashboard
76    * FetchDashboards
77    * UpdateDashboard
78    * CreateDashboard
79    * DeleteDashboard
80    * DeleteDashboardByCID
81    * SearchDashboards
82* [Graph](https://login.circonus.com/resources/api/calls/graph)
83    * NewGraph
84    * FetchGraph
85    * FetchGraphs
86    * UpdateGraph
87    * CreateGraph
88    * DeleteGraph
89    * DeleteGraphByCID
90    * SearchGraphs
91* [Metric Cluster](https://login.circonus.com/resources/api/calls/metric_cluster)
92    * NewMetricCluster
93    * FetchMetricCluster
94    * FetchMetricClusters
95    * UpdateMetricCluster
96    * CreateMetricCluster
97    * DeleteMetricCluster
98    * DeleteMetricClusterByCID
99    * SearchMetricClusters
100* [Metric](https://login.circonus.com/resources/api/calls/metric)
101    * FetchMetric
102    * FetchMetrics
103    * UpdateMetric
104    * SearchMetrics
105* [Maintenance window](https://login.circonus.com/resources/api/calls/maintenance)
106    * NewMaintenanceWindow
107    * FetchMaintenanceWindow
108    * FetchMaintenanceWindows
109    * UpdateMaintenanceWindow
110    * CreateMaintenanceWindow
111    * DeleteMaintenanceWindow
112    * DeleteMaintenanceWindowByCID
113    * SearchMaintenanceWindows
114* [Outlier Report](https://login.circonus.com/resources/api/calls/outlier_report)
115    * NewOutlierReport
116    * FetchOutlierReport
117    * FetchOutlierReports
118    * UpdateOutlierReport
119    * CreateOutlierReport
120    * DeleteOutlierReport
121    * DeleteOutlierReportByCID
122    * SearchOutlierReports
123* [Provision Broker](https://login.circonus.com/resources/api/calls/provision_broker)
124    * NewProvisionBroker
125    * FetchProvisionBroker
126    * UpdateProvisionBroker
127    * CreateProvisionBroker
128* [Rule Set](https://login.circonus.com/resources/api/calls/rule_set)
129    * NewRuleset
130    * FetchRuleset
131    * FetchRulesets
132    * UpdateRuleset
133    * CreateRuleset
134    * DeleteRuleset
135    * DeleteRulesetByCID
136    * SearchRulesets
137* [Rule Set Group](https://login.circonus.com/resources/api/calls/rule_set_group)
138    * NewRulesetGroup
139    * FetchRulesetGroup
140    * FetchRulesetGroups
141    * UpdateRulesetGroup
142    * CreateRulesetGroup
143    * DeleteRulesetGroup
144    * DeleteRulesetGroupByCID
145    * SearchRulesetGroups
146* [User](https://login.circonus.com/resources/api/calls/user)
147    * FetchUser
148    * FetchUsers
149    * UpdateUser
150    * SearchUsers
151* [Worksheet](https://login.circonus.com/resources/api/calls/worksheet)
152    * NewWorksheet
153    * FetchWorksheet
154    * FetchWorksheets
155    * UpdateWorksheet
156    * CreateWorksheet
157    * DeleteWorksheet
158    * DeleteWorksheetByCID
159    * SearchWorksheets
160
161---
162
163Unless otherwise noted, the source files are distributed under the BSD-style license found in the LICENSE file.
164