Page tree

Gets the Transporter info by its ID. 



Tenant Endpoint

For tenants of the multi-tenant product the endpoint must be:

Request Example

curl --request POST \
	--url https://<Director_IP_address>:4443/c/router \
	--header "content-type: application/json" \
	--cookie @cookies.txt \
	--data "{
			"action": "TransporterManagement",
			"method": "get",
			"data": [1],
			"type": "rpc",
			"tid": 1}"

Request Fields





dataarray of intThe ID of Transporter

Response Sample

  "action": "TransporterManagement",
  "method": "get",
  "tid": "1",
  "type": "rpc",
  "message": null,
  "where": null,
  "cause": null,
  "data": {
    "id": 1,
    "name": "Onboard transporter",
    "state": "OK",
    "status": "NONE",
    "changeStatus": "NONE",
    "type": "TRANSPORTER",
    "loggingLevel": "AUTO",
    "local": true,
    "host": "",
    "port": 9446,
    "dataPortRangeStart": 9448,
    "dataPortRangeEnd": 10000,
    "loadFactor": 6,
    "description": "This is the built-in Transporter of NAKIVO Backup & Replication. It is installed on the same machine where the main part of the product resides. For better scalability, you can deploy more Transporters. It is recommended to have at least one Transporter per each Source and Target site.",
    "preventModification": false,
    "monitorAddressChanges": true,
    "locked": false,
    "lockReasons": [],
    "outOfDate": false,
    "wasEdited": false,
    "wasDiscoveredOnce": true,
    "wasDeployed": false,
    "progress": 0,
    "version": "7.2.0.r18265",
    "fingerprint": "5F:69:0C:87:4F:1D:13:51:38:82:C4:99:38:91:A0:3D:2A:54:84:63:53:ED:C9:91:68:BF:72:69:6A:F2:3D:63",
    "awsAccountId": null,
    "regionId": null,
    "ec2InstanceId": null,
    "virtualizationType": null,
    "vpcId": null,
    "subnetId": null,
    "availabilityZoneId": null,
    "inboundFilter": null,
    "instanceType": null,
    "operationMode": null,
    "wasInfoDownloaded": null,
    "autoConfigureVpc": null,
    "isWindowsPlatform": null,
    "wasAutoPoweredOff": false,
    "accountName": null,
    "regionName": null,
    "vpcName": null,
    "subnetName": null,
    "availabilityZoneName": null,
    "securityGroupName": null,
    "os": "Linux",
    "vmwarevSphereSupport": true,
    "msHypervSupport": false,
    "awsEc2Support": false,
	"nutanixSupport": false,
    "repositoryManagementSupport": true,
    "cifsShareSupport": true,
    "nfsShareSupport": true,
    "repositoryEncryptionSupport": true,
    "windowsGuestsRecoverySupport": true,
    "linuxGuestsRecoverySupport": true,
    "flashVmBootSupport": true,
    "assignedAmazonEbsRepositoryId": null,
    "awsLocal": false,
    "hasAssignedBackupRepositories": true,
    "alertErrorCode": null,
    "alertTitle": null,
    "alertDescription": null    

Response Fields

messagestringMessage if the request failed
wherestringReference to the method where the problem occurred
causestringCause of failure


Transporter parameters (see below)


idintTransporter ID
namestringTransporter display name
statestringThe current state of the Transporter
statusstringThe current status of the Transporter's operations
vidstringTransporter VID
hvTypestringPlatform type
CREATE_PENDING New item, discovery is needed
CHANGE_PENDING Some attributes have changed, discovery is needed
RECREATE_PENDING The item was destroyed and needs to be re-created
typestringThe type of the Transporter
loggingLevelstringLogging level
localbooleanChecks if the Transporter is an onboard one
hoststringThe host where the Transporter is installed
portintTransporter port
dataPortRangeStartintThe start of the data transfer port range
dataPortRangeEndintThe end of the data transfer port range
loadFactorintThe maximum number of concurrent jobs
descriptionstringDescription (optional)
preventModificationbooleanChecks if the Transporter is locked for manual modification
monitorAddressChangesbooleanIf true, the onboard Transporter IP-address will be changed automatically if local IP settings change
lockedbooleanChecks if the Transporter is currently locked by current tasks
lockReasonsarrayLock reasons
outOfDatebooleanChecks if the Transporter has an outdated version
wasEditedbooleanChecks if the Transporter settings were edited
wasDiscoveredOncebooleanChecks if the Transporter was discovered for the first time
true if the transporter was already deployed to the remote Hyper-V/AWS host
progressintCurrent operation progress
versionstringThe version of the Transporter
fingerprintstringTransporter certificate fingerprint
awsAccountIdintFor AWS Transporters: the internal ID of the AWS account where Transporter is installed
regionIDintFor AWS Transporters: the internal ID of the region where Transporter is installed
es2InstanceIDintFor AWS Transporters: the internal ID of the EC2 instance where Transporter is installed
virtualizationTypestringFor AWS Transporters: virtualization type
vpcIDintFor AWS Transporters: VPC ID
subnetIDintFor AWS Transporters: subnet ID
availabilityZoneIdintFor AWS Transporters: availability zone ID
AWS-specific: IP filter for new EC2 instance where the Transporter will be deployed
instanceTypestringFor AWS Transporters: the type of an instance where Transporter is installed
operationModestringThe mode of operation
AWS-specific: when the Transporter is deployed, an EC2 instance is created with a keypair necessary to access this instance.
true if the user has downloaded it once from the NAKIVO Backup & Replication interface
autoconfigureVpcbooleanChecks if the VPC is auto-configured
isWindowsPlatformbooleanChecks if the Transporter installed on Windows
true if the EC2 instance was powered off automatically due to idle. See operation mode
accountNamestringFor AWS Transporters: AWS account display name
regionNamestringFor AWS Transporters: region display name
vpcNamestringFor AWS Transporters: VPC display name
subnetNamestringFor AWS Transporters: subnet display name
availabilityZoneNamestringFor AWS Transporters: availability zone display name
securityGroupNamestringFor AWS Transporters: security group display name
osstringOperating system where the Transporter is installed
vmwarevSphereSupportbooleanChecks if the Transporter supports VMware
msHypervSupportbooleanChecks if the Transporter supports Hyper-V
awsEc2SupportbooleanChecks if the Transporter supports AWS
nutanixSupportbooleanChecks if the Transporter supports Nutanix AHV
repositoryManagementSupportbooleanChecks if the Transporter can manage Backup Repository
cifsShareSupportbooleanChecks if the Transporter supports CIFS shares
nfsShareSupportbooleanChecks if the Transporter supports NFS shares
repositoryEncryptionSupportbooleanChecks if the Transporter supports backup repository encryption
windowsGuestsRecoverySupportbooleanChecks if the Transporter supports Windows guest OS
linuxGuestsRecoverySupportbooleanChecks if the Transporter supports Linux guest OS
flashVmBootSupportbooleanChecks if the Transporter supports Flash VM Boot
assignedAmazonEbsRepositoryIdintID of assigned Amazon EBS Repository
awsLocalbooleantrue if the Transporter is an onboard one for AWS
hasAssignedBackupRepositoriesbooleanChecks if the Transporter has Backup Repositories assigned
alertErrorCodeintThe error code of the alert (if any)
alertTitlestringThe title of the alert (if any)
alertDescriptionstringThe description of the alert (if any)

Permissions Access

Make sure you have at least one of the following permissions:

Permission type

Access Level


View only or higher


Full access


Full access

File recovery

Full access

Microsoft SQL server objects

Full access

Microsoft Active Directory objects

Full access

Microsoft Exchange & Exchange Online objects

Full access

Universal Object Recovery

Full access

Site recovery

Full access

Edit job actions

Full access

Microsoft 365 objects

Full access

  • No labels