Device | Parallels REST API

Parallels REST API

Products Support Partners Documentation

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

200

Success

application/json; api-version=1.0

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

GET /api/HALB/{HALBId}/Device/{deviceId} HTTP/1.1
Host: 
Accept: */*

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

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

204

No Content

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

delete

DELETE /api/HALB/{HALBId}/Device/{deviceId} HTTP/1.1
Host: 
Accept: */*

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

200

Success

application/json; api-version=1.0

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

GET /api/HALB/{HALBId}/Device HTTP/1.1
Host: 
Accept: */*

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

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

204

No Content

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

post

POST /api/HALB/{HALBId}/Device HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 19

{
  "deviceIP": "text"
}

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

Update the piority of a HALB Device

directionstring · enumRequired

Move Direction.

Possible values:

Responses

204

No Content

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

put

PUT /api/HALB/{HALBId}/Device/{deviceId} HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 35

{
  "direction": [
    "0 = Up",
    "1 = Down"
  ]
}

No content