{ "opencollection": "1.0.0", "info": { "name": "Grafana HTTP Access Groups API", "version": "11.0.0" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Groups", "type": "folder" }, "items": [ { "info": { "name": "Grafana Route Convert Prometheus Cortex Post Rule Groups", "type": "http" }, "http": { "method": "POST", "url": "https://{instance}.grafana.net/api/convert/api/prom/rules", "headers": [ { "name": "Content-Type", "value": "" } ] }, "docs": "This API operation converts Prometheus or Cortex rule group configurations into Grafana's native format by accepting a POST request to the /convert/api/prom/rules endpoint. It enables users to migrate their existing Prometheus-style alerting and recording rules from Prometheus or Cortex deployments into Grafana, facilitating the transition between monitoring systems while preserving rule logic and structure. The endpoint processes the submitted rule groups and transforms them into a format compa" }, { "info": { "name": "Grafana Route Convert Prometheus Cortex Post Rule Group", "type": "http" }, "http": { "method": "POST", "url": "https://{instance}.grafana.net/api/convert/api/prom/rules/:NamespaceTitle", "headers": [ { "name": "x-grafana-alerting-datasource-uid", "value": "" }, { "name": "x-grafana-alerting-recording-rules-paused", "value": "" }, { "name": "x-grafana-alerting-alert-rules-paused", "value": "" }, { "name": "x-grafana-alerting-target-datasource-uid", "value": "" }, { "name": "x-grafana-alerting-folder-uid", "value": "" }, { "name": "x-grafana-alerting-notification-settings", "value": "" } ], "params": [ { "name": "NamespaceTitle", "value": "", "type": "path" } ] }, "docs": "The Grafana API operation POST /convert/api/prom/rules/{NamespaceTitle} converts and creates a Prometheus or Cortex rule group within a specified namespace. This endpoint accepts Prometheus-style rule definitions and transforms them into Grafana's native alert rule format, allowing users to migrate their existing Prometheus alerting and recording rules into Grafana's unified alerting system. The {NamespaceTitle} parameter identifies the target namespace where the converted rule group will be sto" }, { "info": { "name": "Grafana Route Convert Prometheus Cortex Get Rule Group", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.grafana.net/api/convert/api/prom/rules/:NamespaceTitle/:Group", "params": [ { "name": "NamespaceTitle", "value": "", "type": "path" }, { "name": "Group", "value": "", "type": "path" } ] }, "docs": "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 conv" }, { "info": { "name": "Grafana Route Convert Prometheus Cortex Delete Rule Group", "type": "http" }, "http": { "method": "DELETE", "url": "https://{instance}.grafana.net/api/convert/api/prom/rules/:NamespaceTitle/:Group", "params": [ { "name": "NamespaceTitle", "value": "", "type": "path" }, { "name": "Group", "value": "", "type": "path" } ] }, "docs": "This API operation is used to delete a specific Prometheus rule group within Grafana's Cortex-based alerting system. It targets a rule group identified by both its namespace title and group name through the URL path parameters. When called with the DELETE HTTP method, it removes the entire rule group configuration from the specified namespace, effectively eliminating all alert and recording rules contained within that group from the Prometheus-compatible rules engine in Grafana." }, { "info": { "name": "Grafana Route Convert Prometheus Post Rule Groups", "type": "http" }, "http": { "method": "POST", "url": "https://{instance}.grafana.net/api/convert/prometheus/config/v1/rules", "headers": [ { "name": "Content-Type", "value": "" } ] }, "docs": "This API operation converts Prometheus rule group configurations to Grafana's format via a POST request to the /convert/prometheus/config/v1/rules endpoint. It accepts Prometheus-formatted rule groups as input and transforms them into a compatible format that can be used within Grafana's alerting and recording rule system, facilitating migration or integration between Prometheus and Grafana monitoring setups." }, { "info": { "name": "Grafana Route Convert Prometheus Post Rule Group", "type": "http" }, "http": { "method": "POST", "url": "https://{instance}.grafana.net/api/convert/prometheus/config/v1/rules/:NamespaceTitle", "headers": [ { "name": "x-grafana-alerting-datasource-uid", "value": "" }, { "name": "x-grafana-alerting-recording-rules-paused", "value": "" }, { "name": "x-grafana-alerting-alert-rules-paused", "value": "" }, { "name": "x-grafana-alerting-target-datasource-uid", "value": "" }, { "name": "x-grafana-alerting-folder-uid", "value": "" }, { "name": "x-grafana-alerting-notification-settings", "value": "" } ], "params": [ { "name": "NamespaceTitle", "value": "", "type": "path" } ] }, "docs": "This API operation converts Prometheus rule group configurations to Grafana's native format by accepting a POST request to the endpoint /convert/prometheus/config/v1/rules/{NamespaceTitle}, where {NamespaceTitle} represents the target namespace for the rule group. It takes Prometheus-formatted alerting and recording rules as input and transforms them into Grafana-compatible rule configurations, facilitating migration or integration between Prometheus and Grafana alerting systems. The operation a" }, { "info": { "name": "Grafana Route Convert Prometheus Get Rule Group", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.grafana.net/api/convert/prometheus/config/v1/rules/:NamespaceTitle/:Group", "params": [ { "name": "NamespaceTitle", "value": "", "type": "path" }, { "name": "Group", "value": "", "type": "path" } ] }, "docs": "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" }, { "info": { "name": "Grafana Route Convert Prometheus Delete Rule Group", "type": "http" }, "http": { "method": "DELETE", "url": "https://{instance}.grafana.net/api/convert/prometheus/config/v1/rules/:NamespaceTitle/:Group", "params": [ { "name": "NamespaceTitle", "value": "", "type": "path" }, { "name": "Group", "value": "", "type": "path" } ] }, "docs": "This API operation is used to delete a Prometheus rule group from a specific namespace in Grafana's configuration. It targets a particular rule group identified by both the namespace title and group name through the URL path parameters. When invoked with a DELETE HTTP method, it removes the specified rule group configuration from the Prometheus-compatible alerting and recording rules system within Grafana, effectively cleaning up rules that are no longer needed or are being replaced." }, { "info": { "name": "Grafana Get Mapped Groups", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.grafana.net/api/groupsync/groups" }, "docs": "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 cont" }, { "info": { "name": "Grafana Create Group Mappings", "type": "http" }, "http": { "method": "POST", "url": "https://{instance}.grafana.net/api/groupsync/groups/:group_id", "params": [ { "name": "group_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This API operation creates group mappings for a specific group in Grafana's group synchronization system. It uses a POST request to the endpoint /groupsync/groups/{group_id}, where {group_id} is a path parameter identifying the target group for which mappings should be created. The operation establishes connections between external authentication provider groups (such as LDAP, OAuth, or SAML groups) and Grafana's internal groups, enabling automated user group assignment based on their external g" }, { "info": { "name": "Grafana Update Group Mappings", "type": "http" }, "http": { "method": "PUT", "url": "https://{instance}.grafana.net/api/groupsync/groups/:group_id", "params": [ { "name": "group_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This API operation updates the group mappings for a specific group in Grafana's group synchronization system. By sending a PUT request to the endpoint with a particular group ID, administrators can modify how external authentication groups (such as those from LDAP, OAuth, or SAML providers) are mapped to internal Grafana groups. This allows for dynamic management of user permissions and access control by adjusting which external groups correspond to specific Grafana organizational roles and team" }, { "info": { "name": "Grafana Delete Group Mappings", "type": "http" }, "http": { "method": "DELETE", "url": "https://{instance}.grafana.net/api/groupsync/groups/:group_id", "params": [ { "name": "group_id", "value": "", "type": "path" } ] }, "docs": "This API operation removes group mappings associated with a specific group in Grafana's group synchronization system. By sending a DELETE request to the endpoint with a particular group ID, administrators can eliminate the synchronization configuration that links external identity provider groups to Grafana teams or roles. This is useful when cleaning up deprecated mappings, removing access controls, or reconfiguring how external groups are mapped within Grafana's authorization structure." }, { "info": { "name": "Grafana Get Group Roles", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.grafana.net/api/groupsync/groups/:group_id/roles", "params": [ { "name": "group_id", "value": "", "type": "path" } ] }, "docs": "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." }, { "info": { "name": "Grafana Get Team Groups Api", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.grafana.net/api/teams/:teamId/groups", "params": [ { "name": "teamId", "value": "", "type": "path" } ] }, "docs": "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" }, { "info": { "name": "Grafana Add Team Group Api", "type": "http" }, "http": { "method": "POST", "url": "https://{instance}.grafana.net/api/teams/:teamId/groups", "params": [ { "name": "teamId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "The Add Team Group API is a POST operation available at the endpoint /teams/{teamId}/groups in Grafana that allows administrators to associate an external authentication group with a specific Grafana team. This operation requires the teamId parameter in the URL path to identify the target team, and typically accepts a request body containing details about the group to be added, such as the group identifier from the external authentication provider (like LDAP, OAuth, or SAML). When executed succe" }, { "info": { "name": "Grafana Remove Team Group Api Query", "type": "http" }, "http": { "method": "DELETE", "url": "https://{instance}.grafana.net/api/teams/:teamId/groups", "params": [ { "name": "groupId", "value": "", "type": "query" }, { "name": "teamId", "value": "", "type": "path" } ] }, "docs": "This API operation removes an external group mapping from a specified team in Grafana. When executed, it performs a DELETE request to the endpoint /teams/{teamId}/groups, where {teamId} represents the unique identifier of the team from which the group association should be removed. The operation is used to disconnect external authentication provider groups (such as LDAP, OAuth, or SAML groups) from Grafana teams, effectively revoking the automatic team membership that was granted to users belong" }, { "info": { "name": "Grafana Search Team Groups", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.grafana.net/api/teams/:teamId/groups/search", "params": [ { "name": "teamId", "value": "", "type": "path" }, { "name": "page", "value": "", "type": "query" }, { "name": "perpage", "value": "", "type": "query", "description": "Number of items per page" }, { "name": "query", "value": "", "type": "query", "description": "If set it will return results where the query value is contained in the name field. Query values with spaces need to be URL encoded." }, { "name": "name", "value": "", "type": "query", "description": "Filter by exact name match" } ] }, "docs": "This API operation performs a search for groups associated with a specific team in Grafana by making a GET request to the endpoint /teams/{teamId}/groups/search, where {teamId} is the unique identifier of the team whose groups you want to search. It allows administrators and authorized users to query and retrieve a list of groups that are linked to a particular team, which is useful for managing team memberships, permissions, and organizational structures within Grafana. The search functionality" }, { "info": { "name": "Grafana Route Get Alert Rule Group", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.grafana.net/api/v1/provisioning/folder/:FolderUID/rule-groups/:Group", "params": [ { "name": "FolderUID", "value": "", "type": "path" }, { "name": "Group", "value": "", "type": "path" } ] }, "docs": "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 qu" }, { "info": { "name": "Grafana Route Put Alert Rule Group", "type": "http" }, "http": { "method": "PUT", "url": "https://{instance}.grafana.net/api/v1/provisioning/folder/:FolderUID/rule-groups/:Group", "headers": [ { "name": "X-Disable-Provenance", "value": "" } ], "params": [ { "name": "FolderUID", "value": "", "type": "path" }, { "name": "Group", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an existing alert rule group identified by the folder UID and group name in Grafana's provisioning API. This PUT operation allows you to modify the configuration of alert rules within a specific rule group, including updating rule definitions, thresholds, evaluation intervals, and notification settings. The endpoint requires both the FolderUID parameter to identify the containing folder and the Group parameter to specify which alert rule group to update, with the updated configuration pr" }, { "info": { "name": "Grafana Route Delete Alert Rule Group", "type": "http" }, "http": { "method": "DELETE", "url": "https://{instance}.grafana.net/api/v1/provisioning/folder/:FolderUID/rule-groups/:Group", "params": [ { "name": "FolderUID", "value": "", "type": "path" }, { "name": "Group", "value": "", "type": "path" } ] }, "docs": "Deletes a specific alert rule group within a designated folder in Grafana's provisioning API. This operation requires both the folder's unique identifier (FolderUID) and the name of the alert rule group (Group) to be specified in the URL path. When executed, it removes the entire rule group and all alert rules contained within it from the Grafana instance. This is a destructive operation typically used when cleaning up monitoring configurations or reorganizing alert structures, and it requires a" }, { "info": { "name": "Grafana Route Get Alert Rule Group Export", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.grafana.net/api/v1/provisioning/folder/:FolderUID/rule-groups/:Group/export", "params": [ { "name": "download", "value": "", "type": "query", "description": "Whether to initiate a download of the file or not." }, { "name": "format", "value": "", "type": "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." }, { "name": "FolderUID", "value": "", "type": "path" }, { "name": "Group", "value": "", "type": "path" } ] }, "docs": "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 ope" } ] } ], "bundled": true }