Update Entity

post

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

Updates an Entity based on the Id and other required details. Returns a 404 error if the Id does not exist. Otherwise, creates an Entity if the Id specified is -1, and then returns the LogRhythm generated Entity Id.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

The body of the Entity, which includes the Id, required attributes, and either all the remaining attributes (for a new Entity) or some of the remaining attributes (for an updated Entity).

A summary of Entity details.

integer

required

-2147483648 to 2147483647

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

parentEntityName

string

length ≤ 200

The Parent Entity full name stored in the database.

name

string

required

length ≤ 200

Name of the Entity

fullName

string

length ≤ 410

A full representation of the Entity as child with its parent Entity.

abbreviation

string | null

recordStatusName

string

enum

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

Allowed:

longDesc

string

length ≤ 2000

A full description of the component.

shortDesc

string

length ≤ 255

A brief description of the component.

dateUpdated

date-time

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

Responses

200Returns the updated Entity.

201Returns the newly created Entity.

401Unauthorized

403A User without correct permission tried to create/update the entity.

409Entity with the specified full name already exists. User tried to insert an existing Entity.