Welcome to the Alteryx Knowledge Base

• Alteryx Server version 2021.4 or above

API Access needs to be enabled for the user by the gallery administrator under the Admin > Users menu

The API key and secret can be found under the users profile after API access has been enabled by the gallery administrator.

Please perform the following steps:

1. To access the Web API you must click on the question mark at the top right corner of the page then select API Documentation from the drop down menu. You will land on the Swagger Web Api page.
 

 Alternatively, you can also use the Web API address found in the server's Alteryx System Settings followed by "swagger".  In this example the Web API address is "http://localhost/gallery/" + "swagger" or "http://localhost/gallery/swagger"
 

 API Swagger page is displayed.
 

2. Select the desired API endpoint. For the purpose of this demonstration we will are picking GET /v3/collections. Click on the red circle with the exclamation point. The "Available authorizations" pop-up screen is displayed.  Enter your ClientId and Secret then click the Authorize button.
 

3. Once authorized the previously red circle turns blue. There are no required parameters for this particular endpoint.  Click "Try it out!" button. The call is made and the response is displayed.

On the response you will receive the CURL command, the Request URL, the actual data, the Response Body, and the Response Headers.