Management API - Function Reference

Revision as of 15:15, 29 August 2014 by Ltalaschus (talk | contribs) (→‎Ping)

Global Functions

AttachStore

Arguments

Name Type
instanceID string
name string
path string
requestedState string (optional)

String Definition

requestedState

Value Affects
current Same as Normal but new messages will be archived in the archive store that is set to Current.
normal The content of archives store is available to users and can be modified if the user has the appropriate permission.
writeProtected The content of write protected archive stores is available to users, but cannot be modified (e.g. delete or move messages, rename or move folders)
disabled Disabled archive stores are not in use but the instance still knows about their existence. Therefore the content is not available to users.

CompactStore

Arguments

Name Type
instanceID string
id number

CreateClientAccessServer

Arguments

Name Type
config json

Config Object Definition

{
    "serverName": string,
    "port": number,
    "serverCertificate": {
        "thumbprint": string
    }
}

CreateClientOneTimeUrlForArchiveAdmin

Arguments

Name Type
instanceID string
instanceUrl string

CreateDirectoryOnInstanceHost

Arguments

Name Type
serverName string
path string

CreateInstance

Arguments

Name Type
config json

Config Object Definition

{
    "instanceID": string,
    "alias": string,
    "displayName": string,
    "instanceHost": string,
    "startMode": string,
    "baseDirectory" : string
    "debugLogEnabled": bool
    "vssWriterEnabled": bool
}

CreateInstanceHost

Arguments

Name Type
config json

Config Object Definition

{
    "serverName": string,
    "port": number,
    "serverCertificate": {
        "thumbprint": string
    }
}

CreateLicenseRequest

CreateStore

Arguments

Name Type
instanceID string
name string
path string
requestedState string (optional)

String Definition

requestedState

Value Affects
current Same as Normal but new messages will be archived in the archive store that is set to Current.
normal The content of archives store is available to users and can be modified if the user has the appropriate permission.
writeProtected The content of write protected archive stores is available to users, but cannot be modified (e.g. delete or move messages, rename or move folders)
disabled Disabled archive stores are not in use but the instance still knows about their existence. Therefore the content is not available to users.

CreateSystemAdministrator

Arguments

Name Type
config json
password string

Config Object Definition

{
    "userName": string
    "fullName": string,
}

DeleteClientAccessServer

Arguments

Name Type
serverName string

DeleteInstanceHost

Arguments

Name Type
serverName string

DeleteInstances

Arguments

Name Type
instanceFilter string

String Definition

instanceFilter

Value Affects
instance01 instance02 instance03 instance01, instance02 and instance03
* All instances
*instancehost01 *instancehost02 All instances on instancehost1 and instancehost2
* .running All running instances
* .safeMode All instances running in Safe Mode
* .safeMode .running All instances running in regular or Safe Mode
* .stopped All stopped instances

DeleteSystemAdministrator

Arguments

Name Type
userName string

DetachStore

Arguments

Name Type
instanceID string
id number

FreezeInstances

Arguments

Name Type
instanceFilter string

String Definition

instanceFilter

Value Affects
instance01 instance02 instance03 instance01, instance02 and instance03
* All instances
*instancehost01 *instancehost02 All instances on instancehost1 and instancehost2
* .running All running instances
* .safeMode All instances running in Safe Mode
* .safeMode .running All instances running in regular or Safe Mode
* .stopped All stopped instances

GetArchiveAdminEnabled

Arguments

Name Type
instanceID string

GetClientAccessServers

Arguments

Name Type
serverNameFilter string (optional)
withServiceStatus bool

String Definitions

serverNameFilter

Value Affects
Null All servers
serverName Only the given serverName. Must match exactly.

GetDirectoriesOnInstanceHost

Arguments

Name Type
serverName string
path string (optional)

GetEnvironmentInfo

Arguments

Name Type

GetIndexConfiguration

Arguments

Name Type
instanceID string

GetInstanceConfiguration

Arguments

Name Type
instanceID string

GetInstanceHosts

Arguments

Name Type
serverNameFilter string (optional)

String Definitions

serverNameFilter

Value Affects
Null All servers
serverName Only the given serverName. Must match exactly.

GetInstanceProcessLiveStatistics

Arguments

Name Type
instanceID string

GetInstances

Arguments

Name Type
instanceFilter string

String Definition

instanceFilter

Value Affects
instance01 instance02 instance03 instance01, instance02 and instance03
* All instances
*instancehost01 *instancehost02 All instances on instancehost1 and instancehost2
* .running All running instances
* .safeMode All instances running in Safe Mode
* .safeMode .running All instances running in regular or Safe Mode
* .stopped All stopped instances

GetInstanceStatistics

Arguments

Name Type
instanceID string

GetServiceStatus

GetStoreAutoCreateConfiguration

Arguments

Name Type
instanceID string

GetStores

Arguments

Name Type
instanceID string

GetSystemAdministrators

MaintainFileSystemDatabases

Arguments

Name Type
instanceID string

PairWithManagementServer

Arguments

Name Type
serverType string
serverName string
port number
thumbprint string

Ping

RebuildSelectedStoreIndexes

Arguments

Name Type
instanceID string

RefreshAllStoreStatistics

Arguments

Name Type
instanceID string

RenameStore

Arguments

Name Type
instanceID string
id number
name string

RestartInstances

Arguments

Name Type
instanceFilter string

String Definition

instanceFilter

Value Affects
instance01 instance02 instance03 instance01, instance02 and instance03
* All instances
*instancehost01 *instancehost02 All instances on instancehost1 and instancehost2
* .running All running instances
* .safeMode All instances running in Safe Mode
* .safeMode .running All instances running in regular or Safe Mode
* .stopped All stopped instances

RetryOpenStores

Arguments

Name Type
instanceID string

SelectAllStoreIndexesForRebuild

Arguments

Name Type
instanceID string

SetArchiveAdminEnabled

Arguments

Name Type
instanceID string
enabled bool

SetComplianceConfiguration

Arguments

Name Type
instanceID string
config json

Config Object Definition

{
    "adminEmailPreviewEnabled": bool,
    "globalRetentionTimeYears": number,
    "legalHoldEnabled": bool,
    "logSuccessfulUserActivities": array
}

Allowed values of logSuccessfulUserActivities array items are equal to the User Activity names at MailStore Client > Administrative Tools > Compliance > Auditing.

SetDirectoryServicesConfiguration

Arguments

Name Type
instanceID string
config json

Config Object Definition

Use GetDirectoryServicesConfiguration command after manual directory service configuration to retrieve the config object definition.

SetIndexConfiguration

Arguments

Name Type
instanceID string
config json

Config Object Definition

{
    "attachmentExtensions": string
}

SetInstanceConfiguration

Arguments

Name Type
config json

Config Object Definition

{
    "instanceID": string,
    "alias": string,
    "displayName": string,
    "instanceHost": string,
    "startMode": string,
    "baseDirectory": string,
    "debugLogEnabled": bool,
    "vssWriterEnabled": bool
}

SetStoreAutoCreateConfiguration

Arguments

Name Type
instanceID string
config json

Config Object Definition

{
    "enabled": bool,
    "interval": string,
    "sizeThreshold": string,
    "numberOfMessagesThreshold": number,
    "baseDirectory": string
}

SetStorePath

Arguments

Name Type
instanceID string
id number
path string

SetStoreRequestedState

Arguments

Name Type
instanceID string
id number
requestedState string

String Definition

requestedState

Value Affects
current Same as Normal but new messages will be archived in the archive store that is set to Current.
normal The content of archives store is available to users and can be modified if the user has the appropriate permission.
writeProtected The content of write protected archive stores is available to users, but cannot be modified (e.g. delete or move messages, rename or move folders)
disabled Disabled archive stores are not in use but the instance still knows about their existence. Therefore the content is not available to users.

SetSystemAdministratorPassword

Arguments

Name Type
userName string
password string

StartInstances

Arguments

Name Type
instanceFilter string

String Definition

instanceFilter

Value Affects
instance01 instance02 instance03 instance01, instance02 and instance03
* All instances
*instancehost01 *instancehost02 All instances on instancehost1 and instancehost2
* .running All running instances
* .safeMode All instances running in Safe Mode
* .safeMode .running All instances running in regular or Safe Mode
* .stopped All stopped instances

StopInstances

Arguments

Name Type
instanceFilter string

String Definition

instanceFilter

Value Affects
instance01 instance02 instance03 instance01, instance02 and instance03
* All instances
*instancehost01 *instancehost02 All instances on instancehost1 and instancehost2
* .running All running instances
* .safeMode All instances running in Safe Mode
* .safeMode .running All instances running in regular or Safe Mode
* .stopped All stopped instances

ThawInstances

Arguments

Name Type
instanceFilter string

String Definition

instanceFilter

Value Affects
instance01 instance02 instance03 instance01, instance02 and instance03
* All instances
*instancehost01 *instancehost02 All instances on instancehost1 and instancehost2
* .running All running instances
* .safeMode All instances running in Safe Mode
* .safeMode .running All instances running in regular or Safe Mode
* .stopped All stopped instances

UpdateClientAccessServerConfiguration

Arguments

Name Type
config json

Config Object Definition

{
    "serverName": string,
    "port": number,
    "serverCertificate": {
        "thumbprint": string
    }
}

UpdateInstanceHostConfiguration

Arguments

Name Type
config json


Config Object Definition

{
    "serverName": string,
    "port": number,
    "serverCertificate": {
        "thumbprint": string
    }
    "baseDirectory": string
}

UpdateSystemAdministratorConfiguration

Arguments

Name Type
config json


Config Object Definition

{
    "fullName": string,
    "passwordHash": string
}

UpgradeStore

Arguments

Name Type
instanceID string
id number

VerifyStore

Arguments

Name Type
instanceID string
id number

Instance Level Functions

Important Notice: In order to be able to call functions on instance level, the Service Provider Access must be enabled as described in Archive Access first.

ClearUserPrivilegesOnFolders

Arguments

Name Type
instanceID string
userName string

CreateProfile

Arguments

Name Type
instanceID string
properties json
raw bool

Properties Object Definition

To receive available profile properties create a profile of the desired type manually and use the GetProfiles function.

CreateUser

Arguments

Name Type
instanceID string
userName string
privileges string
fullName string (optional)
distinguishedName string (optional)
authentication string (optional)
password string (optional)

DeleteEmptyFolders

Arguments

Name Type
instanceID string
folder string (optional)

DeleteProfile

Arguments

Name Type
instanceID string
id number

DeleteUser

Arguments

Name Type
instanceID string
userName string

GetChildFolders

Arguments

Name Type
instanceID string
folder string (optional)
maxLevels number (optional)

GetComplianceConfiguration

Arguments

Name Type
instanceID string

GetDirectoryServicesConfiguration

Arguments

Name Type
instanceID string

GetFolderStatistics

Arguments

Name Type
instanceID string

GetProfiles

Arguments

Name Type
instanceID string
raw bool

GetTimeZones

Arguments

Name Type
instanceID string

GetUserInfo

Arguments

Name Type
instanceID string
userName string

GetUsers

Arguments

Name Type
instanceID string

GetWorkerResults

Arguments

Name Type
instanceID string
fromIncluding string
toExcluding string
timeZoneID string
profileID number (optional)
userName string (optional)

fromIncluding and toExcluding format

Value Format
fromIncluding and toExcluding YYYY-MM-DDT00:00:00 Example 2013-10-01T00:00:00

The timeZoneID can be gathered with the GetTimeZones command.

MoveFolder

Arguments

Name Type
instanceID string
fromFolder string
toFolder string

RenameUser

Arguments

Name Type
instanceID string
oldUserName string
newUserName string

RunProfile

Arguments

Name Type
instanceID string
id number

RunTemporaryProfile

Arguments

Name Type
instanceID string
properties json
raw bool

Properties Object Definition

To receive available profile properties create a profile of the desired type manually and use the GetProfiles function.

SetUserAuthentication

Arguments

Name Type
instanceID string
userName string
authentication string

SetUserDistinguishedName

Arguments

Name Type
instanceID string
userName string
distinguishedName string (optional)

SetUserEmailAddresses

Arguments

Name Type
instanceID string
userName string
emailAddresses string (optional)

SetUserFullName

Arguments

Name Type
instanceID string
userName string
fullName string (optional)

SetUserPassword

Arguments

Name Type
instanceID string
userName string
password string

SetUserPop3UserNames

Arguments

Name Type
instanceID string
userName string
pop3UserNames string (optional)

SetUserPrivileges

Arguments

Name Type
instanceID string
userName string
privileges string

SetUserPrivilegesOnFolder

Arguments

Name Type
instanceID string
userName string
folder string
privileges string

SyncUsersWithDirectoryServices

Arguments

Name Type
instanceID string
dryRun bool (optional)
Retrieved from "https://help.mailstore.com/en/spe/index.php?title=Management_API_-_Function_Reference&oldid=1104"