/
Connect to a TM1 Instance Directly via the REST API

Connect to a TM1 Instance Directly via the REST API

Connect to a TM1 Instance Directly via the REST API

In addition to connecting via the TM1 Admin Host, Arc can connect directly to a TM1 instance's REST API port. This is the preferred method when connecting to cloud-hosted TM1 instances where only the REST API port is open, or when you want to bypass the admin host entirely.

When to Use Direct REST API Connections

Scenario

Recommended Approach

Scenario

Recommended Approach

On-premise TM1, admin host accessible

Admin host (adminhosts in settings.yml)

Cloud TM1, only REST API port open

Direct REST API connection (connections in settings.yml)

IBM PA SaaS

IBM ID / OAuth (see Using IBM ID with Arc)

Configuration

Open settings.yml in the Arc installation directory. Replace the empty [] for the connections parameter with the following for each TM1 instance:

connections: - url: https://<server name or IP>:<HttpPortNumber of TM1 instance> name: <display name shown in Arc>

Example:

connections: - url: https://tm1cloud.example.com:8111 name: Production - url: https://tm1cloud.example.com:8112 name: Development

Note: The url uses the TM1 REST API port (set via HttpPortNumber in tm1s.cfg), not the admin host port (5898).

Prerequisites

  • The TM1 REST API must be enabled. Set HttpPortNumber in tm1s.cfg for each TM1 instance.

  • The REST API port must be accessible from the machine running Arc (check firewall and network rules).

Related Pages