Skip to main content
Every grafana.api.* operation is listed below with parameter shapes and return types from the plugin Zod schemas.
New to Corsair? See API access, authentication, and error handling.

​
Dashboards

​
queryPublic

dashboards.queryPublic Query a panel on a public Grafana dashboard Risk: read 
await corsair.grafana.api.dashboards.queryPublic({});
Input
NameTypeRequiredDescription
access_tokenstringYes—
panel_idnumberYes—
fromstringYes—
tostringYes—
intervalMsnumberNo—
maxDataPointsnumberNo—
base_url_overridestringNo—
Output
NameTypeRequiredDescription
dataobjectYes—
errorstringNo—
successfulbooleanYes—
{
  status_code: number,
  message?: string,
  results?: {
  }
}

​
Health

​
get

health.get Check Grafana server health and database connectivity Risk: read 
await corsair.grafana.api.health.get({});
Input: empty object Output
NameTypeRequiredDescription
dataobjectYes—
errorstringNo—
successfulbooleanYes—
{
  version?: string,
  commit?: string,
  database?: string,
  enterpriseCommit?: string
}

​
Jwks

​
retrieve

jwks.retrieve Retrieve JWKS public keys for token verification Risk: read 
await corsair.grafana.api.jwks.retrieve({});
Input: empty object Output
NameTypeRequiredDescription
dataobjectYes—
errorstringNo—
successfulbooleanYes—
{
  keys?: {
    Key?: any,
    Use?: string,
    KeyID?: string,
    Algorithm?: string,
    Certificates?: string[],
    CertificatesURL?: string,
    CertificateThumbprintSHA1?: number[],
    CertificateThumbprintSHA256?: number[]
  }[]
}

​
Logs

​
createOtlp

logs.createOtlp Send OTLP v1 logs to Grafana Loki for ingestion Risk: write 
await corsair.grafana.api.logs.createOtlp({});
Input
NameTypeRequiredDescription
resourceLogsobject[]Yes—
{
  resource?: {
    attributes?: {
      key?: string,
      value?: {
        stringValue?: string,
        intValue?: number,
        boolValue?: boolean,
        doubleValue?: number,
        bytesValue?: string,
        arrayValue?: {
          values?: any[]
        },
        kvlistValue?: {
          values?: any[]
        }
      }
    }[],
    droppedAttributesCount?: number
  },
  scopeLogs?: {
    scope?: {
      name?: string,
      version?: string,
      attributes?: {
        key?: string,
        value?: {
          stringValue?: string,
          intValue?: number,
          boolValue?: boolean,
          doubleValue?: number,
          bytesValue?: string,
          arrayValue?: {
            values?: any[]
          },
          kvlistValue?: {
            values?: any[]
          }
        }
      }[]
    },
    logRecords?: {
      timeUnixNano?: string,
      severityNumber?: number,
      severityText?: string,
      body?: {
        stringValue?: string,
        intValue?: number,
        boolValue?: boolean,
        doubleValue?: number,
        bytesValue?: string,
        arrayValue?: {
          values?: any[]
        },
        kvlistValue?: {
          values?: any[]
        }
      },
      attributes?: {
        key?: string,
        value?: {
          stringValue?: string,
          intValue?: number,
          boolValue?: boolean,
          doubleValue?: number,
          bytesValue?: string,
          arrayValue?: {
            values?: any[]
          },
          kvlistValue?: {
            values?: any[]
          }
        }
      }[],
      flags?: number,
      traceId?: string,
      spanId?: string,
      droppedAttributesCount?: number
    }[]
  }[]
}[]
Output
NameTypeRequiredDescription
dataobjectYes—
errorstringNo—
successfulbooleanYes—
{
  success: boolean,
  status_code: number,
  message: string
}

​
Ring

​
getDistributorHaTracker

ring.getDistributorHaTracker Get distributor HA tracker ring status Risk: read 
await corsair.grafana.api.ring.getDistributorHaTracker({});
Input: empty object Output
NameTypeRequiredDescription
dataobjectYes—
errorstringNo—
successfulbooleanYes—
{
  html_content: string,
  status_code: number
}

​
getIndexGateway

ring.getIndexGateway Get index gateway hash ring status Risk: read 
await corsair.grafana.api.ring.getIndexGateway({});
Input: empty object Output
NameTypeRequiredDescription
dataobjectYes—
errorstringNo—
successfulbooleanYes—
{
  content: string,
  content_type: string
}

​
getOverridesExporter

ring.getOverridesExporter Get overrides-exporter hash ring status Risk: read 
await corsair.grafana.api.ring.getOverridesExporter({});
Input: empty object Output
NameTypeRequiredDescription
dataobjectYes—
errorstringNo—
successfulbooleanYes—
{
  html_content: string
}

​
getRuler

ring.getRuler Get ruler ring status from Grafana Mimir Risk: read 
await corsair.grafana.api.ring.getRuler({});
Input: empty object Output
NameTypeRequiredDescription
dataobjectYes—
errorstringNo—
successfulbooleanYes—
{
  content: string,
  content_type: string
}

​
Saml

​
postAcs

saml.postAcs Process a SAML Assertion Consumer Service authentication response Risk: write 
await corsair.grafana.api.saml.postAcs({});
Input
NameTypeRequiredDescription
saml_responsestringYes—
relay_statestringNo—
Output
NameTypeRequiredDescription
dataobjectYes—
errorstringNo—
successfulbooleanYes—
{
  status_code: number,
  message: string,
  location?: string
}

​
Status

​
get

status.get Check Grafana Enterprise license availability Risk: read 
await corsair.grafana.api.status.get({});
Input: empty object Output
NameTypeRequiredDescription
dataobjectYes—
errorstringNo—
successfulbooleanYes—
{
  license_available: boolean
}

​
Store Gateway

​
getTenants

storeGateway.getTenants List tenants with blocks in the store-gateway storage Risk: read 
await corsair.grafana.api.storeGateway.getTenants({});
Input: empty object Output
NameTypeRequiredDescription
dataobjectYes—
errorstringNo—
successfulbooleanYes—
{
  content: string,
  content_type?: string
}