The following endpoints are available for .

To access the reference documentation for each available API endpoint and method, select Resources menu > API documentation in the .

Current

NOTE: After Release 9.5, any renewals for workspaces that were previously on  must be migrated to a supported product edition. For more information, see Product Editions.


Legacy

For workspaces created before Release 9.5, the following endpoints are available.

ApiAccessToken

Path

Description

Documentation URL

POST /v4/apiAccessTokens

Create api access token

operation/createApiAccessToken

GET /v4/apiAccessTokens

List api access tokens

operation/listApiAccessTokens

GET /v4/apiAccessTokens/:tokenId

Get api access token

operation/getApiAccessToken

DELETE /v4/apiAccessTokens/:tokenId

Delete api access token

operation/deleteApiAccessToken

AwsConfig

Path

Description

Documentation URL

POST /v4/awsConfigs

Create AWS Config

operation/createAwsConfig

GET /v4/awsConfigs

List AWS configs

operation/listAwsConfigs

PUT /v4/awsConfigs/:id

Update AWS Config

operation/updateAwsConfig

AwsRole

Path

Description

Documentation URL

POST /v4/awsRoles

Create AWS role

operation/createAwsRole

GET /v4/awsRoles

List AWS roles

operation/listAwsRoles

PUT /v4/awsRoles/:id

Update AWS role

operation/updateAwsRole

DELETE /v4/awsRoles/:id

Delete AWS role

operation/deleteAwsRole

Connection

Path

Description

Documentation URL

POST /v4/connections

Create connection

operation/createConnection

GET /v4/connections

List connections

operation/listConnections

GET /v4/connections/count

Count connections

operation/countConnections

GET /v4/connections/:id

Get connection

operation/getConnection

DELETE /v4/connections/:id

Delete connection

operation/deleteConnection

GET /v4/connections/:id/status

Get connection status

operation/getConnectionStatus

ConnectorMetadata

Path

Description

Documentation URL

POST /v4/connectorMetadata/:connector/overrides

Create overrides for connector

operation/updateConnectorOverrides

GET /v4/connectorMetadata/:connector/overrides

Get overrides for connector

operation/getConnectorOverrides

DELETE /v4/connectorMetadata/:connector/overrides

Delete all custom overrides for a connector

operation/deleteConnectorOverrides

GET /v4/connectorMetadata/:connector

Get connector metadata information

operation/getConnectorConfig

GET /v4/connectorMetadata/:connector/defaults

Get default connector metadata information

operation/getConnectorDefaults

EnvironmentParameter

Path

Description

Documentation URL

POST /v4/environmentParameters

Create environment parameter

operation/createEnvironmentParameter

GET /v4/environmentParameters

List environment parameters

operation/listEnvironmentParameters

POST /v4/environmentParameters/package

Import environment parameters package

operation/importEnvironmentParametersPackage

GET /v4/environmentParameters/package

Export environment parameters list

operation/getEnvironmentParametersPackage

GET /v4/environmentParameters/:id

Get environment parameter

operation/getEnvironmentParameter

DELETE /v4/environmentParameters/:id

Delete environment parameter

operation/deleteEnvironmentParameter

Flow

Path

Description

Documentation URL

POST /v4/flows

Create flow

operation/createFlow

GET /v4/flows

List flows

operation/listFlows

POST /v4/flows/package

Import Flow package

operation/importPackage

POST /v4/flows/package/dryRun

Import Flow package - Dry run

operation/importPackageDryRun

POST /v4/flows/:id/copy

Copy Flow

operation/copyFlow

POST /v4/flows/:id/run

Run Flow

operation/runFlow

GET /v4/flows/count

Count flows

operation/countFlows

GET /v4/flows/:id

Get flow

operation/getFlow

PATCH /v4/flows/:id

Patch flow

operation/patchFlow

DELETE /v4/flows/:id

Delete flow

operation/deleteFlow

GET /v4/flows/:id/package

Export flow

operation/getFlowPackage

GET /v4/flows/:id/package/dryRun

Export flow - Dry run

operation/getFlowPackageDryRun

GET /v4/flowsLibrary

Flow Library (list)

operation/listFlowsLibrary

GET /v4/flowsLibrary/count

Flow Library (count)

operation/countFlowsLibrary

GET /v4/flows/:id/inputs

List Flow inputs

operation/getFlowInputs

GET /v4/flows/:id/outputs

List Flow outputs

operation/getFlowOutputs

GET /v4/folders/:id/flows

List flows in folder

operation/getFlowsForFolder

GET /v4/folders/:id/flows/count

Count flows in folder

operation/getFlowCountForFolder

PATCH /v4/flows/:id/replaceDataset

Replace dataset

operation/replaceDatasetInFlow

FlowNode

Path

Description

Documentation URL

POST /v4/flowNodes/:id/commitEdges

Create new edges

operation/commitEdges

FlowNotificationSettings

Path

Description

Documentation URL

POST /v4/flowNotificationSettings

Create flow notification settings

operation/createFlowNotificationSettings

FlowPermission

Path

Description

Documentation URL

POST /v4/flows/:id/permissions

Share Flow

operation/shareFlow

FlowRun

Path

Description

Documentation URL

GET /v4/flowRuns/:id

Get flow run

operation/getFlowRun

GET /v4/flowRuns/:id/status

Get Flow Run Status

operation/getFlowRunStatus

GET /v4/flowRuns/:id/jobGroups

Get JobGroups for Flow Run

operation/getFlowRunJobGroups

FlowRunParameterOverride

Path

Description

Documentation URL

POST /v4/flowRunParameterOverrides

Create flow run parameter override

operation/createFlowRunParameterOverride

GET /v4/flowRunParameterOverrides/:id

Get flow run parameter override

operation/getFlowRunParameterOverride

PATCH /v4/flowRunParameterOverrides/:id

Patch flow run parameter override

operation/patchFlowRunParameterOverride

DELETE /v4/flowRunParameterOverrides/:id

Delete flow run parameter override

operation/deleteFlowRunParameterOverride

Folder

Path

Description

Documentation URL

POST /v4/folders

Create folder

operation/createFolder

GET /v4/folders

List folders

operation/listFolders

GET /v4/folders/count

Count folders

operation/countFolders

GET /v4/folders/:id

Get folder

operation/getFolder

PATCH /v4/folders/:id

Patch folder

operation/patchFolder

DELETE /v4/folders/:id

Delete folder

operation/deleteFolder

ImportedDataset

Path

Description

Documentation URL

POST /v4/importedDatasets

Create imported dataset

operation/createImportedDataset

POST /v4/importedDatasets/:id/addToFlow

Add Imported Dataset to Flow

operation/addImportedDatasetToFlow

POST /v4/importedDatasets/:id/copy

Copy imported dataset

operation/copyDataSource

POST /v4/importedDatasets/:id/asyncRefreshSchema

Fetch and update latest datasource schema

operation/asyncRefreshSchema

GET /v4/importedDatasets/:id

Get imported dataset

operation/getImportedDataset

PUT /v4/importedDatasets/:id

Update imported dataset

operation/updateImportedDataset

PATCH /v4/importedDatasets/:id

Patch imported dataset

operation/patchImportedDataset

DELETE /v4/importedDatasets/:id

Delete imported dataset

operation/deleteImportedDataset

GET /v4/datasetLibrary

List Datasets

operation/listDatasetLibrary

GET /v4/datasetLibrary/count

Count Datasets

operation/countDatasetLibrary

Job

Path

Description

Documentation URL

GET /v4/jobs/:id/status

Get Job Status

operation/getJobStatus

JobGroup

Path

Description

Documentation URL

POST /v4/jobGroups

Run Job Group

operation/runJobGroup

GET /v4/jobGroups

List job groups

operation/listJobGroups

POST /v4/jobGroups/:id/cancel

Cancel Job Group

operation/cancelJobGroup

GET /v4/jobGroups/:id

Get job group

operation/getJobGroup

GET /v4/jobGroups/:id/profile

Get Profile Information for Job Group

operation/getProfilingInformationForJobGroup

GET /v4/jobGroups/:id/profileResults

Get Profile Information for Job Group As a Map

operation/getProfilingInformationForJobGroupConsistent

GET /v4/jobGroups/:id/pdfResults

Get PDF Results for Job Group

operation/getJobGroupPdfResults

GET /v4/jobGroups/:id/status

Get JobGroup Status

operation/getJobGroupStatus

GET /v4/jobGroups/:id/inputs

Get Job Group Inputs

operation/getJobGroupInputs

GET /v4/jobGroups/:id/outputs

Get Job Group Outputs

operation/getJobGroupOutputs

GET /v4/jobLibrary

List Job Groups

operation/listJobLibrary

GET /v4/jobLibrary/count

Count Job Groups

operation/countJobLibrary

GET /v4/jobGroups/:id/jobs

Get Jobs for Job Group

operation/getJobsForJobGroup

GET /v4/jobGroups/:id/publications

Get Publications for Job Group

operation/getPublicationsForJobGroup

Macro

Path

Description

Documentation URL

POST /v4/macros/package

Import Macro Package

operation/importMacroPackage

GET /v4/macros/:id/package

Get Macro Package

operation/getMacroPackage

Misc

Path

Description

Documentation URL

GET /v4/open-api-spec

Get OpenAPI specification

operation/getOpenApiSpec

OutputObject

Path

Description

Documentation URL

POST /v4/outputObjects

Create output object

operation/createOutputObject

GET /v4/outputObjects

List output objects

operation/listOutputObjects

GET /v4/outputObjects/count

Count output objects

operation/countOutputObjects

GET /v4/outputObjects/:id

Get output object

operation/getOutputObject

PATCH /v4/outputObjects/:id

Patch output object

operation/patchOutputObject

DELETE /v4/outputObjects/:id

Delete output object

operation/deleteOutputObject

GET /v4/outputObjects/:id/inputs

List inputs for Output Object

operation/getInputsForOutputObject

Person

Path

Description

Documentation URL

GET /v4/people/current

Get Current Person

operation/getCurrentPerson

GET /v4/people/:id

Get person

operation/getPerson

GET /v4/people

List people

operation/listPerson

Plan

Path

Description

Documentation URL

POST /v4/plans

Create plan

operation/createPlan

GET /v4/plans

List plans

operation/listPlans

POST /v4/plans/:id/run

Run plan

operation/runPlan

POST /v4/plans/:id/permissions

Share Plan

operation/sharePlan

GET /v4/plans/:id/permissions

List permissions for plan

operation/getPlanPermissions

POST /v4/plans/package

Import plan package

operation/importPlanPackage

GET /v4/plans/count

Count plans

operation/countPlans

GET /v4/plans/:id/runParameters

List run parameters

operation/planRunParameters

GET /v4/plans/:id/full

Read plan with all attributes

operation/readFull

GET /v4/plans/:id/schedules

List plan schedules

operation/getSchedulesForPlan

GET /v4/plans/:id/package

Export plan

operation/getPlanPackage

PATCH /v4/plans/:id

Update plan

operation/updatePlan

DELETE /v4/plans/:id

Delete plan

operation/deletePlan

DELETE /v4/plans/:id/permissions/{subjectId}

Delete plan permissions for a user

operation/deletePlanPermissions

PlanNode

Path

Description

Documentation URL

POST /v4/planNodes

Create plan node

operation/createPlanNode

GET /v4/planNodes/:id/runParameters

List run parameters for a plan node

operation/getPlanNodeRunParameters

DELETE /v4/planNodes/:id

Delete plan node

operation/deletePlanNode

PlanOverride

Path

Description

Documentation URL

POST /v4/planOverrides

Override a parameter in a plan

operation/createPlanOverride

PUT /v4/planOverrides/:id

Update the value of a parameter override in a plan

operation/updatePlanOverride

PlanSnapshotRun

Path

Description

Documentation URL

POST /v4/planSnapshotRuns/:id/cancel

Cancel a plan execution

operation/cancelPlanSnapshotRun

GET /v4/planSnapshotRuns

List plan snapshot runs

operation/listPlanSnapshotRuns

GET /v4/planSnapshotRuns/count

Count plan snapshot runs

operation/countPlanSnapshotRuns

GET /v4/planSnapshotRuns/:id

Get plan snapshot run

operation/getPlanSnapshotRun

GET /v4/planSnapshotRuns/:id/schedule

Get schedule for plan run

operation/getScheduleForPlanRun

Publication

Path

Description

Documentation URL

POST /v4/publications

Create publication

operation/createPublication

GET /v4/publications

List publications

operation/listPublications

GET /v4/publications/count

Count publications

operation/countPublications

GET /v4/publications/:id

Get publication

operation/getPublication

PATCH /v4/publications/:id

Patch publication

operation/patchPublication

DELETE /v4/publications/:id

Delete publication

operation/deletePublication

Schedule

Path

Description

Documentation URL

POST /v4/schedules

Create a schedule

operation/createSchedule

GET /v4/schedules

List schedules

operation/listSchedules

POST /v4/schedules/:id/enable

Enable schedule

operation/enableSchedule

POST /v4/schedules/:id/disable

Disable schedule

operation/disableSchedule

GET /v4/schedules/count

Count schedules

operation/countSchedules

GET /v4/schedules/:id

Get schedule

operation/getSchedule

PUT /v4/schedules/:id

Update a schedule

operation/updateSchedule

DELETE /v4/schedules/:id

Delete schedule

operation/deleteSchedule

SqlScript

Path

Description

Documentation URL

POST /v4/sqlScripts

Create sql script

operation/createSqlScript

GET /v4/sqlScripts

List sql scripts

operation/listSqlScripts

GET /v4/sqlScripts/count

Count sql scripts

operation/countSqlScripts

GET /v4/sqlScripts/:id

Get sql script

operation/getSqlScript

PATCH /v4/sqlScripts/:id

Patch sql script

operation/patchSqlScript

DELETE /v4/sqlScripts/:id

Delete sql script

operation/deleteSqlScript

WebhookFlowTask

Path

Description

Documentation URL

POST /v4/webhookFlowTasks

Create webhook

operation/createWebhookFlowTask

POST /v4/webhooks/test

Test webhook settings

operation/testWebhook

GET /v4/webhookFlowTasks/:id

Read webhook

operation/getWebhookFlowTask

DELETE /v4/webhookFlowTasks/:id

Delete webhook

operation/deleteWebhookFlowTask

Workspace

Path

Description

Documentation URL

POST /v4/workspaces/current/delete-configuration

Reset a configuration settings for the current workspace

operation/deleteCurrentWorkspaceConfigurationSettings

POST /v4/workspaces/:id/delete-configuration

Reset a workspace configuration settings

operation/deleteWorkspaceConfigurationSettings

GET /v4/workspaces/current/configuration

Get current workspace configuration

operation/getCurrentConfigurationForWorkspace

PATCH /v4/workspaces/current/configuration

Save current workspace configuration

operation/saveCurrentWorkspaceConfiguration

GET /v4/workspaces/:id/configuration

Get workspace configuration

operation/getConfigurationForWorkspace

PATCH /v4/workspaces/:id/configuration

Save workspace configuration

operation/saveWorkspaceConfiguration

GET /v4/workspaces/:id/configuration-schema

Get configuration schema

operation/getConfigurationSchema

GET /v4/workspaces/current/configuration-schema

Get current configuration schema

operation/getCurrentConfigurationSchema

PATCH /v4/workspaces/current/transfer

Transfer User Assets

operation/transferUserAssetsInCurrentWorkspace

WrangledDataset

Path

Description

Documentation URL

POST /v4/wrangledDatasets

Create wrangled dataset

operation/createWrangledDataset

GET /v4/wrangledDatasets

List wrangled datasets

operation/listWrangledDatasets

POST /v4/wrangledDatasets/:id/addToFlow

Add wrangled dataset to flow

operation/addWrangledDatasetToFlow

GET /v4/wrangledDatasets/count

Count wrangled datasets

operation/countWrangledDatasets

GET /v4/wrangledDatasets/:id

Get wrangled dataset

operation/getWrangledDataset

PATCH /v4/wrangledDatasets/:id

Patch Wrangled Dataset

operation/patchWrangledDataset

DELETE /v4/wrangledDatasets/:id

Delete wrangled dataset

operation/deleteWrangledDataset

GET /v4/wrangledDatasets/:id/primaryInputDataset

Get Input Dataset

operation/getInputDataset

PUT /v4/wrangledDatasets/:id/primaryInputDataset

Swap Input Dataset

operation/updateInputDataset

WriteSetting

Path

Description

Documentation URL

POST /v4/writeSettings

Create writesetting

operation/createWriteSetting

GET /v4/writeSettings

List write settings

operation/listWriteSettings

GET /v4/writeSettings/count

Count write settings

operation/countWriteSettings

GET /v4/writeSettings/:id

Get write setting

operation/getWriteSetting

PATCH /v4/writeSettings/:id

Patch write setting

operation/patchWriteSetting

DELETE /v4/writeSettings/:id

Delete write setting

operation/deleteWriteSetting