API docs by Redocly

Kyvos Manager

Download OpenAPI specification:Download

E-mail: support@kyvos.io

Kyvos Manager Rest API Documentation

Find out more about Kyvos mailto:support@kyvos.io

Query Engine Segments

Kyvos Manager REST APIs allow you to add, delete, and update the Query Engine based segments.

Get All Segments

This API is used to fetch details of all the configured segments in the cluster. The response consists of an array containing segment objects including segment name, segment type, and the details of associated Query Engine instances.

Authorizations:
basicAuth
header Parameters
Accept
required
string
Value: "application/JSON"
Example: application/JSON

Supported response type: JSON.

Responses

Response samples

Content type
application/json
{
  • "OUTPUT": [
    ],
  • "STATUS": 200,
  • "MESSAGE": "Get segment request accepted.",
  • "ERRORS": null
}

Add Query Engine Based Segment

This API is used to add Query Engine based segment. You can add multiple Query Engines in a single segment.

The response of the API call shows the Operation ID of the add segments operation. To get a status of operation, use this API Get Single Operation Details or for operation log use this API Get Operation Logs.

Authorizations:
basicAuth
header Parameters
Accept
required
string
Value: "application/JSON"
Example: application/JSON

Supported response type: JSON.

Request Body schema: application/json
NAME
string

Unique Query Engine segment name. If a name is not provided, an auto-generated name will be used.

QUERYENGINE
required
Array of strings

Array of distinct Query Engine nodes. Provide in IP Address:QueryEngine-Instance format.

Responses

Request samples

Content type
application/json
Example
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "OUTPUT": {
    },
  • "STATUS": 202,
  • "MESSAGE": "Add segment request accepted..",
  • "ERRORS": null
}

Update Query Engine Based Segments

This API is used to update the Query Engine based segments. While updating a segment, all the Query Engines associated with the segment are replaced with new Query Engines. The system will show an error if you provide any currently associated Query Engine.

The response of the API call shows the Operation ID of the update segments operation. To get a status of operation, use this API Get Single Operation Details or for operation log use this API Get Operation Logs.

Authorizations:
basicAuth
header Parameters
Accept
required
string
Value: "application/JSON"
Example: application/JSON

Supported response type: JSON.

Request Body schema: application/json
NAME
required
string

Name of the segment to be updated.

QUERYENGINE
required
Array of strings

Array of distinct Query Engine nodes to be added to the segment. Provide in IP Address:QueryEngine-Instance format.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "OUTPUT": {
    },
  • "STATUS": 202,
  • "MESSAGE": "Update segment request accepted.",
  • "ERRORS": null
}

Delete Multiple Segments

This API is used to delete multiple segments from the cluster.

The response of the API call shows the Operation ID of the delete segments operation. To get a status of operation, use this API Get Single Operation Details or for operation log use this API Get Operation Logs.

Authorizations:
basicAuth
header Parameters
Accept
required
string
Value: "application/JSON"
Example: application/JSON

Supported response type: JSON.

Request Body schema: application/json
name
Array of strings

Array of names of the segments to be deleted.

Responses

Request samples

Content type
application/json
{
  • "name": [
    ]
}

Response samples

Content type
application/json
{
  • "OUTPUT": {
    },
  • "STATUS": 200,
  • "MESSAGE": "Update segment request accepted.",
  • "ERRORS": null
}

Get Segment File Data

This API is used to get the segment file data.

Authorizations:
basicAuth
header Parameters
Accept
required
string
Value: "application/JSON"
Example: application/JSON

Supported response type: JSON.

Responses

Response samples

Content type
application/json
{
  • "OUTPUT": {
    },
  • "STATUS": 200,
  • "MESSAGE": "Get segment file request accepted.",
  • "ERRORS": null
}

Get Single Segment

This API is used to fetch a single segment from the cluster.

Authorizations:
basicAuth
path Parameters
segmentName
required
string

Name of the segment to be fetched.

header Parameters
Accept
required
string
Value: "application/JSON"
Example: application/JSON

Supported response type: JSON.

Responses

Response samples

Content type
application/json
{
  • "OUTPUT": [
    ],
  • "STATUS": 200,
  • "MESSAGE": "Get segment request accepted.",
  • "ERRORS": null
}

Delete Single Segment

This API is used to delete a single segment from the cluster.

The response of the API call shows the Operation ID of the delete segments operation. To get a status of operation, use this API Get Single Operation Details or for operation log use this API Get Operation Logs.

Authorizations:
basicAuth
path Parameters
segmentName
required
string

Name of the segment to be deleted.

header Parameters
Accept
required
string
Value: "application/JSON"
Example: application/JSON

Supported response type: JSON.

Responses

Response samples

Content type
application/json
{
  • "OUTPUT": {
    },
  • "STATUS": 200,
  • "MESSAGE": "Delete segment request accepted.",
  • "ERRORS": null
}

Add Query Engine nodes to Segment

This API is used to add Query Engine nodes to a Query Engine based segment.

Authorizations:
basicAuth
header Parameters
Accept
required
string
Value: "application/JSON"
Example: application/JSON

Supported response type: JSON.

Request Body schema: application/json
NAME
required
string

Name of the Query Engine based segment to which you want to add a new node.

QUERYENGINE
required
Array of strings

Array of IP Addresses of the Query Engine nodes to be added to the segment. Provide in IP Address: QueryEngine-Instance format.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "OUTPUT": {
    },
  • "STATUS": 202,
  • "MESSAGE": "Add node in segment request accepted.",
  • "ERRORS": null
}

Delete Query Engine Nodes from Segment

This API is used to delete Query Engine nodes from a Query Engine based segment.

Authorizations:
basicAuth
header Parameters
Accept
required
string
Value: "application/JSON"
Example: application/JSON

Supported response type: JSON.

Request Body schema: application/json
NAME
required
string

Name of the Query Engine based segment from which you want to delete the Query Engine node.

QUERYENGINE
required
Array of strings

Name of the Query Engine node to be deleted from the Query Engine based segment.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "OUTPUT": {
    },
  • "STATUS": 200,
  • "MESSAGE": "Delete node in segment request accepted.",
  • "ERRORS": null
}

Get Nodes Details for Segment

This API is used to fetch details of all the nodes available in the cluster that can be added to segments.

Authorizations:
basicAuth
header Parameters
Accept
required
string
Value: "application/JSON"
Example: application/JSON

Supported response type: JSON.

Responses

Response samples

Content type
application/json
{
  • "OUTPUT": {
    },
  • "STATUS": 200,
  • "MESSAGE": "Get resources request accepted",
  • "ERRORS": null
}

Node

Kyvos Manager supports increasing and decreasing cluster capacity through REST APIs. Using the REST APIs, you can add or delete nodes from the BI Server and Query Engines.

Get Nodes Details

This API is used to fetch details of nodes available in the cluster.

Authorizations:
basicAuth
header Parameters
Accept
required
string
Value: "application/JSON"
Example: application/JSON

Supported response type: JSON.

Request Body schema: application/json
nodes
Array of strings

Array of nodes IP/hostname available in the cluster for which you want to fetch details.

services
Array of strings

Array of cluster services for which you want to fetch details.

Responses

Request samples

Content type
application/json
Example
{
  • "nodes": [
    ]
}

Response samples

Content type
application/json
{
  • "OUTPUT": {
    },
  • "STATUS": 200,
  • "MESSAGE": "Get node details request accepted.",
  • "ERRORS": null
}

Add Nodes for a Single Kyvos Service

This API is used to add nodes for a single Kyvos service. Here Kyvos Service means BI Server or Query Engine. Using this API, you can add nodes for BI Server or Query Engines.

The response of the API call shows the Operation ID of the add node operation. To get a status of operation, use this API Get Single Operation Details or for operation log use this API Get Operation Logs.

Authorizations:
basicAuth
header Parameters
Accept
required
string
Value: "application/JSON"
Example: application/JSON

Supported response type: JSON.

Request Body schema: application/json
nodes
required
Array of strings

Array of node IP/hostname that you want to add to the cluster.

service
required
string
Enum: "BISERVER" "QUERYENGINE"

Service for which you want to add the nodes. It can be BISERVER or QUERYENGINE.

Responses

Request samples

Content type
application/json
{
  • "service": "BISERVER/QUERYENGINE",
  • "nodes": [
    ]
}

Response samples

Content type
application/json
{
  • "OUTPUT": {
    },
  • "STATUS": 202,
  • "MESSAGE": "Add node request accepted.",
  • "ERRORS": null
}

Delete Nodes

This API is used to delete one or more nodes from the cluster. You cannot delete the node from a single-node cluster. Also, deletion of the Web Portal node, Standby Postgres Server node, Postgres Server node, and BI Server (single node) is not allowed.

The response of the API call shows the Operation ID of the delete node operation. To get a status of operation, use this API Get Single Operation Details or for operation log use this API Get Operation Logs.

Authorizations:
basicAuth
header Parameters
Accept
required
string
Value: "application/JSON"
Example: application/JSON

Supported response type: JSON.

Request Body schema: application/json
nodes
Array of strings

Array of IP/hostnames of the nodes to be deleted from cluster.

Responses

Request samples

Content type
application/json
{
  • "nodes": [
    ]
}

Response samples

Content type
application/json
{
  • "OUTPUT": {
    },
  • "STATUS": 200,
  • "MESSAGE": "Delete node request accepted.",
  • "ERRORS": null
}

Add Nodes for Multiple Kyvos Services

This API is used to add nodes to multiple Kyvos services in one go. Using this API, you can add nodes for both BI Server and Query Engines in a single call.

The response of the API call shows the Operation ID of the add node operation. To get a status of operation, use this API Get Single Operation Details or for operation log use this API Get Operation Logs.

Authorizations:
basicAuth
header Parameters
Accept
required
string
Value: "application/JSON"
Example: application/JSON

Supported response type: JSON.

Request Body schema: application/json
required
object

The object IP/hostnames of the nodes to be added along with the corresponding service name array.

Responses

Request samples

Content type
application/json
{
  • "nodes": {
    }
}

Response samples

Content type
application/json
{
  • "OUTPUT": {
    },
  • "STATUS": 202,
  • "MESSAGE": "Add node request accepted.",
  • "ERRORS": null
}

Application Update

Kyvos Manager REST APIs allow you to upgrade,rollback and apply patch on the application.

Upgrade Version Listing

This API is used to get the list of version available for the upgrade. The listing of available bundle is only supported in the Azure environment and for marketplace based deployment on Azure does not required client sceret in request body.

Authorizations:
basicAuth
header Parameters
Accept
required
string
Value: "application/JSON"
Example: application/JSON

Supported response type: JSON.

Request Body schema: application/json
clientSecret
string

Client secret is used to fetch the available upgrade bundles for the listing from the Azure storage.

Responses

Request samples

Content type
application/json
{
  • "clientSecret": "string"
}

Response samples

Content type
application/json
{
  • "OUTPUT": [
    ],
  • "STATUS": 202,
  • "MESSAGE": "Upgrade bundles listing request accepted.",
  • "ERRORS": null
}

Upgrade Kyvos and Kyvos Manager

This API is used to upgrade Kyvos and Kyvos Manager in one go or separately. However, to upgrade the Kyvos version separately, you must first upgrade the Kyvos Manager.

You can use version parameter to upgrade Kyvos and Kyvos Manager in a single call for Azure deployments.

To upgrade Kyvos Manager separately use either the upgradeBundlePath or the version parameter. To upgrade Kyvos only, use the upgradeBundlePath parameter.

Version parameter is supported for Cloud deployments only.

The response of application update API call shows the Operation ID of the upgrade operation. To get a status of operation, use this API Get Single Operation Details or for operation log use this API Get Operation Logs.

Authorizations:
basicAuth
header Parameters
Accept
required
string
Value: "application/JSON"
Example: application/JSON

Supported response type: JSON.

Request Body schema: application/json
component
required
string
Enum: "All" "Kyvos" "KyvosManager"

Component to be upgraded.

  • All: Upgrades both Kyvos and Kyvos Manager.
  • Kyvos: Upgrades only Kyvos.
  • Kyvos Manager: Upgrades only Kyvos Manager.

version
required
string

Version to which you want to upgrade. This parameter is supported only when upgrading either Kyvos Manager or both Kyvos and Kyvos in one go.

upgradeBundlePath
required
string

Path where the upgrade bundle is available on the Kyvos Manager machine.

startServices
boolean

Set as true to restart all the Kyvos services automatically after the upgrade. If this is false, you need to manually restart Kyvos services after the upgrade. The default value is true.

backupCubeData
boolean

Set as true to create a backup of the cube data before upgrade. If the parameter is blank, it is considered as false, and no cube data backup will be created. The default value is false.

backupLogs
boolean

Set as true to create a backup of the monitoring logs. The default value is false.

upgradeBehaviorTemplateOverwrite
boolean

Set as true to override the email template data. The default value is false.

clientSecret
string

Client secret to download the upgrade bundle from the Azure storage. This is a mandatory input if upgrading All components or Kyvos Manger using the version option on the Azure platform.

accessKeyId
string

Access key ID for AWS/GCP to download the upgrade bundle from S3/Google storage. This is a mandatory input if upgrading All components or Kyvos Manger using the version option on the AWS platform.

secretAccessKey
string

Secret access key for AWS/GCP to download the upgrade bundle from S3/Google storge. This is a mandatory input if upgrading All components or Kyvos Manger using the version option on the AWS/GCP platform.

Responses

Request samples

Content type
application/json
Example
{
  • "component": "All",
  • "version": "2023.2",
  • "clientSecret": "xxxxxxxxxxxxxx",
  • "startServices": true,
  • "backupCubeData": true
}

Response samples

Content type
application/json
{
  • "OUTPUT": {
    },
  • "STATUS": 202,
  • "MESSAGE": "The application upgrade request accepted.",
  • "ERRORS": null
}

Patch Version Listing

This API is used to get the list of available version for the patches of Kyvos. The listing of available bundle is only supported in the Azure marketplace deployment.

Authorizations:
basicAuth
header Parameters
Accept
required
string
Value: "application/JSON"
Example: application/JSON

Supported response type: JSON.

Responses

Response samples

Content type
application/json
{
  • "OUTPUT": [
    ],
  • "STATUS": 200,
  • "MESSAGE": "Patch bundle listing request accepted.",
  • "ERRORS": null
}

Apply Patch for Kyvos

This API is used to apply patch on Kyvos. User can use version and patchBundlePath parameter for apply patch on Kyvos.

Version parameter is supported for Azure marketplace deployments only. To get the list of patch bundles use this API Patch Version Listing

In response of API call, the Operation ID of the patch operation is available. To get a status of operation, use this API Get Single Operation Details or for operation log use this API Get Operation Logs.

Authorizations:
basicAuth
header Parameters
Accept
required
string
Value: "application/JSON"
Example: application/JSON

Supported response type: JSON.

Request Body schema: application/json
version
string

Version to which you want to apply patch on Kyvos. This parameter is supported only when apply patch from the marketplace deployment.

patchBundlePath
string

Path where the patch bundle is available on the Kyvos Manager machine.

startServices
boolean

Set as true to restart all the Kyvos services automatically after the patch. If this is false, you need to manually restart Kyvos services after the upgrade. The default value is true.

backupCubeData
boolean

Set as true to create a backup of the cube data before upgrade. If the parameter is blank, it is considered as false, and no cube data backup will be created. The default value is false.

backupLogs
boolean

Set as true to create a backup of the monitoring logs. The default value is false.

Responses

Request samples

Content type
application/json
Example
{
  • "version": "2023.2_Patch075.18",
  • "startServices": true,
  • "backupCubeData": true,
  • "backupLogs": true
}

Response samples

Content type
application/json
{
  • "OUTPUT": {
    },
  • "STATUS": 202,
  • "MESSAGE": "Apply patch request accepted.",
  • "ERRORS": null
}

Rollback Bundle Listing

This API is used to get the list of available bundles for the rollback.

Authorizations:
basicAuth
header Parameters
Accept
required
string
Value: "application/JSON"
Example: application/JSON

Supported response type: JSON.

Responses

Response samples

Content type
application/json
{
  • "OUTPUT": [
    ],
  • "STATUS": 200,
  • "MESSAGE": "Rollback bundle listing request accepted.",
  • "ERRORS": null
}

Rollback Application

This API is used to rollback the Kyvos and Kyvos Manager in single go. Both component rollback is supported only in Azure marketplace deployments. To get the list of rollback bundles use this API Rollback Bundle Listing

In response of API call, the Operation ID of the rollback operation is available. To get a status of operation, use this API Get Single Operation Details or for operation log use this API Get Operation Logs.

Authorizations:
basicAuth
header Parameters
Accept
required
string
Value: "application/JSON"
Example: application/JSON

Supported response type: JSON.

Request Body schema: application/json
component
required
string
Enum: "All" "Kyvos"

Component to be rollback.

  • All: Rollback both Kyvos and Kyvos Manager.
  • Kyvos: Rollback only Kyvos.

rollbackName
required
string

The rollback bundle name to which you want to rollback the Kyvos.

startServices
boolean

Set as true to restart all the Kyvos services automatically after the rollback. If this is false, you need to manually restart Kyvos services after the rollback. The default value is true.

Responses

Request samples

Content type
application/json
Example
{
  • "component": "All",
  • "rollbackName": "Kyvos2023.2_Patch087.027_ux64.tar.gz",
  • "startServices": true
}

Response samples

Content type
application/json
{
  • "OUTPUT": {
    },
  • "STATUS": 202,
  • "MESSAGE": "Application rollback request accepted.",
  • "ERRORS": null
}

Utilities

Kyvos Manager Utilities REST APIs allow you to perform operations such as synchronizing configuration and synchronizing libraries.

Synchronize Configurations

This API is used to synchronize the configuration libraries and files on each cluster node. It is required when you change the configuration paths, name node/EMR/Dataproc node IP/hostname, or change the version of compute cluster.

The response of the API call shows the Operation ID of the synchronize configurations operation. To get a status of operation, use this API Get Single Operation Details or for operation log use this API Get Operation Logs.

Authorizations:
basicAuth
header Parameters
Accept
required
string
Value: "application/JSON"
Example: application/JSON

Supported response type: JSON.

Responses

Response samples

Content type
application/json
{
  • "OUTPUT": {
    },
  • "STATUS": 202,
  • "MESSAGE": "Synchronize configuration request accepted.",
  • "ERRORS": null
}

Synchronize Libraries

This API is used to synchronize the libraries on each cluster node. It is required when you change the libraries paths, name node/EMR/Dataproc node IP/hostname, or change the version of compute cluster. The response of the API call shows the Operation ID of the synchronize libraries operation. To get a status of operation, use this API Get Single Operation Details or for operation log use this API Get Operation Logs.

Authorizations:
basicAuth
header Parameters
Accept
required
string
Value: "application/JSON"
Example: application/JSON

Supported response type: JSON.

Responses

Response samples

Content type
application/json
{
  • "OUTPUT": {
    },
  • "STATUS": 202,
  • "MESSAGE": "Synchronize libraries request accepted.",
  • "ERRORS": null
}

Operations

The Operations module of Kyvos Manager monitors user activities on the cluster. You can use the Kyvos Manager REST APIs to get the operation details, logs, and so on.

Get All Operations Details

This API is used to fetch details of all the operations performed on the cluster.

Authorizations:
basicAuth
header Parameters
Accept
required
string
Value: "application/JSON"
Example: application/JSON

Supported response type: JSON.

Responses

Response samples

Content type
application/json
{
  • "OUTPUT": {
    },
  • "STATUS": 200,
  • "MESSAGE": "Get operation details request accepted.",
  • "ERRORS": null
}

Get Single Operation Details

This API is used to fetch the details of a specific operation ID. The response includes operation name, errors, warning, execution status, start time, end time, and so on.

Authorizations:
basicAuth
path Parameters
operationId
required
string

Operation ID for which you want to fetch details.

header Parameters
Accept
required
string
Value: "application/JSON"
Example: application/JSON

Supported response type: JSON.

Responses

Response samples

Content type
application/json
{
  • "OUTPUT": {
    },
  • "STATUS": 200,
  • "MESSAGE": "Get operation details request accepted.",
  • "ERRORS": null
}

Get Operation Logs

This API is used to fetch the logs of a specific operation ID. The logs provide details of the steps performed for operation execution and details of operation failure, if any.

Authorizations:
basicAuth
path Parameters
operationId
required
string

Operation ID for which you want to fetch logs.

header Parameters
Accept
required
string
Value: "application/JSON"
Example: application/JSON

Supported response type: JSON.

Responses

Response samples

Content type
application/json
{
  • "OUTPUT": {
    },
  • "STATUS": 200,
  • "MESSAGE": "Get operation logs request accepted.",
  • "ERRORS": null
}

Get Linked Operations Details

This API is used to fetch the details of operations linked to a specific operation ID. In the operation detail call, if any operation has the linked property set as true, it means the operation is linked.

Authorizations:
basicAuth
path Parameters
operationId
required
string

Operation ID for which you want to fetch linked operations.

header Parameters
Accept
required
string
Value: "application/JSON"
Example: application/JSON

Supported response type: JSON.

Responses

Response samples

Content type
application/json
{
  • "OUTPUT": {
    },
  • "STATUS": 200,
  • "MESSAGE": "Cluster details.",
  • "ERRORS": null
}

Services

The Services module of Kyvos Manager provides you REST APIs for start/stop/restart the services of cluster. In this module you can start/stop/restart single service, group of service, all services etc.

Start/Stop/Restart Cluster Services

This API is used to start/stop/restart the all cluster services.

In response of API call, the Operation ID of the start/stop/restart cluster services operation is available. To get a status of operation, use this API Get Single Operation Details or for operation log use this API Get Operation Logs.

Authorizations:
basicAuth
path Parameters
action
required
string
Enum: "start" "stop" "restart"

The action name to be performed on cluster services.

header Parameters
Accept
required
string
Value: "application/JSON"
Example: application/JSON

Supported response type: JSON.

Responses

Response samples

Content type
application/json
{
  • "OUTPUT": {
    },
  • "STATUS": 200,
  • "MESSAGE": "Start/Stop/Restart cluster services request accepeted.",
  • "ERRORS": null
}

Start/Stop/Restart Specific Service

This API is used to start/stop/restart the given service in the cluster.

For KYVOSMANAGER service only restart action is available and for this request it never checks whether the operation is in progress or not, it will aborted the in progress operation and restart the Kyvos Manager application. In response user will not get operation ID.

For KYVOS service, it will start/stop/restart the BI Server, Query Engine, Web Portal and Postgres Server if Kyvos Manager is using the external reposiotry.

In response of API call, the Operation ID of the start/stop/restart cluster services operation is available. To get a status of operation, use this API Get Single Operation Details or for operation log use this API Get Operation Logs.

Authorizations:
basicAuth
path Parameters
serviceName
required
string
Enum: "BISERVER" "QUERYENGINE" "WEBPORTAL" "POSTGRESSERVER" "STANDBYPOSTGRESSERVER" "KMAGENT" "ZOOKEEPER" "KYVOS" "KYVOSMANAGER"

The name of service which you want to start/stop/restart.

action
required
string
Enum: "start" "stop" "restart"

The action name to be performed on cluster services.

header Parameters
Accept
required
string
Value: "application/JSON"
Example: application/JSON

Supported response type: JSON.

Responses

Response samples

Content type
application/json
{
  • "OUTPUT": {
    },
  • "STATUS": 200,
  • "MESSAGE": "Start/Stop/Restart services request accepted.",
  • "ERRORS": null
}

Start/Stop/Restart Given Node Services

This API is used to start/stop/restart the all configured services of given node.

In response of API call, the Operation ID of the start/stop/restart cluster services operation is available. To get a status of operation, use this API Get Single Operation Details or for operation log use this API Get Operation Logs.

Authorizations:
basicAuth
path Parameters
node
required
string

The IP/hostname of node which is configured in the cluster.

action
required
string
Enum: "start" "stop" "restart"

The action name to be performed on cluster services.

header Parameters
Accept
required
string
Value: "application/JSON"
Example: application/JSON

Supported response type: JSON.

Responses

Response samples

Content type
application/json
{
  • "OUTPUT": {
    },
  • "STATUS": 200,
  • "MESSAGE": "Start/Stop/Restart services request accepted.",
  • "ERRORS": null
}

Start/Stop/Restart Given Services on Node

This API is used to start/stop/restart the given service of given node.

In response of API call, the Operation ID of the start/stop/restart cluster services operation is available. To get a status of operation, use this API Get Single Operation Details or for operation log use this API Get Operation Logs.

Authorizations:
basicAuth
path Parameters
node
required
string
Example: 172.25.4.3

The IP/hostname of node which is configured in the cluster.

serviceName
required
string
Enum: "BISERVER" "QUERYENGINE" "WEBPORTAL" "POSTGRESSERVER" "STANDBYPOSTGRESSERVER" "KMAGENT" "ZOOKEEPER" "KYVOS" "KYVOSMANAGER"

The name of service which you want to start/stop/restart.

action
required
string
Enum: "start" "stop" "restart"

The action name to be performed on cluster services.

header Parameters
Accept
required
string
Value: "application/JSON"
Example: application/JSON

Supported response type: JSON.

Responses

Response samples

Content type
application/json
{
  • "OUTPUT": {
    },
  • "STATUS": 200,
  • "MESSAGE": "Start/Stop/Restart services request accepted.",
  • "ERRORS": null
}