Skip to main content
Monitoring & Collection/Grafana Integration

RegisterGrafanaDatasource

Register a new Grafana datasource linked to a tenant's Grafana organization

POST/api/v1/monitoring/grafana/datasources

Operation ID

RegisterGrafanaDatasource

Since

1.0.0

Execution Mode

Synchronous

Auth Context

Auth Required

Auth Context

Send these values as request headers when calling this API.

AuthorizationstringRequired

Bearer Token

X-Tenant-IDstring

X-Tenant-ID

Request Inputs

application/json

Body Fields

  • tenantId
    StringRequired

    UUID of the tenant registering the datasource

    Example: tenant-001-xyz

  • name
    StringRequired

    Display name for the new datasource

    Example: Production Prometheus

  • grafanaUrl
    StringRequired

    URL of the Grafana instance to register against

    Example: http://grafana.example.com

  • orgId
    IntegerRequired

    Grafana organization ID

    Example: 1

  • apiKey
    StringRequired

    API key for authenticating with Grafana

    Example: glsa_xxxxxxxxxxxx

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • id
    String

    Unique identifier of the Grafana datasource registration

    Example: ds-001-abc

  • name
    String

    Display name of the datasource

    Example: Production Prometheus

  • grafanaUrl
    String

    URL of the Grafana instance managing this datasource

    Example: http://grafana.example.com

  • orgId
    Integer

    Grafana organization ID this datasource belongs to

    Example: 1

  • apiKey
    String

    API key for authenticating with the Grafana instance

    Example: glsa_xxxxxxxxxxxx

  • tenantId
    String

    UUID of the tenant this datasource belongs to

    Example: tenant-001-xyz

  • createdAt
    String

    Created at

    Example: 2026-01-15T08:00:00Z