Fetch Hosts Details

get

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

Returns all Hosts that match the specified criteria.

Query Params

offset

integer

Defaults to 0

The starting point of records to be returned.

count

integer

1 to 1000

Defaults to 100

The number of results to be returned.

orderBy

string

enum

Defaults to name

Sorts records by name or Id.

Allowed:

dir

string

enum

Defaults to ascending

Sorts records by ascending or descending.

Allowed:

name

string

Object name filter.

entity

string

Filters records by Entity name.

recordStatus

string

enum

Defaults to all

Filters records by object recordStatus.

Allowed:

hostEntityId

array of integers

A collection of non-zero entityID

hostEntityId

parentEntityId

array of integers

A collection of non-zero parent entityID

parentEntityId

hostIdentifier

array of strings

Host Identifier Filter. This will be used to filter hosts by its identifiers.

hostIdentifier

excludeAIERecords

boolean

Defaults to false

Exclude AIE records from the collection.

Responses

Language

Credentials

Header

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Returns requested Hosts.

403Error will appear when any user who is not permitted, tries to fetch hosts.