Skip to main content

API Endpoints for Designer Cloud Powered by Trifacta Enterprise

The following endpoints are available for Designer Cloud Powered by Trifacta Enterprise Edition.

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

ApiAccessToken

Path

Description

Documentation URL

POST /v4/apiAccessTokens

Create api access token

https://api.trifacta.com/ee/9.7/index.html#operation/createApiAccessToken

GET /v4/apiAccessTokens

List api access tokens

https://api.trifacta.com/ee/9.7/index.html#operation/listApiAccessTokens

GET /v4/apiAccessTokens/:tokenId

Get api access token

https://api.trifacta.com/ee/9.7/index.html#operation/getApiAccessToken

DELETE /v4/apiAccessTokens/:tokenId

Delete api access token

https://api.trifacta.com/ee/9.7/index.html#operation/deleteApiAccessToken

AwsConfig

Path

Description

Documentation URL

POST /v4/awsConfigs

Create AWS Config

https://api.trifacta.com/ee/9.7/index.html#operation/createAwsConfig

GET /v4/awsConfigs

List AWS configs

https://api.trifacta.com/ee/9.7/index.html#operation/listAwsConfigs

PUT /v4/awsConfigs/:id

Update AWS Config

https://api.trifacta.com/ee/9.7/index.html#operation/updateAwsConfig

AwsRole

Connection

Path

Description

Documentation URL

POST /v4/connections

Create connection

https://api.trifacta.com/ee/9.7/index.html#operation/createConnection

GET /v4/connections

List connections

https://api.trifacta.com/ee/9.7/index.html#operation/listConnections

GET /v4/connections/count

Count connections

https://api.trifacta.com/ee/9.7/index.html#operation/countConnections

GET /v4/connections/:id

Get connection

https://api.trifacta.com/ee/9.7/index.html#operation/getConnection

DELETE /v4/connections/:id

Delete connection

https://api.trifacta.com/ee/9.7/index.html#operation/deleteConnection

GET /v4/connections/:id/status

Get connection status

https://api.trifacta.com/ee/9.7/index.html#operation/getConnectionStatus

ConnectorMetadata

Path

Description

Documentation URL

POST /v4/connectorMetadata/:connector/overrides

Create overrides for connector

https://api.trifacta.com/ee/9.7/index.html#operation/updateConnectorOverrides

GET /v4/connectorMetadata/:connector/overrides

Get overrides for connector

https://api.trifacta.com/ee/9.7/index.html#operation/getConnectorOverrides

DELETE /v4/connectorMetadata/:connector/overrides

Delete all custom overrides for a connector

https://api.trifacta.com/ee/9.7/index.html#operation/deleteConnectorOverrides

GET /v4/connectorMetadata/:connector

Get connector metadata information

https://api.trifacta.com/ee/9.7/index.html#operation/getConnectorConfig

GET /v4/connectorMetadata/:connector/defaults

Get default connector metadata information

https://api.trifacta.com/ee/9.7/index.html#operation/getConnectorDefaults

EnvironmentParameter

Path

Description

Documentation URL

POST /v4/environmentParameters

Create environment parameter

https://api.trifacta.com/ee/9.7/index.html#operation/createEnvironmentParameter

GET /v4/environmentParameters

List environment parameters

https://api.trifacta.com/ee/9.7/index.html#operation/listEnvironmentParameters

POST /v4/environmentParameters/package

Import environment parameters package

https://api.trifacta.com/ee/9.7/index.html#operation/importEnvironmentParametersPackage

GET /v4/environmentParameters/package

Export environment parameters list

https://api.trifacta.com/ee/9.7/index.html#operation/getEnvironmentParametersPackage

GET /v4/environmentParameters/:id

Get environment parameter

https://api.trifacta.com/ee/9.7/index.html#operation/getEnvironmentParameter

DELETE /v4/environmentParameters/:id

Delete environment parameter

https://api.trifacta.com/ee/9.7/index.html#operation/deleteEnvironmentParameter

Flow

Path

Description

Documentation URL

POST /v4/flows

Create flow

https://api.trifacta.com/ee/9.7/index.html#operation/createFlow

GET /v4/flows

List flows

https://api.trifacta.com/ee/9.7/index.html#operation/listFlows

POST /v4/flows/package

Import Flow package

https://api.trifacta.com/ee/9.7/index.html#operation/importPackage

POST /v4/flows/package/dryRun

Import Flow package - Dry run

https://api.trifacta.com/ee/9.7/index.html#operation/importPackageDryRun

POST /v4/flows/:id/copy

Copy Flow

https://api.trifacta.com/ee/9.7/index.html#operation/copyFlow

POST /v4/flows/:id/run

Run Flow

https://api.trifacta.com/ee/9.7/index.html#operation/runFlow

GET /v4/flows/count

Count flows

https://api.trifacta.com/ee/9.7/index.html#operation/countFlows

GET /v4/flows/:id

Get flow

https://api.trifacta.com/ee/9.7/index.html#operation/getFlow

PATCH /v4/flows/:id

Patch flow

https://api.trifacta.com/ee/9.7/index.html#operation/patchFlow

DELETE /v4/flows/:id

Delete flow

https://api.trifacta.com/ee/9.7/index.html#operation/deleteFlow

GET /v4/flows/:id/package

Export flow

https://api.trifacta.com/ee/9.7/index.html#operation/getFlowPackage

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

Export flow - Dry run

https://api.trifacta.com/ee/9.7/index.html#operation/getFlowPackageDryRun

GET /v4/flowsLibrary

Flow Library (list)

https://api.trifacta.com/ee/9.7/index.html#operation/listFlowsLibrary

GET /v4/flowsLibrary/count

Flow Library (count)

https://api.trifacta.com/ee/9.7/index.html#operation/countFlowsLibrary

GET /v4/flows/:id/inputs

List Flow inputs

https://api.trifacta.com/ee/9.7/index.html#operation/getFlowInputs

GET /v4/flows/:id/outputs

List Flow outputs

https://api.trifacta.com/ee/9.7/index.html#operation/getFlowOutputs

GET /v4/folders/:id/flows

List flows in folder

https://api.trifacta.com/ee/9.7/index.html#operation/getFlowsForFolder

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

Count flows in folder

https://api.trifacta.com/ee/9.7/index.html#operation/getFlowCountForFolder

PATCH /v4/flows/:id/replaceDataset

Replace dataset

https://api.trifacta.com/ee/9.7/index.html#operation/replaceDatasetInFlow

FlowNode

Path

Description

Documentation URL

POST /v4/flowNodes/:id/commitEdges

Create new edges

https://api.trifacta.com/ee/9.7/index.html#operation/commitEdges

FlowNotificationSettings

Path

Description

Documentation URL

POST /v4/flowNotificationSettings

Create flow notification settings

https://api.trifacta.com/ee/9.7/index.html#operation/createFlowNotificationSettings

FlowPermission

Path

Description

Documentation URL

POST /v4/flows/:id/permissions

Share Flow

https://api.trifacta.com/ee/9.7/index.html#operation/shareFlow

FlowRun

Path

Description

Documentation URL

GET /v4/flowRuns/:id

Get flow run

https://api.trifacta.com/ee/9.7/index.html#operation/getFlowRun

GET /v4/flowRuns/:id/status

Get Flow Run Status

https://api.trifacta.com/ee/9.7/index.html#operation/getFlowRunStatus

GET /v4/flowRuns/:id/jobGroups

Get JobGroups for Flow Run

https://api.trifacta.com/ee/9.7/index.html#operation/getFlowRunJobGroups

FlowRunParameterOverride

Path

Description

Documentation URL

POST /v4/flowRunParameterOverrides

Create flow run parameter override

https://api.trifacta.com/ee/9.7/index.html#operation/createFlowRunParameterOverride

GET /v4/flowRunParameterOverrides/:id

Get flow run parameter override

https://api.trifacta.com/ee/9.7/index.html#operation/getFlowRunParameterOverride

PATCH /v4/flowRunParameterOverrides/:id

Patch flow run parameter override

https://api.trifacta.com/ee/9.7/index.html#operation/patchFlowRunParameterOverride

DELETE /v4/flowRunParameterOverrides/:id

Delete flow run parameter override

https://api.trifacta.com/ee/9.7/index.html#operation/deleteFlowRunParameterOverride

Folder

ImportedDataset

Path

Description

Documentation URL

POST /v4/importedDatasets

Create imported dataset

https://api.trifacta.com/ee/9.7/index.html#operation/createImportedDataset

POST /v4/importedDatasets/:id/addToFlow

Add Imported Dataset to Flow

https://api.trifacta.com/ee/9.7/index.html#operation/addImportedDatasetToFlow

POST /v4/importedDatasets/:id/copy

Copy imported dataset

https://api.trifacta.com/ee/9.7/index.html#operation/copyDataSource

POST /v4/importedDatasets/:id/asyncRefreshSchema

Fetch and update latest datasource schema

https://api.trifacta.com/ee/9.7/index.html#operation/asyncRefreshSchema

GET /v4/importedDatasets/:id

Get imported dataset

https://api.trifacta.com/ee/9.7/index.html#operation/getImportedDataset

PUT /v4/importedDatasets/:id

Update imported dataset

https://api.trifacta.com/ee/9.7/index.html#operation/updateImportedDataset

PATCH /v4/importedDatasets/:id

Patch imported dataset

https://api.trifacta.com/ee/9.7/index.html#operation/patchImportedDataset

DELETE /v4/importedDatasets/:id

Delete imported dataset

https://api.trifacta.com/ee/9.7/index.html#operation/deleteImportedDataset

GET /v4/datasetLibrary

List Datasets

https://api.trifacta.com/ee/9.7/index.html#operation/listDatasetLibrary

GET /v4/datasetLibrary/count

Count Datasets

https://api.trifacta.com/ee/9.7/index.html#operation/countDatasetLibrary

Job

Path

Description

Documentation URL

GET /v4/jobs/:id/status

Get Job Status

https://api.trifacta.com/ee/9.7/index.html#operation/getJobStatus

JobGroup

Path

Description

Documentation URL

POST /v4/jobGroups

Run Job Group

https://api.trifacta.com/ee/9.7/index.html#operation/runJobGroup

GET /v4/jobGroups

List job groups

https://api.trifacta.com/ee/9.7/index.html#operation/listJobGroups

POST /v4/jobGroups/:id/cancel

Cancel Job Group

https://api.trifacta.com/ee/9.7/index.html#operation/cancelJobGroup

GET /v4/jobGroups/:id

Get job group

https://api.trifacta.com/ee/9.7/index.html#operation/getJobGroup

GET /v4/jobGroups/:id/profile

Get Profile Information for Job Group

https://api.trifacta.com/ee/9.7/index.html#operation/getProfilingInformationForJobGroup

GET /v4/jobGroups/:id/profileResults

Get Profile Information for Job Group As a Map

https://api.trifacta.com/ee/9.7/index.html#operation/getProfilingInformationForJobGroupConsistent

GET /v4/jobGroups/:id/pdfResults

Get PDF Results for Job Group

https://api.trifacta.com/ee/9.7/index.html#operation/getJobGroupPdfResults

GET /v4/jobGroups/:id/status

Get JobGroup Status

https://api.trifacta.com/ee/9.7/index.html#operation/getJobGroupStatus

GET /v4/jobGroups/:id/inputs

Get Job Group Inputs

https://api.trifacta.com/ee/9.7/index.html#operation/getJobGroupInputs

GET /v4/jobGroups/:id/outputs

Get Job Group Outputs

https://api.trifacta.com/ee/9.7/index.html#operation/getJobGroupOutputs

GET /v4/jobLibrary

List Job Groups

https://api.trifacta.com/ee/9.7/index.html#operation/listJobLibrary

GET /v4/jobLibrary/count

Count Job Groups

https://api.trifacta.com/ee/9.7/index.html#operation/countJobLibrary

GET /v4/jobGroups/:id/jobs

Get Jobs for Job Group

https://api.trifacta.com/ee/9.7/index.html#operation/getJobsForJobGroup

GET /v4/jobGroups/:id/publications

Get Publications for Job Group

https://api.trifacta.com/ee/9.7/index.html#operation/getPublicationsForJobGroup

Macro

Path

Description

Documentation URL

POST /v4/macros/package

Import Macro Package

https://api.trifacta.com/ee/9.7/index.html#operation/importMacroPackage

GET /v4/macros/:id/package

Get Macro Package

https://api.trifacta.com/ee/9.7/index.html#operation/getMacroPackage

Misc

Path

Description

Documentation URL

GET /v4/open-api-spec

Get OpenAPI specification

https://api.trifacta.com/ee/9.7/index.html#operation/getOpenApiSpec

OutputObject

Path

Description

Documentation URL

POST /v4/outputObjects

Create output object

https://api.trifacta.com/ee/9.7/index.html#operation/createOutputObject

GET /v4/outputObjects

List output objects

https://api.trifacta.com/ee/9.7/index.html#operation/listOutputObjects

POST /v4/outputObjects/:id/wrangleToPython

Generate python script for wrangle recipe linked to an output object

https://api.trifacta.com/ee/9.7/index.html#operation/getPythonScriptForOutputObjectInput

GET /v4/outputObjects/count

Count output objects

https://api.trifacta.com/ee/9.7/index.html#operation/countOutputObjects

GET /v4/outputObjects/:id

Get output object

https://api.trifacta.com/ee/9.7/index.html#operation/getOutputObject

PATCH /v4/outputObjects/:id

Patch output object

https://api.trifacta.com/ee/9.7/index.html#operation/patchOutputObject

DELETE /v4/outputObjects/:id

Delete output object

https://api.trifacta.com/ee/9.7/index.html#operation/deleteOutputObject

GET /v4/outputObjects/:id/inputs

List inputs for Output Object

https://api.trifacta.com/ee/9.7/index.html#operation/getInputsForOutputObject

Person

Plan

Path

Description

Documentation URL

POST /v4/plans

Create plan

https://api.trifacta.com/ee/9.7/index.html#operation/createPlan

GET /v4/plans

List plans

https://api.trifacta.com/ee/9.7/index.html#operation/listPlans

POST /v4/plans/:id/run

Run plan

https://api.trifacta.com/ee/9.7/index.html#operation/runPlan

POST /v4/plans/:id/permissions

Share Plan

https://api.trifacta.com/ee/9.7/index.html#operation/sharePlan

GET /v4/plans/:id/permissions

List permissions for plan

https://api.trifacta.com/ee/9.7/index.html#operation/getPlanPermissions

POST /v4/plans/package

Import plan package

https://api.trifacta.com/ee/9.7/index.html#operation/importPlanPackage

GET /v4/plans/count

Count plans

https://api.trifacta.com/ee/9.7/index.html#operation/countPlans

GET /v4/plans/:id/runParameters

List run parameters

https://api.trifacta.com/ee/9.7/index.html#operation/planRunParameters

GET /v4/plans/:id/full

Read plan with all attributes

https://api.trifacta.com/ee/9.7/index.html#operation/readFull

GET /v4/plans/:id/schedules

List plan schedules

https://api.trifacta.com/ee/9.7/index.html#operation/getSchedulesForPlan

GET /v4/plans/:id/package

Export plan

https://api.trifacta.com/ee/9.7/index.html#operation/getPlanPackage

PATCH /v4/plans/:id

Update plan

https://api.trifacta.com/ee/9.7/index.html#operation/updatePlan

DELETE /v4/plans/:id

Delete plan

https://api.trifacta.com/ee/9.7/index.html#operation/deletePlan

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

Delete plan permissions for a user

https://api.trifacta.com/ee/9.7/index.html#operation/deletePlanPermissions

PlanNode

Path

Description

Documentation URL

POST /v4/planNodes

Create plan node

https://api.trifacta.com/ee/9.7/index.html#operation/createPlanNode

GET /v4/planNodes/:id/runParameters

List run parameters for a plan node

https://api.trifacta.com/ee/9.7/index.html#operation/getPlanNodeRunParameters

DELETE /v4/planNodes/:id

Delete plan node

https://api.trifacta.com/ee/9.7/index.html#operation/deletePlanNode

PlanOverride

Path

Description

Documentation URL

POST /v4/planOverrides

Override a parameter in a plan

https://api.trifacta.com/ee/9.7/index.html#operation/createPlanOverride

PUT /v4/planOverrides/:id

Update the value of a parameter override in a plan

https://api.trifacta.com/ee/9.7/index.html#operation/updatePlanOverride

PlanSnapshotRun

Path

Description

Documentation URL

POST /v4/planSnapshotRuns/:id/cancel

Cancel a plan execution

https://api.trifacta.com/ee/9.7/index.html#operation/cancelPlanSnapshotRun

GET /v4/planSnapshotRuns

List plan snapshot runs

https://api.trifacta.com/ee/9.7/index.html#operation/listPlanSnapshotRuns

GET /v4/planSnapshotRuns/count

Count plan snapshot runs

https://api.trifacta.com/ee/9.7/index.html#operation/countPlanSnapshotRuns

GET /v4/planSnapshotRuns/:id

Get plan snapshot run

https://api.trifacta.com/ee/9.7/index.html#operation/getPlanSnapshotRun

GET /v4/planSnapshotRuns/:id/schedule

Get schedule for plan run

https://api.trifacta.com/ee/9.7/index.html#operation/getScheduleForPlanRun

Publication

Path

Description

Documentation URL

POST /v4/publications

Create publication

https://api.trifacta.com/ee/9.7/index.html#operation/createPublication

GET /v4/publications

List publications

https://api.trifacta.com/ee/9.7/index.html#operation/listPublications

GET /v4/publications/count

Count publications

https://api.trifacta.com/ee/9.7/index.html#operation/countPublications

GET /v4/publications/:id

Get publication

https://api.trifacta.com/ee/9.7/index.html#operation/getPublication

PATCH /v4/publications/:id

Patch publication

https://api.trifacta.com/ee/9.7/index.html#operation/patchPublication

DELETE /v4/publications/:id

Delete publication

https://api.trifacta.com/ee/9.7/index.html#operation/deletePublication

Schedule

SqlScript

WebhookFlowTask

Path

Description

Documentation URL

POST /v4/webhookFlowTasks

Create webhook

https://api.trifacta.com/ee/9.7/index.html#operation/createWebhookFlowTask

POST /v4/webhooks/test

Test webhook settings

https://api.trifacta.com/ee/9.7/index.html#operation/testWebhook

GET /v4/webhookFlowTasks/:id

Read webhook

https://api.trifacta.com/ee/9.7/index.html#operation/getWebhookFlowTask

DELETE /v4/webhookFlowTasks/:id

Delete webhook

https://api.trifacta.com/ee/9.7/index.html#operation/deleteWebhookFlowTask

Workspace

Path

Description

Documentation URL

POST /v4/workspaces/current/delete-configuration

Reset a configuration settings for the current workspace

https://api.trifacta.com/ee/9.7/index.html#operation/deleteCurrentWorkspaceConfigurationSettings

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

Reset a workspace configuration settings

https://api.trifacta.com/ee/9.7/index.html#operation/deleteWorkspaceConfigurationSettings

GET /v4/workspaces/current/configuration

Get current workspace configuration

https://api.trifacta.com/ee/9.7/index.html#operation/getCurrentConfigurationForWorkspace

PATCH /v4/workspaces/current/configuration

Save current workspace configuration

https://api.trifacta.com/ee/9.7/index.html#operation/saveCurrentWorkspaceConfiguration

GET /v4/workspaces/:id/configuration

Get workspace configuration

https://api.trifacta.com/ee/9.7/index.html#operation/getConfigurationForWorkspace

PATCH /v4/workspaces/:id/configuration

Save workspace configuration

https://api.trifacta.com/ee/9.7/index.html#operation/saveWorkspaceConfiguration

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

Get configuration schema

https://api.trifacta.com/ee/9.7/index.html#operation/getConfigurationSchema

GET /v4/workspaces/current/configuration-schema

Get current configuration schema

https://api.trifacta.com/ee/9.7/index.html#operation/getCurrentConfigurationSchema

PATCH /v4/workspaces/current/transfer

Transfer User Assets

https://api.trifacta.com/ee/9.7/index.html#operation/transferUserAssetsInCurrentWorkspace

WrangledDataset

Path

Description

Documentation URL

POST /v4/wrangledDatasets

Create wrangled dataset

https://api.trifacta.com/ee/9.7/index.html#operation/createWrangledDataset

GET /v4/wrangledDatasets

List wrangled datasets

https://api.trifacta.com/ee/9.7/index.html#operation/listWrangledDatasets

POST /v4/wrangledDatasets/:id/addToFlow

Add wrangled dataset to flow

https://api.trifacta.com/ee/9.7/index.html#operation/addWrangledDatasetToFlow

GET /v4/wrangledDatasets/count

Count wrangled datasets

https://api.trifacta.com/ee/9.7/index.html#operation/countWrangledDatasets

GET /v4/wrangledDatasets/:id

Get wrangled dataset

https://api.trifacta.com/ee/9.7/index.html#operation/getWrangledDataset

PATCH /v4/wrangledDatasets/:id

Patch Wrangled Dataset

https://api.trifacta.com/ee/9.7/index.html#operation/patchWrangledDataset

DELETE /v4/wrangledDatasets/:id

Delete wrangled dataset

https://api.trifacta.com/ee/9.7/index.html#operation/deleteWrangledDataset

GET /v4/wrangledDatasets/:id/primaryInputDataset

Get Input Dataset

https://api.trifacta.com/ee/9.7/index.html#operation/getInputDataset

PUT /v4/wrangledDatasets/:id/primaryInputDataset

Swap Input Dataset

https://api.trifacta.com/ee/9.7/index.html#operation/updateInputDataset

WriteSetting

Path

Description

Documentation URL

POST /v4/writeSettings

Create writesetting

https://api.trifacta.com/ee/9.7/index.html#operation/createWriteSetting

GET /v4/writeSettings

List write settings

https://api.trifacta.com/ee/9.7/index.html#operation/listWriteSettings

GET /v4/writeSettings/count

Count write settings

https://api.trifacta.com/ee/9.7/index.html#operation/countWriteSettings

GET /v4/writeSettings/:id

Get write setting

https://api.trifacta.com/ee/9.7/index.html#operation/getWriteSetting

PATCH /v4/writeSettings/:id

Patch write setting

https://api.trifacta.com/ee/9.7/index.html#operation/patchWriteSetting

DELETE /v4/writeSettings/:id

Delete write setting

https://api.trifacta.com/ee/9.7/index.html#operation/deleteWriteSetting