Applying new port number.
to navigation to content

INNORIX Platform

53 GB Free
53 GB free in your server storage.
Language

MRT API Manual

With RESTful API, external applications can access MONITOR/TRACKER transfer history.

API Overview

HTTP Address

Using the latest version : http://innorix.server.address/api/mt
Using specific version : http://innorix.server.address/api/mt/v2.0

HTTP Methods

Methods Actions Idempotent
POST Create No
GET Select Yes
PUT Update Yes
DELETE Delete Yes

HTTP JSON type

Request type : JSON Payload

{
    "name1" : "value",
    "name2" : ["value1", "value2"],
    "name3" : [
        {
          "name1" : "value1",
          "name2" : "value2"
        }
    ]
}

RESTful response status code

Code Description
200 Success - JSON payload succeeded
400 Bad Request - field validation failed
401 Unauthorized - API authorization failed
404 Not found – No resources
500 Internal Server Error – Sevrer error

API authentication key

RESTful API Key

Authenticating APIs

Resource : Query String, http://innorix.server.address/api/mt/track/transfer/{transferID}?api_key={authKey}
webpage) http://innorix.server.address/api/mt/track/transfer/57E90AD3653D975706a?api_key=NqfBvC3hu8pc6HFPPwF9

Request JSON
Key Value Description
authKey NqfBvC3hu8pc6HFPPwF9 RESTful API authentication key

With Transfer ID, Requesting transfer history

Resource : GET, http://innorix.server.address/api/mt/track/transfer/{transferID}?api_key={authKey}
webpage) http://innorix.server.address/api/mt/track/transfer/57E90AD3653D?api_key=NqfBvC3hu8pc6HFPPwF9

Request Path
Key Value Description
transferID 57E90AD3653D Transfer ID
Response JSON
Key Value Description
id 57E90AD3653D Transfer ID
userid innorix User ID
sourceName Seoul-Deploy Origin device, user or department name
sourceIP 172.30.1.1 172.30.1.1
destinationName Sydney-Australia Destination device, user or department name
destinationIP 172.30.2.1 Destination IP
fileCount 3000 Total number of files
totalSize 1073741824 Total file size [byte]
state complete
Transfer status
              complete
              transferring
              pause
              cancel
              error
transferDate 21398492134 Transfer start time [Unix timestamp format]
fileid ["975706a6", "62c27ffb"] Array of file IDs

With File ID, requesting transfer history

Resource : GET, http://innorix.server.address/api/mt/track/file/{fileID}?api_key={authKey}
webpage) http://innorix.server.address/api/mt/track/file/975706a?api_key=my1nF88U

Request Path
Key Value Description
fileID 975706a6 File ID
Response JSON
Key Value Description
id 975706a6 File ID
filename metrics.2016-06-09T11.dat Original filename
filesize 827392 File size [byte]
sourceIP 172.30.1.1 Origin IP
startTime 21398492134 Transfer start time [Unix timestamp format]
endTime 21398531143 Transfer end time [Unix timestamp format]
historyCount 120 The total number of histories
encrypt true | false true : Secure transfer false :
compress true | false true : Compressed transfer false :
fileAttribute
[
  {
   "name": "MIME Info",
   "value" : "application/x-msdownload"
  },
  {
   "name": "Extension",
   "value" : "exe"
  },
  {
   "name": ": "Type",
   "value" : "Application"
  }
]
File property information

With Product Name, requesting transfer history

Resource : GET, http://innorix.server.address/api/mt/track/product/{productName}?api_key={authKey}
webpage) http://innorix.server.address/api/mt/track/product/wp?api_key=my1nF88U

Request Path
Key Value Description
productName wp Product Name
Response JSON
Key Value Description
id 57E90AD3653D Transfer ID
userid innorix User ID
sourceName Seoul-Deploy Origin device, user or department name
sourceIP 172.30.1.1 172.30.1.1
destinationName Sydney-Australia Destination device, user or department name
destinationIP 172.30.2.1 Destination IP
fileCount 3000 Total number of files
totalSize 1073741824 Total file size [byte]
state complete
Transfer status
              complete
              transferring
              pause
              cancel
              error

With Location Name, requesting transfer history

Resource : GET, http://innorix.server.address/api/mt/track/location/{locationName}?api_key={authKey}
webpage) http://innorix.server.address/api/mt/track/location/INNORIX Server?api_key=my1nF88U

Request Path
Key Value Description
locationName INNORIX Server Location Name
Response JSON
Key Value Description
id 57E90AD3653D Transfer ID
userid innorix User ID
sourceName Seoul-Deploy Origin device, user or department name
sourceIP 172.30.1.1 172.30.1.1
destinationName Sydney-Australia Destination device, user or department name
destinationIP 172.30.2.1 Destination IP
fileCount 3000 Total number of files
totalSize 1073741824 Total file size [byte]
state complete
Transfer status
              complete
              transferring
              pause
              cancel
              error
System Message
It can not be changed in Live Demo.
if (!empty($subMenuActive) && !empty($menuActive)) { $testActive = function ($sub) use ($subMenuActive, $menuActive) { return $sub === $menuActive . '/' . $subMenuActive ? 'on' : 'off'; }; } else { $testActive = function () { return ''; }; }