GRgrafana
enterprise

POST /datasources/{dataSourceUID}/cache

set cache config for a single data source

Request

  • Base URL
    /api (relative, and the document’s source URL is not known)
  • URL
    /api/datasources/{dataSourceUID}/cache
  • Auth
    • HTTP basic
    • or API key in header Authorization

Path parameters

dataSourceUIDstring required

Query parameters

dataSourceTypestring

Request body

dataSourceIDinteger
dataSourceUIDstring
enabledboolean
ttlQueriesMsinteger

TTL MS, or "time to live", is how long a cached item will stay in the cache before it is removed (in milliseconds)

ttlResourcesMsinteger
useDefaultTTLboolean

If UseDefaultTTL is enabled, then the TTLQueriesMS and TTLResourcesMS in this object is always sent as the default TTL located in grafana.ini

Response

CacheConfigResponse

createdstring date-time
dataSourceIDinteger

Fields that can be set by the API caller - read/write

dataSourceUIDstring
defaultTTLMsinteger

These are returned by the HTTP API, but are managed internally - read-only Note: 'created' and 'updated' are special properties managed automatically by xorm, but we are setting them manually

enabledboolean
messagestring
ttlQueriesMsinteger

TTL MS, or "time to live", is how long a cached item will stay in the cache before it is removed (in milliseconds)

ttlResourcesMsinteger
updatedstring date-time
useDefaultTTLboolean

If UseDefaultTTL is enabled, then the TTLQueriesMS and TTLResourcesMS in this object is always sent as the default TTL located in grafana.ini

Changes

No recorded changes to this operation across all 1 revision of this API.