Update an addon

Updates a node addon by setting the values of the attributes specified in the request body. Any unspecified attributes will be left unchanged.

Node addon can be updated with either a PUT or PATCH request. The external_account_id, enabled, and folder_id fields are mandatory in a PUT, and optional in PATCH. Non-string values will be accepted and stringified, however we make no promises about the stringification output.

To delete or deauthorize a node addon, issue a PUT with all fields set to null or False, or a PATCH with enabled set False.

Permissions

NodeSettings that are attached to public nodes will give read-only access to everyone. Private nodes require explicit read permission. Write and admin access are the same for public and private nodes. Administrators on a parent node have implicit read permissions for all child nodes. Any users with write or admin access to the node are able to deauthorize an enabled addon, but only the addon authorizer is able to change the configuration (i.e. selected folder) of an already-configured NodeSettings entity.

Returns

Returns a JSON object with a data key containing the new representation of the updated node addon, if the request is successful.

If the request is unsuccessful, an errors key containing information about the failure will be returned. Refer to the list of error codes to understand why this request may have failed.

{
  "data": {
    "type": "node_addons",
    "id": "{provider}",
    "attributes": {
      "external_account_id": "{account_id}",
      "folder_id": "{folder_id}",
      "folder_path": "{folder_path}",
      "url": "{url}",
      "label": "{label}"
    }
  }
}