Switch Rule Set
Function
Modifying the Status of a Rule Set
URI
PUT /v2/{domain_id}/tenant/rule-sets/{rule_set_id}/switch
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
rule_set_id |
Yes |
String |
Rule Set ID |
|
domain_id |
Yes |
String |
Indicates the tenant ID. |
Request Parameters
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
X-Auth-Token |
Yes |
String |
User token. Can be obtained by calling the IAM API for obtaining the user token (the value of X-Subject-Token in the response header). |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
is_valid |
Yes |
Boolean |
Rule Template Instance Status |
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
status |
Boolean |
Status |
|
rule_set_id |
String |
Rule Set ID |
Status code: 400
|
Parameter |
Type |
Description |
|---|---|---|
|
error_msg |
String |
Error Message |
|
error_code |
String |
Error code. |
Example Requests
PUT https://{endpoint}/v2/ce8df55870164338a72d7e828a966a2a/tenant/rule-sets/6cb18ee5ca1c48caa335706e0e5ee288/switch
{
"is_valid" : false
}
Example Responses
Status code: 200
OK
{
"status" : true,
"rule_set_id" : "6cb18ee5ca1c48caa335706e0e5ee288"
}
Status Codes
|
Status Code |
Description |
|---|---|
|
200 |
OK |
|
400 |
Bad request |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.
