Grafana Cloud

The Pipeline HTTP API

The Grafana Fleet Management Pipeline API allows you to perform CRUD operations on configuration pipelines.

For a full definition of the Pipeline API, refer to the .proto file.

Find the base URL

You can find the base URL for the Pipeline API in the Grafana Cloud Fleet Management interface.

  1. In your Grafana Cloud stack, click Connections > Fleet Management in the left-side menu.

  2. On the Fleet Management interface, switch to the API tab.

  3. Find the URL in the Base URL section. It looks like one of the following URLs, depending on the region where your Grafana Cloud stack is hosted.

    Flat format, where <CLUSTER_NAME> is the production cluster of your stack:

    https://fleet-management-<CLUSTER_NAME>.grafana.net/pipeline.v1.PipelineService/

    Nested format, where <CSP> is the cloud provider, <CSP_REGION> is the cloud provider’s region identifier, and <COUNTER> distinguishes multiple Grafana Cloud regions hosted in the same cloud provider region:

    https://fleet-management-<CLUSTER_NAME>.<CSP>-<CSP_REGION>-<COUNTER>.grafana.net/pipeline.v1.PipelineService/

    Caution

    Always copy the exact URL from your Fleet Management interface instead of constructing it by hand. For details on the URL differences, refer to Determine Grafana Cloud URLs based on region.

Secure connection

If you need to secure your API traffic, you can configure a private endpoint in place of the base URL. You can find the service name for endpoint configuration and the private DNS name on the same API tab where the base URL is found. For more information, refer to the instructions for your cloud provider:

Rate limit

You can make a request to the Fleet Management Tenant API to find out the requests-per-second limits applied to your stack.

Requests to the Pipeline API are included in the requests_per_second:api limit reported by the Tenant API and are limited to 3 requests per second by default.

PipelineService

The PipelineService defines the RPCs for managing pipelines.

Method NameRequest TypeResponse TypeDescription
GetPipelineGetPipelineRequestPipeline