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.js"

parameters object Optional

Global plugin configuration. Plugins can persist whatever information they want in this object to reuse it later.

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>

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
  const plugin = await client.plugin.update(pluginId, {
9
    parameters: { foo: "bar" },
10
  });
11

12
  console.log(plugin);
13
}
14

15
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
  const plugin = await client.plugin.update(pluginId, {
9
    package_version: "2.0.0",
10
  });
11

12
  console.log(plugin);
13
}
14

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

14
  console.log(plugin);
15
}
16

17
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
};

Did this doc help you?

Need help?

Explore our forum, contact support, or connect with our sales team . You can also chat live with other users in our Slack channel.