Canso - ML Platform
  • 👋Introduction
  • 🏛️Canso Architecture
  • 💻Getting Started
    • 🏁Overview
    • 🌌Provison K8s Clusters
    • 🚢Install Canso Helm Charts
    • 🐍🔗 Canso Python Client & Web App
    • 📊Health Metrics for Features in the Data Plane
  • 💡Feature Store
    • Data Sources
      • Data Spans
    • Data Sinks
    • ML Features
      • Raw ML Batch Feature
      • Derived ML Batch Feature
      • Raw ML Streaming Feature
      • Custom User Defined Function
  • 💡AI Agents
    • Introduction
    • Getting Started
    • Quickstart
    • Use Cases
      • Fraud Analyst Agent
      • Agent with Memory
      • Memory command examples
    • Concepts
      • Task Server
      • Broker
      • Checkpoint DB
      • Conversation History
      • Memory
    • How Tos
      • Update the AI Agent
      • Delete the AI Agent
    • Toolkit
      • SQL Runner
      • Kubernetes Job
      • Text-to-SQL
    • API Documentation
      • Agent
      • Memory
  • 💡Risk
    • Overview
    • Workflows and Rules
    • Real Time Transaction Monitoring
    • API Documentation
  • 💡Fraud Investigation
    • API Documentation
  • 📝Guides
    • Registry
    • Dry Runs for Batch ML Features
    • Deployment
Powered by GitBook
On this page

Was this helpful?

  1. 💡Fraud Investigation

API Documentation

PreviousAPI DocumentationNextRegistry

Last updated 7 days ago

Was this helpful?

Health Check

Tenant Options

Get Tenant Options

Add Tenant Options

Product Options

Get Product Options

Add Product Options

Tenant Data Connection Configs

Get Tenant Data Connections

Create Tenant Data Connections

Update Tenant Data Connection

Delete Tenant Data Connection

Users

Get Users

Tenant Data ET Configs

Create Tenant Data ET

Update Tenant Data ET

Delete Tenant Data ET

Health Check

get
Responses
200
Successful Response
application/json
Responseany
get
GET /health HTTP/1.1
Host: 
Accept: */*
200

Successful Response

No content

Get Tenant Options

get
Authorizations
Header parameters
correlation-idstringRequired
Responses
200
Successful Response
application/json
422
Validation Error
application/json
get
GET /v1/tenant-options HTTP/1.1
Host: 
correlation-id: text
Accept: */*

{
  "options_values": [
    {
      "name": "text",
      "values": [
        "text"
      ]
    }
  ]
}

Get Product Options

get
Authorizations
Query parameters
limitany ofOptional

Maximum number of records to return

integer · min: 1Optional
or
nullOptional
offsetany ofOptional

Number of records to skip

integerOptional
or
nullOptional
Header parameters
correlation-idstringRequired
Responses
200
Successful Response
application/json
422
Validation Error
application/json
get
GET /v1/product-options HTTP/1.1
Host: 
correlation-id: text
Accept: */*

{
  "options_values": [
    {
      "product": "text",
      "option_values": [
        {
          "option_name": "text",
          "option_values": [
            "text"
          ]
        }
      ]
    }
  ]
}

Get Tenant Data Conn

get

Get all data connection configs for the current tenant.

Authorizations
Header parameters
correlation-idstringRequired
Responses
200
Successful Response
application/json
422
Validation Error
application/json
get
GET /v1/tenant-data-conn-configs HTTP/1.1
Host: 
correlation-id: text
Accept: */*

{
  "data_connections": [
    {
      "name": "text",
      "type": "text",
      "configs": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  ]
}

Delete Tenant Data Conn

delete

DELETE one data‑connection config by name for the current tenant.

Authorizations
Path parameters
namestringRequired
Header parameters
correlation-idstringRequired
Responses
200
Successful Response
application/json
422
Validation Error
application/json
delete
DELETE /v1/tenant-data-conn-configs/{name} HTTP/1.1
Host: 
correlation-id: text
Accept: */*

{
  "message": "text"
}

Get list of users

get
Authorizations
Query parameters
roleany ofOptional

Filter users by role

string · enumOptionalPossible values:
or
nullOptional
Header parameters
correlation-idstringRequired
Responses
200
List of users retrieved successfully
application/json
400
Bad Request
422
Validation Error
application/json
500
Internal server error
get
GET /v1/users HTTP/1.1
Host: 
correlation-id: text
Accept: */*

{
  "users": [
    {
      "user_name": "text",
      "email_id": "text",
      "tenant_id": "text",
      "tenant_name": "text",
      "role": "CANSO_ADMIN",
      "status": "ACTIVE"
    }
  ]
}

Delete Tenant Data Conn

delete

DELETE one data ET config by unit_name for the current tenant.

Authorizations
Path parameters
unit_namestringRequired
Header parameters
correlation-idstringRequired
Responses
200
Successful Response
application/json
422
Validation Error
application/json
delete
DELETE /v1/tenant-data-et-configs/{unit_name} HTTP/1.1
Host: 
correlation-id: text
Accept: */*

{
  "message": "text"
}
  • Health Check
  • GETHealth Check
  • Tenant Options
  • Get Tenant Options
  • GETGet Tenant Options
  • Add Tenant Options
  • POSTAdd Tenant Options
  • Product Options
  • Get Product Options
  • GETGet Product Options
  • Add Product Options
  • POSTAdd Product Options
  • Tenant Data Connection Configs
  • Get Tenant Data Connections
  • GETGet Tenant Data Conn
  • Create Tenant Data Connections
  • POSTCreate Tenant Data Conn
  • Update Tenant Data Connection
  • PATCHUpdate Tenant Data Conn
  • Delete Tenant Data Connection
  • DELETEDelete Tenant Data Conn
  • Users
  • Get Users
  • GETGet list of users
  • Tenant Data ET Configs
  • Create Tenant Data ET
  • POSTCreate Tenant Data Et
  • Update Tenant Data ET
  • PATCHUpdate Tenant Data Et
  • Delete Tenant Data ET
  • DELETEDelete Tenant Data Conn

Add Tenant Options

post
Authorizations
Header parameters
correlation-idstringRequired
Body
Responses
201
Successful Response
application/json
422
Validation Error
application/json
post
POST /v1/tenant-options HTTP/1.1
Host: 
correlation-id: text
Content-Type: application/json
Accept: */*
Content-Length: 47

{
  "options": [
    {
      "name": "text",
      "values": [
        "text"
      ]
    }
  ]
}
{
  "message": "text"
}

Add Product Options

post
Authorizations
Header parameters
correlation-idstringRequired
Body
Responses
201
Successful Response
application/json
422
Validation Error
application/json
post
POST /v1/product-options HTTP/1.1
Host: 
correlation-id: text
Content-Type: application/json
Accept: */*
Content-Length: 106

{
  "product_options": [
    {
      "product": "text",
      "option_values": [
        {
          "option_name": "text",
          "option_values": [
            "text"
          ]
        }
      ]
    }
  ]
}
{
  "message": "text"
}

Create Tenant Data Conn

post

Add data connection configs for the current tenant.

Authorizations
Header parameters
correlation-idstringRequired
Body

Request model for adding one or more data‐connection configs to a tenant.

Responses
201
Successful Response
application/json
422
Validation Error
application/json
post
POST /v1/tenant-data-conn-configs HTTP/1.1
Host: 
correlation-id: text
Content-Type: application/json
Accept: */*
Content-Length: 101

{
  "data_connections": [
    {
      "name": "text",
      "type": "text",
      "configs": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  ]
}
{
  "message": "text"
}

Update Tenant Data Conn

patch

Update data‑connection config by name for the current tenant.

Authorizations
Path parameters
namestringRequired
Header parameters
correlation-idstringRequired
Body
typeany ofOptional

New connection type, if updating

stringOptional
or
nullOptional
configsany ofOptional

New configs map, if updating

or
nullOptional
Responses
200
Successful Response
application/json
422
Validation Error
application/json
patch
PATCH /v1/tenant-data-conn-configs/{name} HTTP/1.1
Host: 
correlation-id: text
Content-Type: application/json
Accept: */*
Content-Length: 64

{
  "type": "text",
  "configs": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}
{
  "message": "text"
}

Create Tenant Data Et

post
Authorizations
Header parameters
correlation-idstringRequired
Body
Responses
201
Successful Response
application/json
422
Validation Error
application/json
post
POST /v1/tenant-data-et-configs HTTP/1.1
Host: 
correlation-id: text
Content-Type: application/json
Accept: */*
Content-Length: 84

{
  "data_ets": [
    {
      "unit_name": "text",
      "configs": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  ]
}
{
  "message": "text"
}

Update Tenant Data Et

patch

Update data ET config by unit_name for the current tenant.

Authorizations
Path parameters
unit_namestringRequired
Header parameters
correlation-idstringRequired
Body
Responses
200
Successful Response
application/json
422
Validation Error
application/json
patch
PATCH /v1/tenant-data-et-configs/{unit_name} HTTP/1.1
Host: 
correlation-id: text
Content-Type: application/json
Accept: */*
Content-Length: 50

{
  "configs": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}
{
  "message": "text"
}