The following endpoints are available for Trifacta® Self-Managed Enterprise Edition.
To access the reference documentation for each available API endpoint and method, select Help menu > API Documentation in the Trifacta application.
ApiAccessToken
Path |
Description |
Documentation URL |
---|---|---|
POST /v4/apiAccessTokens |
Create api access token |
https://api.trifacta.com/ee/8.2/index.html#operation/createApiAccessToken |
GET /v4/apiAccessTokens |
List api access tokens |
https://api.trifacta.com/ee/8.2/index.html#operation/listApiAccessTokens |
GET /v4/apiAccessTokens/:tokenId |
Get api access token |
https://api.trifacta.com/ee/8.2/index.html#operation/getApiAccessToken |
DELETE /v4/apiAccessTokens/:tokenId |
Delete api access token |
https://api.trifacta.com/ee/8.2/index.html#operation/deleteApiAccessToken |
AwsConfig
Path |
Description |
Documentation URL |
---|---|---|
POST /v4/awsConfigs |
Create AWS Config |
https://api.trifacta.com/ee/8.2/index.html#operation/createAwsConfig |
GET /v4/awsConfigs |
List AWS configs |
https://api.trifacta.com/ee/8.2/index.html#operation/listAwsConfigs |
PUT /v4/awsConfigs/:id |
Update AWS Config |
https://api.trifacta.com/ee/8.2/index.html#operation/updateAwsConfig |
PATCH /v4/awsConfigs/:id |
Update AWS Config |
https://api.trifacta.com/ee/8.2/index.html#operation/patchAwsConfig |
AwsRole
Path |
Description |
Documentation URL |
---|---|---|
POST /v4/awsRoles |
Create AWS role |
https://api.trifacta.com/ee/8.2/index.html#operation/createAwsRole |
GET /v4/awsRoles |
List AWS roles |
https://api.trifacta.com/ee/8.2/index.html#operation/listAwsRoles |
PUT /v4/awsRoles/:id |
Update AWS role |
https://api.trifacta.com/ee/8.2/index.html#operation/updateAwsRole |
DELETE /v4/awsRoles/:id |
Delete AWS role |
https://api.trifacta.com/ee/8.2/index.html#operation/deleteAwsRole |
Connection
ConnectionPermission
Path |
Description |
Documentation URL |
|||
---|---|---|---|---|---|
POST /v4/connections/:id/permissions |
Create connection permission |
https://api.trifacta.com/ee/8.2/index.html#operation/createConnectionPermission | |||
GET /v4/connections/:id/permissions |
Get connection permissions |
https://api.trifacta.com/ee/8.2/index.html#operation/getConnectionPermissions | |||
GET /v4/connections/:id/permissions/ Unknown macro: {aid}
|
Delete connection permission |
https://api.trifacta.com/ee/8.2/index.html#operation/deleteConnectionPermission |
ConnectorMetadata
Path |
Description |
Documentation URL |
---|---|---|
POST /v4/connectorMetadata/:connector/overrides |
Create overrides for connector |
https://api.trifacta.com/ee/8.2/index.html#operation/updateConnectorOverrides |
GET /v4/connectorMetadata/:connector/overrides |
Get overrides for connector |
https://api.trifacta.com/ee/8.2/index.html#operation/getConnectorOverrides |
DELETE /v4/connectorMetadata/:connector/overrides |
Delete all custom overrides for a connector |
https://api.trifacta.com/ee/8.2/index.html#operation/deleteConnectorOverrides |
GET /v4/connectorMetadata/:connector |
Get connector metadata information |
https://api.trifacta.com/ee/8.2/index.html#operation/getConnectorConfig |
GET /v4/connectorMetadata/:connector/defaults |
Get default connector metadata information |
https://api.trifacta.com/ee/8.2/index.html#operation/getConnectorDefaults |
DatabricksCluster
Path |
Description |
Documentation URL |
---|---|---|
GET /v4/databricksClusters/hasToken |
Check for Databricks access token |
https://api.trifacta.com/ee/8.2/index.html#operation/hasDatabricksAccessToken |
GET /v4/databricksClusters/getDatabricksTableClusterName |
Get Databricks Table cluster name for user |
https://api.trifacta.com/ee/8.2/index.html#operation/getDatabricksTableClusterName |
PUT /v4/databricksClusters/saveDatabricksToken |
Save Databricks access token |
https://api.trifacta.com/ee/8.2/index.html#operation/saveDatabricksAccessToken |
PUT /v4/databricksClusters/saveDatabricksTokenByAdmin |
Update Databricks access token for user |
https://api.trifacta.com/ee/8.2/index.html#operation/saveDatabricksAccessTokenByAdmin |
PUT /v4/databricksClusters/saveDatabricksCluster |
Save Databricks cluster for current user |
https://api.trifacta.com/ee/8.2/index.html#operation/saveDatabricksCluster |
PUT /v4/databricksClusters/saveDatabricksClusterByAdmin |
Save Databricks cluster for user |
https://api.trifacta.com/ee/8.2/index.html#operation/saveDatabricksClusterByAdmin |
PUT /v4/databricksClusters/saveDatabricksTableClusterName |
Save Databricks Table cluster name for user |
https://api.trifacta.com/ee/8.2/index.html#operation/saveDatabricksTableClusterName |
Deployment
Edit
Path |
Description |
Documentation URL |
---|---|---|
GET /v4/edits/:id/history |
Get Recipe Edit history |
https://api.trifacta.com/ee/8.2/index.html#operation/getEditHistoryForEdit |
EmrCluster
Path |
Description |
Documentation URL |
---|---|---|
POST /v4/emrClusters |
Create emr cluster |
https://api.trifacta.com/ee/8.2/index.html#operation/createEmrCluster |
GET /v4/emrClusters |
List emr clusters |
https://api.trifacta.com/ee/8.2/index.html#operation/listEmrClusters |
GET /v4/emrClusters/count |
Count emr clusters |
https://api.trifacta.com/ee/8.2/index.html#operation/countEmrClusters |
GET /v4/emrClusters/:id |
Get emr cluster |
https://api.trifacta.com/ee/8.2/index.html#operation/getEmrCluster |
PATCH /v4/emrClusters/:id |
Update emr cluster |
https://api.trifacta.com/ee/8.2/index.html#operation/updateEmrCluster |
DELETE /v4/emrClusters/:id |
Delete emr cluster |
https://api.trifacta.com/ee/8.2/index.html#operation/deleteEmrCluster |
Flow
FlowNode
Path |
Description |
Documentation URL |
---|---|---|
POST /v4/flowNodes/:id/commitEdges |
Create new edges |
https://api.trifacta.com/ee/8.2/index.html#operation/commitEdges |
FlowPermission
Path |
Description |
Documentation URL |
|||
---|---|---|---|---|---|
POST /v4/flows/:id/permissions |
Share Flow |
https://api.trifacta.com/ee/8.2/index.html#operation/shareFlow | |||
GET /v4/flows/:id/permissions |
List permissions for Flow |
https://api.trifacta.com/ee/8.2/index.html#operation/getFlowPermissions | |||
GET /v4/flows/:id/permissions/ Unknown macro: {aid}
|
Delete flow permission |
https://api.trifacta.com/ee/8.2/index.html#operation/deleteFlowPermission |
FlowRun
Path |
Description |
Documentation URL |
---|---|---|
GET /v4/flowRuns/:id |
Get flow run |
https://api.trifacta.com/ee/8.2/index.html#operation/getFlowRun |
GET /v4/flowRuns/:id/status |
Get Flow Run Status |
https://api.trifacta.com/ee/8.2/index.html#operation/getFlowRunStatus |
GET /v4/flowRuns/:id/jobGroups |
Get JobGroups for Flow Run |
https://api.trifacta.com/ee/8.2/index.html#operation/getFlowRunJobGroups |
FlowRunParameterOverride
Path |
Description |
Documentation URL |
---|---|---|
POST /v4/flowRunParameterOverrides |
Create flow run parameter override |
https://api.trifacta.com/ee/8.2/index.html#operation/createFlowRunParameterOverride |
GET /v4/flowRunParameterOverrides/:id |
Get flow run parameter override |
https://api.trifacta.com/ee/8.2/index.html#operation/getFlowRunParameterOverride |
PATCH /v4/flowRunParameterOverrides/:id |
Patch flow run parameter override |
https://api.trifacta.com/ee/8.2/index.html#operation/patchFlowRunParameterOverride |
DELETE /v4/flowRunParameterOverrides/:id |
Delete flow run parameter override |
https://api.trifacta.com/ee/8.2/index.html#operation/deleteFlowRunParameterOverride |
Folder
Path |
Description |
Documentation URL |
---|---|---|
POST /v4/folders |
Create folder |
https://api.trifacta.com/ee/8.2/index.html#operation/createFolder |
GET /v4/folders |
List folders |
https://api.trifacta.com/ee/8.2/index.html#operation/listFolders |
GET /v4/folders/count |
Count folders |
https://api.trifacta.com/ee/8.2/index.html#operation/countFolders |
GET /v4/folders/:id |
Get folder |
https://api.trifacta.com/ee/8.2/index.html#operation/getFolder |
PUT /v4/folders/:id |
Update folder |
https://api.trifacta.com/ee/8.2/index.html#operation/updateFolder |
PATCH /v4/folders/:id |
Patch folder |
https://api.trifacta.com/ee/8.2/index.html#operation/patchFolder |
DELETE /v4/folders/:id |
Delete folder |
https://api.trifacta.com/ee/8.2/index.html#operation/deleteFolder |
ImportedDataset
Job
Path |
Description |
Documentation URL |
---|---|---|
GET /v4/jobs/:id/status |
Get Job Status |
https://api.trifacta.com/ee/8.2/index.html#operation/getJobStatus |
JobGroup
License
Path |
Description |
Documentation URL |
---|---|---|
GET /v4/validateLicensedUserQuota |
Validate User Quota in License |
https://api.trifacta.com/ee/8.2/index.html#operation/validateLicensedUserQuota |
Macro
Path |
Description |
Documentation URL |
---|---|---|
POST /v4/macros/package |
Import Macro Package |
https://api.trifacta.com/ee/8.2/index.html#operation/importMacroPackage |
POST /v4/macros/:id/package/dryRun |
Import Macro Package - Dry run |
https://api.trifacta.com/ee/8.2/index.html#operation/importMacroPackageDryRun |
GET /v4/macros/:id/package |
Get Macro Package |
https://api.trifacta.com/ee/8.2/index.html#operation/getMacroPackage |
Misc
Path |
Description |
Documentation URL |
---|---|---|
GET /v4/open-api-spec |
Get OpenAPI specification |
https://api.trifacta.com/ee/8.2/index.html#operation/getOpenApiSpec |
Oauth2ClientDetail
Path |
Description |
Documentation URL |
---|---|---|
POST /v4/oauth2ClientDetails |
Create oauth 2 client detail |
https://api.trifacta.com/ee/8.2/index.html#operation/createOauth2ClientDetail |
GET /v4/oauth2ClientDetails/oauth2ClientModels/ |
Get all oauth2 client models for enterprise edition |
https://api.trifacta.com/ee/8.2/index.html#operation/allOAuth2ClientModels |
GET /v4/oauth2ClientDetails/oauth2ClientModels/:type |
Get oauth2 client models according to edition |
https://api.trifacta.com/ee/8.2/index.html#operation/oauth2ClientModels |
OutputObject
Path |
Description |
Documentation URL |
---|---|---|
POST /v4/outputObjects |
Create output object |
https://api.trifacta.com/ee/8.2/index.html#operation/createOutputObject |
GET /v4/outputObjects |
List output objects |
https://api.trifacta.com/ee/8.2/index.html#operation/listOutputObjects |
GET /v4/outputObjects/count |
Count output objects |
https://api.trifacta.com/ee/8.2/index.html#operation/countOutputObjects |
GET /v4/outputObjects/:id |
Get output object |
https://api.trifacta.com/ee/8.2/index.html#operation/getOutputObject |
PUT /v4/outputObjects/:id |
Update output object |
https://api.trifacta.com/ee/8.2/index.html#operation/updateOutputObject |
PATCH /v4/outputObjects/:id |
Patch output object |
https://api.trifacta.com/ee/8.2/index.html#operation/patchOutputObject |
DELETE /v4/outputObjects/:id |
Delete output object |
https://api.trifacta.com/ee/8.2/index.html#operation/deleteOutputObject |
GET /v4/outputObjects/:id/inputs |
List inputs for Output Object |
https://api.trifacta.com/ee/8.2/index.html#operation/getInputsForOutputObject |
Person
Plan
PlanNode
Path |
Description |
Documentation URL |
---|---|---|
POST /v4/planNodes |
Create plan node |
https://api.trifacta.com/ee/8.2/index.html#operation/createPlanNode |
GET /v4/planNodes/:id/runParameters |
List run parameters for a plan node |
https://api.trifacta.com/ee/8.2/index.html#operation/getPlanNodeRunParameters |
DELETE /v4/planNodes/:id |
Delete plan node |
https://api.trifacta.com/ee/8.2/index.html#operation/deletePlanNode |
PlanOverride
Path |
Description |
Documentation URL |
---|---|---|
POST /v4/planOverrides |
Override a parameter in a plan |
https://api.trifacta.com/ee/8.2/index.html#operation/createPlanOverride |
PUT /v4/planOverrides/:id |
Update the value of a parameter override in a plan |
https://api.trifacta.com/ee/8.2/index.html#operation/updatePlanOverride |
PlanSnapshotRun
Path |
Description |
Documentation URL |
---|---|---|
POST /v4/planSnapshotRuns/:id/cancel |
Cancel a plan execution |
https://api.trifacta.com/ee/8.2/index.html#operation/cancelPlanSnapshotRun |
GET /v4/planSnapshotRuns |
List plan snapshot runs |
https://api.trifacta.com/ee/8.2/index.html#operation/listPlanSnapshotRuns |
GET /v4/planSnapshotRuns/count |
Count plan snapshot runs |
https://api.trifacta.com/ee/8.2/index.html#operation/countPlanSnapshotRuns |
GET /v4/planSnapshotRuns/:id |
Get plan snapshot run |
https://api.trifacta.com/ee/8.2/index.html#operation/getPlanSnapshotRun |
GET /v4/planSnapshotRuns/:id/schedule |
Get schedule for plan run |
https://api.trifacta.com/ee/8.2/index.html#operation/getScheduleForPlanRun |
Publication
Path |
Description |
Documentation URL |
---|---|---|
POST /v4/publications |
Create publication |
https://api.trifacta.com/ee/8.2/index.html#operation/createPublication |
GET /v4/publications |
List publications |
https://api.trifacta.com/ee/8.2/index.html#operation/listPublications |
GET /v4/publications/count |
Count publications |
https://api.trifacta.com/ee/8.2/index.html#operation/countPublications |
GET /v4/publications/:id |
Get publication |
https://api.trifacta.com/ee/8.2/index.html#operation/getPublication |
PUT /v4/publications/:id |
Update publication |
https://api.trifacta.com/ee/8.2/index.html#operation/updatePublication |
PATCH /v4/publications/:id |
Patch publication |
https://api.trifacta.com/ee/8.2/index.html#operation/patchPublication |
DELETE /v4/publications/:id |
Delete publication |
https://api.trifacta.com/ee/8.2/index.html#operation/deletePublication |
Release
Path |
Description |
Documentation URL |
---|---|---|
GET /v4/releases |
List releases |
https://api.trifacta.com/ee/8.2/index.html#operation/listReleases |
GET /v4/releases/count |
Count releases |
https://api.trifacta.com/ee/8.2/index.html#operation/countReleases |
GET /v4/releases/:id |
Get release |
https://api.trifacta.com/ee/8.2/index.html#operation/getRelease |
PUT /v4/releases/:id |
Update release |
https://api.trifacta.com/ee/8.2/index.html#operation/updateRelease |
PATCH /v4/releases/:id |
Patch release |
https://api.trifacta.com/ee/8.2/index.html#operation/patchRelease |
DELETE /v4/releases/:id |
Delete release |
https://api.trifacta.com/ee/8.2/index.html#operation/deleteRelease |
GET /v4/releases/:id/package |
Export Release |
https://api.trifacta.com/ee/8.2/index.html#operation/getReleasePackage |
GET /v4/releases/:id/package/dryRun |
Export Release - dry run |
https://api.trifacta.com/ee/8.2/index.html#operation/getReleasePackageDryRun |
SupportBundle
Path |
Description |
Documentation URL |
---|---|---|
GET /v4/supportbundle |
Get Support Bundle |
https://api.trifacta.com/ee/8.2/index.html#operation/getSupportBundle |
GET /v4/supportbundle/currentsession |
Get Support Bundle for current session |
https://api.trifacta.com/ee/8.2/index.html#operation/getSupportBundleForCurrentSession |
Workspace
WrangledDataset
WriteSetting
Path |
Description |
Documentation URL |
---|---|---|
POST /v4/writeSettings |
Create writesetting |
https://api.trifacta.com/ee/8.2/index.html#operation/createWriteSetting |
GET /v4/writeSettings |
List write settings |
https://api.trifacta.com/ee/8.2/index.html#operation/listWriteSettings |
GET /v4/writeSettings/count |
Count write settings |
https://api.trifacta.com/ee/8.2/index.html#operation/countWriteSettings |
GET /v4/writeSettings/:id |
Get write setting |
https://api.trifacta.com/ee/8.2/index.html#operation/getWriteSetting |
PUT /v4/writeSettings/:id |
Update write setting |
https://api.trifacta.com/ee/8.2/index.html#operation/updateWriteSetting |
PATCH /v4/writeSettings/:id |
Patch write setting |
https://api.trifacta.com/ee/8.2/index.html#operation/patchWriteSetting |
DELETE /v4/writeSettings/:id |
Delete write setting |
https://api.trifacta.com/ee/8.2/index.html#operation/deleteWriteSetting |
This page has no comments.