Administrators

List

get

Retrieve Admin Account(s).

Query parameters

NamestringOptional

Admin Account Name (optional)

Responses

200

Success

application/json; api-version=1.0

RAS Admin

idinteger · int32Optional

ID of the object.

adminCreatestring · nullableOptional

User who created the object.

adminLastModstring · nullableOptional

User who last modified the object.

timeCreatestring · date-timeOptional

Time when the object was created.

timeLastModstring · date-timeOptional

Time when the object was last modified.

namestring · nullableOptional

Parallels RAS administrator user or group name.

typestring · enumOptional

Admin Type

Possible values:

notifystring · enumOptional

Admin Notify

Possible values:

enabledbooleanOptional

Whether this administrator is enabled or disabled in the farm.

emailstring · nullableOptional

The user email address.

mobilestring · nullableOptional

The user mobile phone number.

groupNamestring · nullableOptional

Group name.

fullPermissionsbooleanOptional

Whether the "Full Permissions" option is enabled or disabled.

permissionsstring · enumOptional

Administrator type

Possible values:

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get/api/AdminAccount

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

[
  {
    "id": 1,
    "adminCreate": "text",
    "adminLastMod": "text",
    "timeCreate": "2026-01-01T00:00:00.000Z",
    "timeLastMod": "2026-01-01T00:00:00.000Z",
    "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

To create a new RAS administrator account

namestring · min: 1 · max: 255 · nullableRequired

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

emailstring · nullableOptional

The user email address.

mobilestring · min: 1 · max: 50 · 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

RAS Admin

idinteger · int32Optional

ID of the object.

adminCreatestring · nullableOptional

User who created the object.

adminLastModstring · nullableOptional

User who last modified the object.

timeCreatestring · date-timeOptional

Time when the object was created.

timeLastModstring · date-timeOptional

Time when the object was last modified.

namestring · nullableOptional

Parallels RAS administrator user or group name.

typestring · enumOptional

Admin Type

Possible values:

notifystring · enumOptional

Admin Notify

Possible values:

enabledbooleanOptional

Whether this administrator is enabled or disabled in the farm.

emailstring · nullableOptional

The user email address.

mobilestring · nullableOptional

The user mobile phone number.

groupNamestring · nullableOptional

Group name.

fullPermissionsbooleanOptional

Whether the "Full Permissions" option is enabled or disabled.

permissionsstring · enumOptional

Administrator type

Possible values:

401

Unauthorized

application/json; api-version=1.0

409

Conflict

application/json; api-version=1.0

post/api/AdminAccount

POST /api/AdminAccount HTTP/1.1
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": "2026-01-01T00:00:00.000Z",
  "timeLastMod": "2026-01-01T00:00:00.000Z",
  "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

RAS Admin

idinteger · int32Optional

ID of the object.

adminCreatestring · nullableOptional

User who created the object.

adminLastModstring · nullableOptional

User who last modified the object.

timeCreatestring · date-timeOptional

Time when the object was created.

timeLastModstring · date-timeOptional

Time when the object was last modified.

namestring · nullableOptional

Parallels RAS administrator user or group name.

typestring · enumOptional

Admin Type

Possible values:

notifystring · enumOptional

Admin Notify

Possible values:

enabledbooleanOptional

Whether this administrator is enabled or disabled in the farm.

emailstring · nullableOptional

The user email address.

mobilestring · nullableOptional

The user mobile phone number.

groupNamestring · nullableOptional

Group name.

fullPermissionsbooleanOptional

Whether the "Full Permissions" option is enabled or disabled.

permissionsstring · enumOptional

Administrator type

Possible values:

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get/api/AdminAccount/{id}

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

{
  "id": 1,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2026-01-01T00:00:00.000Z",
  "timeLastMod": "2026-01-01T00:00:00.000Z",
  "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

Update a RAS administrator account

emailstring · nullableOptional

Parallels RAS administrator email address.

mobilestring · max: 50 · 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

No content

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

put/api/AdminAccount/{id}

PUT /api/AdminAccount/{id} HTTP/1.1
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

No content

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

delete/api/AdminAccount/{id}

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

No content