Device

PreviousHALBs NextStatus

Last updated 1 year ago

Was this helpful?

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

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/HALB/{HALBId}/Device/{deviceId}'

200

401

404

{
  "deviceIP": "text",
  "deviceId": 1
}

Success

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

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/api/HALB/{HALBId}/Device/{deviceId}'

204

401

404

No body

No Content

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

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/HALB/{HALBId}/Device'

200

401

404

[
  {
    "deviceIP": "text",
    "deviceId": 1
  }
]

Success

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

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/HALB/{HALBId}/Device' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "deviceIP": "text"
  }'

204

401

404

No body

No Content

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

directionstring · enumrequired

Move Direction.

Options: 0 = Up,1 = Down

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/HALB/{HALBId}/Device/{deviceId}' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "direction": [
      "0 = Up",
      "1 = Down"
    ]
  }'

204

401

404

No body

No Content