Install and Configure the ATRS API

Install and start the ATRS API service, create credentials for your application and check that the application can reach it.

Before you begin

• Install the latest ATRS release on the Windows server that will run your reports.
• Have an administrator available to install the service and configure network access.
• Identify the Windows account the service will use and its access to the ATRS database, Tableau resources and output locations.
• Choose the protocol, hostname and port applications will use.
• Prepare a working Tableau report schedule and a test destination.

The service’s Windows account is separate from the ATRS user or API client used to authenticate API requests.

1. Install the API service

In the ATRS desktop application:

1. Open Options → REST API.
2. Under API Settings, click Install API.
3. Enter the requested Windows credentials and click OK.
4. Accept the installation confirmation with Yes, then dismiss the completion message with OK.

The ATRS API setup walkthrough shows the installation screens.

2. Configure the connection

With the API service stopped, review Protocol and Port in Options → REST API. Use a port that is available on this server.

For HTTPS, complete Configure HTTPS for the ATRS API before starting the HTTPS listener. Selecting HTTPS also requires a certificate binding and client trust.

3. Start the API service

Click Start and confirm that the ATRS API Service shows as running. ATRS saves protocol and port settings when it starts the service.

Record the base address, such as http://localhost:9000 for a local check. Use the actual configured port. This example address does not discover your settings.

4. Create an API client

1. Open Options → REST API → API Clients.
2. Click Add and enter a name for the application.
3. Click Save & Close.
4. Store the generated client ID and secret securely.

Use these credentials for API-client authentication. Keep the secret out of shared collections and source control.

5. Test the connection locally

On the ATRS server, replace this address with its configured local address and call GET /api/Service/Ping:

$AtrsBaseUrl = "http://localhost:9000"
$AtrsPing = Invoke-RestMethod -Method Get -Uri "$AtrsBaseUrl/api/Service/Ping" -Headers @{Accept="application/json"} -TimeoutSec 30
if ($AtrsPing -ne 1) { throw "Unexpected Ping response" }

Expect HTTP 200 and the JSON number 1. This confirms that the listener responds.

6. Test from your application host

Run the same check from the machine that will call ATRS, using the reachable server hostname. localhost on that machine refers to the application host.

If the local check succeeds but the remote check fails, check DNS, routing, the configured TCP port and firewall access. For HTTPS, also check the certificate hostname and trust chain.

7. Authenticate and verify a report

Follow Authentication and Token Management and complete its protected scheduler-state request. Either true or false confirms the protected request returned a scheduler-state value.

Then follow the Quick Start. Installation checks are complete when the application host can reach Ping, authenticate, read protected state and run the intended test schedule with verified output.

Troubleshooting