Content Management API > Plugin

Update a plugin

Body parameters

name string Optional

The name of the plugin

Example:

"5 stars"

description null, string Optional

A description of the plugin

Example:

"A better rating experience!"

url string Optional

The entry point URL of the plugin

Example:

"https://cdn.rawgit.com/datocms/extensions/master/samples/five-stars/extension.ts"

package_name string Optional

Turns a private plugin into a Marketplace plugin, installing the specified package from the DatoCMS Marketplace. Only accepted for private, non-legacy plugins, and cannot be combined with other attributes (except enabled). Name, description, URL, version and permissions are replaced with the ones published in the Marketplace, while the existing parameters are preserved.

Example:

"datocms-plugin-star-rating-editor"

parameters object Optional

Global plugin configuration. Plugins can persist whatever information they want in this object to reuse it later. Refer to the CMA for details about technical limits.

Example:

{ devMode: true }

package_version null, string Optional

The installed version of the plugin (or null if it's a private plugin)

Example:

"0.0.4"

permissions Optional

Permissions granted to this plugin

Type: Array<string>

enabled boolean Optional

Whether the plugin is enabled or not. When disabled, the plugin behaves as if it didn't exist: fields using it as editor/addon fall back to the default editor, and any sidebar panel/page/config screen/asset source it registers does not render.

Returns

Returns a resource object of type plugin

Other examples

1
import { buildClient } from "@datocms/cma-client-node";
2

3
async function run() {
4
  // Make sure the API token has access to the CMA, and is stored securely
5
  const client = buildClient({ apiToken: process.env.DATOCMS_API_TOKEN });
6

7
  const pluginId = "124";
8

9
  const plugin = await client.plugins.update(pluginId, {
10
    parameters: { foo: "bar" },
11
  });
12

13
  console.log(plugin);
14
}
15

16
run();

1
const result = {
2
  type: "plugin",
3
  id: "124",
4
  name: "5 stars",
5
  /* ... */
6
  parameters: { foo: "bar" },
7
};

1
import { buildClient } from "@datocms/cma-client-node";
2

3
async function run() {
4
  // Make sure the API token has access to the CMA, and is stored securely
5
  const client = buildClient({ apiToken: process.env.DATOCMS_API_TOKEN });
6

7
  const pluginId = "124";
8

9
  const plugin = await client.plugins.update(pluginId, {
10
    package_version: "2.0.0",
11
  });
12

13
  console.log(plugin);
14
}
15

16
run();

1
const result = {
2
  type: "plugin",
3
  id: "124",
4
  name: "5 stars",
5
  /* ... */
6
  package_version: "2.0.0",
7
};

1
import { buildClient } from "@datocms/cma-client-node";
2

3
async function run() {
4
  // Make sure the API token has access to the CMA, and is stored securely
5
  const client = buildClient({ apiToken: process.env.DATOCMS_API_TOKEN });
6

7
  const pluginId = "124";
8

9
  const plugin = await client.plugins.update(pluginId, {
10
    name: "5 stars",
11
    description: "A better rating experience!",
12
    url: "https://cdn.rawgit.com/datocms/extensions/master/samples/five-stars/extension.js",
13
    permissions: ["currentUserAccessToken"],
14
  });
15

16
  console.log(plugin);
17
}
18

19
run();

1
const result = {
2
  type: "plugin",
3
  id: "124",
4
  name: "5 stars",
5
  description: "A better rating experience!",
6
  package_name: null,
7
  package_version: null,
8
  url: "https://cdn.rawgit.com/datocms/extensions/master/samples/five-stars/extension.js",
9
  permissions: ["currentUserAccessToken"],
10
  parameters: { foo: "bar" },
11
};

Once a privately-hosted plugin gets published to the DatoCMS Marketplace, you can turn the private plugin into a Marketplace plugin. Its global parameters are preserved.

1
import { buildClient } from "@datocms/cma-client-node";
2

3
async function run() {
4
  // Make sure the API token has access to the CMA, and is stored securely
5
  const client = buildClient({ apiToken: process.env.DATOCMS_API_TOKEN });
6

7
  const pluginId = "124";
8

9
  const plugin = await client.plugins.update(pluginId, {
10
    package_name: "datocms-plugin-star-rating-editor",
11
  });
12

13
  console.log(plugin);
14
}
15

16
run();

1
const result = {
2
  type: "plugin",
3
  id: "124",
4
  name: "Star rating",
5
  description: "A better rating experience!",
6
  package_name: "datocms-plugin-star-rating-editor",
7
  package_version: "0.0.4",
8
  url: "https://plugins-cdn.datocms.com/datocms-plugin-star-rating-editor@0.0.4/dist/index.html",
9
  permissions: [],
10
  parameters: { foo: "bar" },
11
  enabled: true,
12
};