Skip to main content

API Reference

This section contains reference information on the REST APIs that are made available by Designer Cloud Powered by Trifacta Enterprise Edition.

Access to API docs locally

Note

URLs to API endpoint documentation are case-sensitive.

To access the API documentation for each API endpoint and method that is available to your specific user account, select Resources menu > API documentation in the Trifacta Application.

Note

This API documentation portal displays only the API endpoints based on your specific user account and the features enabled in your Alteryx instance. Additional API endpoint documentation may be available at https://api.trifacta.com. For more information on the differences between these documentation portals, see API Documentation Versions.

Enable Access

Access tokens required

If the API documentation is not available, a workspace administrator must enable the use of API access tokens.

API tokens enable users and processes to access the REST APIs available through the platform.

Tip

Individual users do not need personal API access tokens to use the API documentation. The feature must be enabled.

For more information, seeWorkspace Settings Page.

Enable access through the menu

To enable the Resources menu option and access to the API documentation, the following parameter must be enabled.

Steps:

  1. Login to the application as an administrator.

  2. You can apply this change through the Admin Settings Page (recommended) or trifacta-conf.json. For more information, see Platform Configuration Methods.

  3. Locate the following parameter and set it to true:

    "webapp.apiDoc.enabled": true,

  4. Save your changes and restart the platform.

API Endpoint Documentation

You can access API reference documentation through the Trifacta Application. In the left navigation bar, select Resources menu > API documentation.

In this section: