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

Toggle Pane

• FlowEndpointEncryptionOptions
  • getRetrieves a specific encryption configuration by ID
  • delDeletes a specific encryption configuration
  • getRetrieves encryption configuration for a specific flow endpoint
  • postCreates a new encryption configuration for a flow endpoint
  • putUpdates an existing encryption configuration for a flow endpoint
  • putSaves encryption configuration (creates new or updates existing based on ID)
  • delDeletes all encryption 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.

FlowEndpointEncryptionOptions

Retrieves a specific encryption configuration by ID

Returns encryption configuration including PGP key assignments and verification settings.

Authorizations:

ApiKeyBearer

path Parameters

flowEndpointEncryptionOptionId required

integer <int32> Unique identifier of the encryption configuration

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

id	integer <int32>
flowEndpointId	integer <int32>
pgpKeyId	integer <int32>
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>
isVerify	boolean
verifyPgpKeyId	integer or null <int32>
isSign	boolean
signPgpKeyId	integer or null <int32>
isAsciiArmor	boolean

https://us.thruinc.com/api/FlowEndpointEncryptionOptions/{flowEndpointEncryptionOptionId}

https://uk.thruinc.com/api/FlowEndpointEncryptionOptions/{flowEndpointEncryptionOptionId}

https://eu.thruinc.com/api/FlowEndpointEncryptionOptions/{flowEndpointEncryptionOptionId}

https://au.thruinc.com/api/FlowEndpointEncryptionOptions/{flowEndpointEncryptionOptionId}

Response samples

• 200
• 403
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Deletes a specific encryption configuration

Removes encryption configuration from flow endpoint.

Authorizations:

ApiKeyBearer

path Parameters

flowEndpointEncryptionOptionId required

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

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

	object (thruStatus)
data	any or null

https://us.thruinc.com/api/FlowEndpointEncryptionOptions/{flowEndpointEncryptionOptionId}

https://uk.thruinc.com/api/FlowEndpointEncryptionOptions/{flowEndpointEncryptionOptionId}

https://eu.thruinc.com/api/FlowEndpointEncryptionOptions/{flowEndpointEncryptionOptionId}

https://au.thruinc.com/api/FlowEndpointEncryptionOptions/{flowEndpointEncryptionOptionId}

Response samples

• 200
• 403
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Retrieves encryption configuration for a specific flow endpoint

Returns encryption configuration for a specific flow endpoint.

Authorizations:

ApiKeyBearer

query Parameters

flowEndpointId

integer <int32> Unique identifier of the flow endpoint

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

id	integer <int32>
flowEndpointId	integer <int32>
pgpKeyId	integer <int32>
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>
isVerify	boolean
verifyPgpKeyId	integer or null <int32>
isSign	boolean
signPgpKeyId	integer or null <int32>
isAsciiArmor	boolean

https://us.thruinc.com/api/FlowEndpointEncryptionOptions/getByFlowEndpointId

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

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

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

Response samples

• 200
• 403
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Creates a new encryption configuration for a flow endpoint

Establishes new encryption configuration with PGP key and signing settings.

Authorizations:

ApiKeyBearer

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

Encryption configuration details including algorithms and key management settings

id	integer <int32>
flowEndpointId	integer <int32>
pgpKeyId	integer <int32>
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>
isVerify	boolean
verifyPgpKeyId	integer or null <int32>
isSign	boolean
signPgpKeyId	integer or null <int32>
isAsciiArmor	boolean

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

id	integer <int32>
flowEndpointId	integer <int32>
pgpKeyId	integer <int32>
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>
isVerify	boolean
verifyPgpKeyId	integer or null <int32>
isSign	boolean
signPgpKeyId	integer or null <int32>
isAsciiArmor	boolean

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

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

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

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

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "id": 0,
• "flowEndpointId": 0,
• "pgpKeyId": 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",
• "isVerify": true,
• "verifyPgpKeyId": 0,
• "isSign": true,
• "signPgpKeyId": 0,
• "isAsciiArmor": true

}

Response samples

• 200
• 403
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Updates an existing encryption configuration for a flow endpoint

Modifies existing encryption configuration including key assignments and verification.

Authorizations:

ApiKeyBearer

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

Updated encryption configuration details

id	integer <int32>
flowEndpointId	integer <int32>
pgpKeyId	integer <int32>
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>
isVerify	boolean
verifyPgpKeyId	integer or null <int32>
isSign	boolean
signPgpKeyId	integer or null <int32>
isAsciiArmor	boolean

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

id	integer <int32>
flowEndpointId	integer <int32>
pgpKeyId	integer <int32>
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>
isVerify	boolean
verifyPgpKeyId	integer or null <int32>
isSign	boolean
signPgpKeyId	integer or null <int32>
isAsciiArmor	boolean

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

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

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

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

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "id": 0,
• "flowEndpointId": 0,
• "pgpKeyId": 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",
• "isVerify": true,
• "verifyPgpKeyId": 0,
• "isSign": true,
• "signPgpKeyId": 0,
• "isAsciiArmor": true

}

Response samples

• 200
• 403
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Saves encryption 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

Encryption configuration to save (performs upsert based on record ID)

id	integer <int32>
flowEndpointId	integer <int32>
pgpKeyId	integer <int32>
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>
isVerify	boolean
verifyPgpKeyId	integer or null <int32>
isSign	boolean
signPgpKeyId	integer or null <int32>
isAsciiArmor	boolean

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

id	integer <int32>
flowEndpointId	integer <int32>
pgpKeyId	integer <int32>
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>
isVerify	boolean
verifyPgpKeyId	integer or null <int32>
isSign	boolean
signPgpKeyId	integer or null <int32>
isAsciiArmor	boolean

https://us.thruinc.com/api/FlowEndpointEncryptionOptions/save

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

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

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

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "id": 0,
• "flowEndpointId": 0,
• "pgpKeyId": 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",
• "isVerify": true,
• "verifyPgpKeyId": 0,
• "isSign": true,
• "signPgpKeyId": 0,
• "isAsciiArmor": true

}

Response samples

• 200
• 403
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Deletes all encryption configurations for a specific flow endpoint

Removes all encryption configurations from a flow endpoint.

Authorizations:

ApiKeyBearer

query Parameters

flowEndpointId

integer <int32> Unique identifier of the flow endpoint to remove all encryption configurations for

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

	object (thruStatus)
data	any or null

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

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

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

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

Response samples

• 200
• 403
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample