Home
Content Management API
Content Management API Overview Using the JavaScript client API versioning Authentication Environments Errors Pagination Asynchronous jobs Technical Limits
Main resources
Record Scheduled publication Scheduled unpublishing Upload Site Model/Block Field Fieldset Record version
Upload-related
Upload permission Upload track Manual tags Smart tags Upload Collection
Site Search
Search result
Environments
Environment Maintenance mode
UI
Menu Item Schema Menu Item Uploads filter Model filter Plugin
Create a new plugin Update a plugin List all plugins Retrieve a plugin Delete a plugin Retrieve all fields using the plugin
Workflows
Workflow
Async jobs
Asynchronous job Job result
Roles & permissions
Account Organization Invitation Collaborator Role API token
Webhooks
Webhook Webhook call
Hosting & CI integrations
Build trigger Deploy activity
Subscription
Subscription limit Subscription feature
Enterprise
SSO Settings SSO User SSO Group White-label settings Audit log event
Show examples in:
Javascript HTTP
Resource info

Content Management API > Plugin

Plugin

Plugins enable developers to replace DatoCMS field components with HTML5 applications so the editing experiences of the DatoCMS web app can be customized.

Object payload

id string

RFC 4122 UUID of plugin expressed in URL-safe base64 format

Example: "RMAMRffBRlmBuDlQsIWZ0g"
type string

Must be exactly "plugin".

attributes.name string

The name of the plugin

Example: "5 stars"
attributes.description null, string

A description of the plugin

Example: "A better rating experience!"
attributes.url string

The entry point URL of the plugin

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

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

Example: { devMode: true }
attributes.package_name null, string

NPM package name of the plugin (or null if it's a private plugin)

Example: "datocms-plugin-star-rating-editor"
attributes.package_version null, string

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

Example: "0.0.4"
attributes.permissions

Permissions granted to this plugin

Type: Array<string>
meta.version string

Version of the plugin. Legacy plugins are v1, new plugins are v2

Example: "2"
attributes.plugin_type null, enum Deprecated

The type of field extension a legacy plugin implements

This field makes sense for legacy plugins only. Modern plugins declare their capabilities at run-time.

field_editor

Field editor plugin

sidebar

Sidebar plugin

field_addon

Field addon plugin
attributes.field_types Deprecated

On which types of field in which a legacy plugin can be used

This field makes sense for legacy plugins only. Modern plugins declare their capabilities at run-time.

Type: null, Array<string>
attributes.parameter_definitions null, object Deprecated

The schema for the parameters a legacy plugin can persist

This field makes sense for legacy plugins only. Modern plugins declare can store anything they want in the parameters attribute.

global Array
instance Array

Available endpoints

Did this doc help you?
Yes
No
Would you like to add more information?
Optional
To receive further updates or address your feedback, kindly share your email address with us.
Optional

If you need a reply, please contact support instead.

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.