Authentication19 endpoints

Add Identity Provider

POST/api/v2/authentication/identity-provider

Add a new identity provider

Code Server Url Map

GET/api/v2/authentication/code-server/{identity_provider}

**Parameters:**

Custom Token Signin Callback

GET/api/v2/authentication/signin/custom-token-callback/{idp}/organization/{organization}

**Parameters:**

Custom Token Signup Callback

GET/api/v2/authentication/signup/custom-token-callback/{idp}/organization/{organization}

**Parameters:**

Decode Token

GET/api/v2/authentication/token/decode/{token}

**Parameters:**

Email Verification

GET/api/v2/authentication/email-verification

Verify the email of the user

Forgot Password

PUT/api/v2/authentication/forgot-password

**Parameters:**

List Idp

GET/api/v2/authentication/list_identity_providers

Get a list of all suppported identity providers.

Refresh Tokens

GET/api/v2/authentication/refresh_tokens

Takes refresh token as an input and returns new access token and refresh token

Refresh Tokens

GET/api/v2/authentication/refresh-tokens

Takes refresh token as an input and returns new access token and refresh token

Remove Identity Provider

DELETE/api/v2/authentication/identity-provider

Remove an identity provider

Reset Password

POST/api/v2/authentication/reset-password

**Parameters:**

Saml Callback

POST/api/v2/authentication/signin/callback/saml/idp/{idp}/organization/{organization}

**Parameters:**

Sign In Token Callback

GET/api/v2/authentication/sign_in_token_callback/{idp}/organization/{organization}

Gets authorization code from keycloak and exchanges it for access token.

Sign In Via Password

POST/api/v2/authentication/sign_in_via_password

**Parameters:**

Sign In Via Password

POST/api/v2/authentication/signin/password

**Parameters:**

Sign Out

POST/api/v2/authentication/signout

**Parameters:**

Sign Up Token Callback

GET/api/v2/authentication/sign_up_token_callback/{idp}/organization/{organization}

**Parameters:**

Sign Up Via Password

POST/api/v2/authentication/signup/password

**Parameters:**

Admin51 endpoints

Create Account

POST/api/v2/admin/accounts

Creates a new account and creates the admin user for this account with admin role.

Create Api Key

POST/api/v2/admin/accounts/{account_id}/users/{user_id}/api_keys

Create and map it to an user under an account.

Create Permission

POST/api/v2/admin/accounts/{account_id}/permissions

Create a new permission for a specific account.

Create Rbac Status

POST/api/v2/admin/rbac_status

**Parameters:**

Create Resource Allocation

POST/api/v2/admin/accounts/{account_id}/resource_allocation

Create resource_allocation

Create Role

POST/api/v2/admin/accounts/{account_id}/roles

Create a new role for a specific account.

Create Secret

POST/api/v2/admin/accounts/{account_id}/secrets

Create a secret with the provided secret values

Create User

POST/api/v2/admin/accounts/{account_id}/users

Create a new user for a specific account.

Create User

POST/api/v2/admin/users

Create a new user for a specific account.

Create User Group

POST/api/v2/admin/accounts/{account_id}/usergroups

Create a new user group for a specific account.

Delete Account

DELETE/api/v2/admin/accounts/{account_id}

Delete a specific account.

Delete Api Key

DELETE/api/v2/admin/accounts/{account_id}/users/{user_id}/api_keys/{api_key_id}

Delete the API key and unlinks from attached roles & permissions, and roles.

Delete Permission

DELETE/api/v2/admin/accounts/{account_id}/permissions/{permission_id}

Delete a specific permission for a specific account.

Delete Rbac Status

DELETE/api/v2/admin/rbac_status/{rbac_status_id}

**Parameters:**

Delete Resource Allocation

DELETE/api/v2/admin/accounts/{account_id}/resource_allocation/{resource_allocation_id}

Delete resource_allocation

Delete Role

DELETE/api/v2/admin/accounts/{account_id}/roles/{role_id}

Delete a specific role for a specific account.

Delete Secret Details

DELETE/api/v2/admin/accounts/{account_id}/secrets/{secret_name}

Delete the secret values of a secret name.

Delete User

DELETE/api/v2/admin/accounts/{account_id}/users/{user_id}

Delete a specific user for a specific account.

Delete User

DELETE/api/v2/admin/users/{user_id}

Delete a specific user for a specific account.

Delete User Group

DELETE/api/v2/admin/accounts/{account_id}/usergroups/{user_group_id}

Delete a specific user group for a specific account.

Get Account

GET/api/v2/admin/accounts/{account_id}

Get a specific account.

Get Api Key Details

GET/api/v2/admin/accounts/{account_id}/users/{user_id}/api_keys/{api_key_id}

Get the attached roles & permissions, user, account of the API Key ID.

Get Permission

GET/api/v2/admin/accounts/{account_id}/permissions/{permission_id}

Get a specific permission for a specific account.

Get Rbac Status

GET/api/v2/admin/rbac_status

**Parameters:**

Get Rbac Status By Id

GET/api/v2/admin/rbac_status/{rbac_status_id}

**Parameters:**

Get Resource Allocation

GET/api/v2/admin/accounts/{account_id}/resource_allocation/{resource_allocation_id}

Get resource_allocation

Get Role

GET/api/v2/admin/accounts/{account_id}/roles/{role_id}

Get a specific role for a specific account.

Get Rules

GET/api/v2/admin/trino_rbac_rules

**Responses:**

Get Secret Details

GET/api/v2/admin/accounts/{account_id}/secrets/{secret_name}

Get the secret details of the Secret Name.

Get User

GET/api/v2/admin/accounts/{account_id}/users/{user_id}

Get a specific user for a specific account.

Get User

GET/api/v2/admin/users/{user_id}

Get a specific user for a specific account.

Get User Group

GET/api/v2/admin/accounts/{account_id}/usergroups/{user_group_id}

Get a specific user group for a specific account.

List Account Secrets

GET/api/v2/admin/accounts/{account_id}/secrets

Create a secret with the provided secret values

List Accounts

GET/api/v2/admin/accounts

Get a list of all accounts.

List Api Keys

GET/api/v2/admin/accounts/{account_id}/users/{user_id}/api_keys

List all the API key ID associated with an user.

List Permissions

GET/api/v2/admin/accounts/{account_id}/permissions

Get a list of all permissions for a specific account.

List Resource Allocations

GET/api/v2/admin/accounts/{account_id}/resource_allocation

List all resource allocations

List Roles

GET/api/v2/admin/accounts/{account_id}/roles

Get a list of all roles for a specific account.

List User Groups

GET/api/v2/admin/accounts/{account_id}/usergroups

Get a list of all user groups for a specific account.

List Users

GET/api/v2/admin/accounts/{account_id}/users

Get a list of all users for a specific account.

List Users

GET/api/v2/admin/users

Get a list of all users for a specific account.

Modify Rbac Status

PATCH/api/v2/admin/rbac_status/{rbac_status_id}

**Parameters:**

Update Account

PUT/api/v2/admin/accounts/{account_id}

Update a specific account.

Update Api Key Details

PATCH/api/v2/admin/accounts/{account_id}/users/{user_id}/api_keys/{api_key_id}

Add or remove roles and permissions from an API key ID.

Update Permission

PUT/api/v2/admin/accounts/{account_id}/permissions/{permission_id}

Update a specific permission for a specific account.

Update Resource Allocation

PATCH/api/v2/admin/accounts/{account_id}/resource_allocation/{resource_allocation_id}

Update resource_allocation

Update Resource Allocation Overwrite

PUT/api/v2/admin/accounts/{account_id}/resource_allocation/{resource_allocation_id}

Update resource_allocation

Update Role

PUT/api/v2/admin/accounts/{account_id}/roles/{role_id}

Update a specific role for a specific account.

Update Secret Details

PUT/api/v2/admin/accounts/{account_id}/secrets/{secret_name}

Update the secret values of a secret name.

Update User

PUT/api/v2/admin/accounts/{account_id}/users/{user_id}

Update a specific user for a specific account.

Update User Group

PUT/api/v2/admin/accounts/{account_id}/usergroups/{user_group_id}

Update a specific user group for a specific account.

Marketplace12 endpoints

Create Asset

POST/api/v1/marketplace/assets/

**Parameters:**

Create Asset Type

POST/api/v1/marketplace/asset_types/

**Parameters:**

Delete Asset

DELETE/api/v1/marketplace/assets/{asset_id}

**Parameters:**

Delete Asset Type

DELETE/api/v1/marketplace/asset_types/{asset_type_id}

**Parameters:**

Get Asset

GET/api/v1/marketplace/assets/{asset_id}

**Parameters:**

Get Asset Type

GET/api/v1/marketplace/asset_types/{asset_type_id}

**Parameters:**

Import Asset

POST/api/v1/marketplace/assets/{asset_id}/import

**Parameters:**

List Asset Types

GET/api/v1/marketplace/asset_types/

This API lists the total number of asset_types that have been registered in the asset_type registry, with its corresponding name and identifiers.

List Assets

GET/api/v1/marketplace/assets/

This API lists the total number of assets that have been registered in the asset registry, with its corresponding name and identifiers.

Patch Asset

PATCH/api/v1/marketplace/assets/{asset_id}

**Parameters:**

Patch Asset Type

PATCH/api/v1/marketplace/asset_types/{asset_type_id}

**Parameters:**

Remove Asset From Library

DELETE/api/v1/marketplace/assets/{asset_id}/library

**Parameters:**

MLOps20 endpoints

Create Experiment

POST/api/v1/mlops/experiments

This API is used to register any experiment pertaining to it in the experiment registry.

Create Experiment V2

POST/api/v2/mlops/experiments

This API is used to register any experiment pertaining to it in the experiment registry.

Create Model

POST/api/v1/mlops/models

This API is used to register any models along with metadata configurations pertaining to it in the model registry.

Create Model V2

POST/api/v2/mlops/models

This API is used to register any models along with metadata configurations pertaining to it in the model registry.

Delete Experiment

DELETE/api/v1/mlops/experiments/{experiment_id}

This API allows the deletion of any specified experiment.

Delete Experiment V2

DELETE/api/v2/mlops/experiments/{experiment_id}

This API allows the deletion of any specified experiment.

Delete Model

DELETE/api/v1/mlops/models/{model_id}

This API allows the deletion of any specified model.

Delete Model V2

DELETE/api/v2/mlops/models/{model_id}

This API allows the deletion of any specified model.

Get Experiment

GET/api/v1/mlops/experiments/{experiment_id}

This API allows the user to read metadata configuration pertaining to a experiment identifier.

Get Experiment V2

GET/api/v2/mlops/experiments/{experiment_id}

This API allows the user to read metadata configuration pertaining to a experiment identifier.

Get Model

GET/api/v1/mlops/models/{model_id}

This API allows the user to read metadata configuration pertaining to a model identifier.

Get Model V2

GET/api/v2/mlops/models/{model_id}

This API allows the user to read metadata configuration pertaining to a model identifier.

List Experiments

GET/api/v1/mlops/experiments

This API lists the total number of experiments that have been registered in the experiment registry, with its corresponding name and identifiers.

List Experiments V2

GET/api/v2/mlops/experiments

This API lists the total number of experiments that have been registered in the experiment registry, with its corresponding name and identifiers.

List Models

GET/api/v1/mlops/models

This API lists the total number of models that have been registered in the model registry, with its corresponding name and identifiers.

List Models V2

GET/api/v2/mlops/models

This API lists the total number of models that have been registered in the model registry, with its corresponding name and identifiers.

Update Experiment

PATCH/api/v1/mlops/experiments/{experiment_id}

This API allows metadata updation for any specified experiment and re-registers the metadata in the experiment registry.

Update Experiment V2

PATCH/api/v2/mlops/experiments/{experiment_id}

This API allows metadata updation for any specified experiment and re-registers the metadata in the experiment registry.

Update Model

PATCH/api/v1/mlops/models/{model_id}

This API allows metadata updation for any specified model and re-registers the metadata in the model registry.

Update Model V2

PATCH/api/v2/mlops/models/{model_id}

This API allows metadata updation for any specified model and re-registers the metadata in the model registry.

Documents39 endpoints

Clone Doc Type

POST/api/v1/doc_types/{doctype_id}/clone

**Parameters:**

Create Datatype

POST/api/v1/datatypes

creates given datatype

Create Doc Type

POST/api/v1/doc_types/

**Parameters:**

Create Document

POST/api/v1/documents/

**Parameters:**

Create Matching

POST/api/v1/matchings/

**Parameters:**

Create Preset Doc Type

POST/api/v1/preset-doc-types

creates given preset_doc_type

Delete Datatype

DELETE/api/v1/datatypes/{datatype_id}

Deletes given datatype

Delete Doctype

DELETE/api/v1/doc_types/{doctype_id}

This API allows metadata deletion for any specified doctype identifier.

Delete Document

DELETE/api/v1/documents/{document_id}

This API allows metadata deletion for any specified document identifier.

Delete Matching

DELETE/api/v1/matchings/{matching_id}

This API allows metadata deletion for any specified matching identifier.

Delete Preset Doc Type

DELETE/api/v1/preset-doc-types/{preset_doc_type_id}

Deletes given preset_doc_type

Document Callback

POST/api/v1/documents/callback

**Parameters:**

Download Doctype

GET/api/v1/doc_types/{doctype_id}/export

This API returns the dataset csv download link for the specified doctype identifier.

Fetch Cache Details

GET/api/v1/documents/fetch_cache_details/{document_id}

**Parameters:**

Generate Taxonomy Template

GET/api/v1/doc_types/{doctype_id}/taxonomy/template

This API returns a template taxonomy for the specified doctype identifier.

Get Datatype

GET/api/v1/datatypes/{datatype_id}

Get given datatype

Get Doc Type

GET/api/v1/doc_types/{doctype_id}

**Parameters:**

Get Doctype Status

GET/api/v1/doc_types/{doctype_id}/status

This API returns the status of the specified doctype.

Get Matching

GET/api/v1/matchings/{matching_id}

**Parameters:**

Get Preset Doc Type

GET/api/v1/preset-doc-types/{preset_doc_type_id}

Get given preset_doc_type

Get Preset Documents For Doctype

GET/api/v1/doc_types/{doctype_id}/preset-documents

This API returns the list of preset documents for the given doctype identifier.

Get Record

GET/api/v1/documents/{document_id}

**Parameters:**

List Datatypes

GET/api/v1/datatypes

Lists all the created datatypes

List Doc Types

GET/api/v1/doc_types/

**Parameters:**

List Documents

GET/api/v1/documents/

This API lists the total number of documents that have been registered in the document registry, with its corresponding name and identifiers.

List Hitl Actions

GET/api/v1/hitlactions/

**Parameters:**

List Matchings

GET/api/v1/matchings/

This API lists the total number of matchings that have been registered in the matching registry, with its corresponding name and identifiers.

List Preset Doc Types

GET/api/v1/preset-doc-types

Lists all the created preset_doc_types

Live Ocr

POST/api/v1/documents/live-ocr/{document_id}

**Parameters:**

Metrics

GET/api/v1/metrics/

**Parameters:**

Patch Doctype

PATCH/api/v1/doc_types/{doctype_id}

**Parameters:**

Patch Document

PATCH/api/v1/documents/{document_id}

**Parameters:**

Query Document

POST/api/v1/documents/query_document/{document_id}

**Parameters:**

Update Datatype

PATCH/api/v1/datatypes/{datatype_id}

updates given datatype

Update Doctype

PUT/api/v1/doc_types/{doctype_id}

This API allows metadata updation for any specified doctype and re-registers the metadata in the doctype registry.

Update Matching

PUT/api/v1/matchings/{matching_id}

**Parameters:**

Update Preset Doc Type

PATCH/api/v1/preset-doc-types/{preset_doc_type_id}

updates given preset_doc_type

Update Record

PUT/api/v1/documents/{document_id}

**Parameters:**

Upload Document

POST/api/v1/documents/upload_document

**Parameters:**

IDP Delivery8 endpoints

Async Document Inference

POST/api/v2/documents/async

**Parameters:**

Download Batch

POST/api/v2/batch/async/download

**Parameters:**

Get Batch Details

GET/api/v2/batch/{batch_id}

**Parameters:**

Get Batch Progress

GET/api/v2/batch/{batch_id}/progress

**Parameters:**

Get Document Results

GET/api/v2/documents/{document_id}

**Parameters:**

Get Job

GET/api/v2/job/{job_id}

**Parameters:**

Sync Document Inference

POST/api/v2/documents

This API endpoint allows you to perform document inference synchronously.

Workflow Batch Run

POST/api/v2/workflow/{workflow_id}/batch_run

**Parameters:**

Workflows53 endpoints

Async Run Workflow

POST/api/v1/workflow/async/run

**Parameters:**

Create Job

POST/api/v1/jobs/

**Parameters:**

Create Node

POST/api/v1/nodes/

This API is used to register any node along with metadata configurations pertaining to it in the node registry.

Create Node Definition

POST/api/v1/nodes/definitions/

Create a new node definition.

Create Node Definition Presets

POST/api/v1/nodes/definitions/create_preset_node_definitions

This API is triggered for creating Preset Node Definitions for a client/account upon creation.

Create Preset Workflows

POST/api/v1/workflow/create_preset_workflows

This API is triggered for creating Preset Workflows for a client/account upon creation.

Create Workflow

POST/api/v1/workflow/

This API is used to register any workflow along with metadata configurations pertaining to it in the workflow registry.

Delete Job

DELETE/api/v1/jobs/{job_id}

**Parameters:**

Delete Node

DELETE/api/v1/nodes/{node_id}

This API allows metadata deletion for any specified node identifier.

Delete Node Definition

DELETE/api/v1/nodes/definitions/{node_definition_id}

Delete a node definition.

Delete Workflow

DELETE/api/v1/workflow/{workflow_id}

This API allows the deletion of any specified workflow.

Delete Workflow

DELETE/api/v1/workflow/configs/{workflow_id}

This API allows the deletion of any specified workflow.

Deploy Workflow

POST/api/v1/workflow/enable

This API allows the deployment of any specified workflow and make it available for execution in an operational environment on asynchronous mode.

Deploy Workflow

POST/api/v1/workflow/deploy

This API allows the deployment of any specified workflow and make it available for execution in an operational environment on asynchronous mode.

Deploy Workflow Status

GET/api/v1/workflow/enable/status

**Parameters:**

Deploy Workflow Status

GET/api/v1/workflow/deploy/status

**Parameters:**

Deploy Workflow V2

POST/api/v1/workflow/deploy_v2

**Parameters:**

Get Config Internal

GET/api/v1/workflow/internal/configs

**Parameters:**

Get Job

GET/api/v1/jobs/{job_id}

**Parameters:**

Get Job Packet Status

GET/api/v1/jobs/{job_id}/packet_status

**Parameters:**

Get Job Payload

GET/api/v1/jobs/{job_id}/payload

**Parameters:**

Get Job Status

GET/api/v1/jobs/{job_id}/status

**Parameters:**

Get Node

GET/api/v1/nodes/{node_id}

This API allows the user to read metadata configuration pertaining to a node identifier.

Get Node Definition

GET/api/v1/nodes/definitions/{node_definition_id}

Get a node definition.

Get Node Deployment Config

GET/api/v1/nodes/deployment/{deployment_id}

**Parameters:**

Get Node Output

GET/api/v1/jobs/{job_id}/node/{node_name}/payload

**Parameters:**

Get Schema Changes

GET/api/v1/workflow/schema_changes/{workflow_id}

Updates the specified connector using the given payload

Get Workflow

GET/api/v1/workflow/{workflow_id}

This API allows the user to read metadata configuration pertaining to a workflow identifier.

Get Workflow Run

GET/api/v1/workflow/{workflow_id}/runs/{run_id}

This API allows the user to get the details of a particular run of a workflow.

Get Workflow Run Status

GET/api/v1/workflow{workflow_id}/runs/{run_id}/status

This API allows the user to get the status of a particular run of a workflow.

List Jobs

GET/api/v1/jobs/

**Parameters:**

List Node Definitions

GET/api/v1/nodes/definitions/

List all node definitions.

List Nodes

GET/api/v1/nodes/

This API lists the total number of nodes that have been registered in the node registry, with its corresponding name and identifiers.

List Workflow Runs

GET/api/v1/workflow/{workflow_id}/runs

This API allows the user to list all the runs of a workflow.

List Workflows

GET/api/v1/workflow/

This API lists the total number of workflows that have been registered in the workflow registry, with its corresponding name and identifiers.

Patch Job

PATCH/api/v1/jobs/{job_id}

**Parameters:**

Patch Node Definition

PATCH/api/v1/nodes/definitions/{node_definition_id}

Patch a node definition.

Patch Workflow

PATCH/api/v1/workflow/{workflow_id}

**Parameters:**

Process Packet Workflow

POST/api/v1/workflow/process-packet

This API is the trigger to execute the DAG in synchronous mode for a packet(s) of different types.

Register Node Definition

POST/api/v1/nodes/definitions/register

Register a node definition.

Startup Check

GET/api/v1/workflow/health

This is a startup check endpoint. It can be used to check if the application is up and running.

Sync Run Workflow

POST/api/v1/workflow/run

This API is the trigger to execute the DAG in synchronous mode using pandas and not spark queries.

Sync Run Workflow V2

POST/api/v1/workflow/runv2

**Parameters:**

Undeploy Workflow

POST/api/v1/workflow/disable

This API allows the un-deployment of any specified workflow that has previously been deployed on an execution engine.

Undeploy Workflow

POST/api/v1/workflow/undeploy

This API allows the un-deployment of any specified workflow that has previously been deployed on an execution engine.

Update Node

PUT/api/v1/nodes/{node_id}

This API allows metadata updation for any specified node and re-registers the metadata in the node registry.

Update Node Definition

PUT/api/v1/nodes/definitions/{node_definition_id}

Update a node definition.

Update Node Deployment Config

PUT/api/v1/nodes/{node_definition_id}/deployment

Create a new deployment config.

Update Workflow

PUT/api/v1/workflow/{workflow_id}

This API allows metadata updation for any specified workflow and re-registers the metadata in the workflow registry.

Validate Workflow

POST/api/v1/workflow/validate

This API is used to validate any workflow metadata configurations which is passed as the input payload.

Workflow Callback

POST/api/v1/workflow/callback

**Parameters:**

Workflow Status

GET/api/v1/workflow/status

This API can be used to view the status of the DAG run, if triggered for async runs.

Workflow Status

GET/api/v1/workflow/internal/status

This API can be used to view the status of the DAG run, if triggered for async runs.

Agents20 endpoints

Add Chat Message

POST/api/v1/chat/{chat_id}/messages

**Parameters:**

Create Account Datasets

POST/api/v1/agents/create_account_datasets

This API is triggered for creating Account Level Datasets for a client/account upon creation.

Create Action

POST/api/v1/actions/

**Parameters:**

Create Agent

POST/api/v1/agents/

Create a new agent.

Create Chat

POST/api/v1/chat/

**Parameters:**

Delete Action

DELETE/api/v1/actions/{action_id}

Delete a action by ID.

Delete Agent

DELETE/api/v1/agents/{agent_id}

Delete an agent by ID.

Delete Chat

DELETE/api/v1/chat/{chat_id}

**Parameters:**

Get Action By Id

GET/api/v1/actions/{id}

**Parameters:**

Get Agent By Id

GET/api/v1/agents/{agent_id}

Get a specific agent by ID.

Get Chat By Id

GET/api/v1/chat/{chat_id}

**Parameters:**

Get Message Response

GET/api/v1/chat/{message_id}/completions

**Parameters:**

Get Message Response

GET/api/v1/agents/{agent_id}/{message_id}/completions

**Parameters:**

List Actions

GET/api/v1/actions/

**Parameters:**

List Agents

GET/api/v1/agents/

List all agents with optional pagination.

List Chats

GET/api/v1/chat/user/{user_id}

**Parameters:**

Publish Notification

POST/api/v1/chat/notify/

**Parameters:**

Run Agent

POST/api/v1/agents/{agent_id}/run

Run an existing agent.

Update Action

PUT/api/v1/actions/{action_id}

**Parameters:**

Update Agent

PUT/api/v1/agents/{agent_id}

Update an existing agent.

Connector62 endpoints

Cancel Run

PUT/api/v2/connectors/connections/{connection_id}/runs/{run_id}/cancel

Cancel specified run of the given connector

Create Connector

POST/api/v2/connectors/connections

Creates a connector between given source and destination

Create Destination

POST/api/v2/connectors/destinations

Get given destination_id

Create Destination Definition

POST/api/v2/connectors/destinations/definitions

Create new destination definition

Create Egress

POST/api/v2/connectors/egress

Create a egress

Create Ingress

POST/api/v2/connectors/ingress

Create a new ingress

Create Source

POST/api/v2/connectors/sources

creates given source

Create Source Definition

POST/api/v2/connectors/sources/definitions

Create new source definition

Create Workspace

POST/api/v2/connectors/workspaces

Create workspace

Data Register

POST/api/v2/connectors/datasets/data/register/

**Parameters:**

Delete Connector

DELETE/api/v2/connectors/connections/{connection_id}

Delete the given connector

Delete Destination

DELETE/api/v2/connectors/destinations/{destination_id}

Delete the given destination

Delete Destination Definition

DELETE/api/v2/connectors/destinations/definitions/{destination_definition_id}

Delete the given destination definition

Delete Egress

DELETE/api/v2/connectors/egress/{egress_id}

**Parameters:**

Delete Ingress

DELETE/api/v2/connectors/ingress/{ingress_id}

Delete an existing ingress

Delete Source

DELETE/api/v2/connectors/sources/{source_id}

Deletes given source

Delete Source Definition

DELETE/api/v2/connectors/sources/definitions/{source_definition_id}

Deletes given source definition

Delete Workspace

DELETE/api/v2/connectors/workspaces/{workspace_id}

Delete workspace by id

Get Connector

GET/api/v2/connectors/connections/{connection_id}

Returns connector for a given connection_id

Get Connector Run

GET/api/v2/connectors/connections/{connection_id}/runs/{run_id}

Gets run of the given connector

Get Connector Run

GET/api/v2/connectors/connections/{connection_id}/feeds/{run_id}

Gets run of the given connector

Get Connector Run Status

GET/api/v2/connectors/connections/{connection_id}/runs/{run_id}/status

**Parameters:**

Get Destination

GET/api/v2/connectors/destinations/{destination_id}

Get given destination_id

Get Destination Definition

GET/api/v2/connectors/destinations/definitions/{destination_definition_id}

Returns destination defintion for a given destination

Get Egress

GET/api/v2/connectors/egress/{egress_id}

Get a egress by id

Get Egress Run

GET/api/v2/connectors/egress/{egress_id}/runs/{run_id}

Get a egress run by id

Get Egress Run Status

GET/api/v2/connectors/egress/{egress_id}/run/{run_id}/status

Get a egress run status

Get Feed

GET/api/v2/connectors/feeds/{feed_id}

Get feed

Get Ingress

GET/api/v2/connectors/ingress/{ingress_id}

Get a specific ingress

Get Ingress Run

GET/api/v2/connectors/ingress/{ingress_id}/runs/{run_id}

Get a specific run of an ingress

Get Ingress Run Status

GET/api/v2/connectors/ingress/{ingress_id}/run/{run_id}/status

Get the status of a running ingress

Get Latest Run

GET/api/v2/connectors/connections/{connection_id}/latest-run

Gets latest run of the given connector

Get Preset Connnectors

GET/api/v2/connectors/workspaces/{workspace_id}/preset-connectors

Returns preset connectors created on the given workspace creation

Get Source

GET/api/v2/connectors/sources/{source_id}

Get given source_id

Get Source Definition

GET/api/v2/connectors/sources/definitions/{source_definition_id}

Returns source defintion for a given source

Get Workspace By Id

GET/api/v2/connectors/workspaces/{workspace_id}

Get workspace by id

Get Workspace By Name

GET/api/v2/connectors/workspaces/name/{workspace_name}

Get workspace by name

Infer Source Schema

GET/api/v2/connectors/sources/{source_id}/infer-schema

Tests connection foe the given source_id

List Connector Runs

GET/api/v2/connectors/connections/{connection_id}/runs

Lists runs of the given connector

List Connector Runs

GET/api/v2/connectors/connections/{connection_id}/feeds

Lists runs of the given connector

List Connectors

GET/api/v2/connectors/connections

List all the connectors

List Destination Definitons

GET/api/v2/connectors/destinations/definitions

Lists all the supported destinations

List Destinations

GET/api/v2/connectors/destinations

Lists all the created destinations

List Eggresses

GET/api/v2/connectors/egress

List all egresses

List Egress Runs

GET/api/v2/connectors/egress/{egress_id}/runs

List all egress runs

List Feeds

GET/api/v2/connectors/feeds

List feeds

List Ingress Runs

GET/api/v2/connectors/ingress/{ingress_id}/runs

List all runs of an ingress

List Ingresses

GET/api/v2/connectors/ingress

List all ingresses

List Source Definitons

GET/api/v2/connectors/sources/definitions

Lists all the supported sources

List Sources

GET/api/v2/connectors/sources

Lists all the created sources

List Workspaces

GET/api/v2/connectors/workspaces

List workspaces

Run Connector

POST/api/v2/connectors/connections/{connection_id}/run

Runs a connector between given source and destination

Run Egress

POST/api/v2/connectors/egress/{egress_id}/run

Run a egress

Run Ingress

POST/api/v2/connectors/ingress/{ingress_id}/run

Run an existing ingress

Startup Check

GET/api/v2/connectors/health

This is a startup check endpoint. It can be used to check if the application is up and running.

Test Destination Connection

POST/api/v2/connectors/destinations/{destination_id}/test-connection

Tests connection foe the given destination_id

Test Source Connection

POST/api/v2/connectors/sources/{source_id}/test-connection

Tests connection foe the given source_id

Update Connector

PATCH/api/v2/connectors/connections/{connection_id}

Update the given connector

Update Destination

PATCH/api/v2/connectors/destinations/{destination_id}

Update the given destination

Update Destination Definition

PATCH/api/v2/connectors/destinations/definitions/{destination_definition_id}

Update the given destination definition

Update Source

PATCH/api/v2/connectors/sources/{source_id}

updates given source

Update Source Definition

PATCH/api/v2/connectors/sources/definitions/{source_definition_id}

updates given source definition

Data4 endpoints

Delete Record

DELETE/api/v2/datasets/{dataset_id}/data/{data_id}

Delete data for a dataset based on the dataset_id and data_id.

Query Records

POST/api/v2/datasets/{dataset_id}/query

Get the data of a dataset based on the dataset_id.

Startup Check

GET/api/v2/datasets/health

This is a startup check endpoint. It can be used to check if the application is up and running.

Upsert Record

POST/api/v2/datasets/{dataset_id}/upsert

Create data for a dataset based on the dataset_id.

Datasets23 endpoints

Create Account Datasets

POST/api/v1/datasets/create_account_datasets

This API is triggered for creating Account Level Datasets for a client/account upon creation.

Create Dataset

POST/api/v1/datasets/

This API is used to register metadata configurations pertaining to data in the dataset registry.

Create Dataset Group

POST/api/v1/dataset_groups/

**Parameters:**

Delete Dataset

DELETE/api/v1/datasets/{dataset_id}

This API allows metadata deletion for any specified dataset identifier.

Delete Dataset Group

DELETE/api/v1/dataset_groups/{dataset_group_id}

**Parameters:**

Download Dataset

GET/api/v1/datasets/{dataset_id}/export

This API allows the user to get the csv download link pertaining to a dataset identifier.

Get Dataset

GET/api/v1/datasets/{dataset_id}

This API allows the user to read metadata configuration pertaining to a dataset identifier.

Get Dataset Group

GET/api/v1/dataset_groups/{dataset_group_id}

**Parameters:**

Get Dataset Group Summary Status

GET/api/v1/dataset_groups/{dataset_group_id}/summarize/status

**Parameters:**

Get Dataset Profile Status

GET/api/v1/datasets/{dataset_id}/profile/status

This API allows the user to get the status of the profiling of a dataset.

Get Latest Synchronization Status

GET/api/v1/datasets/{dataset_id}/sync/latest-status

API returns the latest sync status

Get Sampling Status

GET/api/v1/datasets/{dataset_id}/sample/status

This API allows the user to get the status of the sampling of a dataset.

List Dataset Groups

GET/api/v1/dataset_groups/

**Parameters:**

List Dataset Synchronization Runs

GET/api/v1/datasets/{dataset_id}/sync-runs

**Parameters:**

List Datasets

GET/api/v1/datasets/

This API lists the total number of datasets that have been registered in the dataset registry, with its corresponding name and identifiers.

Partial Update Dataset

PATCH/api/v1/datasets/{dataset_id}

This API allows metadata configuration updation for any specified dataset and updates the metadata in the dataset registry.

Partial Update Dataset Group

PATCH/api/v1/dataset_groups/{dataset_group_id}

**Parameters:**

Profile Dataset

POST/api/v1/datasets/{dataset_id}/profile

This API allows the user to profile a dataset to obtain and aggregated summary & univariate analysis of the raw data.

Sample Dataset

POST/api/v1/datasets/{dataset_id}/sample

This API allows the user to sample a dataset

Startup Check

GET/api/v1/datasets/health

This is a startup check endpoint. It can be used to check if the application is up and running.

Summarize Dataset Group

POST/api/v1/dataset_groups/{dataset_group_id}/summarize

**Parameters:**

Synchronize Dataset

POST/api/v1/datasets/{dataset_id}/sync

API allows the user to manually sync the dataset with the data source. only polyglot datasets can be manually synced

Update Dataset Group

PUT/api/v1/dataset_groups/{dataset_group_id}

**Parameters:**

Notification7 endpoints

Acknowledge Notification

POST/api/v1/notifications/acknowledge

Function to acknowledge a notification

Get Notifications

GET/api/v1/notifications

Function to get notifications

List Subscriptions

GET/api/v1/subscriptions

Function to list all subscriptions

Publish

POST/api/v1/notification/publish

Publish a message to a subscriber

Startup Check

GET/api/v1/notification/health

This is a startup check endpoint. It can be used to check if the application is up and running.

Subscribe

POST/api/v1/subscribe

Function to subscribe to a topic

Unsubscribe

POST/api/v1/unsubscribe

Function to unsubscribe from a topic

Data Models & Schemas