# Constants
AddCommandRoleAdmin captures enum value "Admin".
AddCommandRoleEditor captures enum value "Editor".
AddCommandRoleNone captures enum value "None".
AddCommandRoleViewer 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".
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".
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]".
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.
AddCommand add command
swagger:model AddCommand.
AddDataSourceCommand Also acts as api DTO
swagger:model AddDataSourceCommand.
AddDataSourceOKBody add data source o k body
swagger:model addDataSourceOKBody.
AddInviteForm add invite form
swagger:model AddInviteForm.
AddOrgUserCommand add org user command
swagger:model AddOrgUserCommand.
AddPermissionOKBody add permission o k body
swagger:model addPermissionOKBody.
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 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.
AlertListItemDTO alert list item d t o
swagger:model AlertListItemDTO.
AlertManager AlertManager models a configured Alert Manager.
AlertmanagerConfig AlertmanagerConfig alertmanager config
swagger:model alertmanagerConfig.
AlertManagersResult AlertManagersResult contains the result from querying the alertmanagers endpoint.
AlertNotification alert notification
swagger:model AlertNotification.
AlertNotificationLookup alert notification lookup
swagger:model AlertNotificationLookup.
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.
AlertStateInfoDTO alert state info d t o
swagger:model AlertStateInfoDTO.
AlertStatus AlertStatus alert status
swagger:model alertStatus.
AlertTestCommand alert test command
swagger:model AlertTestCommand.
AlertTestResult alert test result
swagger:model AlertTestResult.
AlertTestResultLog alert test result log
swagger:model AlertTestResultLog.
AnnotationActions annotation actions
swagger:model AnnotationActions.
AnnotationPermission annotation permission
swagger:model AnnotationPermission.
APIKeyDTO Api key d t o
swagger:model ApiKeyDTO.
Authorization Authorization contains HTTP authorization credentials.
BasicAuth BasicAuth contains basic HTTP authentication credentials.
BrandingOptionsDTO branding options d t o
swagger:model BrandingOptionsDTO.
CalculateDashboardDiffParamsBody calculate dashboard diff params body
swagger:model calculateDashboardDiffParamsBody.
CalculateDiffTarget calculate diff target
swagger:model CalculateDiffTarget.
ChangeUserPasswordCommand change user password command
swagger:model ChangeUserPasswordCommand.
ClearHelpFlagsOKBody clear help flags o k body
swagger:model clearHelpFlagsOKBody.
ClusterStatus ClusterStatus cluster status
swagger:model clusterStatus.
ConfigDTO ConfigDTO is model representation in transfer
swagger:model ConfigDTO.
Correlation Correlation is the model for correlations definitions
swagger:model Correlation.
CorrelationConfig correlation config
swagger:model CorrelationConfig.
CorrelationConfigUpdateDTO correlation config update d t o
swagger:model CorrelationConfigUpdateDTO.
CreateAlertNotificationCommand create alert notification command
swagger:model CreateAlertNotificationCommand.
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 o k 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 o k body
swagger:model createOrgOKBody.
CreateOrUpdateConfigCmd create or update config cmd
swagger:model CreateOrUpdateConfigCmd.
CreatePlaylistCommand create playlist command
swagger:model CreatePlaylistCommand.
CreateQueryInQueryHistoryCommand CreateQueryInQueryHistoryCommand is the command for adding query history
swagger:model CreateQueryInQueryHistoryCommand.
CreateReportOKBody create report o k body
swagger:model createReportOKBody.
CreateRoleForm create role form
swagger:model CreateRoleForm.
CreateServiceAccountForm create service account form
swagger:model CreateServiceAccountForm.
CreateTeamCommand create team command
swagger:model CreateTeamCommand.
CreateTeamOKBody create team o k body
swagger:model createTeamOKBody.
CustomPermissionsRecordDTO custom permissions record d t o
swagger:model CustomPermissionsRecordDTO.
DashboardACLInfoDTO dashboard ACL info d t o
swagger:model DashboardACLInfoDTO.
DashboardACLUpdateItem dashboard ACL update item
swagger:model DashboardACLUpdateItem.
DashboardDTO dashboard d t o
swagger:model DashboardDTO.
DashboardFullWithMeta dashboard full with meta
swagger:model DashboardFullWithMeta.
DashboardMeta dashboard meta
swagger:model DashboardMeta.
DashboardReportDTO dashboard report d t o
swagger:model DashboardReportDTO.
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 d t o
swagger:model DataSourceListItemDTO.
DataSourcePermissionRuleDTO data source permission rule d t o
swagger:model DataSourcePermissionRuleDTO.
DataSourcePermissionsDTO data source permissions d t o
swagger:model DataSourcePermissionsDTO.
DeleteAlertNotificationChannelByUIDOKBody delete alert notification channel by Uid o k body
swagger:model deleteAlertNotificationChannelByUidOKBody.
DeleteCorrelationResponseBody delete correlation response body
swagger:model DeleteCorrelationResponseBody.
DeleteDashboardByUIDOKBody delete dashboard by Uid o k body
swagger:model deleteDashboardByUidOKBody.
DeleteDataSourceByNameOKBody delete data source by name o k body
swagger:model deleteDataSourceByNameOKBody.
DeleteFolderOKBody delete folder o k body
swagger:model deleteFolderOKBody.
DeleteTokenCommand delete token command
swagger:model DeleteTokenCommand.
DisablePermissionsOKBody disable permissions o k body
swagger:model disablePermissionsOKBody.
DiscordConfig DiscordConfig configures notifications via Discord.
EmailConfig EmailConfig configures notifications via mail.
EmbeddedContactPoint EmbeddedContactPoint is the contact point type that is used by grafanas embedded alertmanager implementation.
EnablePermissionsOKBody enable permissions o k body
swagger:model enablePermissionsOKBody.
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.
EvalMatch eval match
swagger:model EvalMatch.
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.
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.
GetAnnotationTagsResponse GetAnnotationTagsResponse is a response struct for FindTagsResult.
GetDataSourceIDByNameOKBody get data source Id by name o k 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.
GetSharingOptionsOKBody get sharing options o k body
swagger:model getSharingOptionsOKBody.
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.
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.
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.
Integration integration
swagger:model integration.
InternalDataLink InternalDataLink definition to allow Explore links to be constructed in the backend
swagger:model InternalDataLink.
Item Item defines model for Item.
ItemDTO item d t o
swagger:model ItemDTO.
Label Label is a key/value pair of strings.
LegacyAlert legacy alert
swagger:model LegacyAlert.
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.
ListSortOptionsOKBody list sort options o k body
swagger:model listSortOptionsOKBody.
MassDeleteAnnotationsCmd mass delete annotations cmd
swagger:model MassDeleteAnnotationsCmd.
Matcher Matcher matcher
swagger:model matcher.
MetricRequest metric request
swagger:model MetricRequest.
MigrateQueriesToQueryHistoryCommand MigrateQueriesToQueryHistoryCommand is the command used for migration of old queries into query history
swagger:model MigrateQueriesToQueryHistoryCommand.
MoveFolderCommand MoveFolderCommand captures the information required by the folder service to move a folder.
MuteTimeInterval MuteTimeInterval represents a named set of time intervals for which a route should be muted.
NewAPIKeyResult new Api key result
swagger:model NewApiKeyResult.
Notice Notice provides a structure for presenting notifications in Grafana's user interface.
NotificationTemplate notification template
swagger:model NotificationTemplate.
NotificationTemplateContent notification template content
swagger:model NotificationTemplateContent.
NotificationTestCommand notification test command
swagger:model NotificationTestCommand.
OAuth2 OAuth2 is the oauth2 client configuration.
OpsGenieConfig OpsGenieConfig configures notifications via OpsGenie.
OpsGenieConfigResponder ops genie config responder
swagger:model OpsGenieConfigResponder.
OrgDetailsDTO org details d t o
swagger:model OrgDetailsDTO.
OrgDTO org d t o
swagger:model OrgDTO.
OrgUserDTO org user d t o
swagger:model OrgUserDTO.
PagerdutyConfig PagerdutyConfig configures notifications via PagerDuty.
PagerdutyImage PagerdutyImage is an image
swagger:model PagerdutyImage.
PagerdutyLink PagerdutyLink is a link
swagger:model PagerdutyLink.
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.
PauseAlertCommand pause alert command
swagger:model PauseAlertCommand.
PauseAlertOKBody pause alert o k body
swagger:model pauseAlertOKBody.
PauseAllAlertsCommand pause all alerts command
swagger:model PauseAllAlertsCommand.
PauseAllAlertsOKBody pause all alerts o k body
swagger:model pauseAllAlertsOKBody.
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.
PostableAlert PostableAlert postable alert
swagger:model postableAlert.
PostableAPIAlertingConfig postable Api alerting config
swagger:model PostableApiAlertingConfig.
PostableAPIReceiver postable Api receiver
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 o k body
swagger:model postAnnotationOKBody.
PostAnnotationsCmd post annotations cmd
swagger:model PostAnnotationsCmd.
PostDashboardOKBody post dashboard o k body
swagger:model postDashboardOKBody.
PostGraphiteAnnotationOKBody post graphite annotation o k body
swagger:model postGraphiteAnnotationOKBody.
PostGraphiteAnnotationsCmd post graphite annotations cmd
swagger:model PostGraphiteAnnotationsCmd.
Preferences Preferences defines model for Preferences.
PrometheusRemoteWriteTargetJSON prometheus remote write target JSON
swagger:model PrometheusRemoteWriteTargetJSON.
ProvisionedAlertRule provisioned alert rule
swagger:model ProvisionedAlertRule.
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 d t o
swagger:model QueryHistoryDTO.
QueryHistoryMigrationResponse query history migration response
swagger:model QueryHistoryMigrationResponse.
QueryHistoryPreference query history preference
swagger:model 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.
QueryToMigrate query to migrate
swagger:model QueryToMigrate.
QuotaDTO quota d t o
swagger:model QuotaDTO.
Receiver receiver
swagger:model receiver.
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.
ReportEmailDTO report email d t o
swagger:model ReportEmailDTO.
ReportOptionsDTO report options d t o
swagger:model ReportOptionsDTO.
ResponseDetails response details
swagger:model ResponseDetails.
RestoreDashboardVersionByIDOKBody restore dashboard version by Id o k body
swagger:model restoreDashboardVersionByIdOKBody.
RestoreDashboardVersionByUIDOKBody restore dashboard version by Uid o k body
swagger:model restoreDashboardVersionByUidOKBody.
RestoreDashboardVersionCommand restore dashboard version command
swagger:model RestoreDashboardVersionCommand.
RevokeAuthTokenCmd revoke auth token cmd
swagger:model RevokeAuthTokenCmd.
RoleAssignmentsDTO role assignments d t o
swagger:model RoleAssignmentsDTO.
RoleDTO role d t o
swagger:model RoleDTO.
Route A Route is a node that contains definitions of how to handle alerts.
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.
ScheduleDTO schedule d t o
swagger:model ScheduleDTO.
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 d t o
swagger:model ServiceAccountProfileDTO.
SetHelpFlagOKBody set help flag o k body
swagger:model setHelpFlagOKBody.
SetRoleAssignmentsCommand set role assignments command
swagger:model SetRoleAssignmentsCommand.
SettingsDTO settings d t o
swagger:model SettingsDTO.
SetUserRolesCommand set user roles command
swagger:model SetUserRolesCommand.
SigV4Config SigV4Config is the configuration for signing remote write requests with AWS's SigV4 verification process.
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.
SNSConfig s n s config
swagger:model SNSConfig.
Span A Span defines a continuous sequence of buckets.
Spec Spec defines model for Spec.
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 d t o
swagger:model TeamDTO.
TeamGroupDTO team group d t o
swagger:model TeamGroupDTO.
TeamGroupMapping team group mapping
swagger:model TeamGroupMapping.
TeamMemberDTO team member d t o
swagger:model TeamMemberDTO.
TelegramConfig TelegramConfig configures notifications via Telegram.
TempUserDTO temp user d t o
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 describes intervals of time.
TimeRange Redefining this to avoid an import cycle
swagger:model TimeRange.
TimeRangeDTO time range d t o
swagger:model TimeRangeDTO.
TLSConfig TLSConfig configures the options for TLS connections.
Token token
swagger:model Token.
TokenDTO token d t o
swagger:model TokenDTO.
Transformation transformation
swagger:model Transformation.
TrimDashboardCommand trim dashboard command
swagger:model TrimDashboardCommand.
TrimDashboardFullWithMeta trim dashboard full with meta
swagger:model TrimDashboardFullWithMeta.
UpdateAlertNotificationCommand update alert notification command
swagger:model UpdateAlertNotificationCommand.
UpdateAlertNotificationWithUIDCommand update alert notification with Uid command
swagger:model UpdateAlertNotificationWithUidCommand.
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 o k body
swagger:model updateDataSourceByIdOKBody.
UpdateDataSourceByUIDOKBody update data source by Uid o k 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.
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 o k 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 URL is a custom URL type that allows validation at configuration load time.
UserLookupDTO user lookup d t o
swagger:model UserLookupDTO.
UserOrgDTO user org d t o
swagger:model UserOrgDTO.
UserProfileDTO user profile d t o
swagger:model UserProfileDTO.
UserSearchHitDTO user search hit d t o
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.
RawMessage raw message
swagger:model RawMessage.
Regexp Regexp is the representation of a compiled regular expression.
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
AlertStateType alert state type
swagger:model AlertStateType.
ConfFloat64 ConfFloat64 is a float64.
ContactPoints contact points
swagger:model ContactPoints.
CookieType cookie type
swagger:model CookieType.
CorrelationConfigType correlation config type
swagger:model CorrelationConfigType.
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.
DsPermissionType Datasource permission Description: `0` - No Access `1` - Query `2` - Edit Enum: 0,1,2
swagger:model DsPermissionType.
Duration A Duration represents the elapsed time between two instants as an int64 nanosecond count.
ErrorType ErrorType models the different API error types.
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).
Header header
swagger:model Header.
HitList hit list
swagger:model HitList.
HitType hit type
swagger:model HitType.
InspectType InspectType is a type for the Inspect property of a Notice.
ItemType Type of the item.
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.
ObjectMatchers object matchers
swagger:model ObjectMatchers.
OverrideLabels override the labels type with a map for generation.
PermissionType permission type
swagger:model PermissionType.
PlaylistDashboardsSlice playlist dashboards slice
swagger:model PlaylistDashboardsSlice.
Playlists playlists
swagger:model Playlists.
Provenance provenance
swagger:model Provenance.
ProvisionedAlertRules provisioned alert rules
swagger:model ProvisionedAlertRules.
Responses Responses is a map of RefIDs (Unique Query ID) to DataResponses.
RuleType RuleType models the type of a rule.
Secret Secret special type for storing secrets.
SettingsBag settings bag
swagger:model SettingsBag.
State state
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 type
swagger:model Type.
ValueMappings value mappings
swagger:model ValueMappings.
Vector Vector is basically only an alias for model.Samples, 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.