Documentationbreadcrumb arrow Grafana Cloudbreadcrumb arrow Instrument and send databreadcrumb arrow Fleet Managementbreadcrumb arrow Referencebreadcrumb arrow Tenant HTTP API
Grafana Cloud

The Tenant HTTP API

The Grafana Fleet Management Tenant API allows you to retrieve information about your stack. Currently, calls to the API can tell you what limits, if any, apply to the collectors, pipelines, and API requests of your stack.

Find the base URL

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

  1. In your Grafana Cloud stack, click Connections > Collector > 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 the following URL, where <CLUSTER_NAME> is the production cluster of your stack:
https://fleet-management-<CLUSTER_NAME>.grafana.net/tenant.v1.TenantService/

Note

If you need to secure your API traffic, you can configure an AWS PrivateLink endpoint and use the private DNS name 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.

TenantService

TenantService is the service that provides information about the tenant.

Method NameRequest TypeResponse TypeDescription
GetLimitsGetLimitsRequestGetLimitsResponseReturns the limits applied to the stack

Endpoints

Note

Protobuf field names are defined in snake_case. Due to default protojson behavior, field names are converted to camelCase in responses. Both snake_case and camelCase field names are accepted in requests.

GetLimitsRequest

GetLimitsRequest is a request to retrieve the collector, pipeline, and requests per second (RPS) limits for a stack.

GetLimitsResponse

GetLimitsResponse is the response to a GetLimitsRequest. It contains all limits applied to the stack. If a limit field is omitted in the response, that limit does not apply to the stack. For example, if the response does not contain the collectors field, the stack does not have a limit on the number of collectors.

FieldTypeLabelDescription
collectorsintegerThe limit on the number of collectors for the tenant
pipelinesintegerThe limit on the number of configuration pipelines for the tenant
requests_per_secondRequestLimitsThe request limits for the tenant

RequestLimits

FieldTypeLabelDescription
collectorintegerThe limit on the number of requests per second for collectors
apiintegerThe limit on the number of requests per second for the API and UI

Examples

The following request retrieves limits for the authorized stack. The Basic Auth username and password are set as environment variables.

shell 
curl -s \
  -u "$GCLOUD_INSTANCE_ID:$GCLOUD_FM_API_TOKEN" \
  -H "Content-Type: application/json" \
  -X POST \
  -d '{}' \
  https://fleet-management-prod-001.grafana.net/tenant.v1.TenantService/GetLimits \
  | jq

This is the response showing all limits:

JSON 
{
  "pipelines": 200,
  "collectors": 2000,
  "requestsPerSecond": {
    "collector": 20,
    "api": 3
  }
}