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

Toggle Pane

• FlowEndpointAntiVirusOptions
  • getRetrieves a specific anti-virus configuration by ID
  • delDeletes a specific anti-virus configuration
  • getRetrieves all anti-virus configurations for a specific flow endpoint
  • postCreates a new anti-virus configuration for a flow endpoint
  • putUpdates an existing anti-virus configuration for a flow endpoint
  • putSaves anti-virus configuration (creates new or updates existing based on ID)
  • delDeletes all anti-virus configurations for a specific flow endpoint

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.

FlowEndpointAntiVirusOptions

Retrieves a specific anti-virus configuration by ID

Returns anti-virus scanning configuration for a specific flow endpoint.

Authorizations:

ApiKeyBearer

path Parameters

flowEndpointAntiVirusOptionId required

integer <int32> Unique identifier of the anti-virus configuration

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

id	integer <int32>
flowEndpointId	integer <int32>
isEnabled	boolean
createdBy	string or null
createdDate	string or null <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/FlowEndpointAntiVirusOptions/{flowEndpointAntiVirusOptionId}

https://uk.thruinc.com/api/FlowEndpointAntiVirusOptions/{flowEndpointAntiVirusOptionId}

https://eu.thruinc.com/api/FlowEndpointAntiVirusOptions/{flowEndpointAntiVirusOptionId}

https://au.thruinc.com/api/FlowEndpointAntiVirusOptions/{flowEndpointAntiVirusOptionId}

Response samples

• 200
• 403
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Deletes a specific anti-virus configuration

Removes anti-virus configuration from flow endpoint.

Authorizations:

ApiKeyBearer

path Parameters

flowEndpointAntiVirusOptionId required

integer <int32> Unique identifier of the anti-virus configuration to delete

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

	object (thruStatus)
data	any or null

https://us.thruinc.com/api/FlowEndpointAntiVirusOptions/{flowEndpointAntiVirusOptionId}

https://uk.thruinc.com/api/FlowEndpointAntiVirusOptions/{flowEndpointAntiVirusOptionId}

https://eu.thruinc.com/api/FlowEndpointAntiVirusOptions/{flowEndpointAntiVirusOptionId}

https://au.thruinc.com/api/FlowEndpointAntiVirusOptions/{flowEndpointAntiVirusOptionId}

Response samples

• 200
• 403
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Retrieves all anti-virus configurations for a specific flow endpoint

Returns anti-virus configuration for a specific flow endpoint including enabled status.

Authorizations:

ApiKeyBearer

query Parameters

flowEndpointId

integer <int32> Unique identifier of the flow endpoint

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

Array

id	integer <int32>
flowEndpointId	integer <int32>
isEnabled	boolean
createdBy	string or null
createdDate	string or null <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/FlowEndpointAntiVirusOptions/getByFlowEndpointId

https://uk.thruinc.com/api/FlowEndpointAntiVirusOptions/getByFlowEndpointId

https://eu.thruinc.com/api/FlowEndpointAntiVirusOptions/getByFlowEndpointId

https://au.thruinc.com/api/FlowEndpointAntiVirusOptions/getByFlowEndpointId

Response samples

• 200
• 403
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Creates a new anti-virus configuration for a flow endpoint

Establishes new anti-virus scanning configuration for file security.

Authorizations:

ApiKeyBearer

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

Anti-virus configuration details including scanning rules and file type filters

id	integer <int32>
flowEndpointId	integer <int32>
isEnabled	boolean
createdBy	string or null
createdDate	string or null <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:

text/plainapplication/jsontext/jsontext/plain

id	integer <int32>
flowEndpointId	integer <int32>
isEnabled	boolean
createdBy	string or null
createdDate	string or null <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/FlowEndpointAntiVirusOptions

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

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

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

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "id": 0,
• "flowEndpointId": 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

text/plainapplication/jsontext/jsontext/plain

No sample

Updates an existing anti-virus configuration for a flow endpoint

Modifies existing anti-virus configuration including scan settings.

Authorizations:

ApiKeyBearer

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

Updated anti-virus configuration details

id	integer <int32>
flowEndpointId	integer <int32>
isEnabled	boolean
createdBy	string or null
createdDate	string or null <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:

text/plainapplication/jsontext/jsontext/plain

id	integer <int32>
flowEndpointId	integer <int32>
isEnabled	boolean
createdBy	string or null
createdDate	string or null <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/FlowEndpointAntiVirusOptions

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

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

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

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "id": 0,
• "flowEndpointId": 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

text/plainapplication/jsontext/jsontext/plain

No sample

Saves anti-virus configuration (creates new or updates existing based on ID)

Performs upsert operation: creates new configuration if ID is 0, otherwise updates existing configuration

Authorizations:

ApiKeyBearer

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

Anti-virus configuration to save (performs upsert based on record ID)

id	integer <int32>
flowEndpointId	integer <int32>
isEnabled	boolean
createdBy	string or null
createdDate	string or null <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:

text/plainapplication/jsontext/jsontext/plain

id	integer <int32>
flowEndpointId	integer <int32>
isEnabled	boolean
createdBy	string or null
createdDate	string or null <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/FlowEndpointAntiVirusOptions/save

https://uk.thruinc.com/api/FlowEndpointAntiVirusOptions/save

https://eu.thruinc.com/api/FlowEndpointAntiVirusOptions/save

https://au.thruinc.com/api/FlowEndpointAntiVirusOptions/save

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "id": 0,
• "flowEndpointId": 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

text/plainapplication/jsontext/jsontext/plain

No sample

Deletes all anti-virus configurations for a specific flow endpoint

Removes all anti-virus configurations from a flow endpoint.

Authorizations:

ApiKeyBearer

query Parameters

flowEndpointId

integer <int32> Unique identifier of the flow endpoint to remove all anti-virus configurations for

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

	object (thruStatus)
data	any or null

https://us.thruinc.com/api/FlowEndpointAntiVirusOptions/deleteByFlowEndpointId

https://uk.thruinc.com/api/FlowEndpointAntiVirusOptions/deleteByFlowEndpointId

https://eu.thruinc.com/api/FlowEndpointAntiVirusOptions/deleteByFlowEndpointId

https://au.thruinc.com/api/FlowEndpointAntiVirusOptions/deleteByFlowEndpointId

Response samples

• 200
• 403
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample