SupportDocumentation

Device

List

get

Return a list of HALB Devices used by the specific HALB Virtual Server

Path parameters
HALBIdinteger · int32Required

The ID of the HALB Virtual Server (mandatory)

Responses
get
/api/HALB/{HALBId}/Device

Add

post

Add an HALB Device to a specific HALB Virtual Server.

Path parameters
HALBIdinteger · int32Required

The ID of the HALB Virtual Server

Query parameters
noInstallbooleanOptional

If specified the HALB devices will not be initialized.

Body
deviceIPstring | nullableRequired
Responses
post
/api/HALB/{HALBId}/Device
No content

Get

get

Return the HALB Devices used by the specific HALB Virtual Server

Path parameters
HALBIdinteger · int32Required

The ID of the HALB Virtual Server (mandatory)

deviceIdinteger · int32Required

The ID of the HALB Device (mandatory)

Responses
get
/api/HALB/{HALBId}/Device/{deviceId}

Update Priority

put

Change the priority of HALB Device.

Path parameters
HALBIdinteger · int32Required

The HALB Virtual Server ID.

deviceIdinteger · int32Required

The HALB Device ID.

Body

Update the piority of a HALB Device

directionstring · enumRequired

Move Direction.

Possible values:
Responses
put
/api/HALB/{HALBId}/Device/{deviceId}
No content

Delete

delete

Remove the specific HALB Devices used by the HALB Virtual Server.

Path parameters
HALBIdinteger · int32Required

The ID of the HALB Virtual Server

deviceIdinteger · int32Required

The HALB Device ID used by the HALB Virtual Server that need to be removed.

Query parameters
noUnInstallbooleanOptional

If specified the HALB devices will not be un-initialized.

Responses
delete
/api/HALB/{HALBId}/Device/{deviceId}
No content
PreviousHALBsNextStatus

Last updated

Was this helpful?