{ "opencollection": "1.0.0", "info": { "name": "Grafana HTTP Access Create API", "version": "11.0.0" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Create", "type": "folder" }, "items": [ { "info": { "name": "Grafana Create Correlation", "type": "http" }, "http": { "method": "POST", "url": "https://{instance}.grafana.net/api/datasources/uid/:sourceUID/correlations", "params": [ { "name": "sourceUID", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new correlation in Grafana between two data sources, allowing users to establish relationships and navigate between different data sources using the specified source data source UID. This operation enables the creation of links that help connect related data across different monitoring or logging systems, facilitating easier investigation and analysis workflows by defining how data in one source relates to data in another source through correlation configurations." }, { "info": { "name": "Grafana Create Folder", "type": "http" }, "http": { "method": "POST", "url": "https://{instance}.grafana.net/api/folders", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new folder in Grafana's organizational structure, allowing users to group and organize dashboards and other resources hierarchically. This POST endpoint accepts parameters such as the folder title, a unique identifier (UID), and optional metadata to define the new folder's properties. The operation requires appropriate permissions and returns the newly created folder object with its assigned ID and other attributes upon successful execution. Folders created through this endpoint can th" }, { "info": { "name": "Grafana Create Library Element", "type": "http" }, "http": { "method": "POST", "url": "https://{instance}.grafana.net/api/library-elements", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new library element in Grafana, which is a reusable component such as a panel or variable that can be shared across multiple dashboards. This endpoint accepts a POST request with the library element configuration in the request body, including properties like name, model, kind (panel or variable), and folder ID where the element should be stored. Upon successful creation, it returns the newly created library element object with its unique identifier, allowing users to reference and reu" }, { "info": { "name": "Grafana Create Query", "type": "http" }, "http": { "method": "POST", "url": "https://{instance}.grafana.net/api/query-history", "body": { "type": "json", "data": "{}" } }, "docs": "This API operation allows users to create a new entry in Grafana's query history by sending a POST request to the /query-history endpoint. It enables users to save queries they've executed for future reference, tracking, or reuse purposes. The operation typically accepts query details such as the datasource, query text, timestamp, and potentially additional metadata like comments or tags. This functionality is particularly useful for maintaining an audit trail of queries, sharing queries among t" }, { "info": { "name": "Grafana Create Org", "type": "http" }, "http": { "method": "POST", "url": "https://{instance}.grafana.net/api/orgs", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new organization in Grafana with the specified name and optional metadata. This operation requires administrative privileges and returns the newly created organization's ID and details upon successful creation. The request body must include at minimum the organization name, and the API will generate a unique identifier for the new organization that can be used in subsequent API calls for managing users, dashboards, and data sources within that organizational context." }, { "info": { "name": "Grafana Create Team", "type": "http" }, "http": { "method": "POST", "url": "https://{instance}.grafana.net/api/teams", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new team in Grafana with the specified configuration including team name and optional settings such as email and organizational unit identifier. This endpoint requires authentication and appropriate permissions to create teams within the Grafana instance. The request accepts a JSON payload containing team details and returns the newly created team object including its assigned unique identifier upon successful creation. Team creation is essential for organizing users into groups for ma" }, { "info": { "name": "Grafana Create Role", "type": "http" }, "http": { "method": "POST", "url": "https://{instance}.grafana.net/api/access-control/roles", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new custom role in Grafana's role-based access control (RBAC) system. This endpoint allows administrators to define granular permissions by creating roles with specific sets of permissions that can be assigned to users, teams, or service accounts. The request requires specifying the role name, display name, description, and optionally a set of permissions that define what actions the role can perform within Grafana. Custom roles enable organizations to implement fine-grained access con" }, { "info": { "name": "Grafana Create Report", "type": "http" }, "http": { "method": "POST", "url": "https://{instance}.grafana.net/api/reports", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new dashboard report in Grafana that can be automatically generated and distributed on a scheduled basis. This operation allows you to configure report parameters including the target dashboard, time range, layout options, orientation, and recipients who will receive the report via email. The report can be set to recur daily, weekly, or monthly, and supports various output formats such as PDF or image. You can customize branding elements, include specific dashboard panels, and define v" }, { "info": { "name": "Grafana Create Service Account", "type": "http" }, "http": { "method": "POST", "url": "https://{instance}.grafana.net/api/serviceaccounts", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new service account in Grafana, which is a special type of user designed for automated tasks and API interactions rather than human login. Service accounts can be assigned specific permissions and roles to programmatically access Grafana resources, making them ideal for integrations, CI/CD pipelines, monitoring scripts, and other automated workflows. The request requires authentication and appropriate administrative permissions, and upon successful creation, returns details about the n" }, { "info": { "name": "Grafana Create Token", "type": "http" }, "http": { "method": "POST", "url": "https://{instance}.grafana.net/api/serviceaccounts/:serviceAccountId/tokens", "params": [ { "name": "serviceAccountId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new API token for a specified service account in Grafana by sending a POST request to the endpoint with the service account ID as a path parameter. This operation generates authentication tokens that allow service accounts to interact with Grafana's API programmatically, enabling automated workflows, integrations, and machine-to-machine communication. The request typically requires specifying token properties such as name, role, and optionally an expiration date, and returns the newly " }, { "info": { "name": "Grafana Admin Create User", "type": "http" }, "http": { "method": "POST", "url": "https://{instance}.grafana.net/api/admin/users", "body": { "type": "json", "data": "{}" } }, "docs": "This API operation allows administrators to create new users in Grafana through a POST request to the /admin/users endpoint. It is an administrative function that requires elevated privileges and enables the programmatic addition of user accounts to the Grafana system. When invoked, the operation accepts user details such as username, email, password, and other relevant attributes in the request body, then creates a new user account with the specified credentials and settings. This endpoint is p" }, { "info": { "name": "Grafana Create Session", "type": "http" }, "http": { "method": "POST", "url": "https://{instance}.grafana.net/api/cloudmigration/migration", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new cloud migration session in Grafana that initializes the process for migrating a Grafana instance or its resources to Grafana Cloud. This operation sets up the necessary session context and parameters required to begin transferring dashboards, data sources, folders, and other configuration elements from a self-hosted or existing Grafana installation to a cloud-based environment, returning a session identifier that can be used to track and manage the migration progress throughout its" }, { "info": { "name": "Grafana Create Snapshot", "type": "http" }, "http": { "method": "POST", "url": "https://{instance}.grafana.net/api/cloudmigration/migration/:uid/snapshot", "params": [ { "name": "uid", "value": "", "type": "path", "description": "UID of a session" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a snapshot of the current Grafana instance configuration and data for a specified cloud migration session identified by its unique identifier (uid). This operation captures the state of dashboards, data sources, users, organizations, and other Grafana resources at a point in time, preparing them for migration to a cloud-hosted Grafana instance. The snapshot serves as a migration package that can be uploaded and restored in the target cloud environment, enabling seamless transfer of Grafa" }, { "info": { "name": "Grafana Create Cloud Migration Token", "type": "http" }, "http": { "method": "POST", "url": "https://{instance}.grafana.net/api/cloudmigration/token" }, "docs": "Creates a new cloud migration token in Grafana that enables secure data transfer and authentication between a self-hosted Grafana instance and Grafana Cloud during migration operations. This endpoint generates a temporary authentication token that authorizes the migration service to access and migrate dashboards, data sources, alerts, and other Grafana resources from the source instance to the cloud destination. The token serves as a security credential to establish a trusted connection and shou" }, { "info": { "name": "Grafana Create Public Dashboard", "type": "http" }, "http": { "method": "POST", "url": "https://{instance}.grafana.net/api/dashboards/uid/:dashboardUid/public-dashboards", "params": [ { "name": "dashboardUid", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a public dashboard that enables external users to view a specific Grafana dashboard without authentication. This operation takes a dashboard UID as a path parameter and accepts configuration options in the request body to control how the dashboard is shared publicly, including settings for time range, template variables, and access permissions. Once created, it generates a unique public URL that can be shared with anyone to view the dashboard's visualizations and data without requiring G" }, { "info": { "name": "Grafana Create Dashboard Snapshot", "type": "http" }, "http": { "method": "POST", "url": "https://{instance}.grafana.net/api/snapshots", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new dashboard snapshot in Grafana, allowing users to capture and share the current state of a dashboard at a specific point in time. This operation accepts a POST request containing the dashboard data, metadata, and optional configuration parameters such as expiration time and external sharing settings. The snapshot preserves all panel configurations, queries, and visualizations as they appear at the moment of creation, generating a unique URL that can be shared with others without req" }, { "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 Create Playlist", "type": "http" }, "http": { "method": "POST", "url": "https://{instance}.grafana.net/api/playlists", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new playlist in Grafana by submitting playlist configuration data through a POST request to the /playlists endpoint. This operation allows users to define a playlist containing a collection of dashboards that can be displayed in sequence, specifying properties such as the playlist name, the interval between dashboard transitions, and the list of dashboard items to include. The request requires appropriate authentication and permissions, and upon successful creation, returns the newly c" }, { "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 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 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" } ] } ], "bundled": true }