v4.0 Rule Sets API
TrueSight Network Automation REST API – RuleSetService
The base URL for the API is:
rule_sets
{{status subtle="false" colour="Blue" title="GET"/}}
/v4.0/rule_sets
Click here to expand...
Description
Retrieves rule sets, matching any filter criteria or view; may filter by filterable rule set dynamic fields by including query parameters in the form 'filter.dynamicFieldName=value'
Parameters
Name | Located in | Description | Default | Schema |
|---|---|---|---|---|
filter.name | query | Filter for rule sets matching this name, asterisk wildcards allowed | string | |
filter.enabled | query | Filter for enabled or disabled rule sets; when true, returns only enabled rule sets; when false, returns only disabled rule sets; when this filter is absent, no filtering is done | boolean | |
view | query | Filter for rule sets per the named private or shared view; any input filter.* or orderBy parameters override those settings in the view | string | |
orderBy | query | Sort by the specified attribute (assignedSpans, enabledFlag, name, or a listable rule set dynamic field name) in the specified order (prefix with a '+' for ascending or a '-' for descending) | string | |
offset | query | Return the specified page number | 1 | integer |
limit | query | Define the number of rows in a page or the maximum number of rule set to return | 25 | integer |
Authorization | header | Authorization token formatted as 'Bearer [token]' | string * |
Responses
Code | Description | Schema |
|---|---|---|
200 | successful operation | [ |
401 | Unauthorized: Failed to provide a suitable Authorization header or accessToken cookie, or the specified user is not logged in | |
403 | Forbidden: Not allowed to access rule sets | |
404 | Not found: No matching view found | |
500 | Internal server error: Unexpected exception occurred |
{{status subtle="false" colour="Green" title="POST"/}}
/v4.0/rule_sets
Click here to expand...
Parameters
Name | Located in | Description | Default | Schema |
|---|---|---|---|---|
body | body | Complete attributes of the new rule set | ||
Authorization | header | Authorization token formatted as 'Bearer [token]' | string * |
Responses
Code | Description | Schema |
|---|---|---|
201 | Created: New rule set successfully added | |
400 | Bad request: Input rule set DTO is missing or new rule set is invalid | |
401 | Unauthorized: Failed to provide a suitable Authorization header or accessToken cookie, or the specified user is not logged in | |
403 | Forbidden: Not allowed to add a new rule set or not allowed to specify an ACL | |
500 | Internal server error: Unexpected exception occurred |
{{status subtle="false" colour="Green" title="POST"/}}
/v4.0/rule_sets/changes_to_acls
Click here to expand...
Parameters
Name | Located in | Description | Default | Schema |
|---|---|---|---|---|
body | body | Changes to be made in the access control lists | ||
Authorization | header | Authorization token formatted as 'Bearer [token]' | string * |
Responses
Code | Description | Schema |
|---|---|---|
201 | OK: Access control lists updated successfully | |
400 | Bad request: Rule set access control lists are not enabled, input DTO is missing or invalid, or a modified rule set is invalid | |
401 | Unauthorized: Failed to provide a suitable Authorization header or accessToken cookie, or the specified user is not logged in | |
403 | Forbidden: Not allowed to manage the access control lists of rule sets,not allowed to modify a particular rule set, or not allowed to grant or revoke a particular right | |
500 | Internal server error: Unexpected exception occurred |
{{status subtle="false" colour="Blue" title="GET"/}}
/v4.0/rule_sets/custom_rights_management_information
Click here to expand...
Parameters
Name | Located in | Description | Default | Schema |
|---|---|---|---|---|
Authorization | header | Authorization token formatted as 'Bearer [token]' | string * |
Responses
Code | Description | Schema |
|---|---|---|
200 | successful operation | |
400 | Bad request: Rule set access control lists are not enabled | |
401 | Unauthorized: Failed to provide a suitable Authorization header or accessToken cookie, or the specified user is not logged in | |
500 | Internal server error: Unexpected exception occurred |
{{status subtle="false" colour="Blue" title="GET"/}}
/v4.0/rule_sets/{nameOrKey}
Click here to expand...
Parameters
Name | Located in | Description | Default | Schema |
|---|---|---|---|---|
nameOrKey | path | Name or database key of the rule set of interest | string * | |
Authorization | header | Authorization token formatted as 'Bearer [token]' | string * |
Responses
Code | Description | Schema |
|---|---|---|
200 | successful operation | |
401 | Unauthorized: Failed to provide a suitable Authorization header or accessToken cookie, or the specified user is not logged in | |
403 | Forbidden: Not allowed to access rule sets | |
404 | Not found: No single matching accessible rule set found | |
500 | Internal server error: Unexpected exception occurred |
{{status subtle="false" colour="Yellow" title="PUT"/}}
/v4.0/rule_sets/{nameOrKey}
Click here to expand...
Parameters
Name | Located in | Description | Default | Schema |
|---|---|---|---|---|
nameOrKey | path | Name or Database key of the rule set to be modified | string * | |
body | body | Complete new attribute values for the rule set; anything left out will be considered to be null and will be nulled out in the rule set; any required dynamic fields missing or null in the input will revert to default values | ||
Authorization | header | Authorization token formatted as 'Bearer [token]' | string * |
Responses
Code | Description | Schema |
|---|---|---|
200 | successful operation | |
400 | Bad request: Input rule set DTO is missing or modified rule set is invalid | |
401 | Unauthorized: Failed to provide a suitable Authorization header or accessToken cookie, or the specified user is not logged in | |
403 | Forbidden: Not allowed to modify the rule set or not allowed to modify the ACL | |
404 | Not found: No single matching accessible rule set found | |
500 | Internal server error: Unexpected exception occurred |
{{status colour="Green" title="POST"/}}
/v4.0/rule_sets/{nameOrKey}/copy
Click here to expand...
Parameters
Name | Located in | Description | Default | Schema |
|---|---|---|---|---|
nameOrKey | path | Name or database key of the original rule set whose member rules are to be copied | string * | |
body | body | Complete new attribute values for the rule set; anything left out will be considered to be null and will be nulled out in the rule set; any required dynamic fields missing or null in the input will revert to default values | ||
Authorization | header | Authorization token formatted as 'Bearer [token]' | string * |
Responses
Code | Description | Schema |
|---|---|---|
201 | Created: New rule set successfully added | |
400 | Bad request: Input rule set DTO is missing or new rule set is invalid | |
401 | Unauthorized: Failed to provide a suitable Authorization header or accessToken cookie, or the specified user is not logged in | |
403 | Forbidden: Not allowed to add a new rule set, or not allowed to specify an ACL, or not allowed to access all of the rules being copied | |
404 | Not found: No single matching accessible rule set found | |
500 | Internal server error: Unexpected exception occurred |
{{status subtle="false" colour="Red" title="DELETE"/}}
/v4.0/rule_sets/{nameOrKey}
Click here to expand...
Parameters
Name | Located in | Description | Default | Schema |
|---|---|---|---|---|
nameOrKey | path | Name or database key of the rule set to be deleted | string * | |
Authorization | header | Authorization token formatted as 'Bearer [token]' | string * |
Responses
Code | Description | Schema |
|---|---|---|
200 | successful operation | string |
400 | Bad request: Rule set is currently in use | |
401 | Unauthorized: Failed to provide a suitable Authorization header or accessToken cookie, or the specified user is not logged in | |
403 | Forbidden: Not allowed to delete the rule set | |
404 | Not found: No single matching accessible rule set found | |
500 | Internal server error: Unexpected exception occurred |
{{status subtle="false" colour="Yellow" title="PATCH"/}}
/v4.0/rule_sets/{nameOrKey}
Click here to expand...
Parameters
Name | Located in | Description | Default | Schema |
|---|---|---|---|---|
nameOrKey | path | Name or database key of the rule set to be modified | string * | |
body | body | New attribute values for the rule set, in JSON Patch format | ||
Authorization | header | Authorization token formatted as 'Bearer [token]' | string * |
Responses
Code | Description | Schema |
|---|---|---|
200 | successful operation | |
400 | Bad request: Input JSON patch information is missing or modified rule set is invalid | |
401 | Unauthorized: Failed to provide a suitable Authorization header or accessToken cookie, or the specified user is not logged in | |
403 | Forbidden: Not allowed to modify the rule set or not allowed to modify the ACL | |
404 | Not found: No single matching accessible rule set found | |
500 | Internal server error: Unexpected exception occurred |
{{status subtle="false" colour="Green" title="POST"/}}
/v4.0/rule_sets/{nameOrKey}/disablement
Click here to expand...
Parameters
Name | Located in | Description | Default | Schema |
|---|---|---|---|---|
nameOrKey | path | Name or database key of the rule set to be disabled | string * | |
Authorization | header | Authorization token formatted as 'Bearer [token]' | string * |
Responses
Code | Description | Schema |
|---|---|---|
200 | successful operation | string |
400 | Bad request: Rule set is already disabled | |
401 | Unauthorized: Failed to provide a suitable Authorization header or accessToken cookie, or the specified user is not logged in | |
403 | Forbidden: Not allowed to modify the rule set | |
404 | Not found: No single matching accessible rule set found | |
500 | Internal server error: Unexpected exception occurred |
{{status subtle="false" colour="Green" title="POST"/}}
/v4.0/rule_sets/{nameOrKey}/enablement
Click here to expand...
Parameters
Name | Located in | Description | Default | Schema |
|---|---|---|---|---|
nameOrKey | path | Name or database key of the rule set to be enabled | string * | |
Authorization | header | Authorization token formatted as 'Bearer [token]' | string * |
Responses
Code | Description | Schema |
|---|---|---|
200 | successful operation | string |
400 | Bad request: Rule set is already enabled | |
401 | Unauthorized: Failed to provide a suitable Authorization header or accessToken cookie, or the specified user is not logged in | |
403 | Forbidden: Not allowed to modify the rule set | |
404 | Not found: No single matching accessible rule set found | |
500 | Internal server error: Unexpected exception occurred |
Object Definitions
Object | Schema |
|---|---|
AclChangesDTO | Click here to expand...{ |
AclDTO | Click here to expand...{ |
ComponentId | Click here to expand...{ |
CustomRightsManagementDTO | Click here to expand...{ |
DynamicFieldValueDTO | Click here to expand...{ |
JsonPatch | Click here to expand...[ |
JsonPatch.OneOperation | Click here to expand... |
JsonPatch.Pointer | Click here to expand...string |
JsonPatch.Add | Click here to expand...{ |
JsonPatch.Remove | Click here to expand...{ |
JsonPatch.Replace | Click here to expand...{ |
JsonPatch.Move | Click here to expand...{ |
JsonPatch.Copy | Click here to expand...{ |
JsonPatch.Test | Click here to expand...{ |
PerRoleRightsDTO | Click here to expand...{ |
RuleSetDTO | Click here to expand...{ |