Boomi MFT - AFT Management API Reference (v1) - ThruNodes

Toggle Pane

• ThruNodes
  • getRetrieves a list of nodes for a specific organization
  • getRetrieves a specific node by its identifier
  • getRetrieves a specific node by its node identifier
  • putUpdates an existing node configuration
  • postCreates a new node configuration
  • postRegenerates the authentication key for a node
  • delDeletes a node configuration
  • getRetrieves a list of endpoint identifiers associated with a node

API docs by Redocly

Download OpenAPI Specification: Download

For more information about Postman collections, forking, and making your first API call, refer to the Working with Boomi APIs on Postman page.

ThruNodes

Retrieves a list of nodes for a specific organization

Returns list of nodes configured for a specific organization.

Authorizations:

ApiKeyBearer

query Parameters

organizationId

integer <int32> Unique identifier of the organization

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

Array

id	integer <int32>
thruNodeId	string or null
organizationId	integer <int32>
organizationName	string or null
name	string or null
isEnabled	boolean
tenantId	integer <int32>
lastActiveTime	string or null <date-time>
thruNodeKey	string or null
keyCreationDateTimeUtc	string or null <date-time>
createdDate	string <date-time>
createdBy	string or null
updatedBy	string or null
updatedDate	string or null <date-time>
deletedBy	string or null
deletedDate	string or null <date-time>
description	string or null
isAlertsEnabled	boolean
lastHeartbeatTimeUTC	string or null <date-time>
lanIpAddress	string or null
hostname	string or null
version	string or null

https://us.thruinc.com/api/ThruNodes/List

https://uk.thruinc.com/api/ThruNodes/List

https://eu.thruinc.com/api/ThruNodes/List

https://au.thruinc.com/api/ThruNodes/List

Response samples

• 200
• 400
• 403
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Retrieves a specific node by its identifier

Returns detailed node configuration including status, key, and heartbeat information.

Authorizations:

ApiKeyBearer

query Parameters

id	integer <int32> Unique identifier of the node

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

id	integer <int32>
thruNodeId	string or null
organizationId	integer <int32>
organizationName	string or null
name	string or null
isEnabled	boolean
tenantId	integer <int32>
lastActiveTime	string or null <date-time>
thruNodeKey	string or null
keyCreationDateTimeUtc	string or null <date-time>
createdDate	string <date-time>
createdBy	string or null
updatedBy	string or null
updatedDate	string or null <date-time>
deletedBy	string or null
deletedDate	string or null <date-time>
description	string or null
isAlertsEnabled	boolean
lastHeartbeatTimeUTC	string or null <date-time>
lanIpAddress	string or null
hostname	string or null
version	string or null
alertEmails	Array of strings or null

https://us.thruinc.com/api/ThruNodes/GetSingle

https://uk.thruinc.com/api/ThruNodes/GetSingle

https://eu.thruinc.com/api/ThruNodes/GetSingle

https://au.thruinc.com/api/ThruNodes/GetSingle

Response samples

• 200
• 400
• 403
• 404
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Retrieves a specific node by its node identifier

Returns node configuration identified by node string identifier.

Authorizations:

ApiKeyBearer

query Parameters

thruNodeId

string Unique node identifier string

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

id	integer <int32>
thruNodeId	string or null
organizationId	integer <int32>
name	string or null
isEnabled	boolean
lastActiveTime	string or null <date-time>
thruNodeKey	string or null
keyCreationDateTimeUtc	string or null <date-time>
isAlertsEnabled	boolean
createdDate	string <date-time>
createdBy	string or null
updatedBy	string or null
updatedDate	string or null <date-time>
deletedBy	string or null
deletedDate	string or null <date-time>
description	string or null
alertEmails	Array of strings or null

https://us.thruinc.com/api/ThruNodes/getByThruNodeId

https://uk.thruinc.com/api/ThruNodes/getByThruNodeId

https://eu.thruinc.com/api/ThruNodes/getByThruNodeId

https://au.thruinc.com/api/ThruNodes/getByThruNodeId

Response samples

• 200
• 400
• 403
• 404
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Updates an existing node configuration

Modifies existing node configuration including name, enabled status, and alert settings.

Authorizations:

ApiKeyBearer

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

Updated node configuration details

id	integer <int32>
thruNodeId	string or null
organizationId	integer <int32>
name	string or null
isEnabled	boolean
lastActiveTime	string or null <date-time>
thruNodeKey	string or null
keyCreationDateTimeUtc	string or null <date-time>
isAlertsEnabled	boolean
createdDate	string <date-time>
createdBy	string or null
updatedBy	string or null
updatedDate	string or null <date-time>
deletedBy	string or null
deletedDate	string or null <date-time>
description	string or null
alertEmails	Array of strings or null

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

isUpdated

boolean

https://us.thruinc.com/api/ThruNodes/Update

https://uk.thruinc.com/api/ThruNodes/Update

https://eu.thruinc.com/api/ThruNodes/Update

https://au.thruinc.com/api/ThruNodes/Update

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "id": 0,
• "thruNodeId": "string",
• "organizationId": 0,
• "name": "string",
• "isEnabled": true,
• "lastActiveTime": "2019-08-24T14:15:22Z",
• "thruNodeKey": "string",
• "keyCreationDateTimeUtc": "2019-08-24T14:15:22Z",
• "isAlertsEnabled": true,
• "createdDate": "2019-08-24T14:15:22Z",
• "createdBy": "string",
• "updatedBy": "string",
• "updatedDate": "2019-08-24T14:15:22Z",
• "deletedBy": "string",
• "deletedDate": "2019-08-24T14:15:22Z",
• "description": "string",
• "alertEmails": [

  • "string"

  ]

}

Response samples

• 200
• 400
• 403
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Creates a new node configuration

Establishes new node with generated authentication key and configuration.

Authorizations:

ApiKeyBearer

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

Node configuration details

id	integer <int32>
thruNodeId	string or null
organizationId	integer <int32>
name	string or null
isEnabled	boolean
lastActiveTime	string or null <date-time>
thruNodeKey	string or null
keyCreationDateTimeUtc	string or null <date-time>
isAlertsEnabled	boolean
createdDate	string <date-time>
createdBy	string or null
updatedBy	string or null
updatedDate	string or null <date-time>
deletedBy	string or null
deletedDate	string or null <date-time>
description	string or null
alertEmails	Array of strings or null

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

id	integer <int32>
thruNodeId	string or null
organizationId	integer <int32>
name	string or null
isEnabled	boolean
lastActiveTime	string or null <date-time>
thruNodeKey	string or null
keyCreationDateTimeUtc	string or null <date-time>
isAlertsEnabled	boolean
createdDate	string <date-time>
createdBy	string or null
updatedBy	string or null
updatedDate	string or null <date-time>
deletedBy	string or null
deletedDate	string or null <date-time>
description	string or null
alertEmails	Array of strings or null

https://us.thruinc.com/api/ThruNodes/Create

https://uk.thruinc.com/api/ThruNodes/Create

https://eu.thruinc.com/api/ThruNodes/Create

https://au.thruinc.com/api/ThruNodes/Create

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "id": 0,
• "thruNodeId": "string",
• "organizationId": 0,
• "name": "string",
• "isEnabled": true,
• "lastActiveTime": "2019-08-24T14:15:22Z",
• "thruNodeKey": "string",
• "keyCreationDateTimeUtc": "2019-08-24T14:15:22Z",
• "isAlertsEnabled": true,
• "createdDate": "2019-08-24T14:15:22Z",
• "createdBy": "string",
• "updatedBy": "string",
• "updatedDate": "2019-08-24T14:15:22Z",
• "deletedBy": "string",
• "deletedDate": "2019-08-24T14:15:22Z",
• "description": "string",
• "alertEmails": [

  • "string"

  ]

}

Response samples

• 200
• 400
• 403
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Regenerates the authentication key for a node

Generates new authentication key for node, invalidating previous key.

Authorizations:

ApiKeyBearer

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

Key regeneration request containing node details

thruNodeId

string or null

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

thruNodeKey	string or null
keyCreationDateTimeUtc	string or null <date-time>

https://us.thruinc.com/api/ThruNodes/RegenerateKey

https://uk.thruinc.com/api/ThruNodes/RegenerateKey

https://eu.thruinc.com/api/ThruNodes/RegenerateKey

https://au.thruinc.com/api/ThruNodes/RegenerateKey

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "thruNodeId": "string"

}

Response samples

• 200
• 400
• 403
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Deletes a node configuration

Removes node configuration if no endpoints are currently using it.

Authorizations:

ApiKeyBearer

query Parameters

id	integer <int32> Unique identifier of the node to delete

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

isDeleted

boolean

https://us.thruinc.com/api/ThruNodes/Delete

https://uk.thruinc.com/api/ThruNodes/Delete

https://eu.thruinc.com/api/ThruNodes/Delete

https://au.thruinc.com/api/ThruNodes/Delete

Response samples

• 200
• 400
• 403
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Retrieves a list of endpoint identifiers associated with a node

Returns list of endpoint IDs that reference the specified node.

Authorizations:

ApiKeyBearer

query Parameters

thruNodeId

string Unique node identifier string

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

Array

integer <int32>

https://us.thruinc.com/api/ThruNodes/getAssociatedEndpointList

https://uk.thruinc.com/api/ThruNodes/getAssociatedEndpointList

https://eu.thruinc.com/api/ThruNodes/getAssociatedEndpointList

https://au.thruinc.com/api/ThruNodes/getAssociatedEndpointList

Response samples

• 200
• 400
• 403
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample