Session related methods
- postGet the challenge string for RSA authentication type
- postAuthenticates and returns authentication token that can be used for both webadmin and webclient
- postAuthenticates user in IceWarp server and creates his session
- postCreates user session by provided JWT token
- postAuthenticates user and creates JWT token for him
- postAuthenticates user and creates JWT token for him
- postThis method creates access and refresh token for user with session. It creates new JWT login into login table.
- postCreates access token for valid refreshtoken
- postLogouts refresh and access token
- postAuthenticates gateway account ( account that does not exist on current server , but hash some quarantine here )
- postAuthenticates using weblclient session id
- postAuthenticates using authentication token
- postAuthenticates using authentication SSO token
- postSends the authentication link ( with Hash ) to the email
- postGet user IM roster
- postGet user IM roster
- postImpersonate as another person and get its webclient session id Administrator can impersonate anyone Domain administrator can impersonate accounts from his domain
- postLogs the user out and destroy his session
- postResets 2 factor authorization for account given in Email parameter
- postResets 2 factor authorization for authenticated user
- postInfo about active session , see TAPISessionInfo for more details
- postAuthenticates and returns authentication token that can be used for both webadmin and webclient
- postReturns the authentication token for TeamChat for the currently logged in user
- postAuthenticates and returns authentication token that can be used for both webadmin and webclient
Server related methods
- postGets the rights for server properties
- postGets the values of server properties
- postSets the values of server properties
- postGets the list of server api variables, its values, data types and rights
- postGets the list of all api variables and its comments
Domain related methods
- postGet the informations about domains available in current session
- postDeletes the domain on IceWarp server
- postRenames the domain on IceWarp server
- postCreates the domain on IceWarp server
- postMakes the primary domain from one of the domains on IceWarp server
- postGets the rights for domain properties
- postGets the values of domain properties
- postSets the values of domain properties
- postGets the list of domain api variables, its values, data types and rights
- postGets the domain informations ( currently used for DNS valiadation only )
- postResets DKIM of domain
- postget new private_key for DKIM purposes
- postCheck if specified domain is external or local to this server
Account related methods
- postGet the list of informations about accounts in sepcified IceWarp domain
- postCreates an account in sepcified IceWarp domain
- postDeletes the list of accounts in sepcified IceWarp domain
- postDeletes all accounts that matches current filter in sepcified IceWarp domain
- postGets the properties of the existing IceWarp account
- postGets the properties of the existing IceWarp account ( limited to logged on user )
- postSets the properties of the existing IceWarp account
- postSets the properties of the existing IceWarp account ( limited to logged on user )
- postGets the list of IMAP and GroupWare folders in specified IceWarp account
- postGets the permission list for the folder specified by account email and folderid
- postSets the list of permissions for specified folder in existing IceWarp account
- postInherits the permissions of specified folder from higher level
- postInherits the permissions of specified folder from higher level
- postChanges the password of existing IceWarp account
- postGenerates the password of existing IceWarp account according to current Password policy
- postExpires the current password of existing IceWarp account
- postGenerates activation key for IceWarp account
- postSends the activation key for IceWarp account
- postMove specified accounts to other domain
- postAdds the members to the specified IceWarp account. Available for groups and mailing lists
- postEdits the members of the specified IceWarp account. Available for groups and mailing lists
- postEdits the rights for all members of the specified IceWarp account. Available for groups and mailing lists
- postAdds the members to the specified IceWarp account. Members are specified by IceWarp domain name and current account filter. Available for groups and mailing lists
- postDeletes the members from the specified IceWarp account. Available for groups and mailing lists
- postDeletes all members from the IceWarp account. Available for groups and mailing lists
- postGets the list of account api variables, its values, data types and rights
Rule related methods
- postGet the info list of server, domain or account rules
- postGet the info list of authenticated user rules
- postReturns detailed information about rule specified by Who and RuleID
- postReturns detailed information about my account rule specified by RuleID
- postCreates new rule from RuleSettings
- postCreates new rule in authenticated account from RuleSettings
- postEdits RuleSettings of existing rule specified by Id
- postEdits RuleSettings of existing my account rule specified by Id
- postDeletes existing rule specified by Id
- postDeletes existing my account rule specified by Id
- postMove specified Rule up or down
- postMove specified my account Rule up or down
- postSet rule active state
- postSet my rule active state
Device related methods
- postGet the info list of server, domain or account mobile devices
- postGets mobile device properties
- postSets mobile device properties
- postDeletes mobile device(s)
- postMarks selected mobile device for remote wipe
- postSets the specified mobile device status
- postDeletes the mobile devices that matches current Who and Filter
- postSets the status of all mobile devices that mathces current Who and Filter
Account mebers related methods
- postGet the info list of server, domain or account mobile devices
- postGets mobile device properties
- postSets account member properties
- postDeletes mobile device(s)
- postGets webclient setting properties
- postSets webclient settings resources
- postGets admin setting properties
- postSets admin settings resources
Service & statistics related methods
- postGets server statistic properties
- postGets the info list of IceWarp services
- postGet the statistics for specified IceWarp service
- postCheck if specified IceWarp service is running or not
- postStarts the specified IceWarp service
- postStops the specified IceWarp service
- postRestarts the specified IceWarp service
- postGets the traffic chart data for specified IceWarp service
Spam queues related methods
- postGets the spam queue list
- postAdds the item to the Spam Queues ( whitelist / blacklist )
- postDeletes the item from Spam Queues
- postDelivers the item in Spam Queue ( quarantine )
- postBlacklist the item in Spam Queue
- postWhitelist the item in Spam Queue
- postReturns the body of Spam Queue item
Certificate related methods
- postRertrieves the list of server certificates
- postAdd new server certificate (uploaded)
- postCreate new CSR / Server certificate
- postEdits existing server certificate
- postDeletes existing server certificate
- postSets the existing server certificate as default
- postReissues existing server certificate
- postExports existing server certificate
SmartDiscover related methods
- postSets new domain(host) value to all smartdiscover variables
License related methods
- postReturns license informations
SignUp related methods
- postReturns usage list of plans per domain or combined of all domains on server
- postCreates corresponding info when user is joined to existing meeting on remote server
- postReturns JWT Jitsi messaging token
- postPipe to GW AddMeetingInfo
- postPipe to GW GetMeetingInfo
- postCreates params for user statistics in CSV format export as URL
- postReturns secret data for license info passing
- postReturns callback URL used to revalidate license
- postSends a signup verification
- postCreates a new account on IceWarp server , Captcha protected
- postCheck if username is available in given domain - Domain has to be same as in invite session - Returns true if username is available in given domain - Requires invite session id
- postSends the reset password email that contains the link to reset the password, captcha protected
- postResets the password for account specified by email
- postChanges the password for account specified by email
- postSends the email to contact the server administrator
- postSends the guest confirmation email that contains the link to verify guest account It also sets fullname and password for guest account
- postVerifies the guest account
- postConfirmation of personality added using WebClient
- postReturns the captcha image as HTML (divtcha)
- postReturns license informations
OAuth related methods
- postRegister new OAuth client
- postRepresents function TAPISession.AddOauthClientWithId
- postReturns informations about registered OAuth client only if matches secret
- postReturns informations about registered OAuth client
- postReturns list of registered OAuth clients
- postAllows edit informations about registered OAuth client
- postRemoves OAuth client with all authorizations and tokens
- postReturns uri where client will be authorized for oauth by user.
- postReturns OAuth scopes.
- postBegins application authorization to access to user data.
- postIt checks if logged user already granted authorization to client in the past. If authorization is granted than authorization request is paired with already existing grant.
- postLogged user grants authorization to authorization request.
- postIt gets informations about users granted authorization.
- postIt removes authorization.
- postIt gets informations about authorization request.
- postIt stores generated access code to the authorization request.
- postIt gets informations about access code.
- postIt finishes authorization sequesnce and stores generated tokens.
- postIt gets informations about refresh token.
- postIt replaces access token with new one generated by refresh token. Old access token is deleted even if it is not expired.
- postRepresents function TAPISession.GetOauthClientRegistration
- postRepresents function TAPISession.VerifyOAuthTokenSignature
- postIt verifies token signature, validity and expiration.
- postRepresents function TAPISession.AuthorizedToIMQuery
- postRepresents function TAPISession.GetRestrictIPList
- postRepresents function TAPISession.SetRestrictIPList
- postReturns DNS zone file as base64 encoded string
- postChecks if base64 encode PEM certificate passed as parameter has all intermediate certificates and is not self-signed
- postNot published
- postRepresents function TAPISession.GetPassword
- postRepresents function TAPISession.GetActualEmail

IceWarp API (1.0.0)

Download OpenAPI specification:Download

API for IceWarp

Session related methods

Get the challenge string for RSA authentication type

Parameters

AuthType: Type of authentication ( plain, rsa, ... ) - see TAuthType

Returns

Authentication challegenge string ( currently RSA public key ) see TAuthChallenge

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/GetAuthChallenge

IceWarp API (https)

https://localhost:32001/icewarpapi/GetAuthChallenge

Authenticates and returns authentication token that can be used for both webadmin and webclient

Parameters

AuthType: Type of authentication ( plain, rsa, ... ) - see TAuthType
Email: Account username or email address - depends on server login policy
Password: Account plain text password
Digest: Account encrypted password
PersistentLogin: Specifies the session expiration - 1 day or 24 days

Returns

Authentication token

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/GetAuthToken

IceWarp API (https)

https://localhost:32001/icewarpapi/GetAuthToken

Authenticates user in IceWarp server and creates his session

Parameters

AuthType: Type of authentication ( plain, rsa, ... ) - see TAuthType
Email: Account username or email address - depends on server login policy
Password: Account plain text password
Digest: Account encrypted password
PersistentLogin: Specifies the session expiration - 1 day or 24 days

Returns

Session ID of authenticated user

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/Authenticate

IceWarp API (https)

https://localhost:32001/icewarpapi/Authenticate

Creates user session by provided JWT token

Parameters

Token: JWT token can be obtained with GetJWTToken method or OAuth token can be used

Returns

Session ID of authenticated user in sid and authentication token in result

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/AuthenticateJWT

IceWarp API (https)

https://localhost:32001/icewarpapi/AuthenticateJWT

Authenticates user and creates JWT token for him

Parameters

AuthType: Type of authentication ( plain, rsa, ... ) - see TAuthType
Email: Account username or email address - depends on server login policy
Password: Account plain text password
Digest: Account encrypted password

Returns

JWT token which can be used for creating session by calling AuthenticateJWT method

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/GetJWTToken

IceWarp API (https)

https://localhost:32001/icewarpapi/GetJWTToken

Authenticates user and creates JWT token for him

Parameters

AuthType: Type of authentication ( plain, rsa, ... ) - see TAuthType
Email: Account username or email address - depends on server login policy
Password: Account plain text password
Digest: Account encrypted password
ClientIdent: Custom client identification

Returns

JWT token which can be used for creating session by calling AuthenticateJWT method

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/LoginJWTToken

IceWarp API (https)

https://localhost:32001/icewarpapi/LoginJWTToken

This method creates access and refresh token for user with session. It creates new JWT login into login table.

Parameters

Returns

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/MakeJWTTokenLogin

IceWarp API (https)

https://localhost:32001/icewarpapi/MakeJWTTokenLogin

Creates access token for valid refreshtoken

Parameters

Returns

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/RefreshJWTToken

IceWarp API (https)

https://localhost:32001/icewarpapi/RefreshJWTToken

Logouts refresh and access token

Parameters

Returns

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/LogoutJWTToken

IceWarp API (https)

https://localhost:32001/icewarpapi/LogoutJWTToken

Authenticates gateway account ( account that does not exist on current server , but hash some quarantine here )

Parameters

Hash: Hash received in gateway authentication email

Returns

1 on success, 0 when there is some failiure

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/AuthenticateGateway

IceWarp API (https)

https://localhost:32001/icewarpapi/AuthenticateGateway

Authenticates using weblclient session id

Parameters

WebClientSessionID: WebClient Session ID

Returns

1 on success, 0 when there is some failiure

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/AuthenticateWebClient

IceWarp API (https)

https://localhost:32001/icewarpapi/AuthenticateWebClient

Authenticates using authentication token

Parameters

Token: Authentication token

Returns

1 on success, 0 when there is some failiure + SID

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/AuthenticateToken

IceWarp API (https)

https://localhost:32001/icewarpapi/AuthenticateToken

Authenticates using authentication SSO token

Parameters

SSOToken: Authentication sso token
Host: Host name

Returns

1 on success, 0 when there is some failiure + SID

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/AuthenticateSSO

IceWarp API (https)

https://localhost:32001/icewarpapi/AuthenticateSSO

Sends the authentication link ( with Hash ) to the email

Parameters

Email: Email of gateway account

Returns

1 on success, 0 when there is some failiure

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/SendGatewayAuthentication

IceWarp API (https)

https://localhost:32001/icewarpapi/SendGatewayAuthentication

Get user IM roster

Parameters

accountemail: email address of IceWarp account existing on server

Returns

1 on success, 0 when there is some failiure

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/GetAccountChatRoster

IceWarp API (https)

https://localhost:32001/icewarpapi/GetAccountChatRoster

Get user IM roster

Parameters

accountemail: email address of IceWarp account existing on server
withemail: roster contact email
from: if from is missing: infinity
to: if to is missing: current time

Returns

1 on success, 0 when there is some failiure

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/GetAccountChatHistory

IceWarp API (https)

https://localhost:32001/icewarpapi/GetAccountChatHistory

Impersonate as another person and get its webclient session id Administrator can impersonate anyone Domain administrator can impersonate accounts from his domain

Parameters

Email: Email of gateway account

Returns

1 on success, 0 when there is some failiure

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/ImpersonateWebClient

IceWarp API (https)

https://localhost:32001/icewarpapi/ImpersonateWebClient

Logs the user out and destroy his session

Parameters

Returns

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/Logout

IceWarp API (https)

https://localhost:32001/icewarpapi/Logout

Resets 2 factor authorization for account given in Email parameter

Parameters

Email: Full email address of account whose 2 factor setup will be reset

Returns

1 on success, 0 when there is some failiure

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/Reset2Factor

IceWarp API (https)

https://localhost:32001/icewarpapi/Reset2Factor

Resets 2 factor authorization for authenticated user

Parameters

Code: Two-factor code from existing token generator

Returns

1 on success, 0 when there is some failiure

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/ResetMy2Factor

IceWarp API (https)

https://localhost:32001/icewarpapi/ResetMy2Factor

Info about active session , see TAPISessionInfo for more details

Parameters

Returns

Info about active session , see TAPISessionInfo for more details

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/GetSessionInfo

IceWarp API (https)

https://localhost:32001/icewarpapi/GetSessionInfo

Authenticates and returns authentication token that can be used for both webadmin and webclient

Parameters

Email: Email

Returns

Authentication token

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/GetAvatarToken

IceWarp API (https)

https://localhost:32001/icewarpapi/GetAvatarToken

Returns the authentication token for TeamChat for the currently logged in user

Parameters

ExternalDeviceID: External deviceid for push notifications (the as TC API login "external_deviceid")

Returns

TeamChat token

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/AuthenticateTeamChatApi

IceWarp API (https)

https://localhost:32001/icewarpapi/AuthenticateTeamChatApi

Authenticates and returns authentication token that can be used for both webadmin and webclient

Parameters

AuthType: Type of authentication ( plain, rsa, ... ) - see TAuthType

Returns

Authentication token

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/GetAvatar

IceWarp API (https)

https://localhost:32001/icewarpapi/GetAvatar

Server related methods

Gets the rights for server properties

Parameters

ServerPropertyList: Specifies the server properties you want to get rights for

Returns

Server properties rights list ( see TPropertyRightList )

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/GetMyServerRights

IceWarp API (https)

https://localhost:32001/icewarpapi/GetMyServerRights

Gets the values of server properties

Parameters

ServerPropertyList: Specifies the list of variables you want to get

Returns

List of server properties with its values and rights ( see TPropertyValueList for more details )

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/GetServerProperties

IceWarp API (https)

https://localhost:32001/icewarpapi/GetServerProperties

Sets the values of server properties

Parameters

PropertyValueList: Specifies the list of variables you want to set with its values

Returns

1 on success, 0 when there is some failiure

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/SetServerProperties

IceWarp API (https)

https://localhost:32001/icewarpapi/SetServerProperties

Gets the list of server api variables, its values, data types and rights

Parameters

Filter: Filter for server api variables ( see TPropertyListFilter )
Offset: Specifies offset start of returned items
Count: Specifies count of returned items
Comments: Specifies if return comments or not

Returns

List of server api variables with its values and rights ( see TPropertyInfoList )

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/GetServerAPIConsole

IceWarp API (https)

https://localhost:32001/icewarpapi/GetServerAPIConsole

Gets the list of all api variables and its comments

Parameters

Returns

Info list about server api variables - only names and comments

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/GetAllAPIVariables

IceWarp API (https)

https://localhost:32001/icewarpapi/GetAllAPIVariables

Domain related methods

Get the informations about domains available in current session

Parameters

Filter: Domain list filter , see TDomainListFilter for more details
Offset: Specifies offset start of returned items
Count: Specifies count of returned items

Returns

Informational list of domains ( see TDomainsInfoList )

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/GetDomainsInfoList

IceWarp API (https)

https://localhost:32001/icewarpapi/GetDomainsInfoList

Deletes the domain on IceWarp server

Parameters

DomainStr: The name of the domain you want to delete

Returns

1 on success, 0 when there is some failiure

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/DeleteDomain

IceWarp API (https)

https://localhost:32001/icewarpapi/DeleteDomain

Renames the domain on IceWarp server

Parameters

OldName: The name of the domain you want to rename
NewName: New domain name

Returns

1 on success, 0 when there is some failiure

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/RenameDomain

IceWarp API (https)

https://localhost:32001/icewarpapi/RenameDomain

Creates the domain on IceWarp server

Parameters

DomainStr: New domain name
DomainProperties: Specifies the domain properties you want to store upon creating the domain

Returns

1 on success, 0 when there is some failiure

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/CreateDomain

IceWarp API (https)

https://localhost:32001/icewarpapi/CreateDomain

Makes the primary domain from one of the domains on IceWarp server

Parameters

DomainStr: New domain name
DomainProperties: Specifies the domain properties you want to store upon creating the domain

Returns

1 on success, 0 when there is some failiure

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/MakeDomainPrimary

IceWarp API (https)

https://localhost:32001/icewarpapi/MakeDomainPrimary

Gets the rights for domain properties

Parameters

DomainStr: Domain name
DomainPropertyList: Specifies the domains properties you want to get rights for

Returns

Domain properties rights list ( see TPropertyRightList )

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/GetMyDomainRigths

IceWarp API (https)

https://localhost:32001/icewarpapi/GetMyDomainRigths

Gets the values of domain properties

Parameters

DomainStr: Domain name
DomainPropertyList: Specifies the list of variables you want to get

Returns

List of domain properties with its values and rights ( see TPropertyValueList for more details )

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/GetDomainProperties

IceWarp API (https)

https://localhost:32001/icewarpapi/GetDomainProperties

Sets the values of domain properties

Parameters

DomainStr: Domain name
PropertyValueList: Specifies the list of variables you want to set with its values

Returns

1 on success, 0 when there is some failiure

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/SetDomainProperties

IceWarp API (https)

https://localhost:32001/icewarpapi/SetDomainProperties

Gets the list of domain api variables, its values, data types and rights

Parameters

DomainStr: Name of IceWarp domain existing on server
Filter: Filter for domain api variables ( see TPropertyListFilter )
Offset: Specifies offset start of returned items
Count: Specifies count of returned items
Comments: Specifies whether return comments or not ( Boolean )

Returns

List of domain api variables with its values and rights ( see TPropertyInfoList )

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/GetDomainAPIConsole

IceWarp API (https)

https://localhost:32001/icewarpapi/GetDomainAPIConsole

Gets the domain informations ( currently used for DNS valiadation only )

Parameters

DomainStr: Name of IceWarp domain existing on server

Returns

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/GetDomainInformations

IceWarp API (https)

https://localhost:32001/icewarpapi/GetDomainInformations

Resets DKIM of domain

Parameters

Domain: Domian name to reset DKIM for

Returns

1 on success, 0 when there is some failiure

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/ResetDKIM

IceWarp API (https)

https://localhost:32001/icewarpapi/ResetDKIM

get new private_key for DKIM purposes

Parameters

Returns

String with private key

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/DKIM_GeneratePrivateKey

IceWarp API (https)

https://localhost:32001/icewarpapi/DKIM_GeneratePrivateKey

Check if specified domain is external or local to this server

Parameters

DomainStr: Checked domain name

Returns

True when domain is external, False when it's local

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/IsGuestDomain

IceWarp API (https)

https://localhost:32001/icewarpapi/IsGuestDomain

Account related methods

Get the list of informations about accounts in sepcified IceWarp domain

Parameters

DomainStr: Name of IceWarp domain existing on server
Filter: Accounts list filter ( see TAccountListFilter )
Offset: Specifies offset start of returned items
Count: Specifies count of returned items

Returns

Informational list of accounts ( see TAccountsInfoList )

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/GetAccountsInfoList

IceWarp API (https)

https://localhost:32001/icewarpapi/GetAccountsInfoList

Creates an account in sepcified IceWarp domain

Parameters

DomainStr: Name of IceWarp domain existing on server
AccountProperties: List of account properties with its values you want to set upon creating an account

Returns

1 on success, 0 when there is some failiure

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/CreateAccount

IceWarp API (https)

https://localhost:32001/icewarpapi/CreateAccount

Deletes the list of accounts in sepcified IceWarp domain

Parameters

DomainStr: Name of IceWarp domain existing on server
AccountList: StringList of accounts you want to delete ( see TPropertyStringList )
LeaveData: Specifies if all account related data should be deleted or not

Returns

1 on success, 0 when there is some failiure

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/DeleteAccounts

IceWarp API (https)

https://localhost:32001/icewarpapi/DeleteAccounts

Deletes all accounts that matches current filter in sepcified IceWarp domain

Parameters

DomainStr: Name of IceWarp domain existing on server
Filter: Account list filter ( see TAccountListFilter )

Returns

1 on success, 0 when there is some failiure

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/DeleteAllAccounts

IceWarp API (https)

https://localhost:32001/icewarpapi/DeleteAllAccounts

Gets the properties of the existing IceWarp account

Parameters

AccountEmail: Email address of IceWarp account existing on server
AccountPropertyList: List of properties you want to get ( see TAccountPropertyList )
AccountPropertySet: Predefined list of properties( see TAccountPropertySet )

Returns

List of account properties with its values and rights ( see TPropertyValueList )

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/GetAccountProperties

IceWarp API (https)

https://localhost:32001/icewarpapi/GetAccountProperties

Gets the properties of the existing IceWarp account ( limited to logged on user )

Parameters

AccountPropertyList: List of properties you want to get ( see TAccountPropertyList )

Returns

List of account properties with its values and rights ( see TPropertyValueList )

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/GetMyProperties

IceWarp API (https)

https://localhost:32001/icewarpapi/GetMyProperties

Sets the properties of the existing IceWarp account

Parameters

AccountEmail: Name of IceWarp account existing on server
PropertyValueList: List of properties you want to set with its values ( see TPropertyValueList )
Filter: Account list filter ( see TAccountListFilter )

Returns

1 on success, 0 when there is some failiure

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/SetAccountProperties

IceWarp API (https)

https://localhost:32001/icewarpapi/SetAccountProperties

Sets the properties of the existing IceWarp account ( limited to logged on user )

Parameters

PropertyValueList: List of properties you want to set with its values ( see TPropertyValueList )

Returns

1 on success, 0 when there is some failiure

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/SetMyProperties

IceWarp API (https)

https://localhost:32001/icewarpapi/SetMyProperties

Gets the list of IMAP and GroupWare folders in specified IceWarp account

Parameters

AccountEmail: Email address of IceWarp account existing on server
OnlyDefault: If set to true ,only default folders are returned

Returns

List of folders in specified account( see TFolderInfo )

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/GetAccountFolderList

IceWarp API (https)

https://localhost:32001/icewarpapi/GetAccountFolderList

Gets the permission list for the folder specified by account email and folderid

Parameters

AccountEmail: Email address of IceWarp account existing on server
FolderId: Id of the folder in specified account

Returns

List of permissions for specified folder ( TFolderPermissions )

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/GetAccountFolderPermissions

IceWarp API (https)

https://localhost:32001/icewarpapi/GetAccountFolderPermissions

Sets the list of permissions for specified folder in existing IceWarp account

Parameters

AccountEmail: Email address of IceWarp account existing on server
FolderId: Id of the folder in specified account
Permissions: List of folder permissions ( see TFolderPermissions )

Returns

1 on success, 0 when there is some failiure

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/SetAccountFolderPermissions

IceWarp API (https)

https://localhost:32001/icewarpapi/SetAccountFolderPermissions

Inherits the permissions of specified folder from higher level

Parameters

AccountEmail: Email address of IceWarp account existing on server
FolderId: Id of the folder in specified account

Returns

1 on success, 0 when there is some failiure

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/InheritAccountFolderPermissions

IceWarp API (https)

https://localhost:32001/icewarpapi/InheritAccountFolderPermissions

Inherits the permissions of specified folder from higher level

Parameters

AccountEmail: Email address of IceWarp account existing on server
FolderId: Id of the folder in specified account

Returns

1 on success, 0 when there is some failiure

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/GetAccountAdministrativePermissions

IceWarp API (https)

https://localhost:32001/icewarpapi/GetAccountAdministrativePermissions

Changes the password of existing IceWarp account

Parameters

AccountEmail: Name of IceWarp account existing on server
AuthType: Type of authorization ( plain, RSA, ... ) see ( see TAuthType )
Password: Plain text password if type of authorization is plain
Digest: RSA encrypted password
IgnorePolicy: If set, the process ignores the current password policy

Returns

1 on success, 0 when there is some failiure

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/SetAccountPassword

IceWarp API (https)

https://localhost:32001/icewarpapi/SetAccountPassword

Generates the password of existing IceWarp account according to current Password policy

Parameters

Returns

Generated password

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/GenerateAccountPassword

IceWarp API (https)

https://localhost:32001/icewarpapi/GenerateAccountPassword

Expires the current password of existing IceWarp account

Parameters

AccountEmail: Name of IceWarp account existing on server
DisableNotification: If set to true, notification email about expiration is not sent to user as part of process

Returns

1 on success, 0 when there is some failiure

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/ExpireAccountPassword

IceWarp API (https)

https://localhost:32001/icewarpapi/ExpireAccountPassword

Generates activation key for IceWarp account

Parameters

AccountEmail: Email address of IceWarp account existing on server
KeyType: Specifies the type of generated key ( see TActivationKeyType )
Description: Description of generated key
Count: Number of allowed activations

Returns

Activation Key string

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/GenerateAccountActivationKey

IceWarp API (https)

https://localhost:32001/icewarpapi/GenerateAccountActivationKey

Sends the activation key for IceWarp account

Parameters

AccountEmail: Email address of IceWarp account existing on server
KeyType: Specifies the type of generated key ( see TActivationKeyType )
Description: Description of generated key
Count: Number of allowed activations

Returns

1 on success, 0 when there is some failiure

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/SendAccountActivationKey

IceWarp API (https)

https://localhost:32001/icewarpapi/SendAccountActivationKey

Move specified accounts to other domain

Parameters

AccountEmail: Email address of IceWarp account existing on server
DestDomain: Target address of IceWarp domain existing on server server

Returns

1 on success, 0 when there is some failiure

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/MoveAccountToDomain

IceWarp API (https)

https://localhost:32001/icewarpapi/MoveAccountToDomain

Adds the members to the specified IceWarp account. Available for groups and mailing lists

Parameters

AccountEmail: Email address of IceWarp account existing on server
Members: List of members you want to add ( see TPropertyMembers )

Returns

1 on success, 0 when there is some failiure

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/AddAccountMembers

IceWarp API (https)

https://localhost:32001/icewarpapi/AddAccountMembers

Edits the members of the specified IceWarp account. Available for groups and mailing lists

Parameters

AccountEmail: Email address of IceWarp account existing on server
Members: List of members you want to add ( see TPropertyMembers )

Returns

1 on success, 0 when there is some failiure

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/EditAccountMembers

IceWarp API (https)

https://localhost:32001/icewarpapi/EditAccountMembers

Edits the rights for all members of the specified IceWarp account. Available for groups and mailing lists

Parameters

AccountEmail: Email address of IceWarp account existing on server
Members: List of members you want to add ( see TPropertyMembers )

Returns

1 on success, 0 when there is some failiure

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/EditAllAccountMembersRights

IceWarp API (https)

https://localhost:32001/icewarpapi/EditAllAccountMembersRights

Adds the members to the specified IceWarp account. Members are specified by IceWarp domain name and current account filter. Available for groups and mailing lists

Parameters

AccountEmail: Email address of IceWarp account existing on server
DomainStr: Name of IceWarp domain existing on server
Filter: Account list filter ( see TAccountListFilter )

Returns

1 on success, 0 when there is some failiure

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/AddAllAccountMembers

IceWarp API (https)

https://localhost:32001/icewarpapi/AddAllAccountMembers

Deletes the members from the specified IceWarp account. Available for groups and mailing lists

Parameters

AccountEmail: Email address of IceWarp account existing on server
Members: List of members you want to delete ( see TPropertyMembers )

Returns

1 on success, 0 when there is some failiure

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/DeleteAccountMembers

IceWarp API (https)

https://localhost:32001/icewarpapi/DeleteAccountMembers

Deletes all members from the IceWarp account. Available for groups and mailing lists

Parameters

AccountEmail: Email address of IceWarp account existing on server
Filter: Account list filter ( see TAccountMemberListFilter )

Returns

1 on success, 0 when there is some failiure

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/DeleteAllAccountMembers

IceWarp API (https)

https://localhost:32001/icewarpapi/DeleteAllAccountMembers

Gets the list of account api variables, its values, data types and rights

Parameters

AccountEmail: Email address of IceWarp account existing on server
Filter: Filter for account api variables ( see TPropertyListFilter )
Offset: Specifies offset start of returned items
Count: Specifies count of returned items
Comments: Specifies whether return comments or not ( Boolean )

Returns

List of account api variables with its values and rights ( see TPropertyInfoList )

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/GetAccountAPIConsole

IceWarp API (https)

https://localhost:32001/icewarpapi/GetAccountAPIConsole

Rule related methods

Get the info list of server, domain or account rules

Parameters

Who: The value can be email address(account rules), domain name(domain rules) or empty string (server rules)
Filter: Rules list filter , see TRulesListFilter for more details
Offset: Specifies offset start of returned items
Count: Specifies count of returned items

Returns

Informational list of rules ( see TRulesInfoList )

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/GetRulesInfoList

IceWarp API (https)

https://localhost:32001/icewarpapi/GetRulesInfoList

Get the info list of authenticated user rules

Parameters

Filter: Rules list filter , see TRulesListFilter for more details
Offset: Specifies offset start of returned items
Count: Specifies count of returned items

Returns

Informational list of rules ( see TRulesInfoList )

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/GetMyRulesInfoList

IceWarp API (https)

https://localhost:32001/icewarpapi/GetMyRulesInfoList

Returns detailed information about rule specified by Who and RuleID

Parameters

Who: The value can be email address(account rules), domain name(domain rules) or empty string (server rules)
RuleID: Id of the rule

Returns

Detailed settings for current rule ( list of conditions, actions - see TRuleSettings )

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/GetRule

IceWarp API (https)

https://localhost:32001/icewarpapi/GetRule

Returns detailed information about my account rule specified by RuleID

Parameters

RuleID: Id of the rule

Returns

Detailed settings for current rule ( list of conditions, actions - see TRuleSettings )

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/GetMyRule

IceWarp API (https)

https://localhost:32001/icewarpapi/GetMyRule

Creates new rule from RuleSettings

Parameters

Who: The value can be email address(account rules), domain name(domain rules) or empty string (server rules)
RuleSettings: Detailed settings for current rule( see TRuleSettings )

Returns

1 on success, 0 when there is some failiure

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/AddRule

IceWarp API (https)

https://localhost:32001/icewarpapi/AddRule

Creates new rule in authenticated account from RuleSettings

Parameters

RuleSettings: Detailed settings for current rule( see TRuleSettings )

Returns

1 on success, 0 when there is some failiure

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/AddMyRule

IceWarp API (https)

https://localhost:32001/icewarpapi/AddMyRule

Edits RuleSettings of existing rule specified by Id

Parameters

Who: The value can be email address(account rules), domain name(domain rules) or empty string (server rules)
RuleSettings: Detailed settings for current rule( see TRuleSettings )
RuleID: Id of the rule

Returns

1 on success, 0 when there is some failiure

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/EditRule

IceWarp API (https)

https://localhost:32001/icewarpapi/EditRule

Edits RuleSettings of existing my account rule specified by Id

Parameters

RuleSettings: Detailed settings for current rule( see TRuleSettings )
RuleID: Id of the rule

Returns

1 on success, 0 when there is some failiure

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/EditMyRule

IceWarp API (https)

https://localhost:32001/icewarpapi/EditMyRule

Deletes existing rule specified by Id

Parameters

Who: The value can be email address(account rules), domain name(domain rules) or empty string (server rules)
RuleID: Id of the rule

Returns

1 on success, 0 when there is some failiure

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/DeleteRule

IceWarp API (https)

https://localhost:32001/icewarpapi/DeleteRule

Deletes existing my account rule specified by Id

Parameters

RuleID: Id of the rule

Returns

1 on success, 0 when there is some failiure

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/DeleteMyRule

IceWarp API (https)

https://localhost:32001/icewarpapi/DeleteMyRule

Move specified Rule up or down

Parameters

Who: The value can be email address(account rules), domain name(domain rules) or empty string (server rules)
RuleID: Id of the rule
MoveType: Specifies whether to move rule up(0) or down(1) - see TRuleMoveType

Returns

1 on success, 0 when there is some failiure

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/MoveRule

IceWarp API (https)

https://localhost:32001/icewarpapi/MoveRule

Move specified my account Rule up or down

Parameters

Who: The value can be email address(account rules), domain name(domain rules) or empty string (server rules)
RuleID: Id of the rule
MoveType: Specifies whether to move rule up(0) or down(1) - see TRuleMoveType

Returns

1 on success, 0 when there is some failiure

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/MoveMyRule

IceWarp API (https)

https://localhost:32001/icewarpapi/MoveMyRule

Set rule active state

Parameters

Who: The value can be email address(account rules), domain name(domain rules) or empty string (server rules)
RuleID: Id of the rule
State: 0 - active , 1 - disabled

Returns

1 on success, 0 when there is some failiure

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/SetRuleActive

IceWarp API (https)

https://localhost:32001/icewarpapi/SetRuleActive

Set my rule active state

Parameters

RuleID: Id of the rule
State: 0 - active , 1 - disabled

Returns

1 on success, 0 when there is some failiure

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/SetMyRuleActive

IceWarp API (https)

https://localhost:32001/icewarpapi/SetMyRuleActive

Device related methods

Get the info list of server, domain or account mobile devices

Parameters

Who: The value can be email address(account devices), domain name(domain devices) or empty string (server devices)
Filter: Mobile devices list filter ( see TMobileDeviceListFilter )
Offset: Specifies offset start of returned items
Count: Specifies count of returned items

Returns

Informational list of rules ( see TMobileDevicesInfoList )

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/GetDevicesInfoList

IceWarp API (https)

https://localhost:32001/icewarpapi/GetDevicesInfoList

Gets mobile device properties

Parameters

DeviceID: Id of mobile device
DevicePropertyList: List of properties you want to retrieve

Returns

Device property list with its values and rights

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/GetDeviceProperties

IceWarp API (https)

https://localhost:32001/icewarpapi/GetDeviceProperties

Sets mobile device properties

Parameters

DeviceID: Id of mobile device
PropertyValueList: List of properties you want to set with its values

Returns

1 on success, 0 when there is some failiure

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/SetDeviceProperties

IceWarp API (https)

https://localhost:32001/icewarpapi/SetDeviceProperties

Deletes mobile device(s)

Parameters

DevicesList: List of DeviceIDs to be deleted

Returns

1 on success, 0 when there is some failiure

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/DeleteDevices

IceWarp API (https)

https://localhost:32001/icewarpapi/DeleteDevices

Marks selected mobile device for remote wipe

Parameters

DeviceID: Id of mobile device
WipeType: Type of mobile device remote wipe ( see TMobileDeviceRemoteWipeSet )

Returns

1 on success, 0 when there is some failiure

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/SetDeviceWipe

IceWarp API (https)

https://localhost:32001/icewarpapi/SetDeviceWipe

Sets the specified mobile device status

Parameters

DeviceID: Id of mobile device
StatusType: Type of mobile status ( see TMobileDeviceStatusSet )

Returns

1 on success, 0 when there is some failiure

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/SetDeviceStatus

IceWarp API (https)

https://localhost:32001/icewarpapi/SetDeviceStatus

Deletes the mobile devices that matches current Who and Filter

Parameters

Who: The value can be email address(account devices), domain name(domain devices) or empty string (server devices)
Filter: Mobile devices list filter ( see TMobileDeviceListFilter )

Returns

1 on success, 0 when there is some failiure

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/DeleteAllDevices

IceWarp API (https)

https://localhost:32001/icewarpapi/DeleteAllDevices

Sets the status of all mobile devices that mathces current Who and Filter

Parameters

Who: The value can be email address(account devices), domain name(domain devices) or empty string (server devices)
Filter: Mobile devices list filter ( see TMobileDeviceListFilter )
StatusType: Type of mobile status ( see TMobileDeviceStatusSet )

Returns

1 on success, 0 when there is some failiure

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/SetAllDevicesStatus

IceWarp API (https)

https://localhost:32001/icewarpapi/SetAllDevicesStatus

Account mebers related methods

Get the info list of server, domain or account mobile devices

Parameters

Who: The value can be email address(account devices), domain name(domain devices) or empty string (server devices)
Filter: Mobile devices list filter ( see TMobileDeviceListFilter )
Offset: Specifies offset start of returned items
Count: Specifies count of returned items

Returns

Informational list of rules ( see TMobileDevicesInfoList )

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/GetAccountMemberInfoList

IceWarp API (https)

https://localhost:32001/icewarpapi/GetAccountMemberInfoList

Gets mobile device properties

Parameters

MemberID: Id of account member
AccountMemberPropertyList: List of properties you want to retrieve

Returns

Account member property list with its values and rights

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/GetAccountMemberProperties

IceWarp API (https)

https://localhost:32001/icewarpapi/GetAccountMemberProperties

Sets account member properties

Parameters

MemberID: Id of account member
PropertyValueList: List of properties you want to set with its values

Returns

1 on success, 0 when there is some failiure

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/SetAccountMemberProperties

IceWarp API (https)

https://localhost:32001/icewarpapi/SetAccountMemberProperties

Deletes mobile device(s)

Parameters

DevicesList: List of DeviceIDs to be deleted
Resource: Webclient resource name
Level: Level : 0 - Server, 1 - Domain, 2 - Account
Selector: Depends on Level : 0 - empty, 1 - Domain name, 2 - Account email address
Items: Optional filter on which variable names you want to get from selected resource name

Returns

1 on success, 0 when there is some failiure

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/GetWebmailResource

IceWarp API (https)

https://localhost:32001/icewarpapi/GetWebmailResource

Gets webclient setting properties

Parameters

Resources: List of webclient resrouces we want to get
Level: Level : 0 - Server, 1 - Domain, 2 - Account
Selector: Depends on Level : 0 - empty, 1 - Domain name, 2 - Account email address
Items: Optional filter on which variable names you want to get from selected resource name

Returns

Webclient setting resource ( see TWebmailSettingsResource )

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/GetWebmailResources

IceWarp API (https)

https://localhost:32001/icewarpapi/GetWebmailResources

Sets webclient settings resources

Parameters

Resources: Webclient resources to be set
Level: Level : 0 - Server, 1 - Domain, 2 - Account
Selector: Depends on Level : 0 - empty, 1 - Domain name, 2 - Account email address

Returns

1 on succes, 0 on failure

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/SetWebmailResources

IceWarp API (https)

https://localhost:32001/icewarpapi/SetWebmailResources

Gets admin setting properties

Parameters

Resources: Admin resource name
Level: Level : 0 - Server, 1 - Domain, 2 - Account
Selector: Depends on Level : 0 - empty, 1 - Domain name, 2 - Account email address
Items: Optional filter on which variable names you want to get from selected resource name

Returns

Webclient setting resource ( see TSettingsResource )

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/GetAdminResources

IceWarp API (https)

https://localhost:32001/icewarpapi/GetAdminResources

Sets admin settings resources

Parameters

Resources: Admin resources to be set
Level: Level : 0 - Server, 1 - Domain, 2 - Account
Selector: Depends on Level : 0 - empty, 1 - Domain name, 2 - Account email address
Value: Value we want to set

Returns

1 on succes, 0 on failure

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/SetAdminResources

IceWarp API (https)

https://localhost:32001/icewarpapi/SetAdminResources

Service & statistics related methods

Gets server statistic properties

Parameters

StatisticsPropertyList: List of statistics properties you want to retrieve

Returns

Statistics property list with its rights and values( see TPropertyValueList )

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/GetStatisticsProperties

IceWarp API (https)

https://localhost:32001/icewarpapi/GetStatisticsProperties

Gets the info list of IceWarp services

Parameters

Filter: Services list filter ( see TServiceListFilter )
Offset: Specifies offset start of returned items
Count: Specifies count of returned items

Returns

Info list of IceWarp services ( see TServicesInfoList )

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/GetServicesInfoList

IceWarp API (https)

https://localhost:32001/icewarpapi/GetServicesInfoList

Get the statistics for specified IceWarp service

Parameters

SType: Service type specification ( see TServiceType )

Returns

Statistic values for service of type SType

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/GetServiceStatistics

IceWarp API (https)

https://localhost:32001/icewarpapi/GetServiceStatistics

Check if specified IceWarp service is running or not

Parameters

Service: Service type specification ( see TServiceType )

Returns

1 if service is running , 0 if the service is stopped

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/IsServiceRunning

IceWarp API (https)

https://localhost:32001/icewarpapi/IsServiceRunning

Starts the specified IceWarp service

Parameters

Service: Service type specification ( see TServiceType )

Returns

1 on success, 0 when there is some failiure

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/StartService

IceWarp API (https)

https://localhost:32001/icewarpapi/StartService

Stops the specified IceWarp service

Parameters

Service: Service type specification ( see TServiceType )

Returns

1 on success, 0 when there is some failiure

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/StopService

IceWarp API (https)

https://localhost:32001/icewarpapi/StopService

Restarts the specified IceWarp service

Parameters

Service: Service type specification ( see TServiceType )

Returns

1 on success, 0 when there is some failiure

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/RestartService

IceWarp API (https)

https://localhost:32001/icewarpapi/RestartService

Gets the traffic chart data for specified IceWarp service

Parameters

SType: Service type specification ( see TServiceType )
ChartType: Type of traffic chart data ( see TServiceChartType )
Count: Number of points on x asis
Period: Interval Length ( see TServiceChartPeriod )
FFrom: Optional interval start (string datetime)
FTo: Optional interval end (string datetime)

Returns

1 on success, 0 when there is some failiure

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/GetTrafficCharts

IceWarp API (https)

https://localhost:32001/icewarpapi/GetTrafficCharts

Spam queues related methods

Gets the spam queue list

Parameters

QueueType: Queue type specification ( see TSpamQueueType )
Filter: Used to filter values in the list
Offset: Specifies offset start of returned items
Count: Specifies count of returned items

Returns

List of QueueType items that matches filter

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/GetSpamQueueInfoList

IceWarp API (https)

https://localhost:32001/icewarpapi/GetSpamQueueInfoList

Adds the item to the Spam Queues ( whitelist / blacklist )

Parameters

Info: Informations about item to be added

Returns

1 on success, 0 when there is some failiure

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/AddSpamQueueItem

IceWarp API (https)

https://localhost:32001/icewarpapi/AddSpamQueueItem

Deletes the item from Spam Queues

Parameters

ItemID: Spam Queue item ID

Returns

1 on success, 0 when there is some failiure

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/DeleteSpamQueueItem

IceWarp API (https)

https://localhost:32001/icewarpapi/DeleteSpamQueueItem

Delivers the item in Spam Queue ( quarantine )

Parameters

ItemID: Spam Queue item ID

Returns

1 on success, 0 when there is some failiure

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/DeliverSpamQueueItem

IceWarp API (https)

https://localhost:32001/icewarpapi/DeliverSpamQueueItem

Blacklist the item in Spam Queue

Parameters

ItemID: Spam Queue item ID

Returns

1 on success, 0 when there is some failiure

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/BlackListSpamQueueItem

IceWarp API (https)

https://localhost:32001/icewarpapi/BlackListSpamQueueItem

Whitelist the item in Spam Queue

Parameters

ItemID: Spam Queue item ID

Returns

1 on success, 0 when there is some failiure

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/WhiteListSpamQueueItem

IceWarp API (https)

https://localhost:32001/icewarpapi/WhiteListSpamQueueItem

Returns the body of Spam Queue item

Parameters

ItemID: Spam Queue item ID

Returns

1 on success, 0 when there is some failiure

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/GetSpamQueueItemBody

IceWarp API (https)

https://localhost:32001/icewarpapi/GetSpamQueueItemBody

Certificate related methods

Rertrieves the list of server certificates

Parameters

Returns

List of server certificates ( see TServerCertificateList )

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/GetServerCertificateList

IceWarp API (https)

https://localhost:32001/icewarpapi/GetServerCertificateList

Add new server certificate (uploaded)

Parameters

IPAddress: IP Address of the server certificate
Certificate: Certificate data (base64 encoded data string)
SetAsDefault: Tells the server if set this certificate as new default certificate (obsolete)

Returns

1 on success, 0 when there is some failiure

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/AddServerCertificate

IceWarp API (https)

https://localhost:32001/icewarpapi/AddServerCertificate

Create new CSR / Server certificate

Parameters

Certificate: Certificate request data (see TServerCertificateRequest)
SetAsDefault: Tells the server if set this certificate as new default certificate (obsolete)

Returns

1 on success, 0 when there is some failiure

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/CreateServerCertificate

IceWarp API (https)

https://localhost:32001/icewarpapi/CreateServerCertificate

Edits existing server certificate

Parameters

ID: Certificate ID
IPAddress: New IP Address
Certificate: New certificate data (base64 encoded data string)
SetAsDefault: Tells the server if set this certificate as new default certificate (obsolete)

Returns

1 on success, 0 when there is some failiure

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/EditServerCertificate

IceWarp API (https)

https://localhost:32001/icewarpapi/EditServerCertificate

Deletes existing server certificate

Parameters

ID: Certificate ID

Returns

1 on success, 0 when there is some failiure

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/DeleteServerCertificate

IceWarp API (https)

https://localhost:32001/icewarpapi/DeleteServerCertificate

Sets the existing server certificate as default

Parameters

ID: Certificate ID

Returns

1 on success, 0 when there is some failiure

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/SetDefaultServerCertificate

IceWarp API (https)

https://localhost:32001/icewarpapi/SetDefaultServerCertificate

Reissues existing server certificate

Parameters

ID: Certificate ID
Certificate: Certificate data
ReUse: Specifies whether to regenerate certificate private key(0) or use the old one(1)

Returns

1 on success, 0 when there is some failiure

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/ReissueServerCertificate

IceWarp API (https)

https://localhost:32001/icewarpapi/ReissueServerCertificate

Exports existing server certificate

Parameters

ID: Certificate ID

Returns

1 on success, 0 when there is some failiure

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/ExportServerCertificate

IceWarp API (https)

https://localhost:32001/icewarpapi/ExportServerCertificate

SmartDiscover related methods

Sets new domain(host) value to all smartdiscover variables

Parameters

HostName: New host ( domain )

Returns

1 on success, 0 when there is some failiure

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/SetSmartDiscoverHostname

IceWarp API (https)

https://localhost:32001/icewarpapi/SetSmartDiscoverHostname

License related methods

Returns license informations

Parameters

Returns

TAPILicenseInfo

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/GetLicenseInfo

IceWarp API (https)

https://localhost:32001/icewarpapi/GetLicenseInfo

SignUp related methods

Returns usage list of plans per domain or combined of all domains on server

Parameters

Returns

TAPITotalSaaSUsage

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/GetTotalSaaSUsage

IceWarp API (https)

https://localhost:32001/icewarpapi/GetTotalSaaSUsage

Creates corresponding info when user is joined to existing meeting on remote server

Parameters

MeetingID: meeting id eg '645714506@iwdemo.com'
Email: Email of user requesting token eg'. 'admin@domain.com'
MeetingUrl: username of user requesting token eg'. 'admin'
Organizer: meeting organizer
Summary: Title of the meeting
RecordingsUri: a recording service url
RecordingsApiUri: a recording service url

Returns

TAPIMeetingRemoteJoinedResult

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/MeetingRemoteJoined

IceWarp API (https)

https://localhost:32001/icewarpapi/MeetingRemoteJoined

Returns JWT Jitsi messaging token

Parameters

meetingID: meeting id eg '645714506@iwdemo.com'
username: username of user requesting token eg'. 'admin'
password: password to match with existing password set when starting meeting via AddMeetingInfo or empty
avatar: Avatar URL override, empty string if not used

Returns

TAPIJitsiJWT

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/GetJitsiJWT

IceWarp API (https)

https://localhost:32001/icewarpapi/GetJitsiJWT

Pipe to GW AddMeetingInfo

Parameters

Returns

TAPIAddMeetingInfoResult

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/GWAddMeetingInfo

IceWarp API (https)

https://localhost:32001/icewarpapi/GWAddMeetingInfo

Pipe to GW GetMeetingInfo

Parameters

Returns

TAPIGetMeetingInfoResult

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/GWGetMeetingInfo

IceWarp API (https)

https://localhost:32001/icewarpapi/GWGetMeetingInfo

Creates params for user statistics in CSV format export as URL

Parameters

datefrom: range start date in format YYYY/MM/DD
dateto: range end date in format YYYY/MM/DD
filter: * or domain/user eg. domain.com, user@domain.com
maxitems: max items count returned
groupbydomain: if set, results will be returned summed by domain, not per user account

Returns

AnsiString

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/GetUserStats

IceWarp API (https)

https://localhost:32001/icewarpapi/GetUserStats

Returns secret data for license info passing

Parameters

Returns

TAPILicenseManagementSecret

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/GetLicenseManagementSecret

IceWarp API (https)

https://localhost:32001/icewarpapi/GetLicenseManagementSecret

Returns callback URL used to revalidate license

Parameters

Returns

GetLicenseManagementCallbackURL

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/GetLicenseManagementCallbackURL

IceWarp API (https)

https://localhost:32001/icewarpapi/GetLicenseManagementCallbackURL

Sends a signup verification

Parameters

Returns

TAPILicenseInfo

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/SendSignupVerification

IceWarp API (https)

https://localhost:32001/icewarpapi/SendSignupVerification

Creates a new account on IceWarp server , Captcha protected

Parameters

Returns

TAPILicenseInfo

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/SignupAccount

IceWarp API (https)

https://localhost:32001/icewarpapi/SignupAccount

Check if username is available in given domain - Domain has to be same as in invite session - Returns true if username is available in given domain - Requires invite session id

Check if username is available in given domain

Domain has to be same as in invite session
Returns true if username is available in given domain
Requires invite session id

Parameters

Returns

TAPILicenseInfo

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/UsernameAvailable

IceWarp API (https)

https://localhost:32001/icewarpapi/UsernameAvailable

Sends the reset password email that contains the link to reset the password, captcha protected

Parameters

Returns

TAPILicenseInfo

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/ResetPasswordEmail

IceWarp API (https)

https://localhost:32001/icewarpapi/ResetPasswordEmail

Resets the password for account specified by email

Parameters

Returns

TAPILicenseInfo

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/ResetPassword

IceWarp API (https)

https://localhost:32001/icewarpapi/ResetPassword

Changes the password for account specified by email

Parameters

Returns

TAPILicenseInfo

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/ChangePassword

IceWarp API (https)

https://localhost:32001/icewarpapi/ChangePassword

Sends the email to contact the server administrator

Parameters

Returns

TAPILicenseInfo

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/ContactAdministrator

IceWarp API (https)

https://localhost:32001/icewarpapi/ContactAdministrator

Sends the guest confirmation email that contains the link to verify guest account It also sets fullname and password for guest account

Parameters

Returns

TAPILicenseInfo

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/GuestConfirm

IceWarp API (https)

https://localhost:32001/icewarpapi/GuestConfirm

Verifies the guest account

Parameters

Returns

TAPILicenseInfo

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/GuestVerify

IceWarp API (https)

https://localhost:32001/icewarpapi/GuestVerify

Confirmation of personality added using WebClient

Parameters

Returns

TAPILicenseInfo

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/ConfirmPersonality

IceWarp API (https)

https://localhost:32001/icewarpapi/ConfirmPersonality

Returns the captcha image as HTML (divtcha)

Parameters

Returns

TAPILicenseInfo

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/GetCaptcha

IceWarp API (https)

https://localhost:32001/icewarpapi/GetCaptcha

Returns license informations

Parameters

Returns

TAPILicenseInfo

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/ManageCloudLicense

IceWarp API (https)

https://localhost:32001/icewarpapi/ManageCloudLicense

OAuth related methods

Register new OAuth client

Parameters

Returns

New client id and secret

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/AddOauthClient

IceWarp API (https)

https://localhost:32001/icewarpapi/AddOauthClient

Represents function TAPISession.AddOauthClientWithId

Represents function TAPISession.AddOauthClientWithId

Parameters

Returns

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/AddOauthClientWithId

IceWarp API (https)

https://localhost:32001/icewarpapi/AddOauthClientWithId

Returns informations about registered OAuth client only if matches secret

Parameters

Returns

TAPIOauthClientInfo

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/OauthVerifySecret

IceWarp API (https)

https://localhost:32001/icewarpapi/OauthVerifySecret

Returns informations about registered OAuth client

Parameters

Returns

TAPIOauthClientInfo

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/GetOauthClientInfo

IceWarp API (https)

https://localhost:32001/icewarpapi/GetOauthClientInfo

Returns list of registered OAuth clients

Parameters

Returns

List of OAuht clients

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/GetOauthClients

IceWarp API (https)

https://localhost:32001/icewarpapi/GetOauthClients

Allows edit informations about registered OAuth client

Parameters

Returns

TAPIOauthNewClientResult. In case that auth type is not changed or new type does not require secret than empty secret is returned. When type is changed to standard OAuth application than new secret is returned.

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/EditOauthClient

IceWarp API (https)

https://localhost:32001/icewarpapi/EditOauthClient

Removes OAuth client with all authorizations and tokens

Parameters

Returns

True on success

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/RemoveOauthClient

IceWarp API (https)

https://localhost:32001/icewarpapi/RemoveOauthClient

Returns uri where client will be authorized for oauth by user.

Parameters

Returns

AnsiString

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/GetOauthAuthorizationUri

IceWarp API (https)

https://localhost:32001/icewarpapi/GetOauthAuthorizationUri

Returns OAuth scopes.

Parameters

Returns

List of scopes

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/GetOauthScopes

IceWarp API (https)

https://localhost:32001/icewarpapi/GetOauthScopes

Begins application authorization to access to user data.

Parameters

Returns

Id of authorization request

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/StartOauthAuthorizationRequest

IceWarp API (https)

https://localhost:32001/icewarpapi/StartOauthAuthorizationRequest

It checks if logged user already granted authorization to client in the past. If authorization is granted than authorization request is paired with already existing grant.

Parameters

Returns

Boolean

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/OauthAuthorizationExists

IceWarp API (https)

https://localhost:32001/icewarpapi/OauthAuthorizationExists

Logged user grants authorization to authorization request.

Parameters

Returns

Boolean

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/GrantOauthAuthorization

IceWarp API (https)

https://localhost:32001/icewarpapi/GrantOauthAuthorization

It gets informations about users granted authorization.

Parameters

Returns

List of users authorizations

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/GetOauthAuthorizations

IceWarp API (https)

https://localhost:32001/icewarpapi/GetOauthAuthorizations

It removes authorization.

Parameters

Returns

True on success

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/RemoveOauthAuthorization

IceWarp API (https)

https://localhost:32001/icewarpapi/RemoveOauthAuthorization

It gets informations about authorization request.

Parameters

Returns

TAPIOauthRequestInfo

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/GetOauthAuthorizationRequest

IceWarp API (https)

https://localhost:32001/icewarpapi/GetOauthAuthorizationRequest

It stores generated access code to the authorization request.

Parameters

Returns

Boolean

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/SaveOauthAccessCode

IceWarp API (https)

https://localhost:32001/icewarpapi/SaveOauthAccessCode

It gets informations about access code.

Parameters

Returns

TAPIOauthAccessCode

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/GetOauthAccessCode

IceWarp API (https)

https://localhost:32001/icewarpapi/GetOauthAccessCode

It finishes authorization sequesnce and stores generated tokens.

Parameters

Returns

Boolean

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/SaveOauthTokens

IceWarp API (https)

https://localhost:32001/icewarpapi/SaveOauthTokens

It gets informations about refresh token.

Parameters

Returns

TAPIOauthTokenInfo

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/GetOauthRefreshToken

IceWarp API (https)

https://localhost:32001/icewarpapi/GetOauthRefreshToken

It replaces access token with new one generated by refresh token. Old access token is deleted even if it is not expired.

Parameters

Returns

Boolean

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/ReplaceOauthAccessToken

IceWarp API (https)

https://localhost:32001/icewarpapi/ReplaceOauthAccessToken

Represents function TAPISession.GetOauthClientRegistration

Represents function TAPISession.GetOauthClientRegistration

Parameters

Returns

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/GetOauthClientRegistration

IceWarp API (https)

https://localhost:32001/icewarpapi/GetOauthClientRegistration

Represents function TAPISession.VerifyOAuthTokenSignature

Represents function TAPISession.VerifyOAuthTokenSignature

Parameters

Returns

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/VerifyOAuthTokenSignature

IceWarp API (https)

https://localhost:32001/icewarpapi/VerifyOAuthTokenSignature

It verifies token signature, validity and expiration.

Parameters

Returns

Boolean

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/VerifyJWTToken

IceWarp API (https)

https://localhost:32001/icewarpapi/VerifyJWTToken

Represents function TAPISession.AuthorizedToIMQuery

Represents function TAPISession.AuthorizedToIMQuery

Parameters

Returns

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/AuthorizedToIMQuery

IceWarp API (https)

https://localhost:32001/icewarpapi/AuthorizedToIMQuery

Represents function TAPISession.GetRestrictIPList

Represents function TAPISession.GetRestrictIPList

Parameters

Returns

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/GetRestrictIPList

IceWarp API (https)

https://localhost:32001/icewarpapi/GetRestrictIPList

Represents function TAPISession.SetRestrictIPList

Represents function TAPISession.SetRestrictIPList

Parameters

Returns

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/SetRestrictIPList

IceWarp API (https)

https://localhost:32001/icewarpapi/SetRestrictIPList

Returns DNS zone file as base64 encoded string

Parameters

Returns

Ansistring

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/GetDNSZoneFile

IceWarp API (https)

https://localhost:32001/icewarpapi/GetDNSZoneFile

Checks if base64 encode PEM certificate passed as parameter has all intermediate certificates and is not self-signed

Parameters

Returns

Verification result code

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/VerifyCertificateChain

IceWarp API (https)

https://localhost:32001/icewarpapi/VerifyCertificateChain

Not published

Parameters

Returns

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/CreateOAuthSignedToken

IceWarp API (https)

https://localhost:32001/icewarpapi/CreateOAuthSignedToken

Represents function TAPISession.GetPassword

Represents function TAPISession.GetPassword

Parameters

Returns

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/GetPassword

IceWarp API (https)

https://localhost:32001/icewarpapi/GetPassword

Represents function TAPISession.GetActualEmail

Represents function TAPISession.GetActualEmail

Parameters

Returns

Request Body schema: application/xml

sid	string
	object

Responses

IceWarp API (http)

http://localhost:32000/icewarpapi/GetActualEmail

IceWarp API (https)

https://localhost:32001/icewarpapi/GetActualEmail