Overview
Resources
CRUD Operations
Conventions
Embedding Resources
Errors
Request Ids
Versioning and Endpoint Lifecycle
Trying the API
Authentication
supported endpoints
ApiAccessToken
post
Create api access token
get
List api access tokens
get
Get api access token
del
Delete api access token
AwsConfig
post
Create AWS Config
get
List AWS configs
put
Update AWS Config
patch
Update AWS Config
AwsRole
post
Create AWS role
get
List AWS roles
put
Update AWS role
del
Delete AWS role
Connection
post
Create connection
get
List connections
post
Create connection (dry run)
get
Count connections
get
Get connection
patch
Update connection
del
Delete connection
get
Get connection status
ConnectionPermission
post
Create connection permission
get
Get connection permissions
get
Get connection permission
del
Delete connection permission
ConnectorMetadata
post
Create overrides for connector
get
Get overrides for connector
del
Delete all custom overrides for a connector
get
Get connector metadata information
get
Get default connector metadata information
get
Get connector publish information
DatabricksCluster
get
Check for Databricks access token
get
Get Databricks Table cluster name for user
put
Save Databricks access token
put
Update Databricks access token for user
put
Save Databricks cluster for current user
put
Save Databricks cluster for user
put
Save Databricks Table cluster name for user
Deployment
post
Create deployment
get
List deployments
post
Run Deployment
post
Import Flow package for deployment
get
Get releases for deployment
post
Import deployment package - Dry run
get
Count deployments
get
Get deployment
put
Update deployment
patch
Patch deployment
del
Delete deployment
get
Get active Outputs for Deployment
patch
Update Object Import Rules
patch
Update Value Import Rules
Edit
get
Get Recipe Edit history
EmrCluster
post
Create emr cluster
get
List emr clusters
get
Count emr clusters
get
Get emr cluster
patch
Update emr cluster
del
Delete emr cluster
EnvironmentParameter
post
Create environment parameter
get
List environment parameters
post
Import environment parameters package
get
Export environment parameters list
get
Get environment parameter
del
Delete environment parameter
get
Count environment parameters
Flow
post
Create flow
get
List flows
post
Move Flow
post
Import Flow package
post
Import Flow package - Dry run
post
Copy Flow
post
Run Flow
get
Count flows
get
Get flow
put
Update flow
patch
Patch flow
del
Delete flow
get
Validate Flow
get
Export flow
get
Export flow - Dry run
get
Flow Library (list)
get
Flow Library (count)
get
Get flow level parameters and overrides
get
List Flow inputs
get
List Flow outputs
get
List flows in folder
get
Count flows in folder
patch
Replace dataset
patch
Reset flow dependencies
FlowNode
post
Create new edges
get
Validate Flow Node
FlowPermission
post
Share Flow
get
List permissions for Flow
get
Get flow permission
del
Delete flow permission
FlowRun
get
Get flow run
get
Get Flow Run Status
get
Get JobGroups for Flow Run
FlowRunParameterOverride
post
Create flow run parameter override
get
Get flow run parameter override
patch
Patch flow run parameter override
del
Delete flow run parameter override
Folder
post
Create folder
get
List folders
get
Count folders
get
Get folder
put
Update folder
patch
Patch folder
del
Delete folder
get
List flows in folder
get
Count flows in folder
ImportedDataset
post
Create imported dataset
get
List imported datasets
post
Add Imported Dataset to Flow
post
Copy imported dataset
post
Fetch and update latest datasource schema
get
List Flow inputs
get
Count imported datasets
get
Get imported dataset
put
Update imported dataset
patch
Patch imported dataset
del
Delete imported dataset
get
List inputs for Output Object
get
List Datasets
get
Count Datasets
put
Update existing scriptlines for the datasource
Job
get
Get Jobs for Job Group
get
Get Job Status
JobGroup
post
Run Job Group
get
List job groups
post
Cancel Job Group
get
Count job groups
get
Get job group
get
Get Profile Information for Job Group
get
Get Profile Information for Job Group As a Map
get
Get PDF Results for Job Group
get
Get JobGroup Status
get
Get Job Group Inputs
get
Get Job Group Outputs
get
List Job Groups
get
Count Job Groups
get
Get Jobs for Job Group
get
Get Job Group logs
get
Get Publications for Job Group
put
Publish Job Group
License
get
Validate User Quota in License
Macro
post
Import Macro Package
post
Import Macro Package - Dry run
get
Get Macro Package
Misc
get
Get OpenAPI specification
Oauth2ClientDetail
post
Create oauth 2 client detail
get
Get all oauth2 client models for enterprise edition
get
Get available oauth2 client models for enterprise edition
get
Get oauth2 client models according to edition
OutputObject
post
Create output object
get
List output objects
post
Generate python script for wrangle recipe linked to an output object
get
List Flow outputs
get
Count output objects
get
Get output object
put
Update output object
patch
Patch output object
del
Delete output object
get
List inputs for Output Object
Person
get
Get Current Person
get
Get person
put
Update person
patch
Patch person
del
Delete person
get
List people
post
Create person
get
Count people
patch
Update password
post
Reset password request
Plan
post
Create plan
get
List plans
post
Run plan
post
Share Plan
get
List permissions for plan
post
Import plan package
get
Count plans
get
List run parameters
get
Read plan with all attributes
get
List plan schedules
get
Export plan
patch
Update plan
del
Delete plan
del
Delete plan permissions for a user
PlanEdge
post
Create plan edge
PlanNode
post
Create plan node
get
List run parameters for a plan node
del
Delete plan node
PlanOverride
post
Override a parameter in a plan
put
Update the value of a parameter override in a plan
PlanScheduleOverride
post
Create plan schedule override
put
Update plan schedule override
PlanSnapshotRun
post
Cancel a plan execution
get
List plan snapshot runs
get
Count plan snapshot runs
get
Get plan snapshot run
get
Get schedule for plan run
PlanStorageTask
patch
Update plan storage task
Publication
post
Create publication
get
List publications
get
Count publications
get
Get publication
put
Update publication
patch
Patch publication
del
Delete publication
Release
post
Import Flow package for deployment
get
Get releases for deployment
post
Import deployment package - Dry run
get
List releases
get
Count releases
get
Get release
put
Update release
patch
Patch release
del
Delete release
get
Export Release
get
Export Release - dry run
ResourceTaskState
post
Get Resource Task States
post
Get Resource Task Ids for given resources
RunParameter
post
Create run parameter
put
Update run parameter
del
Delete run parameter
Schedule
post
Create a schedule
get
List schedules
post
Enable schedule
post
Disable schedule
get
Count schedules
get
Get schedule
put
Update a schedule
del
Delete schedule
SqlScript
post
Create sql script
get
List sql scripts
get
Count sql scripts
get
Get sql script
patch
Patch sql script
del
Delete sql script
SupportBundle
get
Get Support Bundle
get
Get Support Bundle for current session
Usage
get
List Jobs usage
get
List compute usage
get
Get the Usage Detailed Report for the specified period
get
Get the Usage Detailed Report for the specified period
get
List user usages for project
get
List user usages for entitlement
WebhookFlowTask
post
Create webhook
post
Test webhook settings
get
Read webhook
del
Delete webhook
Workspace
post
Reset a configuration settings for the current workspace
post
Reset a workspace configuration settings
get
Get current workspace configuration
patch
Save current workspace configuration
get
Get workspace configuration
patch
Save workspace configuration
get
Get configuration schema
get
Get current configuration schema
patch
Transfer User Assets
patch
Transfer User Assets
WrangledDataset
post
Create wrangled dataset
get
List wrangled datasets
post
Add wrangled dataset to flow
get
Count wrangled datasets
get
Get wrangled dataset
patch
Patch Wrangled Dataset
del
Delete wrangled dataset
get
Get Input Dataset
put
Swap Input Dataset
WriteSetting
post
Create writesetting
get
List write settings
get
Count write settings
get
Get write setting
put
Update write setting
patch
Patch write setting
del
Delete write setting
Documentation Powered by ReDoc