{ "opencollection": "1.0.0", "info": { "name": "Grafana HTTP Access Recording API", "version": "11.0.0" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Recording", "type": "folder" }, "items": [ { "info": { "name": "Grafana List Recording Rules", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.grafana.net/api/recording-rules" }, "docs": "This API operation retrieves a list of all recording rules configured in Grafana. Recording rules are used to pre-compute frequently needed or computationally expensive expressions and save their result as a new set of time series data, which can improve query performance and reduce load on data sources. The GET request to the /recording-rules endpoint returns details about existing recording rules including their names, expressions, labels, and associated data sources, allowing administrators a" }, { "info": { "name": "Grafana Create Recording Rule", "type": "http" }, "http": { "method": "POST", "url": "https://{instance}.grafana.net/api/recording-rules", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new recording rule in Grafana's alerting system that allows you to pre-compute frequently needed or computationally expensive expressions and save their result as a new set of time series. This POST endpoint accepts a recording rule definition including the rule name, query expression, labels, and evaluation interval, then stores it in the Grafana instance for continuous evaluation. Recording rules are particularly useful for dashboard performance optimization and creating aggregated m" }, { "info": { "name": "Grafana Update Recording Rule", "type": "http" }, "http": { "method": "PUT", "url": "https://{instance}.grafana.net/api/recording-rules", "body": { "type": "json", "data": "{}" } }, "docs": "Updates an existing recording rule in Grafana's alerting system. Recording rules are used to pre-calculate frequently needed or computationally expensive expressions and save their results as a new set of time series. This operation allows you to modify the configuration of a recording rule including its query expressions, labels, evaluation interval, and other parameters. You need to provide the complete updated recording rule configuration in the request body, and the rule will be identified b" }, { "info": { "name": "Grafana Test Create Recording Rule", "type": "http" }, "http": { "method": "POST", "url": "https://{instance}.grafana.net/api/recording-rules/test", "body": { "type": "json", "data": "{}" } }, "docs": "This API operation allows users to test the creation of a recording rule in Grafana before actually implementing it. By sending a POST request to the /recording-rules/test endpoint, users can validate their recording rule configuration, including the PromQL expression, labels, and other parameters, to ensure it functions as expected without permanently adding it to the system. This testing capability helps prevent errors and allows users to verify that their recording rule will produce the desir" }, { "info": { "name": "Grafana Get Recording Rule Write Target", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.grafana.net/api/recording-rules/writer" }, "docs": "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 reco" }, { "info": { "name": "Grafana Create Recording Rule Write Target", "type": "http" }, "http": { "method": "POST", "url": "https://{instance}.grafana.net/api/recording-rules/writer", "body": { "type": "json", "data": "{}" } }, "docs": "The POST operation on the /recording-rules/writer endpoint in Grafana allows administrators to create a new recording rule write target, which defines a destination where pre-computed metric aggregations (recording rules) should be written. This endpoint accepts configuration details such as the remote write URL, authentication credentials, and other parameters necessary to establish a connection with the target storage system. Recording rule write targets enable Grafana to send the results of r" }, { "info": { "name": "Grafana Delete Recording Rule Write Target", "type": "http" }, "http": { "method": "DELETE", "url": "https://{instance}.grafana.net/api/recording-rules/writer" }, "docs": "This API operation removes a configured recording rule write target from Grafana. Recording rule write targets define external destinations where pre-aggregated metric data can be stored, and deleting a write target will disconnect Grafana from that specific storage endpoint. This DELETE operation is typically used when decommissioning a remote write destination, cleaning up unused configurations, or reconfiguring the recording rules infrastructure. Once deleted, recording rules will no longer w" }, { "info": { "name": "Grafana Delete Recording Rule", "type": "http" }, "http": { "method": "DELETE", "url": "https://{instance}.grafana.net/api/recording-rules/:recordingRuleID", "params": [ { "name": "recordingRuleID", "value": "", "type": "path" } ] }, "docs": "Deletes a specific recording rule from Grafana by providing its unique identifier in the request path. Recording rules are used to pre-compute frequently needed or computationally expensive expressions and save their results as new time series data. This DELETE operation permanently removes the recording rule configuration identified by the recordingRuleID parameter, stopping any future evaluations and recordings associated with that rule. The operation requires appropriate authentication and au" } ] } ], "bundled": true }