consul

History

…
..
config	…
README.md	…
account.go	…
acknowledgement.go	…
alert.go	…
annotation.go	…
api.go	…
broker.go	…
check.go	…
check_bundle.go	…
check_bundle_metrics.go	…
contact_group.go	…
dashboard.go	…
doc.go	…
graph.go	…
maintenance.go	…
metric.go	…
metric_cluster.go	…
outlier_report.go	…
provision_broker.go	…
rule_set.go	…
rule_set_group.go	…
user.go	…
worksheet.go	…

README.md

Circonus API package

Full api documentation (for using this package) is available at godoc.org. Links in the lists below go directly to the generic Circonus API documentation for the endpoint.

Straight [raw] API access

Get
Post (for creates)
Put (for updates)
Delete

Helpers for currently supported API endpoints

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 of the API may change if common use contexts would benefit significantly.

Account
- FetchAccount
- FetchAccounts
- UpdateAccount
- SearchAccounts
Acknowledgement
- NewAcknowledgement
- FetchAcknowledgement
- FetchAcknowledgements
- UpdateAcknowledgement
- CreateAcknowledgement
- DeleteAcknowledgement
- DeleteAcknowledgementByCID
- SearchAcknowledgements
Alert
- FetchAlert
- FetchAlerts
- SearchAlerts
Annotation
- NewAnnotation
- FetchAnnotation
- FetchAnnotations
- UpdateAnnotation
- CreateAnnotation
- DeleteAnnotation
- DeleteAnnotationByCID
- SearchAnnotations
Broker
- FetchBroker
- FetchBrokers
- SearchBrokers
Check Bundle
- NewCheckBundle
- FetchCheckBundle
- FetchCheckBundles
- UpdateCheckBundle
- CreateCheckBundle
- DeleteCheckBundle
- DeleteCheckBundleByCID
- SearchCheckBundles
Check Bundle Metrics
- FetchCheckBundleMetrics
- UpdateCheckBundleMetrics
Check
- FetchCheck
- FetchChecks
- SearchChecks
Contact Group
- NewContactGroup
- FetchContactGroup
- FetchContactGroups
- UpdateContactGroup
- CreateContactGroup
- DeleteContactGroup
- DeleteContactGroupByCID
- SearchContactGroups
Dashboard -- note, this is a work in progress, the methods/types may still change
- NewDashboard
- FetchDashboard
- FetchDashboards
- UpdateDashboard
- CreateDashboard
- DeleteDashboard
- DeleteDashboardByCID
- SearchDashboards
Graph
- NewGraph
- FetchGraph
- FetchGraphs
- UpdateGraph
- CreateGraph
- DeleteGraph
- DeleteGraphByCID
- SearchGraphs
Metric Cluster
- NewMetricCluster
- FetchMetricCluster
- FetchMetricClusters
- UpdateMetricCluster
- CreateMetricCluster
- DeleteMetricCluster
- DeleteMetricClusterByCID
- SearchMetricClusters
Metric
- FetchMetric
- FetchMetrics
- UpdateMetric
- SearchMetrics
Maintenance window
- NewMaintenanceWindow
- FetchMaintenanceWindow
- FetchMaintenanceWindows
- UpdateMaintenanceWindow
- CreateMaintenanceWindow
- DeleteMaintenanceWindow
- DeleteMaintenanceWindowByCID
- SearchMaintenanceWindows
Outlier Report
- NewOutlierReport
- FetchOutlierReport
- FetchOutlierReports
- UpdateOutlierReport
- CreateOutlierReport
- DeleteOutlierReport
- DeleteOutlierReportByCID
- SearchOutlierReports
Provision Broker
- NewProvisionBroker
- FetchProvisionBroker
- UpdateProvisionBroker
- CreateProvisionBroker
Rule Set
- NewRuleset
- FetchRuleset
- FetchRulesets
- UpdateRuleset
- CreateRuleset
- DeleteRuleset
- DeleteRulesetByCID
- SearchRulesets
Rule Set Group
- NewRulesetGroup
- FetchRulesetGroup
- FetchRulesetGroups
- UpdateRulesetGroup
- CreateRulesetGroup
- DeleteRulesetGroup
- DeleteRulesetGroupByCID
- SearchRulesetGroups
User
- FetchUser
- FetchUsers
- UpdateUser
- SearchUsers
Worksheet
- NewWorksheet
- FetchWorksheet
- FetchWorksheets
- UpdateWorksheet
- CreateWorksheet
- DeleteWorksheet
- DeleteWorksheetByCID
- SearchWorksheets

Unless otherwise noted, the source files are distributed under the BSD-style license found in the LICENSE file.