Skip to main content

Home

Autoaction

Overview

AutoActions APIs manage threshold‑based policies for Databricks jobs and clusters, including listing policy instances and templates, viewing details, and retrieving violation events. They let you automate alerts or other actions when duration or cost cross configured limits.

AutoActions instances list API
Request
/api/v1/ds/api/v1/autoactions/instances/list
Query Parameters

This endpoint does not take query parameters.

Example
curl -X GET \
  -H "Authorization: JWT <token>" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  "https://{yourdomain.com}/api/v1/ds/api/v1/autoactions/instances/list"
Response
[{"enabled":true,"admin":true,"policy_name":"Databricks Job runs","policy_id":1119,"instance_id":"3795775801234561626","entity_type":"databricks","name_by_user":"Databricks Job runs","description_by_user":"Databricks Job runs","created_by":"admin","last_edited_by":"admin","created_at":1746440802756,"updated_at":1753843304695,"rules":[{"OR":[{"scope":"Databricks jobs","metric":"totalDuration","compare":"&gt;=","value":300000},{"scope":"Databricks jobs","metric":"cost","compare":"&gt;=","value":1}]}],"actions":[],"cluster_mode":0,"cluster_list":[],"cluster_transform":"","queue_mode":0,"queue_list":[],"queue_transform":"","user_mode":0,"user_list":[],"user_transform":"","app_mode":2,"app_list":["job3"],"app_transform":"","sustain_mode":0,"sustain_time":0,"time_mode":0},{"enabled":true,"admin":true,"policy_name":"Databricks Job runs","policy_id":1119,"instance_id":"5736267329799637125","entity_type":"databricks","name_by_user":"Databricks Job runs","description_by_user":"Databricks Job runs","created_by":"admin","last_edited_by":"admin","created_at":1748350437480,"updated_at":1753859079166,"rules":[{"OR":[{"scope":"Databricks jobs","metric":"totalDuration","compare":"&gt;=","value":1000},{"scope":"Databricks jobs","metric":"cost","compare":"&gt;=","value":1}]}],"actions":[{"action":"send_email","to":["mshivanna@unraveldata.com"],"subject":"Databricks Job runs","to_owner":false}],"cluster_mode":0,"cluster_list":[],"cluster_transform":"","queue_mode":0,"queue_list":[],"queue_transform":"","user_mode":0,"user_list":[],"user_transform":"","app_mode":2,"app_list":["job2"],"app_transform":"","sustain_mode":0,"sustain_time":0,"time_mode":0},{"enabled":true,"admin":true,"policy_name":"Databricks Clusters","policy_id":1120,"instance_id":"2899784531176363857","entity_type":"databricks","name_by_user":"Databricks Clusters test","description_by_user":"Databricks Clusters","created_by":"admin","last_edited_by":"admin","created_at":1753792111018,"updated_at":1753853360922,"rules":[{"OR":[{"scope":"Databricks clusters","metric":"totalDuration","compare":"&gt;=","value":300000},{"scope":"Databricks clusters","metric":"cost","compare":"&gt;=","value":1}]}],"actions":[],"cluster_mode":2,"cluster_list":["0528-090505-tj4sz9wt","0507-065232-zn88qzmh","0515-123139-xsi8kqjl"],"queue_mode":0,"queue_list":[],"queue_transform":"","user_mode":2,"user_list":["swati@unraveldata.com","dgupta@unraveldata.com"],"user_transform":"","app_mode":0,"app_list":[],"app_transform":"","sustain_mode":0,"sustain_time":0,"time_mode":0},{"enabled":true,"admin":true,"policy_name":"Databricks Clusters","policy_id":1120,"instance_id":"6815283305623567386","entity_type":"databricks","name_by_user":"Databricks Clusters 2 test","description_by_user":"Databricks Clusters","created_by":"admin","last_edited_by":"admin","created_at":1753836787197,"updated_at":1753859058330,"rules":[{"OR":[{"scope":"Databricks clusters","metric":"totalDuration","compare":"&gt;=","value":300000},{"scope":"Databricks clusters","metric":"cost","compare":"&gt;=","value":1}]}],"actions":[],"cluster_mode":2,"cluster_list":["0507-065232-zn88qzmh"],"cluster_transform":"","queue_mode":0,"queue_list":[],"queue_transform":"","user_mode":0,"user_list":[],"user_transform":"","app_mode":0,"app_list":[],"app_transform":"","sustain_mode":0,"sustain_time":0,"time_mode":0},{"enabled":true,"admin":true,"policy_name":"Databricks Clusters","policy_id":1120,"instance_id":"7988469124471101028","entity_type":"databricks","name_by_user":"Databricks Clusters malik","description_by_user":"Databricks Clusters","created_by":"admin","last_edited_by":"admin","created_at":1753868741936,"updated_at":1753876425068,"rules":[{"OR":[{"scope":"Databricks clusters","metric":"totalDuration","compare":"&gt;=","value":10000},{"scope":"Databricks clusters","metric":"cost","compare":"&gt;=","value":1}]}],"actions":[],"cluster_mode":2,"cluster_list":["0703-130904-3vzcla7x","0718-090835-5cwdpr6o"],"queue_mode":0,"queue_list":[],"queue_transform":"","user_mode":0,"user_list":[],"user_transform":"","app_mode":0,"app_list":[],"app_transform":"","sustain_mode":0,"sustain_time":0,"time_mode":0},{"enabled":true,"admin":true,"policy_name":"Databricks Job runs","policy_id":1119,"instance_id":"3950349026105513440","entity_type":"databricks","name_by_user":"Databricks Job runs malik","description_by_user":"Databricks Job runs","created_by":"admin","last_edited_by":"admin","created_at":1753868858126,"updated_at":1753876423439,"rules":[{"OR":[{"scope":"Databricks jobs","metric":"totalDuration","compare":"&gt;=","value":10000},{"scope":"Databricks jobs","metric":"cost","compare":"&gt;=","value":1}]}],"actions":[],"cluster_mode":0,"cluster_list":[],"cluster_transform":"","queue_mode":0,"queue_list":[],"queue_transform":"","user_mode":0,"user_list":[],"user_transform":"","app_mode":2,"app_list":["Spark_Python_Task_Simulator"],"sustain_mode":0,"sustain_time":0,"time_mode":0},{"enabled":false,"admin":true,"policy_name":"Databricks Clusters","policy_id":1120,"instance_id":"4804697325787864193","entity_type":"databricks","name_by_user":"Databricks Clusters new test once more","description_by_user":"Databricks Clusters","created_by":"admin","last_edited_by":"admin","created_at":1753876439012,"updated_at":1753876723679,"rules":[{"OR":[{"scope":"Databricks clusters","metric":"totalDuration","compare":"&gt;=","value":300000},{"scope":"Databricks clusters","metric":"cost","compare":"&gt;=","value":1}]}],"actions":[],"cluster_mode":3,"cluster_list":["0508-174834-qwn2gprc"],"cluster_transform":"","queue_mode":0,"queue_list":[],"queue_transform":"","user_mode":1,"user_list":[],"user_transform":"","app_mode":0,"app_list":[],"app_transform":"","sustain_mode":0,"sustain_time":0,"time_mode":0},{"enabled":false,"admin":true,"policy_name":"Databricks Job runs","policy_id":1119,"instance_id":"6760296398621846162","entity_type":"databricks","name_by_user":"Databricks Job runs test once more","description_by_user":"Databricks Job runs","created_by":"admin","last_edited_by":"admin","created_at":1753876594142,"updated_at":1753876735454,"rules":[{"OR":[{"scope":"Databricks jobs","metric":"totalDuration","compare":"&gt;=","value":300000},{"scope":"Databricks jobs","metric":"cost","compare":"&gt;=","value":1}]}],"actions":[],"cluster_mode":0,"cluster_list":[],"cluster_transform":"","queue_mode":0,"queue_list":[],"queue_transform":"","user_mode":0,"user_list":[],"user_transform":"","app_mode":3,"app_list":["job1","job23"],"app_transform":"","sustain_mode":0,"sustain_time":0,"time_mode":0},{"enabled":true,"admin":true,"policy_name":"Databricks Clusters","policy_id":1120,"instance_id":"711366794186507746","entity_type":"databricks","name_by_user":"Mallik_Databricks Clusters","description_by_user":"Databricks Clusters","created_by":"admin","last_edited_by":"admin","created_at":1754984633809,"updated_at":1754984633809,"rules":[{"OR":[{"scope":"Databricks clusters","metric":"totalDuration","compare":"&gt;=","value":300000},{"scope":"Databricks clusters","metric":"cost","compare":"&gt;=","value":1}]}],"actions":[],"cluster_mode":2,"cluster_list":["0718-085334-h0ichpi2","0718-090835-5cwdpr6o"],"queue_mode":0,"queue_list":[],"queue_transform":"","user_mode":0,"user_list":[],"user_transform":"","app_mode":0,"app_list":[],"app_transform":"","sustain_mode":0,"sustain_time":0,"time_mode":0},{"enabled":true,"admin":true,"policy_name":"Databricks Job runs","policy_id":1119,"instance_id":"244415390804281232","entity_type":"databricks","name_by_user":"Databricks Job runs","description_by_user":"Databricks Job runs","created_by":"admin","last_edited_by":"admin","created_at":1755409206698,"updated_at":1755409225098,"rules":[{"OR":[{"scope":"Databricks jobs","metric":"totalDuration","compare":"&gt;=","value":300000},{"scope":"Databricks jobs","metric":"cost","compare":"&gt;=","value":1}]}],"actions":[],"cluster_mode":0,"cluster_list":[],"cluster_transform":"","queue_mode":0,"queue_list":[],"queue_transform":"","user_mode":0,"user_list":[],"user_transform":"","app_mode":1,"app_list":[],"sustain_mode":0,"sustain_time":0,"time_mode":0},{"enabled":true,"admin":true,"policy_name":"Databricks Clusters","policy_id":1120,"instance_id":"1778873862908335176","entity_type":"databricks","name_by_user":"Databricks Clusters hf","description_by_user":"Databricks Clusters","created_by":"admin","last_edited_by":"admin","created_at":1755419837692,"updated_at":1755419854221,"rules":[{"OR":[{"scope":"Databricks clusters","metric":"totalDuration","compare":"&gt;=","value":500000},{"scope":"Databricks clusters","metric":"cost","compare":"&gt;=","value":1}]}],"actions":[],"cluster_mode":2,"cluster_list":["0515-124056-pslkxeu5","0506-070952-ct50p6d8"],"queue_mode":0,"queue_list":[],"queue_transform":"","user_mode":0,"user_list":[],"user_transform":"","app_mode":0,"app_list":[],"app_transform":"","sustain_mode":0,"sustain_time":0,"time_mode":0},{"enabled":false,"admin":true,"policy_name":"Databricks Clusters","policy_id":1120,"instance_id":"7757012377550849701","entity_type":"databricks","name_by_user":"Databricks Clusters hf (duplicate)","description_by_user":"Databricks Clusters","created_by":"admin","last_edited_by":"admin","created_at":1755419920030,"updated_at":1755420105874,"rules":[{"OR":[{"scope":"Databricks clusters","metric":"totalDuration","compare":"&gt;=","value":500000},{"scope":"Databricks clusters","metric":"cost","compare":"&gt;=","value":1}]}],"actions":[],"cluster_mode":2,"cluster_list":["0515-124056-pslkxeu5","0506-070952-ct50p6d8"],"queue_mode":0,"queue_list":[],"queue_transform":"","user_mode":0,"user_list":[],"user_transform":"","app_mode":0,"app_list":[],"app_transform":"","sustain_mode":0,"sustain_time":0,"time_mode":0},{"enabled":true,"admin":true,"policy_name":"Databricks Job runs","policy_id":1119,"instance_id":"876325625317790817","entity_type":"databricks","name_by_user":"Databricks Job runs","description_by_user":"Databricks Job runs","created_by":"admin","last_edited_by":"admin","created_at":1766044670375,"updated_at":1766044670375,"rules":[{"OR":[{"scope":"Databricks jobs","metric":"totalDuration","compare":"&gt;=","value":300000},{"scope":"Databricks jobs","metric":"cost","compare":"&gt;=","value":2}]}],"actions":[],"cluster_mode":0,"cluster_list":[],"cluster_transform":"","queue_mode":0,"queue_list":[],"queue_transform":"","user_mode":0,"user_list":[],"user_transform":"","app_mode":1,"app_list":[],"sustain_mode":0,"sustain_time":0,"time_mode":0}]
AutoActions templates list API
Request
/api/v1/ds/api/v1/autoactions/templates

Use this API to list AutoAction templates, which define reusable policy skeletons for Databricks jobs and clusters.

Query prameters

Parameter

Type

Description

is_enabled

boolean

Filter to enabled templates only.

is_admin

boolean

If true, return admin‑level templates; if false, return templates created by the caller.

type

string

Target system type (for example, databricks).

Example
curl -X GET \
  -H "Authorization: JWT <token>" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  "https://{yourdomain.com}/api/v1/ds/api/v1/autoactions/templates?is_enabled=true&is_admin=true&type=databricks"
Response
[{"tooltip":"AutoAction policy for Databricks job runs that exceed the cost or duration threshold.","enabled":true,"admin":true,"policy_name":"Databricks Job runs","policy_id":1119,"instance_id":3780982408095453608,"entity_id":null,"entity_type":"databricks","name_by_user":"Databricks Job runs","description_by_user":"Databricks Job runs","created_by":"admin","last_edited_by":"admin","user_mode":0,"time_mode":0,"queue_mode":0,"cluster_mode":0,"app_mode":1,"sustain_mode":0,"sustain_time":0,"rules":[{"OR":[{"scope":"Databricks jobs","metric":"totalDuration","compare":"&gt;=","value":0},{"scope":"Databricks jobs","metric":"cost","compare":"&gt;=","value":0}]}],"start_hour":0,"start_min":0,"end_hour":0,"end_min":0,"dt_zone":"America/Los_Angeles","cluster_tags_mode":1},{"tooltip":"AutoAction policy for Databricks clusters that exceed the cost or duration threshold.","enabled":true,"admin":true,"policy_name":"Databricks Clusters","policy_id":1120,"instance_id":841610134986591374,"entity_id":null,"entity_type":"databricks","name_by_user":"Databricks Clusters","description_by_user":"Databricks Clusters","created_by":"admin","last_edited_by":"admin","user_mode":0,"time_mode":0,"queue_mode":0,"cluster_mode":1,"app_mode":0,"sustain_mode":0,"sustain_time":0,"rules":[{"OR":[{"scope":"Databricks clusters","metric":"totalDuration","compare":"&gt;=","value":0},{"scope":"Databricks clusters","metric":"cost","compare":"&gt;=","value":0}]}],"start_hour":0,"start_min":0,"end_hour":0,"end_min":0,"dt_zone":"America/Los_Angeles","cluster_tags_mode":1}]
AutoActions details API
Request
/api/v1/ds/api/v1/autoactions/{autoActionId}/details

Use this API to retrieve full configuration details for a specific AutoAction instance.

Path parameters

Parameter

Type

Description

autoActionId

string

Unique AutoAction instance ID.

Example
curl -X GET \
  -H "Authorization: JWT <token>" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  "https://{yourdomain.com}/api/v1/ds/api/v1/autoactions/1778873862908335176/details"
Response
{  "enabled" : true,  "admin" : true,  "policy_name" : "Databricks Clusters",  "policy_id" : 1120,  "instance_id" : "1778873862908335176",  "entity_type" : "databricks",  "name_by_user" : "Databricks Clusters hf",  "description_by_user" : "Databricks Clusters",  "created_by" : "admin",  "last_edited_by" : "admin",  "created_at" : 1755419837692,  "updated_at" : 1755419854221,  "rules" : [ {    "OR" : [ {      "scope" : "Databricks clusters",      "metric" : "totalDuration",      "compare" : "&gt;=",      "value" : 500000    }, {      "scope" : "Databricks clusters",      "metric" : "cost",      "compare" : "&gt;=",      "value" : 1    } ]  } ],  "actions" : [ ],  "cluster_mode" : 2,  "cluster_list" : [ "0515-124056-pslkxeu5", "0506-070952-ct50p6d8" ],  "queue_mode" : 0,  "queue_list" : [ ],  "queue_transform" : "",  "user_mode" : 0,  "user_list" : [ ],  "user_transform" : "",  "app_mode" : 0,  "app_list" : [ ],  "app_transform" : "",  "sustain_mode" : 0,  "sustain_time" : 0,  "time_mode" : 0}
AutoActions violations API
Request
/api/v1/ds/api/v1/autoactions/{autoActionId}/violations

Use this API to list violation events generated by an AutoAction instance, including cluster, event time, and event metadata.

Path parameters

Parameter

Type

Description

autoActionId

string

AutoAction policy ID.

Query parameters

Parameter

Type

Required

Description

aiid

string

Yes

AutoAction instance ID.

limit

number

No

Number of records to return.

from

number

No

Pagination offset.

total

boolean

No

Whether to include total count.

sortField

string

No

Sort field (for example, eventTime).

sortType

string

No

Sort order (asc, desc).

Example
curl -X GET \
  -H "Authorization: JWT <token>" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  "https://{yourdomain.com}/api/v1/ds/api/v1/autoactions/4076185910407592500/violations?aiid=4076185910407592500&limit=100&from=0&total=true&sortField=eventTime&sortType=desc"
Response
[{"appCount":1,"clusterUid":"0203-035604-vr6ex38n","eventNumber":80002,"entityType":0,"entityId":"4076185910407592500","eventType":"AV","entityGroup":0,"staticRank":80,"clusterName":"job-365266228678133-run-807514865705192","appId":"http://shell.saas.unraveldata.com:443/#/compute/cluster_summary?cluster_uid=0203-035604-vr6ex38n&amp;app_id=app-20260203035658-0000","eventTime":1770091513479,"dynamicRank":-1,"eventName":"Databricks Clusters","user":"N/A","queue":"N/A"},{"appCount":1,"clusterUid":"0203-034937-4gey7iqv","eventNumber":80002,"entityType":0,"entityId":"4076185910407592500","eventType":"AV","entityGroup":0,"staticRank":80,"clusterName":"job-87803859578262-run-85841415653547","appId":"http://shell.saas.unraveldata.com:443/#/compute/cluster_summary?cluster_uid=0203-034937-4gey7iqv&amp;app_id=app-20260203035623-0000","eventTime":1770091513479,"dynamicRank":-1,"eventName":"Databricks Clusters","user":"N/A","queue":"N/A"},{"appCount":1,"clusterUid":"1011-123644-8kzykqaf","eventNumber":80002,"entityType":0,"entityId":"4076185910407592500","eventType":"AV","entityGroup":0,"staticRank":80,"clusterName":"Iain Miller's Cluster","appId":"http://shell.saas.unraveldata.com:443/#/compute/cluster_summary?cluster_uid=1011-123644-8kzykqaf&amp;app_id=local-1769144787471","eventTime":1770091333197,"dynamicRank":-1,"eventName":"Databricks Clusters","user":"N/A","queue":"N/A"},{"appCount":1,"clusterUid":"0203-015141-0drp98ln","eventNumber":80002,"entityType":0,"entityId":"4076185910407592500","eventType":"AV","entityGroup":0,"staticRank":80,"clusterName":"job-617747896331285-run-339886289074106","appId":"http://shell.saas.unraveldata.com:443/#/compute/cluster_summary?cluster_uid=0203-015141-0drp98ln&amp;app_id=app-20260203015347-0000","eventTime":1770091333197,"dynamicRank":-1,"eventName":"Databricks Clusters","user":"N/A","queue":"N/A"},{"appCount":1,"clusterUid":"0203-035437-mojqqb3b","eventNumber":80002,"entityType":0,"entityId":"4076185910407592500","eventType":"AV","entityGroup":0,"staticRank":80,"clusterName":"job-799923876814046-run-122157280879261-sfsbi_external_rt_curation_streaming-ePIN_cluster","appId":"http://shell.saas.unraveldata.com:443/#/compute/cluster_summary?cluster_uid=0203-035437-mojqqb3b&amp;app_id=app-20260203035541-0000","eventTime":1770091333197,"dynamicRank":-1,"eventName":"Databricks Clusters","user":"N/A","queue":"N/A"},{"appCount":1,"clusterUid":"1221-072806-rxi991ox","eventNumber":80002,"entityType":0,"entityId":"4076185910407592500","eventType":"AV","entityGroup":0,"staticRank":80,"clusterName":"CLS_MEDIUM_CONCURRENT_3_2","appId":"http://shell.saas.unraveldata.com:443/#/compute/cluster_summary?cluster_uid=1221-072806-rxi991ox&amp;app_id=app-20260203022506-0000","eventTime":1770091333197,"dynamicRank":-1,"eventName":"Databricks Clusters","user":"N/A","queue":"N/A"},{"appCount":1,"clusterUid":"0203-034940-5f4uxx9j","eventNumber":80002,"entityType":0,"entityId":"4076185910407592500","eventType":"AV","entityGroup":0,"staticRank":80,"clusterName":"job-773969716232867-run-780734899004367","appId":"http://shell.saas.unraveldata.com:443/#/compute/cluster_summary?cluster_uid=0203-034940-5f4uxx9j&amp;app_id=app-20260203035540-0000","eventTime":1770091333197,"dynamicRank":-1,"eventName":"Databricks Clusters","user":"N/A","queue":"N/A"},{"appCount":1,"clusterUid":"0305-080554-4ioc1tt1","eventNumber":80002,"entityType":0,"entityId":"4076185910407592500","eventType":"AV","entityGroup":0,"staticRank":80,"clusterName":"MDH_PROD_CLUSTER_13.3","appId":"http://shell.saas.unraveldata.com:443/#/compute/cluster_summary?cluster_uid=0305-080554-4ioc1tt1&amp;app_id=app-20251130233527-0000","eventTime":1770091333197,"dynamicRank":-1,"eventName":"Databricks Clusters","user":"N/A","queue":"N/A"},{"appCount":1,"clusterUid":"0727-055756-h528ni2m","eventNumber":80002,"entityType":0,"entityId":"4076185910407592500","eventType":"AV","entityGroup":0,"staticRank":80,"clusterName":"MMM_DEV","appId":"http://shell.saas.unraveldata.com:443/#/compute/cluster_summary?cluster_uid=0727-055756-h528ni2m&amp;app_id=app-20260203024754-0000","eventTime":1770090972983,"dynamicRank":-1,"eventName":"Databricks Clusters","user":"N/A","queue":"N/A"}]