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

Updated 13 November 2026

Toggle Pane

• NodeCommandConfigs
  • getRetrieves a node command configuration by ID
  • delDeletes a node command configuration and all of its node assignments, and re-applies the flows on those nodes
  • getRetrieves all node command configurations for an organization
  • postCreates a node command configuration
  • putUpdates a node command configuration and re-applies every flow on its assigned nodes
  • getRetrieves the command configuration assigned to a node
  • postAssigns a command configuration to a node and re-applies the node's flows
  • delRemoves a command configuration from a node and re-applies the node's flows
  • getRetrieves the node assignments of a command configuration
  • putSaves a command configuration (creates when ID is 0, otherwise updates), optionally assigns it to a node, and re-applies every flow on its assigned nodes
  • getRetrieves the status and results of a FlowApply job queued by a command configuration change

API docs by Redocly

License: Boomi API License and Rate Limits

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.

NodeCommandConfigs

External command configurations, node assignments, and flow re-apply job status.

Retrieves a node command configuration by ID

Requires node command configuration read permission. The configuration must belong to the caller's tenant.

Authorizations:

ApiKeyBearer

path Parameters

nodeCommandConfigId required

integer <int32> Unique identifier of the command configuration

Responses

Response Schema:

application/jsontext/plaintext/jsonapplication/json

id	integer <int32>
organizationId	integer <int32>
name	string or null
description	string or null
command	string or null
argumentsJson	string or null
workingDirectory	string or null
envAllowlistJson	string or null
timeoutSeconds	integer <int32>
retryCycles	integer <int32>
retryFirstIntervalSeconds	integer <int32>
retryBackoffEnabled	boolean
retryMaxIntervalSeconds	integer <int32>
successExitCodes	string or null
retryExitCodes	string or null
quarantineFolder	string or null
onFailDisposition	integer <int32>
onExhaustionDisposition	integer <int32>
isEnabled	boolean
createdBy	string or null
createdDate	string <date-time>
updatedBy	string or null
updatedDate	string or null <date-time>
deletedBy	string or null
deletedDate	string or null <date-time>

https://us.thruinc.com/api/NodeCommandConfigs/{nodeCommandConfigId}

https://uk.thruinc.com/api/NodeCommandConfigs/{nodeCommandConfigId}

https://eu.thruinc.com/api/NodeCommandConfigs/{nodeCommandConfigId}

https://au.thruinc.com/api/NodeCommandConfigs/{nodeCommandConfigId}

Response samples

• 200
• 403
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "id": 0,
• "organizationId": 0,
• "name": "string",
• "description": "string",
• "command": "string",
• "argumentsJson": "string",
• "workingDirectory": "string",
• "envAllowlistJson": "string",
• "timeoutSeconds": 0,
• "retryCycles": 0,
• "retryFirstIntervalSeconds": 0,
• "retryBackoffEnabled": true,
• "retryMaxIntervalSeconds": 0,
• "successExitCodes": "string",
• "retryExitCodes": "string",
• "quarantineFolder": "string",
• "onFailDisposition": 0,
• "onExhaustionDisposition": 0,
• "isEnabled": true,
• "createdBy": "string",
• "createdDate": "2019-08-24T14:15:22Z",
• "updatedBy": "string",
• "updatedDate": "2019-08-24T14:15:22Z",
• "deletedBy": "string",
• "deletedDate": "2019-08-24T14:15:22Z"

}

Deletes a node command configuration and all of its node assignments, and re-applies the flows on those nodes

Requires node command configuration read and delete permissions. Removes assignments with the configuration and re-applies affected flows. When queued, use ApplyJobId to track progress.

Authorizations:

ApiKeyBearer

path Parameters

nodeCommandConfigId required

integer <int32> Unique identifier of the command configuration to delete

query Parameters

queued

boolean Default: true Re-apply through a FlowApply job (default) rather than inline

Responses

Response Schema:

application/jsontext/plaintext/jsonapplication/json

	object (NodeCommandConfigs)
nodeCapabilityWarning	string or null Set when an assigned node does not report the post-download-command capability. The configuration is saved either way; the node just does not receive it until it reports the capability.
applyJobId	string or null FlowApply job queued to re-apply the affected flows, or null when none was queued.
affectedFlowCount	integer <int32> Number of flows re-applied, or queued for re-apply.
applyErrors	Array of strings or null Set when the write committed but its flows could not all be re-applied, one entry per failure; null otherwise. The write stands either way.

https://us.thruinc.com/api/NodeCommandConfigs/{nodeCommandConfigId}

https://uk.thruinc.com/api/NodeCommandConfigs/{nodeCommandConfigId}

https://eu.thruinc.com/api/NodeCommandConfigs/{nodeCommandConfigId}

https://au.thruinc.com/api/NodeCommandConfigs/{nodeCommandConfigId}

Response samples

• 200
• 403
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "config": {

  • "id": 0,
  • "organizationId": 0,
  • "name": "string",
  • "description": "string",
  • "command": "string",
  • "argumentsJson": "string",
  • "workingDirectory": "string",
  • "envAllowlistJson": "string",
  • "timeoutSeconds": 0,
  • "retryCycles": 0,
  • "retryFirstIntervalSeconds": 0,
  • "retryBackoffEnabled": true,
  • "retryMaxIntervalSeconds": 0,
  • "successExitCodes": "string",
  • "retryExitCodes": "string",
  • "quarantineFolder": "string",
  • "onFailDisposition": 0,
  • "onExhaustionDisposition": 0,
  • "isEnabled": true,
  • "createdBy": "string",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "updatedBy": "string",
  • "updatedDate": "2019-08-24T14:15:22Z",
  • "deletedBy": "string",
  • "deletedDate": "2019-08-24T14:15:22Z"

  },
• "nodeCapabilityWarning": "string",
• "applyJobId": "string",
• "affectedFlowCount": 0,
• "applyErrors": [

  • "string"

  ]

}

Retrieves all node command configurations for an organization

Requires node command configuration read permission. The organization must belong to the caller's tenant.

Authorizations:

ApiKeyBearer

query Parameters

organizationId

integer <int32> Unique identifier of the organization

Responses

Response Schema:

application/jsontext/plaintext/jsonapplication/json

Array

id	integer <int32>
organizationId	integer <int32>
name	string or null
description	string or null
command	string or null
argumentsJson	string or null
workingDirectory	string or null
envAllowlistJson	string or null
timeoutSeconds	integer <int32>
retryCycles	integer <int32>
retryFirstIntervalSeconds	integer <int32>
retryBackoffEnabled	boolean
retryMaxIntervalSeconds	integer <int32>
successExitCodes	string or null
retryExitCodes	string or null
quarantineFolder	string or null
onFailDisposition	integer <int32>
onExhaustionDisposition	integer <int32>
isEnabled	boolean
createdBy	string or null
createdDate	string <date-time>
updatedBy	string or null
updatedDate	string or null <date-time>
deletedBy	string or null
deletedDate	string or null <date-time>

https://us.thruinc.com/api/NodeCommandConfigs

https://uk.thruinc.com/api/NodeCommandConfigs

https://eu.thruinc.com/api/NodeCommandConfigs

https://au.thruinc.com/api/NodeCommandConfigs

Response samples

• 200
• 403
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

[

• {

  • "id": 0,
  • "organizationId": 0,
  • "name": "string",
  • "description": "string",
  • "command": "string",
  • "argumentsJson": "string",
  • "workingDirectory": "string",
  • "envAllowlistJson": "string",
  • "timeoutSeconds": 0,
  • "retryCycles": 0,
  • "retryFirstIntervalSeconds": 0,
  • "retryBackoffEnabled": true,
  • "retryMaxIntervalSeconds": 0,
  • "successExitCodes": "string",
  • "retryExitCodes": "string",
  • "quarantineFolder": "string",
  • "onFailDisposition": 0,
  • "onExhaustionDisposition": 0,
  • "isEnabled": true,
  • "createdBy": "string",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "updatedBy": "string",
  • "updatedDate": "2019-08-24T14:15:22Z",
  • "deletedBy": "string",
  • "deletedDate": "2019-08-24T14:15:22Z"

  }

]

Creates a node command configuration

Requires node command configuration read and create permissions. Creates a configuration in an organization belonging to the caller's tenant; it does not assign the configuration to a node.

Authorizations:

ApiKeyBearer

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

Command configuration to create

id	integer <int32>
organizationId	integer <int32>
name	string or null
description	string or null
command	string or null
argumentsJson	string or null
workingDirectory	string or null
envAllowlistJson	string or null
timeoutSeconds	integer <int32>
retryCycles	integer <int32>
retryFirstIntervalSeconds	integer <int32>
retryBackoffEnabled	boolean
retryMaxIntervalSeconds	integer <int32>
successExitCodes	string or null
retryExitCodes	string or null
quarantineFolder	string or null
onFailDisposition	integer <int32>
onExhaustionDisposition	integer <int32>
isEnabled	boolean
createdBy	string or null
createdDate	string <date-time>
updatedBy	string or null
updatedDate	string or null <date-time>
deletedBy	string or null
deletedDate	string or null <date-time>

Responses

Response Schema:

application/jsontext/plaintext/jsonapplication/json

	object (NodeCommandConfigs)
nodeCapabilityWarning	string or null Set when an assigned node does not report the post-download-command capability. The configuration is saved either way; the node just does not receive it until it reports the capability.
applyJobId	string or null FlowApply job queued to re-apply the affected flows, or null when none was queued.
affectedFlowCount	integer <int32> Number of flows re-applied, or queued for re-apply.
applyErrors	Array of strings or null Set when the write committed but its flows could not all be re-applied, one entry per failure; null otherwise. The write stands either way.

https://us.thruinc.com/api/NodeCommandConfigs

https://uk.thruinc.com/api/NodeCommandConfigs

https://eu.thruinc.com/api/NodeCommandConfigs

https://au.thruinc.com/api/NodeCommandConfigs

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "id": 0,
• "organizationId": 0,
• "name": "string",
• "description": "string",
• "command": "string",
• "argumentsJson": "string",
• "workingDirectory": "string",
• "envAllowlistJson": "string",
• "timeoutSeconds": 0,
• "retryCycles": 0,
• "retryFirstIntervalSeconds": 0,
• "retryBackoffEnabled": true,
• "retryMaxIntervalSeconds": 0,
• "successExitCodes": "string",
• "retryExitCodes": "string",
• "quarantineFolder": "string",
• "onFailDisposition": 0,
• "onExhaustionDisposition": 0,
• "isEnabled": true,
• "createdBy": "string",
• "createdDate": "2019-08-24T14:15:22Z",
• "updatedBy": "string",
• "updatedDate": "2019-08-24T14:15:22Z",
• "deletedBy": "string",
• "deletedDate": "2019-08-24T14:15:22Z"

}

Response samples

• 200
• 403
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "config": {

  • "id": 0,
  • "organizationId": 0,
  • "name": "string",
  • "description": "string",
  • "command": "string",
  • "argumentsJson": "string",
  • "workingDirectory": "string",
  • "envAllowlistJson": "string",
  • "timeoutSeconds": 0,
  • "retryCycles": 0,
  • "retryFirstIntervalSeconds": 0,
  • "retryBackoffEnabled": true,
  • "retryMaxIntervalSeconds": 0,
  • "successExitCodes": "string",
  • "retryExitCodes": "string",
  • "quarantineFolder": "string",
  • "onFailDisposition": 0,
  • "onExhaustionDisposition": 0,
  • "isEnabled": true,
  • "createdBy": "string",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "updatedBy": "string",
  • "updatedDate": "2019-08-24T14:15:22Z",
  • "deletedBy": "string",
  • "deletedDate": "2019-08-24T14:15:22Z"

  },
• "nodeCapabilityWarning": "string",
• "applyJobId": "string",
• "affectedFlowCount": 0,
• "applyErrors": [

  • "string"

  ]

}

Updates a node command configuration and re-applies every flow on its assigned nodes

Requires node command configuration read, create, and update permissions. Re-applies flows after saving. When queued, use the returned ApplyJobId to track progress.

Authorizations:

ApiKeyBearer

query Parameters

queued

boolean Default: true Re-apply through a FlowApply job (default) rather than inline

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

Complete updated command configuration

id	integer <int32>
organizationId	integer <int32>
name	string or null
description	string or null
command	string or null
argumentsJson	string or null
workingDirectory	string or null
envAllowlistJson	string or null
timeoutSeconds	integer <int32>
retryCycles	integer <int32>
retryFirstIntervalSeconds	integer <int32>
retryBackoffEnabled	boolean
retryMaxIntervalSeconds	integer <int32>
successExitCodes	string or null
retryExitCodes	string or null
quarantineFolder	string or null
onFailDisposition	integer <int32>
onExhaustionDisposition	integer <int32>
isEnabled	boolean
createdBy	string or null
createdDate	string <date-time>
updatedBy	string or null
updatedDate	string or null <date-time>
deletedBy	string or null
deletedDate	string or null <date-time>

Responses

Response Schema:

application/jsontext/plaintext/jsonapplication/json

	object (NodeCommandConfigs)
nodeCapabilityWarning	string or null Set when an assigned node does not report the post-download-command capability. The configuration is saved either way; the node just does not receive it until it reports the capability.
applyJobId	string or null FlowApply job queued to re-apply the affected flows, or null when none was queued.
affectedFlowCount	integer <int32> Number of flows re-applied, or queued for re-apply.
applyErrors	Array of strings or null Set when the write committed but its flows could not all be re-applied, one entry per failure; null otherwise. The write stands either way.

https://us.thruinc.com/api/NodeCommandConfigs

https://uk.thruinc.com/api/NodeCommandConfigs

https://eu.thruinc.com/api/NodeCommandConfigs

https://au.thruinc.com/api/NodeCommandConfigs

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "id": 0,
• "organizationId": 0,
• "name": "string",
• "description": "string",
• "command": "string",
• "argumentsJson": "string",
• "workingDirectory": "string",
• "envAllowlistJson": "string",
• "timeoutSeconds": 0,
• "retryCycles": 0,
• "retryFirstIntervalSeconds": 0,
• "retryBackoffEnabled": true,
• "retryMaxIntervalSeconds": 0,
• "successExitCodes": "string",
• "retryExitCodes": "string",
• "quarantineFolder": "string",
• "onFailDisposition": 0,
• "onExhaustionDisposition": 0,
• "isEnabled": true,
• "createdBy": "string",
• "createdDate": "2019-08-24T14:15:22Z",
• "updatedBy": "string",
• "updatedDate": "2019-08-24T14:15:22Z",
• "deletedBy": "string",
• "deletedDate": "2019-08-24T14:15:22Z"

}

Response samples

• 200
• 403
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "config": {

  • "id": 0,
  • "organizationId": 0,
  • "name": "string",
  • "description": "string",
  • "command": "string",
  • "argumentsJson": "string",
  • "workingDirectory": "string",
  • "envAllowlistJson": "string",
  • "timeoutSeconds": 0,
  • "retryCycles": 0,
  • "retryFirstIntervalSeconds": 0,
  • "retryBackoffEnabled": true,
  • "retryMaxIntervalSeconds": 0,
  • "successExitCodes": "string",
  • "retryExitCodes": "string",
  • "quarantineFolder": "string",
  • "onFailDisposition": 0,
  • "onExhaustionDisposition": 0,
  • "isEnabled": true,
  • "createdBy": "string",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "updatedBy": "string",
  • "updatedDate": "2019-08-24T14:15:22Z",
  • "deletedBy": "string",
  • "deletedDate": "2019-08-24T14:15:22Z"

  },
• "nodeCapabilityWarning": "string",
• "applyJobId": "string",
• "affectedFlowCount": 0,
• "applyErrors": [

  • "string"

  ]

}

Retrieves the command configuration assigned to a node

Requires node command configuration read permission. Returns 204 when the node has no assigned configuration; the node must belong to the caller's tenant.

Authorizations:

ApiKeyBearer

path Parameters

nodeId required

integer <int32> org.ThruNodes.Id of the node

Responses

Response Schema:

application/jsontext/plaintext/jsonapplication/json

id	integer <int32>
organizationId	integer <int32>
name	string or null
description	string or null
command	string or null
argumentsJson	string or null
workingDirectory	string or null
envAllowlistJson	string or null
timeoutSeconds	integer <int32>
retryCycles	integer <int32>
retryFirstIntervalSeconds	integer <int32>
retryBackoffEnabled	boolean
retryMaxIntervalSeconds	integer <int32>
successExitCodes	string or null
retryExitCodes	string or null
quarantineFolder	string or null
onFailDisposition	integer <int32>
onExhaustionDisposition	integer <int32>
isEnabled	boolean
createdBy	string or null
createdDate	string <date-time>
updatedBy	string or null
updatedDate	string or null <date-time>
deletedBy	string or null
deletedDate	string or null <date-time>

https://us.thruinc.com/api/NodeCommandConfigs/node/{nodeId}

https://uk.thruinc.com/api/NodeCommandConfigs/node/{nodeId}

https://eu.thruinc.com/api/NodeCommandConfigs/node/{nodeId}

https://au.thruinc.com/api/NodeCommandConfigs/node/{nodeId}

Response samples

• 200
• 403
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "id": 0,
• "organizationId": 0,
• "name": "string",
• "description": "string",
• "command": "string",
• "argumentsJson": "string",
• "workingDirectory": "string",
• "envAllowlistJson": "string",
• "timeoutSeconds": 0,
• "retryCycles": 0,
• "retryFirstIntervalSeconds": 0,
• "retryBackoffEnabled": true,
• "retryMaxIntervalSeconds": 0,
• "successExitCodes": "string",
• "retryExitCodes": "string",
• "quarantineFolder": "string",
• "onFailDisposition": 0,
• "onExhaustionDisposition": 0,
• "isEnabled": true,
• "createdBy": "string",
• "createdDate": "2019-08-24T14:15:22Z",
• "updatedBy": "string",
• "updatedDate": "2019-08-24T14:15:22Z",
• "deletedBy": "string",
• "deletedDate": "2019-08-24T14:15:22Z"

}

Assigns a command configuration to a node and re-applies the node's flows

Requires node command configuration read and update permissions. The node and configuration must belong to the caller's tenant. Re-applies the node's flows after assignment.

Authorizations:

ApiKeyBearer

path Parameters

nodeCommandConfigId required	integer <int32> Unique identifier of the command configuration
nodeId required	integer <int32> org.ThruNodes.Id of the node

query Parameters

queued

boolean Default: true Re-apply through a FlowApply job (default) rather than inline

Responses

Response Schema:

application/jsontext/plaintext/jsonapplication/json

	object (NodeCommandConfigs)
nodeCapabilityWarning	string or null Set when an assigned node does not report the post-download-command capability. The configuration is saved either way; the node just does not receive it until it reports the capability.
applyJobId	string or null FlowApply job queued to re-apply the affected flows, or null when none was queued.
affectedFlowCount	integer <int32> Number of flows re-applied, or queued for re-apply.
applyErrors	Array of strings or null Set when the write committed but its flows could not all be re-applied, one entry per failure; null otherwise. The write stands either way.

https://us.thruinc.com/api/NodeCommandConfigs/{nodeCommandConfigId}/assignments/{nodeId}

https://uk.thruinc.com/api/NodeCommandConfigs/{nodeCommandConfigId}/assignments/{nodeId}

https://eu.thruinc.com/api/NodeCommandConfigs/{nodeCommandConfigId}/assignments/{nodeId}

https://au.thruinc.com/api/NodeCommandConfigs/{nodeCommandConfigId}/assignments/{nodeId}

Response samples

• 200
• 403
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "config": {

  • "id": 0,
  • "organizationId": 0,
  • "name": "string",
  • "description": "string",
  • "command": "string",
  • "argumentsJson": "string",
  • "workingDirectory": "string",
  • "envAllowlistJson": "string",
  • "timeoutSeconds": 0,
  • "retryCycles": 0,
  • "retryFirstIntervalSeconds": 0,
  • "retryBackoffEnabled": true,
  • "retryMaxIntervalSeconds": 0,
  • "successExitCodes": "string",
  • "retryExitCodes": "string",
  • "quarantineFolder": "string",
  • "onFailDisposition": 0,
  • "onExhaustionDisposition": 0,
  • "isEnabled": true,
  • "createdBy": "string",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "updatedBy": "string",
  • "updatedDate": "2019-08-24T14:15:22Z",
  • "deletedBy": "string",
  • "deletedDate": "2019-08-24T14:15:22Z"

  },
• "nodeCapabilityWarning": "string",
• "applyJobId": "string",
• "affectedFlowCount": 0,
• "applyErrors": [

  • "string"

  ]

}

Removes a command configuration from a node and re-applies the node's flows

Requires node command configuration read and update permissions. Removes the selected assignment and re-applies the node's flows; it does not delete the configuration.

Authorizations:

ApiKeyBearer

path Parameters

nodeCommandConfigId required	integer <int32> Unique identifier of the command configuration
nodeId required	integer <int32> org.ThruNodes.Id of the node

query Parameters

queued

boolean Default: true Re-apply through a FlowApply job (default) rather than inline

Responses

Response Schema:

application/jsontext/plaintext/jsonapplication/json

	object (NodeCommandConfigs)
nodeCapabilityWarning	string or null Set when an assigned node does not report the post-download-command capability. The configuration is saved either way; the node just does not receive it until it reports the capability.
applyJobId	string or null FlowApply job queued to re-apply the affected flows, or null when none was queued.
affectedFlowCount	integer <int32> Number of flows re-applied, or queued for re-apply.
applyErrors	Array of strings or null Set when the write committed but its flows could not all be re-applied, one entry per failure; null otherwise. The write stands either way.

https://us.thruinc.com/api/NodeCommandConfigs/{nodeCommandConfigId}/assignments/{nodeId}

https://uk.thruinc.com/api/NodeCommandConfigs/{nodeCommandConfigId}/assignments/{nodeId}

https://eu.thruinc.com/api/NodeCommandConfigs/{nodeCommandConfigId}/assignments/{nodeId}

https://au.thruinc.com/api/NodeCommandConfigs/{nodeCommandConfigId}/assignments/{nodeId}

Response samples

• 200
• 403
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "config": {

  • "id": 0,
  • "organizationId": 0,
  • "name": "string",
  • "description": "string",
  • "command": "string",
  • "argumentsJson": "string",
  • "workingDirectory": "string",
  • "envAllowlistJson": "string",
  • "timeoutSeconds": 0,
  • "retryCycles": 0,
  • "retryFirstIntervalSeconds": 0,
  • "retryBackoffEnabled": true,
  • "retryMaxIntervalSeconds": 0,
  • "successExitCodes": "string",
  • "retryExitCodes": "string",
  • "quarantineFolder": "string",
  • "onFailDisposition": 0,
  • "onExhaustionDisposition": 0,
  • "isEnabled": true,
  • "createdBy": "string",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "updatedBy": "string",
  • "updatedDate": "2019-08-24T14:15:22Z",
  • "deletedBy": "string",
  • "deletedDate": "2019-08-24T14:15:22Z"

  },
• "nodeCapabilityWarning": "string",
• "applyJobId": "string",
• "affectedFlowCount": 0,
• "applyErrors": [

  • "string"

  ]

}

Retrieves the node assignments of a command configuration

Requires node command configuration read permission. Returns the configuration's live node assignments within the caller's tenant.

Authorizations:

ApiKeyBearer

path Parameters

nodeCommandConfigId required

integer <int32> Unique identifier of the command configuration

Responses

Response Schema:

application/jsontext/plaintext/jsonapplication/json

Array

id	integer <int32>
organizationId	integer <int32>
nodeCommandConfigId	integer <int32>
targetType	integer <int32>
nodeId	integer or null <int32>
flowEndpointId	integer or null <int32>
createdBy	string or null
createdDate	string <date-time>
updatedBy	string or null
updatedDate	string or null <date-time>
deletedBy	string or null
deletedDate	string or null <date-time>

https://us.thruinc.com/api/NodeCommandConfigs/{nodeCommandConfigId}/assignments

https://uk.thruinc.com/api/NodeCommandConfigs/{nodeCommandConfigId}/assignments

https://eu.thruinc.com/api/NodeCommandConfigs/{nodeCommandConfigId}/assignments

https://au.thruinc.com/api/NodeCommandConfigs/{nodeCommandConfigId}/assignments

Response samples

• 200
• 403
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

[

• {

  • "id": 0,
  • "organizationId": 0,
  • "nodeCommandConfigId": 0,
  • "targetType": 0,
  • "nodeId": 0,
  • "flowEndpointId": 0,
  • "createdBy": "string",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "updatedBy": "string",
  • "updatedDate": "2019-08-24T14:15:22Z",
  • "deletedBy": "string",
  • "deletedDate": "2019-08-24T14:15:22Z"

  }

]

Saves a command configuration (creates when ID is 0, otherwise updates), optionally assigns it to a node, and re-applies every flow on its assigned nodes

Save and assignment commit in one transaction; the re-apply runs after the commit. Track a queued re-apply with NodeCommandConfigs_GetApplyJobStatus.

Authorizations:

ApiKeyBearer

query Parameters

queued

boolean Default: true Re-apply through a FlowApply job (default) rather than inline

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

Configuration to save and an optional node to assign it to

	object (NodeCommandConfigs)
nodeId	integer or null <int32> Optional org.ThruNodes.Id to assign the configuration to, in the same transaction as the save.

Responses

Response Schema:

application/jsontext/plaintext/jsonapplication/json

	object (NodeCommandConfigs)
nodeCapabilityWarning	string or null Set when an assigned node does not report the post-download-command capability. The configuration is saved either way; the node just does not receive it until it reports the capability.
applyJobId	string or null FlowApply job queued to re-apply the affected flows, or null when none was queued.
affectedFlowCount	integer <int32> Number of flows re-applied, or queued for re-apply.
applyErrors	Array of strings or null Set when the write committed but its flows could not all be re-applied, one entry per failure; null otherwise. The write stands either way.

https://us.thruinc.com/api/NodeCommandConfigs/saveAndApply

https://uk.thruinc.com/api/NodeCommandConfigs/saveAndApply

https://eu.thruinc.com/api/NodeCommandConfigs/saveAndApply

https://au.thruinc.com/api/NodeCommandConfigs/saveAndApply

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "config": {

  • "id": 0,
  • "organizationId": 0,
  • "name": "string",
  • "description": "string",
  • "command": "string",
  • "argumentsJson": "string",
  • "workingDirectory": "string",
  • "envAllowlistJson": "string",
  • "timeoutSeconds": 0,
  • "retryCycles": 0,
  • "retryFirstIntervalSeconds": 0,
  • "retryBackoffEnabled": true,
  • "retryMaxIntervalSeconds": 0,
  • "successExitCodes": "string",
  • "retryExitCodes": "string",
  • "quarantineFolder": "string",
  • "onFailDisposition": 0,
  • "onExhaustionDisposition": 0,
  • "isEnabled": true,
  • "createdBy": "string",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "updatedBy": "string",
  • "updatedDate": "2019-08-24T14:15:22Z",
  • "deletedBy": "string",
  • "deletedDate": "2019-08-24T14:15:22Z"

  },
• "nodeId": 0

}

Response samples

• 200
• 403
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "config": {

  • "id": 0,
  • "organizationId": 0,
  • "name": "string",
  • "description": "string",
  • "command": "string",
  • "argumentsJson": "string",
  • "workingDirectory": "string",
  • "envAllowlistJson": "string",
  • "timeoutSeconds": 0,
  • "retryCycles": 0,
  • "retryFirstIntervalSeconds": 0,
  • "retryBackoffEnabled": true,
  • "retryMaxIntervalSeconds": 0,
  • "successExitCodes": "string",
  • "retryExitCodes": "string",
  • "quarantineFolder": "string",
  • "onFailDisposition": 0,
  • "onExhaustionDisposition": 0,
  • "isEnabled": true,
  • "createdBy": "string",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "updatedBy": "string",
  • "updatedDate": "2019-08-24T14:15:22Z",
  • "deletedBy": "string",
  • "deletedDate": "2019-08-24T14:15:22Z"

  },
• "nodeCapabilityWarning": "string",
• "applyJobId": "string",
• "affectedFlowCount": 0,
• "applyErrors": [

  • "string"

  ]

}

Retrieves the status and results of a FlowApply job queued by a command configuration change

Requires node command configuration read permission. Only command configuration apply jobs belonging to the caller's tenant can be retrieved through this operation.

Authorizations:

ApiKeyBearer

path Parameters

jobId required

string Job ID returned as ApplyJobId

Responses

Response Schema:

application/jsontext/plaintext/jsonapplication/json

jobId	string or null Unique identifier for the job
status	string or null Current status of the job (Queued, Processing, Completed, Failed)
endpointId	integer or null <int32> ID of the endpoint associated with this job
endpointName	string or null Name of the endpoint associated with this job
createdAt	string <date-time> Timestamp when the job was created
completedAt	string or null <date-time> Timestamp when the job was completed (if completed)
errorMessage	string or null Error message if the job failed
	Array of objects or null (FlowApplyResultDto) List of flow application results

https://us.thruinc.com/api/NodeCommandConfigs/applyJob/{jobId}

https://uk.thruinc.com/api/NodeCommandConfigs/applyJob/{jobId}

https://eu.thruinc.com/api/NodeCommandConfigs/applyJob/{jobId}

https://au.thruinc.com/api/NodeCommandConfigs/applyJob/{jobId}

Response samples

• 200
• 403
• 404
• 500

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "jobId": "string",
• "status": "string",
• "endpointId": 0,
• "endpointName": "string",
• "createdAt": "2019-08-24T14:15:22Z",
• "completedAt": "2019-08-24T14:15:22Z",
• "errorMessage": "string",
• "results": [

  • {

    • "flowId": 0,
    • "flowName": "string",
    • "success": true,
    • "message": "string"

    }

  ]

}