Edit an MPE Policy.

put

https://localhost:8501/lr-admin-api/mpepolicies/{id}

*Edit an MPE Policy and returns the updated MPE Policy.

*In case of System MPE policy, only "ruleTimeout" field is allowed to update and other fields will be non-editable.

*"messageSourceTypeID" is a non-editable field and any user input for this field will not be considered while updating MPE policy.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

integer

required

-2147483647 to 2147483647

The Object Id stored in the database.

Body Params

The body of the MPE Policy, including all the required parameters.

integer

required

-2147483648 to 2147483647

The Object Id generated by LogRhythm. Required for PUT operations (updates).

name

string

required

length ≤ 50

The name of MPE policy.

messageSourceTypeID

integer

required

-2147483648 to 2147483647

The Object Id generated by LogRhythm. Required for PUT operations (updates).

shortDesc

string

length ≤ 255

A brief description of the component.

longDesc

string

length ≤ 2000

A full description of the component.

recordStatusName

string

enum

The database status. Required for PUT operations. Valid values are "Active" or "Retired".

Allowed:

dateUpdated

date-time

allowAutoSort

boolean

required

Allows automatic MPE Rule sorting.

ruleTimeout

integer

required

0 to 2000

The time out in milliseconds for MPE Rules in the policy.

Responses

200Returns the updated MPE Policy.

403A User without the correct permissions tried to update the existing MPE Policy.