# Constants
AddAPIKeyCommandRoleAdmin captures enum value "Admin".
AddAPIKeyCommandRoleEditor captures enum value "Editor".
AddAPIKeyCommandRoleNone captures enum value "None".
AddAPIKeyCommandRoleViewer captures enum value "Viewer".
AddInviteFormRoleAdmin captures enum value "Admin".
AddInviteFormRoleEditor captures enum value "Editor".
AddInviteFormRoleNone captures enum value "None".
AddInviteFormRoleViewer captures enum value "Viewer".
AddOrgUserCommandRoleAdmin captures enum value "Admin".
AddOrgUserCommandRoleEditor captures enum value "Editor".
AddOrgUserCommandRoleNone captures enum value "None".
AddOrgUserCommandRoleViewer captures enum value "Viewer".
AlertRuleExportExecErrStateAlerting captures enum value "Alerting".
AlertRuleExportExecErrStateError captures enum value "Error".
AlertRuleExportExecErrStateOK captures enum value "OK".
AlertRuleExportNoDataStateAlerting captures enum value "Alerting".
AlertRuleExportNoDataStateNoData captures enum value "NoData".
AlertRuleExportNoDataStateOK captures enum value "OK".
AlertStatusStateUnprocessedActiveSuppressed captures enum value "[unprocessed active suppressed]".
APIKeyDTORoleAdmin captures enum value "Admin".
APIKeyDTORoleEditor captures enum value "Editor".
APIKeyDTORoleNone captures enum value "None".
APIKeyDTORoleViewer captures enum value "Viewer".
CalculateDashboardDiffParamsBodyDiffTypeBasic captures enum value "basic".
CalculateDashboardDiffParamsBodyDiffTypeJSON captures enum value "json".
ClusterStatusStatusReadySettlingDisabled captures enum value "[ready settling disabled]".
CreateServiceAccountFormRoleAdmin captures enum value "Admin".
CreateServiceAccountFormRoleEditor captures enum value "Editor".
CreateServiceAccountFormRoleNone captures enum value "None".
CreateServiceAccountFormRoleViewer captures enum value "Viewer".
DashboardACLInfoDTORoleAdmin captures enum value "Admin".
DashboardACLInfoDTORoleEditor captures enum value "Editor".
DashboardACLInfoDTORoleNone captures enum value "None".
DashboardACLInfoDTORoleViewer captures enum value "Viewer".
DashboardACLUpdateItemRoleAdmin captures enum value "Admin".
DashboardACLUpdateItemRoleEditor captures enum value "Editor".
DashboardACLUpdateItemRoleNone captures enum value "None".
DashboardACLUpdateItemRoleViewer captures enum value "Viewer".
EmbeddedContactPointTypeAlertmanager captures enum value "alertmanager".
EmbeddedContactPointTypeDingding captures enum value " dingding".
EmbeddedContactPointTypeDiscord captures enum value " discord".
EmbeddedContactPointTypeEmail captures enum value " email".
EmbeddedContactPointTypeGooglechat captures enum value " googlechat".
EmbeddedContactPointTypeKafka captures enum value " kafka".
EmbeddedContactPointTypeLine captures enum value " line".
EmbeddedContactPointTypeOpsgenie captures enum value " opsgenie".
EmbeddedContactPointTypePagerduty captures enum value " pagerduty".
EmbeddedContactPointTypePushover captures enum value " pushover".
EmbeddedContactPointTypeSensugo captures enum value " sensugo".
EmbeddedContactPointTypeSlack captures enum value " slack".
EmbeddedContactPointTypeTeams captures enum value " teams".
EmbeddedContactPointTypeTelegram captures enum value " telegram".
EmbeddedContactPointTypeThreema captures enum value " threema".
EmbeddedContactPointTypeVictorops captures enum value " victorops".
EmbeddedContactPointTypeWebhook captures enum value " webhook".
EmbeddedContactPointTypeWecom captures enum value " wecom".
GetSnapshotResponseDTOStatusCANCELED captures enum value "CANCELED".
GetSnapshotResponseDTOStatusCREATING captures enum value "CREATING".
GetSnapshotResponseDTOStatusERROR captures enum value "ERROR".
GetSnapshotResponseDTOStatusFINISHED captures enum value "FINISHED".
GetSnapshotResponseDTOStatusINITIALIZING captures enum value "INITIALIZING".
GetSnapshotResponseDTOStatusPENDINGPROCESSING captures enum value "PENDING_PROCESSING".
GetSnapshotResponseDTOStatusPENDINGUPLOAD captures enum value "PENDING_UPLOAD".
GetSnapshotResponseDTOStatusPROCESSING captures enum value "PROCESSING".
GetSnapshotResponseDTOStatusUNKNOWN captures enum value "UNKNOWN".
GetSnapshotResponseDTOStatusUPLOADING captures enum value "UPLOADING".
GettableGrafanaRuleExecErrStateAlerting captures enum value "Alerting".
GettableGrafanaRuleExecErrStateError captures enum value "Error".
GettableGrafanaRuleExecErrStateOK captures enum value "OK".
GettableGrafanaRuleNoDataStateAlerting captures enum value "Alerting".
GettableGrafanaRuleNoDataStateNoData captures enum value "NoData".
GettableGrafanaRuleNoDataStateOK captures enum value "OK".
MigrateDataResponseItemDTOStatusERROR captures enum value "ERROR".
MigrateDataResponseItemDTOStatusOK captures enum value "OK".
MigrateDataResponseItemDTOStatusPENDING captures enum value "PENDING".
MigrateDataResponseItemDTOStatusUNKNOWN captures enum value "UNKNOWN".
MigrateDataResponseItemDTOStatusWARNING captures enum value "WARNING".
MigrateDataResponseItemDTOTypeDASHBOARD captures enum value "DASHBOARD".
MigrateDataResponseItemDTOTypeDATASOURCE captures enum value "DATASOURCE".
MigrateDataResponseItemDTOTypeFOLDER captures enum value "FOLDER".
PatchPrefsCmdThemeDark captures enum value "dark".
PatchPrefsCmdThemeLight captures enum value "light".
PatchPrefsCmdTimezoneBrowser captures enum value "browser".
PatchPrefsCmdTimezoneUtc captures enum value "utc".
PostableGrafanaRuleExecErrStateAlerting captures enum value "Alerting".
PostableGrafanaRuleExecErrStateError captures enum value "Error".
PostableGrafanaRuleExecErrStateOK captures enum value "OK".
PostableGrafanaRuleNoDataStateAlerting captures enum value "Alerting".
PostableGrafanaRuleNoDataStateNoData captures enum value "NoData".
PostableGrafanaRuleNoDataStateOK captures enum value "OK".
ProvisionedAlertRuleExecErrStateAlerting captures enum value "Alerting".
ProvisionedAlertRuleExecErrStateError captures enum value "Error".
ProvisionedAlertRuleExecErrStateOK captures enum value "OK".
ProvisionedAlertRuleNoDataStateAlerting captures enum value "Alerting".
ProvisionedAlertRuleNoDataStateNoData captures enum value "NoData".
ProvisionedAlertRuleNoDataStateOK captures enum value "OK".
SilenceStatusStateExpiredActivePending captures enum value "[expired active pending]".
SnapshotDTOStatusCANCELED captures enum value "CANCELED".
SnapshotDTOStatusCREATING captures enum value "CREATING".
SnapshotDTOStatusERROR captures enum value "ERROR".
SnapshotDTOStatusFINISHED captures enum value "FINISHED".
SnapshotDTOStatusINITIALIZING captures enum value "INITIALIZING".
SnapshotDTOStatusPENDINGPROCESSING captures enum value "PENDING_PROCESSING".
SnapshotDTOStatusPENDINGUPLOAD captures enum value "PENDING_UPLOAD".
SnapshotDTOStatusPROCESSING captures enum value "PROCESSING".
SnapshotDTOStatusUNKNOWN captures enum value "UNKNOWN".
SnapshotDTOStatusUPLOADING captures enum value "UPLOADING".
TempUserDTORoleAdmin captures enum value "Admin".
TempUserDTORoleEditor captures enum value "Editor".
TempUserDTORoleNone captures enum value "None".
TempUserDTORoleViewer captures enum value "Viewer".
TestTemplatesErrorResultKindExecutionError captures enum value "execution_error".
TestTemplatesErrorResultKindInvalidTemplate captures enum value "invalid_template".
TransformationTypeLogfmt captures enum value "logfmt".
TransformationTypeRegex captures enum value "regex".
UpdateOrgUserCommandRoleAdmin captures enum value "Admin".
UpdateOrgUserCommandRoleEditor captures enum value "Editor".
UpdateOrgUserCommandRoleNone captures enum value "None".
UpdateOrgUserCommandRoleViewer captures enum value "Viewer".
UpdatePrefsCmdThemeDark captures enum value "dark".
UpdatePrefsCmdThemeLight captures enum value "light".
UpdatePrefsCmdThemeSystem captures enum value "system".
UpdatePrefsCmdTimezoneBrowser captures enum value "browser".
UpdatePrefsCmdTimezoneUtc captures enum value "utc".
UpdateServiceAccountFormRoleAdmin captures enum value "Admin".
UpdateServiceAccountFormRoleEditor captures enum value "Editor".
UpdateServiceAccountFormRoleNone captures enum value "None".
UpdateServiceAccountFormRoleViewer captures enum value "Viewer".
UserOrgDTORoleAdmin captures enum value "Admin".
UserOrgDTORoleEditor captures enum value "Editor".
UserOrgDTORoleNone captures enum value "None".
UserOrgDTORoleViewer captures enum value "Viewer".
# Structs
ActiveSyncStatusDTO ActiveSyncStatusDTO holds the information for LDAP background Sync
swagger:model ActiveSyncStatusDTO.
ActiveUserStats active user stats
swagger:model ActiveUserStats.
AddAPIKeyCommand add API key command
swagger:model AddAPIKeyCommand.
AddDataSourceCommand Also acts as api DTO
swagger:model AddDataSourceCommand.
AddDataSourceOKBody add data source Ok body
swagger:model addDataSourceOkBody.
AddInviteForm add invite form
swagger:model AddInviteForm.
AddOrgUserCommand add org user command
swagger:model AddOrgUserCommand.
Address address
swagger:model Address.
AddServiceAccountTokenCommand add service account token command
swagger:model AddServiceAccountTokenCommand.
AddTeamMemberCommand add team member command
swagger:model AddTeamMemberCommand.
AddTeamRoleCommand add team role command
swagger:model AddTeamRoleCommand.
AddUserRoleCommand add user role command
swagger:model AddUserRoleCommand.
AdminCreateUserForm admin create user form
swagger:model AdminCreateUserForm.
AdminCreateUserResponse admin create user response
swagger:model AdminCreateUserResponse.
AdminStats admin stats
swagger:model AdminStats.
AdminUpdateUserPasswordForm admin update user password form
swagger:model AdminUpdateUserPasswordForm.
AdminUpdateUserPermissionsForm admin update user permissions form
swagger:model AdminUpdateUserPermissionsForm.
Alert Alert has info for an alert.
AlertDiscovery AlertDiscovery has info for all active alerts.
AlertGroup AlertGroup alert group
swagger:model alertGroup.
AlertingFileExport AlertingFileExport is the full provisioned file export.
AlertingRule adapted from cortex
swagger:model AlertingRule.
AlertInstancesResponse alert instances response
swagger:model AlertInstancesResponse.
AlertManager AlertManager models a configured Alert Manager.
AlertmanagerConfig AlertmanagerConfig alertmanager config
swagger:model alertmanagerConfig.
AlertManagersResult AlertManagersResult contains the result from querying the alertmanagers endpoint.
AlertQuery AlertQuery represents a single query associated with an alert definition.
AlertQueryExport AlertQueryExport is the provisioned export of models.AlertQuery.
AlertRuleExport AlertRuleExport is the provisioned file export of models.AlertRule.
AlertRuleGroup alert rule group
swagger:model AlertRuleGroup.
AlertRuleGroupExport AlertRuleGroupExport is the provisioned file export of AlertRuleGroupV1.
AlertRuleNotificationSettings alert rule notification settings
swagger:model AlertRuleNotificationSettings.
AlertRuleNotificationSettingsExport AlertRuleNotificationSettingsExport is the provisioned export of models.NotificationSettings.
AlertRuleRecordExport Record is the provisioned export of models.Record.
AlertStatus AlertStatus alert status
swagger:model alertStatus.
Annotation annotation
swagger:model Annotation.
AnnotationActions annotation actions
swagger:model AnnotationActions.
AnnotationEvent annotation event
swagger:model AnnotationEvent.
AnnotationPanelFilter AnnotationPanelFilter defines model for AnnotationPanelFilter.
AnnotationPermission annotation permission
swagger:model AnnotationPermission.
AnnotationQuery TODO docs FROM: AnnotationQuery in grafana-data/src/types/annotations.ts
swagger:model AnnotationQuery.
AnnotationTarget TODO: this should be a regular DataQuery that depends on the selected dashboard these match the properties of the "grafana" datasouce that is default in most dashboards
swagger:model AnnotationTarget.
APIKeyDTO Api key DTO
swagger:model ApiKeyDTO.
Assignments assignments
swagger:model Assignments.
AttributeTypeAndValue AttributeTypeAndValue mirrors the ASN.1 structure of the same name in RFC 5280, Section 4.1.2.4.
Authorization Authorization contains HTTP authorization credentials.
BasicAuth BasicAuth contains basic HTTP authentication credentials.
CacheConfigResponse cache config response
swagger:model CacheConfigResponse.
CacheConfigSetter ConfigSetter defines the cache parameters that users can configure per datasource This is only intended to be consumed by the SetCache HTTP Handler
swagger:model CacheConfigSetter.
CalculateDashboardDiffParamsBody calculate dashboard diff params body
swagger:model calculateDashboardDiffParamsBody.
CalculateDiffTarget calculate diff target
swagger:model CalculateDiffTarget.
Certificate A Certificate represents an X.509 certificate.
ChangeUserPasswordCommand change user password command
swagger:model ChangeUserPasswordCommand.
ClearHelpFlagsOKBody clear help flags Ok body
swagger:model clearHelpFlagsOkBody.
CloudMigrationRunListDTO cloud migration run list DTO
swagger:model CloudMigrationRunListDTO.
CloudMigrationSessionListResponseDTO cloud migration session list response DTO
swagger:model CloudMigrationSessionListResponseDTO.
CloudMigrationSessionRequestDTO cloud migration session request DTO
swagger:model CloudMigrationSessionRequestDTO.
CloudMigrationSessionResponseDTO cloud migration session response DTO
swagger:model CloudMigrationSessionResponseDTO.
ClusterStatus ClusterStatus cluster status
swagger:model clusterStatus.
ContactPointExport ContactPointExport is the provisioned file export of alerting.ContactPointV1.
CookiePreferences CookiePreferences defines model for CookiePreferences.
Correlation Correlation is the model for correlations definitions
swagger:model Correlation.
CorrelationConfig correlation config
swagger:model CorrelationConfig.
CorrelationConfigUpdateDTO correlation config update DTO
swagger:model CorrelationConfigUpdateDTO.
CreateAccessTokenResponseDTO create access token response DTO
swagger:model CreateAccessTokenResponseDTO.
CreateCorrelationCommand CreateCorrelationCommand is the command for creating a correlation
swagger:model CreateCorrelationCommand.
CreateCorrelationResponseBody CreateCorrelationResponse is the response struct for CreateCorrelationCommand
swagger:model CreateCorrelationResponseBody.
CreateDashboardSnapshotCommand create dashboard snapshot command
swagger:model CreateDashboardSnapshotCommand.
CreateDashboardSnapshotOKBody create dashboard snapshot Ok body
swagger:model createDashboardSnapshotOkBody.
CreateFolderCommand CreateFolderCommand captures the information required by the folder service to create a folder.
CreateLibraryElementCommand CreateLibraryElementCommand is the command for adding a LibraryElement
swagger:model CreateLibraryElementCommand.
CreateOrgCommand create org command
swagger:model CreateOrgCommand.
CreateOrgOKBody create org Ok body
swagger:model createOrgOkBody.
CreateOrUpdateReport create or update report
swagger:model CreateOrUpdateReport.
CreatePlaylistCommand create playlist command
swagger:model CreatePlaylistCommand.
CreateQueryInQueryHistoryCommand CreateQueryInQueryHistoryCommand is the command for adding query history
swagger:model CreateQueryInQueryHistoryCommand.
CreateReportOKBody create report Ok body
swagger:model createReportOkBody.
CreateRoleForm create role form
swagger:model CreateRoleForm.
CreateServiceAccountForm create service account form
swagger:model CreateServiceAccountForm.
CreateSnapshotResponseDTO create snapshot response DTO
swagger:model CreateSnapshotResponseDTO.
CreateTeamCommand create team command
swagger:model CreateTeamCommand.
CreateTeamOKBody create team Ok body
swagger:model createTeamOkBody.
DashboardACLInfoDTO dashboard ACL info DTO
swagger:model DashboardACLInfoDTO.
DashboardACLUpdateItem dashboard ACL update item
swagger:model DashboardACLUpdateItem.
DashboardFullWithMeta dashboard full with meta
swagger:model DashboardFullWithMeta.
DashboardMeta dashboard meta
swagger:model DashboardMeta.
DashboardSnapshotDTO DashboardSnapshotDTO without dashboard map
swagger:model DashboardSnapshotDTO.
DashboardTagCloudItem dashboard tag cloud item
swagger:model DashboardTagCloudItem.
DashboardVersionMeta DashboardVersionMeta extends the DashboardVersionDTO with the names associated with the UserIds, overriding the field with the same name from the DashboardVersionDTO model.
DataLink DataLink define what
swagger:model DataLink.
DataResponse DataResponse contains the results from a DataQuery.
DataSource data source
swagger:model DataSource.
DataSourceListItemDTO data source list item DTO
swagger:model DataSourceListItemDTO.
DataSourceRef Ref to a DataSource instance
swagger:model DataSourceRef.
DeleteCorrelationResponseBody delete correlation response body
swagger:model DeleteCorrelationResponseBody.
DeleteDashboardByUIDOKBody delete dashboard by Uid Ok body
swagger:model deleteDashboardByUidOkBody.
DeleteDataSourceByNameOKBody delete data source by name Ok body
swagger:model deleteDataSourceByNameOkBody.
DeleteFolderOKBody delete folder Ok body
swagger:model deleteFolderOkBody.
DeleteTokenCommand delete token command
swagger:model DeleteTokenCommand.
Description description
swagger:model Description.
DeviceDTO device DTO
swagger:model deviceDTO.
DeviceSearchHitDTO device search hit DTO
swagger:model DeviceSearchHitDTO.
DiscordConfig DiscordConfig configures notifications via Discord.
EmailConfig EmailConfig configures notifications via mail.
EmailDTO email DTO
swagger:model EmailDTO.
EmbeddedContactPoint EmbeddedContactPoint is the contact point type that is used by grafanas embedded alertmanager implementation.
EnumFieldConfig Enum field config Vector values are used as lookup keys into the enum fields
swagger:model EnumFieldConfig.
ErrorResponseBody error response body
swagger:model ErrorResponseBody.
EvalAlertConditionCommand EvalAlertConditionCommand is the command for evaluating a condition
swagger:model EvalAlertConditionCommand.
Extension Extension represents the ASN.1 structure of the same name.
FailedUser FailedUser holds the information of an user that failed
swagger:model FailedUser.
Field Field represents a typed column of data within a Frame.
FieldConfig FieldConfig represents the display properties for a Field.
FieldTypeConfig FieldTypeConfig has type specific configs, only one should be active at a time
swagger:model FieldTypeConfig.
FindTagsResult FindTagsResult is the result of a tags search.
FloatHistogram FloatHistogram is similar to Histogram but uses float64 for all counts.
Folder folder
swagger:model Folder.
FolderSearchHit folder search hit
swagger:model FolderSearchHit.
ForbiddenError forbidden error
swagger:model ForbiddenError.
Frame Frame is a columnar data structure where each column is a Field.
FrameMeta FrameMeta matches:
https://github.com/grafana/grafana/blob/master/packages/grafana-data/src/types/data.ts#L11 NOTE -- in javascript this can accept any `[key: string]: any;` however this interface only exposes the values we want to be exposed
swagger:model FrameMeta.
GetAccessTokenResponseDTO get access token response DTO
swagger:model GetAccessTokenResponseDTO.
GetAnnotationTagsResponse GetAnnotationTagsResponse is a response struct for FindTagsResult.
GetDataSourceIDByNameOKBody get data source Id by name Ok body
swagger:model getDataSourceIdByNameOkBody.
GetHomeDashboardResponse Get home dashboard response.
GetHomeDashboardResponseAllOf0 get home dashboard response all of0
swagger:model getHomeDashboardResponseAllOf0.
GetHomeDashboardResponseAllOf1 get home dashboard response all of1
swagger:model getHomeDashboardResponseAllOf1.
GetProviderSettingsOKBody get provider settings Ok body
swagger:model getProviderSettingsOkBody.
GetSharingOptionsOKBody get sharing options Ok body
swagger:model getSharingOptionsOkBody.
GetSnapshotResponseDTO get snapshot response DTO
swagger:model GetSnapshotResponseDTO.
GettableAlert GettableAlert gettable alert
swagger:model gettableAlert.
GettableAPIAlertingConfig gettable Api alerting config
swagger:model GettableApiAlertingConfig.
GettableAPIReceiver gettable Api receiver
swagger:model GettableApiReceiver.
GettableExtendedRuleNode gettable extended rule node
swagger:model GettableExtendedRuleNode.
GettableGrafanaReceiver gettable grafana receiver
swagger:model GettableGrafanaReceiver.
GettableGrafanaRule gettable grafana rule
swagger:model GettableGrafanaRule.
GettableGrafanaSilence gettable grafana silence
swagger:model gettableGrafanaSilence.
GettableRuleGroupConfig gettable rule group config
swagger:model GettableRuleGroupConfig.
GettableSilence GettableSilence gettable silence
swagger:model gettableSilence.
GlobalConfig GlobalConfig defines configuration parameters that are valid globally unless overwritten.
HardDeleteDashboardByUIDOKBody hard delete dashboard by Uid Ok body
swagger:model hardDeleteDashboardByUidOkBody.
Header Header represents the configuration for a single HTTP header.
Headers Headers represents the configuration for HTTP headers.
HealthResponse health response
swagger:model healthResponse.
Hit hit
swagger:model Hit.
HostPort HostPort represents a "host:port" network address.
HTTPClientConfig HTTPClientConfig configures an HTTP client.
ImportDashboardInput ImportDashboardInput definition of input parameters when importing a dashboard.
ImportDashboardRequest ImportDashboardRequest request object for importing a dashboard.
ImportDashboardResponse ImportDashboardResponse response object returned when importing a dashboard.
InhibitRule InhibitRule defines an inhibition rule that mutes alerts that match the target labels if an alert matching the source labels exists.
InternalDataLink InternalDataLink definition to allow Explore links to be constructed in the backend
swagger:model InternalDataLink.
IPNet An IPNet represents an IP network.
JSONWebKey JSONWebKey represents a public or private key in JWK format.
Label Label is a key/value pair of strings.
LibraryElementArrayResponse LibraryElementArrayResponse is a response struct for an array of LibraryElementDTO.
LibraryElementConnectionDTO LibraryElementConnectionDTO is the frontend DTO for element connections.
LibraryElementConnectionsResponse LibraryElementConnectionsResponse is a response struct for an array of LibraryElementConnectionDTO.
LibraryElementDTO LibraryElementDTO is the frontend DTO for entities.
LibraryElementDTOMeta LibraryElementDTOMeta is the meta information for LibraryElementDTO.
LibraryElementDTOMetaUser LibraryElementDTOMetaUser defines model for LibraryElementDTOMetaUser.
LibraryElementResponse LibraryElementResponse is a response struct for LibraryElementDTO.
LibraryElementSearchResponse LibraryElementSearchResponse is a response struct for LibraryElementSearchResult.
LibraryElementSearchResult LibraryElementSearchResult is the search result for entities.
LinkTransformationConfig link transformation config
swagger:model LinkTransformationConfig.
ListAllProvidersSettingsOKBodyItems list all providers settings Ok body items
swagger:model listAllProvidersSettingsOkBodyItems.
ListSortOptionsOKBody list sort options Ok body
swagger:model listSortOptionsOkBody.
MassDeleteAnnotationsCmd mass delete annotations cmd
swagger:model MassDeleteAnnotationsCmd.
Matcher Matcher matcher
swagger:model matcher.
MetricRequest metric request
swagger:model MetricRequest.
MigrateDataResponseDTO migrate data response DTO
swagger:model MigrateDataResponseDTO.
MigrateDataResponseItemDTO migrate data response item DTO
swagger:model MigrateDataResponseItemDTO.
MigrateDataResponseListDTO migrate data response list DTO
swagger:model MigrateDataResponseListDTO.
MoveFolderCommand MoveFolderCommand captures the information required by the folder service to move a folder.
MSTeamsConfig m s teams config
swagger:model MSTeamsConfig.
MuteTimeInterval MuteTimeInterval represents a named set of time intervals for which a route should be muted.
MuteTimeIntervalExport mute time interval export
swagger:model MuteTimeIntervalExport.
Name Name represents an X.509 distinguished name.
NavbarPreference NavbarPreference defines model for NavbarPreference.
NewAPIKeyResult new Api key result
swagger:model NewApiKeyResult.
Notice Notice provides a structure for presenting notifications in Grafana's user interface.
NotificationPolicyExport NotificationPolicyExport is the provisioned file export of alerting.NotificiationPolicyV1.
NotificationTemplate notification template
swagger:model NotificationTemplate.
NotificationTemplateContent notification template content
swagger:model NotificationTemplateContent.
OAuth2 OAuth2 is the oauth2 client configuration.
OpsGenieConfig OpsGenieConfig configures notifications via OpsGenie.
OpsGenieConfigResponder ops genie config responder
swagger:model OpsGenieConfigResponder.
OrgDetailsDTO org details DTO
swagger:model OrgDetailsDTO.
OrgDTO org DTO
swagger:model OrgDTO.
OrgUserDTO org user DTO
swagger:model OrgUserDTO.
PagerdutyConfig PagerdutyConfig configures notifications via PagerDuty.
PagerdutyImage PagerdutyImage is an image.
PagerdutyLink PagerdutyLink is a link.
PatchAnnotationsCmd patch annotations cmd
swagger:model PatchAnnotationsCmd.
PatchLibraryElementCommand PatchLibraryElementCommand is the command for patching a LibraryElement
swagger:model PatchLibraryElementCommand.
PatchPrefsCmd patch prefs cmd
swagger:model PatchPrefsCmd.
PatchQueryCommentInQueryHistoryCommand PatchQueryCommentInQueryHistoryCommand is the command for updating comment for query in query history
swagger:model PatchQueryCommentInQueryHistoryCommand.
PeerStatus PeerStatus peer status
swagger:model peerStatus.
Permission Permission is the model for access control permissions.
Playlist Playlist model
swagger:model Playlist.
PlaylistDashboard playlist dashboard
swagger:model PlaylistDashboard.
PlaylistItem playlist item
swagger:model PlaylistItem.
PlaylistItemDTO playlist item DTO
swagger:model PlaylistItemDTO.
PostableAlert PostableAlert postable alert
swagger:model postableAlert.
PostableAPIAlertingConfig nolint:revive
swagger:model PostableApiAlertingConfig.
PostableAPIReceiver nolint:revive
swagger:model PostableApiReceiver.
PostableExtendedRuleNode postable extended rule node
swagger:model PostableExtendedRuleNode.
PostableGrafanaReceiver postable grafana receiver
swagger:model PostableGrafanaReceiver.
PostableGrafanaRule postable grafana rule
swagger:model PostableGrafanaRule.
PostAnnotationOKBody post annotation Ok body
swagger:model postAnnotationOkBody.
PostAnnotationsCmd post annotations cmd
swagger:model PostAnnotationsCmd.
PostDashboardOKBody post dashboard Ok body
swagger:model postDashboardOkBody.
PostGraphiteAnnotationOKBody post graphite annotation Ok body
swagger:model postGraphiteAnnotationOkBody.
PostGraphiteAnnotationsCmd post graphite annotations cmd
swagger:model PostGraphiteAnnotationsCmd.
Preferences Spec defines user, team or org Grafana preferences
swagger:model Preferences.
PrometheusRemoteWriteTargetJSON prometheus remote write target JSON
swagger:model PrometheusRemoteWriteTargetJSON.
ProvisionedAlertRule provisioned alert rule
swagger:model ProvisionedAlertRule.
PublicDashboard public dashboard
swagger:model PublicDashboard.
PublicDashboardDTO public dashboard DTO
swagger:model PublicDashboardDTO.
PublicDashboardListResponse public dashboard list response
swagger:model PublicDashboardListResponse.
PublicDashboardListResponseWithPagination public dashboard list response with pagination
swagger:model PublicDashboardListResponseWithPagination.
PublicError PublicError is derived from Error and only contains information available to the end user.
PushoverConfig pushover config
swagger:model PushoverConfig.
QueryDataResponse QueryDataResponse contains the results from a QueryDataRequest.
QueryHistoryDeleteQueryResponse QueryHistoryDeleteQueryResponse is the response struct for deleting a query from query history
swagger:model QueryHistoryDeleteQueryResponse.
QueryHistoryDTO query history DTO
swagger:model QueryHistoryDTO.
QueryHistoryPreference QueryHistoryPreference defines model for QueryHistoryPreference.
QueryHistoryResponse QueryHistoryResponse is a response struct for QueryHistoryDTO
swagger:model QueryHistoryResponse.
QueryHistorySearchResponse query history search response
swagger:model QueryHistorySearchResponse.
QueryHistorySearchResult query history search result
swagger:model QueryHistorySearchResult.
QueryStat QueryStat is used for storing arbitrary statistics metadata related to a query and its result, e.g.
QuotaDTO quota DTO
swagger:model QuotaDTO.
Receiver Receiver receiver
swagger:model receiver.
ReceiverExport ReceiverExport is the provisioned file export of alerting.ReceiverV1.
Record record
swagger:model Record.
RecordingRuleJSON RecordingRuleJSON is the external representation of a recording rule
swagger:model RecordingRuleJSON.
RelativeTimeRange RelativeTimeRange is the per query start and end time for requests.
RelativeTimeRangeExport relative time range export
swagger:model RelativeTimeRangeExport.
Report report
swagger:model Report.
ReportBrandingOptions report branding options
swagger:model ReportBrandingOptions.
ReportDashboard report dashboard
swagger:model ReportDashboard.
ReportDashboardID report dashboard ID
swagger:model ReportDashboardID.
ReportEmail report email
swagger:model ReportEmail.
ReportOptions report options
swagger:model ReportOptions.
ReportSchedule report schedule
swagger:model ReportSchedule.
ReportSettings report settings
swagger:model ReportSettings.
ReportTimeRange report time range
swagger:model ReportTimeRange.
ResourcePermissionDTO resource permission DTO
swagger:model resourcePermissionDTO.
ResponseDetails response details
swagger:model ResponseDetails.
RestoreDashboardVersionByIDOKBody restore dashboard version by Id Ok body
swagger:model restoreDashboardVersionByIdOkBody.
RestoreDashboardVersionByUIDOKBody restore dashboard version by Uid Ok body
swagger:model restoreDashboardVersionByUidOkBody.
RestoreDashboardVersionCommand restore dashboard version command
swagger:model RestoreDashboardVersionCommand.
RestoreDeletedDashboardByUIDOKBody restore deleted dashboard by Uid Ok body
swagger:model restoreDeletedDashboardByUidOkBody.
RestoreDeletedDashboardCommand restore deleted dashboard command
swagger:model RestoreDeletedDashboardCommand.
RetrieveJWKSOKBody retrieve j w k s Ok body
swagger:model retrieveJWKSOkBody.
RevokeAuthTokenCmd revoke auth token cmd
swagger:model RevokeAuthTokenCmd.
RoleAssignmentsDTO role assignments DTO
swagger:model RoleAssignmentsDTO.
RoleDTO role DTO
swagger:model RoleDTO.
RolesSearchQuery roles search query
swagger:model RolesSearchQuery.
Route A Route is a node that contains definitions of how to handle alerts.
RouteExport RouteExport is the provisioned file export of definitions.Route.
RuleDiscovery rule discovery
swagger:model RuleDiscovery.
RuleGroup rule group
swagger:model RuleGroup.
Sample Sample is a single sample belonging to a metric.
SaveDashboardCommand save dashboard command
swagger:model SaveDashboardCommand.
SearchDeviceQueryResult search device query result
swagger:model SearchDeviceQueryResult.
SearchOrgServiceAccountsResult swagger: model
swagger:model SearchOrgServiceAccountsResult.
SearchOrgUsersQueryResult search org users query result
swagger:model SearchOrgUsersQueryResult.
SearchResult search result
swagger:model SearchResult.
SearchResultItem search result item
swagger:model SearchResultItem.
SearchTeamQueryResult search team query result
swagger:model SearchTeamQueryResult.
SearchUserQueryResult search user query result
swagger:model SearchUserQueryResult.
SecretURL SecretURL is a URL that must not be revealed on marshaling.
ServiceAccountDTO swagger: model
swagger:model ServiceAccountDTO.
ServiceAccountProfileDTO service account profile DTO
swagger:model ServiceAccountProfileDTO.
SetHelpFlagOKBody set help flag Ok body
swagger:model setHelpFlagOkBody.
SetPermissionCommand set permission command
swagger:model setPermissionCommand.
SetPermissionsCommand set permissions command
swagger:model setPermissionsCommand.
SetResourcePermissionCommand set resource permission command
swagger:model SetResourcePermissionCommand.
SetRoleAssignmentsCommand set role assignments command
swagger:model SetRoleAssignmentsCommand.
SetTeamMembershipsCommand set team memberships command
swagger:model SetTeamMembershipsCommand.
SetUserRolesCommand set user roles command
swagger:model SetUserRolesCommand.
SigV4Config SigV4Config is the configuration for signing remote write requests with AWS's SigV4 verification process.
SilenceMetadata silence metadata
swagger:model SilenceMetadata.
SilenceStatus SilenceStatus silence status
swagger:model silenceStatus.
SlackAction SlackAction configures a single Slack action that is sent with each notification.
SlackConfig SlackConfig configures notifications via Slack.
SlackConfirmationField SlackConfirmationField protect users from destructive actions or particularly distinguished decisions by asking them to confirm their button click one more time.
SlackField SlackField configures a single Slack field that is sent with each notification.
SnapshotDTO Base snapshot without results
swagger:model SnapshotDTO.
SnapshotListResponseDTO snapshot list response DTO
swagger:model SnapshotListResponseDTO.
SnapshotResourceStats snapshot resource stats
swagger:model SnapshotResourceStats.
SNSConfig SNS config
swagger:model SNSConfig.
Span A Span defines a continuous sequence of buckets.
SuccessResponseBody success response body
swagger:model SuccessResponseBody.
SyncResult SyncResult holds the result of a sync with LDAP.
TagsDTO TagsDTO is the frontend DTO for Tag.
TeamDTO team DTO
swagger:model TeamDTO.
TeamGroupDTO team group DTO
swagger:model TeamGroupDTO.
TeamGroupMapping team group mapping
swagger:model TeamGroupMapping.
TeamMemberDTO team member DTO
swagger:model TeamMemberDTO.
TelegramConfig TelegramConfig configures notifications via Telegram.
TempUserDTO temp user DTO
swagger:model TempUserDTO.
TestReceiverConfigResult test receiver config result
swagger:model TestReceiverConfigResult.
TestReceiverResult test receiver result
swagger:model TestReceiverResult.
TestReceiversConfigAlertParams test receivers config alert params
swagger:model TestReceiversConfigAlertParams.
TestTemplatesErrorResult test templates error result
swagger:model TestTemplatesErrorResult.
TestTemplatesResult test templates result
swagger:model TestTemplatesResult.
Threshold Threshold a single step on the threshold list
swagger:model Threshold.
ThresholdsConfig ThresholdsConfig setup thresholds
swagger:model ThresholdsConfig.
TimeInterval TimeInterval represents a named set of time intervals for which a route should be muted.
TimeIntervalItem time interval item
swagger:model TimeIntervalItem.
TimeIntervalTimeRange time interval time range
swagger:model TimeIntervalTimeRange.
TimeRange Redefining this to avoid an import cycle
swagger:model TimeRange.
TLSConfig TLSConfig configures the options for TLS connections.
Token token
swagger:model Token.
TokenDTO token DTO
swagger:model TokenDTO.
Transformation transformation
swagger:model Transformation.
Unstructured Unstructured allows objects that do not have Golang structs registered to be manipulated generically.
UpdateAnnotationsCmd update annotations cmd
swagger:model UpdateAnnotationsCmd.
UpdateCorrelationCommand UpdateCorrelationCommand is the command for updating a correlation
swagger:model UpdateCorrelationCommand.
UpdateCorrelationResponseBody update correlation response body
swagger:model UpdateCorrelationResponseBody.
UpdateDashboardACLCommand update dashboard ACL command
swagger:model UpdateDashboardACLCommand.
UpdateDataSourceByIDOKBody update data source by Id Ok body
swagger:model updateDataSourceByIdOkBody.
UpdateDataSourceByUIDOKBody update data source by Uid Ok body
swagger:model updateDataSourceByUidOkBody.
UpdateDataSourceCommand Also acts as api DTO
swagger:model UpdateDataSourceCommand.
UpdateFolderCommand UpdateFolderCommand captures the information required by the folder service to update a folder.
UpdateOrgAddressForm update org address form
swagger:model UpdateOrgAddressForm.
UpdateOrgForm update org form
swagger:model UpdateOrgForm.
UpdateOrgUserCommand update org user command
swagger:model UpdateOrgUserCommand.
UpdatePlaylistCommand update playlist command
swagger:model UpdatePlaylistCommand.
UpdatePrefsCmd update prefs cmd
swagger:model UpdatePrefsCmd.
UpdateProviderSettingsParamsBody update provider settings params body
swagger:model updateProviderSettingsParamsBody.
UpdateQuotaCmd update quota cmd
swagger:model UpdateQuotaCmd.
UpdateRoleCommand update role command
swagger:model UpdateRoleCommand.
UpdateServiceAccountForm update service account form
swagger:model UpdateServiceAccountForm.
UpdateServiceAccountOKBody update service account Ok body
swagger:model updateServiceAccountOkBody.
UpdateTeamCommand update team command
swagger:model UpdateTeamCommand.
UpdateTeamMemberCommand update team member command
swagger:model UpdateTeamMemberCommand.
UpdateUserCommand update user command
swagger:model UpdateUserCommand.
URL A URL represents a parsed URL (technically, a URI reference).
UserLookupDTO user lookup DTO
swagger:model UserLookupDTO.
UserOrgDTO user org DTO
swagger:model UserOrgDTO.
UserProfileDTO user profile DTO
swagger:model UserProfileDTO.
UserSearchHitDTO user search hit DTO
swagger:model UserSearchHitDTO.
UserToken UserToken represents a user token
swagger:model UserToken.
ValidationError validation error
swagger:model ValidationError.
VersionInfo VersionInfo version info
swagger:model versionInfo.
VictorOpsConfig VictorOpsConfig configures notifications via VictorOps.
WebexConfig WebexConfig configures notifications via Webex.
WebhookConfig WebhookConfig configures notifications via a generic webhook.
WechatConfig WechatConfig configures notifications via Wechat.
# Interfaces
Ack ack
swagger:model Ack.
ExplorePanelsState This is an object constructed with the keys as the values of the enum VisType and the value being a bag of properties
swagger:model ExplorePanelsState.
JSON Json
swagger:model Json.
NotFound not found
swagger:model NotFound.
PermissionDenied permission denied
swagger:model PermissionDenied.
RawMessage raw message
swagger:model RawMessage.
Userinfo The Userinfo type is an immutable encapsulation of username and password details for a [URL].
ValueMapping ValueMapping allows mapping input values to text and color
swagger:model ValueMapping.
# Type aliases
ConfFloat64 ConfFloat64 is a float64.
ContactPoints contact points
swagger:model ContactPoints.
CookieType cookie type
swagger:model CookieType.
CorrelationType correlation type
swagger:model CorrelationType.
CounterResetHint CounterResetHint contains the known information about a counter reset,
or alternatively that we are dealing with a gauge histogram, where counter resets do not apply.
DataSourceList data source list
swagger:model DataSourceList.
DataTopic DataTopic is used to identify which topic the frame should be assigned to.
DescendantCounts descendant counts
swagger:model DescendantCounts.
DsAccess ds access
swagger:model DsAccess.
Duration A Duration represents the elapsed time between two instants as an int64 nanosecond count.
ErrorSource ErrorSource type defines the source of the error
swagger:model ErrorSource.
ErrorType ErrorType models the different API error types.
ExtKeyUsage ExtKeyUsage represents an extended set of actions that are valid for a given key.
FrameLabels Labels are used to add metadata to an object.
Frames Frames is a slice of Frame pointers.
FrameType A FrameType string, when present in a frame's metadata, asserts that the frame's structure conforms to the FrameType's specification.
FrameTypeVersion FrameType is a 2 number version (Major / Minor).
HitList hit list
swagger:model HitList.
HitType hit type
swagger:model HitType.
InspectType InspectType is a type for the Inspect property of a Notice.
IPMask An IPMask is a bitmask that can be used to manipulate IP addresses for IP addressing and routing.
KeyUsage KeyUsage represents the set of actions that are valid for a given key.
LabelName A LabelName is a key for a LabelSet or Metric.
LabelNames LabelNames is a sortable LabelName slice.
Labels Labels is a sorted set of labels.
LabelSet LabelSet label set
swagger:model labelSet.
LabelValue A LabelValue is an associated value for a LabelName.
Matchers Matchers matchers
swagger:model matchers.
MatchRegexps MatchRegexps represents a map of Regexp.
MatchType MatchType is an enum for label matching types.
Metadata Metadata contains user accesses for a given resource Ex: map[string]bool{"create":true, "delete": true}
swagger:model Metadata.
MuteTimings mute timings
swagger:model MuteTimings.
NoticeSeverity NoticeSeverity is a type for the Severity property of a Notice.
NotificationTemplates notification templates
swagger:model NotificationTemplates.
ObjectIdentifier An ObjectIdentifier represents an ASN.1 OBJECT IDENTIFIER.
ObjectMatcher ObjectMatcher is a matcher that can be used to filter alerts.
ObjectMatchers ObjectMatchers is a list of matchers that can be used to filter alerts.
Password password
swagger:model Password.
PermissionType permission type
swagger:model PermissionType.
Playlists playlists
swagger:model Playlists.
Provenance provenance
swagger:model Provenance.
ProvisionedAlertRules provisioned alert rules
swagger:model ProvisionedAlertRules.
ProxyHeader proxy header
swagger:model ProxyHeader.
PublicKeyAlgorithm public key algorithm
swagger:model PublicKeyAlgorithm.
Responses Responses is a map of RefIDs (Unique Query ID) to DataResponses.
Secret Secret special type for storing secrets.
SettingsBag settings bag
swagger:model SettingsBag.
ShareType share type
swagger:model ShareType.
SignatureAlgorithm signature algorithm
swagger:model SignatureAlgorithm.
State +enum
swagger:model State.
Status status
swagger:model Status.
SupportedTransformationTypes supported transformation types
swagger:model SupportedTransformationTypes.
TempUserStatus temp user status
swagger:model TempUserStatus.
ThresholdsMode ThresholdsMode absolute or percentage
swagger:model ThresholdsMode.
TLSVersion TLS version
swagger:model TLSVersion.
TokenStatus token status
swagger:model TokenStatus.
Transformations transformations
swagger:model Transformations.
Type +enum
swagger:model Type.
ValueMappings value mappings
swagger:model ValueMappings.
Vector Vector is basically only an alias for []Sample, but the contract is that in a Vector, all Samples have the same timestamp.
VisType VisType is used to indicate how the data should be visualized in explore.