/api/ee/custom-viz-plugin

POST /api/ee/custom-viz-plugin/dev

Changed on

Register a dev-only custom visualization plugin from a local dev server. No bundle upload is required — files are served from the dev server URL. Requires custom viz plugin dev mode to be enabled.

post/api/ee/custom-viz-plugin/dev

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

dev_bundle_urlstring required

value must be a non-blank string.

identifierstring nullable

value must be a non-blank string.

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

    • breaking

      removed subschema #1 subschema #2 from the request property oneOf list

    • info

      added subschema #1 subschema #2 to the request property anyOf list

    • 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

    • info

      endpoint added