Unable to render embedded object: File (Dark logo transperant background.png) not found.

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this content. View the current version.

Compare with Current View Version History

Version 1 Next »

GET event_rule_sets

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Returns a list of all Event Rule Sets configuration data.

Resource URL

http://{host}/api/2.0/event_rule_sets/.format

Example Request

GET 

  1. http://44.235.52.211/api/2.0/event_rule_sets/.json

[
    {
        "EventRuleSet": {
            "id": 1,
            "title": "Default",
            "modified": "1611142282208",
            "created": "1611142282208",
            "EventRuleSetEntry": [
                {
                    "id": 1,
                    "event_rule_id": 1,
                    "threshold": 1,
                    "event_severity_id": 1,
                    "is_record_enabled": 0
                }
            ]    
        }        
    },
    {
        "EventRuleSet": {
            "id": 2,
            "title": "Default_1",
            "modified": "1611142282208",
            "created": "1611142282208",
            "EventRuleSetEntry": []
        }
    }
]

GET event_rule_sets/{id}

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Returns a detailed single specific Event Rule Set configuration data.

Resource URL

http://{host}/api/2.0/event_rule_sets/{id}/.format

Parameters

Parameter

Data Type

Description

id
(required)

integer

The ID if the desired Event Rule Set to be viewed.

Example Request

GET 

  1. http://44.235.52.211/api/2.0/event_rule_sets/2/.json

{
    "EventRuleSet": {
        "id": 1,
        "title": "Default",
        "modified": "1611142282208",
        "created": "1611142282208",
        "EventRuleSetEntry": [
            {
                "id": 1,
                "event_rule_id": 1,
                "threshold": 1,
                "event_severity_id": 1,
                "is_record_enabled": 0
            }
        ]
    }
}

POST event_rule_sets

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

POST

Adds a new Event Rule Set.

Resource URL

http://{host}/api/2.0/event_rule_sets/.format

Example Request

POST 

  1. http://44.235.52.211/api/2.0/event_rule_sets/.json

Body

{
    "EventRuleSet": {
        "title": "EventRuleSet_NEW",
        "EventRuleSetEntry": [
            {
                "event_rule_id": "98",
                "threshold": "2",
                "event_severity_id": "8",
                "is_record_enabled": "0"
            }
        ]
    }
}

Response

{
    "EventRuleSet": {
        "id": 3,
        "title": "EventRuleSet_NEW",
        "modified": "1619435943662",
        "created": "1619435943660",
        "EventRuleSetEntry": [
            {
                "id": 382,
                "event_rule_id": 98,
                "threshold": 2,
                "event_severity_id": 8,
                "is_record_enabled": 0
            }
        ]
    }
}

POST event_rule_sets/{id}

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

POST

Duplicates a single specific Event Rule Set into a new one, preserving all configuration except the title.

Resource URL

http://{host}/api/2.0/event_rule_sets/{id}/.format

Parameters

Parameter

Data Type

Description

id
(required)

integer

The ID if the desired Event Rule Set to be copied.

Example Request

POST 

  1. http://44.235.52.211/api/2.0/event_rule_sets/3/.json

{
    "EventRuleSet": {
        "id": 4,
        "title": "EventRuleSet_NEW_1",
        "modified": "1619435993282",
        "created": "1619435993281",
        "EventRuleSetEntry": [
            {
                "id": 383,
                "event_rule_id": 98,
                "threshold": 2,
                "event_severity_id": 8,
                "is_record_enabled": 0
            }
        ]
    }
}

PUT event_rule_sets/{id}

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

PUT

Updates a sngle specific Event Rule Set.

Resource URL

http://{host}/api/2.0/event_rule_sets/{id}/.format

Parameters

Parameter

Data Type

Description

id
(required)

integer

The ID if the desired Event Rule Set to be updated.

Example Request

PUT 

  1. http://44.235.52.211/api/2.0/event_rule_sets/3/.json

Body

{
    "EventRuleSet": {
        "title": "EventRuleSet_EDIT",
        "EventRuleSetEntry": [
            {
                "event_rule_id": "98",
                "threshold": "2",
                "event_severity_id": "4",
                "is_record_enabled": "0"
            }
        ]
    }
}

Response

{
    "EventRuleSet": {
        "id": 3,
        "title": "EventRuleSet_EDIT",
        "modified": "1619436061919",
        "created": "1619435943660",
        "EventRuleSetEntry": [
            {
                "id": 382,
                "event_rule_id": 98,
                "threshold": 2,
                "event_severity_id": 4,
                "is_record_enabled": 0
            }
        ]
    }
}

DELETE event_rule_sets/{id}

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

DELETE

Deletes a single specific Event Rule Set.

Resource URL

http://{host}/api/2.0/event_rule_sets/{id}/.format

Parameters

Parameter

Data Type

Description

id
(required)

integer

The ID if the desired Event Rule Set to be deleted.

Example Request

DELETE 

  1. http://44.235.52.211/api/2.0/event_rule_sets/3/.json

{
    "success": true
}
  • No labels