1. Docs
  2. Overview
  3. Observability
  4. Data management
  5. Data import and export
  6. Observability Platform API

Last modified July 13, 2026

Observability Platform API reference

This page documents the interface of the Giant Swarm Observability Platform API. It covers the import and export endpoints, the authentication headers, the tenant values you can target, and the settings common OIDC providers need. For task-oriented steps, see import data and export data.

Availability

The API must be enabled for your installation before use. Contact your Account Engineer to configure the authentication endpoints. It’s reached through a shared host based on your installation’s base domain: https://observability.<domain_name>.

Authentication

Every request, in either direction, requires two things:

RequirementHow to provide it
IdentityA valid OIDC token in the Authorization: Bearer <token> header
Tenant scopeAn X-Scope-OrgID header naming an existing tenant

Your identity must have access to the specified tenant, and the tenant must exist in a Grafana Organization. Requests that target a tenant which doesn’t exist are rejected.

Import endpoints

The platform accepts data through these standard observability APIs:

SignalProtocolEndpoint
MetricsPrometheus remote writehttps://observability.<domain>/prometheus/api/v1/push
LogsLoki push APIhttps://observability.<domain>/loki/api/v1/push
TracesOTLP HTTPhttps://observability.<domain>/tempo (when tracing is enabled)

Export endpoints

The platform exposes these query APIs, each compatible with the upstream project’s API:

SignalCompatible withBase endpoint
LogsLoki query APIhttps://observability.<domain>
MetricsPrometheus query APIhttps://observability.<domain>/prometheus
TracesTempo query APIhttps://observability.<domain>/tempo (when tracing is enabled)

Supported data types

The platform supports importing and exporting all three observability signals:

SignalAvailabilityExamples
Logs and eventsImport and exportApplication logs, Kubernetes events, audit logs, external service logs
TracesImport and export (when tracing is enabled)Distributed traces, application spans, external service traces, platform traces
MetricsImport and exportInfrastructure metrics, application metrics, platform metrics, external system metrics

Tenant values

Choose the tenant value based on the data you want to reach:

Data typeTenant valueDescription
Platform logsgiantswarmSystem and infrastructure logs
Platform metricsgiantswarmSystem and infrastructure metrics
Platform tracesgiantswarmSystem and infrastructure traces
Custom logsYour tenantLogs from your applications
Custom metricsYour tenantMetrics from your applications
Custom tracesYour tenantTraces from your applications

OIDC provider examples

When you configure a client (for example Grafana Alloy), set the token_url and scopes to match your OIDC provider:

Providertoken_urlscopes
Azure ADhttps://login.microsoftonline.com/<tenant>/oauth2/v2.0/token["<client_id>/.default", "openid", "email", "profile"]
Googlehttps://oauth2.googleapis.com/token["openid", "email", "profile"]
Oktahttps://<domain>.okta.com/oauth2/default/v1/token["openid", "email", "profile"]
Keycloakhttps://<keycloak-domain>/realms/<realm>/protocol/openid-connect/token["openid", "email", "profile"]

The client_id and client_secret are provided by your Account Engineer.

See also