# README
Grafana HTTP API Client for Go
This library provides a low-level client to access Grafana HTTP API.
:warning: This repository is still active but not under heavy development. Contributions to this library offering support for the Terraform provider for Grafana will be prioritized over generic ones.
Tests
To run the tests:
make test
# Functions
No description provided by the author
No description provided by the author
No description provided by the author
New creates a new Grafana client.
# Constants
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Defines values for QueryType.
Defines values for QueryType.
Defines values for QueryType.
Defines values for QueryType.
No description provided by the author
No description provided by the author
Defines values for ThresholdOperator.
Defines values for ThresholdOperator.
Defines values for ThresholdOperator.
Defines values for ThresholdOperator.
Defines values for ThresholdOperator.
No description provided by the author
# Structs
Alert represents a Grafana API Alert.
Alerting defines model for Alerting.
AlertingMessageTemplate is a re-usable template for Grafana Alerting messages.
AlertingMetadata defines model for AlertingMetadata.
AlertNotification represents a Grafana alert notification.
AlertQuery represents a single query stage associated with an alert definition.
AlertRule represents a Grafana Alert Rule.
Annotation represents a Grafana API Annotation.
No description provided by the author
Client is a Grafana API client.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
CloudRegion represents a Grafana Cloud region.
CloudRegionsResponse represents the response from the Grafana Cloud regions API.
Config contains client configuration.
ContactPoint represents a Grafana Alerting contact point.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
CreateServiceAccountRequest is the request body for creating a new service account.
CreateServiceAccountTokenRequest represents the request body for creating a new service account token.
CreateServiceAccountTokenResponse represents the response from the Grafana API when creating a service account token.
No description provided by the author
No description provided by the author
Dashboard represents a Grafana dashboard.
DashboardMeta represents Grafana dashboard meta.
DashboardPermission has information such as a dashboard, user, team, role and permission.
DashboardRef defines model for DashboardRef.
DashboardSaveResponse represents the Grafana API response to creating or saving a dashboard.
DataSource represents a Grafana data source.
No description provided by the author
No description provided by the author
DatasourcePermission has information such as a datasource, user, team, role and permission.
No description provided by the author
No description provided by the author
No description provided by the author
DeleteServiceAccountResponse represents the response from deleting a service account or a service account token.
DestinationDatasource defines model for DestinationDatasource.
No description provided by the author
Folder represents a Grafana folder.
FolderDashboardSearchResponse represents the Grafana API dashboard search response.
No description provided by the author
FolderPermission has information such as a folder, user, team, role and permission.
FreeformQuery defines model for FreeformQuery.
No description provided by the author
GetServiceAccountTokensResponse represents a Grafana service account token.
GraphiteAnnotation represents a Grafana API annotation in Graphite format.
No description provided by the author
HistogramQuery defines model for HistogramQuery.
Label defines model for Label.
LibraryPanel represents a Grafana library panel.
LibraryPanelConnection represents a Grafana connection between a library panel and a dashboard.
LibraryPanelCreateResponse represents the Grafana API response to creating or saving a library panel.
LibraryPanelDeleteResponse represents the Grafana API response to deleting a library panel.
LibraryPanelGetAllResponse represents the Grafana API response to getting all library panels.
LibraryPanelMeta represents Grafana library panel metadata.
LibraryPanelMetaUser represents the Grafana library panel createdBy and updatedBy fields.
No description provided by the author
No description provided by the author
MetricDef defines model for MetricDef.
MuteTiming represents a Grafana Alerting mute timing.
NavbarPreference represents a Grafana navbar preference.
NavLink represents a Grafana nav link.
Represents a notification routing tree in Grafana Alerting.
Objective defines model for Objective.
Org represents a Grafana org.
OrgUser represents a Grafana org user.
PauseAlertRequest represents the request payload for a PauseAlert request.
PauseAlertResponse represents the response body for a PauseAlert request.
PauseAllAlertsResponse represents the response body for a PauseAllAlerts request.
No description provided by the author
PermissionItem represents a Grafana folder permission item.
PermissionItems represents Grafana folder permission items.
Playlist represents a Grafana playlist.
PlaylistItem represents a Grafana playlist item.
No description provided by the author
Preferences represents Grafana preferences.
PublicDashboard represents a public dashboard.
No description provided by the author
No description provided by the author
PublicDashboardPayload represents a public dashboard payload.
Query defines model for Query.
QueryHistoryPreference represents a Grafana query history preference.
RatioQuery defines model for RatioQuery.
ReadOnly defines model for ReadOnly.
RelativeTimeRange represents the time range for an alert query.
Report represents a Grafana report.
ReportDashboard represents a dashboard on a Grafana report.
ReportDashboardIdentifier represents the identifier for a dashboard on a Grafana report.
ReportDashboardTimeRange represents the time range from a dashboard on a Grafana report.
ReportOptions represents the options for a Grafana report.
ReportSchedule represents the schedule from a Grafana report.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
RuleGroup represents a group of rules in Grafana Alerting.
SearchTeam represents a search for a Grafana team.
ServiceAccountDTO represents a Grafana service account.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Slo defines model for Slo.
No description provided by the author
Snapshot represents a Grafana snapshot.
SnapshotResponse represents the Grafana API response to creating a dashboard.
Represents a non-root node in a notification routing tree.
https://grafana.com/docs/grafana-cloud/reference/cloud-api/#stacks.
StackItems represents Grafana stack items.
Status defines model for Status.
Team consists of a get response It's used in Add and Update API.
TeamGroup represents a Grafana TeamGroup.
TeamMember represents a Grafana team member.
Threshold defines model for Threshold.
ThresholdQuery defines model for ThresholdQuery.
TimeInterval describes intervals of time using a Prometheus-defined standard.
TimeRange represents a range of minutes within a 1440 minute day, exclusive of the End minute.
No description provided by the author
No description provided by the author
UpdateOrgPreferencesResponse represents the response to a request updating Grafana org preferences.
UpdateServiceAccountRequest is the request body for modifying a service account.
No description provided by the author
User represents a Grafana user.
UserSearch represents a Grafana user as returned by API endpoints that return a collection of Grafana users.
# Interfaces
ResourceIdent represents anything that can be considered a resource identifier.
# Type aliases
No description provided by the author
A DayOfMonthRange is an inclusive range of days, 1-31, within a month, e.g.
No description provided by the author
A Location time zone for the time interval in IANA time zone database, e.g.
No description provided by the author
No description provided by the author
A MonthRange is an inclusive range of months, either numerical or full calendar month, e.g "1:3", "december", or "may:august".
No description provided by the author
QueryType defines model for Query.Type.
ResourceID wraps `int64` to be a valid `ResourceIdent`.
ResourceUID wraps `string` to be a valid `ResourceIdent`.
ThresholdOperator defines model for Threshold.Operator.
A WeekdayRange is an inclusive range of weekdays, e.g.
A YearRange is a positive inclusive range of years, e.g.