Skip to content

Latest commit

 

History

History
64 lines (50 loc) · 1.39 KB

File metadata and controls

64 lines (50 loc) · 1.39 KB
layout toc title slug
docs-api
toc-api-admin.html
PUT /nodes/:module/:set
url label
/docs/api/admin
admin
url label
/docs/api/admin/methods
methods
modify node set

Enable/Disable a node set

Requires permission: nodes.write

Headers

Header Value
Authorization Bearer [token] - if authentication is enabled
Content-type application/json

Arguments

Path Component Description
module The name of the module
set The name of the set

The request body must be a JSON string with the following fields:

Field Description
enabled true or false - whether to enable or disable the module

{% highlight json %} { "enabled": true } {% endhighlight %}

Response

Status Code Reason Response
200 Success A Node Set object. See example response body
400 Bad request An Error response
401 Not authorized none
404 Not found none

{% highlight json %} { "id": "node-red-node-suncalc/suncalc", "name": "suncalc", "types": [ "sunrise" ], "enabled": false, "module": "node-red-node-suncalc" } {% endhighlight %}