How To: Use Titan API

How To: Use Titan API


How To: Use the Titan API


Question

Does Titan provide an API?

Reasoning

I am interested in working with Titan Server programmatically.

Answer

Titan provides an OpenAPI 3.0.x specification for its REST API, available at https://<your-titan-server>/swagger/v1/swagger.json.

A public reference version is also on GitHub, but always use your live server’s spec for the most accurate endpoints.

Steps

The Titan REST API is disabled by default. To enable the API, you will need to create a configuration file in the Titan executable's directory.
  1. Create  a file named appsettings.oem.json with the following content:
    {         
       "ConfigSettings" : {
        "RESTEnableSwaggerUI" : true,
        "RESTEnableAdminApi" : true,
        "RESTEnableUserApi" : false,
        "RESTEnableBasicAuth" : false,
        "RESTEnableDigestAuth" : true
        }
    }

  2. Copy this file into the Titan server’s install directory:

    1. Windows: C:\Program Files\South River Technologies\srxserver\appsettings.oem.json

    2. Linux: /srxserver/appsettings.oem.json

  3. Restart the Titan service to apply changes.

You should now be able to access https://<your-titan-server>:31443/swagger/index.html
(Port 41443 for remote login; check your deployment’s configuration.)

Examples

South River Technologies provides the following examples in Github:
  1. C#: https://github.com/southrivertech/titanapi.pub/tree/main/sdk/csharp
  2. PS: https://github.com/southrivertech/titanapi.pub/tree/main/sdk/powershell
  3. Javascript: Coming soon!

Support

If you have any issues enabling or working with the Titan API, cut us a support ticket at https://southrivertech.com/support/

South River Technologies also provides professional services for complex or advanced integrations or custom code. Contact us for more information.


    • Related Articles

    • How To Install Titan MFT Server on Windows

      How To: Install Titan MFT Server on Windows Question How can I install Titan MFT on a Windows Server? Reasoning We have a requirement to install a Managed File Transfer (MFT) server on a Windows platform Answer You can install Titan easily in your ...

    • KB PUSH and PULL in Titan MFT Server Next Gen

      PUSH and PULL Automation Events in Titan MFT Server Next Gen Question How do I configure and use the PUSH and PULL capabilities in Events on my Titan MFT server? Pre-requisites: Titan MFT Server Next Gen must be installed on your server system ...

    • How To: Create a Server With Windows Authentication In Titan

      How To: Create a Server With Windows Authentication In Titan Question How do I create a server within Titan that utilizes Windows authentication? Reasoning I already have a database of users stored on a local windows server or an Active Directory ...

    • How To: Use Hybrid Authentication In Titan

      Related To Titan SFTP Server and Titan MFT Server. Question How can I use hybrid authentication in Titan? Reasoning I would like to be able to manage native user accounts and windows user accounts under one server instance to simplify administration. ...

    • Titan Rebranding Announcement – FAQ

      Titan Rebranding Announcement FAQ Overview South River Technologies, Inc. (SRT) has announced a major rebranding initiative to unify its server suite of products under the Titan brand. This change is aimed at driving clarity, enhancing product ...