REST API Reference

Reference for the Splunk_ML_Toolkit /mltk/** REST API surface, derived from AITK_API_reference.md and AITK_API_summary.md.

Showing 61 of 61

Method
Group

All custom endpoints are mounted under a single Splunk REST entry-point: /servicesNS/{owner}/Splunk_ML_Toolkit/mltk/<handler>[/<subpath>].

Comprehensive reference for the Splunk AI Toolkit (Splunk_ML_Toolkit) REST API.

All custom endpoints are mounted under a single Splunk REST entry-point:

/servicesNS/{owner}/Splunk_ML_Toolkit/mltk/<handler>[/<subpath>]

Declared in Splunk_ML_Toolkit/default/restmap.conf:

[script:mltk]
match              = /mltk
script             = util/rest_handler.py
scripttype         = persist
requireAuthentication = true
output_modes       = json
passHttpHeaders    = true
passSystemAuth     = true
passPayload        = true
python.version     = python3

Exposed in Splunk_ML_Toolkit/default/web.conf:

[expose:mltk]
pattern = mltk/**
methods = GET, POST, PUT, DELETE

Dispatch is dynamic. The dispatcher at Splunk_ML_Toolkit/bin/util/rest_handler.py takes the first path segment after /mltk/, imports Splunk_ML_Toolkit/bin/rest_handlers/<name>.py, instantiates the matching CamelCase class (name.title().replace('_', '')), and dispatches handle_get | handle_post | handle_put | handle_delete(request, path_parts).

Endpoint groups Permalink to this section

# Group Endpoints Slug
1 Feature Flags & Notifications 5 /api/feature-flags/
2 AI Commander (LLM Providers) 6 /api/ai-commander/
3 AI Agents 5 /api/agents/
4 MCP Connections 6 /api/mcp-connections/
5 Vector Stores 5 /api/vector-stores/
6 Experiments 8 /api/experiments/
7 Models & External Inventories 7 /api/models/
8 Container Lifecycle (DSDL) 14 /api/containers/
9 Run History & HEC 2 /api/run-history-hec/

Inventory snapshot Permalink to this section

Total documented endpoints: 36 (from AITK_API_summary.md).

Endpoint Methods Handler
/mltk/agent_feature_flag GET Splunk_ML_Toolkit/bin/rest_handlers/agent_feature_flag.py
/mltk/agents GET, POST, PUT Splunk_ML_Toolkit/bin/rest_handlers/agents.py
/mltk/agents/{agent_name} GET, DELETE Splunk_ML_Toolkit/bin/rest_handlers/agents.py
/mltk/aicommander GET, POST Splunk_ML_Toolkit/bin/rest_handlers/aicommander.py
/mltk/aicommander/{service}/{connection_name}/{model} GET, DELETE Splunk_ML_Toolkit/bin/rest_handlers/aicommander.py
/mltk/aicommander_metadata GET, POST Splunk_ML_Toolkit/bin/rest_handlers/aicommander_metadata.py
/mltk/container_connection POST Splunk_ML_Toolkit/bin/rest_handlers/container_connection.py
/mltk/container_connection/{container_type} GET Splunk_ML_Toolkit/bin/rest_handlers/container_connection.py
/mltk/container_connection/{container_type}/{connection_name} GET, DELETE Splunk_ML_Toolkit/bin/rest_handlers/container_connection.py
/mltk/container_data GET Splunk_ML_Toolkit/bin/rest_handlers/container_data.py
/mltk/container_logs GET, POST Splunk_ML_Toolkit/bin/rest_handlers/container_logs.py
/mltk/ctsm_acknowledge POST Splunk_ML_Toolkit/bin/rest_handlers/ctsm_acknowledge.py
/mltk/ctsm_feature GET, POST Splunk_ML_Toolkit/bin/rest_handlers/ctsm_feature.py
/mltk/experiments GET, POST Splunk_ML_Toolkit/bin/rest_handlers/experiments.py
/mltk/experiments/{experiment_id} GET, POST, DELETE Splunk_ML_Toolkit/bin/rest_handlers/experiments.py
/mltk/experiments/{experiment_id}/history GET, POST Splunk_ML_Toolkit/bin/rest_handlers/experiments.py
/mltk/experiments/{experiment_id}/clone_models POST Splunk_ML_Toolkit/bin/rest_handlers/experiments.py
/mltk/hec_operations PUT Splunk_ML_Toolkit/bin/rest_handlers/hec_operations.py
/mltk/list_connections GET Splunk_ML_Toolkit/bin/rest_handlers/list_connections.py
/mltk/list_models GET Splunk_ML_Toolkit/bin/rest_handlers/list_models.py
/mltk/mcp_connection GET, POST, PUT Splunk_ML_Toolkit/bin/rest_handlers/mcp_connection.py
/mltk/mcp_connection/{name} DELETE Splunk_ML_Toolkit/bin/rest_handlers/mcp_connection.py
/mltk/mcp_connection/test POST Splunk_ML_Toolkit/bin/rest_handlers/mcp_connection.py
/mltk/mcp_connection/tools POST Splunk_ML_Toolkit/bin/rest_handlers/mcp_connection.py
/mltk/mltk_feature_flags GET Splunk_ML_Toolkit/bin/rest_handlers/mltk_feature_flags.py
/mltk/register_model GET, POST, PUT Splunk_ML_Toolkit/bin/rest_handlers/register_model.py
/mltk/register_model?test_connection=1 POST Splunk_ML_Toolkit/bin/rest_handlers/register_model.py
/mltk/run_history POST Splunk_ML_Toolkit/bin/rest_handlers/run_history.py
/mltk/start_container GET, POST Splunk_ML_Toolkit/bin/rest_handlers/start_container.py
/mltk/start_container/{model_name} DELETE Splunk_ML_Toolkit/bin/rest_handlers/start_container.py
/mltk/stop_container GET, POST Splunk_ML_Toolkit/bin/rest_handlers/stop_container.py
/mltk/test_container_connection GET, POST Splunk_ML_Toolkit/bin/rest_handlers/test_container_connection.py
/mltk/upload_model POST Splunk_ML_Toolkit/bin/rest_handlers/upload_model.py
/mltk/vector_stores GET, POST, PUT Splunk_ML_Toolkit/bin/rest_handlers/vector_stores.py
/mltk/vector_stores/{connection_name} DELETE Splunk_ML_Toolkit/bin/rest_handlers/vector_stores.py
/mltk/vector_stores/test POST Splunk_ML_Toolkit/bin/rest_handlers/vector_stores.py

Backing stores and internal Splunk APIs Permalink to this section

Custom area Native/internal target Responsible code
/mltk/experiments /configs/conf-experiments bin/experiment/experiment_store.py
/mltk/experiments/{id}/history /storage/collections/data/experiment_history bin/experiment/history_store.py
/mltk/list_models lookup table file/model inventory bin/rest_handlers/list_models.py, bin/models/listmodels.py
/mltk/upload_model model upload and validation flow bin/rest_handlers/upload_model.py, bin/util/onnx_util.py
/mltk/register_model SageMaker model config, credentials, lookup entries bin/rest_handlers/register_model.py, bin/util/sagemaker_util_extensions.py
/mltk/hec_operations /services/receivers/simple bin/rest_handlers/hec_operations.py
/mltk/run_history /search/jobs bin/rest_handlers/run_history.py, bin/run_history/search_utils.py
/mltk/container_connection /configs/conf-container_connections bin/rest_handlers/container_connection.py, bin/util/docker_util.py, bin/dsdl/docker_util.py
Container lifecycle endpoints Docker/Kubernetes control helpers and dsdl_container.conf bin/rest_handlers/start_container.py, bin/rest_handlers/stop_container.py, bin/dsdl/configure_handler.py, bin/dsdl/docker_util.py
/mltk/aicommander AI Commander config and KV store data bin/rest_handlers/aicommander.py, bin/ai_commander/ai_commander_util.py
/mltk/mcp_connection aitk_mcp_collection KV store bin/rest_handlers/mcp_connection.py, bin/connection_config_manager/mcp/mcp_util.py
/mltk/vector_stores aitk_vector_store_collection KV store bin/rest_handlers/vector_stores.py, bin/connection_config_manager/vector_db/config_manager.py
/mltk/agents aitk_agent_collection KV store plus agentstatus search command bin/rest_handlers/agents.py, bin/agent_manager/agent_manager.py

Appendices Permalink to this section

Press Cmd/Ctrl+K to focus search. Esc to close.

Type to search the portal.