Hardware IDs | Parallels REST API

Parallels REST API

SupportDocumentation

Last updated 11 months ago

Was this helpful?

List

Retrieve Criteria Hardware ID List of a session server with the specified ID.

get

/api/PubItems/{id}/Rules/{ruleId}/Criteria/HardwareIDs

Path parameters

idinteger · int32required

The ID of a session server for which to retrieve the Criteria settings.

ruleIdinteger · int32required

The ID of the Rule to retrieve.

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/PubItems/{id}/Rules/{ruleId}/Criteria/HardwareIDs'

200

401

404

[
  {
    "hardwareID": "text"
  }
]

Success

Add

Add a hardware ID to the Hardware ID List of the Criteria settings.

post

/api/PubItems/{id}/Rules/{ruleId}/Criteria/HardwareIDs

Path parameters

idinteger · int32required

The ID of a session server for which to modify the Criteria settings.

ruleIdinteger · int32required

The ID of the Rule to retrieve.

Body

hardwareIDstring | nullablerequired

<para type="description">The hardware ID to add to the Criteria.</para>

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/PubItems/{id}/Rules/{ruleId}/Criteria/HardwareIDs' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "hardwareID": "text"
  }'

201

401

404

409

No body

Created

Remove

Remove a hardware ID from the Hardware ID List of the Criteria settings.

delete

/api/PubItems/{id}/Rules/{ruleId}/Criteria/HardwareIDs

Path parameters

idinteger · int32required

The ID of a session server for which to modify the Criteria settings.

ruleIdinteger · int32required

The ID of the Rule to retrieve.

Body

hardwareIDstring | nullablerequired

<para type="description">The hardware ID to remove from the Criteria.</para>

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/api/PubItems/{id}/Rules/{ruleId}/Criteria/HardwareIDs' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "hardwareID": "text"
  }'

204

401

404

No body

No Content