Create or Update List Summary

post

https://localhost:8501/lr-admin-api/lists

* Updates a list summary based on the GUID and other required details.

* Searches the system for existing list summaries by GUID. Creates a new list summary if the GUID does not exist. Otherwise, updates the list summary.

* Owner field in json body is a required parameter and should be same as the UserID.

* When autoImportOption.enabled is true, importFileName must be a valid filename (not a path) with .csv or .txt extension. Path traversal attempts and absolute paths will be rejected.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

The body of the list summary, including all required attributes.

listType

string

enum

required

The list type.

status

string

enum

A record status of retired or active.

Allowed:

name

string

required

shortDescription

string | null

longDescription

string | null

useContext

array of objects

useContext

autoImportOption

object

required

importFileName

string | null

Filename for auto-import functionality. Must be a bare filename without path separators. Required when autoImportOption.enabled is true. NOTE: This pattern provides basic client-side validation. Server-side validation is more strict and enforces printable ASCII characters only (space through tilde, chars 32-126). The pattern cannot fully represent all server-side rules; when in doubt, the server response is authoritative. Validation rules (enforced server-side): - Must be a filename only (no directory paths or path separators) - Must not contain path traversal sequences (..) - Must not be an absolute path (/, , C:, \server\share) - Must not be a hidden file (cannot start with .) - Must not contain URL encoding (%) - Must not contain Windows reserved characters (: * ? " < > |) - Must contain only printable ASCII characters (space through ~) - Must have .csv or .txt extension (case-insensitive) - Must have at least one character before the extension - Must not exceed 255 characters - File must exist in the Job Manager's list import directory Valid examples: "hosts.csv", "import_list.txt", "FILE.CSV", "data.2024.csv" Invalid examples: "../file.csv", ".hidden.csv", ".csv", "C:\file.csv", "imports/file.csv", "file*.csv", "file.exe"

integer

-2147483648 to 2147483647

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

guid

string

Unique ID of the list. This will be ignore when creating the new list and generate new unique identifier, also list will be updated if a matching item found based on guid.

dateCreated

date-time

The date when the object was created. This is ignored when saving the records.

dateUpdated

date-time

The date when the object was last modified. This is ignored when saving the records.

revisitDate

date-time | null

readAccess

string

enum

required

The permission level.

Allowed:

writeAccess

string

enum

required

The permission level.

Allowed:

restrictedRead

boolean

required

entityName

string

required

length ≤ 200

The Entity name stored in the database.

entryCount

integer

timeToLiveSeconds

integer | null

needToNotify

boolean

required

doesExpire

boolean

required

owner

integer

Responses

200Updates list summary in the database.

201Creates new list in the database with no list items.

400Bad Request. Possible validation errors: - The time-to-live minimum value is 1200 seconds - Invalid importFileName (path traversal, absolute path, invalid extension, exceeds 255 characters) - Invalid owner ID - Invalid GUID format - General value list must have at least one use context

403An unauthorized user tried to create the list.

409Public list with this name already exists.