Introduction

This documentation is for Kyvos 2026.6.x. To view documentation for other Kyvos versions, click here.

This documentation is for Kyvos 2026.6.x. To view documentation for other Kyvos versions, click here.

REST API Overview

The Kyvos REST APIs allow you to programmatically manage and administer the platform. With these APIs, you can:

Manage users, groups, roles, and security settings.
Create, update, and manage connections, datasets, dataset relationships, and semantic models.
Automate platform administration and operational workflows.
Monitor system activity, jobs, users, and cluster resources.
Configure and manage cluster scaling and other platform settings.
Integrate Kyvos with external applications, scripts, and enterprise systems.

Kyvos REST APIs support the following authentication methods:

API Key (sessionId) – Authenticates requests using a session ID, which acts as an API key. The session ID must be provided in the sessionId request header.
HTTP Basic Authentication – Authenticates requests using a username and password sent in the HTTP Authorization header.

API requests must include valid authentication credentials to access protected resources.

The URL for Kyvos REST endpoints is structured as follows:

http://{servername}:{port}/kyvos/rest/<endpoint>