Skip to main content
API docs by Redocly

Koverse Data Platform (KDP) API (4.152.0)

Download OpenAPI specification:Download

The KDP API is a REST API that can be used to create, access, and update data in KDP Workspaces. Please note that the Python client library follows Python's naming convention of snake casing for fields, even though they may appear in camel case in the API specification.

By default this api documentation targets the koverse production server at 'api.app.koverse.com' You can provide the hostname of your koverse instance to this documentation page via the 'host' query param.

For example providing host - https://koverse-docs.saic.com/api?host=api.myHost.com, will update requests to target the provided host.

Authentication request example with provided host - https://api.myHost.com/authentication

KDP Documentation

Authenticate

The authentication service can be used to generate an accessToken. The accessToken can be used for other REST requests that require authentication by sending the Authorization: Bearer HTTP header.

Creates a new Koverse Authentication Token

Authorizations:
BearerAPIKey
Request Body schema: application/json
strategy
required
string
Enum: "local" "proxy"

The method of authentication

email
required
string

The email associated with the user account

password
required
string

The password of the KDP account

workspaceId
string

The ID of the Workspace

Responses

Request samples

Content type
application/json
{
  • "strategy": "local",
  • "email": "string",
  • "password": "string",
  • "workspaceId": "string"
}

Response samples

Content type
application/json
{
  • "accessToken": "string",
  • "authentication": {
    },
  • "user": {
    }
}

Creates a new Koverse Authentication Token for Single Sign-On (SSO) users

Authorizations:
BearerAPIKey
path Parameters
workspaceId
required
string

workspaceId for authentication

Request Body schema: application/json
strategy
required
string
Enum: "keycloak" "microsoft" "google" "github" "okta" "custom"

The method of authentication for single sign-on customers

access_token
required
string

The access_token retrieved by signing into the SSO account

Responses

Request samples

Content type
application/json
{
  • "strategy": "keycloak",
  • "access_token": "string"
}

Response samples

Content type
application/json
{
  • "accessToken": "string",
  • "authentication": {
    },
  • "user": {
    }
}

Creates a new Koverse Authentication Token for API Key users

Authorizations:
BearerAPIKey
Request Body schema: application/json
strategy
required
string
Value: "api-key"

The method of authentication for API Key

key
required
string

The API Key retrieved by POST to /api-keys

Responses

Request samples

Content type
application/json
{
  • "strategy": "api-key",
  • "key": "string"
}

Response samples

Content type
application/json
{
  • "accessToken": "string",
  • "authentication": {
    },
  • "user": {
    }
}

Remove authentication with accessToken

Should be called with id set to null or to the authenticated access token. Will verify the authentication and emit the logout event if successful.

Authorizations:
BearerAPIKey
path Parameters
id
required
string

accessToken of authentication to remove

Responses

Response samples

Content type
application/json
{
  • "strategy": "local",
  • "email": "string",
  • "password": "string",
  • "workspaceId": "string"
}

Applications

Manage your Koverse Applications

Retrieves a list of Applications

Authorizations:
Bearer
query Parameters
$limit
integer

Number of results to return

$skip
integer

Number of results to skip

$sort
object

Property to sort results

filter
object

Query parameters to filter

Responses

Response samples

Content type
application/json
{
  • "total": 1,
  • "limit": 10,
  • "skip": 0,
  • "data": [
    ]
}

Create a new Application

Authorizations:
Bearer
Request Body schema: application/json
name
required
string
url
required
string <applicationUrl>
redirectUrl
required
string <applicationUrl>
workspaceId
required
string <workspaceId>
clientId
string
clientSecret
string
visible
boolean
description
string
type
string
Enum: "mls" "sls"
allowedUsers
Array of strings <uuid>
Array of objects

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "url": "string",
  • "redirectUrl": "string",
  • "workspaceId": "string",
  • "clientId": "string",
  • "clientSecret": "string",
  • "visible": true,
  • "description": "string",
  • "type": "mls",
  • "allowedUsers": [
    ],
  • "requiredDatasetAccess": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "url": "string",
  • "redirectUrl": "string",
  • "workspaceId": "string",
  • "clientId": "string",
  • "clientSecret": "string",
  • "visible": true,
  • "description": "string",
  • "type": "mls",
  • "allowedUsers": [
    ],
  • "requiredDatasetAccess": [
    ]
}

Retrieves Application with the given ID

Authorizations:
Bearer
path Parameters
id
required
string

ID of application to return

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "url": "string",
  • "redirectUrl": "string",
  • "workspaceId": "string",
  • "clientId": "string",
  • "clientSecret": "string",
  • "visible": true,
  • "description": "string",
  • "type": "mls",
  • "allowedUsers": [
    ],
  • "requiredDatasetAccess": [
    ]
}

Updates Application with the given ID

Authorizations:
Bearer
path Parameters
id
required
string

ID of application to update

Request Body schema: application/json
id
required
string <uuid>
name
required
string
url
required
string <applicationUrl>
redirectUrl
required
string <applicationUrl>
workspaceId
required
string <workspaceId>
clientId
string
clientSecret
string
visible
boolean
description
string
type
string
Enum: "mls" "sls"
allowedUsers
Array of strings <uuid>
Array of objects
resetSecret
boolean

If set to true, a new clientSecret will be generated for the application

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "url": "string",
  • "redirectUrl": "string",
  • "workspaceId": "string",
  • "clientId": "string",
  • "clientSecret": "string",
  • "visible": true,
  • "description": "string",
  • "type": "mls",
  • "allowedUsers": [
    ],
  • "requiredDatasetAccess": [
    ],
  • "resetSecret": true
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "url": "string",
  • "redirectUrl": "string",
  • "workspaceId": "string",
  • "clientId": "string",
  • "clientSecret": "string",
  • "visible": true,
  • "description": "string",
  • "type": "mls",
  • "allowedUsers": [
    ],
  • "requiredDatasetAccess": [
    ]
}

Updates provided fields of Application with the given ID

Authorizations:
Bearer
path Parameters
id
required
string

ID of application to update

Request Body schema: application/json
name
string
url
string <applicationUrl>
redirectUrl
string <applicationUrl>
workspaceId
string <workspaceId>
clientId
string
clientSecret
string
visible
boolean
description
string
type
string
Enum: "mls" "sls"
allowedUsers
Array of strings <uuid>
Array of objects
resetSecret
boolean

If set to true, a new clientSecret will be generated for the application

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "url": "string",
  • "redirectUrl": "string",
  • "workspaceId": "string",
  • "clientId": "string",
  • "clientSecret": "string",
  • "visible": true,
  • "description": "string",
  • "type": "mls",
  • "allowedUsers": [
    ],
  • "requiredDatasetAccess": [
    ],
  • "resetSecret": true
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "url": "string",
  • "redirectUrl": "string",
  • "workspaceId": "string",
  • "clientId": "string",
  • "clientSecret": "string",
  • "visible": true,
  • "description": "string",
  • "type": "mls",
  • "allowedUsers": [
    ],
  • "requiredDatasetAccess": [
    ]
}

Removes Application with the given ID

Authorizations:
Bearer
path Parameters
id
required
string

ID of application to remove

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "url": "string",
  • "redirectUrl": "string",
  • "workspaceId": "string",
  • "clientId": "string",
  • "clientSecret": "string",
  • "visible": true,
  • "description": "string",
  • "type": "mls",
  • "allowedUsers": [
    ],
  • "requiredDatasetAccess": [
    ]
}

Attribute Based Access Control

Manage your Koverse Attributes and Attribute-Assignments

Attributes - Retrieves a list of Attributes

Authorizations:
BearerAPIKey
query Parameters
$limit
integer

Number of results to return

$skip
integer

Number of results to skip

$sort
object

Property to sort results

filter
object

Query parameters to filter

Responses

Response samples

Content type
application/json
{
  • "total": 1,
  • "limit": 10,
  • "skip": 0,
  • "data": [
    ]
}

Attributes - Creates a new Attribute

Authorizations:
BearerAPIKey
Request Body schema: application/json
name
required
string
token
required
string
description
string
workspaceId
string <workspaceId>

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "token": "string",
  • "description": "string",
  • "workspaceId": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "token": "string",
  • "description": "string",
  • "workspaceId": "string"
}

Attributes - Retrieve Attribute with the given ID

Authorizations:
BearerAPIKey
path Parameters
id
required
string

ID of attribute to return

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "token": "string",
  • "description": "string",
  • "workspaceId": "string"
}

Attributes - Update Attribute with the given ID

Authorizations:
BearerAPIKey
path Parameters
id
required
string

ID of attribute to update

Request Body schema: application/json
id
required
string <uuid>
name
required
string
token
required
string
description
string
workspaceId
string <workspaceId>

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "token": "string",
  • "description": "string",
  • "workspaceId": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "token": "string",
  • "description": "string",
  • "workspaceId": "string"
}

Attributes - Update provided fields of Attribute with the given ID

Authorizations:
BearerAPIKey
path Parameters
id
required
string

ID of attribute to update

Request Body schema: application/json
name
string
token
string
description
string
workspaceId
string <workspaceId>

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "token": "string",
  • "description": "string",
  • "workspaceId": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "token": "string",
  • "description": "string",
  • "workspaceId": "string"
}

Attributes - Remove Attribute with the given ID

Authorizations:
BearerAPIKey
path Parameters
id
required
string

ID of attribute to remove

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "token": "string",
  • "description": "string",
  • "workspaceId": "string"
}

Attributes - Retrieve a list of Attribute Assignments

Authorizations:
BearerAPIKey
query Parameters
workspaceId
string

workspace id

attributeId
string

attributeId

userId
string

userId

attribute
string

attribute

$limit
integer

Number of results to return

$skip
integer

Number of results to skip

$sort
object

Property to sort results

filter
object

Query parameters to filter

Responses

Response samples

Content type
application/json
{
  • "total": 1,
  • "limit": 10,
  • "skip": 0,
  • "data": [
    ]
}

Attribute-Assignments - Create a new Attribute Assignment

Authorizations:
BearerAPIKey
Request Body schema: application/json
attributeId
required
string <uuid>
userId
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "attributeId": "4373db18-af63-40d4-ad40-80a2c734bfcf",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "attributeId": "4373db18-af63-40d4-ad40-80a2c734bfcf",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "attribute": {
    },
  • "user": {
    }
}

Attribute-Assignments - Retrieve Attribute Assignment with the given ID

Authorizations:
BearerAPIKey
path Parameters
id
required
string

ID of attribute-assignment to return

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "attributeId": "4373db18-af63-40d4-ad40-80a2c734bfcf",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "attribute": {
    },
  • "user": {
    }
}

Attribute-Assignments - Update an Attribute Assignment by given ID

Authorizations:
BearerAPIKey
path Parameters
id
required
string

ID of attribute-assignment to update

Request Body schema: application/json
id
required
string <uuid>
attributeId
required
string <uuid>
userId
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "attributeId": "4373db18-af63-40d4-ad40-80a2c734bfcf",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "attributeId": "4373db18-af63-40d4-ad40-80a2c734bfcf",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "attribute": {
    },
  • "user": {
    }
}

Attribute-Assignments - Update provided fields of Attribute Assignment by given ID

Authorizations:
BearerAPIKey
path Parameters
id
required
string

ID of attribute-assignment to update

Request Body schema: application/json
attributeId
string <uuid>
userId
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "attributeId": "4373db18-af63-40d4-ad40-80a2c734bfcf",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "attributeId": "4373db18-af63-40d4-ad40-80a2c734bfcf",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "attribute": {
    },
  • "user": {
    }
}

Attribute-Assignments - Remove Attribute Assignment with given ID

Authorizations:
BearerAPIKey
path Parameters
id
required
string

ID of attribute-assignment to remove

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "attributeId": "4373db18-af63-40d4-ad40-80a2c734bfcf",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "attribute": {
    },
  • "user": {
    }
}

Schema - Modify schema by adding new column security configuration

Authorizations:
Bearer
path Parameters
datasetId
required
string <uuid>

dataset ID

Request Body schema: application/json
object (Security label patch request)

The schema object in json format.

Responses

Request samples

Content type
application/json
{
  • "id": {
    },
  • "make": {
    }
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "message": "string",
  • "code": 0
}

Datasets

Manage your Koverse Datasets

Datasets - Retrieve a list of datasets

Authorizations:
BearerAPIKey
query Parameters
$limit
integer

Number of results to return

$skip
integer

Number of results to skip

$sort
object

Property to sort results

filter
object

Query parameters to filter

Responses

Response samples

Content type
application/json
{
  • "total": 1,
  • "limit": 10,
  • "skip": 0,
  • "data": [
    ]
}

Datasets - Create a new Dataset

Authorizations:
BearerAPIKey
Request Body schema: application/json
name
required
string
recordCount
number
description
string
autoCreateIndexes
boolean
schema
object
searchAnyField
boolean
workspaceId
required
string <workspaceId>

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "recordCount": 0,
  • "description": "string",
  • "autoCreateIndexes": true,
  • "schema": { },
  • "searchAnyField": true,
  • "workspaceId": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "recordCount": 0,
  • "description": "string",
  • "autoCreateIndexes": true,
  • "schema": { },
  • "searchAnyField": true,
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "workspaceId": "string",
  • "currentUserPermissions": {
    }
}

Datasets - Retrieve a Dataset with the given ID

Authorizations:
BearerAPIKey
path Parameters
id
required
string

ID of dataset to return

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "recordCount": 0,
  • "description": "string",
  • "autoCreateIndexes": true,
  • "schema": { },
  • "searchAnyField": true,
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "workspaceId": "string",
  • "currentUserPermissions": {
    }
}

Datasets - Updates Dataset with given ID

Authorizations:
BearerAPIKey
path Parameters
id
required
string

ID of dataset to update

Request Body schema: application/json
id
string <uuid>
name
required
string
recordCount
number
description
string
autoCreateIndexes
boolean
schema
object
searchAnyField
boolean

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "recordCount": 0,
  • "description": "string",
  • "autoCreateIndexes": true,
  • "schema": { },
  • "searchAnyField": true
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "recordCount": 0,
  • "description": "string",
  • "autoCreateIndexes": true,
  • "schema": { },
  • "searchAnyField": true,
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "workspaceId": "string",
  • "currentUserPermissions": {
    }
}

Datasets - Updates the provided fields of Dataset with given ID

Authorizations:
BearerAPIKey
path Parameters
id
required
string

ID of dataset to update

Request Body schema: application/json
id
string <uuid>
name
string
recordCount
number
description
string
autoCreateIndexes
boolean
schema
object
searchAnyField
boolean

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "recordCount": 0,
  • "description": "string",
  • "autoCreateIndexes": true,
  • "schema": { },
  • "searchAnyField": true
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "recordCount": 0,
  • "description": "string",
  • "autoCreateIndexes": true,
  • "schema": { },
  • "searchAnyField": true,
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "workspaceId": "string",
  • "currentUserPermissions": {
    }
}

Datasets - Remove Dataset with given ID

Authorizations:
BearerAPIKey
path Parameters
id
required
string

ID of dataset to remove

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "recordCount": 0,
  • "description": "string",
  • "autoCreateIndexes": true,
  • "schema": { },
  • "searchAnyField": true,
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "workspaceId": "string",
  • "currentUserPermissions": {
    }
}

Jobs - Retrieves list of Jobs

Authorizations:
BearerAPIKey
query Parameters
workspaceId
string

workspaceId

datasetId
required
string

datasetId

$limit
integer

Number of results to return

$skip
integer

Number of results to skip

$sort
object

Property to sort results

filter
object

Query parameters to filter

Responses

Response samples

Content type
application/json
{
  • "total": 1,
  • "limit": 10,
  • "skip": 0,
  • "data": [
    ]
}

Jobs - Creates a new Job

Authorizations:
BearerAPIKey
Request Body schema: application/json
id
string <uuid>

job ID

type
required
string
Enum: "ingest" "reindex" "clear-dataset" "delete-record" "delete-document"

job type

status
string
Enum: "queued" "running" "completed" "canceled" "failed"

job status

config
object

job config

error
object

job error

stage
number

job stage

totalStages
number

count of stages

datasetId
required
string <uuid>

dataset ID

workspaceId
required
string <workspaceId>

workspace ID

userId
required
string <uuid>

user ID

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "type": "ingest",
  • "status": "queued",
  • "config": { },
  • "error": { },
  • "stage": 0,
  • "totalStages": 0,
  • "datasetId": "6586f21b-ad4d-4d06-a309-712af47184a2",
  • "workspaceId": "string",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "type": "ingest",
  • "status": "queued",
  • "config": { },
  • "error": { },
  • "stage": 0,
  • "totalStages": 0,
  • "datasetId": "6586f21b-ad4d-4d06-a309-712af47184a2",
  • "workspaceId": "string",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b"
}

Jobs - Retrieve Job with the given ID

Authorizations:
BearerAPIKey
path Parameters
id
required
string

ID of job to return

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "type": "ingest",
  • "status": "queued",
  • "config": { },
  • "error": { },
  • "stage": 0,
  • "totalStages": 0,
  • "datasetId": "6586f21b-ad4d-4d06-a309-712af47184a2",
  • "workspaceId": "string",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b"
}

Jobs - Updates Job with the ID given

Authorizations:
BearerAPIKey
path Parameters
id
required
string

ID of job to update

Request Body schema: application/json
id
string <uuid>

job ID

type
required
string
Enum: "ingest" "reindex" "clear-dataset" "delete-record" "delete-document"

job type

status
string
Enum: "queued" "running" "completed" "canceled" "failed"

job status

config
object

job config

error
object

job error

stage
number

job stage

totalStages
number

count of stages

datasetId
required
string <uuid>

dataset ID

workspaceId
required
string <workspaceId>

workspace ID

userId
required
string <uuid>

user ID

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "type": "ingest",
  • "status": "queued",
  • "config": { },
  • "error": { },
  • "stage": 0,
  • "totalStages": 0,
  • "datasetId": "6586f21b-ad4d-4d06-a309-712af47184a2",
  • "workspaceId": "string",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "type": "ingest",
  • "status": "queued",
  • "config": { },
  • "error": { },
  • "stage": 0,
  • "totalStages": 0,
  • "datasetId": "6586f21b-ad4d-4d06-a309-712af47184a2",
  • "workspaceId": "string",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b"
}

Jobs - Updates fields provided for Jobs with the ID given

Authorizations:
BearerAPIKey
path Parameters
id
required
string

ID of job to update

Request Body schema: application/json
id
string <uuid>

job ID

type
required
string
Enum: "ingest" "reindex" "clear-dataset" "delete-record" "delete-document"

job type

status
string
Enum: "queued" "running" "completed" "canceled" "failed"

job status

config
object

job config

error
object

job error

stage
number

job stage

totalStages
number

count of stages

datasetId
required
string <uuid>

dataset ID

workspaceId
required
string <workspaceId>

workspace ID

userId
required
string <uuid>

user ID

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "type": "ingest",
  • "status": "queued",
  • "config": { },
  • "error": { },
  • "stage": 0,
  • "totalStages": 0,
  • "datasetId": "6586f21b-ad4d-4d06-a309-712af47184a2",
  • "workspaceId": "string",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "type": "ingest",
  • "status": "queued",
  • "config": { },
  • "error": { },
  • "stage": 0,
  • "totalStages": 0,
  • "datasetId": "6586f21b-ad4d-4d06-a309-712af47184a2",
  • "workspaceId": "string",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b"
}

Schema - Get the schema for the given dataset id

Authorizations:
BearerAPIKey
path Parameters
datasetId
required
string <uuid>

dataset ID

query Parameters
includeSecurityField
boolean
Default: false

Boolean flag to include the security field (_koverse_security_label) for each schema entry.

includeNestedFields
boolean
Default: false

Boolean flag to include nested fields of the schema such as the child fields of an object or map. To include top level fields only, keep set to false.

Responses

Response samples

Content type
application/json
{
  • "property1": {
    },
  • "property2": {
    }
}

Segments - Retrieves a list of Segments

Authorizations:
BearerAPIKey
query Parameters
workspaceId
string

workspaceId

datasetId
required
string

datasetId

jobId
string

jobId

$limit
integer

Number of results to return

$skip
integer

Number of results to skip

$sort
object

Property to sort results

filter
object

Query parameters to filter

Responses

Response samples

Content type
application/json
{
  • "total": 1,
  • "limit": 10,
  • "skip": 0,
  • "data": [
    ]
}

Segments - Retrieves Segment with the given ID

Authorizations:
BearerAPIKey
path Parameters
id
required
string

ID of segment to return

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "config": { },
  • "stage": 0,
  • "status": "queued",
  • "error": { },
  • "datasetId": "6586f21b-ad4d-4d06-a309-712af47184a2",
  • "workspaceId": "string",
  • "jobId": "9d222c6d-893e-4e79-8201-3c9ca16a0f39",
  • "processedBy": "string",
  • "uploadId": "ef523ba8-509e-47af-8e2c-5fa751596497"
}

Dataset Pairing

Manage your Koverse Dataset Pairing

Retrieve a list of Dataset Syncs

Authorizations:
Bearer
query Parameters
datasetId
string <uuid>

Dataset ID

status
string
Enum: "pending" "active" "canceled"

Status of the Dataset Sync

type
string
Enum: "read" "write" "manage"

Type of the Dataset Sync

read - the paired replica dataset can only read records from the origin dataset

write - the paired replica dataset can only write records to the origin dataset

manage - the paired replica dataset can read records from the origin dataset,
write records to the origin dataset, and delete records from the origin dataset

$limit
integer

Number of results to return

$skip
integer

Number of results to skip

$sort
object

Property to sort results

filter
object

Query parameters to filter

Responses

Response samples

Content type
application/json
{
  • "total": 1,
  • "limit": 10,
  • "skip": 0,
  • "data": [
    ]
}

Create Sync Key (Create Origin Dataset Sync)

Authorizations:
Bearer
Request Body schema: application/json
datasetId
required
string <uuid>

dataset ID

type
required
string
Enum: "read" "write" "manage"

Type of the Dataset Sync

read - the paired replica dataset can only read records from the origin dataset

write - the paired replica dataset can only write records to the origin dataset

manage - the paired replica dataset can read records from the origin dataset,
write records to the origin dataset, and delete records from the origin dataset

Responses

Request samples

Content type
application/json
{
  • "datasetId": "6586f21b-ad4d-4d06-a309-712af47184a2",
  • "type": "read"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "datasetId": "6586f21b-ad4d-4d06-a309-712af47184a2",
  • "status": "pending",
  • "type": "read",
  • "key": "string",
  • "createdByUserId": "4d2aef9a-17b0-44e6-902e-616812033620",
  • "isOriginWorkspace": true,
  • "host": "myKoverseWorkspaceName.api.myKoverseHostName.com",
  • "workspaceId": "myWorkspace",
  • "workspaceUniqueId": "b9569c3a-1a3e-433b-87e2-f8462dfd83a3",
  • "syncId": "24d9ea7f-fdab-4f53-95fd-4deda2362964",
  • "syncHost": "myReplicaWorkspaceName.api.myReplicaKoverseHostName.com",
  • "syncDatasetId": "ff86e890-19c7-4534-bc79-01f4f62d141c",
  • "syncWorkspaceId": null,
  • "syncWorkspaceUniqueId": "0e71e4c7-8672-4407-95c6-b6a409f2a296",
  • "lastSyncAt": "2019-08-24T14:15:22Z"
}

Create and activate a Dataset Sync from key (Create Replica Dataset Sync)

Authorizations:
Bearer
Request Body schema: application/json
key
required
string

Security key used for the dataset sync

Is the key field from Create Sync Key (Create Origin Dataset Sync) response body.

Plain Text key is only available from the Create Sync Key (Create Origin Dataset Sync) POST response, key is encrypted on GET requests.

syncHost
required
string

The Host Name of the paired Sync Workspace

syncId
required
string <uuid>

The ID of the dataset-sync in paired Sync Workspace

For a paired replica, this is the Origin Dataset Sync ID

For the origin sync, this is the Paired Replica Dataset Sync ID

Responses

Request samples

Content type
application/json
{
  • "key": "string",
  • "syncHost": "myReplicaWorkspaceName.api.myReplicaKoverseHostName.com",
  • "syncId": "24d9ea7f-fdab-4f53-95fd-4deda2362964"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "datasetId": "6586f21b-ad4d-4d06-a309-712af47184a2",
  • "status": "pending",
  • "type": "read",
  • "key": "string",
  • "createdByUserId": "4d2aef9a-17b0-44e6-902e-616812033620",
  • "isOriginWorkspace": true,
  • "host": "myKoverseWorkspaceName.api.myKoverseHostName.com",
  • "workspaceId": "myWorkspace",
  • "workspaceUniqueId": "b9569c3a-1a3e-433b-87e2-f8462dfd83a3",
  • "syncId": "24d9ea7f-fdab-4f53-95fd-4deda2362964",
  • "syncHost": "myReplicaWorkspaceName.api.myReplicaKoverseHostName.com",
  • "syncDatasetId": "ff86e890-19c7-4534-bc79-01f4f62d141c",
  • "syncWorkspaceId": null,
  • "syncWorkspaceUniqueId": "0e71e4c7-8672-4407-95c6-b6a409f2a296",
  • "lastSyncAt": "2019-08-24T14:15:22Z"
}

Retrieve a Dataset Sync with the given ID

Authorizations:
Bearer
path Parameters
id
required
string

ID of dataset-sync to return

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "datasetId": "6586f21b-ad4d-4d06-a309-712af47184a2",
  • "status": "pending",
  • "type": "read",
  • "key": "string",
  • "createdByUserId": "4d2aef9a-17b0-44e6-902e-616812033620",
  • "isOriginWorkspace": true,
  • "host": "myKoverseWorkspaceName.api.myKoverseHostName.com",
  • "workspaceId": "myWorkspace",
  • "workspaceUniqueId": "b9569c3a-1a3e-433b-87e2-f8462dfd83a3",
  • "syncId": "24d9ea7f-fdab-4f53-95fd-4deda2362964",
  • "syncHost": "myReplicaWorkspaceName.api.myReplicaKoverseHostName.com",
  • "syncDatasetId": "ff86e890-19c7-4534-bc79-01f4f62d141c",
  • "syncWorkspaceId": null,
  • "syncWorkspaceUniqueId": "0e71e4c7-8672-4407-95c6-b6a409f2a296",
  • "lastSyncAt": "2019-08-24T14:15:22Z"
}

Update Dataset Sync with the given ID

Authorizations:
Bearer
path Parameters
id
required
string

ID of dataset-sync to update

Request Body schema: application/json
id
required
string <uuid>

dataset sync ID

datasetId
required
string <uuid>

dataset ID

status
required
string
Enum: "pending" "active" "canceled"

Status of the dataset sync.
Pending, active, or canceled.

type
required
string
Enum: "read" "write" "manage"

Type of the Dataset Sync

read - the paired replica dataset can only read records from the origin dataset

write - the paired replica dataset can only write records to the origin dataset

manage - the paired replica dataset can read records from the origin dataset,
write records to the origin dataset, and delete records from the origin dataset

key
required
string

Security key used for the dataset sync

createdByUserId
required
string <uuid>

ID of User that created the dataset sync

isOriginWorkspace
required
boolean

Indicates if dataset for sync originates in this workspace

host
required
string

Our Host name

workspaceId
required
string

Our workspace ID

workspaceUniqueId
required
string <uuid>

Our workspace uniqueId

syncId
string <uuid>

The ID of the dataset-sync in paired Sync Workspace

For a paired replica, this is the Origin Dataset Sync ID

For the origin sync, this is the Paired Replica Dataset Sync ID

syncHost
string

The Host Name of the paired Sync Workspace

syncDatasetId
string <uuid>

The ID of the dataset in paired Sync Workspace

syncWorkspaceId
any

The ID of the paired Sync Workspace

syncWorkspaceUniqueId
string <uuid>

UniqueId of the paired Sync Workspace

lastSyncAt
string <date-time>

Last Sync At - Time of last successful Sync

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "datasetId": "6586f21b-ad4d-4d06-a309-712af47184a2",
  • "status": "pending",
  • "type": "read",
  • "key": "string",
  • "createdByUserId": "4d2aef9a-17b0-44e6-902e-616812033620",
  • "isOriginWorkspace": true,
  • "host": "myKoverseWorkspaceName.api.myKoverseHostName.com",
  • "workspaceId": "myWorkspace",
  • "workspaceUniqueId": "b9569c3a-1a3e-433b-87e2-f8462dfd83a3",
  • "syncId": "24d9ea7f-fdab-4f53-95fd-4deda2362964",
  • "syncHost": "myReplicaWorkspaceName.api.myReplicaKoverseHostName.com",
  • "syncDatasetId": "ff86e890-19c7-4534-bc79-01f4f62d141c",
  • "syncWorkspaceId": null,
  • "syncWorkspaceUniqueId": "0e71e4c7-8672-4407-95c6-b6a409f2a296",
  • "lastSyncAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "datasetId": "6586f21b-ad4d-4d06-a309-712af47184a2",
  • "status": "pending",
  • "type": "read",
  • "key": "string",
  • "createdByUserId": "4d2aef9a-17b0-44e6-902e-616812033620",
  • "isOriginWorkspace": true,
  • "host": "myKoverseWorkspaceName.api.myKoverseHostName.com",
  • "workspaceId": "myWorkspace",
  • "workspaceUniqueId": "b9569c3a-1a3e-433b-87e2-f8462dfd83a3",
  • "syncId": "24d9ea7f-fdab-4f53-95fd-4deda2362964",
  • "syncHost": "myReplicaWorkspaceName.api.myReplicaKoverseHostName.com",
  • "syncDatasetId": "ff86e890-19c7-4534-bc79-01f4f62d141c",
  • "syncWorkspaceId": null,
  • "syncWorkspaceUniqueId": "0e71e4c7-8672-4407-95c6-b6a409f2a296",
  • "lastSyncAt": "2019-08-24T14:15:22Z"
}

Update provided fields of Dataset Sync with given ID

Authorizations:
Bearer
path Parameters
id
required
string

ID of dataset-sync to update

Request Body schema: application/json
id
string <uuid>

dataset sync ID

datasetId
string <uuid>

dataset ID

status
string
Enum: "pending" "active" "canceled"

Status of the dataset sync.
Pending, active, or canceled.

type
string
Enum: "read" "write" "manage"

Type of the Dataset Sync

read - the paired replica dataset can only read records from the origin dataset

write - the paired replica dataset can only write records to the origin dataset

manage - the paired replica dataset can read records from the origin dataset,
write records to the origin dataset, and delete records from the origin dataset

key
string

Security key used for the dataset sync

createdByUserId
string <uuid>

ID of User that created the dataset sync

isOriginWorkspace
boolean

Indicates if dataset for sync originates in this workspace

host
string

Our Host name

workspaceId
string

Our workspace ID

workspaceUniqueId
string <uuid>

Our workspace uniqueId

syncId
string <uuid>

The ID of the dataset-sync in paired Sync Workspace

For a paired replica, this is the Origin Dataset Sync ID

For the origin sync, this is the Paired Replica Dataset Sync ID

syncHost
string

The Host Name of the paired Sync Workspace

syncDatasetId
string <uuid>

The ID of the dataset in paired Sync Workspace

syncWorkspaceId
any

The ID of the paired Sync Workspace

syncWorkspaceUniqueId
string <uuid>

UniqueId of the paired Sync Workspace

lastSyncAt
string <date-time>

Last Sync At - Time of last successful Sync

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "datasetId": "6586f21b-ad4d-4d06-a309-712af47184a2",
  • "status": "pending",
  • "type": "read",
  • "key": "string",
  • "createdByUserId": "4d2aef9a-17b0-44e6-902e-616812033620",
  • "isOriginWorkspace": true,
  • "host": "myKoverseWorkspaceName.api.myKoverseHostName.com",
  • "workspaceId": "myWorkspace",
  • "workspaceUniqueId": "b9569c3a-1a3e-433b-87e2-f8462dfd83a3",
  • "syncId": "24d9ea7f-fdab-4f53-95fd-4deda2362964",
  • "syncHost": "myReplicaWorkspaceName.api.myReplicaKoverseHostName.com",
  • "syncDatasetId": "ff86e890-19c7-4534-bc79-01f4f62d141c",
  • "syncWorkspaceId": null,
  • "syncWorkspaceUniqueId": "0e71e4c7-8672-4407-95c6-b6a409f2a296",
  • "lastSyncAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "datasetId": "6586f21b-ad4d-4d06-a309-712af47184a2",
  • "status": "pending",
  • "type": "read",
  • "key": "string",
  • "createdByUserId": "4d2aef9a-17b0-44e6-902e-616812033620",
  • "isOriginWorkspace": true,
  • "host": "myKoverseWorkspaceName.api.myKoverseHostName.com",
  • "workspaceId": "myWorkspace",
  • "workspaceUniqueId": "b9569c3a-1a3e-433b-87e2-f8462dfd83a3",
  • "syncId": "24d9ea7f-fdab-4f53-95fd-4deda2362964",
  • "syncHost": "myReplicaWorkspaceName.api.myReplicaKoverseHostName.com",
  • "syncDatasetId": "ff86e890-19c7-4534-bc79-01f4f62d141c",
  • "syncWorkspaceId": null,
  • "syncWorkspaceUniqueId": "0e71e4c7-8672-4407-95c6-b6a409f2a296",
  • "lastSyncAt": "2019-08-24T14:15:22Z"
}

Terminate a Dataset-Sync Connection

Authorizations:
Bearer
Request Body schema: application/json
action
required
string

The dataset sync management action

datasetSyncId
required
string <uuid>

The ID of the dataset-sync with the connection

Responses

Request samples

Content type
application/json
{
  • "action": "terminateConnection",
  • "datasetSyncId": "a267d4aa-efa2-42d1-87ad-fd049329a5a5"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "error": "string",
  • "sync": {
    }
}

Dataset Permissions

Manage your Koverse Dataset Permissions

Retrieve list of dataset permissions

Authorizations:
BearerAPIKey
query Parameters
$limit
integer

Number of results to return

$skip
integer

Number of results to skip

$sort
object

Property to sort results

filter
object

Query parameters to filter

Responses

Response samples

Content type
application/json
{
  • "total": 1,
  • "limit": 10,
  • "skip": 0,
  • "data": [
    ]
}

Create a new Dataset Permission

Authorizations:
BearerAPIKey
Request Body schema: application/json
action
required
string
Enum: "read" "write" "manage"
datasetId
required
string <uuid>
groupId
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "action": "read",
  • "datasetId": "6586f21b-ad4d-4d06-a309-712af47184a2",
  • "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "action": "read",
  • "datasetId": "6586f21b-ad4d-4d06-a309-712af47184a2",
  • "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55"
}

Retrieve a Dataset Permission with the given ID

Authorizations:
BearerAPIKey
path Parameters
id
required
string

ID of dataset-permission to return

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "action": "read",
  • "datasetId": "6586f21b-ad4d-4d06-a309-712af47184a2",
  • "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55"
}

Update Dataset Permission with the given ID

Authorizations:
BearerAPIKey
path Parameters
id
required
string

ID of dataset-permission to update

Request Body schema: application/json
id
required
string <uuid>
action
required
string
Enum: "read" "write" "manage"
datasetId
required
string <uuid>
groupId
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "action": "read",
  • "datasetId": "6586f21b-ad4d-4d06-a309-712af47184a2",
  • "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "action": "read",
  • "datasetId": "6586f21b-ad4d-4d06-a309-712af47184a2",
  • "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55"
}

Update provided fields of Dataset Permission with given ID

Authorizations:
BearerAPIKey
path Parameters
id
required
string

ID of dataset-permission to update

Request Body schema: application/json
action
string
Enum: "read" "write" "manage"
datasetId
string <uuid>
groupId
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "action": "read",
  • "datasetId": "6586f21b-ad4d-4d06-a309-712af47184a2",
  • "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "action": "read",
  • "datasetId": "6586f21b-ad4d-4d06-a309-712af47184a2",
  • "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55"
}

Remove Dataset Permission with given ID

Authorizations:
BearerAPIKey
path Parameters
id
required
string

ID of dataset-permission to remove

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "action": "read",
  • "datasetId": "6586f21b-ad4d-4d06-a309-712af47184a2",
  • "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55"
}

Indexing

Manage your Koverse Indexing

Indexes - Retrieve list of Indexes

Authorizations:
BearerAPIKey
query Parameters
datasetId
required
string

dataset id

fields
boolean

populate fields

$limit
integer

Number of results to return

$skip
integer

Number of results to skip

$sort
object

Property to sort results

filter
object

Query parameters to filter

Responses

Response samples

Content type
application/json
{
  • "total": 1,
  • "limit": 10,
  • "skip": 0,
  • "data": [
    ]
}

Indexes - Create a new Index

Authorizations:
BearerAPIKey
Request Body schema: application/json
id
string <uuid>

index ID

datasetId
required
string <uuid>

dataset ID

fields
required
Array of strings

dataset fields

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "datasetId": "6586f21b-ad4d-4d06-a309-712af47184a2",
  • "fields": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "datasetId": "6586f21b-ad4d-4d06-a309-712af47184a2",
  • "fields": [
    ]
}

Indexes - Retrieve Index with given ID

Authorizations:
BearerAPIKey
path Parameters
id
required
string

ID of index to return

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "datasetId": "6586f21b-ad4d-4d06-a309-712af47184a2",
  • "fields": [
    ]
}

Indexes - Updates Index with given ID

Authorizations:
BearerAPIKey
path Parameters
id
required
string

ID of index to update

Request Body schema: application/json
id
string <uuid>

index ID

datasetId
required
string <uuid>

dataset ID

fields
required
Array of strings

dataset fields

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "datasetId": "6586f21b-ad4d-4d06-a309-712af47184a2",
  • "fields": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "datasetId": "6586f21b-ad4d-4d06-a309-712af47184a2",
  • "fields": [
    ]
}

Indexes - Updates fields provided for Index with the ID given

Authorizations:
BearerAPIKey
path Parameters
id
required
string

ID of index to update

Request Body schema: application/json
id
string <uuid>

index ID

datasetId
required
string <uuid>

dataset ID

fields
required
Array of strings

dataset fields

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "datasetId": "6586f21b-ad4d-4d06-a309-712af47184a2",
  • "fields": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "datasetId": "6586f21b-ad4d-4d06-a309-712af47184a2",
  • "fields": [
    ]
}

Indexes - Removes Index with the given ID

Authorizations:
BearerAPIKey
path Parameters
id
required
string

ID of index to remove

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "datasetId": "6586f21b-ad4d-4d06-a309-712af47184a2",
  • "fields": [
    ]
}

Manage Records

Manage your Koverse Dataset Records including clearing and deleting records

Delete - Clear a dataset

Remove all the records and indices for the dataset but keep the empty dataset available for use

Authorizations:
BearerAPIKey
path Parameters
datasetId
required
string

ID of dataset to be cleared

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "type": "ingest",
  • "status": "queued",
  • "config": { },
  • "error": { },
  • "stage": 0,
  • "totalStages": 0,
  • "datasetId": "6586f21b-ad4d-4d06-a309-712af47184a2",
  • "workspaceId": "string",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b"
}

Delete Documents - Deletes documents from a dataset based on a given query

Authorizations:
BearerAPIKey
path Parameters
datasetId
required
string

Dataset ID

Request Body schema: application/json
query
required
string

Documents identified by running this query will be deleted

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "type": "ingest",
  • "status": "queued",
  • "config": { },
  • "error": { },
  • "stage": 0,
  • "totalStages": 0,
  • "datasetId": "6586f21b-ad4d-4d06-a309-712af47184a2",
  • "workspaceId": "string",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b"
}

Delete Records - Deletes records from a dataset based on the given ids

Authorizations:
BearerAPIKey
path Parameters
datasetId
required
string <uuid>

Dataset ID

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

Ids of the records to be deleted. To delete all the records in the dataset set this to empty array and set deleteAll parameter to true

deleteAll
boolean
Default: false

If this boolean is set to true, delete all records in the dataset that are visible to the user

Responses

Request samples

Content type
application/json
{
  • "recordIds": [
    ],
  • "deleteAll": false
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "type": "ingest",
  • "status": "queued",
  • "config": { },
  • "error": { },
  • "stage": 0,
  • "totalStages": 0,
  • "datasetId": "6586f21b-ad4d-4d06-a309-712af47184a2",
  • "workspaceId": "string",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b"
}

Delete Records - Deletes records from a dataset based on a given query

Authorizations:
BearerAPIKey
path Parameters
datasetId
required
string

Dataset ID

Request Body schema: application/json
query
required
string

Records identified by running this query will be deleted

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "type": "ingest",
  • "status": "queued",
  • "config": { },
  • "error": { },
  • "stage": 0,
  • "totalStages": 0,
  • "datasetId": "6586f21b-ad4d-4d06-a309-712af47184a2",
  • "workspaceId": "string",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b"
}

Read and Query

The read service can be used for fast access to records in KDP datasets.

Query a dataset

Search a dataset using a SQL query string. Standard SQL is supported in the expression.

Authorizations:
BearerAPIKey
query Parameters
includeInternalFields
boolean
Default: false

(Advanced) If true, include koverse internal fields in the response body

Request Body schema: application/json
datasetId
string <uuid>

The ID of the dataset where this query will run

expression
string

The Sql Expression written in query language made up of one or more values, operators, or SQL functions

limit
integer <int32>

The maximum number of records to return for the query, providing -1 returns all records

offset
integer <int32>

The number of records from the beginning of a record batch where the current batch will start, used for paging results

credentialsSubset
Array of strings

A list of credentials that can be provided to return records of a more limited subset than that of the authenticated caller

orderedResults
boolean
Default: false

If true, the results will be returned prioritizing order over response speed

Responses

Request samples

Content type
application/json
{
  • "datasetId": "97d23549-fd63-41b2-9950-bcc7f566e4d4",
  • "expression": "select * from \"97d23549-fd63-41b2-9950-bcc7f566e4d4\" where \"alphabet\" = 'a'",
  • "limit": 10,
  • "offset": 0,
  • "credentialsSubset": [
    ],
  • "orderedResults": false
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "message": "string",
  • "code": 0
}

Query document for a dataset using the lucene query syntax

Search document records for a dataset using lucene query syntax. Supported features include wildcards, range queries, search across all fields, and many more.

Authorizations:
BearerAPIKey
Request Body schema: application/json
datasetId
string <uuid>

The ID of the dataset where this query will run

expression
string

The query in lucene query syntax

recordIds
Array of strings

Collection of record ids. Each record id is the same as the _koverse_record_id. If the record ids are present in the request, the expression is ignored

limit
integer <int32>

The maximum number of records to return for the query, providing -1 returns all records

offset
integer <int32>

The number of records from the beginning of a record batch where the current batch will start, used for paging results

credentialsSubset
Array of strings

A list of credentials that can be provided to return records of a more limited subset than that of the authenticated caller

Responses

Request samples

Content type
application/json
{
  • "datasetId": "97d23549-fd63-41b2-9950-bcc7f566e4d4",
  • "expression": "alphabet:a",
  • "recordIds": [
    ],
  • "limit": 10,
  • "offset": 0,
  • "credentialsSubset": [
    ]
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "message": "string",
  • "code": 0
}

Query a dataset using the lucene query syntax

Search a dataset using lucene query syntax. Supported features include wildcards, range queries, search across all fields, and many more.

Authorizations:
BearerAPIKey
query Parameters
includeInternalFields
boolean
Default: false

(Advanced) If true, include koverse internal fields in the response body

Request Body schema: application/json
datasetId
string <uuid>

The ID of the dataset where this query will run

expression
string

The query in lucene query syntax

limit
integer <int32>

The maximum number of records to return for the query, providing -1 returns all records

offset
integer <int32>

The number of records from the beginning of a record batch where the current batch will start, used for paging results

credentialsSubset
Array of strings

A list of credentials that can be provided to return records of a more limited subset than that of the authenticated caller

orderedResults
boolean
Default: false

If true, the results will be returned prioritizing order over response speed

Responses

Request samples

Content type
application/json
{
  • "datasetId": "97d23549-fd63-41b2-9950-bcc7f566e4d4",
  • "expression": "alphabet: a",
  • "limit": 10,
  • "offset": 0,
  • "credentialsSubset": [
    ],
  • "orderedResults": false
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "message": "string",
  • "code": 0
}

Query all datasets

Search in all fields across all datasets you have access to for the same value. Returns a list of datasets and the number of matching records found in each dataset. Supported features include wildcards and range queries.

Authorizations:
BearerAPIKey
Request Body schema: application/json
expression
string

The term that you want to search for

searchId
string <uuid>

A uuid used for paging through search results.

limit
integer <int32>

The maximum number of datasets to return for the query, providing -1 returns all datasets that contain matching records

offset
integer <int32>

The number of datasets from the beginning where the current results will start, used for paging results

credentialsSubset
Array of strings

A list of credentials that can be provided to return records of a more limited subset than that of the authenticated caller

Responses

Request samples

Content type
application/json
{
  • "expression": "Seattle",
  • "searchId": "34bc843d-c96f-476b-96c3-e286e83ae311",
  • "limit": 10,
  • "offset": 0,
  • "credentialsSubset": [
    ]
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "message": "string",
  • "code": 0
}

Read records

Read a batch of records from partitions.

Dataset partitions can be read in parallel, using the record ranges of partitions (from the splits endpoint), and calling the read endpoint with each partition range. In the read in parallel use case, the startingRecordId is the start of each partition range, and the endingRecordId is the last record of each partition range.

Authorizations:
BearerAPIKey
Request Body schema: application/json
datasetId
string

ID of the dataset (uuid)

startingRecordId
string

ID of the record that will be the start of the range for the read request

endingRecordId
string

ID of the record that will be the end of the range for the read request

excludeStartingRecordId
boolean

Boolean that indicates if the first record should be included in the range of the read request

includeInternalRecordId
boolean

Boolean that indicates if the Koverse Internal Record Id should be included

batchSize
integer <int32>

Maximum number of records that should be included in this batch

credentialsSubset
Array of strings

A list of credentials that can be provided to return records of a more limited subset than that of the authenticated caller

Responses

Request samples

Content type
application/json
{
  • "datasetId": "0fc3f37a-6e55-4879-b085-c541859ab456",
  • "startingRecordId": "string",
  • "endingRecordId": "string",
  • "excludeStartingRecordId": true,
  • "includeInternalRecordId": true,
  • "batchSize": 0,
  • "credentialsSubset": [
    ]
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "message": "string",
  • "code": 0
}

Read records from dataset in sequence

Authorizations:
BearerAPIKey
Request Body schema: application/json
datasetId
string

ID of the dataset (uuid)

startingRecordId
string

ID of the record that will be the start of the range for the read request

endingRecordId
string

ID of the record that will be the end of the range for the read request

excludeStartingRecordId
boolean

Boolean that indicates if the first record should be included in the range of the read request

includeInternalRecordId
boolean

Boolean that indicates if the Koverse Internal Record Id should be included

batchSize
integer <int32>

Maximum number of records that should be included in this batch

credentialsSubset
Array of strings

A list of credentials that can be provided to return records of a more limited subset than that of the authenticated caller

Responses

Request samples

Content type
application/json
{
  • "datasetId": "0fc3f37a-6e55-4879-b085-c541859ab456",
  • "startingRecordId": "string",
  • "endingRecordId": "string",
  • "excludeStartingRecordId": true,
  • "includeInternalRecordId": true,
  • "batchSize": 0,
  • "credentialsSubset": [
    ]
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "message": "string",
  • "code": 0
}

Serve-Media - Performs authentication and authorization checks for users before providing a media url

Authorizations:
BearerAPIKey
path Parameters
datasetId
required
string

Dataset ID containing the document

query Parameters
documentId
required
string

Document ID

download
boolean

Optional parameter to request the url as content to be downloaded

Responses

Response samples

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

Get record ranges of partitions

Get a list of record ranges. Each range consists of an array containing the starting record ID of the partition, followed by the ending record ID of the partition. For use by applications that want to read data partitions in parallel, such as with spark. Each partition's records can be read via the read endpoint in parallel to proficiently read large datasets.

Authorizations:
BearerAPIKey
path Parameters
datasetId
required
string

dataset ID

Responses

Response samples

Content type
*/*
[
  {
    "ranges": [
      [
        "0.b910ceca-4718-4240-ac6a-ce926006bd2c",
        "0.b910ceca-4718-4240-ac6a-ce926006bd2d"
      ],
      [
        "1.b910ceca-4718-4240-ac6a-ce926006bd2c",
        "1.b910ceca-4718-4240-ac6a-ce926006bd2d"
      ],
      [
        "2.b910ceca-4718-4240-ac6a-ce926006bd2c",
        "2.b910ceca-4718-4240-ac6a-ce926006bd2d"
      ],
      [
        "3.b910ceca-4718-4240-ac6a-ce926006bd2c",
        "3.b910ceca-4718-4240-ac6a-ce926006bd2d"
      ],
      [
        "4.b910ceca-4718-4240-ac6a-ce926006bd2c",
        "4.b910ceca-4718-4240-ac6a-ce926006bd2d"
      ],
      [
        "5.b910ceca-4718-4240-ac6a-ce926006bd2c",
        "5.b910ceca-4718-4240-ac6a-ce926006bd2d"
      ],
      [
        "6.b910ceca-4718-4240-ac6a-ce926006bd2c",
        "6.b910ceca-4718-4240-ac6a-ce926006bd2d"
      ],
      [
        "7.b910ceca-4718-4240-ac6a-ce926006bd2c",
        "7.b910ceca-4718-4240-ac6a-ce926006bd2d"
      ],
      [
        "8.b910ceca-4718-4240-ac6a-ce926006bd2c",
        "8.b910ceca-4718-4240-ac6a-ce926006bd2d"
      ],
      [
        "9.b910ceca-4718-4240-ac6a-ce926006bd2c",
        "9.b910ceca-4718-4240-ac6a-ce926006bd2d"
      ]
    ]
  }
]

Users and Groups

Manage your Koverse Users and Groups

API Keys - Retrieves a list of API Keys

Authorizations:
Bearer
query Parameters
$limit
integer

Number of results to return

$skip
integer

Number of results to skip

$sort
object

Property to sort results

filter
object

Query parameters to filter

Responses

Response samples

Content type
application/json
{
  • "total": 1,
  • "limit": 10,
  • "skip": 0,
  • "data": [
    ]
}

API Keys - Creates a new API key

Authorizations:
Bearer
Request Body schema: application/json
name
required
string
workspaceId
required
string <workspaceId>
description
string
expirationAt
string <date-time>

API Key expiration date

groupNames
required
Array of strings

List of group names the API key will become a member of. Groups are used for getting permission to read, write or delete a dataset.

attributeNames
required
Array of strings

List of attribute tokens to be included in the API key. This list of strings will be converted to uppercase and compared to the token of existing attributes in the workspace. Any attributes that don't exist will be created.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "workspaceId": "string",
  • "description": "string",
  • "expirationAt": "2019-08-24T14:15:22Z",
  • "groupNames": [
    ],
  • "attributeNames": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "key": "string",
  • "workspaceId": "string",
  • "description": "string",
  • "revoked": false,
  • "createdBy": "string",
  • "expirationAt": "2019-08-24T14:15:22Z",
  • "keyId": "string",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "deletedAt": "2019-08-24T14:15:22Z"
}

API Keys - Retrieve API Key with the given ID

Authorizations:
Bearer
path Parameters
id
required
string

ID of API Key to return

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "key": "string",
  • "workspaceId": "string",
  • "description": "string",
  • "revoked": false,
  • "createdBy": "string",
  • "expirationAt": "2019-08-24T14:15:22Z",
  • "keyId": "string",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "deletedAt": "2019-08-24T14:15:22Z"
}

API Keys - Update API Key with the given ID

Authorizations:
Bearer
path Parameters
id
required
string

ID of API Key to update

Request Body schema: application/json
id
required
string
name
required
string
workspaceId
required
string <workspaceId>
description
string
groupNames
required
Array of strings
attributeNames
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "workspaceId": "string",
  • "description": "string",
  • "groupNames": [
    ],
  • "attributeNames": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "key": "string",
  • "workspaceId": "string",
  • "description": "string",
  • "revoked": false,
  • "createdBy": "string",
  • "expirationAt": "2019-08-24T14:15:22Z",
  • "keyId": "string",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "deletedAt": "2019-08-24T14:15:22Z"
}

Api Keys - Update provided fields of Api Keys with the given ID

Authorizations:
Bearer
path Parameters
id
required
string

ID of API Key to update

Request Body schema: application/json
name
string
workspaceId
string <workspaceId>
description
string
groupNames
Array of strings
attributeNames
Array of strings

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "workspaceId": "string",
  • "description": "string",
  • "groupNames": [
    ],
  • "attributeNames": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "key": "string",
  • "workspaceId": "string",
  • "description": "string",
  • "revoked": false,
  • "createdBy": "string",
  • "expirationAt": "2019-08-24T14:15:22Z",
  • "keyId": "string",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "deletedAt": "2019-08-24T14:15:22Z"
}

API Keys - Remove Api Key with the given ID

Authorizations:
BearerAPIKey
path Parameters
id
required
string

ID of API Key to remove

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "key": "string",
  • "workspaceId": "string",
  • "description": "string",
  • "revoked": false,
  • "createdBy": "string",
  • "expirationAt": "2019-08-24T14:15:22Z",
  • "keyId": "string",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "deletedAt": "2019-08-24T14:15:22Z"
}

Groups - Retrieves a list of groups from the groups service

Authorizations:
BearerAPIKey
query Parameters
$limit
integer

Number of results to return

$skip
integer

Number of results to skip

$sort
object

Property to sort results

filter
object

Query parameters to filter

Responses

Response samples

Content type
application/json
{
  • "total": 1,
  • "limit": 10,
  • "skip": 0,
  • "data": [
    ]
}

Groups - Create a new group

Authorizations:
BearerAPIKey
Request Body schema: application/json
id
string <uuid>
name
required
string
workspaceId
required
string <workspaceId>
userId
string <uuid>
autoCreateIndexes
boolean

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "workspaceId": "string",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "autoCreateIndexes": true
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "workspaceId": "string",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "memberCount": 0,
  • "autoCreateIndexes": true
}

Groups - Retrieves a group with the given id from the service

Authorizations:
BearerAPIKey
path Parameters
id
required
string

ID of group to return

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "workspaceId": "string",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "memberCount": 0,
  • "autoCreateIndexes": true
}

Groups - Updates the group with given id

Authorizations:
BearerAPIKey
path Parameters
id
required
string

ID of group to update

Request Body schema: application/json
id
string <uuid>
name
required
string
workspaceId
required
string <workspaceId>
userId
string <uuid>
autoCreateIndexes
boolean

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "workspaceId": "string",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "autoCreateIndexes": true
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "workspaceId": "string",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "memberCount": 0,
  • "autoCreateIndexes": true
}

Groups - Updates the resource with the given id

Authorizations:
BearerAPIKey
path Parameters
id
required
string

ID of group to update

Request Body schema: application/json
id
string <uuid>
name
string
userId
string <uuid>
autoCreateIndexes
boolean

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "autoCreateIndexes": true
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "workspaceId": "string",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "memberCount": 0,
  • "autoCreateIndexes": true
}

Groups - Removes the group with the given id

Authorizations:
BearerAPIKey
path Parameters
id
required
string

ID of group to remove

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "workspaceId": "string",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "memberCount": 0,
  • "autoCreateIndexes": true
}

Group-Memberships - Retrieves a list of group memberships

Authorizations:
BearerAPIKey
query Parameters
$limit
integer

Number of results to return

$skip
integer

Number of results to skip

$sort
object

Property to sort results

filter
object

Query parameters to filter

Responses

Response samples

Content type
application/json
{
  • "total": 1,
  • "limit": 10,
  • "skip": 0,
  • "data": [
    ]
}

Group-Memberships - Create a new group membership

Authorizations:
BearerAPIKey
Request Body schema: application/json
groupId
required
string <uuid>
userId
required
string <uuid>
role
required
string
Enum: "member" "admin"

Responses

Request samples

Content type
application/json
{
  • "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "role": "member"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "role": "member",
  • "group": {
    },
  • "user": {
    }
}

Group-Memberships - Retrieves a group membership with the given id

Authorizations:
BearerAPIKey
path Parameters
id
required
string

ID of group-membership to return

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "role": "member",
  • "group": {
    },
  • "user": {
    }
}

Group-Memberships - Updates the group membership with the given ID

Authorizations:
BearerAPIKey
path Parameters
id
required
string

ID of group-membership to update

Request Body schema: application/json
id
required
string <uuid>
groupId
required
string <uuid>
userId
required
string <uuid>
role
required
string
Enum: "member" "admin"

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "role": "member"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "role": "member",
  • "group": {
    },
  • "user": {
    }
}

Group-Memberships - Updates the provided properties of group membership with the given ID

Authorizations:
BearerAPIKey
path Parameters
id
required
string

ID of group-membership to update

Request Body schema: application/json
groupId
string <uuid>
userId
string <uuid>
role
string
Enum: "member" "admin"

Responses

Request samples

Content type
application/json
{
  • "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "role": "member"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "role": "member",
  • "group": {
    },
  • "user": {
    }
}

Group-Memberships - Deletes the group membership with the given ID

Authorizations:
BearerAPIKey
path Parameters
id
required
string

ID of group-membership to remove

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "role": "member",
  • "group": {
    },
  • "user": {
    }
}

Users - Create a user

Authorizations:
BearerAPIKey
Request Body schema: application/json
email
required
string <email>

email of the new user

firstName
required
string

first name of the new user

lastName
required
string

last name of the new user

password
required
string <password>

authentication password for the new user

workspaceId
string <workspaceId>

ID of the KDP workspace that the new user will access. Does not grant permissions to data.

role
string
Enum: "member" "admin"

role for the new user

Responses

Request samples

Content type
application/json
{
  • "email": "user@example.com",
  • "firstName": "string",
  • "lastName": "string",
  • "password": "pa$$word",
  • "workspaceId": "string",
  • "role": "member"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "email": "user@example.com",
  • "firstName": "string",
  • "lastName": "string",
  • "workspaceId": "string",
  • "role": "member",
  • "stripeLatestCharge": {
    }
}

Users - Retrieves a list of users

Authorizations:
BearerAPIKey
query Parameters
$limit
integer

Number of results to return

$skip
integer

Number of results to skip

$sort
object

Property to sort results

filter
object

Query parameters to filter

Responses

Response samples

Content type
application/json
{
  • "total": 1,
  • "limit": 10,
  • "skip": 0,
  • "data": [
    ]
}

Users - Retrieves a user with the given id from the users service.

Authorizations:
BearerAPIKey
path Parameters
id
required
string

ID of user to return

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "email": "user@example.com",
  • "firstName": "string",
  • "lastName": "string",
  • "workspaceId": "string",
  • "role": "member",
  • "stripeLatestCharge": {
    }
}

Users - Updates a user with given id

Authorizations:
BearerAPIKey
path Parameters
id
required
string

ID of user to update

Request Body schema: application/json
id
string <uuid>

provide current or updated ID of the user

email
required
string <email>

provide current or updated email of the user

firstName
required
string

the current or updated first name of the user

lastName
required
string

the current or updated last name of the user

password
required
string <password>

the current or updated authentication password of the user

workspaceId
string <workspaceId>

the current or updated workspaceId the user can access

role
string
Enum: "member" "admin"

the current or updated workspace role for the user

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "email": "user@example.com",
  • "firstName": "string",
  • "lastName": "string",
  • "password": "pa$$word",
  • "workspaceId": "string",
  • "role": "member"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "email": "user@example.com",
  • "firstName": "string",
  • "lastName": "string",
  • "workspaceId": "string",
  • "role": "member",
  • "stripeLatestCharge": {
    }
}

Users - Updates the resource by id for the fields provided

Authorizations:
BearerAPIKey
path Parameters
id
required
string

ID of user to update

Request Body schema: application/json
id
string <uuid>
email
string <email>
firstName
string
lastName
string
password
string <password>
workspaceId
string <workspaceId>
role
string
Enum: "member" "admin"
object (stripeLatestCharge)

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "email": "user@example.com",
  • "firstName": "string",
  • "lastName": "string",
  • "password": "pa$$word",
  • "workspaceId": "string",
  • "role": "member",
  • "stripeLatestCharge": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "email": "user@example.com",
  • "firstName": "string",
  • "lastName": "string",
  • "workspaceId": "string",
  • "role": "member",
  • "stripeLatestCharge": {
    }
}

Users - Removes the user by given id

Authorizations:
BearerAPIKey
path Parameters
id
required
string

ID of user to remove

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "email": "user@example.com",
  • "firstName": "string",
  • "lastName": "string",
  • "workspaceId": "string",
  • "role": "member",
  • "stripeLatestCharge": {
    }
}

Workspaces

Manage your Koverse Workspaces

Audit-Logs - Queries audit log datasets

Search an audit log dataset using lucene query syntax. Supported features include wildcards, range queries, search across all fields, and many more.

Authorizations:
BearerAPIKey
query Parameters
includeInternalFields
boolean
Default: false

(Advanced) If true, include koverse internal fields in the response body

Request Body schema: application/json
datasetId
string <uuid>

The ID of the dataset where this query will run

expression
string

The query in lucene query syntax

limit
integer <int32>

The maximum number of records to return for the query, providing -1 returns all records

offset
integer <int32>

The number of records from the beginning of a record batch where the current batch will start, used for paging results

credentialsSubset
Array of strings

A list of credentials that can be provided to return records of a more limited subset than that of the authenticated caller

orderedResults
boolean
Default: false

If true, the results will be returned prioritizing order over response speed

Responses

Request samples

Content type
application/json
{
  • "datasetId": "97d23549-fd63-41b2-9950-bcc7f566e4d4",
  • "expression": "alphabet: a",
  • "limit": 10,
  • "offset": 0,
  • "credentialsSubset": [
    ],
  • "orderedResults": false
}

Response samples

Content type
application/json
{
  • "total": 1,
  • "limit": 10,
  • "skip": 0,
  • "data": [
    ]
}

Audit-Logs - Get audit log configuration

Get all audit log configuration of all workspaces

Authorizations:
BearerAPIKey
query Parameters
workspaceId
string

Return the audit log configurations

keepForever
boolean

Return the audit log configurations

$limit
integer

Number of results to return

$skip
integer

Number of results to skip

$sort
object

Property to sort results

filter
object

Query parameters to filter

Responses

Response samples

Content type
application/json
{
  • "total": 1,
  • "limit": 1,
  • "skip": 0,
  • "data": [
    ]
}

Audit-Logs - Patch audit log configuration of a workspace

Patch audit log configuration of a workspace

Authorizations:
BearerAPIKey
path Parameters
auditLogConfigsId
required
string

ID of the audit log configuration

Request Body schema: application/json
id
string <uuid>

The id of the audit log configuration

keepForever
required
boolean

flag to never delete the logs

ageInDays
integer

The age of the logs- Logs older than that would be deleted, if the keepForever flag is false

workspaceId
string

The id of the workspace to which this configuration belongs

datasetId
string <uuid>

The id of the dataset in which the audit logs for this workspace is stored

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "keepForever": true,
  • "ageInDays": 0,
  • "workspaceId": "string",
  • "datasetId": "6586f21b-ad4d-4d06-a309-712af47184a2"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "keepForever": true,
  • "ageInDays": 0,
  • "workspaceId": "string",
  • "datasetId": "6586f21b-ad4d-4d06-a309-712af47184a2"
}

Workspaces - Retrieves a list of workspaces

Authorizations:
BearerAPIKey
query Parameters
$limit
integer

Number of results to return

$skip
integer

Number of results to skip

$sort
object

Property to sort results

filter
object

Query parameters to filter

Responses

Response samples

Content type
application/json
{
  • "total": 1,
  • "limit": 10,
  • "skip": 0,
  • "data": [
    ]
}

Workspaces - Creates a new Workspace

Authorizations:
Bearer
Request Body schema: application/json
id
string <workspaceId>
name
required
string
userId
string
object

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "userId": "string",
  • "subscription": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "uniqueId": "a1e12d74-d756-40d1-9bb3-519def353f44",
  • "name": "string",
  • "userId": "string",
  • "subscription": {
    }
}

Workspaces - Retrieves Workspace with given ID

Authorizations:
BearerAPIKey
path Parameters
id
required
string

ID of workspace to return

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "uniqueId": "a1e12d74-d756-40d1-9bb3-519def353f44",
  • "name": "string",
  • "userId": "string",
  • "subscription": {
    }
}

Workspaces - Updates Workspace with the ID given

Authorizations:
Bearer
path Parameters
id
required
string

ID of workspace to update

Request Body schema: application/json
id
required
string <workspaceId>
name
required
string
userId
string
object

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "userId": "string",
  • "subscription": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "uniqueId": "a1e12d74-d756-40d1-9bb3-519def353f44",
  • "name": "string",
  • "userId": "string",
  • "subscription": {
    }
}

Workspaces - Updates provided fields of Workspace with the ID given

Authorizations:
Bearer
path Parameters
id
required
string

ID of workspace to update

Request Body schema: application/json
id
string <workspaceId>
name
string
userId
string
object

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "userId": "string",
  • "subscription": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "uniqueId": "a1e12d74-d756-40d1-9bb3-519def353f44",
  • "name": "string",
  • "userId": "string",
  • "subscription": {
    }
}

Write

The write service can be used to create records in KDP datasets.

Retrieves a list of Abac Label Parsers

The response returns the available Abac Label Parsers. The ID of the Abac Label Parser is used to specify the parser for an Ingest Job when calling the /ingest endpoint. Abac Label Parsers are used to parse security labels from records and assign them to the record's security label.

Authorizations:
BearerAPIKey
query Parameters
$limit
integer

Number of results to return

$skip
integer

Number of results to skip

$sort
object

Property to sort results

filter
object

Query parameters to filter

Responses

Response samples

Content type
application/json
{
  • "total": 1,
  • "limit": -1,
  • "skip": 0,
  • "data": [
    ]
}

Retrieves Abac Label Parser with the given ID.

The response returns an Abac Label Parser matching the provided ID. The ID of the Abac Label Parser is used to specify the parser for an Ingest Job when calling the /ingest endpoint. The Abac Label Parser is used to parse security labels from records and assign them to the record's security label.

Authorizations:
BearerAPIKey
path Parameters
id
required
string

ID of abac-label-parsers to return. Please note 'SimpleSecurityLabelParser', ID simple-parser, has been deprecated and will be removed in the future. Use 'IdentityParser' instead.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "parserClassName": "IdentityParser",
  • "name": "string"
}

Create an Ingest Job

For creating an ingest job to import data into the Koverse Data Platform from many sources including via Amazon S3, url datasources, Kafka Streaming, Postgres Databases and many others.

For file uploads use the `Upload data from files` /uploads endpoint and not this ingest endpoint. The /uploads endpoint will upload the file to the configured file storage and create the ingest job.

Authorizations:
BearerAPIKey
query Parameters
isAsync
boolean
Default: false
Request Body schema: application/json
datasetId
string <uuid>

id of the dataset that will receive the data from the ingest job

object (Data Source Params)

Contains the configuration parameters for the datasource

Responses

Request samples

Content type
application/json
{
  • "datasetId": "6586f21b-ad4d-4d06-a309-712af47184a2",
  • "dataSourceParams": {
    }
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "message": "string",
  • "code": 0
}

Upload data from files

The uploads endpoint is used to load data into a koverse dataset from one or multiple files. The request body is encoded as multipart/form-data to allow for uploading the files. ABAC security label configuration can be specified in the request body accessControlLabel to apply security labels to the records being written.

Supporting form fields such as accessLabelControl, customMetadata, and processAsDocument are expected to be in string format.

Authorizations:
BearerAPIKey
Request Body schema: multipart/form-data

form-data

object <object>

ABAC configuration for the uploaded files

customMetadata
object

Custom metadata that will be applied to each file

datasetId
required
string <uuid>

Dataset ID

files
required
Array of strings <binary>

Files

processAsDocument
boolean <string>

Process the Uploaded File as a Document - for data files (such as CSV) setting this value to true will result in a single CSV document being ingested for preview instead of each individual data row being written as separate records.

Responses

Request samples

Content type
multipart/form-data
Example
curl --location '{koverse-url/uploads}' \
--header 'Cookie: koverse-jwt={token}' \
--form 'files=@"{path/file-name}"' \
--form 'accessControlLabel="{\"securityLabeled\":\"true\",\"securityLabelInfo\":{\"parserClassName\":\"apply-label-to-all-records-parser\",\"label\":\"CUSTOM\"}}"' \
--form 'datasetId="{datasetId}"'

Response samples

Content type
application/json
{
  • "jobId": "9d222c6d-893e-4e79-8201-3c9ca16a0f39",
  • "datasetId": "6586f21b-ad4d-4d06-a309-712af47184a2",
  • "files": [
    ],
  • "accessControlLabel": {
    },
  • "customMetadata": { }
}

Write records

Writes a batch of records to random partitions and returns the list of partitions

Authorizations:
BearerAPIKey
path Parameters
datasetId
required
string <uuid>
query Parameters
isAsync
boolean
Default: false
Request Body schema: application/json
Array
property name*
additional property
any

Responses

Request samples

Content type
application/json
[
  • { }
]

Response samples

Content type
application/json
{
  • "name": "string",
  • "message": "string",
  • "code": 0
}

Write records (v2)

Writes a batch of records to random partitions with the option of configuring security label parser and returns the list of partitions

Authorizations:
BearerAPIKey
path Parameters
datasetId
required
string <uuid>
query Parameters
isAsync
boolean
Default: false
Request Body schema: application/json
Array of objects (JsonRecord)

Array of json documents to write into KDP.

object (Security Label Info)

Contains the configuration parameters for the security label parser

object (Schema Security Label)

The schema of the records returned in a record batch

Responses

Request samples

Content type
application/json
{
  • "records": [
    ],
  • "securityLabelInfo": {
    },
  • "columnSecurityLabelInfo": {
    }
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "message": "string",
  • "code": 0
}