Parallels REST API

Get Auto Info

Retrieve information about MFA Radius Auto Info List.

get

/api/MFA/{id}/RadiusAutoInfo

Path parameters

idinteger int32required

The ID of a MFA for which to retrieve the MFA Radius Auto Info List.

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/MFA/{id}/RadiusAutoInfo'

200

401

404

{
  "id": 1,
  "priority": 1,
  "autoSend": true,
  "command": "text",
  "enabled": true,
  "image": [
    "100 = Alert",
    "101 = Message",
    "102 = Email",
    "103 = Call",
    "104 = Chat",
    "105 = Flag"
  ],
  "description": "text",
  "actionMessage": "text",
  "title": "text"
}

Success

Add Auto Info

Add a new Radius Auto Info to a site.

post

/api/MFA/{id}/RadiusAutoInfo

Path parameters

idinteger int32required

MFA settings

Body

commandnullable stringrequired

RADIUS Automation command

enabledboolean

Whether the RADIUS Automation is enabled/disabled

imageenum

Image Type

Options: 100 = Alert,101 = Message,102 = Email,103 = Call,104 = Chat,105 = Flag

titlenullable stringrequired

RADIUS Automation title

actionMessagenullable string

RADIUS Automation action message

descriptionnullable string

RADIUS Automation description

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/MFA/{id}/RadiusAutoInfo' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{"command":"text","image":["100 = Alert","101 = Message","102 = Email","103 = Call","104 = Chat","105 = Flag"],"title":"text"}'

201

401

409

{
  "id": 1,
  "priority": 1,
  "autoSend": true,
  "command": "text",
  "enabled": true,
  "image": [
    "100 = Alert",
    "101 = Message",
    "102 = Email",
    "103 = Call",
    "104 = Chat",
    "105 = Flag"
  ],
  "description": "text",
  "actionMessage": "text",
  "title": "text"
}

Created

Update Auto Info

Update Radius Auto Info from a site.

put

/api/MFA/{id}/RadiusAutoInfo/{radiusautoid}

Path parameters

idinteger int32required

The ID of a MFA to update a RadiusAutoInfo from the site.

radiusautoidinteger int32required

The ID of a RadiusAutoInfo to update.

Body

autoSendnullable boolean

Whether the RADIUS Automation autoSend is enabled or not

commandnullable string

RADIUS Automation command

enablednullable boolean

Whether the RADIUS Automation is enabled/disabled

imageenum

Image Type

Options: 100 = Alert,101 = Message,102 = Email,103 = Call,104 = Chat,105 = Flag

descriptionnullable string

RADIUS Automation description

actionMessagenullable string

RADIUS Automation action message

newTitlenullable string

RADIUS Automation title

priorityenum

Move Direction.

Options: 0 = Up,1 = Down

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/MFA/{id}/RadiusAutoInfo/{radiusautoid}' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{"image":["100 = Alert","101 = Message","102 = Email","103 = Call","104 = Chat","105 = Flag"],"priority":["0 = Up","1 = Down"]}'

204

401

404

No body

No Content

Delete Auto Info

Delete a Radius Auto Info from a site.

delete

/api/MFA/{id}/RadiusAutoInfo/{radiusautoid}

Path parameters

idinteger int32required

The ID of a MFA to remove a RadiusAutoInfo from the site.

radiusautoidinteger int32required

The ID of a RadiusAutoInfo to remove from the site.

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/api/MFA/{id}/RadiusAutoInfo/{radiusautoid}'

204

401

404

No body

No Content