Administrators

List

get

Retrieve Admin Account(s).

Query parameters

NamestringOptional

Admin Account Name (optional)

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

/api/AdminAccount

HTTPcURLJavaScriptPython

GET /api/AdminAccount HTTP/1.1
Host: 
Accept: */*

[
  {
    "id": 1,
    "adminCreate": "text",
    "adminLastMod": "text",
    "timeCreate": "2025-12-16T19:38:08.645Z",
    "timeLastMod": "2025-12-16T19:38:08.645Z",
    "name": "text",
    "type": [
      "0 = User",
      "1 = Group",
      "2 = UserGroup"
    ],
    "notify": [
      "0 = None",
      "1 = Email"
    ],
    "enabled": true,
    "email": "text",
    "mobile": "text",
    "groupName": "text",
    "fullPermissions": true,
    "permissions": [
      "0 = PowerAdmin",
      "1 = RootAdmin",
      "2 = CustomAdmin"
    ]
  }
]

Create

post

Create a new Admin Account.

Body

application/json; api-version=1.0

To create a new RAS administrator account

namestring | nullableRequired

The name of a user or group to add to the farm as an administrator.

emailstring | nullableOptional

The user email address.

mobilestring | nullableOptional

The user mobile phone number.

enabledbooleanOptional

Enables or disables this administrator in the farm.

notifystring · enumOptional

Admin Notify

Possible values:

permissionsstring · enumOptional

Administrator type

Possible values:

Responses

201

Created

application/json; api-version=1.0

401

Unauthorized

application/json; api-version=1.0

409

Conflict

application/json; api-version=1.0

post

/api/AdminAccount

HTTPcURLJavaScriptPython

POST /api/AdminAccount HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 162

{
  "name": "text",
  "email": "text",
  "mobile": "text",
  "enabled": true,
  "notify": [
    "0 = None",
    "1 = Email"
  ],
  "permissions": [
    "0 = PowerAdmin",
    "1 = RootAdmin",
    "2 = CustomAdmin"
  ]
}

{
  "id": 1,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2025-12-16T19:38:08.645Z",
  "timeLastMod": "2025-12-16T19:38:08.645Z",
  "name": "text",
  "type": [
    "0 = User",
    "1 = Group",
    "2 = UserGroup"
  ],
  "notify": [
    "0 = None",
    "1 = Email"
  ],
  "enabled": true,
  "email": "text",
  "mobile": "text",
  "groupName": "text",
  "fullPermissions": true,
  "permissions": [
    "0 = PowerAdmin",
    "1 = RootAdmin",
    "2 = CustomAdmin"
  ]
}

Get

get

Retrieve an Admin Account by ID.

Path parameters

idinteger · int32Required

Admin Account ID

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

/api/AdminAccount/{id}

HTTPcURLJavaScriptPython

GET /api/AdminAccount/{id} HTTP/1.1
Host: 
Accept: */*

{
  "id": 1,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2025-12-16T19:38:08.645Z",
  "timeLastMod": "2025-12-16T19:38:08.645Z",
  "name": "text",
  "type": [
    "0 = User",
    "1 = Group",
    "2 = UserGroup"
  ],
  "notify": [
    "0 = None",
    "1 = Email"
  ],
  "enabled": true,
  "email": "text",
  "mobile": "text",
  "groupName": "text",
  "fullPermissions": true,
  "permissions": [
    "0 = PowerAdmin",
    "1 = RootAdmin",
    "2 = CustomAdmin"
  ]
}

Update

put

Update Admin Account settings.

Path parameters

idinteger · int32Required

Admin Account ID

Body

application/json; api-version=1.0

Update a RAS administrator account

emailstring | nullableOptional

Parallels RAS administrator email address.

mobilestring | nullableOptional

Parallels RAS administrator mobile phone number.

enabledboolean | nullableOptional

Enable or disable the specified administrator account.

notifystring · enumOptional

Admin Notify

Possible values:

permissionsstring · enumOptional

Administrator type

Possible values:

Responses

204

No Content

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

put

/api/AdminAccount/{id}

HTTPcURLJavaScriptPython

PUT /api/AdminAccount/{id} HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 148

{
  "email": "text",
  "mobile": "text",
  "enabled": true,
  "notify": [
    "0 = None",
    "1 = Email"
  ],
  "permissions": [
    "0 = PowerAdmin",
    "1 = RootAdmin",
    "2 = CustomAdmin"
  ]
}

No content

Delete

delete

Deletes the Admin Account.

Path parameters

idinteger · int32Required

Admin Account ID

Query parameters

forceDeletebooleanOptional

Force Delete the Admin Account

Responses

204

No Content

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

delete

/api/AdminAccount/{id}

HTTPcURLJavaScriptPython

DELETE /api/AdminAccount/{id} HTTP/1.1
Host: 
Accept: */*

No content