openapi: 3.0.3 info: title: Grafana HTTP Access Public API description: The Grafana HTTP API provides programmatic access to Grafana's core functionality including dashboards, data sources, alerts, users, organizations, folders, annotations, and teams. Authentication is handled via API keys, basic auth, or OAuth tokens passed in the Authorization header. version: 11.0.0 contact: name: Grafana Labs url: https://grafana.com license: name: AGPL-3.0 url: https://www.gnu.org/licenses/agpl-3.0.html servers: - url: https://{instance}.grafana.net/api description: Grafana Cloud variables: instance: default: your-instance - url: http://localhost:3000/api description: Local Grafana instance security: - BearerAuth: [] - BasicAuth: [] - ApiKeyAuth: [] tags: - name: Public paths: /dashboards/public-dashboards: parameters: [] get: tags: - Public summary: Grafana List Public Dashboards description: This API operation retrieves a list of all public dashboards available in Grafana. It uses a GET request to the /dashboards/public-dashboards endpoint and returns information about dashboards that have been made publicly accessible, meaning they can be viewed without authentication. The response typically includes details such as dashboard UIDs, titles, access tokens, and configuration settings for each public dashboard. This endpoint is useful for administrators who need to audit or manage which dashboards are publicly shared and review their sharing settings. operationId: listPublicDashboards parameters: [] responses: '200': description: (empty) headers: {} content: application/json: schema: $ref: '#/components/schemas/PublicDashboardListResponseWithPagination' '401': description: UnauthorisedPublicError is returned when the request is not authenticated. headers: {} content: application/json: schema: $ref: '#/components/schemas/publicError1' '403': description: ForbiddenPublicError is returned if the user/token has insufficient permissions to access the requested resource. headers: {} content: application/json: schema: $ref: '#/components/schemas/publicError1' '500': description: InternalServerPublicError is a general error indicating something went wrong internally. headers: {} content: application/json: schema: $ref: '#/components/schemas/publicError1' deprecated: false x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /dashboards/uid/{dashboardUid}/public-dashboards: parameters: [] get: tags: - Public summary: Grafana Get Public Dashboard description: This API operation retrieves the public dashboard configuration for a specific Grafana dashboard identified by its unique identifier (dashboardUid). When a dashboard has been made publicly accessible, this GET endpoint returns the public dashboard settings and metadata, including information such as the public access token, sharing configuration, enabled state, and any annotations or time range settings that have been configured for public viewing. This allows administrators and applications to programmatically query and manage public dashboard sharing settings without requiring direct access to the Grafana UI. operationId: getPublicDashboard parameters: - name: dashboardUid in: path description: '' required: true schema: type: string responses: '200': description: (empty) headers: {} content: application/json: schema: $ref: '#/components/schemas/PublicDashboard' '400': description: BadRequestPublicError is returned when the request is invalid and it cannot be processed. headers: {} content: application/json: schema: $ref: '#/components/schemas/publicError1' '401': description: UnauthorisedPublicError is returned when the request is not authenticated. headers: {} content: application/json: schema: $ref: '#/components/schemas/publicError1' '403': description: ForbiddenPublicError is returned if the user/token has insufficient permissions to access the requested resource. headers: {} content: application/json: schema: $ref: '#/components/schemas/publicError1' '404': description: NotFoundPublicError is returned when the requested resource was not found. headers: {} content: application/json: schema: $ref: '#/components/schemas/publicError1' '500': description: InternalServerPublicError is a general error indicating something went wrong internally. headers: {} content: application/json: schema: $ref: '#/components/schemas/publicError1' deprecated: false x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true post: tags: - Public summary: Grafana Create Public Dashboard description: Creates a public dashboard that enables external users to view a specific Grafana dashboard without authentication. This operation takes a dashboard UID as a path parameter and accepts configuration options in the request body to control how the dashboard is shared publicly, including settings for time range, template variables, and access permissions. Once created, it generates a unique public URL that can be shared with anyone to view the dashboard's visualizations and data without requiring Grafana login credentials, making it useful for embedding dashboards in public websites or sharing metrics with external stakeholders. operationId: createPublicDashboard parameters: - name: dashboardUid in: path description: '' required: true schema: type: string requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/PublicDashboardDTO' required: true responses: '200': description: (empty) headers: {} content: application/json: schema: $ref: '#/components/schemas/PublicDashboard' '400': description: BadRequestPublicError is returned when the request is invalid and it cannot be processed. headers: {} content: application/json: schema: $ref: '#/components/schemas/publicError1' '401': description: UnauthorisedPublicError is returned when the request is not authenticated. headers: {} content: application/json: schema: $ref: '#/components/schemas/publicError1' '403': description: ForbiddenPublicError is returned if the user/token has insufficient permissions to access the requested resource. headers: {} content: application/json: schema: $ref: '#/components/schemas/publicError1' '500': description: InternalServerPublicError is a general error indicating something went wrong internally. headers: {} content: application/json: schema: $ref: '#/components/schemas/publicError1' deprecated: false x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /dashboards/uid/{dashboardUid}/public-dashboards/{uid}: parameters: [] delete: tags: - Public summary: Grafana Delete Public Dashboard description: Deletes a public dashboard by its unique identifier, removing public access to the specified dashboard. This operation requires both the dashboard's UID and the public dashboard's UID to locate and remove the specific public sharing configuration. Once deleted, the public link previously associated with this dashboard will no longer be accessible, and any users who had the public URL will lose access to view the dashboard anonymously. This is a permanent action that revokes the public sharing settings for the dashboard while leaving the underlying private dashboard intact. operationId: deletePublicDashboard parameters: - name: dashboardUid in: path description: '' required: true schema: type: string - name: uid in: path description: '' required: true schema: type: string responses: '200': description: An OKResponse is returned if the request was successful. headers: {} content: application/json: schema: $ref: '#/components/schemas/SuccessResponseBody' '400': description: BadRequestPublicError is returned when the request is invalid and it cannot be processed. headers: {} content: application/json: schema: $ref: '#/components/schemas/publicError1' '401': description: UnauthorisedPublicError is returned when the request is not authenticated. headers: {} content: application/json: schema: $ref: '#/components/schemas/publicError1' '403': description: ForbiddenPublicError is returned if the user/token has insufficient permissions to access the requested resource. headers: {} content: application/json: schema: $ref: '#/components/schemas/publicError1' '500': description: InternalServerPublicError is a general error indicating something went wrong internally. headers: {} content: application/json: schema: $ref: '#/components/schemas/publicError1' deprecated: false x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true patch: tags: - Public summary: Grafana Update Public Dashboard description: This API operation allows you to update an existing public dashboard in Grafana by specifying both the parent dashboard's unique identifier (dashboardUid) and the public dashboard's unique identifier (uid) in the endpoint path. Using the PATCH HTTP method, you can modify specific properties of the public dashboard configuration without replacing the entire resource, such as toggling public access, changing sharing settings, or updating time range configurations. This endpoint is particularly useful when you need to make incremental changes to how a dashboard is shared publicly, enabling administrators to fine-tune visibility and access controls for external users without affecting the underlying dashboard structure or requiring a complete reconfiguration of the public sharing settings. operationId: updatePublicDashboard parameters: - name: dashboardUid in: path description: '' required: true schema: type: string - name: uid in: path description: '' required: true schema: type: string requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/PublicDashboardDTO' required: true responses: '200': description: (empty) headers: {} content: application/json: schema: $ref: '#/components/schemas/PublicDashboard' '400': description: BadRequestPublicError is returned when the request is invalid and it cannot be processed. headers: {} content: application/json: schema: $ref: '#/components/schemas/publicError1' '401': description: UnauthorisedPublicError is returned when the request is not authenticated. headers: {} content: application/json: schema: $ref: '#/components/schemas/publicError1' '403': description: ForbiddenPublicError is returned if the user/token has insufficient permissions to access the requested resource. headers: {} content: application/json: schema: $ref: '#/components/schemas/publicError1' '500': description: InternalServerPublicError is a general error indicating something went wrong internally. headers: {} content: application/json: schema: $ref: '#/components/schemas/publicError1' deprecated: false x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /public/dashboards/{accessToken}: parameters: [] get: tags: - Public summary: Grafana View Public Dashboard description: This API operation retrieves and displays a public Grafana dashboard using a unique access token. When a GET request is made to the endpoint with a valid accessToken parameter, it returns the dashboard configuration and visualization data that has been publicly shared. This allows users to view specific dashboards without requiring authentication or login credentials, making it useful for sharing monitoring data, metrics, and analytics with external stakeholders or embedding dashboards in public websites and applications. operationId: viewPublicDashboard parameters: - name: accessToken in: path description: '' required: true schema: type: string responses: '200': description: (empty) headers: {} content: application/json: schema: $ref: '#/components/schemas/DashboardFullWithMeta' '400': description: BadRequestPublicError is returned when the request is invalid and it cannot be processed. headers: {} content: application/json: schema: $ref: '#/components/schemas/publicError1' '401': description: UnauthorisedPublicError is returned when the request is not authenticated. headers: {} content: application/json: schema: $ref: '#/components/schemas/publicError1' '403': description: ForbiddenPublicError is returned if the user/token has insufficient permissions to access the requested resource. headers: {} content: application/json: schema: $ref: '#/components/schemas/publicError1' '404': description: NotFoundPublicError is returned when the requested resource was not found. headers: {} content: application/json: schema: $ref: '#/components/schemas/publicError1' '500': description: InternalServerPublicError is a general error indicating something went wrong internally. headers: {} content: application/json: schema: $ref: '#/components/schemas/publicError1' deprecated: false x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /public/dashboards/{accessToken}/annotations: parameters: [] get: tags: - Public summary: Grafana Get Public Annotations description: This API operation retrieves public annotations for a specific Grafana dashboard using an access token. It accepts a GET request to the endpoint '/public/dashboards/{accessToken}/annotations' where the accessToken parameter identifies the publicly shared dashboard. The operation returns annotation data that can be displayed on the dashboard timeline, allowing viewers of public dashboards to see relevant markers, events, or notes without requiring authentication. This is particularly useful for sharing dashboards externally while maintaining context through visible annotations. operationId: getPublicAnnotations parameters: - name: accessToken in: path description: '' required: true schema: type: string responses: '200': description: (empty) headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/AnnotationEvent' description: '' contentMediaType: application/json '400': description: BadRequestPublicError is returned when the request is invalid and it cannot be processed. headers: {} content: application/json: schema: $ref: '#/components/schemas/publicError1' '401': description: UnauthorisedPublicError is returned when the request is not authenticated. headers: {} content: application/json: schema: $ref: '#/components/schemas/publicError1' '403': description: ForbiddenPublicError is returned if the user/token has insufficient permissions to access the requested resource. headers: {} content: application/json: schema: $ref: '#/components/schemas/publicError1' '404': description: NotFoundPublicError is returned when the requested resource was not found. headers: {} content: application/json: schema: $ref: '#/components/schemas/publicError1' '500': description: InternalServerPublicError is a general error indicating something went wrong internally. headers: {} content: application/json: schema: $ref: '#/components/schemas/publicError1' deprecated: false x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /public/dashboards/{accessToken}/panels/{panelId}/query: parameters: [] post: tags: - Public summary: Grafana Query Public Dashboard description: The Grafana POST endpoint at /public/dashboards/{accessToken}/panels/{panelId}/query enables querying data from a specific panel within a publicly shared dashboard. This operation requires an access token that grants permission to view the public dashboard and a panel ID to identify which panel's data should be retrieved. The endpoint allows external applications or users to programmatically fetch panel data without authentication beyond the public access token, making it useful for embedding dashboard visualizations in external websites, generating reports, or integrating Grafana metrics into other monitoring systems. The query executes the panel's configured data source query and returns the results in a structured format that can be consumed by the requesting application. operationId: queryPublicDashboard parameters: - name: accessToken in: path description: '' required: true schema: type: string - name: panelId in: path description: '' required: true schema: type: integer contentEncoding: int64 responses: '200': description: (empty) headers: {} content: application/json: schema: $ref: '#/components/schemas/QueryDataResponsecontainstheresultsfromaQueryDataRequest.' '400': description: BadRequestPublicError is returned when the request is invalid and it cannot be processed. headers: {} content: application/json: schema: $ref: '#/components/schemas/publicError1' '401': description: UnauthorisedPublicError is returned when the request is not authenticated. headers: {} content: application/json: schema: $ref: '#/components/schemas/publicError1' '403': description: ForbiddenPublicError is returned if the user/token has insufficient permissions to access the requested resource. headers: {} content: application/json: schema: $ref: '#/components/schemas/publicError1' '404': description: NotFoundPublicError is returned when the requested resource was not found. headers: {} content: application/json: schema: $ref: '#/components/schemas/publicError1' '500': description: InternalServerPublicError is a general error indicating something went wrong internally. headers: {} content: application/json: schema: $ref: '#/components/schemas/publicError1' deprecated: false x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true components: schemas: AnnotationPanelFilter: title: AnnotationPanelFilter type: object properties: exclude: type: boolean description: Should the specified panels be included or excluded ids: type: array items: type: integer contentEncoding: int32 description: Panel IDs that should be included or excluded DataLink: title: DataLink type: object properties: internal: allOf: - $ref: '#/components/schemas/InternalDataLink' - description: InternalDataLink definition to allow Explore links to be constructed in the backend targetBlank: type: boolean title: type: string url: type: string description: DataLink define what FrameMetamatches: title: FrameMetamatches type: object properties: channel: type: string description: Channel is the path to a stream in grafana live that has real-time updates for this data. custom: description: Custom datasource specific values. dataTopic: type: string description: nolint:revive executedQueryString: type: string description: 'ExecutedQueryString is the raw query sent to the underlying system. All macros and templating have been applied. When metadata contains this value, it will be shown in the query inspector.' notices: type: array items: $ref: '#/components/schemas/NoticeprovidesastructureforpresentingnotificationsinGrafanasuserinterface.' description: 'Notices provide additional information about the data in the Frame that Grafana can display to the user in the user interface.' path: type: string description: Path is a browsable path on the datasource. pathSeparator: type: string description: PathSeparator defines the separator pattern to decode a hierarchy. The default separator is '/'. preferredVisualisationPluginId: type: string description: 'PreferredVisualizationPluginId sets the panel plugin id to use to render the data when using Explore. If the plugin cannot be found will fall back to PreferredVisualization.' preferredVisualisationType: type: string stats: type: array items: $ref: '#/components/schemas/QueryStatisusedforstoringarbitrarystatisticsmetadatarelatedtoaqueryanditsresulte.g.totalrequesttimedataprocessingtime.' description: Stats is an array of query result statistics. type: type: string description: 'A FrameType string, when present in a frame''s metadata, asserts that the frame''s structure conforms to the FrameType''s specification. This property is currently optional, so FrameType may be FrameTypeUnknown even if the properties of the Frame correspond to a defined FrameType. +enum' typeVersion: type: array items: type: integer contentEncoding: int32 description: '' uniqueRowIdFields: type: array items: type: integer contentEncoding: int64 description: 'Array of field indices which values create a unique id for each row. Ideally this should be globally unique ID but that isn''t guarantied. Should help with keeping track and deduplicating rows in visualizations, especially with streaming data with frequent updates.' description: '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' DashboardMeta: title: DashboardMeta type: object properties: annotationsPermissions: allOf: - $ref: '#/components/schemas/AnnotationPermission' - description: +k8s:deepcopy-gen=true apiVersion: type: string canAdmin: type: boolean canDelete: type: boolean canEdit: type: boolean canSave: type: boolean canStar: type: boolean created: type: string contentEncoding: date-time createdBy: type: string expires: type: string contentEncoding: date-time folderId: type: integer description: 'Deprecated: use FolderUID instead' contentEncoding: int64 folderTitle: type: string folderUid: type: string folderUrl: type: string hasAcl: type: boolean isFolder: type: boolean isSnapshot: type: boolean isStarred: type: boolean provisioned: type: boolean provisionedExternalId: type: string publicDashboardEnabled: type: boolean slug: type: string type: type: string updated: type: string contentEncoding: date-time updatedBy: type: string url: type: string version: type: integer contentEncoding: int64 FieldrepresentsatypedcolumnofdatawithinaFrame.: title: FieldrepresentsatypedcolumnofdatawithinaFrame. type: object properties: config: $ref: '#/components/schemas/FieldConfigrepresentsthedisplaypropertiesforaField.' labels: type: object additionalProperties: type: string description: Labels are used to add metadata to an object. The JSON will always be sorted keys name: type: string description: 'Name is default identifier of the field. The name does not have to be unique, but the combination of name and Labels should be unique for proper behavior in all situations.' description: 'A Field is essentially a slice of various types with extra properties and methods. See NewField() for supported types. The slice data in the Field is a not exported, so methods on the Field are used to to manipulate its data.' PublicDashboardListResponse: title: PublicDashboardListResponse type: object properties: accessToken: type: string dashboardUid: type: string isEnabled: type: boolean slug: type: string title: type: string uid: type: string QueryStatisusedforstoringarbitrarystatisticsmetadatarelatedtoaqueryanditsresulte.g.totalrequesttimedataprocessingtime.: title: QueryStatisusedforstoringarbitrarystatisticsmetadatarelatedtoaqueryanditsresulte.g.totalrequesttimedataprocessingtime. type: object properties: color: type: object additionalProperties: {} description: 'Map values to a display color NOTE: this interface is under development in the frontend... so simple map for now' custom: type: object additionalProperties: {} description: Panel Specific Values decimals: type: integer contentEncoding: int32 description: type: string description: Description is human readable field metadata displayName: type: string description: DisplayName overrides Grafana default naming, should not be used from a data source displayNameFromDS: type: string description: DisplayNameFromDS overrides Grafana default naming strategy. filterable: type: boolean description: Filterable indicates if the Field's data can be filtered by additional calls. interval: type: number description: 'Interval indicates the expected regular step between values in the series. When an interval exists, consumers can identify "missing" values when the expected value is not present. The grafana timeseries visualization will render disconnected values when missing values are found it the time field. The interval uses the same units as the values. For time.Time, this is defined in milliseconds.' links: type: array items: $ref: '#/components/schemas/DataLink' description: The behavior when clicking on a result mappings: type: array items: type: object description: '' max: type: number description: 'ConfFloat64 is a float64. It Marshals float64 values of NaN of Inf to null.' min: type: number description: 'ConfFloat64 is a float64. It Marshals float64 values of NaN of Inf to null.' noValue: type: string description: Alternative to empty string path: type: string description: 'Path is an explicit path to the field in the datasource. When the frame meta includes a path, this will default to `${frame.meta.path}/${field.name} When defined, this value can be used as an identifier within the datasource scope, and may be used as an identifier to update values in a subsequent request' thresholds: allOf: - $ref: '#/components/schemas/ThresholdsConfig' - description: ThresholdsConfig setup thresholds type: allOf: - $ref: '#/components/schemas/FieldTypeConfig' - description: FieldTypeConfig has type specific configs, only one should be active at a time unit: type: string description: Numeric Options value: type: number writeable: type: boolean description: Writeable indicates that the datasource knows how to update this value description: 'The embedded FieldConfig''s display name must be set. It corresponds to the QueryResultMetaStat on the frontend (https://github.com/grafana/grafana/blob/master/packages/grafana-data/src/types/data.ts#L53).' LinkTransformationConfig: title: LinkTransformationConfig type: object properties: expression: type: string field: type: string mapValue: type: string type: type: string AnnotationQuery: title: AnnotationQuery type: object properties: builtIn: type: number description: Set to 1 for the standard annotation query all dashboards have by default. datasource: allOf: - $ref: '#/components/schemas/DataSourceRef' - description: Ref to a DataSource instance enable: type: boolean description: When enabled the annotation query is issued with every dashboard refresh filter: $ref: '#/components/schemas/AnnotationPanelFilter' hide: type: boolean description: 'Annotation queries can be toggled on or off at the top of the dashboard. When hide is true, the toggle is not shown in the dashboard.' iconColor: type: string description: Color to use for the annotation event markers name: type: string description: Name of annotation. placement: type: string description: Placement can be used to display the annotation query somewhere else on the dashboard other than the default location. target: allOf: - $ref: '#/components/schemas/AnnotationTarget' - description: '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' type: type: string description: TODO -- this should not exist here, it is based on the --grafana-- datasource description: 'TODO docs FROM: AnnotationQuery in grafana-data/src/types/annotations.ts' AnnotationTarget: title: AnnotationTarget type: object properties: limit: type: integer description: 'Only required/valid for the grafana datasource... but code+tests is already depending on it so hard to change' contentEncoding: int64 matchAny: type: boolean description: 'Only required/valid for the grafana datasource... but code+tests is already depending on it so hard to change' tags: type: array items: type: string description: 'Only required/valid for the grafana datasource... but code+tests is already depending on it so hard to change' type: type: string description: 'Only required/valid for the grafana datasource... but code+tests is already depending on it so hard to change' description: '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' AnnotationActions: title: AnnotationActions type: object properties: canAdd: type: boolean canDelete: type: boolean canEdit: type: boolean description: +k8s:deepcopy-gen=true DataResponsecontainstheresultsfromaDataQuery.: title: DataResponsecontainstheresultsfromaDataQuery. type: object properties: Error: type: string description: Error is a property to be set if the corresponding DataQuery has an error. ErrorSource: type: string Frames: type: array items: $ref: '#/components/schemas/FrameisacolumnardatastructurewhereeachcolumnisaField.' description: 'It is the main data container within a backend.DataResponse. There should be no `nil` entries in the Frames slice (making them pointers was a mistake).' Status: type: integer contentEncoding: int64 description: 'A map of RefIDs (unique query identifiers) to this type makes up the Responses property of a QueryDataResponse. The Error property is used to allow for partial success responses from the containing QueryDataResponse.' QueryDataResponsecontainstheresultsfromaQueryDataRequest.: title: QueryDataResponsecontainstheresultsfromaQueryDataRequest. type: object properties: results: type: object additionalProperties: $ref: '#/components/schemas/DataResponsecontainstheresultsfromaDataQuery.' description: 'The QueryData method the QueryDataHandler method will set the RefId property on the DataResponses'' frames based on these RefIDs.' description: It is the return type of a QueryData call. TimeRange: title: TimeRange type: object properties: from: type: string contentEncoding: date-time to: type: string contentEncoding: date-time description: Redefining this to avoid an import cycle InternalDataLink: title: InternalDataLink type: object properties: datasourceName: type: string datasourceUid: type: string panelsState: description: This is an object constructed with the keys as the values of the enum VisType and the value being a bag of properties query: {} timeRange: allOf: - $ref: '#/components/schemas/TimeRange' - description: Redefining this to avoid an import cycle transformations: type: array items: $ref: '#/components/schemas/LinkTransformationConfig' description: '' description: InternalDataLink definition to allow Explore links to be constructed in the backend ThresholdsConfig: title: ThresholdsConfig type: object properties: mode: type: string description: ThresholdsMode absolute or percentage steps: type: array items: $ref: '#/components/schemas/Threshold' description: Must be sorted by 'value', first value is always -Infinity description: ThresholdsConfig setup thresholds EmailDTO: title: EmailDTO type: object properties: recipient: type: string uid: type: string FrameisacolumnardatastructurewhereeachcolumnisaField.: title: FrameisacolumnardatastructurewhereeachcolumnisaField. type: object properties: Fields: type: array items: $ref: '#/components/schemas/FieldrepresentsatypedcolumnofdatawithinaFrame.' description: 'Fields are the columns of a frame. All Fields must be of the same the length when marshalling the Frame for transmission. There should be no `nil` entries in the Fields slice (making them pointers was a mistake).' Meta: allOf: - $ref: '#/components/schemas/FrameMetamatches' - description: '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' Name: type: string description: Name is used in some Grafana visualizations. RefID: type: string description: RefID is a property that can be set to match a Frame to its originating query. description: 'Each Field is well typed by its FieldType and supports optional Labels. A Frame is a general data container for Grafana. A Frame can be table data or time series data depending on its content and field types.' PublicDashboardListResponseWithPagination: title: PublicDashboardListResponseWithPagination type: object properties: page: type: integer contentEncoding: int64 perPage: type: integer contentEncoding: int64 publicDashboards: type: array items: $ref: '#/components/schemas/PublicDashboardListResponse' description: '' totalCount: type: integer contentEncoding: int64 Threshold: title: Threshold type: object properties: color: type: string state: type: string value: type: number description: 'ConfFloat64 is a float64. It Marshals float64 values of NaN of Inf to null.' description: Threshold a single step on the threshold list PublicDashboardDTO: title: PublicDashboardDTO type: object properties: accessToken: type: string annotationsEnabled: type: boolean isEnabled: type: boolean share: type: string timeSelectionEnabled: type: boolean uid: type: string PublicDashboard: title: PublicDashboard type: object properties: accessToken: type: string annotationsEnabled: type: boolean createdAt: type: string contentEncoding: date-time createdBy: type: integer contentEncoding: int64 dashboardUid: type: string isEnabled: type: boolean recipients: type: array items: $ref: '#/components/schemas/EmailDTO' description: '' share: type: string timeSelectionEnabled: type: boolean uid: type: string updatedAt: type: string contentEncoding: date-time updatedBy: type: integer contentEncoding: int64 FieldConfigrepresentsthedisplaypropertiesforaField.: title: FieldConfigrepresentsthedisplaypropertiesforaField. type: object properties: color: type: object additionalProperties: {} description: 'Map values to a display color NOTE: this interface is under development in the frontend... so simple map for now' custom: type: object additionalProperties: {} description: Panel Specific Values decimals: type: integer contentEncoding: int32 description: type: string description: Description is human readable field metadata displayName: type: string description: DisplayName overrides Grafana default naming, should not be used from a data source displayNameFromDS: type: string description: DisplayNameFromDS overrides Grafana default naming strategy. filterable: type: boolean description: Filterable indicates if the Field's data can be filtered by additional calls. interval: type: number description: 'Interval indicates the expected regular step between values in the series. When an interval exists, consumers can identify "missing" values when the expected value is not present. The grafana timeseries visualization will render disconnected values when missing values are found it the time field. The interval uses the same units as the values. For time.Time, this is defined in milliseconds.' links: type: array items: $ref: '#/components/schemas/DataLink' description: The behavior when clicking on a result mappings: type: array items: type: object description: '' max: type: number description: 'ConfFloat64 is a float64. It Marshals float64 values of NaN of Inf to null.' min: type: number description: 'ConfFloat64 is a float64. It Marshals float64 values of NaN of Inf to null.' noValue: type: string description: Alternative to empty string path: type: string description: 'Path is an explicit path to the field in the datasource. When the frame meta includes a path, this will default to `${frame.meta.path}/${field.name} When defined, this value can be used as an identifier within the datasource scope, and may be used as an identifier to update values in a subsequent request' thresholds: allOf: - $ref: '#/components/schemas/ThresholdsConfig' - description: ThresholdsConfig setup thresholds type: allOf: - $ref: '#/components/schemas/FieldTypeConfig' - description: FieldTypeConfig has type specific configs, only one should be active at a time unit: type: string description: Numeric Options writeable: type: boolean description: Writeable indicates that the datasource knows how to update this value DashboardFullWithMeta: title: DashboardFullWithMeta type: object properties: dashboard: type: object meta: $ref: '#/components/schemas/DashboardMeta' EnumFieldConfig: title: EnumFieldConfig type: object properties: color: type: array items: type: string description: Color is the color value for a given index (empty is undefined) description: type: array items: type: string description: Description of the enum state icon: type: array items: type: string description: Icon supports setting an icon for a given index value text: type: array items: type: string description: Value is the string display value for a given index description: 'Enum field config Vector values are used as lookup keys into the enum fields' publicError1: title: publicError1 required: - messageId - statusCode type: object properties: extra: type: object additionalProperties: {} description: Extra Additional information about the error message: type: string description: Message A human readable message messageId: type: string description: MessageID A unique identifier for the error statusCode: type: integer description: StatusCode The HTTP status code returned contentEncoding: int64 description: 'PublicError is derived from Error and only contains information available to the end user.' FieldTypeConfig: title: FieldTypeConfig type: object properties: enum: allOf: - $ref: '#/components/schemas/EnumFieldConfig' - description: 'Enum field config Vector values are used as lookup keys into the enum fields' description: FieldTypeConfig has type specific configs, only one should be active at a time SuccessResponseBody: title: SuccessResponseBody type: object properties: message: type: string AnnotationPermission: title: AnnotationPermission type: object properties: dashboard: allOf: - $ref: '#/components/schemas/AnnotationActions' - description: +k8s:deepcopy-gen=true organization: allOf: - $ref: '#/components/schemas/AnnotationActions' - description: +k8s:deepcopy-gen=true description: +k8s:deepcopy-gen=true DataSourceRef: title: DataSourceRef type: object properties: type: type: string description: The plugin type-id uid: type: string description: Specific datasource instance description: Ref to a DataSource instance NoticeprovidesastructureforpresentingnotificationsinGrafanasuserinterface.: title: NoticeprovidesastructureforpresentingnotificationsinGrafanasuserinterface. type: object properties: inspect: type: integer contentEncoding: int64 link: type: string description: 'Link is an optional link for display in the user interface and can be an absolute URL or a path relative to Grafana''s root url.' severity: type: integer contentEncoding: int64 text: type: string description: Text is freeform descriptive text for the notice. AnnotationEvent: title: AnnotationEvent type: object properties: color: type: string dashboardId: type: integer contentEncoding: int64 dashboardUID: type: string id: type: integer contentEncoding: int64 isRegion: type: boolean panelId: type: integer contentEncoding: int64 source: allOf: - $ref: '#/components/schemas/AnnotationQuery' - description: 'TODO docs FROM: AnnotationQuery in grafana-data/src/types/annotations.ts' tags: type: array items: type: string description: '' text: type: string time: type: integer contentEncoding: int64 timeEnd: type: integer contentEncoding: int64 securitySchemes: BearerAuth: type: http scheme: bearer description: Service account token or API key BasicAuth: type: http scheme: basic ApiKeyAuth: type: apiKey in: header name: Authorization description: 'Format: Bearer '