API Reference
Start typing to search…

Update Host

put
https://localhost:8501/lr-admin-api/hosts/

Updates a Host based on the Id and other required details. Searches existing Hosts by Id. Returns a 404 error if the Id does not exist. Otherwise, updates the Host and returns the Host Id with response 200.

Path Params
integer
required
-2147483647 to 2147483647

The Object Id stored in the database.

Body Params

The body of the Host, including the Id and all required attributes.

integer
-2147483648 to 2147483647

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

entity
object
required
string
required
length ≤ 200

The name of the Host.

string
length ≤ 255

A brief description of the component.

string
length ≤ 2000

A full description of the component.

string
enum
required

The risk level.

string
enum

The risk level.

string

Threat level comments

string
enum
required

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

Allowed:
string
enum
required

The Host zones type.

Allowed:
location
object
string
enum
required

The OS type supported by LogRhythm.

string
length ≤ 100
string
length ≤ 512
password
length ≤ 512
boolean
required
string
enum
Defaults to Server

The Agent server type on which the OS is installed.

Allowed:
date-time

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

Responses

Updated 6 months ago

Language
Credentials
Header
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 6 months ago