1// Copyright 2016 Circonus, Inc. All rights reserved. 2// Use of this source code is governed by a BSD-style 3// license that can be found in the LICENSE file. 4 5/* 6Package api provides methods for interacting with the Circonus API. See the full Circonus API 7Documentation at https://login.circonus.com/resources/api for more information. 8 9Raw REST methods 10 11 Get - retrieve existing item(s) 12 Put - update an existing item 13 Post - create a new item 14 Delete - remove an existing item 15 16Endpoints (supported) 17 18 Account https://login.circonus.com/resources/api/calls/account 19 Acknowledgement https://login.circonus.com/resources/api/calls/acknowledgement 20 Alert https://login.circonus.com/resources/api/calls/alert 21 Annotation https://login.circonus.com/resources/api/calls/annotation 22 Broker https://login.circonus.com/resources/api/calls/broker 23 Check https://login.circonus.com/resources/api/calls/check 24 Check Bundle https://login.circonus.com/resources/api/calls/check_bundle 25 Check Bundle Metrics https://login.circonus.com/resources/api/calls/check_bundle_metrics 26 Contact Group https://login.circonus.com/resources/api/calls/contact_group 27 Dashboard https://login.circonus.com/resources/api/calls/dashboard 28 Graph https://login.circonus.com/resources/api/calls/graph 29 Maintenance [window] https://login.circonus.com/resources/api/calls/maintenance 30 Metric https://login.circonus.com/resources/api/calls/metric 31 Metric Cluster https://login.circonus.com/resources/api/calls/metric_cluster 32 Outlier Report https://login.circonus.com/resources/api/calls/outlier_report 33 Provision Broker https://login.circonus.com/resources/api/calls/provision_broker 34 Rule Set https://login.circonus.com/resources/api/calls/rule_set 35 Rule Set Group https://login.circonus.com/resources/api/calls/rule_set_group 36 User https://login.circonus.com/resources/api/calls/user 37 Worksheet https://login.circonus.com/resources/api/calls/worksheet 38 39Endpoints (not supported) 40 41 Support may be added for these endpoints in the future. These endpoints may currently be used 42 directly with the Raw REST methods above. 43 44 CAQL https://login.circonus.com/resources/api/calls/caql 45 Check Move https://login.circonus.com/resources/api/calls/check_move 46 Data https://login.circonus.com/resources/api/calls/data 47 Snapshot https://login.circonus.com/resources/api/calls/snapshot 48 Tag https://login.circonus.com/resources/api/calls/tag 49 Template https://login.circonus.com/resources/api/calls/template 50 51Verbs 52 53 Fetch singular/plural item(s) - e.g. FetchAnnotation, FetchAnnotations 54 Create create new item - e.g. CreateAnnotation 55 Update update an item - e.g. UpdateAnnotation 56 Delete remove an item - e.g. DeleteAnnotation, DeleteAnnotationByCID 57 Search search for item(s) - e.g. SearchAnnotations 58 New new item config - e.g. NewAnnotation (returns an empty item, 59 any applicable defaults defined) 60 61 Not all endpoints support all verbs. 62*/ 63package api 64