Sign in

v12

latestOpenAPI 3.1.0AGPL-3.0raw.githubusercontent.com2026-05-286377631.6 MB
/api/ee/custom-viz-plugin

POST /api/ee/custom-viz-plugin

Register a new custom visualization plugin from an uploaded tar.gz bundle.

The archive must contain metabase-plugin.json at the root and dist/index.js for the JS bundle, plus any whitelisted assets under dist/assets/. The plugin's identifier is taken from the manifest's name field.

post/api/ee/custom-viz-plugin

Response

Successful response

bundle_hashstring nullable
{"stackTrail":"paths:/api/ee/custom-viz-plugin:post:responses:2XX:content:application/json:schema:properties:created_at","oasType":"schema","type":"unknown"}
dev_bundle_urlstring nullable
dev_onlyboolean required
display_namestring required
enabledboolean required
error_messagestring nullable
iconstring nullable
idinteger required

value must be an integer greater than zero.

identifierstring required
{"stackTrail":"paths:/api/ee/custom-viz-plugin:post:responses:2XX:content:application/json:schema:properties:manifest:oneOf","oasType":"schema","type":"unknown","nullable":true}
metabase_versionstring nullable
status'active' | 'error' required
{"stackTrail":"paths:/api/ee/custom-viz-plugin:post:responses:2XX:content:application/json:schema:properties:updated_at","oasType":"schema","type":"unknown"}