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

Toggle Pane

• EndpointOptions
  • getRetrieves all available protocols for endpoint configuration
  • getRetrieves configuration options for a specific protocol
  • getRetrieves all protocol types
  • getRetrieves the server path configuration
  • getRetrieves available AWS S3 regions for endpoint configuration
  • getRetrieves available Azure Blob Storage authentication types for endpoints

API docs by Redocly

Download OpenAPI Specification: Download

EndpointOptions

Retrieves all available protocols for endpoint configuration

Authorizations:

ApiKeyBearer

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

Array

id	integer <int32>
name	string or null
displayOrder	integer <int32>
description	string or null

https://us.thruinc.com/api/EndpointOptions/getProtocols

https://uk.thruinc.com/api/EndpointOptions/getProtocols

https://eu.thruinc.com/api/EndpointOptions/getProtocols

https://au.thruinc.com/api/EndpointOptions/getProtocols

Response samples

• 200
• 401
• 403
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Retrieves configuration options for a specific protocol

Authorizations:

ApiKeyBearer

query Parameters

protocolId

integer <int32> Unique identifier of the protocol to get options for

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

protocolId	integer <int32>
	Array of objects or null (EndpointTypes)

https://us.thruinc.com/api/EndpointOptions/getProtocolOptionsForProtocol

https://uk.thruinc.com/api/EndpointOptions/getProtocolOptionsForProtocol

https://eu.thruinc.com/api/EndpointOptions/getProtocolOptionsForProtocol

https://au.thruinc.com/api/EndpointOptions/getProtocolOptionsForProtocol

Response samples

• 200
• 403
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Retrieves all protocol types

Authorizations:

ApiKeyBearer

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

Array

	object (vwProtocolsList)
	object (ProtocolTypeViewItem)

https://us.thruinc.com/api/EndpointOptions/getAllProtocolTypes

https://uk.thruinc.com/api/EndpointOptions/getAllProtocolTypes

https://eu.thruinc.com/api/EndpointOptions/getAllProtocolTypes

https://au.thruinc.com/api/EndpointOptions/getAllProtocolTypes

Response samples

• 200
• 401
• 403
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Retrieves the server path configuration

Authorizations:

ApiKeyBearer

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

string

https://us.thruinc.com/api/EndpointOptions/getThruServerPath

https://uk.thruinc.com/api/EndpointOptions/getThruServerPath

https://eu.thruinc.com/api/EndpointOptions/getThruServerPath

https://au.thruinc.com/api/EndpointOptions/getThruServerPath

Response samples

• 200
• 401
• 403
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Retrieves available AWS S3 regions for endpoint configuration

Authorizations:

ApiKeyBearer

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

Array

id	integer <int32>
name	string or null
region	string or null
endpoint	string or null
protocol	string or null
description	string or null

https://us.thruinc.com/api/EndpointOptions/getS3Regions

https://uk.thruinc.com/api/EndpointOptions/getS3Regions

https://eu.thruinc.com/api/EndpointOptions/getS3Regions

https://au.thruinc.com/api/EndpointOptions/getS3Regions

Response samples

• 200
• 401
• 403
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Retrieves available Azure Blob Storage authentication types for endpoints

Authorizations:

ApiKeyBearer

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

Array

id	integer <int32>
name	string or null
description	string or null

https://us.thruinc.com/api/EndpointOptions/getAzureBlobAuthTypes

https://uk.thruinc.com/api/EndpointOptions/getAzureBlobAuthTypes

https://eu.thruinc.com/api/EndpointOptions/getAzureBlobAuthTypes

https://au.thruinc.com/api/EndpointOptions/getAzureBlobAuthTypes

Response samples

• 200
• 401
• 403
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample