Device

PreviousHALBs NextStatus

Last updated 10 months ago

Was this helpful?

List

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

GET/api/HALB/{HALBId}/Device

Path parameters

HALBId*integer (int32)

The ID of the HALB Virtual Server (mandatory)

Response

Success

Body

deviceIPnullable string

IP of the HALB Device

deviceIdinteger (int32)

ID of the HALB Device

Request

const response = await fetch('/api/HALB/{HALBId}/Device', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

Add

Add an HALB Device to a specific HALB Virtual Server.

POST/api/HALB/{HALBId}/Device

Path parameters

HALBId*integer (int32)

The ID of the HALB Virtual Server

Query parameters

Body

The HALB Devices to add.

deviceIP*nullable string

Response

No Content

Request

const response = await fetch('/api/HALB/{HALBId}/Device', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({
      "deviceIP": "text"
    }),
});
const data = await response.json();

Response

{
  "type": "text",
  "title": "text",
  "status": 1,
  "detail": "text",
  "instance": "text",
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Get

Return the HALB Devices used by the specific HALB Virtual Server

GET/api/HALB/{HALBId}/Device/{deviceId}

Path parameters

HALBId*integer (int32)

The ID of the HALB Virtual Server (mandatory)

deviceId*integer (int32)

The ID of the HALB Device (mandatory)

Response

Success

Body

deviceIPnullable string

IP of the HALB Device

deviceIdinteger (int32)

ID of the HALB Device

Request

const response = await fetch('/api/HALB/{HALBId}/Device/{deviceId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

Update Priority

Change the priority of HALB Device.

PUT/api/HALB/{HALBId}/Device/{deviceId}

Path parameters

HALBId*integer (int32)

The HALB Virtual Server ID.

deviceId*integer (int32)

The HALB Device ID.

Body

The HALB Device priority settings

direction*enum

Move Direction.

0 = Up,1 = Down

Response

No Content

Request

const response = await fetch('/api/HALB/{HALBId}/Device/{deviceId}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({
      "direction": [
        "0 = Up",
        "1 = Down"
      ]
    }),
});
const data = await response.json();

Response

{
  "type": "text",
  "title": "text",
  "status": 1,
  "detail": "text",
  "instance": "text",
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Delete

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

DELETE/api/HALB/{HALBId}/Device/{deviceId}

Path parameters

HALBId*integer (int32)

The ID of the HALB Virtual Server

deviceId*integer (int32)

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

Query parameters

Response

No Content

Request

const response = await fetch('/api/HALB/{HALBId}/Device/{deviceId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

{
  "type": "text",
  "title": "text",
  "status": 1,
  "detail": "text",
  "instance": "text",
  "ANY_ADDITIONAL_PROPERTY": "anything"
}