Update Plugin

Update Plugin

Performs partial update, if a field is specified in the request it will be updated

Will upload the code file and publish the plugin if code is sent, and subscribe to all requested notifications and interceptions to the endpoint.

Environment variables update rules:

  • The environmentVariables map is optional. Omitting it keeps every existing custom entry as-is.
  • When the map is provided, treat it as the full desired set: any key you do not include is removed (system-managed keys are added automatically). Sending {} clears all custom environment variables.

Subscriptions update rules:

  • Omit subscriptions (or set to null) to leave all subscriptions unchanged. An empty object ({}) also makes no changes.
  • When subscriptions is provided:
    • subscriptions.interceptions:
      • Omit to keep existing
      • [] removes all
      • A list replaces existing (unmentioned items removed)
    • subscriptions.notifications:
      • Omit to keep existing
      • [] removes all
      • A list replaces existing (unmentioned items removed)

CORS update rules:

  • The cors object is optional. Omitting it keeps the existing browser access configuration.
  • Each list inside cors (allowOrigins, allowMethods, allowHeaders, exposeHeaders) is a full replacement list: omit the list to keep its current value, send [] to remove all entries, or provide a populated list to replace the existing one.

These semantics apply to every array/list field in this API: omit the field to leave it untouched; send [] (or {}) to clear its entries; provide values to fully replace the collection. If runtime is changed to a different language and a seed is already deployed, a seed of the new language will be used. If runtime is changed to a different language and custom code is already deployed, the code will not change. The imageTag field is relevant only for deploymentPackageType = IMAGE. Specify the tag you used when you uploaded the image using the docker push command. After being attach to the plugin, the image will be managed by the server. The imageTag has no meanings after a successful call and will not be returned as part of the response, the imageTag is only a way to provide the plugin code when the deploymentPackageType is IMAGE (instead of using the code parameter). If this API fails, it will roll back the changes it made. This is a "multipart/form-data" request that includes both the binary zip file and configuration information. The form should include 2 parameters:

  1. "code": Non-mandatory binary zip file.
  2. "config": Mandatory JSON configuration of the plugin.

For more detailed information regarding the plugins, please visit the following page: https://docs.biot-med.com/docs/biot-plugins

Path Parameters:

ParameterTypeMandatoryDescriptionExample
namestringtruenull

This API requires SETTINGS_PLUGIN_UPDATE permission(s).

Language
Credentials
Bearer
JWT
Click Try It! to start a request and see the response here!