Modify the Rule Status

This API is used by an application to modify the status of a specific rule on the platform to activate or deactivate the rule.

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

PUT /v5/iot/{project_id}/rules/{rule_id}/status

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Parameter description: project ID. For details about how to obtain the project ID, see Obtaining a Project ID.
rule_id	Yes	String	Parameter description: rule ID. Value: The value can contain a maximum of 32 characters. Only letters and digits are allowed.

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	No	String	Parameter description: user token. You can obtain the token by calling the IAM API Obtaining a User Token Through Password Authentication. In the returned response header, X-Subject-Token is the desired user token. For details about how to obtain the token, see Token Authentication.
Instance-Id	No	String	Parameter description: instance ID. Unique identifier of each instance in the physical multi-tenant scenario. Mandatory for professional editions and recommended in other cases. Log in to the IoTDA console and choose Overview in the navigation pane to view the instance ID. For details, see Viewing Instance Details.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
status	Yes	String	Parameter description: rule status. Options: active: activated. inactive: not activated.

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
status	String	Parameter description: rule status. Options: active: activated. inactive: not activated.

Changes the status of the rule to Active.

PUT https://{endpoint}/v5/iot/{project_id}/rules/{rule_id}/status

{
  "status" : "active"
}

Status code: 200

{
  "status" : "active"
}

Parent topic: Rule Management

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.