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.
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 |
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 |
Path | Description | Documentation URL |
---|---|---|
POST /v4/awsRoles | Create AWS role | https://api.trifacta.com/ee/9.7/index.html#operation/createAwsRole |
GET /v4/awsRoles | List AWS roles | https://api.trifacta.com/ee/9.7/index.html#operation/listAwsRoles |
PUT /v4/awsRoles/:id | Update AWS role | https://api.trifacta.com/ee/9.7/index.html#operation/updateAwsRole |
DELETE /v4/awsRoles/:id | Delete AWS role | https://api.trifacta.com/ee/9.7/index.html#operation/deleteAwsRole |
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 |
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 |
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 |
Path | Description | Documentation URL |
---|---|---|
POST /v4/flowNodes/:id/commitEdges | Create new edges | https://api.trifacta.com/ee/9.7/index.html#operation/commitEdges |
Path | Description | Documentation URL |
---|---|---|
POST /v4/flowNotificationSettings | Create flow notification settings | https://api.trifacta.com/ee/9.7/index.html#operation/createFlowNotificationSettings |
Path | Description | Documentation URL |
---|---|---|
POST /v4/flows/:id/permissions | Share Flow | https://api.trifacta.com/ee/9.7/index.html#operation/shareFlow |
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 |
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 |
Path | Description | Documentation URL |
---|---|---|
POST /v4/folders | Create folder | https://api.trifacta.com/ee/9.7/index.html#operation/createFolder |
GET /v4/folders | List folders | https://api.trifacta.com/ee/9.7/index.html#operation/listFolders |
GET /v4/folders/count | Count folders | https://api.trifacta.com/ee/9.7/index.html#operation/countFolders |
PATCH /v4/folders/:id | Patch folder | https://api.trifacta.com/ee/9.7/index.html#operation/patchFolder |
DELETE /v4/folders/:id | Delete folder | https://api.trifacta.com/ee/9.7/index.html#operation/deleteFolder |
Path | Description | Documentation URL |
---|---|---|
GET /v4/jobs/:id/status | Get Job Status | https://api.trifacta.com/ee/9.7/index.html#operation/getJobStatus |
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 |
Path | Description | Documentation URL |
---|---|---|
GET /v4/open-api-spec | Get OpenAPI specification | https://api.trifacta.com/ee/9.7/index.html#operation/getOpenApiSpec |
Path | Description | Documentation URL |
---|---|---|
GET /v4/people/current | Get Current Person | https://api.trifacta.com/ee/9.7/index.html#operation/getCurrentPerson |
GET /v4/people/:id | Get person | https://api.trifacta.com/ee/9.7/index.html#operation/getPerson |
GET /v4/people | List people | https://api.trifacta.com/ee/9.7/index.html#operation/listPerson |
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 |
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 |
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 |
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 |
Path | Description | Documentation URL |
---|---|---|
POST /v4/schedules | Create a schedule | https://api.trifacta.com/ee/9.7/index.html#operation/createSchedule |
GET /v4/schedules | List schedules | https://api.trifacta.com/ee/9.7/index.html#operation/listSchedules |
POST /v4/schedules/:id/enable | Enable schedule | https://api.trifacta.com/ee/9.7/index.html#operation/enableSchedule |
POST /v4/schedules/:id/disable | Disable schedule | https://api.trifacta.com/ee/9.7/index.html#operation/disableSchedule |
GET /v4/schedules/count | Count schedules | https://api.trifacta.com/ee/9.7/index.html#operation/countSchedules |
GET /v4/schedules/:id | Get schedule | https://api.trifacta.com/ee/9.7/index.html#operation/getSchedule |
PUT /v4/schedules/:id | Update a schedule | https://api.trifacta.com/ee/9.7/index.html#operation/updateSchedule |
DELETE /v4/schedules/:id | Delete schedule | https://api.trifacta.com/ee/9.7/index.html#operation/deleteSchedule |
Path | Description | Documentation URL |
---|---|---|
POST /v4/sqlScripts | Create sql script | https://api.trifacta.com/ee/9.7/index.html#operation/createSqlScript |
GET /v4/sqlScripts | List sql scripts | https://api.trifacta.com/ee/9.7/index.html#operation/listSqlScripts |
GET /v4/sqlScripts/count | Count sql scripts | https://api.trifacta.com/ee/9.7/index.html#operation/countSqlScripts |
GET /v4/sqlScripts/:id | Get sql script | https://api.trifacta.com/ee/9.7/index.html#operation/getSqlScript |
PATCH /v4/sqlScripts/:id | Patch sql script | https://api.trifacta.com/ee/9.7/index.html#operation/patchSqlScript |
DELETE /v4/sqlScripts/:id | Delete sql script | https://api.trifacta.com/ee/9.7/index.html#operation/deleteSqlScript |
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 |
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 |