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"
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
import { buildClient } from "@datocms/cma-client-node";
async function run() { // Make sure the API token has access to the CMA, and is stored securely const client = buildClient({ apiToken: process.env.DATOCMS_API_TOKEN });
const pluginId = "124";
const plugin = await client.plugins.update(pluginId, { parameters: { foo: "bar" }, });
console.log(plugin);}
run();const result = { type: "plugin", id: "124", name: "5 stars", /* ... */ parameters: { foo: "bar" },};import { buildClient } from "@datocms/cma-client-node";
async function run() { // Make sure the API token has access to the CMA, and is stored securely const client = buildClient({ apiToken: process.env.DATOCMS_API_TOKEN });
const pluginId = "124";
const plugin = await client.plugins.update(pluginId, { package_version: "2.0.0", });
console.log(plugin);}
run();const result = { type: "plugin", id: "124", name: "5 stars", /* ... */ package_version: "2.0.0",};import { buildClient } from "@datocms/cma-client-node";
async function run() { // Make sure the API token has access to the CMA, and is stored securely const client = buildClient({ apiToken: process.env.DATOCMS_API_TOKEN });
const pluginId = "124";
const plugin = await client.plugins.update(pluginId, { name: "5 stars", description: "A better rating experience!", url: "https://cdn.rawgit.com/datocms/extensions/master/samples/five-stars/extension.js", permissions: ["currentUserAccessToken"], });
console.log(plugin);}
run();const result = { type: "plugin", id: "124", name: "5 stars", description: "A better rating experience!", package_name: null, package_version: null, url: "https://cdn.rawgit.com/datocms/extensions/master/samples/five-stars/extension.js", permissions: ["currentUserAccessToken"], parameters: { foo: "bar" },};