/api/ee/custom-viz-plugin

PUT /api/ee/custom-viz-plugin/{id}/bundle

Changed on

Replace the bundle for an existing plugin. Accepts a multipart tar.gz upload in the same format as the POST / endpoint. The manifest's name field must match the plugin's existing identifier.

put/api/ee/custom-viz-plugin/{id}/bundle

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

Path parameters

idinteger required

value must be an integer greater than zero.

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

    • 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

    • info

      endpoint added