plugin.json

dependencies

Dependencies needed by the plugin.

Property	Type	Required	Description
`grafanaDependency`	string	Yes	Required Grafana version for this plugin. Validated using .
`grafanaVersion`	string	No	(Deprecated) Required Grafana version for this plugin, e.g. to denote plugin requires Grafana v6.x.x or v7.x.x.
`plugins`	object[]	No	An array of required plugins on which this plugin depends.

Plugin dependency. Used to display information about plugin dependencies in the Grafana UI.

Property	Type	Required	Description
`id`	string	Yes
`name`	string	Yes
`type`	string	Yes	Possible values are: `app`, `datasource`, `panel`.
`version`	string	Yes

Property	Type	Required	Description
`addToNav`	boolean	No	Add the include to the side menu.
`component`	string	No	(Legacy) The Angular component to use for a page.
`defaultNav`	boolean	No	Page or dashboard when user clicks the icon in the side menu.
`icon`	string	No	Icon to use in the side menu. For information on available icon, refer to .
`name`	string	No
`path`	string	No	Used for app plugins.
`role`	string	No	Possible values are: `Admin`, `Editor`, `Viewer`.
`type`	string	No	Possible values are: `dashboard`, `page`, `panel`, `datasource`.

Metadata for the plugin. Some fields are used on the plugins page in Grafana and others on grafana.com if the plugin is published.

Property	Type	Required	Description
`keywords`	string[]	Yes	Array of plugin keywords. Used for search on grafana.com.
`logos`	object	Yes	SVG images that are used as plugin icons.
`updated`	string	Yes	Date when this plugin was built.
`version`	string	Yes	Project version of this commit, e.g. `6.7.x`.
`author`		No	Information about the plugin author.
`build`	object	No	Build information
`description`	string	No	Description of plugin. Used on the plugins page in Grafana and for search on grafana.com.
`links`	[]	No	An array of link objects to be displayed on this plugin’s project page in the form `{name: ‘foo’, url: ‘http://example.com'}`
`screenshots`	[]	No	An array of screenshot objects in the form `{name: ‘bar’, path: ‘img/screenshot.png’}`

Build information

Property	Type	Required	Description
`branch`	string	No	Git branch the plugin was built from.
	string	No	Git hash of the commit the plugin was built from
`number`	number	No
`pr`	number	No	GitHub pull request the plugin was built from
`repo`	string	No
`time`	number	No	Time when the plugin was built, as a Unix timestamp.

Property	Type	Required	Description
`name`	string	No
`url`	string	No

SVG images that are used as plugin icons.

Property	Type	Required	Description
`large`	string	Yes	Link to the “large” version of the plugin logo, which must be an SVG image. “Large” and “small” logos can be the same image.
`small`	string	Yes	Link to the “small” version of the plugin logo, which must be an SVG image. “Large” and “small” logos can be the same image.

Property	Type	Required	Description
`name`	string	No
`path`	string	No

For data source plugins. There is a query options section in the plugin’s query editor and these options can be turned on if needed.

Property	Type	Required	Description
`body`	object	No	For data source plugins. Route headers set the body content and length to the proxied request.
`headers`	array	No	For data source plugins. Route headers adds HTTP headers to the proxied request.
`jwtTokenAuth`		No	For data source plugins. Token authentication section used with an JWT OAuth API.
`method`	string	No	For data source plugins. Route method matches the HTTP verb like GET or POST.
`path`	string	No	For data source plugins. The route path that is replaced by the route URL field when proxying the call.
`reqRole`	string	No
`reqSignedIn`	boolean	No
`tokenAuth`	object	No	For data source plugins. Token authentication section used with an OAuth API.
`url`	string	No	For data source plugins. Route URL is where the request is proxied to.

For data source plugins. Route headers set the body content and length to the proxied request.

Property	Type	Required	Description

For data source plugins. Token authentication section used with an JWT OAuth API.

Property	Type	Required	Description
`params`	object	No	Parameters for the JWT token authentication request.
`scopes`	string	No
`url`	string	No	URL to fetch the JWT token.

Parameters for the JWT token authentication request.

Property	Type	Required
`client_email`	string	No
`private_key`	string	No
`scopes`	string[]	No
`token_uri`	string	No

Parameters for the token authentication request.

Property	Type	Required	Description
`client_id`	string	No	OAuth client ID
`client_secret`	string	No	OAuth client secret. Usually populated by decrypting the secret from the SecureJson blob.
`grant_type`	string	No	OAuth grant type
`resource`	string	No	OAuth resource