Skip to content

API: Discovery - Hosts

This guide covers endpoints for managing discovered hosts.

List Hosts

Retrieve a list of discovered hosts. You can use query parameters for paging, sorting, or filtering.

Request:

1
2
GET /api/v1/discovery/hosts?{PAGING-SORT-PARAMETERS} HTTP/1.1
Authorization: Bearer {JWT_TOKEN}

GET parameters:

  • page: Results page number
  • pageSize: Number of results per page
  • sort: Format {FIELD}:{ASC/DESC} (can be used multiple times)
  • address: Filter by address (supports leading/trailing * wildcards)
  • name: Filter by host name (supports wildcards)
  • anyFieldContains: Search across all fields

Example:

1
2
GET /api/v1/discovery/hosts?page=0&pageSize=10&sort=address:asc HTTP/1.1
Authorization: Bearer {JWT_TOKEN}

1
2
GET /api/v1/discovery/hosts?page=0&pageSize=100&address=192.168* HTTP/1.1
Authorization: Bearer {JWT_TOKEN}

Get Host Details

Retrieve details for a specific host by its ID.

Request:

1
2
GET /api/v1/discovery/host/{HOST-ID} HTTP/1.1
Authorization: Bearer {JWT_TOKEN}

Create a New Host

Add a new host entry by providing the required configuration.

Request:

1
2
3
4
5
POST /api/v1/discovery/hosts HTTP/1.1
Authorization: Bearer {JWT_TOKEN}
Content-Type: application/json

{HOST-CONF}

Example:

1
2
3
4
5
6
7
8
9
POST /api/v1/discovery/hosts HTTP/1.1
Authorization: Bearer {JWT_TOKEN}
Content-Type: application/json

{
  "address": "192.168.1.2",
  "name": "test-host",
  "note": "test note"
}

Update an Existing Host

Modify details for an existing host.

Request:

1
2
3
4
5
PATCH /api/v1/discovery/host/{HOST-ID} HTTP/1.1
Authorization: Bearer {JWT_TOKEN}
Content-Type: application/json

{HOST-CONF}

Example:

1
2
3
4
5
6
7
PATCH /api/v1/discovery/host/b0561061-b8f2-4820-adb3-1a4a369ebb35 HTTP/1.1
Authorization: Bearer {JWT_TOKEN}
Content-Type: application/json

{
  "name": "new name"
}

Bulk Archive Hosts

Archive one or more hosts by providing their IDs.

Request:

1
2
3
4
5
6
7
POST /api/v1/discovery/hosts/bulk-archive HTTP/1.1
Authorization: Bearer {JWT_TOKEN}
Content-Type: application/json

{
  "hostIds": [HOST-IDS]
}

Example:

1
2
3
4
5
6
7
POST /api/v1/discovery/hosts/bulk-archive HTTP/1.1
Authorization: Bearer {JWT_TOKEN}
Content-Type: application/json

{
  "hostIds": ["b0561061-b8f2-4820-adb3-1a4a369ebb35", "215ds361-b232-4650-a5b3-354a369ebb36"]
}

Bulk Restore Hosts

Restore archived hosts by providing their IDs.

Request:

1
2
3
4
5
6
7
POST /api/v1/discovery/hosts/bulk-restore HTTP/1.1
Authorization: Bearer {JWT_TOKEN}
Content-Type: application/json

{
  "hostIds": [HOST-IDS]
}

Example:

1
2
3
4
5
6
7
POST /api/v1/discovery/hosts/bulk-restore HTTP/1.1
Authorization: Bearer {JWT_TOKEN}
Content-Type: application/json

{
  "hostIds": ["b0561061-b8f2-4820-adb3-1a4a369ebb35", "215ds361-b232-4650-a5b3-354a369ebb36"]
}

Get Host Events

Retrieve events related to a specific host.

Request:

1
2
GET /api/v1/discovery/host/{HOST-ID}/events HTTP/1.1
Authorization: Bearer {JWT_TOKEN}