openapi: 3.0.3 info: title: Grafana HTTP Access Get 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: Get paths: /datasources: parameters: [] get: tags: - Get summary: Grafana Get Data Sources description: The GET /datasources endpoint in the Grafana HTTP API retrieves a list of all configured data sources within the Grafana instance. This operation returns an array of data source objects, each containing details such as the data source ID, name, type (like Prometheus, InfluxDB, or Elasticsearch), URL, access method, and other configuration parameters. Authentication is required to access this endpoint, and the response will only include data sources that the authenticated user has permission to view based on their role and organizational membership. This endpoint is commonly used for discovering available data sources, validating configurations, or building administrative tools that need to enumerate and manage data source connections within Grafana. operationId: getDataSources parameters: [] responses: '200': description: (empty) headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/DataSourceListItemDTO' description: '' contentMediaType: application/json '401': description: UnauthorizedError is returned when the request is not authenticated. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '403': description: ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '500': description: InternalServerError is a general error indicating something went wrong internally. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' deprecated: false x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /datasources/correlations: parameters: [] get: tags: - Get summary: Grafana Get Correlations description: This API operation retrieves correlation configurations from Grafana datasources. Correlations define relationships between different data sources, allowing users to create links and navigate between related data across multiple datasources. The GET request to the /datasources/correlations endpoint returns a list of all configured correlations in the Grafana instance, including details such as source and target datasources, correlation labels, and transformation rules that enable cross-datasource querying and exploration workflows. operationId: getCorrelations parameters: - name: limit in: query description: Limit the maximum number of correlations to return per page style: form explode: true schema: maximum: 1000 type: integer contentEncoding: int64 default: 100 - name: page in: query description: Page index for starting fetching correlations style: form explode: true schema: type: integer contentEncoding: int64 default: 1 - name: sourceUID in: query description: Source datasource UID filter to be applied to correlations style: form explode: true schema: type: array items: type: string responses: '200': description: (empty) headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/Correlation' description: '' contentMediaType: application/json '401': description: UnauthorizedError is returned when the request is not authenticated. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '404': description: NotFoundError is returned when the requested resource was not found. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '500': description: InternalServerError is a general error indicating something went wrong internally. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' deprecated: false x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /datasources/id/{name}: parameters: [] get: tags: - Get summary: Grafana Get Data Source Id By Name description: This API operation retrieves the unique identifier of a Grafana data source by providing its name as a path parameter. It performs a GET request to the endpoint '/datasources/id/{name}' where {name} is replaced with the actual name of the data source you want to look up. The operation returns the numeric ID associated with that specific data source, which can be useful for subsequent API calls that require the data source ID rather than its name. This is particularly helpful when you need to programmatically reference data sources in scripts or applications where you know the name but need the ID for other operations. operationId: getDataSourceIdByName parameters: - name: name in: path description: '' required: true schema: type: string responses: '200': description: (empty) headers: {} content: application/json: schema: $ref: '#/components/schemas/getDataSourceIDResponse' '401': description: UnauthorizedError is returned when the request is not authenticated. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '403': description: ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '404': description: NotFoundError is returned when the requested resource was not found. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '500': description: InternalServerError is a general error indicating something went wrong internally. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' deprecated: false x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /datasources/name/{name}: parameters: [] get: tags: - Get summary: Grafana Get Data Source By Name description: This API operation retrieves a specific data source configuration from Grafana by using its unique name as an identifier. When you send a GET request to the endpoint with the data source name as a path parameter, Grafana returns the complete configuration details of that data source, including its type, connection settings, authentication credentials, and other relevant metadata. This is particularly useful when you need to programmatically access or verify the configuration of a specific data source without knowing its numeric ID, making it more intuitive for automation scripts and integrations that work with human-readable names rather than database identifiers. operationId: getDataSourceByName parameters: - name: name in: path description: '' required: true schema: type: string responses: '200': description: (empty) headers: {} content: application/json: schema: $ref: '#/components/schemas/DataSource' '401': description: UnauthorizedError is returned when the request is not authenticated. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '403': description: ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '500': description: InternalServerError is a general error indicating something went wrong internally. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' deprecated: false x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /datasources/proxy/uid/{uid}/{datasource_proxy_route}: parameters: [] get: tags: - Get summary: Grafana Datasource Proxy GET By UID Calls description: This API operation performs a GET request to proxy datasource calls through Grafana using a datasource's unique identifier (UID). It forwards requests to the configured datasource via the specified proxy route, allowing Grafana to act as an intermediary between the client and the actual datasource. The operation uses the path pattern '/datasources/proxy/uid/{uid}/{datasource_proxy_route}' where {uid} identifies the specific datasource and {datasource_proxy_route} represents the downstream API path to be called on that datasource. This proxying mechanism enables secure datasource access while maintaining Grafana's authentication and authorization controls, eliminating the need for clients to have direct access to datasource credentials or endpoints. operationId: datasourceProxyGETByUIDcalls parameters: - name: datasource_proxy_route in: path description: '' required: true schema: type: string - name: uid in: path description: '' required: true schema: type: string responses: '200': description: (empty) headers: {} content: {} '400': description: BadRequestError is returned when the request is invalid and it cannot be processed. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '401': description: UnauthorizedError is returned when the request is not authenticated. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '403': description: ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '404': description: NotFoundError is returned when the requested resource was not found. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '500': description: InternalServerError is a general error indicating something went wrong internally. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' deprecated: false x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /datasources/proxy/{id}/{datasource_proxy_route}: parameters: [] get: tags: - Get summary: Grafana Datasource Proxy GET calls description: This API operation provides a proxy endpoint for executing GET requests against a configured datasource in Grafana. By specifying the datasource ID and a custom proxy route, it allows Grafana to forward requests to the underlying data source while handling authentication, CORS, and other middleware concerns transparently. This is particularly useful for querying data sources that may have complex authentication requirements or need to be accessed from the browser without exposing credentials, as Grafana acts as an intermediary that securely manages the connection to the data source and returns the results to the client. operationId: datasourceProxyGETcalls parameters: - name: datasource_proxy_route in: path description: '' required: true schema: type: string - name: id in: path description: '' required: true schema: type: string responses: '200': description: (empty) headers: {} content: {} '400': description: BadRequestError is returned when the request is invalid and it cannot be processed. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '401': description: UnauthorizedError is returned when the request is not authenticated. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '403': description: ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '404': description: NotFoundError is returned when the requested resource was not found. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '500': description: InternalServerError is a general error indicating something went wrong internally. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' deprecated: true x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /datasources/uid/{sourceUID}/correlations: parameters: [] get: tags: - Get summary: Grafana Get Correlations By Source UID description: This API operation retrieves all correlations associated with a specific data source in Grafana by providing the data source's unique identifier (UID). It uses a GET request to the endpoint /datasources/uid/{sourceUID}/correlations, where {sourceUID} is replaced with the actual UID of the data source you want to query. The operation returns a list of correlation configurations that have been defined for the specified data source, which are used to link related data across different data sources in Grafana, enabling users to navigate between panels and dashboards based on contextual relationships in their observability data. operationId: getCorrelationsBySourceUID parameters: - name: sourceUID in: path description: '' required: true schema: type: string responses: '200': description: (empty) headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/Correlation' description: '' contentMediaType: application/json '401': description: UnauthorizedError is returned when the request is not authenticated. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '404': description: NotFoundError is returned when the requested resource was not found. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '500': description: InternalServerError is a general error indicating something went wrong internally. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' deprecated: false x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /datasources/uid/{sourceUID}/correlations/{correlationUID}: parameters: [] get: tags: - Get summary: Grafana Get Correlation description: The Get Correlation API operation in Grafana retrieves a specific correlation configuration between data sources using their unique identifiers. By making a GET request to the endpoint `/datasources/uid/{sourceUID}/correlations/{correlationUID}`, users can fetch detailed information about an existing correlation, including its configuration settings, transformations, and the relationship between a source data source and a target data source. This operation requires both the unique identifier of the source data source (sourceUID) and the unique identifier of the specific correlation (correlationUID) to return the correlation object with all its associated metadata and configuration parameters. operationId: getCorrelation parameters: - name: sourceUID in: path description: '' required: true schema: type: string - name: correlationUID in: path description: '' required: true schema: type: string responses: '200': description: (empty) headers: {} content: application/json: schema: $ref: '#/components/schemas/Correlation' '401': description: UnauthorizedError is returned when the request is not authenticated. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '404': description: NotFoundError is returned when the requested resource was not found. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '500': description: InternalServerError is a general error indicating something went wrong internally. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' deprecated: false x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /datasources/uid/{uid}: parameters: [] get: tags: - Get summary: Grafana Get Data Source By UID description: This API operation retrieves detailed information about a specific data source in Grafana by providing its unique identifier (UID). When called with a GET request to the endpoint /datasources/uid/{uid}, it returns the complete configuration and metadata for the requested data source, including its name, type, access method, connection details, and other relevant settings. This endpoint is particularly useful when you need to programmatically query or verify the configuration of a specific data source using its immutable UID rather than its numeric ID, which may change across different Grafana instances or during migrations. operationId: getDataSourceByUID parameters: - name: uid in: path description: '' required: true schema: type: string responses: '200': description: (empty) headers: {} content: application/json: schema: $ref: '#/components/schemas/DataSource' '400': description: BadRequestError is returned when the request is invalid and it cannot be processed. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '401': description: UnauthorizedError is returned when the request is not authenticated. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '403': description: ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '404': description: NotFoundError is returned when the requested resource was not found. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '500': description: InternalServerError is a general error indicating something went wrong internally. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' deprecated: false x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /datasources/{id}: parameters: [] get: tags: - Get summary: Grafana Get Data Source By ID description: Retrieves detailed information about a specific data source in Grafana by providing its unique identifier. This endpoint returns comprehensive configuration details for the data source including its name, type, URL, access mode, authentication settings, and other metadata associated with the specified ID. It requires appropriate permissions to view data source configurations and is commonly used when you need to inspect or verify the settings of a particular data source that has already been configured in your Grafana instance. operationId: getDataSourceByID parameters: - name: id in: path description: '' required: true schema: type: string responses: '200': description: (empty) headers: {} content: application/json: schema: $ref: '#/components/schemas/DataSource' '400': description: BadRequestError is returned when the request is invalid and it cannot be processed. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '401': description: UnauthorizedError is returned when the request is not authenticated. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '403': description: ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '404': description: NotFoundError is returned when the requested resource was not found. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '500': description: InternalServerError is a general error indicating something went wrong internally. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' deprecated: true x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /folders: parameters: [] get: tags: - Get summary: Grafana Get Folders description: Retrieves a list of all folders in the Grafana instance. This endpoint returns folder metadata including folder ID, UID, title, and URL, allowing users to navigate and organize dashboards hierarchically. The operation supports optional query parameters to filter results by limit and page for pagination. Authentication is required and the response includes an array of folder objects that can be used to manage dashboard organization and access control within Grafana. operationId: getFolders parameters: - name: limit in: query description: Limit the maximum number of folders to return style: form explode: true schema: type: integer contentEncoding: int64 default: 1000 - name: page in: query description: Page index for starting fetching folders style: form explode: true schema: type: integer contentEncoding: int64 default: 1 - name: parentUid in: query description: The parent folder UID style: form explode: true schema: type: string - name: permission in: query description: Set to `Edit` to return folders that the user can edit style: form explode: true schema: allOf: - $ref: '#/components/schemas/permission1' - description: Set to `Edit` to return folders that the user can edit responses: '200': description: (empty) headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/FolderSearchHit' description: '' contentMediaType: application/json '401': description: UnauthorizedError is returned when the request is not authenticated. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '403': description: ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '500': description: InternalServerError is a general error indicating something went wrong internally. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' deprecated: false x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /folders/id/{folder_id}: parameters: [] get: tags: - Get summary: Grafana Get Folder By ID description: The GET /folders/id/{folder_id} endpoint in Grafana retrieves detailed information about a specific folder using its unique identifier. This operation allows users to fetch folder metadata including its title, UID, permissions, and other configuration details by providing the numeric folder ID in the path parameter. It's particularly useful when you need to access folder information programmatically and have the folder's ID rather than its UID, returning a JSON response with the complete folder object if found or an error if the folder doesn't exist or the user lacks sufficient permissions to view it. operationId: getFolderByID parameters: - name: folder_id in: path description: '' required: true schema: type: integer contentEncoding: int64 responses: '200': description: (empty) headers: {} content: application/json: schema: $ref: '#/components/schemas/Folder' '401': description: UnauthorizedError is returned when the request is not authenticated. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '403': description: ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '404': description: NotFoundError is returned when the requested resource was not found. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '500': description: InternalServerError is a general error indicating something went wrong internally. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' deprecated: true x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /folders/{folder_uid}: parameters: [] get: tags: - Get summary: Grafana Get Folder By UID description: This API operation retrieves detailed information about a specific Grafana folder by providing its unique identifier (UID). By making a GET request to the endpoint with the folder's UID as a path parameter, users can fetch metadata about the folder including its title, UID, ID, URL, version, and other configuration details. This is useful for programmatically accessing folder properties, verifying folder existence, or gathering information needed for subsequent operations such as dashboard management or permission configuration within that specific folder. operationId: getFolderByUID parameters: - name: folder_uid in: path description: '' required: true schema: type: string responses: '200': description: (empty) headers: {} content: application/json: schema: $ref: '#/components/schemas/Folder' '401': description: UnauthorizedError is returned when the request is not authenticated. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '403': description: ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '404': description: NotFoundError is returned when the requested resource was not found. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '500': description: InternalServerError is a general error indicating something went wrong internally. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' deprecated: false x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /folders/{folder_uid}/counts: parameters: [] get: tags: - Get summary: Grafana Get Folder Descendant Counts description: Returns statistical information about the descendants of a specified folder in Grafana, identified by its unique folder UID. This endpoint retrieves count data for various types of resources that exist within the folder hierarchy, such as dashboards, alerts, and other nested folders, providing administrators and users with a quick overview of the folder's contents without needing to traverse the entire folder structure manually. operationId: getFolderDescendantCounts parameters: - name: folder_uid in: path description: '' required: true schema: type: string responses: '200': description: (empty) headers: {} content: application/json: schema: type: object additionalProperties: type: integer format: int64 contentMediaType: application/json '401': description: UnauthorizedError is returned when the request is not authenticated. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '403': description: ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '404': description: NotFoundError is returned when the requested resource was not found. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '500': description: InternalServerError is a general error indicating something went wrong internally. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' deprecated: false x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /folders/{folder_uid}/permissions: parameters: [] get: tags: - Get summary: Grafana Get Folder Permission List description: This API operation retrieves the complete list of permissions associated with a specific folder in Grafana by providing the folder's unique identifier (UID) in the request path. It returns details about which users, teams, or roles have access to the folder and what level of permissions they possess, such as view, edit, or admin rights. This GET endpoint is useful for auditing folder access controls, understanding the current permission structure, and determining who has what level of access to dashboards and resources contained within the specified folder. operationId: getFolderPermissionList parameters: - name: folder_uid in: path description: '' required: true schema: type: string responses: '200': description: (empty) headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/DashboardACLInfoDTO' description: '' contentMediaType: application/json '401': description: UnauthorizedError is returned when the request is not authenticated. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '403': description: 'ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource. ' headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '404': description: NotFoundError is returned when the requested resource was not found. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '500': description: InternalServerError is a general error indicating something went wrong internally. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' deprecated: false x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /admin/settings: parameters: [] get: tags: - Get summary: Grafana Admin Get Settings description: The Admin Get Settings endpoint in Grafana's Admin API allows administrators with appropriate permissions to retrieve the current configuration settings of the Grafana instance. This GET operation at the /admin/settings path returns a comprehensive view of all server settings, including data source configurations, authentication settings, feature toggles, and other system-wide parameters. The endpoint is typically used for administrative tasks such as auditing configurations, troubleshooting issues, or verifying that settings have been applied correctly. Access to this endpoint requires admin-level privileges as it exposes sensitive configuration information about the Grafana deployment. operationId: adminGetSettings parameters: [] responses: '200': description: (empty) headers: {} content: application/json: schema: type: object additionalProperties: type: string contentMediaType: application/json '401': description: UnauthorizedError is returned when the request is not authenticated. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '403': description: ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' deprecated: false security: - basic: [] x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /admin/stats: parameters: [] get: tags: - Get summary: Grafana Admin Get Stats description: The Grafana Admin Get Stats API operation is an administrative endpoint accessible via HTTP GET request at `/admin/stats` that retrieves statistical information and metrics about the Grafana instance. This endpoint requires administrator privileges and provides aggregated data such as user counts, dashboard counts, data source statistics, organization metrics, and other system-wide analytics that help administrators monitor the overall health, usage, and growth of their Grafana deployment. The statistics returned offer insights into resource utilization and platform adoption within the organization. operationId: adminGetStats parameters: [] responses: '200': description: (empty) headers: {} content: application/json: schema: $ref: '#/components/schemas/AdminStats' '401': description: UnauthorizedError is returned when the request is not authenticated. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '403': description: ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '500': description: InternalServerError is a general error indicating something went wrong internally. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' deprecated: false x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /annotations: parameters: [] get: tags: - Get summary: Grafana Get Annotations description: The GET /annotations endpoint in Grafana retrieves annotations that have been created for dashboards and panels. Annotations are metadata markers used to overlay event information on graphs, helping users correlate metrics with significant events like deployments, incidents, or system changes. This operation allows you to query and filter annotations based on various parameters such as time range, dashboard ID, panel ID, tags, and annotation type. The endpoint returns a list of annotation objects containing details like the annotation text, time, tags, and associated dashboard or panel information. This is particularly useful for programmatically accessing annotation data for reporting, analysis, or integration with external systems. operationId: getAnnotations parameters: - name: from in: query description: Find annotations created after specific epoch datetime in milliseconds. style: form explode: true schema: type: integer contentEncoding: int64 - name: to in: query description: Find annotations created before specific epoch datetime in milliseconds. style: form explode: true schema: type: integer contentEncoding: int64 - name: userId in: query description: Limit response to annotations created by specific user. style: form explode: true schema: type: integer contentEncoding: int64 - name: alertId in: query description: 'Find annotations for a specified alert rule by its ID. deprecated: AlertID is deprecated and will be removed in future versions. Please use AlertUID instead.' style: form explode: true schema: type: integer contentEncoding: int64 - name: alertUID in: query description: Find annotations for a specified alert rule by its UID. style: form explode: true schema: type: string - name: dashboardId in: query description: Find annotations that are scoped to a specific dashboard style: form explode: true schema: type: integer contentEncoding: int64 - name: dashboardUID in: query description: Find annotations that are scoped to a specific dashboard style: form explode: true schema: type: string - name: panelId in: query description: Find annotations that are scoped to a specific panel style: form explode: true schema: type: integer contentEncoding: int64 - name: limit in: query description: Max limit for results returned. style: form explode: true schema: type: integer contentEncoding: int64 - name: tags in: query description: Use this to filter organization annotations. Organization annotations are annotations from an annotation data source that are not connected specifically to a dashboard or panel. You can filter by multiple tags. style: form explode: true schema: type: array items: type: string - name: type in: query description: Return alerts or user created annotations style: form explode: true schema: allOf: - $ref: '#/components/schemas/type3' - description: Return alerts or user created annotations - name: matchAny in: query description: Match any or all tags style: form explode: true schema: type: boolean responses: '200': description: (empty) headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/Annotation' description: '' contentMediaType: application/json '401': description: UnauthorizedError is returned when the request is not authenticated. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '500': description: InternalServerError is a general error indicating something went wrong internally. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' deprecated: false x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /annotations/tags: parameters: [] get: tags: - Get summary: Grafana Get Annotation Tags description: The Get Annotation Tags operation retrieves all tags that have been used in annotations within Grafana. This endpoint returns a list of tag objects that represent the various labels applied to annotations across the system, making it useful for discovering available tags before filtering annotations or for populating tag selection interfaces. The response provides tag metadata that can be used to query or organize annotations by their associated tags, helping users navigate and categorize their annotation data more effectively. operationId: getAnnotationTags parameters: - name: tag in: query description: Tag is a string that you can use to filter tags. style: form explode: true schema: type: string - name: limit in: query description: Max limit for results returned. style: form explode: true schema: type: string default: '100' responses: '200': description: (empty) headers: {} content: application/json: schema: $ref: '#/components/schemas/GetAnnotationTagsResponseisaresponsestructforFindTagsResult.' '401': description: UnauthorizedError is returned when the request is not authenticated. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '500': description: InternalServerError is a general error indicating something went wrong internally. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' deprecated: false x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /annotations/{annotation_id}: parameters: [] get: tags: - Get summary: Grafana Get Annotation By ID description: Retrieves detailed information about a specific annotation in Grafana using its unique identifier. This GET operation allows users to fetch a single annotation's complete data including its text, tags, time range, dashboard and panel associations, and metadata by providing the annotation ID as a path parameter. It's useful for viewing or auditing individual annotations, or as part of workflows that need to process or display annotation details programmatically. operationId: getAnnotationByID parameters: - name: annotation_id in: path description: '' required: true schema: type: string responses: '200': description: (empty) headers: {} content: application/json: schema: $ref: '#/components/schemas/Annotation' '401': description: UnauthorizedError is returned when the request is not authenticated. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '500': description: InternalServerError is a general error indicating something went wrong internally. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' deprecated: false x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /library-elements: parameters: [] get: tags: - Get summary: Grafana Get Library Elements description: This API operation retrieves library elements from Grafana, which are reusable components such as panels or variables that can be shared across multiple dashboards. When called, it returns a list of library elements available in the Grafana instance, allowing users to query and fetch these shared resources for dashboard creation or management purposes. The GET request to the /library-elements endpoint provides access to the library element catalog, enabling efficient reuse of dashboard components across an organization's Grafana environment. operationId: getLibraryElements parameters: - name: searchString in: query description: Part of the name or description searched for. style: form explode: true schema: type: string - name: kind in: query description: Kind of element to search for. style: form explode: true schema: type: integer contentEncoding: int64 - name: sortDirection in: query description: Sort order of elements. style: form explode: true schema: allOf: - $ref: '#/components/schemas/sortDirection' - description: Sort order of elements. - name: typeFilter in: query description: A comma separated list of types to filter the elements by style: form explode: true schema: type: string - name: excludeUid in: query description: Element UID to exclude from search results. style: form explode: true schema: type: string - name: folderFilter in: query description: A comma separated list of folder ID(s) to filter the elements by. style: form explode: true schema: type: string - name: perPage in: query description: The number of results per page. style: form explode: true schema: type: integer contentEncoding: int64 default: 100 - name: page in: query description: The page for a set of records, given that only perPage records are returned at a time. Numbering starts at 1. style: form explode: true schema: type: integer contentEncoding: int64 default: 1 responses: '200': description: (empty) headers: {} content: application/json: schema: $ref: '#/components/schemas/LibraryElementSearchResponseisaresponsestructforLibraryElementSearchResult.' '401': description: UnauthorizedError is returned when the request is not authenticated. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '500': description: InternalServerError is a general error indicating something went wrong internally. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' deprecated: false x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /library-elements/name/{library_element_name}: parameters: [] get: tags: - Get summary: Grafana Get Library Element By Name description: Gets a library element with the specified name from Grafana's library elements collection. This endpoint retrieves a single library element by providing its unique name as a path parameter. Library elements in Grafana are reusable components like panels or data sources that can be shared across multiple dashboards. The operation returns the complete library element object including its configuration, metadata, and any associated properties. This is useful when you need to reference or reuse a specific library element in your dashboard configurations or when you want to retrieve details about a named library element without knowing its numeric ID. operationId: getLibraryElementByName parameters: - name: library_element_name in: path description: '' required: true schema: type: string responses: '200': description: (empty) headers: {} content: application/json: schema: $ref: '#/components/schemas/LibraryElementArrayResponseisaresponsestructforanarrayofLibraryElementDTO.' '401': description: UnauthorizedError is returned when the request is not authenticated. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '404': description: NotFoundError is returned when the requested resource was not found. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '500': description: InternalServerError is a general error indicating something went wrong internally. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' deprecated: false x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /library-elements/{library_element_uid}: parameters: [] get: tags: - Get summary: Grafana Get Library Element By UID description: This API operation retrieves a specific library element from Grafana using its unique identifier (UID). Library elements in Grafana are reusable components such as panels or variables that can be shared across multiple dashboards. By making a GET request to this endpoint with a library element's UID, users can fetch the complete configuration and metadata of that particular library element, including its type, name, model definition, and any associated properties. This is useful when you need to inspect, reference, or programmatically work with shared dashboard components in your Grafana instance. operationId: getLibraryElementByUID parameters: - name: library_element_uid in: path description: '' required: true schema: type: string responses: '200': description: (empty) headers: {} content: application/json: schema: $ref: '#/components/schemas/LibraryElementResponseisaresponsestructforLibraryElementDTO.' '401': description: UnauthorizedError is returned when the request is not authenticated. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '403': description: ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '404': description: NotFoundError is returned when the requested resource was not found. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '500': description: InternalServerError is a general error indicating something went wrong internally. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' deprecated: false x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /library-elements/{library_element_uid}/connections/: parameters: [] get: tags: - Get summary: Grafana Get Library Element Connections description: This API operation retrieves all the connections associated with a specific library element in Grafana by providing its unique identifier (UID). When called, it returns information about where and how the library element is being used across different dashboards and panels within the Grafana instance. This is particularly useful for understanding dependencies and the impact of modifying or deleting a library element, as it shows all the locations where the element is currently referenced or utilized. operationId: getLibraryElementConnections parameters: - name: library_element_uid in: path description: '' required: true schema: type: string responses: '200': description: (empty) headers: {} content: application/json: schema: $ref: '#/components/schemas/LibraryElementConnectionsResponseisaresponsestructforanarrayofLibraryElementConnectionDTO.' '401': description: UnauthorizedError is returned when the request is not authenticated. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '403': description: ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '404': description: NotFoundError is returned when the requested resource was not found. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '500': description: InternalServerError is a general error indicating something went wrong internally. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' deprecated: false x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /orgs/name/{org_name}: parameters: [] get: tags: - Get summary: Grafana Get Org By Name description: Returns the details of a specific Grafana organization by searching for it using its unique organization name rather than its numeric ID. This endpoint provides an alternative way to retrieve organization information when you know the organization's name but not its ID, returning the same organization data structure including ID, name, and address that would be obtained through the standard ID-based lookup endpoint. operationId: getOrgByName parameters: - name: org_name in: path description: '' required: true schema: type: string responses: '200': description: (empty) headers: {} content: application/json: schema: $ref: '#/components/schemas/OrgDetailsDTO' '401': description: UnauthorizedError is returned when the request is not authenticated. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '403': description: ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '500': description: InternalServerError is a general error indicating something went wrong internally. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' deprecated: false security: - basic: [] x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /orgs/{org_id}: parameters: [] get: tags: - Get summary: Grafana Get Org By ID description: This API operation retrieves detailed information about a specific organization in Grafana by providing its unique organizational identifier. When called with a valid org_id parameter, it returns the organization's configuration data including name, address, and other organizational metadata. This endpoint requires appropriate authentication and authorization to access the organization's details, making it essential for administrative functions and integrations that need to query or display information about a particular Grafana organization. operationId: getOrgByID parameters: - name: org_id in: path description: '' required: true schema: type: integer contentEncoding: int64 responses: '200': description: (empty) headers: {} content: application/json: schema: $ref: '#/components/schemas/OrgDetailsDTO' '401': description: UnauthorizedError is returned when the request is not authenticated. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '403': description: ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '500': description: InternalServerError is a general error indicating something went wrong internally. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' deprecated: false security: - basic: [] x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /orgs/{org_id}/users: parameters: [] get: tags: - Get summary: Grafana Get Org Users description: Retrieves a list of all users that belong to a specific organization in Grafana by providing the organization ID in the URL path. This GET endpoint returns user details including their names, email addresses, roles, and permissions within the specified organization, allowing administrators to view and manage organization membership and access control. operationId: getOrgUsers parameters: - name: org_id in: path description: '' required: true schema: type: integer contentEncoding: int64 responses: '200': description: (empty) headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/OrgUserDTO' description: '' contentMediaType: application/json '401': description: UnauthorizedError is returned when the request is not authenticated. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '403': description: ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '500': description: InternalServerError is a general error indicating something went wrong internally. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' deprecated: false security: - basic: [] x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /org: parameters: [] get: tags: - Get summary: Grafana Get Current Org description: This API operation retrieves information about the currently authenticated user's organization in Grafana. When called, it returns details of the organization context that the user is currently operating within, including properties such as the organization ID, name, and address. This is a GET request to the /org endpoint that requires authentication and provides essential context about which organizational scope the user's actions and queries will apply to within the Grafana instance. operationId: getCurrentOrg parameters: [] responses: '200': description: (empty) headers: {} content: application/json: schema: $ref: '#/components/schemas/OrgDetailsDTO' '401': description: UnauthorizedError is returned when the request is not authenticated. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '403': description: ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '500': description: InternalServerError is a general error indicating something went wrong internally. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' deprecated: false x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /org/invites: parameters: [] get: tags: - Get summary: Grafana Get Pending Org Invites description: This API operation retrieves a list of all pending invitations for the current organization in Grafana. When called using a GET request to the /org/invites endpoint, it returns information about users who have been invited to join the organization but have not yet accepted their invitations. The response typically includes details such as the invitee's email address, invitation date, role assigned, and invitation status. This endpoint is useful for organization administrators to monitor outstanding invitations, track who has been invited but hasn't joined, and manage the invitation lifecycle within their Grafana instance. operationId: getPendingOrgInvites parameters: [] responses: '200': description: (empty) headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/TempUserDTO' description: '' contentMediaType: application/json '401': description: UnauthorizedError is returned when the request is not authenticated. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '403': description: ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '500': description: InternalServerError is a general error indicating something went wrong internally. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' deprecated: false x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /org/preferences: parameters: [] get: tags: - Get summary: Grafana Get Org Preferences description: This API operation retrieves the current preference settings for the active organization in Grafana. When called, it returns a JSON object containing various organizational preferences such as the default theme, home dashboard ID, timezone settings, and other UI-related configurations that apply to all users within the organization. This is a read-only GET request that requires appropriate permissions to access organizational settings and is commonly used by administrators to review or verify the current preference configuration before making changes or to integrate organizational settings into external tools and automation workflows. operationId: getOrgPreferences parameters: [] responses: '200': description: (empty) headers: {} content: application/json: schema: $ref: '#/components/schemas/PreferencesSpec' '401': description: UnauthorizedError is returned when the request is not authenticated. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '403': description: ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '500': description: InternalServerError is a general error indicating something went wrong internally. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' deprecated: false x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /org/users: parameters: [] get: tags: - Get summary: Grafana Get Org Users For Current Org description: This API operation retrieves a list of all users who belong to the currently authenticated organization in Grafana. When called, it returns user information for members of the organization context associated with the API request, including details such as user IDs, email addresses, login names, roles within the organization, and authentication information. This is useful for administrators who need to audit organization membership, manage user access, or integrate Grafana's user management with external systems. The operation requires appropriate permissions within the current organization context to execute successfully. operationId: getOrgUsersForCurrentOrg parameters: - name: query in: query description: '' style: form explode: true schema: type: string - name: limit in: query description: '' style: form explode: true schema: type: integer contentEncoding: int64 responses: '200': description: (empty) headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/OrgUserDTO' description: '' contentMediaType: application/json '401': description: UnauthorizedError is returned when the request is not authenticated. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '403': description: ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '500': description: InternalServerError is a general error indicating something went wrong internally. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' deprecated: false x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /org/users/lookup: parameters: [] get: tags: - Get summary: Grafana Get Org Users For Current Org Lookup description: This API operation retrieves user information for members of the current organization in Grafana by performing a lookup query. It uses a GET request to the '/org/users/lookup' endpoint and returns details about users belonging to the organization context of the authenticated request. This is typically used when you need to search for or validate specific users within your current Grafana organization without iterating through the entire user list, providing a more efficient way to find user data based on lookup criteria such as login name or email address. operationId: getOrgUsersForCurrentOrgLookup parameters: - name: query in: query description: '' style: form explode: true schema: type: string - name: limit in: query description: '' style: form explode: true schema: type: integer contentEncoding: int64 responses: '200': description: (empty) headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/UserLookupDTO' description: '' contentMediaType: application/json '401': description: UnauthorizedError is returned when the request is not authenticated. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '403': description: ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '500': description: InternalServerError is a general error indicating something went wrong internally. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' deprecated: false x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /teams/{team_id}: parameters: [] get: tags: - Get summary: Grafana Get Team By ID description: This API operation retrieves detailed information about a specific team in Grafana by providing the team's unique identifier in the URL path. When a GET request is made to the /teams/{team_id} endpoint with a valid team ID, the API returns comprehensive data about that team, including properties such as the team name, email address, member count, and other relevant team metadata. This endpoint is typically used by administrators or applications that need to fetch information about a particular team for display purposes, integration workflows, or team management operations within the Grafana platform. operationId: getTeamByID parameters: - name: team_id in: path description: '' required: true schema: type: string - name: accesscontrol in: query description: '' style: form explode: true schema: type: boolean default: false responses: '200': description: (empty) headers: {} content: application/json: schema: $ref: '#/components/schemas/TeamDTO' '401': description: UnauthorizedError is returned when the request is not authenticated. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '403': description: ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '404': description: NotFoundError is returned when the requested resource was not found. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '500': description: InternalServerError is a general error indicating something went wrong internally. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' deprecated: false x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /teams/{team_id}/members: parameters: [] get: tags: - Get summary: Grafana Get Team Members description: This API operation retrieves a list of all members belonging to a specific team in Grafana by providing the team's unique identifier in the URL path. When called, it returns detailed information about each team member including their user ID, email, login credentials, and role within the team. This is useful for administrators and team leaders who need to audit team composition, manage access permissions, or integrate Grafana team data with external systems for user management and reporting purposes. operationId: getTeamMembers parameters: - name: team_id in: path description: '' required: true schema: type: string responses: '200': description: (empty) headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/TeamMemberDTO' description: '' contentMediaType: application/json '401': description: UnauthorizedError is returned when the request is not authenticated. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '403': description: ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '404': description: NotFoundError is returned when the requested resource was not found. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '500': description: InternalServerError is a general error indicating something went wrong internally. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' deprecated: false x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /teams/{team_id}/preferences: parameters: [] get: tags: - Get summary: Grafana Get Team Preferences description: Returns the preferences for a specific Grafana team identified by the team_id parameter, which includes settings such as the team's home dashboard, timezone, and theme preferences. This GET endpoint allows administrators and team members with appropriate permissions to retrieve the current preference configuration that applies to all members of the specified team, enabling them to view or audit the team-level settings that override individual user preferences when working within the team context. operationId: getTeamPreferences parameters: - name: team_id in: path description: '' required: true schema: type: string responses: '200': description: (empty) headers: {} content: application/json: schema: $ref: '#/components/schemas/PreferencesSpec' '401': description: UnauthorizedError is returned when the request is not authenticated. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '500': description: InternalServerError is a general error indicating something went wrong internally. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' deprecated: false x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /datasources/uid/{uid}/lbac/teams: parameters: [] get: tags: - Get summary: Grafana Get Team LBAC Rules Api description: This API operation retrieves team-based Label-Based Access Control (LBAC) rules for a specific data source in Grafana identified by its unique identifier (uid). When called with a GET request to the endpoint /datasources/uid/{uid}/lbac/teams, it returns the configured LBAC rules that determine which teams have access to specific labels or subsets of data within the specified data source. This functionality is essential for managing granular permissions and ensuring teams can only query and view data they are authorized to access within multi-tenant Grafana environments. operationId: getTeamLBACRulesApi parameters: - name: uid in: path description: '' required: true schema: type: string responses: '200': description: (empty) headers: {} content: application/json: schema: $ref: '#/components/schemas/TeamLBACRules' '400': description: BadRequestError is returned when the request is invalid and it cannot be processed. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '401': description: UnauthorizedError is returned when the request is not authenticated. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '403': description: ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '404': description: NotFoundError is returned when the requested resource was not found. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '500': description: InternalServerError is a general error indicating something went wrong internally. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' deprecated: false x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /datasources/{dataSourceUID}/cache: parameters: [] get: tags: - Get summary: Grafana Get Data Source Cache Config description: Retrieves the caching configuration settings for a specific data source in Grafana identified by its unique identifier (dataSourceUID). This GET operation allows administrators and users with appropriate permissions to view the current cache configuration parameters associated with a particular data source, which may include settings such as cache TTL (time-to-live), cache size limits, and enabled/disabled status. The response provides insight into how query results from this data source are being cached to optimize performance and reduce load on the underlying data source system. operationId: getDataSourceCacheConfig parameters: - name: dataSourceUID in: path description: '' required: true schema: type: string responses: '200': description: CacheConfigResponse headers: {} content: application/json: schema: $ref: '#/components/schemas/CacheConfigResponse' '500': description: InternalServerError is a general error indicating something went wrong internally. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' deprecated: false x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /access-control/roles/{roleUID}: parameters: [] get: tags: - Get summary: Grafana Get Role description: This API operation retrieves detailed information about a specific role in Grafana's access control system by providing the role's unique identifier (roleUID) in the URL path. When called with a GET request, it returns the complete role definition including the role's name, description, version, permissions, and any other associated metadata. This endpoint is useful for administrators who need to inspect role configurations, audit permissions, or retrieve role details before performing updates or modifications to the access control system. operationId: getRole parameters: - name: roleUID in: path description: '' required: true schema: type: string responses: '200': description: (empty) headers: {} content: application/json: schema: $ref: '#/components/schemas/RoleDTO' '403': description: ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '500': description: InternalServerError is a general error indicating something went wrong internally. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' deprecated: false x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /access-control/roles/{roleUID}/assignments: parameters: [] get: tags: - Get summary: Grafana Get Role Assignments description: This API operation retrieves all current assignments for a specific role in Grafana's access control system by providing the role's unique identifier (roleUID) in the endpoint path. When called with a GET request, it returns a list of users, teams, or service accounts that have been assigned the specified role, allowing administrators to audit and review who has been granted particular permissions within their Grafana instance. This is useful for security audits, compliance checks, and understanding the current permission distribution across the organization's Grafana environment. operationId: getRoleAssignments parameters: - name: roleUID in: path description: '' required: true schema: type: string responses: '200': description: (empty) headers: {} content: application/json: schema: $ref: '#/components/schemas/RoleAssignmentsDTO' '403': description: ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '404': description: NotFoundError is returned when the requested resource was not found. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '500': description: InternalServerError is a general error indicating something went wrong internally. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' deprecated: false x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /access-control/status: parameters: [] get: tags: - Get summary: Grafana Get Access Control Status description: This API operation retrieves the current status of Grafana's access control system, providing information about whether fine-grained access control (RBAC) is enabled and operational within the Grafana instance. It returns details about the access control configuration and its current state, allowing administrators to verify that permission management features are functioning correctly and to understand which access control mode is active. This is particularly useful for troubleshooting permission-related issues or confirming that enterprise access control features are properly configured. operationId: getAccessControlStatus parameters: [] responses: '200': description: (empty) headers: {} content: application/json: schema: type: integer contentEncoding: int64 contentMediaType: application/json '403': description: ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '404': description: NotFoundError is returned when the requested resource was not found. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '500': description: InternalServerError is a general error indicating something went wrong internally. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' deprecated: false x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /access-control/{resource}/description: parameters: [] get: tags: - Get summary: Grafana Get Resource Description description: This API operation retrieves the description of a specific access control resource in Grafana. By making a GET request to the endpoint with a resource identifier, it returns detailed information about what that particular resource represents within Grafana's role-based access control (RBAC) system. This is useful for understanding the purpose and context of different protected resources when managing permissions and access policies, allowing administrators to view human-readable descriptions of resources before assigning or modifying access controls. operationId: getResourceDescription parameters: - name: resource in: path description: '' required: true schema: type: string responses: '200': description: (empty) headers: {} content: application/json: schema: $ref: '#/components/schemas/Description' '403': description: ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '500': description: InternalServerError is a general error indicating something went wrong internally. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' deprecated: false x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /access-control/{resource}/{resourceID}: parameters: [] get: tags: - Get summary: Grafana Get Resource Permissions description: This API operation retrieves the access control permissions for a specific resource in Grafana by providing the resource type and resource ID as path parameters. It returns detailed information about who has access to the specified resource and what level of permissions they have been granted. This is useful for auditing and managing resource-level permissions within Grafana, allowing administrators to review which users, teams, or service accounts have been granted specific permissions on individual dashboards, folders, data sources, or other Grafana resources. operationId: getResourcePermissions parameters: - name: resource in: path description: '' required: true schema: type: string - name: resourceID in: path description: '' required: true schema: type: string responses: '200': description: (empty) headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/resourcePermissionDTO' description: '' contentMediaType: application/json '403': description: ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '404': description: NotFoundError is returned when the requested resource was not found. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '500': description: InternalServerError is a general error indicating something went wrong internally. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' deprecated: false x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /licensing/check: parameters: [] get: tags: - Get summary: Grafana Get Status description: This API operation retrieves the current licensing status information from a Grafana instance. When invoked using a GET request to the /licensing/check endpoint, it returns details about the active license, including validity, expiration dates, enabled features, and any limitations or restrictions associated with the current license tier. This endpoint is typically used by administrators to monitor license compliance, verify enterprise feature availability, and ensure the Grafana installation is properly licensed for its intended use case. operationId: getStatus parameters: [] responses: '200': description: (empty) headers: {} content: {} deprecated: false x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /licensing/custom-permissions: parameters: [] get: tags: - Get summary: Grafana Get Custom Permissions Report description: This API operation retrieves a custom permissions report from Grafana's licensing endpoint. When invoked via a GET request to the /licensing/custom-permissions path, it returns information about custom permission configurations and their usage within the Grafana instance. This endpoint is typically used by administrators to audit and review customized access control settings, helping them understand how permissions have been tailored beyond the standard roles and ensure compliance with licensing terms and organizational security policies. operationId: getCustomPermissionsReport parameters: [] responses: '500': description: InternalServerError is a general error indicating something went wrong internally. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' deprecated: true x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /licensing/custom-permissions-csv: parameters: [] get: tags: - Get summary: Grafana Get Custom Permissions CSV description: This API operation retrieves custom permissions data from Grafana in CSV format through a GET request to the /licensing/custom-permissions-csv endpoint. It allows administrators to export and download a comprehensive list of custom permission configurations that have been set up within their Grafana instance, which can be useful for auditing, backup purposes, or analyzing permission structures across the system. The response is formatted as a CSV file, making it easy to view, process, or import the permissions data into spreadsheet applications or other systems for further analysis and reporting. operationId: getCustomPermissionsCSV parameters: [] responses: '500': description: InternalServerError is a general error indicating something went wrong internally. headers: {} content: text/csv: schema: contentMediaType: text/csv deprecated: true x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /licensing/token: parameters: [] get: tags: - Get summary: Grafana Get License Token description: This API operation retrieves the current license token information from a Grafana instance. When invoked with a GET request to the /licensing/token endpoint, it returns details about the active licensing configuration, which may include token metadata, validity status, expiration dates, and associated entitlements or features enabled by the license. This endpoint is typically used by administrators to verify licensing status, check token validity, or retrieve license information for audit and compliance purposes within Grafana's enterprise or commercial offerings. operationId: getLicenseToken parameters: [] responses: '200': description: (empty) headers: {} content: application/json: schema: $ref: '#/components/schemas/Token' deprecated: false x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /reports: parameters: [] get: tags: - Get summary: Grafana Get Reports description: The Get Reports API operation in Grafana retrieves a list of all configured reports in the system. This endpoint allows administrators and authorized users to fetch comprehensive information about existing reports, including their configurations, schedules, and metadata. When invoked via a GET request to the /reports endpoint, it returns an array of report objects that contain details such as report names, dashboards they're associated with, scheduled delivery times, recipients, and rendering options. This operation is useful for auditing purposes, managing multiple reports, or integrating Grafana's reporting functionality with external systems for automated report distribution and monitoring. operationId: getReports parameters: [] responses: '200': description: (empty) headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/Report' description: '' contentMediaType: application/json '401': description: UnauthorizedError is returned when the request is not authenticated. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '403': description: ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '500': description: InternalServerError is a general error indicating something went wrong internally. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' deprecated: false x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /reports/dashboards/{uid}: parameters: [] get: tags: - Get summary: Grafana Get Reports By Dashboard UID description: This API operation retrieves all reports associated with a specific Grafana dashboard by using its unique identifier (UID). When you make a GET request to the endpoint /reports/dashboards/{uid}, where {uid} is replaced with the actual dashboard's UID, Grafana returns a list of all reports that have been configured for that particular dashboard. This is useful for administrators or users who need to view, audit, or manage the reporting configurations linked to a specific dashboard, allowing them to see details such as report schedules, recipients, formats, and other report-specific settings without having to search through all reports in the system. operationId: getReportsByDashboardUID parameters: - name: uid in: path description: '' required: true schema: type: string responses: '200': description: (empty) headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/Report' description: '' contentMediaType: application/json '401': description: UnauthorizedError is returned when the request is not authenticated. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '403': description: ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '500': description: InternalServerError is a general error indicating something went wrong internally. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' deprecated: false x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /reports/images/:image: parameters: [] get: tags: - Get summary: Grafana Get Settings Image description: This API operation retrieves a specific image that has been uploaded for use in Grafana reports by providing the image identifier in the URL path parameter. When called, it returns the settings and metadata associated with the requested image resource, allowing users to access images that can be embedded in their scheduled reports or exported dashboards. The GET method ensures read-only access to the image data without modifying any existing configurations. operationId: getSettingsImage parameters: [] responses: '200': description: (empty) headers: {} content: application/json: schema: type: array items: type: integer contentEncoding: int32 description: '' contentMediaType: application/json '401': description: UnauthorizedError is returned when the request is not authenticated. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '403': description: ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '404': description: NotFoundError is returned when the requested resource was not found. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '500': description: InternalServerError is a general error indicating something went wrong internally. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' deprecated: false x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /reports/settings: parameters: [] get: tags: - Get summary: Grafana Get Report Settings description: This API operation retrieves the current report settings configuration from Grafana. It is accessed via a GET request to the /reports/settings endpoint and returns the configured parameters that control how reports are generated and delivered within the Grafana instance. These settings typically include options such as branding configurations, email server settings, report scheduling parameters, and other preferences that affect the overall behavior of the reporting functionality. The operation requires appropriate authentication and authorization to access the reporting configuration data. operationId: getReportSettings parameters: [] responses: '200': description: (empty) headers: {} content: application/json: schema: $ref: '#/components/schemas/ReportSettings' '401': description: UnauthorizedError is returned when the request is not authenticated. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '403': description: ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '500': description: InternalServerError is a general error indicating something went wrong internally. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' deprecated: false x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /reports/{id}: parameters: [] get: tags: - Get summary: Grafana Get Report description: Retrieves the details of a specific report in Grafana by its unique identifier. This operation returns comprehensive information about the configured report including its name, dashboard reference, schedule settings, recipients, format options, and other metadata. The report ID must be provided as a path parameter to fetch the corresponding report configuration, allowing users to view or verify the settings of an existing scheduled report before editing or managing it. operationId: getReport parameters: - name: id in: path description: '' required: true schema: type: integer contentEncoding: int64 responses: '200': description: (empty) headers: {} content: application/json: schema: $ref: '#/components/schemas/Report' '400': description: BadRequestError is returned when the request is invalid and it cannot be processed. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '401': description: UnauthorizedError is returned when the request is not authenticated. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '403': description: ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '404': description: NotFoundError is returned when the requested resource was not found. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '500': description: InternalServerError is a general error indicating something went wrong internally. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' deprecated: true x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /admin/ldap-sync-status: parameters: [] get: tags: - Get summary: Grafana Get Sync Status description: This API endpoint retrieves the current synchronization status between Grafana and LDAP (Lightweight Directory Access Protocol) servers. It is an administrative GET operation that returns information about the last LDAP sync operation, including whether it was successful, when it occurred, and any relevant error messages or warnings. This endpoint is typically used by system administrators to monitor and troubleshoot LDAP integration, ensuring that user accounts and permissions are properly synchronized between the external LDAP directory and Grafana's internal user database. operationId: getSyncStatus parameters: [] responses: '200': description: (empty) headers: {} content: application/json: schema: $ref: '#/components/schemas/ActiveSyncStatusDTO' '401': description: UnauthorizedError is returned when the request is not authenticated. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '403': description: ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '500': description: InternalServerError is a general error indicating something went wrong internally. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' deprecated: false x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /admin/ldap/status: parameters: [] get: tags: - Get summary: Grafana Get LDAP Status description: This API operation retrieves the current status of LDAP integration in Grafana by sending a GET request to the /admin/ldap/status endpoint. It provides administrators with information about the LDAP connection status, configuration validation, and whether the LDAP authentication system is functioning properly. The endpoint returns details that help verify if Grafana can successfully communicate with the configured LDAP server, making it useful for troubleshooting authentication issues and monitoring the health of LDAP-based user authentication within the Grafana instance. operationId: getLDAPStatus parameters: [] responses: '200': description: An OKResponse is returned if the request was successful. headers: {} content: application/json: schema: $ref: '#/components/schemas/SuccessResponseBody' '401': description: UnauthorizedError is returned when the request is not authenticated. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '403': description: ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '500': description: InternalServerError is a general error indicating something went wrong internally. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' deprecated: false security: - basic: [] x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /admin/ldap/{user_name}: parameters: [] get: tags: - Get summary: Grafana Get User From LDAP description: This API operation retrieves LDAP user information for a specific username from Grafana's admin interface. By making a GET request to the endpoint with a username parameter, administrators can query the LDAP directory to fetch detailed user data associated with that particular account. This is useful for verifying LDAP user configurations, troubleshooting authentication issues, or confirming user attributes before syncing them into Grafana. The operation requires admin-level permissions and returns user details such as name, email, groups, and other LDAP attributes configured in the Grafana LDAP integration settings. operationId: getUserFromLDAP parameters: - name: user_name 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' '401': description: UnauthorizedError is returned when the request is not authenticated. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '403': description: ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '500': description: InternalServerError is a general error indicating something went wrong internally. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' deprecated: false security: - basic: [] x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /admin/users/{user_id}/auth-tokens: parameters: [] get: tags: - Get summary: Grafana Admin Get User Auth Tokens description: Retrieves a list of authentication tokens associated with a specific user account in Grafana. This administrative endpoint requires admin privileges and allows system administrators to view all active auth tokens that have been generated for a particular user identified by their user ID. The operation returns token metadata including creation dates, last used timestamps, and token names, which helps administrators audit user access, monitor authentication activity, and identify potentially unauthorized or stale tokens that may need to be revoked for security purposes. operationId: adminGetUserAuthTokens parameters: - name: user_id in: path description: '' required: true schema: type: integer contentEncoding: int64 responses: '200': description: (empty) headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/UserToken' description: '' contentMediaType: application/json '401': description: UnauthorizedError is returned when the request is not authenticated. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '403': description: ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '500': description: InternalServerError is a general error indicating something went wrong internally. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' deprecated: false security: - basic: [] x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /admin/users/{user_id}/quotas: parameters: [] get: tags: - Get summary: Grafana Get User Quota description: This API operation retrieves the current quota limits and usage statistics for a specific user in Grafana. By making a GET request to the /admin/users/{user_id}/quotas endpoint with a valid user ID, administrators can view resource allocation details such as the maximum number of dashboards, data sources, or organizations that the specified user is allowed to create or use. The response provides both the configured quota limits and the current consumption for each quota type, enabling administrators to monitor resource usage, enforce limits, and make informed decisions about quota adjustments for individual users within their Grafana instance. operationId: getUserQuota parameters: - name: user_id in: path description: '' required: true schema: type: integer contentEncoding: int64 responses: '200': description: (empty) headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/QuotaDTO' description: '' contentMediaType: application/json '401': description: UnauthorizedError is returned when the request is not authenticated. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '403': description: ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '404': description: NotFoundError is returned when the requested resource was not found. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '500': description: InternalServerError is a general error indicating something went wrong internally. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' deprecated: false security: - basic: [] x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /org/quotas: parameters: [] get: tags: - Get summary: Grafana Get Current Org Quota description: This API operation retrieves the current resource quotas configured for the organization in Grafana. When called, it returns the quota limits that have been set for various resources such as the maximum number of users, dashboards, data sources, and API keys allowed within the organization. This is useful for administrators who need to monitor or verify the current quota settings to ensure they align with organizational policies and resource management requirements. The operation requires appropriate authentication and authorization, typically at the organization administrator level, to access this information. operationId: getCurrentOrgQuota parameters: [] responses: '200': description: (empty) headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/QuotaDTO' description: '' contentMediaType: application/json '401': description: UnauthorizedError is returned when the request is not authenticated. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '403': description: ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '404': description: NotFoundError is returned when the requested resource was not found. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '500': description: InternalServerError is a general error indicating something went wrong internally. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' deprecated: false x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /orgs/{org_id}/quotas: parameters: [] get: tags: - Get summary: Grafana Get Org Quota description: '``` Retrieves the current resource quota settings for a specific organization in Grafana identified by its organization ID. This endpoint returns quota limits that define resource constraints for the organization, such as maximum number of users, dashboards, data sources, and API keys allowed. The response provides visibility into the configured thresholds that govern resource allocation and help administrators manage and control organizational resource consumption within their Grafana instance. ```' operationId: getOrgQuota parameters: - name: org_id in: path description: '' required: true schema: type: integer contentEncoding: int64 responses: '200': description: (empty) headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/QuotaDTO' description: '' contentMediaType: application/json '401': description: UnauthorizedError is returned when the request is not authenticated. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '403': description: ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '404': description: NotFoundError is returned when the requested resource was not found. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '500': description: InternalServerError is a general error indicating something went wrong internally. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' deprecated: false x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /user/quotas: parameters: [] get: tags: - Get summary: Grafana Get User Quotas description: This API operation retrieves the current quota limits and usage for a specific user in Grafana. Quotas define resource limitations such as the maximum number of dashboards, data sources, or organizations that a user can create or belong to. By making a GET request to the /user/quotas endpoint, administrators can view the configured quota settings for the authenticated user, which helps in monitoring resource allocation and ensuring users stay within their assigned limits. The response typically includes quota values for various resources along with current usage statistics, enabling better resource management and capacity planning within the Grafana instance. operationId: getUserQuotas parameters: [] responses: '200': description: (empty) headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/QuotaDTO' description: '' contentMediaType: application/json '401': description: UnauthorizedError is returned when the request is not authenticated. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '403': description: ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '404': description: NotFoundError is returned when the requested resource was not found. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '500': description: InternalServerError is a general error indicating something went wrong internally. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' deprecated: false x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /cloudmigration/migration: parameters: [] get: tags: - Get summary: Grafana Get Session List description: The GET /cloudmigration/migration endpoint retrieves a list of cloud migration sessions in Grafana, allowing administrators to monitor and track ongoing or historical migration activities from self-hosted Grafana instances to Grafana Cloud. This operation returns details about migration sessions including their status, creation timestamps, configuration parameters, and progress information, enabling users to review migration attempts and their outcomes without requiring additional parameters beyond proper authentication credentials. operationId: getSessionList parameters: [] responses: '200': description: (empty) headers: {} content: application/json: schema: $ref: '#/components/schemas/CloudMigrationSessionListResponseDTO' '401': description: UnauthorizedError is returned when the request is not authenticated. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '403': description: ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '500': description: InternalServerError is a general error indicating something went wrong internally. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' deprecated: false x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /cloudmigration/migration/{uid}: parameters: [] get: tags: - Get summary: Grafana Get Session description: Retrieves details of a specific cloud migration session in Grafana using its unique identifier (uid). This GET endpoint allows administrators to check the status and configuration of an ongoing or completed migration session, including information about what data is being or has been migrated to the cloud. The operation requires the session's uid as a path parameter and returns comprehensive details about that particular migration session, enabling users to monitor and track their cloud migration progress. operationId: getSession parameters: - name: uid in: path description: UID of a migration session required: true schema: type: string responses: '200': description: (empty) headers: {} content: application/json: schema: $ref: '#/components/schemas/CloudMigrationSessionResponseDTO' '400': description: BadRequestError is returned when the request is invalid and it cannot be processed. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '401': description: UnauthorizedError is returned when the request is not authenticated. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '403': description: ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '500': description: InternalServerError is a general error indicating something went wrong internally. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' deprecated: false x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /cloudmigration/migration/{uid}/snapshot/{snapshotUid}: parameters: [] get: tags: - Get summary: Grafana Get Snapshot description: This API operation retrieves a specific snapshot associated with a cloud migration in Grafana by providing both the migration's unique identifier (uid) and the snapshot's unique identifier (snapshotUid) as path parameters. When called with a GET request, it returns detailed information about the requested snapshot, which represents a point-in-time capture of data or configuration during the migration process. This endpoint is useful for reviewing, auditing, or restoring specific states captured during cloud migration operations, allowing administrators to track the progress and state of their Grafana instance migration at particular moments in time. operationId: getSnapshot parameters: - name: resultPage in: query description: ResultPage is used for pagination with ResultLimit style: form explode: true schema: type: integer contentEncoding: int64 default: 1 - name: resultLimit in: query description: Max limit for snapshot results returned. style: form explode: true schema: type: integer contentEncoding: int64 default: 100 - name: resultSortColumn in: query description: ResultSortColumn can be used to override the default system sort. Valid values are "name", "resource_type", and "status". style: form explode: true schema: type: string default: default - name: resultSortOrder in: query description: ResultSortOrder is used with ResultSortColumn. Valid values are ASC and DESC. style: form explode: true schema: type: string default: ASC - name: errorsOnly in: query description: ErrorsOnly is used to only return resources with error statuses style: form explode: true schema: type: boolean default: false - name: uid in: path description: Session UID of a session required: true schema: type: string - name: snapshotUid in: path description: UID of a snapshot required: true schema: type: string responses: '200': description: (empty) headers: {} content: application/json: schema: $ref: '#/components/schemas/GetSnapshotResponseDTO' '400': description: BadRequestError is returned when the request is invalid and it cannot be processed. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '401': description: UnauthorizedError is returned when the request is not authenticated. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '403': description: ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '500': description: InternalServerError is a general error indicating something went wrong internally. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' deprecated: false x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /cloudmigration/migration/{uid}/snapshots: parameters: [] get: tags: - Get summary: Grafana Get Shapshot List description: This API operation retrieves a list of snapshots associated with a specific cloud migration job in Grafana. By making a GET request to the endpoint with a unique migration identifier (uid), users can obtain details about all snapshots that have been created during the migration process. This is useful for tracking the progress of a migration, reviewing snapshot history, and managing data transfer between Grafana instances or cloud environments. operationId: getShapshotList parameters: - name: page in: query description: Page is used for pagination with limit style: form explode: true schema: type: integer contentEncoding: int64 default: 1 - name: limit in: query description: Max limit for results returned. style: form explode: true schema: type: integer contentEncoding: int64 default: 100 - name: uid in: path description: Session UID of a session required: true schema: type: string - name: sort in: query description: Sort with value latest to return results sorted in descending order. style: form explode: true schema: type: string responses: '200': description: (empty) headers: {} content: application/json: schema: $ref: '#/components/schemas/SnapshotListResponseDTO' '400': description: BadRequestError is returned when the request is invalid and it cannot be processed. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '401': description: UnauthorizedError is returned when the request is not authenticated. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '403': description: ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '500': description: InternalServerError is a general error indicating something went wrong internally. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' deprecated: false x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /cloudmigration/resources/dependencies: parameters: [] get: tags: - Get summary: Grafana Get Resource Dependencies description: This API operation retrieves the dependencies for resources involved in a cloud migration process within Grafana. When called, it analyzes and returns information about the relationships and dependencies between various Grafana resources (such as dashboards, data sources, folders, and other configuration elements) that need to be considered during a cloud migration. This is particularly useful for understanding which resources must be migrated together to maintain functionality and avoid broken references, helping administrators plan and execute a complete and successful migration from a self-hosted Grafana instance to Grafana Cloud or between different Grafana environments. operationId: getResourceDependencies parameters: [] responses: '200': description: (empty) headers: {} content: application/json: schema: $ref: '#/components/schemas/ResourceDependenciesResponseDTO' deprecated: false x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /cloudmigration/token: parameters: [] get: tags: - Get summary: Grafana Get Cloud Migration Token description: Retrieves the cloud migration token for a Grafana instance, which is used to authenticate and authorize the migration of dashboards, data sources, and other resources from a self-hosted or on-premise Grafana installation to Grafana Cloud. This token serves as a secure credential that enables the migration service to access and transfer configuration data between environments, typically generated when initiating a cloud migration process and required for establishing a trusted connection between the source Grafana instance and the destination cloud environment. operationId: getCloudMigrationToken parameters: [] responses: '200': description: (empty) headers: {} content: application/json: schema: $ref: '#/components/schemas/GetAccessTokenResponseDTO' '401': description: UnauthorizedError is returned when the request is not authenticated. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '403': description: ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '404': description: NotFoundError is returned when the requested resource was not found. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '500': description: InternalServerError is a general error indicating something went wrong internally. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' deprecated: false x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /convert/api/prom/rules: parameters: [] get: tags: - Get summary: Grafana Route Convert Prometheus Cortex Get Rules description: This API operation retrieves Prometheus or Cortex alerting and recording rules from a configured data source and converts them into Grafana's unified alerting format. It acts as a migration utility that fetches existing Prometheus-compatible rules and transforms them so they can be imported or managed within Grafana's alerting system, enabling users to consolidate their monitoring rules into Grafana's native rule structure while maintaining compatibility with Prometheus-style rule definitions. operationId: routeConvertPrometheusCortexGetRules parameters: [] responses: '200': description: PrometheusNamespace headers: {} content: application/yaml: schema: contentMediaType: application/yaml '403': description: ForbiddenError headers: {} content: application/yaml: schema: contentMediaType: application/yaml '404': description: NotFound headers: {} content: application/yaml: schema: contentMediaType: application/yaml deprecated: false x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /convert/api/prom/rules/{NamespaceTitle}: parameters: [] get: tags: - Get summary: Grafana Route Convert Prometheus Cortex Get Namespace description: This API operation retrieves and converts Prometheus or Cortex rule configurations from a specific namespace in Grafana. By making a GET request to the endpoint with a namespace title parameter, it fetches the alerting and recording rules defined within that namespace and converts them into a format compatible with Grafana's unified alerting system. This is particularly useful when migrating from Prometheus-style alerting rules to Grafana's native alerting framework, allowing users to maintain their existing rule configurations while leveraging Grafana's enhanced alerting capabilities and management features. operationId: routeConvertPrometheusCortexGetNamespace parameters: - name: NamespaceTitle in: path description: '' required: true schema: type: string responses: '200': description: PrometheusNamespace headers: {} content: application/yaml: schema: contentMediaType: application/yaml '403': description: ForbiddenError headers: {} content: application/yaml: schema: contentMediaType: application/yaml '404': description: NotFound headers: {} content: application/yaml: schema: contentMediaType: application/yaml deprecated: false x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /convert/api/prom/rules/{NamespaceTitle}/{Group}: parameters: [] get: tags: - Get summary: Grafana Route Convert Prometheus Cortex Get Rule Group description: 'This API operation retrieves a specific Prometheus rule group from a designated namespace in Grafana''s Cortex ruler service. The endpoint accepts two path parameters: NamespaceTitle which identifies the namespace containing the rule group, and Group which specifies the name of the rule group to retrieve. When called, it returns the configuration and rules defined within that particular rule group, allowing users to view and manage their Prometheus alerting and recording rules that have been converted or stored in the Cortex format within Grafana''s unified alerting system.' operationId: routeConvertPrometheusCortexGetRuleGroup parameters: - name: NamespaceTitle in: path description: '' required: true schema: type: string - name: Group in: path description: '' required: true schema: type: string responses: '200': description: PrometheusRuleGroup headers: {} content: application/yaml: schema: contentMediaType: application/yaml '403': description: ForbiddenError headers: {} content: application/yaml: schema: contentMediaType: application/yaml '404': description: NotFound headers: {} content: application/yaml: schema: contentMediaType: application/yaml deprecated: false x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /convert/prometheus/config/v1/rules: parameters: [] get: tags: - Get summary: Grafana Route Convert Prometheus Get Rules description: This API operation retrieves Prometheus alerting and recording rules from a Grafana instance and converts them into a standardized configuration format. When a GET request is made to the /convert/prometheus/config/v1/rules endpoint, it fetches the existing Prometheus-style rules configured within Grafana and transforms them into a version 1 configuration schema, making it easier to migrate, backup, or integrate these rules with other systems or Prometheus instances. This is particularly useful for administrators who need to export their Grafana-managed Prometheus rules or maintain consistency across multiple monitoring environments. operationId: routeConvertPrometheusGetRules parameters: [] responses: '200': description: PrometheusNamespace headers: {} content: application/yaml: schema: contentMediaType: application/yaml '403': description: ForbiddenError headers: {} content: application/yaml: schema: contentMediaType: application/yaml '404': description: NotFound headers: {} content: application/yaml: schema: contentMediaType: application/yaml deprecated: false x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /convert/prometheus/config/v1/rules/{NamespaceTitle}: parameters: [] get: tags: - Get summary: Grafana Route Convert Prometheus Get Namespace description: This API operation retrieves and converts Prometheus alerting and recording rules from a specific namespace within Grafana. By making a GET request to the endpoint with a specified namespace title, it fetches the Prometheus rule configuration for that namespace and converts it into a format compatible with Grafana's alerting system. This is particularly useful when migrating from Prometheus-based alerting to Grafana's unified alerting system, allowing users to import existing Prometheus rule definitions while maintaining their organizational structure by namespace. The operation returns the converted rule configuration that can then be used within Grafana's alert management interface. operationId: routeConvertPrometheusGetNamespace parameters: - name: NamespaceTitle in: path description: '' required: true schema: type: string responses: '200': description: PrometheusNamespace headers: {} content: application/yaml: schema: contentMediaType: application/yaml '403': description: ForbiddenError headers: {} content: application/yaml: schema: contentMediaType: application/yaml '404': description: NotFound headers: {} content: application/yaml: schema: contentMediaType: application/yaml deprecated: false x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /convert/prometheus/config/v1/rules/{NamespaceTitle}/{Group}: parameters: [] get: tags: - Get summary: Grafana Route Convert Prometheus Get Rule Group description: This API operation retrieves and converts a Prometheus rule group configuration from a specific namespace in Grafana. It accepts GET requests at the endpoint path that includes both the namespace title and group name as path parameters, allowing users to fetch the configuration details of a particular Prometheus alerting or recording rule group. The operation is part of Grafana's conversion utilities that help transform Prometheus-native rule configurations into Grafana's internal format or vice versa, facilitating migration and management of alerting rules across different monitoring system configurations. operationId: routeConvertPrometheusGetRuleGroup parameters: - name: NamespaceTitle in: path description: '' required: true schema: type: string - name: Group in: path description: '' required: true schema: type: string responses: '200': description: PrometheusRuleGroup headers: {} content: application/yaml: schema: contentMediaType: application/yaml '403': description: ForbiddenError headers: {} content: application/yaml: schema: contentMediaType: application/yaml '404': description: NotFound headers: {} content: application/yaml: schema: contentMediaType: application/yaml deprecated: false x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /dashboards/home: parameters: [] get: tags: - Get summary: Grafana Get Home Dashboard description: The Grafana Get Home Dashboard API operation retrieves the dashboard that is configured as the home dashboard for the current user or organization. When a GET request is made to the /dashboards/home endpoint, it returns the dashboard data that should be displayed when a user first logs into Grafana or navigates to the home page. This endpoint is useful for applications that need to programmatically access the default landing dashboard, whether it's a custom dashboard set by an administrator or the default Grafana home dashboard. The response includes the dashboard JSON model along with metadata such as the dashboard's unique identifier, title, and other configuration settings. operationId: getHomeDashboard parameters: [] responses: '200': description: (empty) headers: {} content: application/json: schema: $ref: '#/components/schemas/Gethomedashboardresponse.' '401': description: UnauthorizedError is returned when the request is not authenticated. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '500': description: InternalServerError is a general error indicating something went wrong internally. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' deprecated: true x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /dashboards/id/{DashboardID}/permissions: parameters: [] get: tags: - Get summary: Grafana Get Dashboard Permissions List By ID description: This API operation retrieves the complete list of permissions associated with a specific Grafana dashboard by providing its unique dashboard identifier. It returns details about which users, teams, or roles have access to the dashboard and what level of permissions they possess (such as view, edit, or admin rights). The GET request to this endpoint allows administrators to audit and review the current access control settings for a dashboard, making it useful for security compliance, permission management, and understanding who can interact with specific dashboards within the Grafana instance. operationId: getDashboardPermissionsListByID parameters: - name: DashboardID in: path description: '' required: true schema: type: integer contentEncoding: int64 responses: '200': description: (empty) headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/DashboardACLInfoDTO' description: '' contentMediaType: application/json '401': description: UnauthorizedError is returned when the request is not authenticated. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '403': description: ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '404': description: NotFoundError is returned when the requested resource was not found. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '500': description: InternalServerError is a general error indicating something went wrong internally. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' deprecated: true x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /dashboards/id/{DashboardID}/versions: parameters: [] get: tags: - Get summary: Grafana Get Dashboard Versions By ID description: Retrieves the version history of a specific Grafana dashboard identified by its unique dashboard ID. This operation returns a list of all saved versions for the dashboard, including metadata such as version numbers, timestamps, user information who made the changes, and version messages or notes. It allows administrators and users to track changes made to a dashboard over time, compare different versions, and understand the evolution of dashboard configurations, which is useful for auditing purposes, troubleshooting issues introduced by recent changes, or reverting to previous dashboard states if needed. operationId: getDashboardVersionsByID parameters: - name: DashboardID in: path description: '' required: true schema: type: integer contentEncoding: int64 responses: '200': description: (empty) headers: {} content: application/json: schema: $ref: '#/components/schemas/DashboardVersionResponseMeta' '401': description: UnauthorizedError is returned when the request is not authenticated. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '403': description: ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '404': description: NotFoundError is returned when the requested resource was not found. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '500': description: InternalServerError is a general error indicating something went wrong internally. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' deprecated: true x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /dashboards/id/{DashboardID}/versions/{DashboardVersionID}: parameters: [] get: tags: - Get summary: Grafana Get Dashboard Version By ID description: This API operation retrieves a specific version of a Grafana dashboard by providing both the dashboard's unique identifier and the desired version identifier. When invoked using the GET method, it returns the complete configuration and metadata for that particular version of the dashboard, allowing users to view historical snapshots, compare changes between versions, or restore previous dashboard states. This is particularly useful for auditing dashboard modifications, understanding what changes were made over time, and recovering from unwanted updates by accessing earlier working versions of a dashboard's configuration. operationId: getDashboardVersionByID parameters: - name: DashboardID in: path description: '' required: true schema: type: integer contentEncoding: int64 - name: DashboardVersionID in: path description: '' required: true schema: type: integer contentEncoding: int64 responses: '200': description: (empty) headers: {} content: application/json: schema: $ref: '#/components/schemas/DashboardVersionMeta' '401': description: UnauthorizedError is returned when the request is not authenticated. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '403': description: ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '404': description: NotFoundError is returned when the requested resource was not found. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '500': description: InternalServerError is a general error indicating something went wrong internally. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' deprecated: true x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /dashboards/tags: parameters: [] get: tags: - Get summary: Grafana Get Dashboard Tags description: This API operation retrieves all tags that have been assigned to dashboards within the Grafana instance. When called, it returns a list of unique tags used across all dashboards, which can be helpful for filtering, organizing, or discovering dashboards based on their categorization. The endpoint is accessed via a GET request to /dashboards/tags and typically returns an array of tag objects containing information about each tag's name and count of associated dashboards. This is commonly used in dashboard management interfaces or when building custom dashboard discovery tools. operationId: getDashboardTags parameters: [] responses: '200': description: (empty) headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/DashboardTagCloudItem' description: '' contentMediaType: application/json '401': description: UnauthorizedError is returned when the request is not authenticated. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '500': description: InternalServerError is a general error indicating something went wrong internally. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' deprecated: false x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /dashboards/uid/{dashboardUid}/public-dashboards: parameters: [] get: tags: - Get 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 /dashboards/uid/{uid}: parameters: [] get: tags: - Get summary: Grafana Get Dashboard By UID description: This API operation retrieves a specific Grafana dashboard using its unique identifier (UID). By making a GET request to the endpoint with the dashboard's UID as a path parameter, users can fetch the complete dashboard configuration including its panels, variables, time settings, and metadata. This is commonly used for programmatic access to dashboard definitions, enabling automation tasks such as backup, migration, or integration with external systems. The response typically includes the dashboard JSON model along with metadata like version number, folder location, and permissions, making it essential for dashboard management and version control workflows. operationId: getDashboardByUID parameters: - name: uid in: path description: '' required: true schema: type: string responses: '200': description: (empty) headers: {} content: application/json: schema: $ref: '#/components/schemas/DashboardFullWithMeta' '401': description: UnauthorizedError is returned when the request is not authenticated. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '403': description: ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '404': description: NotFoundError is returned when the requested resource was not found. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '406': description: NotAcceptableError is returned when the server cannot produce a response matching the accepted formats. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '500': description: InternalServerError is a general error indicating something went wrong internally. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' deprecated: false x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /dashboards/uid/{uid}/permissions: parameters: [] get: tags: - Get summary: Grafana Get Dashboard Permissions List By UID description: This API operation retrieves the permission settings for a specific Grafana dashboard identified by its unique identifier (UID). When called with a GET request to the endpoint /dashboards/uid/{uid}/permissions, it returns a list of all permissions associated with that dashboard, including which users, teams, or roles have access and their respective permission levels (such as view, edit, or admin rights). This allows administrators and authorized users to review and audit who has access to a particular dashboard and what actions they can perform on it. operationId: getDashboardPermissionsListByUID parameters: - name: uid in: path description: '' required: true schema: type: string responses: '200': description: (empty) headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/DashboardACLInfoDTO' description: '' contentMediaType: application/json '401': description: UnauthorizedError is returned when the request is not authenticated. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '403': description: ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '404': description: NotFoundError is returned when the requested resource was not found. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '500': description: InternalServerError is a general error indicating something went wrong internally. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' deprecated: false x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /dashboards/uid/{uid}/versions: parameters: [] get: tags: - Get summary: Grafana Get Dashboard Versions By UID description: This API operation retrieves the version history of a specific Grafana dashboard identified by its unique identifier (UID). When called with a GET request to the endpoint /dashboards/uid/{uid}/versions, it returns a list of all saved versions of the dashboard, allowing users to track changes made over time, view metadata about each version such as creation date and author, and potentially restore previous versions if needed. This is particularly useful for auditing dashboard modifications, understanding the evolution of visualizations, and recovering from unwanted changes. operationId: getDashboardVersionsByUID parameters: - name: uid in: path description: '' required: true schema: type: string - name: limit in: query description: Maximum number of results to return style: form explode: true schema: type: integer contentEncoding: int64 default: 0 - name: start in: query description: Version to start from when returning queries style: form explode: true schema: type: integer contentEncoding: int64 default: 0 responses: '200': description: (empty) headers: {} content: application/json: schema: $ref: '#/components/schemas/DashboardVersionResponseMeta' '401': description: UnauthorizedError is returned when the request is not authenticated. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '403': description: ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '404': description: NotFoundError is returned when the requested resource was not found. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '500': description: InternalServerError is a general error indicating something went wrong internally. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' deprecated: false x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /dashboards/uid/{uid}/versions/{DashboardVersionID}: parameters: [] get: tags: - Get summary: Grafana Get Dashboard Version By UID description: 'This API operation retrieves a specific version of a Grafana dashboard by providing both the dashboard''s unique identifier (UID) and the desired version ID. It allows users to access historical versions of a dashboard, enabling them to review previous configurations, compare changes over time, or restore an earlier state of the dashboard. The endpoint uses a GET request and requires two path parameters: the dashboard UID which uniquely identifies the dashboard, and the DashboardVersionID which specifies which historical version to retrieve. This is particularly useful for audit purposes, version control, and recovering from unwanted dashboard modifications.' operationId: getDashboardVersionByUID parameters: - name: DashboardVersionID in: path description: '' required: true schema: type: integer contentEncoding: int64 - name: uid in: path description: '' required: true schema: type: string responses: '200': description: (empty) headers: {} content: application/json: schema: $ref: '#/components/schemas/DashboardVersionMeta' '401': description: UnauthorizedError is returned when the request is not authenticated. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '403': description: ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '404': description: NotFoundError is returned when the requested resource was not found. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '500': description: InternalServerError is a general error indicating something went wrong internally. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' deprecated: false x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /public/dashboards/{accessToken}/annotations: parameters: [] get: tags: - Get 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 /snapshots/{key}: parameters: [] get: tags: - Get summary: Grafana Get Dashboard Snapshot description: This API operation retrieves a specific dashboard snapshot from Grafana using its unique key identifier. When called, it fetches the stored snapshot data which represents a static, point-in-time view of a dashboard that was previously captured. The snapshot includes all panel configurations, data visualizations, and dashboard settings as they existed at the moment the snapshot was created. This is useful for sharing dashboard views with external users who may not have access to the live Grafana instance, reviewing historical dashboard states, or preserving specific dashboard configurations for documentation or reporting purposes. The operation requires the snapshot's unique key as a path parameter and returns the complete snapshot object containing all dashboard data and metadata. operationId: getDashboardSnapshot parameters: - name: key in: path description: '' required: true schema: type: string responses: '200': description: (empty) headers: {} content: {} '400': description: BadRequestError is returned when the request is invalid and it cannot be processed. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '404': description: NotFoundError is returned when the requested resource was not found. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '500': description: InternalServerError is a general error indicating something went wrong internally. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' deprecated: false x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /groupsync/groups: parameters: [] get: tags: - Get summary: Grafana Get Mapped Groups description: The Get Mapped Groups API operation retrieves a list of groups that have been configured for synchronization in Grafana's group sync functionality. This GET endpoint at /groupsync/groups returns information about groups that are mapped between an external authentication provider (such as LDAP, OAuth, or SAML) and Grafana's internal team structure, allowing administrators to view which external groups are currently being synchronized and how they correspond to teams within Grafana for access control and permission management purposes. operationId: getMappedGroups parameters: [] responses: '200': description: (empty) headers: {} content: application/json: schema: $ref: '#/components/schemas/getGroupsResponse' '400': description: BadRequestError is returned when the request is invalid and it cannot be processed. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '401': description: UnauthorizedError is returned when the request is not authenticated. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '403': description: ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '500': description: InternalServerError is a general error indicating something went wrong internally. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' deprecated: false x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /groupsync/groups/{group_id}/roles: parameters: [] get: tags: - Get summary: Grafana Get Group Roles description: This API operation retrieves the roles associated with a specific group in Grafana's group synchronization system. By providing a group_id in the URL path, the GET request returns information about what roles have been assigned to that particular group, which is useful for managing permissions and access control in Grafana when using external group synchronization features like LDAP or OAuth. operationId: getGroupRoles parameters: - name: group_id in: path description: '' required: true schema: type: string responses: '200': description: (empty) headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/RoleDTO' description: '' contentMediaType: application/json '400': description: BadRequestError is returned when the request is invalid and it cannot be processed. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '401': description: UnauthorizedError is returned when the request is not authenticated. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '403': description: ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '404': description: NotFoundError is returned when the requested resource was not found. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '500': description: InternalServerError is a general error indicating something went wrong internally. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' deprecated: false x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /health: parameters: [] get: tags: - Get summary: Grafana Get Health description: The Grafana Health API endpoint is a GET operation accessible at the /health path that provides a simple health check mechanism to determine the operational status of the Grafana instance. This endpoint returns basic information about whether the Grafana server is running and responding to requests, making it essential for monitoring, load balancing, and automated health verification in production environments. It typically returns a straightforward response indicating the service status without requiring authentication, allowing external monitoring systems and orchestration tools to quickly verify that the Grafana application is available and functioning correctly. operationId: getHealth parameters: [] responses: '200': description: healthResponse headers: {} content: application/json: schema: $ref: '#/components/schemas/healthResponse' '503': description: InternalServerError is a general error indicating something went wrong internally. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' deprecated: false x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /logout/saml: parameters: [] get: tags: - Get summary: Grafana Get SAML Logout description: The GET /logout/saml endpoint in Grafana handles SAML-based logout operations, providing a way to terminate authenticated user sessions that were established using SAML (Security Assertion Markup Language) single sign-on. When invoked, this endpoint initiates the SAML logout flow, which typically involves invalidating the user's session within Grafana and potentially communicating with the SAML identity provider to perform a global logout across all SAML-integrated applications. This endpoint is essential for organizations using SAML authentication who need to ensure proper session termination and security compliance by allowing users to cleanly exit their Grafana sessions while maintaining the integrity of the broader SAML-based authentication ecosystem. operationId: getSAMLLogout parameters: [] responses: '302': description: (empty) headers: {} content: {} '404': description: NotFoundError is returned when the requested resource was not found. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '500': description: InternalServerError is a general error indicating something went wrong internally. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' deprecated: false x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /saml/metadata: parameters: [] get: tags: - Get summary: Grafana Get Metadata description: This API operation retrieves SAML (Security Assertion Markup Language) metadata from a Grafana instance. When called using a GET request to the /saml/metadata endpoint, it returns the service provider metadata document in XML format, which contains configuration details necessary for establishing SAML-based single sign-on (SSO) authentication. This metadata typically includes information such as entity IDs, assertion consumer service URLs, certificate details, and supported SAML bindings that identity providers need to configure their end of the SSO integration with Grafana. operationId: getMetadata parameters: [] responses: '200': description: (empty) headers: {} content: application/xml;application/samlmetadata+xml: schema: type: array items: type: integer contentEncoding: int32 xml: name: response attribute: false wrapped: false description: '' xml: attribute: false wrapped: false contentMediaType: application/xml;application/samlmetadata+xml deprecated: false x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /saml/slo: parameters: [] get: tags: - Get summary: Grafana Get SLO description: The Grafana SAML Single Logout (SLO) GET endpoint at /saml/slo facilitates the logout process for users authenticated via SAML by handling logout requests from the identity provider. When invoked, this endpoint processes SAML logout requests, terminates the user's Grafana session, and coordinates the single sign-out flow to ensure the user is properly logged out from both Grafana and the SAML identity provider, maintaining security and session consistency across the federated authentication system. operationId: getSLO parameters: [] responses: '302': description: (empty) headers: {} content: {} '400': description: BadRequestError is returned when the request is invalid and it cannot be processed. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '403': description: ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '500': description: InternalServerError is a general error indicating something went wrong internally. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' deprecated: false x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /playlists/{uid}: parameters: [] get: tags: - Get summary: Grafana Get Playlist description: This API operation retrieves a specific playlist from Grafana using its unique identifier (UID). When you make a GET request to the /playlists/{uid} endpoint with a valid playlist UID, Grafana returns the complete details of that playlist, including its name, interval settings, and the list of dashboards it contains. This operation is useful for viewing the configuration of an existing playlist, whether you need to display its properties, verify its contents, or retrieve its data for further processing or updates. operationId: getPlaylist parameters: - name: uid in: path description: '' required: true schema: type: string responses: '200': description: (empty) headers: {} content: application/json: schema: $ref: '#/components/schemas/PlaylistDTO' '401': description: UnauthorizedError is returned when the request is not authenticated. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '403': description: ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '404': description: NotFoundError is returned when the requested resource was not found. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '500': description: InternalServerError is a general error indicating something went wrong internally. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' deprecated: false x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /playlists/{uid}/items: parameters: [] get: tags: - Get summary: Grafana Get Playlist Items description: This API operation retrieves all items associated with a specific playlist in Grafana by providing the playlist's unique identifier (uid) in the URL path. When called with a GET request, it returns a list of dashboard references that are configured to be displayed in sequence as part of the specified playlist, including details such as the dashboard titles, IDs, and their order within the playlist rotation. operationId: getPlaylistItems parameters: - name: uid in: path description: '' required: true schema: type: string responses: '200': description: (empty) headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/PlaylistItemDTO' description: '' contentMediaType: application/json '401': description: UnauthorizedError is returned when the request is not authenticated. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '403': description: ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '404': description: NotFoundError is returned when the requested resource was not found. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '500': description: InternalServerError is a general error indicating something went wrong internally. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' deprecated: false x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /recording-rules/writer: parameters: [] get: tags: - Get summary: Grafana Get Recording Rule Write Target description: This API operation retrieves the configured write target for recording rules in Grafana. When called using a GET request to the /recording-rules/writer endpoint, it returns information about where recording rule data is being written, which typically includes details about the remote write configuration or storage backend that has been set up to receive and store the results of recording rule evaluations. This is useful for administrators who need to verify or audit the destination of their recording rule outputs. operationId: getRecordingRuleWriteTarget parameters: [] responses: '200': description: (empty) headers: {} content: application/json: schema: $ref: '#/components/schemas/PrometheusRemoteWriteTargetJSON' '401': description: UnauthorizedError is returned when the request is not authenticated. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '403': description: ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '404': description: NotFoundError is returned when the requested resource was not found. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '500': description: InternalServerError is a general error indicating something went wrong internally. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' deprecated: false x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /snapshot/shared-options: parameters: [] get: tags: - Get summary: Grafana Get Sharing Options description: This API operation retrieves the available sharing options for snapshots in Grafana. When invoked via a GET request to the /snapshot/shared-options endpoint, it returns configuration details about how snapshots can be shared, including available sharing methods, permissions, and any constraints or settings that govern snapshot sharing behavior within the Grafana instance. This information is useful for determining what sharing capabilities are enabled and how users can distribute dashboard snapshots to others. operationId: getSharingOptions parameters: [] responses: '200': description: (empty) headers: {} content: application/json: schema: $ref: '#/components/schemas/getSharingOptionsResponse' '401': description: UnauthorizedError is returned when the request is not authenticated. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' deprecated: false x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /teams/{teamId}/groups: parameters: [] get: tags: - Get summary: Grafana Get Team Groups Api description: This API operation retrieves the list of external groups that are synchronized with a specific team in Grafana. By providing a team ID in the path parameter, the endpoint returns all groups that have been mapped or linked to that team, which is particularly useful in environments where Grafana teams are integrated with external authentication providers like LDAP, OAuth, or SAML. This allows administrators to view and verify which external directory groups have access to a particular Grafana team, helping maintain proper access control and team membership management across integrated systems. operationId: getTeamGroupsApi parameters: - name: teamId in: path description: '' required: true schema: type: string responses: '200': description: (empty) headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/TeamGroupDTO' description: '' contentMediaType: application/json '400': description: BadRequestError is returned when the request is invalid and it cannot be processed. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '401': description: UnauthorizedError is returned when the request is not authenticated. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '403': description: ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '404': description: NotFoundError is returned when the requested resource was not found. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '500': description: InternalServerError is a general error indicating something went wrong internally. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' deprecated: false x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /user: parameters: [] get: tags: - Get summary: Grafana Get Signed In User description: Retrieves the currently authenticated user's details in Grafana. This endpoint returns information about the user who is currently signed in based on the authentication credentials provided in the request, including user properties such as ID, login name, email, name, and organizational details. It's commonly used to verify authentication status and display user-specific information in the Grafana interface or when integrating with external applications. operationId: getSignedInUser parameters: [] responses: '200': description: (empty) headers: {} content: application/json: schema: $ref: '#/components/schemas/UserProfileDTO' '401': description: UnauthorizedError is returned when the request is not authenticated. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '403': description: ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '404': description: NotFoundError is returned when the requested resource was not found. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '500': description: InternalServerError is a general error indicating something went wrong internally. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' deprecated: false x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /user/auth-tokens: parameters: [] get: tags: - Get summary: Grafana Get User Auth Tokens description: This API operation retrieves a list of authentication tokens associated with the currently authenticated user in Grafana. When called via a GET request to the /user/auth-tokens endpoint, it returns information about active auth tokens that have been generated for the user's account, typically including details such as token IDs, creation timestamps, last used dates, and expiration information. This allows users to view and manage their active sessions and API tokens for security and access control purposes. operationId: getUserAuthTokens parameters: [] responses: '200': description: (empty) headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/UserToken' description: '' contentMediaType: application/json '401': description: UnauthorizedError is returned when the request is not authenticated. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '403': description: ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '500': description: InternalServerError is a general error indicating something went wrong internally. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' deprecated: false x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /user/orgs: parameters: [] get: tags: - Get summary: Grafana Get Signed In User Org List description: This API endpoint retrieves a list of all organizations associated with the currently authenticated user in Grafana. When called with a GET request to /user/orgs, it returns information about each organization the signed-in user belongs to, typically including details such as organization ID, name, and the user's role within each organization. This is useful for applications that need to display or process the organizational memberships of the current user, allowing them to understand which organizations they have access to and what permissions they may have in each one. operationId: getSignedInUserOrgList parameters: [] responses: '200': description: (empty) headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/UserOrgDTO' description: '' contentMediaType: application/json '401': description: UnauthorizedError is returned when the request is not authenticated. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '403': description: ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '500': description: InternalServerError is a general error indicating something went wrong internally. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' deprecated: false security: - basic: [] x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /user/preferences: parameters: [] get: tags: - Get summary: Grafana Get User Preferences description: This API operation retrieves the current preferences for the authenticated user in Grafana. It returns configuration settings such as the user's preferred theme (light or dark mode), home dashboard ID, timezone settings, and UI language preferences. The endpoint requires authentication and returns a JSON object containing all the preference values associated with the logged-in user's account, allowing applications to understand and respect the user's personalized Grafana interface settings. operationId: getUserPreferences parameters: [] responses: '200': description: (empty) headers: {} content: application/json: schema: $ref: '#/components/schemas/PreferencesSpec' '401': description: UnauthorizedError is returned when the request is not authenticated. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '500': description: InternalServerError is a general error indicating something went wrong internally. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' deprecated: false x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /user/teams: parameters: [] get: tags: - Get summary: Grafana Get Signed In User Team List description: This API operation retrieves a list of all teams that the currently authenticated user is a member of in Grafana. When called, it returns team information associated with the signed-in user's account, allowing applications to determine which teams the user belongs to and potentially their roles or permissions within those teams. This is useful for displaying team memberships in user interfaces, implementing team-based access controls, or filtering content based on team associations. operationId: getSignedInUserTeamList parameters: [] responses: '200': description: (empty) headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/TeamDTO' description: '' contentMediaType: application/json '401': description: UnauthorizedError is returned when the request is not authenticated. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '403': description: ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '500': description: InternalServerError is a general error indicating something went wrong internally. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' deprecated: false x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /users/lookup: parameters: [] get: tags: - Get summary: Grafana Get User By Login Or Email description: The Grafana API endpoint /users/lookup with the GET method allows administrators to retrieve detailed information about a specific user by providing either their login username or email address as a query parameter. This operation is particularly useful when you need to fetch user details but only have their login credentials or email rather than their numeric user ID. The endpoint returns comprehensive user information including the user's ID, email, name, login, theme preferences, organization details, and authentication labels. Access to this endpoint typically requires administrator privileges as it exposes sensitive user information across the Grafana instance. operationId: getUserByLoginOrEmail parameters: - name: loginOrEmail in: query description: loginOrEmail of the user required: true style: form explode: true schema: type: string responses: '200': description: (empty) headers: {} content: application/json: schema: $ref: '#/components/schemas/UserProfileDTO' '401': description: UnauthorizedError is returned when the request is not authenticated. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '403': description: ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '404': description: NotFoundError is returned when the requested resource was not found. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '500': description: InternalServerError is a general error indicating something went wrong internally. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' deprecated: false x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /users/{user_id}: parameters: [] get: tags: - Get summary: Grafana Get User By ID description: This API operation retrieves detailed information about a specific Grafana user by their unique user identifier. By sending a GET request to the endpoint with a valid user_id parameter, administrators or authorized users can fetch comprehensive user data including username, email, authentication details, organization memberships, and user preferences. This operation is typically used for user management tasks, displaying user profiles, or verifying user information within Grafana instances, and requires appropriate permissions to access user data depending on the Grafana instance's security configuration. operationId: getUserByID parameters: - name: user_id in: path description: '' required: true schema: type: integer contentEncoding: int64 responses: '200': description: (empty) headers: {} content: application/json: schema: $ref: '#/components/schemas/UserProfileDTO' '401': description: UnauthorizedError is returned when the request is not authenticated. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '403': description: ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '404': description: NotFoundError is returned when the requested resource was not found. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '500': description: InternalServerError is a general error indicating something went wrong internally. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' deprecated: false x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /users/{user_id}/orgs: parameters: [] get: tags: - Get summary: Grafana Get User Org List description: Retrieves a list of all organizations associated with a specific user identified by their user ID in Grafana. This endpoint returns organization membership information for the specified user, including details about each organization they belong to. It requires appropriate authentication and permissions to access user-organization relationship data, making it useful for administrators who need to audit user access across multiple organizations or for displaying a user's organizational affiliations in the Grafana interface. operationId: getUserOrgList parameters: - name: user_id in: path description: '' required: true schema: type: integer contentEncoding: int64 responses: '200': description: (empty) headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/UserOrgDTO' description: '' contentMediaType: application/json '401': description: UnauthorizedError is returned when the request is not authenticated. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '403': description: ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '404': description: NotFoundError is returned when the requested resource was not found. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '500': description: InternalServerError is a general error indicating something went wrong internally. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' deprecated: false x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /users/{user_id}/teams: parameters: [] get: tags: - Get summary: Grafana Get User Teams description: This API operation retrieves a list of all teams that a specific user belongs to in Grafana. By making a GET request to the endpoint with a valid user ID parameter, the system returns information about the teams associated with that particular user, including team details such as team names, IDs, and potentially other relevant metadata. This is useful for administrators or applications that need to understand a user's team memberships and access permissions within the Grafana environment. operationId: getUserTeams parameters: - name: user_id in: path description: '' required: true schema: type: integer contentEncoding: int64 responses: '200': description: (empty) headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/TeamDTO' description: '' contentMediaType: application/json '401': description: UnauthorizedError is returned when the request is not authenticated. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '403': description: ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '404': description: NotFoundError is returned when the requested resource was not found. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '500': description: InternalServerError is a general error indicating something went wrong internally. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' deprecated: false x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /v1/provisioning/alert-rules: parameters: [] get: tags: - Get summary: Grafana Route Get Alert Rules description: This API operation retrieves alert rules from Grafana's provisioning system. It uses a GET request to the /v1/provisioning/alert-rules endpoint to fetch configured alert rules that have been set up through Grafana's provisioning mechanism. The operation returns a list of alert rule definitions including their conditions, notifications, and metadata, allowing administrators and applications to programmatically query and review the current alerting configuration without manual access to the Grafana UI. operationId: routeGetAlertRules parameters: [] responses: '200': description: ProvisionedAlertRules headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/ProvisionedAlertRule' description: '' contentMediaType: application/json deprecated: false x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /v1/provisioning/alert-rules/export: parameters: [] get: tags: - Get summary: Grafana Route Get Alert Rules Export description: This API operation retrieves alert rules from Grafana in an exportable format, allowing administrators to extract alert rule configurations for backup, migration, or version control purposes. The GET endpoint at /v1/provisioning/alert-rules/export provides a way to programmatically access the complete definition of configured alert rules, including their conditions, notification settings, and metadata. This is particularly useful for maintaining infrastructure as code, replicating alert configurations across multiple Grafana instances, or creating snapshots of monitoring setups for disaster recovery scenarios. operationId: routeGetAlertRulesExport parameters: - name: download in: query description: Whether to initiate a download of the file or not. style: form explode: true schema: type: boolean default: false - name: format in: query description: Format of the downloaded file. Supported yaml, json or hcl. Accept header can also be used, but the query parameter will take precedence. style: form explode: true schema: allOf: - $ref: '#/components/schemas/format' - description: Format of the downloaded file. Supported yaml, json or hcl. Accept header can also be used, but the query parameter will take precedence. - name: folderUid in: query description: UIDs of folders from which to export rules style: form explode: true schema: type: array items: type: string - name: group in: query description: Name of group of rules to export. Must be specified only together with a single folder UID style: form explode: true schema: type: string - name: ruleUid in: query description: UID of alert rule to export. If specified, parameters folderUid and group must be empty. style: form explode: true schema: type: string responses: '200': description: AlertingFileExport headers: {} content: application/json: schema: $ref: '#/components/schemas/AlertingFileExportisthefullprovisionedfileexport.' application/yaml: schema: contentMediaType: application/yaml application/terraform+hcl: schema: contentMediaType: application/terraform+hcl text/yaml: schema: contentMediaType: text/yaml text/hcl: schema: contentMediaType: text/hcl '404': description: Not found. headers: {} content: {} deprecated: false x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /v1/provisioning/alert-rules/{UID}: parameters: [] get: tags: - Get summary: Grafana Route Get Alert Rule description: This API operation retrieves a specific alert rule from Grafana's provisioning system using the alert rule's unique identifier (UID). When called with a GET request to the endpoint /v1/provisioning/alert-rules/{UID}, it returns the complete configuration details of the specified alert rule, including its conditions, labels, annotations, and evaluation settings. This endpoint is part of Grafana's provisioning API, which allows programmatic management of alert rules outside of the standard UI interface, making it useful for automation, backup purposes, or integrating Grafana alerting into external systems and workflows. operationId: routeGetAlertRule parameters: - name: UID in: path description: Alert rule UID required: true schema: type: string responses: '200': description: ProvisionedAlertRule headers: {} content: application/json: schema: $ref: '#/components/schemas/ProvisionedAlertRule' '404': description: Not found. headers: {} content: {} deprecated: false x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /v1/provisioning/alert-rules/{UID}/export: parameters: [] get: tags: - Get summary: Grafana Route Get Alert Rule Export description: The Get Alert Rule Export endpoint allows you to export a specific alert rule configuration from Grafana by providing its unique identifier (UID). This operation retrieves the complete alert rule definition in a format suitable for provisioning, enabling you to back up, version control, or migrate alert rules between Grafana instances. By making a GET request to /v1/provisioning/alert-rules/{UID}/export, you can obtain the alert rule's configuration including its conditions, notification settings, labels, and annotations in a structured format that can be used for declarative configuration management or importing into other Grafana environments. operationId: routeGetAlertRuleExport parameters: - name: download in: query description: Whether to initiate a download of the file or not. style: form explode: true schema: type: boolean default: false - name: format in: query description: Format of the downloaded file. Supported yaml, json or hcl. Accept header can also be used, but the query parameter will take precedence. style: form explode: true schema: allOf: - $ref: '#/components/schemas/format' - description: Format of the downloaded file. Supported yaml, json or hcl. Accept header can also be used, but the query parameter will take precedence. - name: UID in: path description: Alert rule UID required: true schema: type: string responses: '200': description: AlertingFileExport headers: {} content: application/json: schema: $ref: '#/components/schemas/AlertingFileExportisthefullprovisionedfileexport.' application/yaml: schema: contentMediaType: application/yaml application/terraform+hcl: schema: contentMediaType: application/terraform+hcl text/yaml: schema: contentMediaType: text/yaml text/hcl: schema: contentMediaType: text/hcl '404': description: Not found. headers: {} content: {} deprecated: false x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /v1/provisioning/contact-points: parameters: [] get: tags: - Get summary: Grafana Route Get Contactpoints description: This API operation retrieves all configured contact points in Grafana's alerting system through a GET request to the /v1/provisioning/contact-points endpoint. Contact points define the destinations where alert notifications are sent, such as email addresses, Slack channels, PagerDuty services, or webhook URLs. When called, this endpoint returns a list of all provisioned contact points along with their configuration details, including the notification channel type, settings, and metadata. This is particularly useful for administrators who need to audit, review, or programmatically manage their alerting infrastructure and understand which notification channels are currently configured in their Grafana instance. operationId: routeGetContactpoints parameters: - name: name in: query description: Filter by name style: form explode: true schema: type: string responses: '200': description: ContactPoints headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/EmbeddedContactPoint' description: '' contentMediaType: application/json deprecated: false x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /v1/provisioning/contact-points/export: parameters: [] get: tags: - Get summary: Grafana Route Get Contactpoints Export description: This API operation retrieves the exported configuration of contact points from Grafana's provisioning system. It uses a GET request to the `/v1/provisioning/contact-points/export` endpoint and returns contact point definitions that can be used for backup, migration, or version control purposes. Contact points define how and where Grafana sends alert notifications, such as email addresses, Slack webhooks, or PagerDuty integrations, and exporting them allows administrators to maintain consistent alerting configurations across different Grafana instances or to preserve configurations as code. operationId: routeGetContactpointsExport parameters: - name: download in: query description: Whether to initiate a download of the file or not. style: form explode: true schema: type: boolean default: false - name: format in: query description: Format of the downloaded file. Supported yaml, json or hcl. Accept header can also be used, but the query parameter will take precedence. style: form explode: true schema: allOf: - $ref: '#/components/schemas/format' - description: Format of the downloaded file. Supported yaml, json or hcl. Accept header can also be used, but the query parameter will take precedence. - name: decrypt in: query description: Whether any contained secure settings should be decrypted or left redacted. Redacted settings will contain RedactedValue instead. Currently, only org admin can view decrypted secure settings. style: form explode: true schema: type: boolean default: false - name: name in: query description: Filter by name style: form explode: true schema: type: string responses: '200': description: AlertingFileExport headers: {} content: application/json: schema: $ref: '#/components/schemas/AlertingFileExportisthefullprovisionedfileexport.' application/yaml: schema: contentMediaType: application/yaml application/terraform+hcl: schema: contentMediaType: application/terraform+hcl text/yaml: schema: contentMediaType: text/yaml text/hcl: schema: contentMediaType: text/hcl '403': description: PermissionDenied headers: {} content: application/json: schema: type: object contentMediaType: application/json application/yaml: schema: contentMediaType: application/yaml application/terraform+hcl: schema: contentMediaType: application/terraform+hcl text/yaml: schema: contentMediaType: text/yaml text/hcl: schema: contentMediaType: text/hcl deprecated: false x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /v1/provisioning/folder/{FolderUID}/rule-groups/{Group}: parameters: [] get: tags: - Get summary: Grafana Route Get Alert Rule Group description: This API operation retrieves a specific alert rule group within a designated folder in Grafana's provisioning system. By providing the folder's unique identifier (FolderUID) and the name of the alert rule group (Group) in the request path, users can fetch the complete configuration and details of that particular rule group. This GET endpoint is part of Grafana's provisioning API, which allows programmatic management of alerting configurations, enabling administrators and automation systems to query existing alert rule groups for monitoring, auditing, or synchronization purposes across different Grafana instances or environments. operationId: routeGetAlertRuleGroup parameters: - name: FolderUID in: path description: '' required: true schema: type: string - name: Group in: path description: '' required: true schema: type: string responses: '200': description: AlertRuleGroup headers: {} content: application/json: schema: $ref: '#/components/schemas/AlertRuleGroup' '404': description: Not found. headers: {} content: {} deprecated: false x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /v1/provisioning/folder/{FolderUID}/rule-groups/{Group}/export: parameters: [] get: tags: - Get summary: Grafana Route Get Alert Rule Group Export description: This API operation retrieves and exports a specific alert rule group from Grafana's provisioning system by providing both the parent folder's unique identifier (FolderUID) and the alert rule group name (Group) as path parameters. It allows users to obtain the complete configuration of an alert rule group in an exportable format, which can be used for backup purposes, migration between Grafana instances, or version control of alerting configurations. The GET method ensures this is a read-only operation that doesn't modify any existing alert rule configurations. operationId: routeGetAlertRuleGroupExport parameters: - name: download in: query description: Whether to initiate a download of the file or not. style: form explode: true schema: type: boolean default: false - name: format in: query description: Format of the downloaded file. Supported yaml, json or hcl. Accept header can also be used, but the query parameter will take precedence. style: form explode: true schema: allOf: - $ref: '#/components/schemas/format' - description: Format of the downloaded file. Supported yaml, json or hcl. Accept header can also be used, but the query parameter will take precedence. - name: FolderUID in: path description: '' required: true schema: type: string - name: Group in: path description: '' required: true schema: type: string responses: '200': description: AlertingFileExport headers: {} content: application/json: schema: $ref: '#/components/schemas/AlertingFileExportisthefullprovisionedfileexport.' application/yaml: schema: contentMediaType: application/yaml application/terraform+hcl: schema: contentMediaType: application/terraform+hcl text/yaml: schema: contentMediaType: text/yaml text/hcl: schema: contentMediaType: text/hcl '404': description: Not found. headers: {} content: {} deprecated: false x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /v1/provisioning/mute-timings: parameters: [] get: tags: - Get summary: Grafana Route Get Mute Timings description: The Get Mute Timings operation retrieves a list of all configured mute timings from Grafana's alerting system. Mute timings are scheduling rules that define time intervals during which alert notifications should be suppressed, such as during maintenance windows or outside business hours. This GET endpoint at /v1/provisioning/mute-timings returns the complete collection of mute timing configurations, allowing administrators to view when and under what conditions notifications will be automatically silenced. The response typically includes details like timing names, time intervals, days of the week, months, and any other temporal constraints that have been defined for each mute timing rule. operationId: routeGetMuteTimings parameters: [] responses: '200': description: MuteTimings headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/MuteTimeIntervalrepresentsanamedsetoftimeintervalsforwhicharouteshouldbemuted.' description: '' contentMediaType: application/json deprecated: false x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /v1/provisioning/mute-timings/{name}: parameters: [] get: tags: - Get summary: Grafana Route Get Mute Timing description: The Get Mute Timing operation retrieves a specific mute timing configuration by its unique name from Grafana's alerting system. Mute timings are used to define time intervals during which alert notifications should be suppressed, allowing users to prevent alerts during scheduled maintenance windows or known periods of reduced monitoring. By providing the mute timing name as a path parameter, this GET endpoint returns the complete configuration details of that particular mute timing, including its time intervals, recurrence rules, and any associated metadata, enabling users to review or audit existing notification suppression schedules programmatically. operationId: routeGetMuteTiming parameters: - name: name in: path description: Mute timing name required: true schema: type: string responses: '200': description: MuteTimeInterval headers: {} content: application/json: schema: $ref: '#/components/schemas/MuteTimeIntervalrepresentsanamedsetoftimeintervalsforwhicharouteshouldbemuted.' '404': description: Not found. headers: {} content: {} deprecated: false x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /v1/provisioning/policies: parameters: [] get: tags: - Get summary: Grafana Route Get Policy Tree description: This API operation retrieves the entire notification policy tree configuration from Grafana's alerting system. It returns the hierarchical structure that defines how alerts are routed to different contact points based on matching labels and conditions. The policy tree includes the root policy and all nested policies with their respective matchers, grouping settings, timing intervals, and associated receiver configurations. This endpoint is part of Grafana's provisioning API and requires appropriate authentication and authorization to access the alerting configuration. operationId: routeGetPolicyTree parameters: [] responses: '200': description: Route headers: {} content: application/json: schema: $ref: '#/components/schemas/Route' deprecated: false x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /v1/provisioning/policies/export: parameters: [] get: tags: - Get summary: Grafana Route Get Policy Tree Export description: This API operation retrieves and exports the complete policy tree structure from Grafana's provisioning system. It returns a comprehensive representation of all configured notification policies in an exportable format, which can be used for backup purposes, version control, or migration to other Grafana instances. The GET request to this endpoint provides administrators with a way to programmatically access and manage their alerting policy configurations outside of the Grafana UI, facilitating infrastructure-as-code practices and automated provisioning workflows. operationId: routeGetPolicyTreeExport parameters: [] responses: '200': description: AlertingFileExport headers: {} content: application/json: schema: $ref: '#/components/schemas/AlertingFileExportisthefullprovisionedfileexport.' application/yaml: schema: contentMediaType: application/yaml application/terraform+hcl: schema: contentMediaType: application/terraform+hcl text/yaml: schema: contentMediaType: text/yaml text/hcl: schema: contentMediaType: text/hcl '404': description: NotFound headers: {} content: application/json: schema: type: object contentMediaType: application/json application/yaml: schema: contentMediaType: application/yaml application/terraform+hcl: schema: contentMediaType: application/terraform+hcl text/yaml: schema: contentMediaType: text/yaml text/hcl: schema: contentMediaType: text/hcl deprecated: false x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /v1/provisioning/templates: parameters: [] get: tags: - Get summary: Grafana Route Get Templates description: This API operation retrieves provisioning templates from Grafana's alerting system. It is accessed via a GET request to the `/v1/provisioning/templates` endpoint and returns a collection of message templates that can be used for alert notifications. These templates define how alert messages are formatted and presented when notifications are sent through various channels, allowing administrators to standardize and customize the appearance and content of alert messages across their Grafana instance. operationId: routeGetTemplates parameters: [] responses: '200': description: NotificationTemplates headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/NotificationTemplate' description: '' contentMediaType: application/json deprecated: false x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /v1/provisioning/templates/{name}: parameters: [] get: tags: - Get summary: Grafana Route Get Template description: The Get Template operation retrieves a specific notification template by its name from Grafana's provisioning API. This endpoint allows users to fetch the complete configuration details of a previously created template, including its content, title, and any associated metadata. By making a GET request to /v1/provisioning/templates/{name} where {name} is the unique identifier of the template, administrators can programmatically access template definitions that are used for formatting alert notifications across various contact points and integrations within Grafana's alerting system. operationId: routeGetTemplate parameters: - name: name in: path description: Template group name required: true schema: type: string responses: '200': description: NotificationTemplate headers: {} content: application/json: schema: $ref: '#/components/schemas/NotificationTemplate' '404': description: PublicError headers: {} content: application/json: schema: $ref: '#/components/schemas/PublicError' deprecated: false x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true /v1/sso-settings/{key}: parameters: [] get: tags: - Get summary: Grafana Get Provider Settings description: Retrieves the configuration settings for a specific Single Sign-On (SSO) provider in Grafana by providing the provider's unique key identifier. This GET operation returns detailed information about the SSO provider's configuration, including authentication parameters, user mapping rules, and other provider-specific settings that control how users authenticate and are provisioned within Grafana through that particular SSO integration. operationId: getProviderSettings parameters: - name: key in: path description: '' required: true schema: type: string responses: '200': description: (empty) headers: {} content: application/json: schema: $ref: '#/components/schemas/getSSOSettingsResponse' '400': description: BadRequestError is returned when the request is invalid and it cannot be processed. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '401': description: UnauthorizedError is returned when the request is not authenticated. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '403': description: ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' '404': description: NotFoundError is returned when the requested resource was not found. headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseBody' deprecated: false x-api-evangelist-processing: SplitPascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true components: schemas: Type: title: Type enum: - alertmanager - dingding - discord - email - googlechat - kafka - line - opsgenie - pagerduty - pushover - sensugo - slack - teams - telegram - threema - victorops - webhook - wecom type: string examples: - webhook SnapshotDTO: title: SnapshotDTO type: object properties: created: type: string contentEncoding: date-time finished: type: string contentEncoding: date-time sessionUid: type: string status: $ref: '#/components/schemas/Status1' uid: type: string description: Base snapshot without results ReportOptions: title: ReportOptions type: object properties: layout: type: string orientation: type: string pdfCombineOneFile: type: boolean pdfShowTemplateVariables: type: boolean timeRange: $ref: '#/components/schemas/ReportTimeRange' ReportSettings: title: ReportSettings type: object properties: branding: $ref: '#/components/schemas/ReportBrandingOptions' embeddedImageTheme: type: string id: type: integer contentEncoding: int64 orgId: type: integer contentEncoding: int64 pdfTheme: type: string userId: type: integer contentEncoding: int64 AlertRuleGroupExportistheprovisionedfileexportofAlertRuleGroupV1.: title: AlertRuleGroupExportistheprovisionedfileexportofAlertRuleGroupV1. type: object properties: folder: type: string interval: type: integer description: 'A Duration represents the elapsed time between two instants as an int64 nanosecond count. The representation limits the largest representable duration to approximately 290 years.' contentEncoding: int64 name: type: string orgId: type: integer contentEncoding: int64 rules: type: array items: $ref: '#/components/schemas/AlertRuleExportistheprovisionedfileexportofmodels.AlertRule.' description: '' LibraryElementSearchResultisthesearchresultforentities.: title: LibraryElementSearchResultisthesearchresultforentities. type: object properties: elements: type: array items: $ref: '#/components/schemas/LibraryElementDTOisthefrontendDTOforentities.' description: '' page: type: integer contentEncoding: int64 perPage: type: integer contentEncoding: int64 totalCount: type: integer contentEncoding: int64 LibraryElementConnectionDTOisthefrontendDTOforelementconnections.: title: LibraryElementConnectionDTOisthefrontendDTOforelementconnections. type: object properties: connectionId: type: integer contentEncoding: int64 connectionUid: type: string created: type: string contentEncoding: date-time createdBy: $ref: '#/components/schemas/LibraryElementDTOMetaUser' elementId: type: integer contentEncoding: int64 id: type: integer description: 'Deprecated: this field will be removed in the future' contentEncoding: int64 kind: type: integer contentEncoding: int64 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 RoleDTO: title: RoleDTO required: - created - description - displayName - group - name - uid - updated - version type: object properties: created: type: string contentEncoding: date-time delegatable: type: boolean description: type: string displayName: type: string global: type: boolean group: type: string hidden: type: boolean mapped: type: boolean name: type: string permissions: type: array items: $ref: '#/components/schemas/Permission' description: '' uid: type: string updated: type: string contentEncoding: date-time version: type: integer contentEncoding: int64 getSharingOptionsResponse: title: getSharingOptionsResponse type: object properties: externalEnabled: type: boolean externalSnapshotName: type: string externalSnapshotURL: type: string LibraryElementDTOisthefrontendDTOforentities.: title: LibraryElementDTOisthefrontendDTOforentities. type: object properties: description: type: string folderId: type: integer description: 'Deprecated: use FolderUID instead' contentEncoding: int64 folderUid: type: string id: type: integer contentEncoding: int64 kind: type: integer contentEncoding: int64 meta: $ref: '#/components/schemas/LibraryElementDTOMetaisthemetainformationforLibraryElementDTO.' model: type: object name: type: string orgId: type: integer contentEncoding: int64 schemaVersion: type: integer contentEncoding: int64 type: type: string uid: type: string version: type: integer contentEncoding: int64 MuteTimeIntervalrepresentsanamedsetoftimeintervalsforwhicharouteshouldbemuted.: title: MuteTimeIntervalrepresentsanamedsetoftimeintervalsforwhicharouteshouldbemuted. type: object properties: name: type: string time_intervals: type: array items: $ref: '#/components/schemas/TimeIntervalrepresentsanamedsetoftimeintervalsforwhicharouteshouldbemuted.' description: '' QuotaDTO: title: QuotaDTO type: object properties: limit: type: integer contentEncoding: int64 org_id: type: integer contentEncoding: int64 target: type: string used: type: integer contentEncoding: int64 user_id: type: integer contentEncoding: int64 TeamDTO: title: TeamDTO required: - id - isProvisioned - memberCount - name - orgId - uid type: object properties: accessControl: type: object additionalProperties: type: boolean avatarUrl: type: string email: type: string externalUID: type: string id: type: integer description: '@deprecated Use UID instead' contentEncoding: int64 isProvisioned: type: boolean memberCount: type: integer contentEncoding: int64 name: type: string orgId: type: integer contentEncoding: int64 permission: type: integer contentEncoding: int64 uid: type: string Gethomedashboardresponse.: title: Gethomedashboardresponse. type: object properties: dashboard: type: object meta: $ref: '#/components/schemas/DashboardMeta' redirectUri: type: string getDataSourceIDResponse: title: getDataSourceIDResponse required: - id type: object properties: id: type: integer description: ID Identifier of the data source. contentEncoding: int64 examples: - 65 PreferencesQueryHistoryPreference: title: PreferencesQueryHistoryPreference type: object properties: homeTab: type: string description: 'one of: '''' | ''query'' | ''starred'';' description: +k8s:openapi-gen=true Group: title: Group type: object properties: groupID: type: string mappings: {} RouteExport: title: RouteExport type: object properties: active_time_intervals: type: array items: type: string description: '' continue: type: boolean group_by: type: array items: type: string description: '' group_interval: type: string group_wait: type: string match: type: object additionalProperties: type: string description: Deprecated. Remove before v1.0 release. match_re: type: object additionalProperties: type: string matchers: type: array items: $ref: '#/components/schemas/Matchermodelsthematchingofalabel.' description: 'Matchers is a slice of Matchers that is sortable, implements Stringer, and provides a Matches method to match a LabelSet against all Matchers in the slice. Note that some users of Matchers might require it to be sorted.' mute_time_intervals: type: array items: type: string description: '' object_matchers: type: array items: type: array items: type: string receiver: type: string repeat_interval: type: string routes: type: array items: $ref: '#/components/schemas/RouteExport' description: '' description: 'RouteExport is the provisioned file export of definitions.Route. This is needed to hide fields that aren''t useable in provisioning file format. An alternative would be to define a custom MarshalJSON and MarshalYAML that excludes them.' ResourceType: title: ResourceType enum: - DASHBOARD - DATASOURCE - FOLDER - LIBRARY_ELEMENT - ALERT_RULE - ALERT_RULE_GROUP - CONTACT_POINT - NOTIFICATION_POLICY - NOTIFICATION_TEMPLATE - MUTE_TIMING - PLUGIN type: string Report: title: Report type: object properties: created: type: string contentEncoding: date-time dashboards: type: array items: $ref: '#/components/schemas/ReportDashboard' description: '' enableCsv: type: boolean enableDashboardUrl: type: boolean formats: type: array items: type: string description: '' id: type: integer contentEncoding: int64 message: type: string name: type: string options: $ref: '#/components/schemas/ReportOptions' orgId: type: integer contentEncoding: int64 recipients: type: string replyTo: type: string scaleFactor: type: integer contentEncoding: int64 schedule: $ref: '#/components/schemas/ReportSchedule' state: type: string description: +enum subject: type: string uid: type: string updated: type: string contentEncoding: date-time userId: type: integer contentEncoding: int64 AlertRuleNotificationSettingsExportistheprovisionedexportofmodels.NotificationSettings.: title: AlertRuleNotificationSettingsExportistheprovisionedexportofmodels.NotificationSettings. type: object properties: active_time_intervals: type: array items: type: string description: '' group_by: type: array items: type: string description: '' group_interval: type: string group_wait: type: string mute_time_intervals: type: array items: type: string description: '' receiver: type: string repeat_interval: type: string Matchermodelsthematchingofalabel.: title: Matchermodelsthematchingofalabel. type: object properties: Name: type: string Type: type: integer contentEncoding: int64 Value: type: string DataSource: title: DataSource type: object properties: access: type: string accessControl: type: object additionalProperties: type: boolean description: 'Metadata contains user accesses for a given resource Ex: map[string]bool{"create":true, "delete": true}' basicAuth: type: boolean basicAuthUser: type: string database: type: string id: type: integer contentEncoding: int64 isDefault: type: boolean jsonData: type: object name: type: string orgId: type: integer contentEncoding: int64 readOnly: type: boolean secureJsonFields: type: object additionalProperties: type: boolean type: type: string typeLogoUrl: type: string uid: type: string url: type: string user: type: string version: type: integer contentEncoding: int64 withCredentials: type: boolean DashboardVersionMeta: title: DashboardVersionMeta type: object properties: created: type: string contentEncoding: date-time createdBy: type: string dashboardId: type: integer contentEncoding: int64 data: type: object id: type: integer contentEncoding: int64 message: type: string parentVersion: type: integer contentEncoding: int64 restoredFrom: type: integer contentEncoding: int64 uid: type: string version: type: integer contentEncoding: int64 description: 'DashboardVersionMeta extends the DashboardVersionDTO with the names associated with the UserIds, overriding the field with the same name from the DashboardVersionDTO model.' Assignments: title: Assignments type: object properties: builtInRoles: type: boolean serviceAccounts: type: boolean teams: type: boolean users: type: boolean Correlation: title: Correlation type: object properties: config: $ref: '#/components/schemas/CorrelationConfig' description: type: string description: Description of the correlation examples: - Logs to Traces label: type: string description: Label identifying the correlation examples: - My Label orgId: type: integer description: OrgID of the data source the correlation originates from contentEncoding: int64 examples: - 1 provisioned: type: boolean description: Provisioned True if the correlation was created during provisioning sourceUID: type: string description: UID of the data source the correlation originates from examples: - d0oxYRg4z targetUID: type: string description: UID of the data source the correlation points to examples: - PE1C5CBDA0504A6A3 type: type: string description: 'the type of correlation, either query for containing query information, or external for containing an external URL +enum' uid: type: string description: Unique identifier of the correlation examples: - 50xhMlg9k description: Correlation is the model for correlations definitions AlertingFileExportisthefullprovisionedfileexport.: title: AlertingFileExportisthefullprovisionedfileexport. type: object properties: apiVersion: type: integer contentEncoding: int64 contactPoints: type: array items: $ref: '#/components/schemas/ContactPointExportistheprovisionedfileexportofalerting.ContactPointV1.' description: '' groups: type: array items: $ref: '#/components/schemas/AlertRuleGroupExportistheprovisionedfileexportofAlertRuleGroupV1.' description: '' muteTimes: type: array items: $ref: '#/components/schemas/MuteTimeIntervalExport' description: '' policies: type: array items: $ref: '#/components/schemas/NotificationPolicyExportistheprovisionedfileexportofalerting.NotificiationPolicyV1.' description: '' NotificationTemplate: title: NotificationTemplate type: object properties: name: type: string provenance: type: string template: type: string version: type: string CloudMigrationSessionResponseDTO: title: CloudMigrationSessionResponseDTO type: object properties: created: type: string contentEncoding: date-time slug: type: string uid: type: string updated: type: string contentEncoding: date-time PublicError: title: PublicError type: object properties: extra: type: object additionalProperties: {} message: type: string messageId: type: string statusCode: type: integer contentEncoding: int64 description: 'PublicError is derived from Error and only contains information available to the end user.' SnapshotListResponseDTO: title: SnapshotListResponseDTO type: object properties: snapshots: type: array items: $ref: '#/components/schemas/SnapshotDTO' description: '' PreferencesSpec: title: PreferencesSpec type: object properties: cookiePreferences: allOf: - $ref: '#/components/schemas/PreferencesCookiePreferences' - description: +k8s:openapi-gen=true homeDashboardUID: type: string description: UID for the home dashboard language: type: string description: Selected language (beta) navbar: allOf: - $ref: '#/components/schemas/PreferencesNavbarPreference' - description: +k8s:openapi-gen=true queryHistory: allOf: - $ref: '#/components/schemas/PreferencesQueryHistoryPreference' - description: +k8s:openapi-gen=true regionalFormat: type: string description: Selected locale (beta) theme: type: string description: light, dark, empty is default timezone: type: string description: 'The timezone selection TODO: this should use the timezone defined in common' weekStart: type: string description: day of the week (sunday, monday, etc) description: +k8s:openapi-gen=true type3: title: type3 enum: - alert - annotation type: string ResourceDependencyDTO: title: ResourceDependencyDTO type: object properties: dependencies: type: array items: $ref: '#/components/schemas/Dependency' description: '' resourceType: $ref: '#/components/schemas/ResourceType' Recordistheprovisionedexportofmodels.Record.: title: Recordistheprovisionedexportofmodels.Record. type: object properties: from: type: string metric: type: string targetDatasourceUid: type: string Description: title: Description type: object properties: assignments: $ref: '#/components/schemas/Assignments' permissions: type: array items: type: string description: '' Token: title: Token type: object properties: account: type: string anonymousRatio: type: integer contentEncoding: int64 company: type: string details_url: type: string exp: type: integer contentEncoding: int64 iat: type: integer contentEncoding: int64 included_users: type: integer contentEncoding: int64 iss: type: string jti: type: string lexp: type: integer contentEncoding: int64 lic_exp_warn_days: type: integer contentEncoding: int64 lid: type: string limit_by: type: string max_concurrent_user_sessions: type: integer contentEncoding: int64 nbf: type: integer contentEncoding: int64 prod: type: array items: type: string description: '' slug: type: string status: type: integer contentEncoding: int64 sub: type: string tok_exp_warn_days: type: integer contentEncoding: int64 trial: type: boolean trial_exp: type: integer contentEncoding: int64 update_days: type: integer contentEncoding: int64 usage_billing: type: boolean 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 UserToken: title: UserToken type: object properties: AuthToken: type: string AuthTokenSeen: type: boolean ClientIp: type: string CreatedAt: type: integer contentEncoding: int64 ExternalSessionId: type: integer contentEncoding: int64 Id: type: integer contentEncoding: int64 PrevAuthToken: type: string RevokedAt: type: integer contentEncoding: int64 RotatedAt: type: integer contentEncoding: int64 SeenAt: type: integer contentEncoding: int64 UnhashedToken: type: string UpdatedAt: type: integer contentEncoding: int64 UserAgent: type: string UserId: type: integer contentEncoding: int64 description: UserToken represents a user token RoleAssignmentsDTO: title: RoleAssignmentsDTO type: object properties: role_uid: type: string service_accounts: type: array items: type: integer contentEncoding: int64 description: '' teams: type: array items: type: integer contentEncoding: int64 description: '' users: type: array items: type: integer contentEncoding: int64 description: '' TempUserDTO: title: TempUserDTO type: object properties: code: type: string createdOn: type: string contentEncoding: date-time email: type: string emailSent: type: boolean emailSentOn: type: string contentEncoding: date-time id: type: integer contentEncoding: int64 invitedByEmail: type: string invitedByLogin: type: string invitedByName: type: string name: type: string orgId: type: integer contentEncoding: int64 role: $ref: '#/components/schemas/Role' status: type: string url: type: string ReportBrandingOptions: title: ReportBrandingOptions type: object properties: emailFooterLink: type: string emailFooterMode: type: string emailFooterText: type: string emailLogoUrl: type: string reportLogoUrl: type: string ErrorResponseBody: title: ErrorResponseBody required: - message type: object properties: error: type: string description: Error An optional detailed description of the actual error. Only included if running in developer mode. message: type: string description: a human readable version of the error status: type: string description: 'Status An optional status to denote the cause of the error. For example, a 412 Precondition Failed error may include additional information of why that error happened.' ResourceDependenciesResponseDTO: title: ResourceDependenciesResponseDTO type: object properties: resourceDependencies: type: array items: $ref: '#/components/schemas/ResourceDependencyDTO' description: '' LibraryElementArrayResponseisaresponsestructforanarrayofLibraryElementDTO.: title: LibraryElementArrayResponseisaresponsestructforanarrayofLibraryElementDTO. type: object properties: result: type: array items: $ref: '#/components/schemas/LibraryElementDTOisthefrontendDTOforentities.' description: '' 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' CorrelationConfig: title: CorrelationConfig required: - field - target type: object properties: field: type: string description: Field used to attach the correlation link examples: - message target: type: object additionalProperties: {} description: Target data query examples: - prop1: value1 prop2: value transformations: type: array items: $ref: '#/components/schemas/Transformation' description: '' type: type: string description: 'the type of correlation, either query for containing query information, or external for containing an external URL +enum' FindTagsResultistheresultofatagssearch.: title: FindTagsResultistheresultofatagssearch. type: object properties: tags: type: array items: $ref: '#/components/schemas/TagsDTOisthefrontendDTOforTag.' description: '' LibraryElementResponseisaresponsestructforLibraryElementDTO.: title: LibraryElementResponseisaresponsestructforLibraryElementDTO. type: object properties: result: $ref: '#/components/schemas/LibraryElementDTOisthefrontendDTOforentities.' PlaylistItemDTO: title: PlaylistItemDTO type: object properties: title: type: string description: Title is an unused property -- it will be removed in the future type: type: string description: Type of the item. value: type: string description: 'Value depends on type and describes the playlist item. dashboard_by_id: The value is an internal numerical identifier set by Grafana. This is not portable as the numerical identifier is non-deterministic between different instances. Will be replaced by dashboard_by_uid in the future. (deprecated) dashboard_by_tag: The value is a tag which is set on any number of dashboards. All dashboards behind the tag will be added to the playlist. dashboard_by_uid: The value is the dashboard UID' PlaylistDTO: title: PlaylistDTO type: object properties: interval: type: string description: Interval sets the time between switching views in a playlist. items: type: array items: $ref: '#/components/schemas/PlaylistItemDTO' description: The ordered list of items that the playlist will iterate over. name: type: string description: Name of the playlist. uid: type: string description: 'Unique playlist identifier. Generated on creation, either by the creator of the playlist of by the application.' format: title: format enum: - yaml - json - hcl type: string TagsDTOisthefrontendDTOforTag.: title: TagsDTOisthefrontendDTOforTag. type: object properties: count: type: integer contentEncoding: int64 tag: type: string DashboardACLInfoDTO: title: DashboardACLInfoDTO type: object properties: created: type: string contentEncoding: date-time dashboardId: type: integer contentEncoding: int64 folderId: type: integer description: 'Deprecated: use FolderUID instead' contentEncoding: int64 folderUid: type: string inherited: type: boolean isFolder: type: boolean permission: type: integer contentEncoding: int64 permissionName: type: string role: $ref: '#/components/schemas/Role' slug: type: string team: type: string teamAvatarUrl: type: string teamEmail: type: string teamId: type: integer contentEncoding: int64 teamUid: type: string title: type: string uid: type: string updated: type: string contentEncoding: date-time url: type: string userAvatarUrl: type: string userEmail: type: string userId: type: integer contentEncoding: int64 userLogin: type: string userUid: type: string sortDirection: title: sortDirection enum: - alpha-asc - alpha-desc type: string ErrorCode: title: ErrorCode enum: - ALERT_RULES_QUOTA_REACHED - ALERT_RULES_GROUP_QUOTA_REACHED - DATASOURCE_NAME_CONFLICT - DATASOURCE_INVALID_URL - DATASOURCE_ALREADY_MANAGED - FOLDER_NAME_CONFLICT - DASHBOARD_ALREADY_MANAGED - LIBRARY_ELEMENT_NAME_CONFLICT - UNSUPPORTED_DATA_TYPE - RESOURCE_CONFLICT - UNEXPECTED_STATUS_CODE - INTERNAL_SERVICE_ERROR - GENERIC_ERROR type: string CacheConfigResponse: title: CacheConfigResponse type: object properties: created: type: string contentEncoding: date-time dataSourceID: type: integer description: Fields that can be set by the API caller - read/write contentEncoding: int64 dataSourceUID: type: string defaultTTLMs: type: integer description: 'These are returned by the HTTP API, but are managed internally - read-only Note: ''created'' and ''updated'' are special properties managed automatically by xorm, but we are setting them manually' contentEncoding: int64 enabled: type: boolean message: type: string ttlQueriesMs: type: integer description: TTL MS, or "time to live", is how long a cached item will stay in the cache before it is removed (in milliseconds) contentEncoding: int64 ttlResourcesMs: type: integer contentEncoding: int64 updated: type: string contentEncoding: date-time useDefaultTTL: type: boolean description: If UseDefaultTTL is enabled, then the TTLQueriesMS and TTLResourcesMS in this object is always sent as the default TTL located in grafana.ini Route: title: Route type: object properties: active_time_intervals: type: array items: type: string description: '' continue: type: boolean group_by: type: array items: type: string description: '' group_interval: type: string group_wait: type: string match: type: object additionalProperties: type: string description: Deprecated. Remove before v1.0 release. match_re: type: object additionalProperties: type: string matchers: type: array items: $ref: '#/components/schemas/Matchermodelsthematchingofalabel.' description: 'Matchers is a slice of Matchers that is sortable, implements Stringer, and provides a Matches method to match a LabelSet against all Matchers in the slice. Note that some users of Matchers might require it to be sorted.' mute_time_intervals: type: array items: type: string description: '' object_matchers: type: array items: type: array items: type: string provenance: type: string receiver: type: string repeat_interval: type: string routes: type: array items: $ref: '#/components/schemas/Route' description: '' description: 'A Route is a node that contains definitions of how to handle alerts. This is modified from the upstream alertmanager in that it adds the ObjectMatchers property.' GetSnapshotResponseDTO: title: GetSnapshotResponseDTO type: object properties: created: type: string contentEncoding: date-time finished: type: string contentEncoding: date-time results: type: array items: $ref: '#/components/schemas/MigrateDataResponseItemDTO' description: '' sessionUid: type: string stats: $ref: '#/components/schemas/SnapshotResourceStats' status: $ref: '#/components/schemas/Status1' uid: type: string TeamLBACRules: title: TeamLBACRules type: object properties: rules: type: array items: $ref: '#/components/schemas/TeamLBACRule' description: '' SnapshotResourceStats: title: SnapshotResourceStats type: object properties: statuses: type: object additionalProperties: type: integer format: int64 total: type: integer contentEncoding: int64 types: type: object additionalProperties: type: integer format: int64 OrgDetailsDTO: title: OrgDetailsDTO type: object properties: address: $ref: '#/components/schemas/Address' id: type: integer contentEncoding: int64 name: type: string DashboardFullWithMeta: title: DashboardFullWithMeta type: object properties: dashboard: type: object meta: $ref: '#/components/schemas/DashboardMeta' 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.' MigrateDataResponseItemDTO: title: MigrateDataResponseItemDTO required: - refId - status - type type: object properties: errorCode: $ref: '#/components/schemas/ErrorCode' message: type: string name: type: string parentName: type: string refId: type: string status: $ref: '#/components/schemas/Status' type: $ref: '#/components/schemas/Type2' TeamGroupDTO: title: TeamGroupDTO type: object properties: groupId: type: string orgId: type: integer contentEncoding: int64 teamId: type: integer contentEncoding: int64 uid: type: string Type2: title: Type2 enum: - DASHBOARD - DATASOURCE - FOLDER - LIBRARY_ELEMENT - ALERT_RULE - ALERT_RULE_GROUP - CONTACT_POINT - NOTIFICATION_POLICY - NOTIFICATION_TEMPLATE - MUTE_TIMING - PLUGIN type: string UserProfileDTO: title: UserProfileDTO type: object properties: accessControl: type: object additionalProperties: type: boolean authLabels: type: array items: type: string description: '' avatarUrl: type: string createdAt: type: string contentEncoding: date-time email: type: string id: type: integer contentEncoding: int64 isDisabled: type: boolean isExternal: type: boolean isExternallySynced: type: boolean isGrafanaAdmin: type: boolean isGrafanaAdminExternallySynced: type: boolean isProvisioned: type: boolean login: type: string name: type: string orgId: type: integer contentEncoding: int64 theme: type: string uid: type: string updatedAt: type: string contentEncoding: date-time SuccessResponseBody: title: SuccessResponseBody type: object properties: message: type: string AlertRuleExportistheprovisionedfileexportofmodels.AlertRule.: title: AlertRuleExportistheprovisionedfileexportofmodels.AlertRule. type: object properties: annotations: type: object additionalProperties: type: string condition: type: string dashboardUid: type: string data: type: array items: $ref: '#/components/schemas/AlertQueryExportistheprovisionedexportofmodels.AlertQuery.' description: '' execErrState: $ref: '#/components/schemas/ExecErrState' for: type: integer description: 'A Duration represents the elapsed time between two instants as an int64 nanosecond count. The representation limits the largest representable duration to approximately 290 years.' contentEncoding: int64 isPaused: type: boolean keepFiringFor: type: integer description: 'A Duration represents the elapsed time between two instants as an int64 nanosecond count. The representation limits the largest representable duration to approximately 290 years.' contentEncoding: int64 labels: type: object additionalProperties: type: string missing_series_evals_to_resolve: type: integer contentEncoding: int64 noDataState: $ref: '#/components/schemas/NoDataState' notification_settings: $ref: '#/components/schemas/AlertRuleNotificationSettingsExportistheprovisionedexportofmodels.NotificationSettings.' panelId: type: integer contentEncoding: int64 record: $ref: '#/components/schemas/Recordistheprovisionedexportofmodels.Record.' title: type: string uid: type: string 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 resourcePermissionDTO: title: resourcePermissionDTO type: object properties: actions: type: array items: type: string description: '' builtInRole: type: string id: type: integer contentEncoding: int64 isInherited: type: boolean isManaged: type: boolean isServiceAccount: type: boolean permission: type: string roleName: type: string team: type: string teamAvatarUrl: type: string teamId: type: integer contentEncoding: int64 teamUid: type: string userAvatarUrl: type: string userId: type: integer contentEncoding: int64 userLogin: type: string userUid: type: string getGroupsResponse: title: getGroupsResponse type: object properties: groups: type: array items: $ref: '#/components/schemas/Group' description: '' total: type: integer contentEncoding: int64 healthResponse: title: healthResponse type: object properties: commit: type: string database: type: string enterpriseCommit: type: string version: type: string OrgUserDTO: title: OrgUserDTO type: object properties: accessControl: type: object additionalProperties: type: boolean authLabels: type: array items: type: string description: '' avatarUrl: type: string email: type: string isDisabled: type: boolean isExternallySynced: type: boolean isProvisioned: type: boolean lastSeenAt: type: string contentEncoding: date-time lastSeenAtAge: type: string login: type: string name: type: string orgId: type: integer contentEncoding: int64 role: type: string uid: type: string userId: type: integer contentEncoding: int64 Address: title: Address type: object properties: address1: type: string address2: type: string city: type: string country: type: string state: type: string zipCode: type: string EmbeddedContactPoint: title: EmbeddedContactPoint required: - settings - type type: object properties: disableResolveMessage: type: boolean examples: - false name: type: string description: 'Name is used as grouping key in the UI. Contact points with the same name will be grouped in the UI.' examples: - webhook_1 provenance: type: string readOnly: true settings: type: object type: allOf: - $ref: '#/components/schemas/Type' - examples: - webhook uid: maxLength: 40 minLength: 1 pattern: ^[a-zA-Z0-9\-\_]+$ type: string description: 'UID is the unique identifier of the contact point. The UID can be set by the user.' examples: - my_external_reference description: 'EmbeddedContactPoint is the contact point type that is used by grafanas embedded alertmanager implementation.' Folder: title: Folder type: object properties: accessControl: type: object additionalProperties: type: boolean description: 'Metadata contains user accesses for a given resource Ex: map[string]bool{"create":true, "delete": true}' canAdmin: type: boolean canDelete: type: boolean canEdit: type: boolean canSave: type: boolean created: type: string contentEncoding: date-time createdBy: type: string hasAcl: type: boolean id: type: integer description: 'Deprecated: use UID instead' contentEncoding: int64 managedBy: type: string description: 'It can be a user or a tool or a generic API client. +enum' orgId: type: integer contentEncoding: int64 parentUid: type: string description: only used if nested folders are enabled parents: type: array items: $ref: '#/components/schemas/Folder' description: the parent folders starting from the root going down title: type: string uid: type: string updated: type: string contentEncoding: date-time updatedBy: type: string url: type: string version: type: integer contentEncoding: int64 AnnotationActions: title: AnnotationActions type: object properties: canAdd: type: boolean canDelete: type: boolean canEdit: type: boolean description: +k8s:deepcopy-gen=true GetAccessTokenResponseDTO: title: GetAccessTokenResponseDTO type: object properties: createdAt: type: string displayName: type: string expiresAt: type: string firstUsedAt: type: string id: type: string lastUsedAt: type: string ReceiverExportistheprovisionedfileexportofalerting.ReceiverV1.: title: ReceiverExportistheprovisionedfileexportofalerting.ReceiverV1. type: object properties: disableResolveMessage: type: boolean settings: type: object type: type: string uid: type: string TeamMemberDTO: title: TeamMemberDTO type: object properties: auth_module: type: string avatarUrl: type: string email: type: string labels: type: array items: type: string description: '' login: type: string name: type: string orgId: type: integer contentEncoding: int64 permission: type: integer contentEncoding: int64 teamId: type: integer contentEncoding: int64 teamUID: type: string uid: type: string userId: type: integer contentEncoding: int64 userUID: type: string Permission: title: Permission type: object properties: action: type: string created: type: string contentEncoding: date-time scope: type: string updated: type: string contentEncoding: date-time description: Permission is the model for access control permissions NoDataState: title: NoDataState enum: - Alerting - NoData - OK type: string PrometheusRemoteWriteTargetJSON: title: PrometheusRemoteWriteTargetJSON type: object properties: data_source_uid: type: string id: type: string remote_write_path: type: string Role: title: Role enum: - None - Viewer - Editor - Admin type: string ActiveSyncStatusDTO: title: ActiveSyncStatusDTO type: object properties: enabled: type: boolean nextSync: type: string contentEncoding: date-time prevSync: $ref: '#/components/schemas/SyncResultholdstheresultofasyncwithLDAP.Thisgivesusinformationonwhichuserswereupdatedandhow.' schedule: type: string description: ActiveSyncStatusDTO holds the information for LDAP background Sync NotificationPolicyExportistheprovisionedfileexportofalerting.NotificiationPolicyV1.: title: NotificationPolicyExportistheprovisionedfileexportofalerting.NotificiationPolicyV1. type: object properties: active_time_intervals: type: array items: type: string description: '' continue: type: boolean group_by: type: array items: type: string description: '' group_interval: type: string group_wait: type: string match: type: object additionalProperties: type: string description: Deprecated. Remove before v1.0 release. match_re: type: object additionalProperties: type: string matchers: type: array items: $ref: '#/components/schemas/Matchermodelsthematchingofalabel.' description: 'Matchers is a slice of Matchers that is sortable, implements Stringer, and provides a Matches method to match a LabelSet against all Matchers in the slice. Note that some users of Matchers might require it to be sorted.' mute_time_intervals: type: array items: type: string description: '' object_matchers: type: array items: type: array items: type: string orgId: type: integer contentEncoding: int64 receiver: type: string repeat_interval: type: string routes: type: array items: $ref: '#/components/schemas/RouteExport' description: '' GetAnnotationTagsResponseisaresponsestructforFindTagsResult.: title: GetAnnotationTagsResponseisaresponsestructforFindTagsResult. type: object properties: result: $ref: '#/components/schemas/FindTagsResultistheresultofatagssearch.' DataSourceListItemDTO: title: DataSourceListItemDTO type: object properties: access: type: string basicAuth: type: boolean database: type: string id: type: integer contentEncoding: int64 isDefault: type: boolean jsonData: type: object name: type: string orgId: type: integer contentEncoding: int64 readOnly: type: boolean type: type: string typeLogoUrl: type: string typeName: type: string uid: type: string url: type: string user: type: string SyncResultholdstheresultofasyncwithLDAP.Thisgivesusinformationonwhichuserswereupdatedandhow.: title: SyncResultholdstheresultofasyncwithLDAP.Thisgivesusinformationonwhichuserswereupdatedandhow. type: object properties: Elapsed: type: integer description: 'A Duration represents the elapsed time between two instants as an int64 nanosecond count. The representation limits the largest representable duration to approximately 290 years.' contentEncoding: int64 FailedUsers: type: array items: $ref: '#/components/schemas/FailedUser' description: '' MissingUserIds: type: array items: type: integer contentEncoding: int64 description: '' Started: type: string contentEncoding: date-time UpdatedUserIds: type: array items: type: integer contentEncoding: int64 description: '' permission1: title: permission1 enum: - Edit - View type: string LibraryElementDTOMetaUser: title: LibraryElementDTOMetaUser type: object properties: avatarUrl: type: string id: type: integer contentEncoding: int64 name: type: string Transformation: title: Transformation type: object properties: expression: type: string field: type: string mapValue: type: string type: $ref: '#/components/schemas/Type1' Record: title: Record required: - from - metric type: object properties: from: type: string description: Which expression node should be used as the input for the recorded metric. examples: - A metric: type: string description: Name of the recorded metric. examples: - grafana_alerts_ratio target_datasource_uid: type: string description: Which data source should be used to write the output of the recording rule, specified by UID. examples: - my-prom getSSOSettingsResponse: title: getSSOSettingsResponse type: object properties: id: type: string provider: type: string settings: type: object additionalProperties: {} source: type: string UserLookupDTO: title: UserLookupDTO type: object properties: avatarUrl: type: string login: type: string uid: type: string userId: type: integer contentEncoding: int64 Status1: title: Status1 enum: - INITIALIZING - CREATING - PENDING_UPLOAD - UPLOADING - PENDING_PROCESSING - PROCESSING - FINISHED - CANCELED - ERROR - UNKNOWN type: string PreferencesNavbarPreference: title: PreferencesNavbarPreference type: object properties: bookmarkUrls: type: array items: type: string description: '' description: +k8s:openapi-gen=true 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 ReportDashboardID: title: ReportDashboardID type: object properties: id: type: integer contentEncoding: int64 name: type: string uid: type: string RelativeTimeRangeExport: title: RelativeTimeRangeExport type: object properties: from: type: integer contentEncoding: int64 to: type: integer contentEncoding: int64 ProvisionedAlertRule: title: ProvisionedAlertRule required: - condition - data - execErrState - folderUID - for - noDataState - orgID - ruleGroup - title type: object properties: annotations: type: object additionalProperties: type: string examples: - runbook_url: https://supercoolrunbook.com/page/13 condition: type: string examples: - A data: type: array items: $ref: '#/components/schemas/AlertQueryrepresentsasinglequeryassociatedwithanalertdefinition.' description: '' examples: - - datasourceUid: __expr__ model: conditions: - evaluator: params: - 0 - 0 type: gt operator: type: and query: params: [] reducer: params: [] type: avg type: query datasource: type: __expr__ uid: __expr__ expression: 1 == 1 hide: false intervalMs: 1000 maxDataPoints: 43200 refId: A type: math queryType: '' refId: A relativeTimeRange: from: 0 to: 0 execErrState: $ref: '#/components/schemas/ExecErrState' folderUID: type: string examples: - project_x for: type: string id: type: integer contentEncoding: int64 isPaused: type: boolean examples: - false keep_firing_for: type: string labels: type: object additionalProperties: type: string examples: - team: sre-team-1 missingSeriesEvalsToResolve: type: integer contentEncoding: int64 examples: - 2 noDataState: $ref: '#/components/schemas/NoDataState' notification_settings: $ref: '#/components/schemas/AlertRuleNotificationSettings' orgID: type: integer contentEncoding: int64 provenance: type: string record: $ref: '#/components/schemas/Record' ruleGroup: maxLength: 190 minLength: 1 type: string examples: - eval_group_1 title: maxLength: 190 minLength: 1 type: string examples: - Always firing uid: maxLength: 40 minLength: 1 pattern: ^[a-zA-Z0-9-_]+$ type: string updated: type: string contentEncoding: date-time readOnly: true LibraryElementSearchResponseisaresponsestructforLibraryElementSearchResult.: title: LibraryElementSearchResponseisaresponsestructforLibraryElementSearchResult. type: object properties: result: $ref: '#/components/schemas/LibraryElementSearchResultisthesearchresultforentities.' LibraryElementDTOMetaisthemetainformationforLibraryElementDTO.: title: LibraryElementDTOMetaisthemetainformationforLibraryElementDTO. type: object properties: connectedDashboards: type: integer contentEncoding: int64 created: type: string contentEncoding: date-time createdBy: $ref: '#/components/schemas/LibraryElementDTOMetaUser' folderName: type: string folderUid: type: string updated: type: string contentEncoding: date-time updatedBy: $ref: '#/components/schemas/LibraryElementDTOMetaUser' CloudMigrationSessionListResponseDTO: title: CloudMigrationSessionListResponseDTO type: object properties: sessions: type: array items: $ref: '#/components/schemas/CloudMigrationSessionResponseDTO' description: '' ReportDashboard: title: ReportDashboard type: object properties: dashboard: $ref: '#/components/schemas/ReportDashboardID' reportVariables: type: object timeRange: $ref: '#/components/schemas/ReportTimeRange' AdminStats: title: AdminStats type: object properties: activeAdmins: type: integer contentEncoding: int64 activeDevices: type: integer contentEncoding: int64 activeEditors: type: integer contentEncoding: int64 activeSessions: type: integer contentEncoding: int64 activeUsers: type: integer contentEncoding: int64 activeViewers: type: integer contentEncoding: int64 admins: type: integer contentEncoding: int64 alerts: type: integer contentEncoding: int64 dailyActiveAdmins: type: integer contentEncoding: int64 dailyActiveEditors: type: integer contentEncoding: int64 dailyActiveSessions: type: integer contentEncoding: int64 dailyActiveUsers: type: integer contentEncoding: int64 dailyActiveViewers: type: integer contentEncoding: int64 dashboards: type: integer contentEncoding: int64 datasources: type: integer contentEncoding: int64 editors: type: integer contentEncoding: int64 monthlyActiveUsers: type: integer contentEncoding: int64 orgs: type: integer contentEncoding: int64 playlists: type: integer contentEncoding: int64 snapshots: type: integer contentEncoding: int64 stars: type: integer contentEncoding: int64 tags: type: integer contentEncoding: int64 users: type: integer contentEncoding: int64 viewers: type: integer contentEncoding: int64 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' FailedUser: title: FailedUser type: object properties: Error: type: string Login: type: string description: FailedUser holds the information of an user that failed AlertRuleNotificationSettings: title: AlertRuleNotificationSettings required: - receiver type: object properties: active_time_intervals: type: array items: type: string description: 'Override the times when notifications should not be muted. These must match the name of a mute time interval defined in the alertmanager configuration time_intervals section. All notifications will be suppressed unless they are sent at the time that matches any interval.' examples: - - maintenance group_by: type: array items: type: string description: 'Override the labels by which incoming alerts are grouped together. For example, multiple alerts coming in for cluster=A and alertname=LatencyHigh would be batched into a single group. To aggregate by all possible labels use the special value ''...'' as the sole label name. This effectively disables aggregation entirely, passing through all alerts as-is. This is unlikely to be what you want, unless you have a very low alert volume or your upstream notification system performs its own grouping. Must include ''alertname'' and ''grafana_folder'' if not using ''...''.' default: - alertname - grafana_folder examples: - - alertname - grafana_folder - cluster group_interval: type: string description: 'Override how long to wait before sending a notification about new alerts that are added to a group of alerts for which an initial notification has already been sent. (Usually ~5m or more.)' examples: - 5m group_wait: type: string description: 'Override how long to initially wait to send a notification for a group of alerts. Allows to wait for an inhibiting alert to arrive or collect more initial alerts for the same group. (Usually ~0s to few minutes.)' examples: - 30s mute_time_intervals: type: array items: type: string description: 'Override the times when notifications should be muted. These must match the name of a mute time interval defined in the alertmanager configuration time_intervals section. When muted it will not send any notifications, but otherwise acts normally.' examples: - - maintenance receiver: type: string description: Name of the receiver to send notifications to. examples: - grafana-default-email repeat_interval: type: string description: 'Override how long to wait before sending a notification again if it has already been sent successfully for an alert. (Usually ~3h or more). Note that this parameter is implicitly bound by Alertmanager''s `--data.retention` configuration flag. Notifications will be resent after either repeat_interval or the data retention period have passed, whichever occurs first. `repeat_interval` should not be less than `group_interval`.' examples: - 4h ReportSchedule: title: ReportSchedule type: object properties: dayOfMonth: type: string endDate: type: string contentEncoding: date-time frequency: type: string intervalAmount: type: integer contentEncoding: int64 intervalFrequency: type: string startDate: type: string contentEncoding: date-time timeZone: type: string workdaysOnly: type: boolean DashboardTagCloudItem: title: DashboardTagCloudItem type: object properties: count: type: integer contentEncoding: int64 term: type: string DashboardVersionResponseMeta: title: DashboardVersionResponseMeta type: object properties: continueToken: type: string versions: type: array items: $ref: '#/components/schemas/DashboardVersionMeta' description: '' UserOrgDTO: title: UserOrgDTO type: object properties: name: type: string orgId: type: integer contentEncoding: int64 role: $ref: '#/components/schemas/Role' ReportTimeRange: title: ReportTimeRange type: object properties: from: type: string to: type: string FolderSearchHit: title: FolderSearchHit type: object properties: id: type: integer contentEncoding: int64 managedBy: type: string description: 'It can be a user or a tool or a generic API client. +enum' parentUid: type: string title: type: string uid: type: string LibraryElementConnectionsResponseisaresponsestructforanarrayofLibraryElementConnectionDTO.: title: LibraryElementConnectionsResponseisaresponsestructforanarrayofLibraryElementConnectionDTO. type: object properties: result: type: array items: $ref: '#/components/schemas/LibraryElementConnectionDTOisthefrontendDTOforelementconnections.' description: '' AlertRuleGroup: title: AlertRuleGroup type: object properties: folderUid: type: string interval: type: integer contentEncoding: int64 rules: type: array items: $ref: '#/components/schemas/ProvisionedAlertRule' description: '' title: type: string RelativeTimeRange: title: RelativeTimeRange type: object properties: from: type: integer description: 'A Duration represents the elapsed time between two instants as an int64 nanosecond count. The representation limits the largest representable duration to approximately 290 years.' contentEncoding: int64 to: type: integer description: 'A Duration represents the elapsed time between two instants as an int64 nanosecond count. The representation limits the largest representable duration to approximately 290 years.' contentEncoding: int64 description: 'RelativeTimeRange is the per query start and end time for requests.' EmailDTO: title: EmailDTO type: object properties: recipient: type: string uid: type: string Dependency: title: Dependency enum: - DASHBOARD - DATASOURCE - FOLDER - LIBRARY_ELEMENT - ALERT_RULE - ALERT_RULE_GROUP - CONTACT_POINT - NOTIFICATION_POLICY - NOTIFICATION_TEMPLATE - MUTE_TIMING - PLUGIN 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 Annotation: title: Annotation type: object properties: alertId: type: integer contentEncoding: int64 alertName: type: string avatarUrl: type: string created: type: integer contentEncoding: int64 dashboardId: type: integer description: 'Deprecated: Use DashboardUID and OrgID instead' contentEncoding: int64 dashboardUID: type: string data: type: object email: type: string id: type: integer contentEncoding: int64 login: type: string newState: type: string panelId: type: integer contentEncoding: int64 prevState: type: string tags: type: array items: type: string description: '' text: type: string time: type: integer contentEncoding: int64 timeEnd: type: integer contentEncoding: int64 updated: type: integer contentEncoding: int64 userId: type: integer contentEncoding: int64 ExecErrState: title: ExecErrState enum: - OK - Alerting - Error type: string Type1: title: Type1 enum: - regex - logfmt type: string AlertQueryrepresentsasinglequeryassociatedwithanalertdefinition.: title: AlertQueryrepresentsasinglequeryassociatedwithanalertdefinition. type: object properties: datasourceUid: type: string description: Grafana data source unique identifier; it should be '__expr__' for a Server Side Expression operation. model: type: object description: JSON is the raw JSON query and includes the above properties as well as custom properties. queryType: type: string description: 'QueryType is an optional identifier for the type of query. It can be used to distinguish different types of queries.' refId: type: string description: RefID is the unique identifier of the query, set by the frontend call. relativeTimeRange: allOf: - $ref: '#/components/schemas/RelativeTimeRange' - description: 'RelativeTimeRange is the per query start and end time for requests.' ContactPointExportistheprovisionedfileexportofalerting.ContactPointV1.: title: ContactPointExportistheprovisionedfileexportofalerting.ContactPointV1. type: object properties: name: type: string orgId: type: integer contentEncoding: int64 receivers: type: array items: $ref: '#/components/schemas/ReceiverExportistheprovisionedfileexportofalerting.ReceiverV1.' description: '' Status: title: Status enum: - OK - WARNING - ERROR - PENDING - UNKNOWN type: string TimeIntervalrepresentsanamedsetoftimeintervalsforwhicharouteshouldbemuted.: title: TimeIntervalrepresentsanamedsetoftimeintervalsforwhicharouteshouldbemuted. type: object properties: name: type: string time_intervals: type: array items: $ref: '#/components/schemas/TimeIntervalrepresentsanamedsetoftimeintervalsforwhicharouteshouldbemuted.' description: '' TeamLBACRule: title: TeamLBACRule type: object properties: rules: type: array items: type: string description: '' teamId: type: string teamUid: type: string 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 MuteTimeIntervalExport: title: MuteTimeIntervalExport type: object properties: name: type: string orgId: type: integer contentEncoding: int64 time_intervals: type: array items: $ref: '#/components/schemas/TimeIntervalrepresentsanamedsetoftimeintervalsforwhicharouteshouldbemuted.' description: '' AlertQueryExportistheprovisionedexportofmodels.AlertQuery.: title: AlertQueryExportistheprovisionedexportofmodels.AlertQuery. type: object properties: datasourceUid: type: string model: type: object additionalProperties: {} queryType: type: string refId: type: string relativeTimeRange: $ref: '#/components/schemas/RelativeTimeRangeExport' PreferencesCookiePreferences: title: PreferencesCookiePreferences type: object properties: analytics: {} functional: {} performance: {} description: +k8s:openapi-gen=true 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 '