Kerio Connect Administration API

https://manuals.gfi.com/en/kerio/api/connect/admin/reference/
Admin
Kerio Connect Administration API is a JSON-RPC 2.0 based API for programmatic administration of...
Tokens:214,936
Snippets:2,457
Trust Score:9.4
Update:5 months ago
Show doc for...
Tokens:
Raw
### start

Source: https://manuals.gfi.com/en/kerio/api/connect/admin/reference/interfacekerio_1_1jsonapi_1_1admin_1_1_migration.html

Start a new migration task.

```APIDOC
## start

### Description
Start a new migration task.

### Method
void

### Parameters
#### Path Parameters
- **errors** (kerio::web::ErrorList) - out - error message list
- **result** (kerio::web::CreateResultList) - out
- **userIds** (kerio::web::KIdList) - in - users to be migrated

### Request Example
```json
{
  "errors": "",
  "result": [],
  "userIds": []
}
```

### Response
#### Success Response (void)
Initiates a migration task and returns any errors encountered and creation results.
```

--------------------------------

### Get Domains Example in PHP

Source: https://manuals.gfi.com/en/kerio/api/connect/admin/reference/example_php.html

This snippet shows how to authenticate with the Kerio Connect API, retrieve a list of domains, and then log out. Ensure you have the kerio-api-php library included and valid login credentials.

```php
<?php
require_once(dirname(__FILE__) . '/src/KerioConnectApi.php');
$api = new KerioConnectApi("Get domains example", "Kerio Technologies s.r.o.", "1.0");
try {
$session = $api->login($hostname, $username, $password);
/* Get domains */
$params = array(
"query" => array(
"fields" => array(
"id",
"name",
"description",
"aliasList",
"userMaxCount",
"outgoingMessageLimit",
"isPrimary",
"renameInfo",
"forwardingOptions",
"kerberosRealm",
"winNtName",
"ipAddressBind",
"pamRealm",
"keepForRecovery",
"isDistributed"),
"start" => 0,
"limit" => -1,
"orderBy" => array(array(
"columnName" => "name",
"direction" => "Asc"
))
)
);
$result = $api->sendRequest('Domains.get', $params);
foreach ($result['list'] as $domain) {
printf("%s\n", $domain['name']);
}
} catch (KerioApiException $error) {
print $error->getMessage();
}
if (isset($session)) {
$api->logout();
}

```

--------------------------------

### Start Backup

Source: https://manuals.gfi.com/en/kerio/api/connect/admin/reference/interfacekerio_1_1jsonapi_1_1admin_1_1_backup-members.html

Initiates a backup process.

```APIDOC
## start

### Description
Starts a backup process.

### Method
POST (assumed, based on 'start' prefix and 'in' parameter)

### Endpoint
/backup/start

### Parameters
#### Request Body
- **backupType** (BackupType) - The type of backup to start.
```

--------------------------------

### start

Source: https://manuals.gfi.com/en/kerio/api/connect/admin/reference/_product_registration_8idl_source.html

Starts registration process. Methods connect to a server and obtain an identification token and a security image.

```APIDOC
## start

### Description
Starts registration process. Methods connect to a server and obtain an identification token and a security image.

### Method
void

### Parameters
#### In Parameters
- **langId** (string) - Required - language id
#### Out Parameters
- **token** (string) - Output - ID of wizard's session
- **image** (string) - Output - URL of the image with the security code
- **showImage** (boolean) - Output - show captcha image in wizard if true
```

--------------------------------

### Start Service

Source: https://manuals.gfi.com/en/kerio/api/connect/admin/reference/interfacekerio_1_1jsonapi_1_1admin_1_1_services-members.html

Starts a specified service.

```APIDOC
## start

### Description
Starts a specified service.

### Method
POST (assumed, based on 'start' operation)

### Endpoint
/services/{serviceId}/start

### Parameters
#### Path Parameters
- **service** (kerio::web::KId) - Required - The ID of the service to start.

### Request Body
(Not explicitly defined, but the 'service' parameter is passed in)

### Response
#### Success Response (200)
(No specific success response fields defined)
```

--------------------------------

### Start Service

Source: https://manuals.gfi.com/en/kerio/api/connect/admin/reference/interfacekerio_1_1jsonapi_1_1admin_1_1_services.html

Starts a specified service.

```APIDOC
## start

### Description
Start a given service.

### Method
POST

### Endpoint
/services/{serviceId}/start

### Parameters
#### Path Parameters
- **service** (kerio::web::KId) - Required - unique service identifier

#### Query Parameters
None

#### Request Body
None

### Response
#### Success Response (200)
- None (typically returns 204 No Content or a success message)

### Response Example
```json
{
  "message": "Service started successfully."
}
```
```

--------------------------------

### Get Certificates

Source: https://manuals.gfi.com/en/kerio/api/connect/admin/reference/interfacekerio_1_1jsonapi_1_1admin_1_1_connect_certificate-members.html

Retrieves a list of all certificates installed on the system.

```APIDOC
## get

### Description
Retrieves a list of certificates.

### Method
GET

### Endpoint
/admin/connect/certificate

### Response
#### Success Response (200)
- **certificates** (CertificateList) - A list of certificates.
```

--------------------------------

### start

Source: https://manuals.gfi.com/en/kerio/api/connect/admin/reference/_migration_8idl_source.html

Initiates a new migration task for a specified list of users.

```APIDOC
/**
 * Start a new migration task.
 *
 * @param errors - error message list
 * @param result
 * @param userIds - users to be migrated
 */
void start(out kerio::web::ErrorList errors, out kerio::web::CreateResultList result, in kerio::web::KIdList userIds);
```

--------------------------------

### get

Source: https://manuals.gfi.com/en/kerio/api/connect/admin/reference/interfacekerio_1_1web_1_1_unity_sign_on-members.html

Retrieves the current SignOn settings.

```APIDOC
## get

### Description
Retrieves the current SignOn settings.

### Method
GET (assumed, based on 'get' operation)

### Endpoint
/unitysignon/settings

### Parameters
#### Path Parameters
None

#### Query Parameters
None

### Request Body
None

### Response
#### Success Response (200)
- **settings** (SignOn) - The current SignOn settings.

### Response Example
```json
{
  "settings": {
    "someField": "someValue"
  }
}
```
```

--------------------------------

### Start Service

Source: https://manuals.gfi.com/en/kerio/api/connect/admin/reference/_services_8idl_source.html

Starts a specified service identified by its unique ID.

```APIDOC
## start

### Description
Start a given service.

### Method
POST (implied by IDL interface)

### Endpoint
/services/{serviceId}/start

### Parameters
#### Path Parameters
- **service** (kerio::web::KId) - Required - unique service identifier

### Request Body
None

### Response
#### Success Response (200)
None
```

--------------------------------

### get

Source: https://manuals.gfi.com/en/kerio/api/connect/admin/reference/_connect_certificate_8idl_source.html

Retrieves a list of all currently configured certificates.

```APIDOC
## get

### Description
Obtains a list of all certificates.

### Method
get

### Parameters
#### Query Parameters
- **certificates** (CertificateList) - Output - The list of certificates.
```

--------------------------------

### start

Source: https://manuals.gfi.com/en/kerio/api/connect/admin/reference/interfacekerio_1_1web_1_1_product_registration-members.html

Initiates the product registration process, returning a token and potentially an image for display.

```APIDOC
## start

### Description
Starts the product registration process.

### Method
[Method Signature]

### Parameters
#### Input Parameters
- **langId** (string) - Required - The language ID for the registration process.

#### Output Parameters
- **token** (string) - Output - The token for subsequent registration steps.
- **image** (string) - Output - An image to be displayed during registration, if any.
- **showImage** (boolean) - Output - Indicates whether the image should be shown.
```

--------------------------------

### start

Source: https://manuals.gfi.com/en/kerio/api/connect/admin/reference/interfacekerio_1_1web_1_1_product_registration.html

Initiates the product registration process, returning a token and an image for security verification.

```APIDOC
## start

### Description
Initiates the product registration process. It returns a token to identify the registration session and an image for security verification.

### Method
void

### Parameters
#### Output Parameters
- **token** (string) - A token to identify the registration session.
- **image** (string) - An image for security verification.
- **showImage** (boolean) - Indicates whether the image should be displayed.

#### Input Parameters
- **langId** (string) - The language identifier for the registration process.
```

--------------------------------

### get

Source: https://manuals.gfi.com/en/kerio/api/connect/admin/reference/interfacekerio_1_1web_1_1_product_registration.html

Retrieves existing product registration data from the server.

```APIDOC
## get

### Description
Retrieves existing registration data from the server.

### Parameters
- **registrationInfo** (out Registration) - The registration data related to the license ID.
- **newRegistration** (out boolean) - Flag indicates whether the registration has already existed.
- **token** (string) - Required - ID of wizard's session
- **securityCode** (string) - Required - A code number from the security image
- **baseId** (string) - Required - License ID
- **trial** (out boolean) - Trial ID registered on web, do not display registrationInfo and finish immediately.
```

--------------------------------

### get

Source: https://manuals.gfi.com/en/kerio/api/connect/admin/reference/interfacekerio_1_1jsonapi_1_1admin_1_1_migration.html

Obtain a list of migration tasks.

```APIDOC
## get

### Description
Obtain list of migration tasks.

### Method
void

### Parameters
#### Path Parameters
- **list** (MigrationTaskList) - out - migration tasks
- **totalItems** (long) - out - total number of tasks
- **query** (kerio::web::SearchQuery) - in - query attributes and limits

### Request Example
```json
{
  "list": "",
  "totalItems": 0,
  "query": {}
}
```

### Response
#### Success Response (void)
Returns migration tasks and total item count.
```

--------------------------------

### finish

Source: https://manuals.gfi.com/en/kerio/api/connect/admin/reference/_product_registration_8idl_source.html

The Method finishes registration and installs the valid licenseKey.

```APIDOC
## finish

### Description
The Method finishes registration and installs the valid licenseKey.

### Method
void

### Parameters
#### In Parameters
- **token** (string) - Required - ID of wizard's session
- **baseId** (string) - Required - Base ID of registration
- **registrationInfo** (Registration) - Required - Registration data retrieved from server by getRegistrationInfo() and modified by user.
- **finishType** (RegistrationFinishType) - Required - how to finish the registration? Create a new one, modyfy an existing or just download an existing license?
```

--------------------------------

### get

Source: https://manuals.gfi.com/en/kerio/api/connect/admin/reference/interfacekerio_1_1jsonapi_1_1admin_1_1_instant_messaging-members.html

Retrieves the current XMPP settings.

```APIDOC
## get

### Description
Retrieves the current XMPP settings.

### Parameters
None

### Response
#### Success Response (200)
- **settings** (XmppSettings) - The current XMPP settings.
```

--------------------------------

### getDownloadProgress

Source: https://manuals.gfi.com/en/kerio/api/connect/admin/reference/_server_8idl_source.html

Retrieves the progress of the installation package download.

```APIDOC
## getDownloadProgress

### Description
Retrieves the progress of the installation package download.

### Parameters
#### Path Parameters
- **progress** (long) - Output - Download progress in percents (0-100).
```

--------------------------------

### Start Backup

Source: https://manuals.gfi.com/en/kerio/api/connect/admin/reference/_backup_8idl_source.html

Initiates a backup operation with the specified backup type.

```APIDOC
## start

### Description
Initiates a backup operation.

### Method
void

### Parameters
#### Path Parameters
- **backupType** (BackupType) - Description: backup type

### Request Example
```
start(BackupType.FULL)
```

### Response
#### Success Response (void)
This method does not return a value upon successful execution.
```

--------------------------------

### get

Source: https://manuals.gfi.com/en/kerio/api/connect/admin/reference/interfacekerio_1_1jsonapi_1_1admin_1_1_connect_certificate.html

Retrieves a list of all available certificates.

```APIDOC
## get

### Description
Obtains a list of certificates.

### Parameters
- **certificates** (CertificateList) - Output - The current list of certificates.
```

--------------------------------

### get

Source: https://manuals.gfi.com/en/kerio/api/connect/admin/reference/_advanced_options_8idl_source.html

Retrieves the current advanced options settings.

```APIDOC
## get

### Description
Retrieves the current advanced options settings.

### Method
void

### Parameters
#### Output Parameters
- **options** (AdvancedOptionsSetting) - Output parameter containing the current advanced options.
```

--------------------------------

### get

Source: https://manuals.gfi.com/en/kerio/api/connect/admin/reference/interfacekerio_1_1jsonapi_1_1admin_1_1_dumps-members.html

Retrieves a list of available dumps.

```APIDOC
## get

### Description
Retrieves a list of available dumps.

### Method
GET

### Endpoint
/admin/dumps

### Parameters
#### Query Parameters
- **dumps** (DumpList) - Output parameter to store the list of dumps.

### Response
#### Success Response (200)
- **dumps** (DumpList) - A list of available dumps.
```

--------------------------------

### get

Source: https://manuals.gfi.com/en/kerio/api/connect/admin/reference/_product_registration_8idl_source.html

Retrieves existing registration data from the server.

```APIDOC
## get

### Description
Retrieves existing registration data from the server.

### Method
void

### Parameters
#### In Parameters
- **token** (string) - Required - ID of wizard's session
- **securityCode** (string) - Required - a code number from the security immage
- **baseId** (string) - Required - license ID
- **trial** (string) - Required - trial ID registered on web, do not display registrationInfo and finish immediatelly 
#### Out Parameters
- **registrationInfo** (Registration) - Output - the registration data related to the license ID
- **newRegistration** (boolean) - Output - flag indicates whether the registration has already existed.
```

--------------------------------

### get

Source: https://manuals.gfi.com/en/kerio/api/connect/admin/reference/interfacekerio_1_1jsonapi_1_1admin_1_1_migration-members.html

Retrieves a list of migration tasks based on a search query.

```APIDOC
## get

### Description
Retrieves a list of migration tasks based on a search query.

### Method
GET (assumed, as it retrieves data)

### Endpoint
/migration/get

### Parameters
#### Query Parameters
- **list** (MigrationTaskList) - Output - A list of migration tasks.
- **totalItems** (long) - Output - The total number of items matching the query.
- **query** (kerio::web::SearchQuery) - Input - The search query to filter migration tasks.
```

--------------------------------

### Get Product Version

Source: https://manuals.gfi.com/en/kerio/api/connect/admin/reference/interfacekerio_1_1web_1_1_version.html

Retrieves the overall product version of Kerio Connect.

```APIDOC
## getProductVersion

### Description
Get product version.

### Method
void

### Endpoint
kerio::web::Version::getProductVersion

### Parameters
#### Out Parameters
- **productVersion** (ProductVersion) - Output parameter to store the product version.
```

--------------------------------

### Get DKIM DNS Record

Source: https://manuals.gfi.com/en/kerio/api/connect/admin/reference/_domains_8idl_source.html

Retrieves the DNS TXT record required for DKIM setup for a given domain.

```APIDOC
## getDkimDnsRecord

### Description
DKIM requires public key in DNS for domain. Returns DNS TXT record to be added into DNS.

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **domain** (string) - The domain for which to get the DKIM DNS record.

### Response
#### Success Response (200)
- **detail** (string) - The DNS TXT record for DKIM.

### Request Example
```json
{
  "domain": "example.com"
}
```

### Response Example
```json
{
  "detail": "v=DKIM1; k=rsa; p=MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA..."
}
```
```

--------------------------------

### Get Services

Source: https://manuals.gfi.com/en/kerio/api/connect/admin/reference/_services_8idl_source.html

Retrieves a list of all configured services along with their current status.

```APIDOC
## get

### Description
Show a list of services with current status.

### Method
GET (implied by IDL interface)

### Endpoint
/services

### Parameters
None

### Response
#### Success Response (200)
- **services** (ServiceList) - list of KMS services
```

--------------------------------

### finish

Source: https://manuals.gfi.com/en/kerio/api/connect/admin/reference/_init_8idl_source.html

Completes the initial configuration process for Kerio Connect.

```APIDOC
## finish

### Description
Finishes the initial configuration of Kerio Connect.

### Parameters
#### Path Parameters
- None

#### Query Parameters
- None

#### Request Body
- None

### Method Signature
`void finish();`

### Response
- None

### Request Example
```
finish();
```

### Response Example
```
// No response body, operation is acknowledged by completion.
```
```

--------------------------------

### runPop3Downloads

Source: https://manuals.gfi.com/en/kerio/api/connect/admin/reference/interfacekerio_1_1jsonapi_1_1admin_1_1_delivery.html

Initiates all POP3 downloads immediately.

```APIDOC
## runPop3Downloads

### Description
Proceed all POP3 downloads right now.

### Method
POST

### Endpoint
/delivery/pop3/downloads/run
```

--------------------------------

### Get Unity Sign On Settings

Source: https://manuals.gfi.com/en/kerio/api/connect/admin/reference/interfacekerio_1_1web_1_1_unity_sign_on.html

Retrieves the current Kerio Unity Sign On settings.

```APIDOC
## get

### Description
Obtain Kerio Unity Sign On settings.

### Parameters
- **settings** (SignOn) - Output parameter for Sign On settings.
```

--------------------------------

### Session Login

Source: https://manuals.gfi.com/en/kerio/api/connect/admin/reference/sample_communication.html

This example demonstrates how to log in to the Kerio Connect API to obtain an authentication token.

```APIDOC
## Session.login

### Description
Logs in to the Kerio Connect API, returning a session token for subsequent requests.

### Method
POST

### Endpoint
/admin/api/jsonrpc/

### Request Body
- **jsonrpc** (string) - Required - Specifies the JSON-RPC version.
- **id** (integer) - Required - A unique identifier for the request.
- **method** (string) - Required - The method to call, which is 'Session.login'.
- **params** (object) - Required - Parameters for the login method.
  - **userName** (string) - Required - The username for authentication.
  - **password** (string) - Required - The password for authentication.
  - **application** (object) - Optional - Information about the client application.
    - **name** (string) - Optional - The name of the application.
    - **vendor** (string) - Optional - The vendor of the application.
    - **version** (string) - Optional - The version of the application.

### Request Example
```json
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "Session.login",
  "params": {
    "userName": "admindemo",
    "password": "readonly",
    "application": {
      "name": "Example: Get all domains",
      "vendor": "Kerio Technologies s.r.o.",
      "version": "BUILD_HASH"
    }
  }
}
```

### Response
#### Success Response (200)
- **jsonrpc** (string) - The JSON-RPC version.
- **id** (integer) - The request ID.
- **result** (object) - The result of the operation.
  - **token** (string) - The authentication token.

#### Response Example
```json
{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "token": "661415af99698a00d9e2a3335350d0c27e14c032fe34c7c52d853e13908c6791"
  }
}
```
```

--------------------------------

### Run POP3 Downloads

Source: https://manuals.gfi.com/en/kerio/api/connect/admin/reference/_delivery_8idl_source.html

Immediately initiates all pending POP3 downloads.

```APIDOC
## runPop3Downloads

### Description
Proceeds all POP3 downloads right now.
```

--------------------------------

### get

Source: https://manuals.gfi.com/en/kerio/api/connect/admin/reference/interfacekerio_1_1jsonapi_1_1admin_1_1_statistics.html

Retrieves the overall server statistics.

```APIDOC
## get

### Description
Obtains overall server statistics.

### Parameters
- **_statistics** (ServerStatistics) - Output parameter to store the current server statistics.
```

--------------------------------

### getInfo

Source: https://manuals.gfi.com/en/kerio/api/connect/admin/reference/interfacekerio_1_1web_1_1_technical_support-members.html

Retrieves user, product, and system information, and checks if the upload server is available.

```APIDOC
## getInfo

### Description
Retrieves user, product, and system information, and checks if the upload server is available.

### Method
Not specified (likely a method call within an SDK or RPC framework).

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Response
#### Success Response
- **userInfo** (UserInfo) - Output parameter containing user information.
- **productInfo** (ProductInfo) - Output parameter containing product information.
- **systemInfo** (SystemInfo) - Output parameter containing system information.
- **isUploadServerAvailable** (boolean) - Output parameter indicating if the upload server is available.
```

--------------------------------

### Domains.get

Source: https://manuals.gfi.com/en/kerio/api/connect/admin/reference/sample_communication.html

This example demonstrates how to retrieve a list of all available domains using the obtained session token.

```APIDOC
## Domains.get

### Description
Retrieves a list of domains with specified fields and sorting options.

### Method
POST

### Endpoint
/admin/api/jsonrpc/

### Parameters
#### Request Headers
- **Accept**: application/json-rpc
- **Content-Type**: application/json-rpc; charset=UTF-8
- **User-Agent**: Kerio APIs Client Library for PHP/1.3
- **Host**: mail.company.tld:4040
- **Cookie**: SESSION_CONNECT_WEBADMIN=...; 
- **X-Token**: [Obtained session token]

#### Request Body
- **jsonrpc** (string) - Required - Specifies the JSON-RPC version.
- **id** (integer) - Required - A unique identifier for the request.
- **token** (string) - Required - The session token obtained from the login response.
- **method** (string) - Required - The method to call, which is 'Domains.get'.
- **params** (object) - Required - Parameters for the get method.
  - **query** (object) - Optional - Query parameters for filtering and sorting domains.
    - **fields** (array of strings) - Optional - List of fields to include in the response.
    - **start** (integer) - Optional - The starting index for pagination.
    - **limit** (integer) - Optional - The maximum number of domains to return.
    - **orderBy** (array of objects) - Optional - Criteria for sorting the results.
      - **columnName** (string) - The name of the column to sort by.
      - **direction** (string) - The sorting direction ('Asc' or 'Desc').

### Request Example
```json
{
  "jsonrpc": "2.0",
  "id": 3,
  "token": "661415af99698a00d9e2a3335350d0c27e14c032fe34c7c52d853e13908c6791",
  "method": "Domains.get",
  "params": {
    "query": {
      "fields": [
        "id",
        "name",
        "description",
        "aliasList",
        "userMaxCount",
        "outgoingMessageLimit",
        "isPrimary",
        "renameInfo",
        "forwardingOptions",
        "kerberosRealm",
        "winNtName",
        "ipAddressBind",
        "pamRealm",
        "keepForRecovery",
        "isDistributed"
      ],
      "start": 0,
      "limit": -1,
      "orderBy": [
        {
          "columnName": "name",
          "direction": "Asc"
        }
      ]
    }
  }
}
```

### Response
#### Success Response (200)
- **jsonrpc** (string) - The JSON-RPC version.
- **id** (integer) - The request ID.
- **result** (object) - The result of the operation, containing a list of domains.
  - **domains** (array of objects) - A list of domain objects, each with the requested fields.

#### Response Example
(Response example not provided in source text, but would typically contain a list of domain objects.)
```

--------------------------------

### StartUp Enumeration

Source: https://manuals.gfi.com/en/kerio/api/connect/admin/reference/_services_8idl.html

Defines the startup modes for a service.

```APIDOC
## enum kerio::jsonapi::admin::StartUp

### Description
Specifies how a service should start.

### Enumerators
- **Manual**: The service must be started manually.
- **Automatic**: The service starts automatically on system boot.
```

--------------------------------

### Archive get()

Source: https://manuals.gfi.com/en/kerio/api/connect/admin/reference/interfacekerio_1_1jsonapi_1_1admin_1_1_archive-members.html

Retrieves archive options.

```APIDOC
## get()

### Description
Retrieves the current archive options.

### Method
GET

### Endpoint
/admin/archive/get

### Parameters
#### Query Parameters
- **options** (ArchiveOptions) - Required - The archive options to retrieve.

### Response
#### Success Response (200)
- **options** (ArchiveOptions) - The retrieved archive options.
```

--------------------------------

### get

Source: https://manuals.gfi.com/en/kerio/api/connect/admin/reference/interfacekerio_1_1web_1_1_system_health-members.html

Retrieves current system health data.

```APIDOC
## get

### Description
Retrieves the current system health data.

### Method Signature
`get(out SystemHealthData data, in HistogramType type)`

### Parameters
#### Output Parameters
- **data** (SystemHealthData) - Required - The structure to populate with system health data.

#### Input Parameters
- **type** (HistogramType) - Required - The type of histogram data to retrieve.
```

--------------------------------

### get

Source: https://manuals.gfi.com/en/kerio/api/connect/admin/reference/_statistics_8idl_source.html

Retrieves the current overall server statistics.

```APIDOC
## get

### Description
Obtains overall server statistics.

### Parameters
#### Path Parameters
- **statistics** (ServerStatistics) - out - The current server statistics.
```

--------------------------------

### getSettings

Source: https://manuals.gfi.com/en/kerio/api/connect/admin/reference/interfacekerio_1_1jsonapi_1_1admin_1_1_session-members.html

Retrieves system settings based on a query.

```APIDOC
## getSettings

### Description
Retrieves system settings based on a query.

### Method
[Method not specified, likely a getter]

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **query** (SettingQuery) - The query to filter settings.

### Response
#### Success Response (200)
- **settings** (jsonstring) - The retrieved settings in JSON format.

### Response Example
```json
{
  "settings": "{...}"
}
```
```

--------------------------------

### getInfo

Source: https://manuals.gfi.com/en/kerio/api/connect/admin/reference/interfacekerio_1_1web_1_1_technical_support.html

Retrieves various information about the running product, including user, product, and system details, and checks if the upload server is available.

```APIDOC
## getInfo

### Description
Get information from running product.

### Method
void

### Parameters
#### Path Parameters
- **userInfo** (UserInfo) - Required - User information
- **productInfo** (ProductInfo) - Required - Product information
- **systemInfo** (SystemInfo) - Required - System information
- **isUploadServerAvailable** (boolean) - Required - Is possible to upload attachment ?

### Response
#### Success Response (void)
(void)

```

--------------------------------

### run

Source: https://manuals.gfi.com/en/kerio/api/connect/admin/reference/interfacekerio_1_1jsonapi_1_1admin_1_1_queue-members.html

Initiates the processing of messages in the queue.

```APIDOC
## run

### Description
Triggers the execution of the message queue processing. This action attempts to send or process messages that are pending.

### Method
APICALL

### Endpoint
kerio.jsonapi.admin.Queue.run

### Parameters
None
```

--------------------------------

### AntivirusPlugin Structure

Source: https://manuals.gfi.com/en/kerio/api/connect/admin/reference/_content_8idl_source.html

Details of an installed antivirus plugin.

```APIDOC
## AntivirusPlugin

### Description
Information about a specific antivirus scanning engine or plugin available on the system.

### Fields
- **id** (string) - The unique identifier for the antivirus plugin (e.g., "avir_avg").
- **description** (string) - A human-readable description of the plugin (e.g., "AVG Email Server Edition").
- **areOptionsAvailable** (boolean) - Indicates if this plugin has configurable options.
- **options** (AntivirusOptionList) - A list of available configuration options for this plugin.
```

--------------------------------

### getSettings

Source: https://manuals.gfi.com/en/kerio/api/connect/admin/reference/interfacekerio_1_1jsonapi_1_1admin_1_1_domains-members.html

Retrieves the domain settings.

```APIDOC
## getSettings

### Description
Retrieves the domain settings.

### Method
(Not specified, likely a GET operation)

### Endpoint
(Not specified)

### Response
#### Success Response (200)
- **setting** (DomainSetting) - The domain settings.
```

--------------------------------

### rename

Source: https://manuals.gfi.com/en/kerio/api/connect/admin/reference/interfacekerio_1_1jsonapi_1_1admin_1_1_domains.html

Starts the domain renaming process for a specified domain.

```APIDOC
## rename

### Description
Starts the domain renaming process.

### Method
void

### Parameters
#### Request Body
- **domainId** (kerio::web::KId) - Required - ID of the domain which will be renamed.
- **newName** (string) - Required - The new domain name.
#### Response Body
- **error** (ClusterError) - Output - Error message.
```

--------------------------------

### get

Source: https://manuals.gfi.com/en/kerio/api/connect/admin/reference/interfacekerio_1_1jsonapi_1_1admin_1_1_users-members.html

Retrieves a list of users based on a search query.

```APIDOC
## get

### Description
Retrieves a list of users based on a search query.

### Method
Not specified (likely GET or POST)

### Endpoint
Not specified

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **list** (UserList) - Output parameter for the list of users.
- **totalItems** (long) - Output parameter for the total number of items.
- **query** (kerio::web::SearchQuery) - Required - The search query to filter users.
- **domainId** (kerio::web::KId) - Required - The ID of the domain.
```

--------------------------------

### getSettings

Source: https://manuals.gfi.com/en/kerio/api/connect/admin/reference/interfacekerio_1_1jsonapi_1_1admin_1_1_domains.html

Retrieves the global settings common to all domains.

```APIDOC
## getSettings

### Description
Gets settings common in all domains.

### Method
void

### Parameters
None

### Response Body
- **setting** (DomainSetting) - Output - The global domain setting.
```

--------------------------------

### create

Source: https://manuals.gfi.com/en/kerio/api/connect/admin/reference/interfacekerio_1_1jsonapi_1_1admin_1_1_users-members.html

Creates new users.

```APIDOC
## create

### Description
Creates new users.

### Method
Not specified (likely POST)

### Endpoint
Not specified

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **errors** (kerio::web::ErrorList) - Output parameter for errors.
- **result** (kerio::web::CreateResultList) - Output parameter for creation results.
- **users** (UserList) - Required - A list of users to create.
```

--------------------------------

### startRebuildFulltext

Source: https://manuals.gfi.com/en/kerio/api/connect/admin/reference/_advanced_options_8idl_source.html

Initiates a full-text index rebuild based on specified parameters.

```APIDOC
## startRebuildFulltext

### Description
Initiates a full-text index rebuild based on specified parameters.

### Method
void

### Parameters
#### Input Parameters
- **parameters** (FulltextRebuildingCommand) - Input parameter specifying the scope and ID for the re-index operation.
```

--------------------------------

### Get API Version

Source: https://manuals.gfi.com/en/kerio/api/connect/admin/reference/interfacekerio_1_1web_1_1_version.html

Retrieves the version of the Administration API.

```APIDOC
## getApiVersion

### Description
Get version of Administration API.

### Method
void

### Endpoint
kerio::web::Version::getApiVersion

### Parameters
#### Out Parameters
- **apiVersion** (ApiVersion) - Output parameter to store the API version.
```

--------------------------------

### get

Source: https://manuals.gfi.com/en/kerio/api/connect/admin/reference/interfacekerio_1_1web_1_1_logs-members.html

Retrieves a viewport of log entries with specified pagination.

```APIDOC
## get

### Description
Retrieves a viewport of log entries with specified pagination.

### Method
GET

### Endpoint
/logs/get

### Parameters
#### Query Parameters
- **logName** (LogType) - Required - The name of the log to retrieve.
- **fromLine** (long) - Required - The starting line number for the viewport.
- **countLines** (long) - Required - The number of lines to include in the viewport.

### Response
#### Success Response (200)
- **viewport** (LogRowList) - Description of the log entries retrieved.
- **totalItems** (long) - The total number of items in the log.
```

--------------------------------

### Set Unity Sign On Settings

Source: https://manuals.gfi.com/en/kerio/api/connect/admin/reference/interfacekerio_1_1web_1_1_unity_sign_on.html

Configures the Kerio Unity Sign On settings.

```APIDOC
## set

### Description
Set Kerio Unity Sign On settings.

### Parameters
- **settings** (SignOn) - Input parameter for Sign On settings.
```

--------------------------------

### startRebuildFulltext

Source: https://manuals.gfi.com/en/kerio/api/connect/admin/reference/interfacekerio_1_1jsonapi_1_1admin_1_1_advanced_options-members.html

Initiates the full-text search index rebuild process.

```APIDOC
## startRebuildFulltext

### Description
Initiates the process of rebuilding the full-text search index.

### Method
Not specified (assumed to be a method call within the API)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **parameters** (FulltextRebuildingCommand) - Required - Parameters for the full-text rebuilding command.
```

--------------------------------

### get

Source: https://manuals.gfi.com/en/kerio/api/connect/admin/reference/interfacekerio_1_1jsonapi_1_1admin_1_1_user_templates-members.html

Retrieves user templates based on a search query.

```APIDOC
## get

### Description
Retrieves user templates based on a search query.

### Method
Not specified (likely GET)

### Endpoint
Not specified

### Parameters
#### Path Parameters
None

#### Query Parameters
- **query** (kerio::web::SearchQuery) - Required - The search query to filter user templates.

### Request Example
```json
{
  "query": {
    "filter": "name:Example*",
    "limit": 10,
    "offset": 0,
    "orderBy": "name"
  }
}
```

### Response
#### Success Response (200)
- **userTemplateList** (UserTemplateList) - A list of user templates matching the query.
- **totalItems** (long) - The total number of user templates found.
```

--------------------------------

### Get IPv6 Status

Source: https://manuals.gfi.com/en/kerio/api/connect/admin/reference/interfacekerio_1_1jsonapi_1_1admin_1_1_services-members.html

Checks if IPv6 is enabled for services.

```APIDOC
## getIPv6

### Description
Checks if IPv6 is enabled for services.

### Method
GET (assumed, based on 'get' operation)

### Endpoint
/services/ipv6

### Parameters
#### Query Parameters
- **isEnabled** (boolean) - Output - Indicates if IPv6 is enabled.
```

--------------------------------

### Get Service List

Source: https://manuals.gfi.com/en/kerio/api/connect/admin/reference/interfacekerio_1_1jsonapi_1_1admin_1_1_services-members.html

Retrieves a list of all available services.

```APIDOC
## get

### Description
Retrieves a list of all available services.

### Method
GET (assumed, based on 'get' operation)

### Endpoint
/services

### Parameters
#### Query Parameters
- **services** (ServiceList) - Output - A list of services.

### Response
#### Success Response (200)
- **services** (ServiceList) - A list of services.
```

--------------------------------

### get

Source: https://manuals.gfi.com/en/kerio/api/connect/admin/reference/interfacekerio_1_1jsonapi_1_1admin_1_1_domains.html

Retrieves a list of domains based on search criteria.

```APIDOC
## get

### Description
Retrieves a list of domains based on search criteria.

### Method
void

### Endpoint
N/A (This appears to be an SDK method)

### Parameters
#### Path Parameters
* **list** (DomainList) - out - The list of domains.
* **totalItems** (long) - out - The total number of items matching the query.
* **query** (kerio::web::SearchQuery) - in - The search query parameters.
```

--------------------------------

### getFromServer

Source: https://manuals.gfi.com/en/kerio/api/connect/admin/reference/interfacekerio_1_1jsonapi_1_1admin_1_1_users-members.html

Retrieves new users from a server for import.

```APIDOC
## getFromServer

### Description
Retrieves new users from a server for import.

### Method
Not specified (likely POST)

### Endpoint
Not specified

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **newUsers** (ImporteeList) - Output parameter for the list of new users.
- **importServer** (ImportServer) - Required - Information about the import server.
- **domainToImport** (kerio::web::KId) - Required - The ID of the domain to import users into.
```

--------------------------------

### get

Source: https://manuals.gfi.com/en/kerio/api/connect/admin/reference/interfacekerio_1_1jsonapi_1_1admin_1_1_aliases.html

Obtain a list of aliases based on search criteria.

```APIDOC
## get

### Description
Obtain list of aliases.

### Parameters
* **list** (AliasList) - Output - aliases
* **totalItems** (long) - Output - amount of aliases for given search condition, useful when limit is defined in query
* **query** (kerio::web::SearchQuery) - Input - query conditions and limits
* **domainId** (kerio::web::KId) - Input - domain identification
```

--------------------------------

### Store Directory Options

Source: https://manuals.gfi.com/en/kerio/api/connect/admin/reference/_advanced_options_8idl_source.html

Options for configuring the paths of the store directory, archive, and backup, along with disk space watchdog limits.

```APIDOC
## StoreDirectoryOptions

### Description
Options for configuring the paths of the store directory, archive, and backup, along with disk space watchdog limits.

### Fields
- **storePath** (string) - Path to the store directory.
- **archivePath** (string) - Path to the archive.
- **backupPath** (string) - Path to the backup.
- **watchdogSoftLimit** (kerio::web::ByteValueWithUnits) - If the available disk space falls below this value, a warning message is displayed.
- **watchdogHardLimit** (kerio::web::ByteValueWithUnits) - If the available disk space falls below this value, Kerio MailServer is stopped and an error message is displayed. Administrator's action is required.
```

--------------------------------

### get

Source: https://manuals.gfi.com/en/kerio/api/connect/admin/reference/_dumps_8idl_source.html

Obtain a list of all available crash dumps on the server.

```APIDOC
## get

### Description
Obtain a list of all available crash dumps on the server.

### Method
APIDOC

### Endpoint
APIDOC

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **dumps** (DumpList) - A list of available crash dumps, where each dump contains its size and timestamp.

#### Response Example
None
```

--------------------------------

### create

Source: https://manuals.gfi.com/en/kerio/api/connect/admin/reference/interfacekerio_1_1jsonapi_1_1admin_1_1_user_templates-members.html

Creates new user templates.

```APIDOC
## create

### Description
Creates new user templates.

### Method
Not specified (likely POST or PUT)

### Endpoint
Not specified

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **userTemplates** (UserTemplateList) - Required - A list of user templates to create.

### Request Example
```json
{
  "userTemplates": [
    {
      "name": "Template Name",
      "fields": { ... }
    }
  ]
}
```

### Response
#### Success Response (200)
- **errors** (kerio::web::ErrorList) - A list of errors encountered during creation.
- **result** (kerio::web::CreateResultList) - A list of results for each created template.
```

--------------------------------

### set

Source: https://manuals.gfi.com/en/kerio/api/connect/admin/reference/interfacekerio_1_1web_1_1_unity_sign_on-members.html

Sets the SignOn settings.

```APIDOC
## set

### Description
Sets the SignOn settings.

### Method
POST (assumed, based on 'set' operation)

### Endpoint
/unitysignon/settings

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **settings** (SignOn) - Required - The new SignOn settings to apply.

### Request Example
```json
{
  "settings": {
    "someField": "someValue"
  }
}
```

### Response
#### Success Response (200)
Indicates that the settings were successfully updated.

#### Response Example
```json
{
  "status": "success"
}
```
```

--------------------------------

### get

Source: https://manuals.gfi.com/en/kerio/api/connect/admin/reference/interfacekerio_1_1web_1_1_product_registration-members.html

Retrieves the current product registration information, including whether a new registration is needed and if it's a trial.

```APIDOC
## get

### Description
Retrieves the current product registration information.

### Method
[Method Signature]

### Parameters
#### Input Parameters
- **token** (string) - Required - The authentication token.
- **securityCode** (string) - Required - The security code for verification.
- **baseId** (string) - Required - The base ID for registration.

#### Output Parameters
- **registrationInfo** (Registration) - Output - The current registration details.
- **newRegistration** (boolean) - Output - Indicates if a new registration is required.
- **trial** (boolean) - Output - Indicates if the registration is a trial.
```

--------------------------------

### get

Source: https://manuals.gfi.com/en/kerio/api/connect/admin/reference/interfacekerio_1_1web_1_1_certificates-members.html

Retrieves a list of certificates based on the provided search query.

```APIDOC
## get

### Description
Retrieves a list of certificates based on the provided search query.

### Method
APIDOC

### Endpoint
APIDOC

### Parameters
#### Path Parameters
APIDOC

#### Query Parameters
- **query** (SearchQuery) - Required - The search query to filter certificates.

#### Request Body
APIDOC

### Request Example
APIDOC

### Response
#### Success Response (200)
- **certificates** (CertificateList) - A list of certificates matching the query.
- **totalItems** (long) - The total number of items found.

#### Response Example
APIDOC
```

--------------------------------

### create

Source: https://manuals.gfi.com/en/kerio/api/connect/admin/reference/interfacekerio_1_1jsonapi_1_1admin_1_1_users.html

Creates new users. Returns a list of errors and a list of IDs for the newly created users.

```APIDOC
## create

### Description
Create new users.

### Parameters
- **errors** (out kerio::web::ErrorList) - error message list
- **result** (out kerio::web::CreateResultList) - list of IDs of created users
- **users** (in UserList) - new user entities
```

--------------------------------

### Get IPv6 Status

Source: https://manuals.gfi.com/en/kerio/api/connect/admin/reference/interfacekerio_1_1jsonapi_1_1admin_1_1_services.html

Retrieves the current IPv6 configuration status.

```APIDOC
## getIPv6

### Description
Obtain IPv6 settings.

### Method
GET

### Endpoint
/ipv6/settings

### Parameters
#### Query Parameters
None

#### Request Body
None

### Response
#### Success Response (200)
- **isEnabled** (boolean) - Indicates if IPv6 is enabled.

### Response Example
```json
{
  "isEnabled": true
}
```
```

--------------------------------

### UnitySignOn Interface

Source: https://manuals.gfi.com/en/kerio/api/connect/admin/reference/_unity_sign_on_8idl_source.html

The UnitySignOn interface provides methods to manage Kerio Unity Sign On settings. It allows retrieving, setting, and testing the connection to the sign-on server.

```APIDOC
## get

### Description
Obtain Kerio Unity Sign On settings.

### Method
get

### Parameters
#### Output Parameters
- **settings** (SignOn) - Sign On settings

## set

### Description
Set Kerio Unity Sign On settings.

### Method
set

### Parameters
#### Input Parameters
- **settings** (SignOn) - Sign On settings

## testConnection

### Description
Test connection to Kerio Unity Sign On server.

### Method
testConnection

### Parameters
#### Output Parameters
- **errors** (ErrorList) - error messages list; If no error is listed, connection is successful
#### Input Parameters
- **hostNames** (StringList) - directory server (primary and secondary if any)
- **credentials** (Credentials) - authentication information
```

--------------------------------

### options

Source: https://manuals.gfi.com/en/kerio/api/connect/admin/reference/structkerio_1_1jsonapi_1_1admin_1_1_antivirus_plugin-members.html

Retrieves the options for the AntivirusPlugin.

```APIDOC
## options

### Description
Retrieves the options for the AntivirusPlugin.

### Method
(Not specified, likely a getter)

### Endpoint
(Not specified)

### Parameters
None

### Response
#### Success Response (200)
- **object** (object) - An object containing the antivirus plugin options.

### Response Example
```json
{
  "result": {
    "option1": "value1",
    "option2": "value2"
  }
}
```
```

--------------------------------

### Get ETRN Timeout

Source: https://manuals.gfi.com/en/kerio/api/connect/admin/reference/interfacekerio_1_1jsonapi_1_1admin_1_1_delivery.html

Retrieves the current ETRN timeout setting.

```APIDOC
## getEtrnTimeout

### Description
Retrieves the ETRN timeout setting.

### Method
void

### Parameters
- **seconds** (out long) - Output parameter for the timeout in seconds.
```

--------------------------------

### getVersion

Source: https://manuals.gfi.com/en/kerio/api/connect/admin/reference/interfacekerio_1_1jsonapi_1_1admin_1_1_server-members.html

Retrieves the detailed version information of the product.

```APIDOC
## getVersion

### Description
Retrieves the product version information.

### Method
GET

### Endpoint
/server/getVersion

### Response
#### Success Response (200)
- **product** (string) - The product name.
- **version** (string) - The product version string.
- **major** (long) - The major version number.
- **minor** (long) - The minor version number.
- **revision** (long) - The revision number.
- **build** (long) - The build number.
```

--------------------------------

### Get XMPP Settings

Source: https://manuals.gfi.com/en/kerio/api/connect/admin/reference/interfacekerio_1_1jsonapi_1_1admin_1_1_instant_messaging.html

Retrieves the current settings for the XMPP server.

```APIDOC
## get

### Description
Get settings of XMPP server

### Method
GET (assumed, based on 'get' operation)

### Endpoint
/api/v1/instant-messaging/settings

### Parameters
#### Query Parameters
None explicitly mentioned.

### Response
#### Success Response (200)
- **settings** (XmppSettings) - Sign On settings

### Response Example
```json
{
  "settings": {
    "someSetting": "value"
  }
}
```
```

--------------------------------

### getAboutInfo

Source: https://manuals.gfi.com/en/kerio/api/connect/admin/reference/_server_8idl_source.html

Retrieves general information about the Kerio Connect server. The caller must be authenticated to use this method.

```APIDOC
## getAboutInfo

### Description
Obtain information about server, caller must be authenticated.

### Method
void

### Parameters
#### Output Parameters
- **aboutInformation** (AboutInfo) - Information about the server.
```

--------------------------------

### get

Source: https://manuals.gfi.com/en/kerio/api/connect/admin/reference/interfacekerio_1_1jsonapi_1_1admin_1_1_domains-members.html

Retrieves a list of domains based on the provided search query.

```APIDOC
## get

### Description
Retrieves a list of domains based on the provided search query.

### Method
(Not specified, likely a GET operation)

### Endpoint
(Not specified)

### Parameters
#### Query Parameters
- **query** (kerio::web::SearchQuery) - Required - The search query to filter domains.
```

--------------------------------

### Get Certificate Source

Source: https://manuals.gfi.com/en/kerio/api/connect/admin/reference/interfacekerio_1_1jsonapi_1_1admin_1_1_connect_certificate-members.html

Retrieves the source content of a specific certificate.

```APIDOC
## toSource

### Description
Retrieves the source content of a certificate.

### Method
GET

### Endpoint
/admin/connect/certificate/{id}/source

### Parameters
#### Path Parameters
- **id** (kerio::web::KId) - Required - The ID of the certificate.

### Response
#### Success Response (200)
- **source** (string) - The source content of the certificate.
```

--------------------------------

### Get Archive Options

Source: https://manuals.gfi.com/en/kerio/api/connect/admin/reference/interfacekerio_1_1jsonapi_1_1admin_1_1_archive.html

Retrieves the current archive configuration options.

```APIDOC
## get

### Description
Obtain archive options.

### Parameters
- **options** (ArchiveOptions) - Output - Current archive options.

### Method
get
```

--------------------------------

### Get Backup Status

Source: https://manuals.gfi.com/en/kerio/api/connect/admin/reference/interfacekerio_1_1jsonapi_1_1admin_1_1_backup.html

Retrieves the current status of the backup process.

```APIDOC
## getStatus

### Description
Return current backup status.

### Method
GET (assumed, based on 'get' operation)

### Endpoint
/api/v1/backup/status

### Parameters
None.

### Response
#### Success Response (200)
- **status** (BackupStatus) - The current backup status.

### Response Example
```json
{
  "status": {
    "state": "idle",
    "lastBackupTime": "2023-10-27T02:00:00Z",
    "lastBackupSizeMB": 1024
  }
}
```
```

--------------------------------

### Create Domain

Source: https://manuals.gfi.com/en/kerio/api/connect/admin/reference/_domains_8idl_source.html

Creates new domains in Kerio Connect.

```APIDOC
## create

### Description
Creates new domains.

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **domains** (DomainList) - new domain entities

### Response
#### Success Response (200)
- **errors** (kerio::web::ErrorList) - error message list
- **result** (kerio::web::CreateResultList) - particular results for all items

### Request Example
```json
{
  "domains": [
    {
      "name": "example.com",
      "description": "Example Domain"
    }
  ]
}
```

### Response Example
```json
{
  "errors": [],
  "result": [
    {
      "id": "domain-id-123",
      "status": "created"
    }
  ]
}
```
```

--------------------------------

### Get Backup Status

Source: https://manuals.gfi.com/en/kerio/api/connect/admin/reference/interfacekerio_1_1jsonapi_1_1admin_1_1_backup-members.html

Retrieves the current status of the backup process.

```APIDOC
## getStatus

### Description
Retrieves the current status of the backup.

### Method
GET (assumed, based on 'get' prefix)

### Endpoint
/backup/status

### Parameters
#### Query Parameters
- **status** (BackupStatus) - Output parameter to hold the current backup status.
```
Tokens:
Raw