Content Management API > Plugin

Update a plugin

Body parameters

type string Required

Must be exactly "plugin".

attributes.name string Optional

The name of the plugin

Example:

"5 stars"

attributes.description null, string Optional

A description of the plugin

Example:

"A better rating experience!"

attributes.url string Optional

The entry point URL of the plugin

Example:

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

attributes.parameters object Optional

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

Example:

{ devMode: true }

attributes.package_version null, string Optional

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

Example:

"0.0.4"

attributes.permissions Optional

Permissions granted to this plugin

Type: Array<string>

Returns

Returns a resource object of type plugin.

Examples

1
PUT https://site-api.datocms.com/plugins/:plugin_id HTTP/1.1
2
Authorization: Bearer YOUR-API-TOKEN
3
Accept: application/json
4
X-Api-Version: 3
5
Content-Type: application/vnd.api+json
6

7
{
8
  "data": {
9
    "type": "plugin",
10
    "id": "RMAMRffBRlmBuDlQsIWZ0g",
11
    "attributes": {}
12
  }
13
}

1
curl -g 'https://site-api.datocms.com/plugins/:plugin_id' \
2
  -X PUT \
3
  -H "Authorization: Bearer YOUR-API-TOKEN" \
4
  -H "Accept: application/json" \
5
  -H "X-Api-Version: 3" \
6
  -H "Content-Type: application/vnd.api+json" \
7
  --data-binary '{"data":{"type":"plugin","id":"RMAMRffBRlmBuDlQsIWZ0g","attributes":{}}}'

1
await fetch("https://site-api.datocms.com/plugins/:plugin_id", {
2
  method: "PUT",
3
  headers: {
4
    Authorization: "Bearer YOUR-API-TOKEN",
5
    Accept: "application/json",
6
    "X-Api-Version": "3",
7
    "Content-Type": "application/vnd.api+json",
8
  },
9
  body: JSON.stringify({
10
    data: { type: "plugin", id: "RMAMRffBRlmBuDlQsIWZ0g", attributes: {} },
11
  }),
12
});

1
HTTP/1.1 200 OK
2
Content-Type: application/json
3
Cache-Control: cache-control: max-age=0, private, must-revalidate
4
X-RateLimit-Limit: 30
5
X-RateLimit-Remaining: 28
6

7
{
8
  "data": {
9
    "type": "plugin",
10
    "id": "RMAMRffBRlmBuDlQsIWZ0g",
11
    "attributes": {
12
      "name": "5 stars",
13
      "description": "A better rating experience!",
14
      "url": "https://cdn.rawgit.com/datocms/extensions/master/samples/five-stars/extension.js",
15
      "parameters": {
16
        "devMode": true
17
      },
18
      "package_name": "datocms-plugin-star-rating-editor",
19
      "package_version": "0.0.4",
20
      "permissions": [
21
        "currentUserAccessToken"
22
      ]
23
    },
24
    "meta": {
25
      "version": "2"
26
    }
27
  }
28
}

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.