MEmetabase
/api/ee/custom-viz-plugin

POST /api/ee/custom-viz-plugin

Changed on

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. The only static asset served from the bundle is the manifest icon (under dist/assets/); plugins do not ship arbitrary assets. The plugin's identifier is taken from the manifest's name field.

post/api/ee/custom-viz-plugin

Request

  • Base URL
    (relative, and the document was published on a file host, not at the API’s origin)
  • Auth
    API key in header X-API-Key

Request body multipart/form-data

Response

Successful response

bundle_hashstring nullable
created_atunknown required
dev_bundle_urlstring nullable
dev_onlyboolean required
display_namestring required

value must be a non-blank string.

enabledboolean required
error_messagestring nullable
iconstring nullable
idinteger required

value must be an integer greater than zero.

identifierstring required

value must be a non-blank string.

manifestunknown
metabase_versionstring nullable
status'active' | 'error' required
updated_atunknown required

Changes

  • 2e178f5a7934Revision changes
    • breaking

      added the new required request property /

    • info

      the / request property type was generalized from no type to string, and format from no format to binary

    • info

      added subschema #1 subschema #2 to the response property anyOf list for the response status

    • info

      added subschema #1 subschema #2 to the response property anyOf list for the response status

    • info

      added subschema #1 subschema #2 to the response property anyOf list for the response status

    • info

      added subschema #1 subschema #2 to the response property anyOf list for the response status

    • info

      added subschema #1 subschema #2 to the response property anyOf list for the response status

    • info

      removed subschema #1 subschema #2 from the response property oneOf list for the response status

    • info

      removed subschema #1 subschema #2 from the response property oneOf list for the response status

    • info

      removed subschema #1 subschema #2 from the response property oneOf list for the response status

    • info

      removed subschema #1 subschema #2 from the response property oneOf list for the response status

    • info

      removed subschema #1 subschema #2 from the response property oneOf list for the response status

    • info

      removed subschema #1 subschema #2 from the response property oneOf list for the response status

    • info

      added the required property to the response with the status

  • b1dc4ea67567Revision changes
    • info

      endpoint added