The Thru MFT API is organized around REST.
Thru exposes multiple APIs to access different parts of the service.
The Management API allows clients to get information and manipulate entities in a single instance.
Entities are flows, activity, alerts, files, deliveries, organizations, subscription and user management etc.
Examples for using this API :
Exposing activity and alerts in external system
Automating the adding of organizations and subscriptions
Automating user management
Enabling / Disabling entities (Organizations, subscriptions)
Replaying files, retrying deliveries
Thru uses Swagger, which is an Interface Description Language for describing RESTful APIs expressed using JSON.
Swagger is used together with a set of open-source software tools to design, build, document, and use RESTful web services.
Swagger includes automated documentation, code generation, and test-case generation.
You can access the api by adding /Swagger/ to a site url.
The Audit API tracks changes to elements in the UI and all user actions.
The changes are visible through an API endpoint api/audit/swagger/ or /api/audit/swagger/v1/swagger.json
Example requests :
1 - GET /api/Audit - Retrieves audit log events filtered by the "Configuration" category and on or after the given date
2 - GET /api/Audit - Retrieves audit log events filtered by the "Transfer" category and between the given date ranges
3 - GET /api/Audit - Retrieves audit log events filtered by the "Login Failed" event type and on or after the given date
4 - GET /api/Audit - Same example as the previous with pagination support
Please adjust the date range according, otherwise it will take a long time to generate the request using the examples shown above.
The overall health of the entire application can be checked using the following endpoint:
GET [[PublicApiUrl]]/api/Healthcheck/Application (this requires the api url not the site url)
If the application is healthy, the API will return HTTP status code 200. If any component is unhealthy, the API will return HTTP status code 503.
In either case, the response body will look like: