API Endpoints for Dataprep Premium

POST /v4/connections

Create connection

GET /v4/connections

List connections

GET /v4/connections/count

Count connections

GET /v4/connections/:id

Get connection

DELETE /v4/connections/:id

Delete connection

GET /v4/connections/:id/status

Get connection status

POST /v4/connectorMetadata/:connector/overrides

Create overrides for connector

GET /v4/connectorMetadata/:connector/overrides

Get overrides for connector

DELETE /v4/connectorMetadata/:connector/overrides

Delete all custom overrides for a connector

GET /v4/connectorMetadata/:connector

Get connector metadata information

GET /v4/connectorMetadata/:connector/defaults

Get default connector metadata information

POST /v4/environmentParameters

Create environment parameter

GET /v4/environmentParameters

List environment parameters

POST /v4/environmentParameters/package

Import environment parameters package

GET /v4/environmentParameters/package

Export environment parameters list

GET /v4/environmentParameters/:id

Get environment parameter

DELETE /v4/environmentParameters/:id

Delete environment parameter

POST /v4/flows

Create flow

GET /v4/flows

List flows

POST /v4/flows/package

Import Flow package

POST /v4/flows/package/dryRun

Import Flow package - Dry run

POST /v4/flows/:id/copy

Copy Flow

POST /v4/flows/:id/run

Run Flow

GET /v4/flows/count

Count flows

GET /v4/flows/:id

Get flow

PATCH /v4/flows/:id

Patch flow

DELETE /v4/flows/:id

Delete flow

GET /v4/flows/:id/package

Export flow

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

Export flow - Dry run

GET /v4/flowsLibrary

Flow Library (list)

GET /v4/flowsLibrary/count

Flow Library (count)

GET /v4/flows/:id/inputs

List Flow inputs

GET /v4/flows/:id/outputs

List Flow outputs

GET /v4/folders/:id/flows

List flows in folder

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

Count flows in folder

PATCH /v4/flows/:id/replaceDataset

Replace dataset

POST /v4/flowNodes/:id/commitEdges

Create new edges

POST /v4/flowNotificationSettings

Create flow notification settings

POST /v4/flows/:id/permissions

Share Flow

GET /v4/flowRuns/:id

Get flow run

GET /v4/flowRuns/:id/status

Get Flow Run Status

GET /v4/flowRuns/:id/jobGroups

Get JobGroups for Flow Run

POST /v4/flowRunParameterOverrides

Create flow run parameter override

GET /v4/flowRunParameterOverrides/:id

Get flow run parameter override

PATCH /v4/flowRunParameterOverrides/:id

Patch flow run parameter override

DELETE /v4/flowRunParameterOverrides/:id

Delete flow run parameter override

POST /v4/folders

Create folder

GET /v4/folders

List folders

GET /v4/folders/count

Count folders

GET /v4/folders/:id

Get folder

PATCH /v4/folders/:id

Patch folder

DELETE /v4/folders/:id

Delete folder

POST /v4/importedDatasets

Create imported dataset

POST /v4/importedDatasets/:id/addToFlow

Add Imported Dataset to Flow

POST /v4/importedDatasets/:id/copy

Copy imported dataset

POST /v4/importedDatasets/:id/asyncRefreshSchema

Fetch and update latest datasource schema

GET /v4/importedDatasets/:id

Get imported dataset

PUT /v4/importedDatasets/:id

Update imported dataset

PATCH /v4/importedDatasets/:id

Patch imported dataset

DELETE /v4/importedDatasets/:id

Delete imported dataset

GET /v4/datasetLibrary

List Datasets

GET /v4/datasetLibrary/count

Count Datasets

GET /v4/jobs/:id/status

Get Job Status

POST /v4/jobGroups

Run Job Group

GET /v4/jobGroups

List job groups

GET /v4/jobGroups/:id

Get job group

GET /v4/jobGroups/:id/profile

Get Profile Information for Job Group

GET /v4/jobGroups/:id/profileResults

Get Profile Information for Job Group As a Map

GET /v4/jobGroups/:id/pdfResults

Get PDF Results for Job Group

GET /v4/jobGroups/:id/status

Get JobGroup Status

GET /v4/jobGroups/:id/inputs

Get Job Group Inputs

GET /v4/jobGroups/:id/outputs

Get Job Group Outputs

GET /v4/jobLibrary

List Job Groups

GET /v4/jobLibrary/count

Count Job Groups

GET /v4/jobGroups/:id/jobs

Get Jobs for Job Group

GET /v4/jobGroups/:id/publications

Get Publications for Job Group

POST /v4/macros/package

Import Macro Package

GET /v4/macros/:id/package

Get Macro Package

GET /v4/open-api-spec

Get OpenAPI specification

POST /v4/outputObjects

Create output object

GET /v4/outputObjects

List output objects

GET /v4/outputObjects/count

Count output objects

GET /v4/outputObjects/:id

Get output object

PATCH /v4/outputObjects/:id

Patch output object

DELETE /v4/outputObjects/:id

Delete output object

GET /v4/outputObjects/:id/inputs

List inputs for Output Object

POST /v4/people/dataflowOptions/:type

Set Dataflow option for self

POST /v4/people/current/dataflowOptions/:type

Set Dataflow option for self

POST /v4/people/:email/dataflowOptions/

Set Dataflow option for another person

POST /v4/plans

Create plan

GET /v4/plans

List plans

POST /v4/plans/:id/run

Run plan

POST /v4/plans/:id/permissions

Share Plan

GET /v4/plans/:id/permissions

List permissions for plan

POST /v4/plans/package

Import plan package

GET /v4/plans/count

Count plans

GET /v4/plans/:id/runParameters

List run parameters

GET /v4/plans/:id/full

Read plan with all attributes

GET /v4/plans/:id/schedules

List plan schedules

GET /v4/plans/:id/package

Export plan

PATCH /v4/plans/:id

Update plan

DELETE /v4/plans/:id

Delete plan

DELETE /v4/plans/:id/permissions/

Delete plan permissions for a user

POST /v4/planNodes

Create plan node

GET /v4/planNodes/:id/runParameters

List run parameters for a plan node

DELETE /v4/planNodes/:id

Delete plan node

POST /v4/planOverrides

Override a parameter in a plan

PUT /v4/planOverrides/:id

Update the value of a parameter override in a plan

POST /v4/planSnapshotRuns/:id/cancel

Cancel a plan execution

GET /v4/planSnapshotRuns

List plan snapshot runs

GET /v4/planSnapshotRuns/count

Count plan snapshot runs

GET /v4/planSnapshotRuns/:id

Get plan snapshot run

GET /v4/planSnapshotRuns/:id/schedule

Get schedule for plan run

POST /v4/publications

Create publication

GET /v4/publications

List publications

GET /v4/publications/count

Count publications

GET /v4/publications/:id

Get publication

PATCH /v4/publications/:id

Patch publication

DELETE /v4/publications/:id

Delete publication

POST /v4/schedules

Create a schedule

GET /v4/schedules

List schedules

POST /v4/schedules/:id/enable

Enable schedule

POST /v4/schedules/:id/disable

Disable schedule

GET /v4/schedules/count

Count schedules

GET /v4/schedules/:id

Get schedule

PUT /v4/schedules/:id

Update a schedule

DELETE /v4/schedules/:id

Delete schedule

POST /v4/sqlScripts

Create sql script

GET /v4/sqlScripts

List sql scripts

GET /v4/sqlScripts/count

Count sql scripts

GET /v4/sqlScripts/:id

Get sql script

PATCH /v4/sqlScripts/:id

Patch sql script

DELETE /v4/sqlScripts/:id

Delete sql script

GET /v4/usages/jobMetrics/detailedReport/compute/from/:from/to/:to

Get the Usage Detailed Report for the specified period

GET /v4/userDefinedFunctions

List user defined functions

GET /v4/userDefinedFunctions/:id

Get user defined function

DELETE /v4/userDefinedFunctions/:id

Delete user defined function

GET /v4/userDefinedFunctions/count

Count user defined functions

GET /v4/userDefinedFunctions/:id/recipes

Get list of recipes using this UDF

GET /v4/userDefinedFunctions/:id/usageCount

Get count of all flows and recipes using this UDF

POST /v4/webhookFlowTasks

Create webhook

POST /v4/webhooks/test

Test webhook settings

GET /v4/webhookFlowTasks/:id

Read webhook

DELETE /v4/webhookFlowTasks/:id

Delete webhook

POST /v4/workspaces/current/delete-configuration

Reset a configuration settings for the current workspace

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

Reset a workspace configuration settings

GET /v4/workspaces/current/configuration

Get current workspace configuration

PATCH /v4/workspaces/current/configuration

Save current workspace configuration

GET /v4/workspaces/:id/configuration

Get workspace configuration

PATCH /v4/workspaces/:id/configuration

Save workspace configuration

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

Get configuration schema

GET /v4/workspaces/current/configuration-schema

Get current configuration schema

PATCH /v4/workspaces/current/transfer

Transfer User Assets

POST /v4/wrangledDatasets

Create wrangled dataset

GET /v4/wrangledDatasets

List wrangled datasets

POST /v4/wrangledDatasets/:id/addToFlow

Add wrangled dataset to flow

GET /v4/wrangledDatasets/count

Count wrangled datasets

GET /v4/wrangledDatasets/:id

Get wrangled dataset

PATCH /v4/wrangledDatasets/:id

Patch Wrangled Dataset

DELETE /v4/wrangledDatasets/:id

Delete wrangled dataset

GET /v4/wrangledDatasets/:id/primaryInputDataset

Get Input Dataset

PUT /v4/wrangledDatasets/:id/primaryInputDataset

Swap Input Dataset

POST /v4/writeSettings

Create writesetting

GET /v4/writeSettings

List write settings

GET /v4/writeSettings/count

Count write settings

GET /v4/writeSettings/:id

Get write setting

PATCH /v4/writeSettings/:id

Patch write setting

DELETE /v4/writeSettings/:id

Delete write setting