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

Toggle Pane

• Endpoints
  • getRetrieves a specific endpoint configuration by ID
  • delDeletes an endpoint configuration and removes all associated data
  • getRetrieves all endpoints for a specific organization
  • getRetrieves endpoints for a specific node within an organization
  • putUpdates an existing endpoint configuration
  • postCreates a new endpoint configuration
  • getRetrieves the internal server path configuration for endpoint setup
  • getRetrieves the public API path configuration for endpoint integration
  • getDownloads the V1 installer package for endpoint deployment
  • getRetrieves the V1 configuration data for a specific endpoint
  • postRegenerates the transport client secret for an endpoint
  • postTests SFTP connection using the provided endpoint configuration
  • postTests FTPS connection using the provided endpoint configuration
  • postTests Amazon S3 connection using the provided endpoint configuration
  • postTests Azure Blob Storage connection using the provided endpoint configuration
  • postTests Azure Files connection using the provided endpoint configuration
  • postTests SharePoint connection using the provided endpoint configuration
  • postTests file share connection using the provided endpoint configuration
  • postTests Google Cloud Storage connection using the provided endpoint configuration
  • postTests LAN connection using the provided endpoint configuration
  • getRetrieves recent activity data for all accessible endpoints
  • getRetrieves all flows associated with a specific endpoint
  • putSaves endpoint configuration and applies flows synchronously
  • putSaves endpoint configuration and applies flows asynchronously
  • getRetrieves the status and results of an asynchronous flow application job

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.

Endpoints

Retrieves a specific endpoint configuration by ID

Requires organization endpoint read permissions to access endpoint configuration data.

Authorizations:

ApiKeyBearer

path Parameters

endpointId required

integer <int32> The unique identifier of the endpoint to retrieve

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

id	integer <int32>
organizationId	integer <int32>
name	string or null
code	string or null
location	string or null
ipAddress	string or null
cidRmask	integer or null <int32>
description	string or null
thruNodeId	string or null
protocolId	integer <int32>
endpointTypeId	integer <int32>
isEnabled	boolean
s3BucketName	string or null
s3AccessKey	string or null
s3SecretKey	string or null
s3RegionTypeId	integer <int32>
s3ServiceUrl	string or null
transferSecretKey	string or null
transferInstallationKey	string or null
ftpsClientIPAddress	string or null
ftpsClientHost	string or null
ftpsClientPort	integer <int32>
ftpsClientUser	string or null
ftpsClientPassword	string or null
ftpsClientAuthTypeId	integer <int32>
ftpsClientCertificateId	integer or null <int32>
sftpClientIPAddress	string or null
sftpClientHost	string or null
sftpClientPort	integer <int32>
sftpClientUser	string or null
sftpUserPassword	string or null
sftpClientAuthTypeId	integer <int32>
sftpClientSshKeyId	integer or null <int32>
sftpAllowSimultaneousTransfers	boolean
aS2RemoteUrl	string or null
aS2RemoteOrgIdentifier	string or null
aS2PublicCertificate	string or null
mailTo	string or null
mailCC	string or null
mailBCC	string or null
mailSubject	string or null
mailMessage	string or null
mailLinkExpirationId	integer <int32>
azureAuthTypeId	integer <int32>
azureAccessKey	string or null
azureConnectionString	string or null
azureContainerName	string or null
azureContainerUrl	string or null
azureStorageAccountName	string or null
azureSharedAccessToken	string or null
azureBlobClientId	string or null
azureBlobClientSecret	string or null
azureBlobTenantId	string or null
externalIdpTokenEndpoint	string or null
externalIdpClientId	string or null
externalIdpClientSecret	string or null
externalIdpScope	string or null
azureFilesShareName	string or null
azureFilesShareUrl	string or null
httpServerUrl	string or null
httpClientUrl	string or null
lanNetworkSharePath	string or null
lanDomain	string or null
lanUsername	string or null
lanPassword	string or null
sharePointTenantName	string or null
sharePointSiteUrl	string or null
sharePointClientId	string or null
sharePointClientSecret	string or null
sharePointDocumentLibrary	string or null
thruFileShareSiteUrl	string or null
thruFileShareUsername	string or null
thruFileSharePassword	string or null
googleCloudStorageBucketName	string or null
googleCloudStorageServiceAccountKeyJson	string or null

https://us.thruinc.com/api/Endpoints/{endpointId}

https://uk.thruinc.com/api/Endpoints/{endpointId}

https://eu.thruinc.com/api/Endpoints/{endpointId}

https://au.thruinc.com/api/Endpoints/{endpointId}

Response samples

• 200
• 401
• 403
• 404
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Deletes an endpoint configuration and removes all associated data

Requires organization endpoint delete permissions to remove endpoint configurations.

Authorizations:

ApiKeyBearer

path Parameters

endpointId required

integer <int32> Unique identifier of the endpoint to delete

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

	object (thruStatus)
data	any or null

https://us.thruinc.com/api/Endpoints/{endpointId}

https://uk.thruinc.com/api/Endpoints/{endpointId}

https://eu.thruinc.com/api/Endpoints/{endpointId}

https://au.thruinc.com/api/Endpoints/{endpointId}

Response samples

• 200
• 401
• 403
• 404
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Retrieves all endpoints for a specific organization

Requires organization endpoint read permissions to access endpoint configurations.

Authorizations:

ApiKeyBearer

query Parameters

organizationId

integer <int32> The unique identifier of the organization

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

Array

type	string or null
status	string or null
id	integer <int32>
organizationId	integer <int32>
endpointTypeId	integer <int32>
endpointStatusId	integer <int32>
name	string or null
code	string or null
description	string or null
thruNodeId	string or null
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/Endpoints/getEndpoints

https://uk.thruinc.com/api/Endpoints/getEndpoints

https://eu.thruinc.com/api/Endpoints/getEndpoints

https://au.thruinc.com/api/Endpoints/getEndpoints

Response samples

• 200
• 401
• 403
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Retrieves endpoints for a specific node within an organization

Requires organization endpoint read permissions to access node endpoint data.

Authorizations:

ApiKeyBearer

query Parameters

organizationId	integer <int32> The unique identifier of the organization
nodeId	integer <int32> The unique identifier of the node

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

Array

type	string or null
status	string or null
id	integer <int32>
organizationId	integer <int32>
endpointTypeId	integer <int32>
endpointStatusId	integer <int32>
name	string or null
code	string or null
description	string or null
thruNodeId	string or null
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/Endpoints/getThruNodeEndpoints

https://uk.thruinc.com/api/Endpoints/getThruNodeEndpoints

https://eu.thruinc.com/api/Endpoints/getThruNodeEndpoints

https://au.thruinc.com/api/Endpoints/getThruNodeEndpoints

Response samples

• 200
• 401
• 403
• 404
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Updates an existing endpoint configuration

Requires organization endpoint update permissions to modify endpoint configurations. Request body must contain valid EndpointEditorViewModel data.

Authorizations:

ApiKeyBearer

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

Updated endpoint configuration including connection details, authentication settings, and processing options

id	integer <int32>
organizationId	integer <int32>
name	string or null
code	string or null
location	string or null
ipAddress	string or null
cidRmask	integer or null <int32>
description	string or null
thruNodeId	string or null
protocolId	integer <int32>
endpointTypeId	integer <int32>
isEnabled	boolean
s3BucketName	string or null
s3AccessKey	string or null
s3SecretKey	string or null
s3RegionTypeId	integer <int32>
s3ServiceUrl	string or null
transferSecretKey	string or null
transferInstallationKey	string or null
ftpsClientIPAddress	string or null
ftpsClientHost	string or null
ftpsClientPort	integer <int32>
ftpsClientUser	string or null
ftpsClientPassword	string or null
ftpsClientAuthTypeId	integer <int32>
ftpsClientCertificateId	integer or null <int32>
sftpClientIPAddress	string or null
sftpClientHost	string or null
sftpClientPort	integer <int32>
sftpClientUser	string or null
sftpUserPassword	string or null
sftpClientAuthTypeId	integer <int32>
sftpClientSshKeyId	integer or null <int32>
sftpAllowSimultaneousTransfers	boolean
aS2RemoteUrl	string or null
aS2RemoteOrgIdentifier	string or null
aS2PublicCertificate	string or null
mailTo	string or null
mailCC	string or null
mailBCC	string or null
mailSubject	string or null
mailMessage	string or null
mailLinkExpirationId	integer <int32>
azureAuthTypeId	integer <int32>
azureAccessKey	string or null
azureConnectionString	string or null
azureContainerName	string or null
azureContainerUrl	string or null
azureStorageAccountName	string or null
azureSharedAccessToken	string or null
azureBlobClientId	string or null
azureBlobClientSecret	string or null
azureBlobTenantId	string or null
externalIdpTokenEndpoint	string or null
externalIdpClientId	string or null
externalIdpClientSecret	string or null
externalIdpScope	string or null
azureFilesShareName	string or null
azureFilesShareUrl	string or null
httpServerUrl	string or null
httpClientUrl	string or null
lanNetworkSharePath	string or null
lanDomain	string or null
lanUsername	string or null
lanPassword	string or null
sharePointTenantName	string or null
sharePointSiteUrl	string or null
sharePointClientId	string or null
sharePointClientSecret	string or null
sharePointDocumentLibrary	string or null
thruFileShareSiteUrl	string or null
thruFileShareUsername	string or null
thruFileSharePassword	string or null
googleCloudStorageBucketName	string or null
googleCloudStorageServiceAccountKeyJson	string or null

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

id	integer <int32>
organizationId	integer <int32>
name	string or null
code	string or null
location	string or null
ipAddress	string or null
cidRmask	integer or null <int32>
description	string or null
thruNodeId	string or null
protocolId	integer <int32>
endpointTypeId	integer <int32>
isEnabled	boolean
s3BucketName	string or null
s3AccessKey	string or null
s3SecretKey	string or null
s3RegionTypeId	integer <int32>
s3ServiceUrl	string or null
transferSecretKey	string or null
transferInstallationKey	string or null
ftpsClientIPAddress	string or null
ftpsClientHost	string or null
ftpsClientPort	integer <int32>
ftpsClientUser	string or null
ftpsClientPassword	string or null
ftpsClientAuthTypeId	integer <int32>
ftpsClientCertificateId	integer or null <int32>
sftpClientIPAddress	string or null
sftpClientHost	string or null
sftpClientPort	integer <int32>
sftpClientUser	string or null
sftpUserPassword	string or null
sftpClientAuthTypeId	integer <int32>
sftpClientSshKeyId	integer or null <int32>
sftpAllowSimultaneousTransfers	boolean
aS2RemoteUrl	string or null
aS2RemoteOrgIdentifier	string or null
aS2PublicCertificate	string or null
mailTo	string or null
mailCC	string or null
mailBCC	string or null
mailSubject	string or null
mailMessage	string or null
mailLinkExpirationId	integer <int32>
azureAuthTypeId	integer <int32>
azureAccessKey	string or null
azureConnectionString	string or null
azureContainerName	string or null
azureContainerUrl	string or null
azureStorageAccountName	string or null
azureSharedAccessToken	string or null
azureBlobClientId	string or null
azureBlobClientSecret	string or null
azureBlobTenantId	string or null
externalIdpTokenEndpoint	string or null
externalIdpClientId	string or null
externalIdpClientSecret	string or null
externalIdpScope	string or null
azureFilesShareName	string or null
azureFilesShareUrl	string or null
httpServerUrl	string or null
httpClientUrl	string or null
lanNetworkSharePath	string or null
lanDomain	string or null
lanUsername	string or null
lanPassword	string or null
sharePointTenantName	string or null
sharePointSiteUrl	string or null
sharePointClientId	string or null
sharePointClientSecret	string or null
sharePointDocumentLibrary	string or null
thruFileShareSiteUrl	string or null
thruFileShareUsername	string or null
thruFileSharePassword	string or null
googleCloudStorageBucketName	string or null
googleCloudStorageServiceAccountKeyJson	string or null

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

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

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

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

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "id": 0,
• "organizationId": 0,
• "name": "string",
• "code": "string",
• "location": "string",
• "ipAddress": "string",
• "cidRmask": 0,
• "description": "string",
• "thruNodeId": "string",
• "protocolId": 0,
• "endpointTypeId": 0,
• "isEnabled": true,
• "s3BucketName": "string",
• "s3AccessKey": "string",
• "s3SecretKey": "string",
• "s3RegionTypeId": 0,
• "s3ServiceUrl": "string",
• "transferSecretKey": "string",
• "transferInstallationKey": "string",
• "ftpsClientIPAddress": "string",
• "ftpsClientHost": "string",
• "ftpsClientPort": 0,
• "ftpsClientUser": "string",
• "ftpsClientPassword": "string",
• "ftpsClientAuthTypeId": 0,
• "ftpsClientCertificateId": 0,
• "sftpClientIPAddress": "string",
• "sftpClientHost": "string",
• "sftpClientPort": 0,
• "sftpClientUser": "string",
• "sftpUserPassword": "string",
• "sftpClientAuthTypeId": 0,
• "sftpClientSshKeyId": 0,
• "sftpAllowSimultaneousTransfers": true,
• "aS2RemoteUrl": "string",
• "aS2RemoteOrgIdentifier": "string",
• "aS2PublicCertificate": "string",
• "mailTo": "string",
• "mailCC": "string",
• "mailBCC": "string",
• "mailSubject": "string",
• "mailMessage": "string",
• "mailLinkExpirationId": 0,
• "azureAuthTypeId": 0,
• "azureAccessKey": "string",
• "azureConnectionString": "string",
• "azureContainerName": "string",
• "azureContainerUrl": "string",
• "azureStorageAccountName": "string",
• "azureSharedAccessToken": "string",
• "azureBlobClientId": "string",
• "azureBlobClientSecret": "string",
• "azureBlobTenantId": "string",
• "externalIdpTokenEndpoint": "string",
• "externalIdpClientId": "string",
• "externalIdpClientSecret": "string",
• "externalIdpScope": "string",
• "azureFilesShareName": "string",
• "azureFilesShareUrl": "string",
• "httpServerUrl": "string",
• "httpClientUrl": "string",
• "lanNetworkSharePath": "string",
• "lanDomain": "string",
• "lanUsername": "string",
• "lanPassword": "string",
• "sharePointTenantName": "string",
• "sharePointSiteUrl": "string",
• "sharePointClientId": "string",
• "sharePointClientSecret": "string",
• "sharePointDocumentLibrary": "string",
• "thruFileShareSiteUrl": "string",
• "thruFileShareUsername": "string",
• "thruFileSharePassword": "string",
• "googleCloudStorageBucketName": "string",
• "googleCloudStorageServiceAccountKeyJson": "string"

}

Response samples

• 200
• 400
• 401
• 403
• 404
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Creates a new endpoint configuration

Requires organization endpoint create permissions to create new endpoint configurations. Request body must contain valid EndpointEditorViewModel data.

Authorizations:

ApiKeyBearer

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

New endpoint configuration including connection details, authentication settings, and processing options

id	integer <int32>
organizationId	integer <int32>
name	string or null
code	string or null
location	string or null
ipAddress	string or null
cidRmask	integer or null <int32>
description	string or null
thruNodeId	string or null
protocolId	integer <int32>
endpointTypeId	integer <int32>
isEnabled	boolean
s3BucketName	string or null
s3AccessKey	string or null
s3SecretKey	string or null
s3RegionTypeId	integer <int32>
s3ServiceUrl	string or null
transferSecretKey	string or null
transferInstallationKey	string or null
ftpsClientIPAddress	string or null
ftpsClientHost	string or null
ftpsClientPort	integer <int32>
ftpsClientUser	string or null
ftpsClientPassword	string or null
ftpsClientAuthTypeId	integer <int32>
ftpsClientCertificateId	integer or null <int32>
sftpClientIPAddress	string or null
sftpClientHost	string or null
sftpClientPort	integer <int32>
sftpClientUser	string or null
sftpUserPassword	string or null
sftpClientAuthTypeId	integer <int32>
sftpClientSshKeyId	integer or null <int32>
sftpAllowSimultaneousTransfers	boolean
aS2RemoteUrl	string or null
aS2RemoteOrgIdentifier	string or null
aS2PublicCertificate	string or null
mailTo	string or null
mailCC	string or null
mailBCC	string or null
mailSubject	string or null
mailMessage	string or null
mailLinkExpirationId	integer <int32>
azureAuthTypeId	integer <int32>
azureAccessKey	string or null
azureConnectionString	string or null
azureContainerName	string or null
azureContainerUrl	string or null
azureStorageAccountName	string or null
azureSharedAccessToken	string or null
azureBlobClientId	string or null
azureBlobClientSecret	string or null
azureBlobTenantId	string or null
externalIdpTokenEndpoint	string or null
externalIdpClientId	string or null
externalIdpClientSecret	string or null
externalIdpScope	string or null
azureFilesShareName	string or null
azureFilesShareUrl	string or null
httpServerUrl	string or null
httpClientUrl	string or null
lanNetworkSharePath	string or null
lanDomain	string or null
lanUsername	string or null
lanPassword	string or null
sharePointTenantName	string or null
sharePointSiteUrl	string or null
sharePointClientId	string or null
sharePointClientSecret	string or null
sharePointDocumentLibrary	string or null
thruFileShareSiteUrl	string or null
thruFileShareUsername	string or null
thruFileSharePassword	string or null
googleCloudStorageBucketName	string or null
googleCloudStorageServiceAccountKeyJson	string or null

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

id	integer <int32>
organizationId	integer <int32>
name	string or null
code	string or null
location	string or null
ipAddress	string or null
cidRmask	integer or null <int32>
description	string or null
thruNodeId	string or null
protocolId	integer <int32>
endpointTypeId	integer <int32>
isEnabled	boolean
s3BucketName	string or null
s3AccessKey	string or null
s3SecretKey	string or null
s3RegionTypeId	integer <int32>
s3ServiceUrl	string or null
transferSecretKey	string or null
transferInstallationKey	string or null
ftpsClientIPAddress	string or null
ftpsClientHost	string or null
ftpsClientPort	integer <int32>
ftpsClientUser	string or null
ftpsClientPassword	string or null
ftpsClientAuthTypeId	integer <int32>
ftpsClientCertificateId	integer or null <int32>
sftpClientIPAddress	string or null
sftpClientHost	string or null
sftpClientPort	integer <int32>
sftpClientUser	string or null
sftpUserPassword	string or null
sftpClientAuthTypeId	integer <int32>
sftpClientSshKeyId	integer or null <int32>
sftpAllowSimultaneousTransfers	boolean
aS2RemoteUrl	string or null
aS2RemoteOrgIdentifier	string or null
aS2PublicCertificate	string or null
mailTo	string or null
mailCC	string or null
mailBCC	string or null
mailSubject	string or null
mailMessage	string or null
mailLinkExpirationId	integer <int32>
azureAuthTypeId	integer <int32>
azureAccessKey	string or null
azureConnectionString	string or null
azureContainerName	string or null
azureContainerUrl	string or null
azureStorageAccountName	string or null
azureSharedAccessToken	string or null
azureBlobClientId	string or null
azureBlobClientSecret	string or null
azureBlobTenantId	string or null
externalIdpTokenEndpoint	string or null
externalIdpClientId	string or null
externalIdpClientSecret	string or null
externalIdpScope	string or null
azureFilesShareName	string or null
azureFilesShareUrl	string or null
httpServerUrl	string or null
httpClientUrl	string or null
lanNetworkSharePath	string or null
lanDomain	string or null
lanUsername	string or null
lanPassword	string or null
sharePointTenantName	string or null
sharePointSiteUrl	string or null
sharePointClientId	string or null
sharePointClientSecret	string or null
sharePointDocumentLibrary	string or null
thruFileShareSiteUrl	string or null
thruFileShareUsername	string or null
thruFileSharePassword	string or null
googleCloudStorageBucketName	string or null
googleCloudStorageServiceAccountKeyJson	string or null

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

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

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

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

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "id": 0,
• "organizationId": 0,
• "name": "string",
• "code": "string",
• "location": "string",
• "ipAddress": "string",
• "cidRmask": 0,
• "description": "string",
• "thruNodeId": "string",
• "protocolId": 0,
• "endpointTypeId": 0,
• "isEnabled": true,
• "s3BucketName": "string",
• "s3AccessKey": "string",
• "s3SecretKey": "string",
• "s3RegionTypeId": 0,
• "s3ServiceUrl": "string",
• "transferSecretKey": "string",
• "transferInstallationKey": "string",
• "ftpsClientIPAddress": "string",
• "ftpsClientHost": "string",
• "ftpsClientPort": 0,
• "ftpsClientUser": "string",
• "ftpsClientPassword": "string",
• "ftpsClientAuthTypeId": 0,
• "ftpsClientCertificateId": 0,
• "sftpClientIPAddress": "string",
• "sftpClientHost": "string",
• "sftpClientPort": 0,
• "sftpClientUser": "string",
• "sftpUserPassword": "string",
• "sftpClientAuthTypeId": 0,
• "sftpClientSshKeyId": 0,
• "sftpAllowSimultaneousTransfers": true,
• "aS2RemoteUrl": "string",
• "aS2RemoteOrgIdentifier": "string",
• "aS2PublicCertificate": "string",
• "mailTo": "string",
• "mailCC": "string",
• "mailBCC": "string",
• "mailSubject": "string",
• "mailMessage": "string",
• "mailLinkExpirationId": 0,
• "azureAuthTypeId": 0,
• "azureAccessKey": "string",
• "azureConnectionString": "string",
• "azureContainerName": "string",
• "azureContainerUrl": "string",
• "azureStorageAccountName": "string",
• "azureSharedAccessToken": "string",
• "azureBlobClientId": "string",
• "azureBlobClientSecret": "string",
• "azureBlobTenantId": "string",
• "externalIdpTokenEndpoint": "string",
• "externalIdpClientId": "string",
• "externalIdpClientSecret": "string",
• "externalIdpScope": "string",
• "azureFilesShareName": "string",
• "azureFilesShareUrl": "string",
• "httpServerUrl": "string",
• "httpClientUrl": "string",
• "lanNetworkSharePath": "string",
• "lanDomain": "string",
• "lanUsername": "string",
• "lanPassword": "string",
• "sharePointTenantName": "string",
• "sharePointSiteUrl": "string",
• "sharePointClientId": "string",
• "sharePointClientSecret": "string",
• "sharePointDocumentLibrary": "string",
• "thruFileShareSiteUrl": "string",
• "thruFileShareUsername": "string",
• "thruFileSharePassword": "string",
• "googleCloudStorageBucketName": "string",
• "googleCloudStorageServiceAccountKeyJson": "string"

}

Response samples

• 200
• 400
• 401
• 403
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Retrieves the internal server path configuration for endpoint setup

Requires organization endpoint read permissions to access server path configuration.

Authorizations:

ApiKeyBearer

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

string

https://us.thruinc.com/api/Endpoints/getInternalServerPath

https://uk.thruinc.com/api/Endpoints/getInternalServerPath

https://eu.thruinc.com/api/Endpoints/getInternalServerPath

https://au.thruinc.com/api/Endpoints/getInternalServerPath

Response samples

• 200
• 401
• 403
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Retrieves the public API path configuration for endpoint integration

Requires organization endpoint read permissions to access public API path configuration.

Authorizations:

ApiKeyBearer

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

string

https://us.thruinc.com/api/Endpoints/getThruPublicApiPath

https://uk.thruinc.com/api/Endpoints/getThruPublicApiPath

https://eu.thruinc.com/api/Endpoints/getThruPublicApiPath

https://au.thruinc.com/api/Endpoints/getThruPublicApiPath

Response samples

• 200
• 401
• 403
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Downloads the V1 installer package for endpoint deployment

Requires organization endpoint read permissions to download installer package.

Authorizations:

ApiKeyBearer

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

string <binary>

https://us.thruinc.com/api/Endpoints/downloadV1Installer

https://uk.thruinc.com/api/Endpoints/downloadV1Installer

https://eu.thruinc.com/api/Endpoints/downloadV1Installer

https://au.thruinc.com/api/Endpoints/downloadV1Installer

Response samples

• 200
• 401
• 403
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Retrieves the V1 configuration data for a specific endpoint

Requires organization endpoint read permissions to retrieve endpoint configuration.

Authorizations:

ApiKeyBearer

query Parameters

endpointId

integer <int32> Unique identifier of the endpoint to generate configuration for

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

	object (thruStatus)
data	any or null

https://us.thruinc.com/api/Endpoints/downloadV1Config

https://uk.thruinc.com/api/Endpoints/downloadV1Config

https://eu.thruinc.com/api/Endpoints/downloadV1Config

https://au.thruinc.com/api/Endpoints/downloadV1Config

Response samples

• 200
• 401
• 403
• 404
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Regenerates the transport client secret for an endpoint

Requires organization endpoint update permissions to regenerate transport client secrets.

Authorizations:

ApiKeyBearer

query Parameters

endpointId

integer <int32> Unique identifier of the endpoint to regenerate secret for

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

	object (thruStatus)
data	any or null

https://us.thruinc.com/api/Endpoints/regenerateTransportClientSecret

https://uk.thruinc.com/api/Endpoints/regenerateTransportClientSecret

https://eu.thruinc.com/api/Endpoints/regenerateTransportClientSecret

https://au.thruinc.com/api/Endpoints/regenerateTransportClientSecret

Response samples

• 200
• 401
• 403
• 404
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Tests SFTP connection using the provided endpoint configuration

Requires organization endpoint read permissions to test SFTP connections. Request body must contain valid EndpointEditorViewModel data.

Authorizations:

ApiKeyBearer

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

SFTP endpoint configuration to test

id	integer <int32>
organizationId	integer <int32>
name	string or null
code	string or null
location	string or null
ipAddress	string or null
cidRmask	integer or null <int32>
description	string or null
thruNodeId	string or null
protocolId	integer <int32>
endpointTypeId	integer <int32>
isEnabled	boolean
s3BucketName	string or null
s3AccessKey	string or null
s3SecretKey	string or null
s3RegionTypeId	integer <int32>
s3ServiceUrl	string or null
transferSecretKey	string or null
transferInstallationKey	string or null
ftpsClientIPAddress	string or null
ftpsClientHost	string or null
ftpsClientPort	integer <int32>
ftpsClientUser	string or null
ftpsClientPassword	string or null
ftpsClientAuthTypeId	integer <int32>
ftpsClientCertificateId	integer or null <int32>
sftpClientIPAddress	string or null
sftpClientHost	string or null
sftpClientPort	integer <int32>
sftpClientUser	string or null
sftpUserPassword	string or null
sftpClientAuthTypeId	integer <int32>
sftpClientSshKeyId	integer or null <int32>
sftpAllowSimultaneousTransfers	boolean
aS2RemoteUrl	string or null
aS2RemoteOrgIdentifier	string or null
aS2PublicCertificate	string or null
mailTo	string or null
mailCC	string or null
mailBCC	string or null
mailSubject	string or null
mailMessage	string or null
mailLinkExpirationId	integer <int32>
azureAuthTypeId	integer <int32>
azureAccessKey	string or null
azureConnectionString	string or null
azureContainerName	string or null
azureContainerUrl	string or null
azureStorageAccountName	string or null
azureSharedAccessToken	string or null
azureBlobClientId	string or null
azureBlobClientSecret	string or null
azureBlobTenantId	string or null
externalIdpTokenEndpoint	string or null
externalIdpClientId	string or null
externalIdpClientSecret	string or null
externalIdpScope	string or null
azureFilesShareName	string or null
azureFilesShareUrl	string or null
httpServerUrl	string or null
httpClientUrl	string or null
lanNetworkSharePath	string or null
lanDomain	string or null
lanUsername	string or null
lanPassword	string or null
sharePointTenantName	string or null
sharePointSiteUrl	string or null
sharePointClientId	string or null
sharePointClientSecret	string or null
sharePointDocumentLibrary	string or null
thruFileShareSiteUrl	string or null
thruFileShareUsername	string or null
thruFileSharePassword	string or null
googleCloudStorageBucketName	string or null
googleCloudStorageServiceAccountKeyJson	string or null

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

	object (thruStatus)
data	any or null

https://us.thruinc.com/api/Endpoints/testSFTPConnection

https://uk.thruinc.com/api/Endpoints/testSFTPConnection

https://eu.thruinc.com/api/Endpoints/testSFTPConnection

https://au.thruinc.com/api/Endpoints/testSFTPConnection

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "id": 0,
• "organizationId": 0,
• "name": "string",
• "code": "string",
• "location": "string",
• "ipAddress": "string",
• "cidRmask": 0,
• "description": "string",
• "thruNodeId": "string",
• "protocolId": 0,
• "endpointTypeId": 0,
• "isEnabled": true,
• "s3BucketName": "string",
• "s3AccessKey": "string",
• "s3SecretKey": "string",
• "s3RegionTypeId": 0,
• "s3ServiceUrl": "string",
• "transferSecretKey": "string",
• "transferInstallationKey": "string",
• "ftpsClientIPAddress": "string",
• "ftpsClientHost": "string",
• "ftpsClientPort": 0,
• "ftpsClientUser": "string",
• "ftpsClientPassword": "string",
• "ftpsClientAuthTypeId": 0,
• "ftpsClientCertificateId": 0,
• "sftpClientIPAddress": "string",
• "sftpClientHost": "string",
• "sftpClientPort": 0,
• "sftpClientUser": "string",
• "sftpUserPassword": "string",
• "sftpClientAuthTypeId": 0,
• "sftpClientSshKeyId": 0,
• "sftpAllowSimultaneousTransfers": true,
• "aS2RemoteUrl": "string",
• "aS2RemoteOrgIdentifier": "string",
• "aS2PublicCertificate": "string",
• "mailTo": "string",
• "mailCC": "string",
• "mailBCC": "string",
• "mailSubject": "string",
• "mailMessage": "string",
• "mailLinkExpirationId": 0,
• "azureAuthTypeId": 0,
• "azureAccessKey": "string",
• "azureConnectionString": "string",
• "azureContainerName": "string",
• "azureContainerUrl": "string",
• "azureStorageAccountName": "string",
• "azureSharedAccessToken": "string",
• "azureBlobClientId": "string",
• "azureBlobClientSecret": "string",
• "azureBlobTenantId": "string",
• "externalIdpTokenEndpoint": "string",
• "externalIdpClientId": "string",
• "externalIdpClientSecret": "string",
• "externalIdpScope": "string",
• "azureFilesShareName": "string",
• "azureFilesShareUrl": "string",
• "httpServerUrl": "string",
• "httpClientUrl": "string",
• "lanNetworkSharePath": "string",
• "lanDomain": "string",
• "lanUsername": "string",
• "lanPassword": "string",
• "sharePointTenantName": "string",
• "sharePointSiteUrl": "string",
• "sharePointClientId": "string",
• "sharePointClientSecret": "string",
• "sharePointDocumentLibrary": "string",
• "thruFileShareSiteUrl": "string",
• "thruFileShareUsername": "string",
• "thruFileSharePassword": "string",
• "googleCloudStorageBucketName": "string",
• "googleCloudStorageServiceAccountKeyJson": "string"

}

Response samples

• 200
• 400
• 401
• 403
• 404
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Tests FTPS connection using the provided endpoint configuration

Requires organization endpoint read permissions to test FTPS connections. Request body must contain valid EndpointEditorViewModel data.

Authorizations:

ApiKeyBearer

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

FTPS endpoint configuration to test

id	integer <int32>
organizationId	integer <int32>
name	string or null
code	string or null
location	string or null
ipAddress	string or null
cidRmask	integer or null <int32>
description	string or null
thruNodeId	string or null
protocolId	integer <int32>
endpointTypeId	integer <int32>
isEnabled	boolean
s3BucketName	string or null
s3AccessKey	string or null
s3SecretKey	string or null
s3RegionTypeId	integer <int32>
s3ServiceUrl	string or null
transferSecretKey	string or null
transferInstallationKey	string or null
ftpsClientIPAddress	string or null
ftpsClientHost	string or null
ftpsClientPort	integer <int32>
ftpsClientUser	string or null
ftpsClientPassword	string or null
ftpsClientAuthTypeId	integer <int32>
ftpsClientCertificateId	integer or null <int32>
sftpClientIPAddress	string or null
sftpClientHost	string or null
sftpClientPort	integer <int32>
sftpClientUser	string or null
sftpUserPassword	string or null
sftpClientAuthTypeId	integer <int32>
sftpClientSshKeyId	integer or null <int32>
sftpAllowSimultaneousTransfers	boolean
aS2RemoteUrl	string or null
aS2RemoteOrgIdentifier	string or null
aS2PublicCertificate	string or null
mailTo	string or null
mailCC	string or null
mailBCC	string or null
mailSubject	string or null
mailMessage	string or null
mailLinkExpirationId	integer <int32>
azureAuthTypeId	integer <int32>
azureAccessKey	string or null
azureConnectionString	string or null
azureContainerName	string or null
azureContainerUrl	string or null
azureStorageAccountName	string or null
azureSharedAccessToken	string or null
azureBlobClientId	string or null
azureBlobClientSecret	string or null
azureBlobTenantId	string or null
externalIdpTokenEndpoint	string or null
externalIdpClientId	string or null
externalIdpClientSecret	string or null
externalIdpScope	string or null
azureFilesShareName	string or null
azureFilesShareUrl	string or null
httpServerUrl	string or null
httpClientUrl	string or null
lanNetworkSharePath	string or null
lanDomain	string or null
lanUsername	string or null
lanPassword	string or null
sharePointTenantName	string or null
sharePointSiteUrl	string or null
sharePointClientId	string or null
sharePointClientSecret	string or null
sharePointDocumentLibrary	string or null
thruFileShareSiteUrl	string or null
thruFileShareUsername	string or null
thruFileSharePassword	string or null
googleCloudStorageBucketName	string or null
googleCloudStorageServiceAccountKeyJson	string or null

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

	object (thruStatus)
data	any or null

https://us.thruinc.com/api/Endpoints/testFTPSConnection

https://uk.thruinc.com/api/Endpoints/testFTPSConnection

https://eu.thruinc.com/api/Endpoints/testFTPSConnection

https://au.thruinc.com/api/Endpoints/testFTPSConnection

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "id": 0,
• "organizationId": 0,
• "name": "string",
• "code": "string",
• "location": "string",
• "ipAddress": "string",
• "cidRmask": 0,
• "description": "string",
• "thruNodeId": "string",
• "protocolId": 0,
• "endpointTypeId": 0,
• "isEnabled": true,
• "s3BucketName": "string",
• "s3AccessKey": "string",
• "s3SecretKey": "string",
• "s3RegionTypeId": 0,
• "s3ServiceUrl": "string",
• "transferSecretKey": "string",
• "transferInstallationKey": "string",
• "ftpsClientIPAddress": "string",
• "ftpsClientHost": "string",
• "ftpsClientPort": 0,
• "ftpsClientUser": "string",
• "ftpsClientPassword": "string",
• "ftpsClientAuthTypeId": 0,
• "ftpsClientCertificateId": 0,
• "sftpClientIPAddress": "string",
• "sftpClientHost": "string",
• "sftpClientPort": 0,
• "sftpClientUser": "string",
• "sftpUserPassword": "string",
• "sftpClientAuthTypeId": 0,
• "sftpClientSshKeyId": 0,
• "sftpAllowSimultaneousTransfers": true,
• "aS2RemoteUrl": "string",
• "aS2RemoteOrgIdentifier": "string",
• "aS2PublicCertificate": "string",
• "mailTo": "string",
• "mailCC": "string",
• "mailBCC": "string",
• "mailSubject": "string",
• "mailMessage": "string",
• "mailLinkExpirationId": 0,
• "azureAuthTypeId": 0,
• "azureAccessKey": "string",
• "azureConnectionString": "string",
• "azureContainerName": "string",
• "azureContainerUrl": "string",
• "azureStorageAccountName": "string",
• "azureSharedAccessToken": "string",
• "azureBlobClientId": "string",
• "azureBlobClientSecret": "string",
• "azureBlobTenantId": "string",
• "externalIdpTokenEndpoint": "string",
• "externalIdpClientId": "string",
• "externalIdpClientSecret": "string",
• "externalIdpScope": "string",
• "azureFilesShareName": "string",
• "azureFilesShareUrl": "string",
• "httpServerUrl": "string",
• "httpClientUrl": "string",
• "lanNetworkSharePath": "string",
• "lanDomain": "string",
• "lanUsername": "string",
• "lanPassword": "string",
• "sharePointTenantName": "string",
• "sharePointSiteUrl": "string",
• "sharePointClientId": "string",
• "sharePointClientSecret": "string",
• "sharePointDocumentLibrary": "string",
• "thruFileShareSiteUrl": "string",
• "thruFileShareUsername": "string",
• "thruFileSharePassword": "string",
• "googleCloudStorageBucketName": "string",
• "googleCloudStorageServiceAccountKeyJson": "string"

}

Response samples

• 200
• 400
• 401
• 403
• 404
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Tests Amazon S3 connection using the provided endpoint configuration

Requires organization endpoint read permissions to test S3 connections. Request body must contain valid EndpointEditorViewModel data.

Authorizations:

ApiKeyBearer

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

S3 endpoint configuration to test

id	integer <int32>
organizationId	integer <int32>
name	string or null
code	string or null
location	string or null
ipAddress	string or null
cidRmask	integer or null <int32>
description	string or null
thruNodeId	string or null
protocolId	integer <int32>
endpointTypeId	integer <int32>
isEnabled	boolean
s3BucketName	string or null
s3AccessKey	string or null
s3SecretKey	string or null
s3RegionTypeId	integer <int32>
s3ServiceUrl	string or null
transferSecretKey	string or null
transferInstallationKey	string or null
ftpsClientIPAddress	string or null
ftpsClientHost	string or null
ftpsClientPort	integer <int32>
ftpsClientUser	string or null
ftpsClientPassword	string or null
ftpsClientAuthTypeId	integer <int32>
ftpsClientCertificateId	integer or null <int32>
sftpClientIPAddress	string or null
sftpClientHost	string or null
sftpClientPort	integer <int32>
sftpClientUser	string or null
sftpUserPassword	string or null
sftpClientAuthTypeId	integer <int32>
sftpClientSshKeyId	integer or null <int32>
sftpAllowSimultaneousTransfers	boolean
aS2RemoteUrl	string or null
aS2RemoteOrgIdentifier	string or null
aS2PublicCertificate	string or null
mailTo	string or null
mailCC	string or null
mailBCC	string or null
mailSubject	string or null
mailMessage	string or null
mailLinkExpirationId	integer <int32>
azureAuthTypeId	integer <int32>
azureAccessKey	string or null
azureConnectionString	string or null
azureContainerName	string or null
azureContainerUrl	string or null
azureStorageAccountName	string or null
azureSharedAccessToken	string or null
azureBlobClientId	string or null
azureBlobClientSecret	string or null
azureBlobTenantId	string or null
externalIdpTokenEndpoint	string or null
externalIdpClientId	string or null
externalIdpClientSecret	string or null
externalIdpScope	string or null
azureFilesShareName	string or null
azureFilesShareUrl	string or null
httpServerUrl	string or null
httpClientUrl	string or null
lanNetworkSharePath	string or null
lanDomain	string or null
lanUsername	string or null
lanPassword	string or null
sharePointTenantName	string or null
sharePointSiteUrl	string or null
sharePointClientId	string or null
sharePointClientSecret	string or null
sharePointDocumentLibrary	string or null
thruFileShareSiteUrl	string or null
thruFileShareUsername	string or null
thruFileSharePassword	string or null
googleCloudStorageBucketName	string or null
googleCloudStorageServiceAccountKeyJson	string or null

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

	object (thruStatus)
data	any or null

https://us.thruinc.com/api/Endpoints/testS3Connection

https://uk.thruinc.com/api/Endpoints/testS3Connection

https://eu.thruinc.com/api/Endpoints/testS3Connection

https://au.thruinc.com/api/Endpoints/testS3Connection

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "id": 0,
• "organizationId": 0,
• "name": "string",
• "code": "string",
• "location": "string",
• "ipAddress": "string",
• "cidRmask": 0,
• "description": "string",
• "thruNodeId": "string",
• "protocolId": 0,
• "endpointTypeId": 0,
• "isEnabled": true,
• "s3BucketName": "string",
• "s3AccessKey": "string",
• "s3SecretKey": "string",
• "s3RegionTypeId": 0,
• "s3ServiceUrl": "string",
• "transferSecretKey": "string",
• "transferInstallationKey": "string",
• "ftpsClientIPAddress": "string",
• "ftpsClientHost": "string",
• "ftpsClientPort": 0,
• "ftpsClientUser": "string",
• "ftpsClientPassword": "string",
• "ftpsClientAuthTypeId": 0,
• "ftpsClientCertificateId": 0,
• "sftpClientIPAddress": "string",
• "sftpClientHost": "string",
• "sftpClientPort": 0,
• "sftpClientUser": "string",
• "sftpUserPassword": "string",
• "sftpClientAuthTypeId": 0,
• "sftpClientSshKeyId": 0,
• "sftpAllowSimultaneousTransfers": true,
• "aS2RemoteUrl": "string",
• "aS2RemoteOrgIdentifier": "string",
• "aS2PublicCertificate": "string",
• "mailTo": "string",
• "mailCC": "string",
• "mailBCC": "string",
• "mailSubject": "string",
• "mailMessage": "string",
• "mailLinkExpirationId": 0,
• "azureAuthTypeId": 0,
• "azureAccessKey": "string",
• "azureConnectionString": "string",
• "azureContainerName": "string",
• "azureContainerUrl": "string",
• "azureStorageAccountName": "string",
• "azureSharedAccessToken": "string",
• "azureBlobClientId": "string",
• "azureBlobClientSecret": "string",
• "azureBlobTenantId": "string",
• "externalIdpTokenEndpoint": "string",
• "externalIdpClientId": "string",
• "externalIdpClientSecret": "string",
• "externalIdpScope": "string",
• "azureFilesShareName": "string",
• "azureFilesShareUrl": "string",
• "httpServerUrl": "string",
• "httpClientUrl": "string",
• "lanNetworkSharePath": "string",
• "lanDomain": "string",
• "lanUsername": "string",
• "lanPassword": "string",
• "sharePointTenantName": "string",
• "sharePointSiteUrl": "string",
• "sharePointClientId": "string",
• "sharePointClientSecret": "string",
• "sharePointDocumentLibrary": "string",
• "thruFileShareSiteUrl": "string",
• "thruFileShareUsername": "string",
• "thruFileSharePassword": "string",
• "googleCloudStorageBucketName": "string",
• "googleCloudStorageServiceAccountKeyJson": "string"

}

Response samples

• 200
• 400
• 401
• 403
• 404
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Tests Azure Blob Storage connection using the provided endpoint configuration

Requires organization endpoint read permissions to test Azure Blob connections. Request body must contain valid EndpointEditorViewModel data.

Authorizations:

ApiKeyBearer

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

Azure Blob endpoint configuration to test

id	integer <int32>
organizationId	integer <int32>
name	string or null
code	string or null
location	string or null
ipAddress	string or null
cidRmask	integer or null <int32>
description	string or null
thruNodeId	string or null
protocolId	integer <int32>
endpointTypeId	integer <int32>
isEnabled	boolean
s3BucketName	string or null
s3AccessKey	string or null
s3SecretKey	string or null
s3RegionTypeId	integer <int32>
s3ServiceUrl	string or null
transferSecretKey	string or null
transferInstallationKey	string or null
ftpsClientIPAddress	string or null
ftpsClientHost	string or null
ftpsClientPort	integer <int32>
ftpsClientUser	string or null
ftpsClientPassword	string or null
ftpsClientAuthTypeId	integer <int32>
ftpsClientCertificateId	integer or null <int32>
sftpClientIPAddress	string or null
sftpClientHost	string or null
sftpClientPort	integer <int32>
sftpClientUser	string or null
sftpUserPassword	string or null
sftpClientAuthTypeId	integer <int32>
sftpClientSshKeyId	integer or null <int32>
sftpAllowSimultaneousTransfers	boolean
aS2RemoteUrl	string or null
aS2RemoteOrgIdentifier	string or null
aS2PublicCertificate	string or null
mailTo	string or null
mailCC	string or null
mailBCC	string or null
mailSubject	string or null
mailMessage	string or null
mailLinkExpirationId	integer <int32>
azureAuthTypeId	integer <int32>
azureAccessKey	string or null
azureConnectionString	string or null
azureContainerName	string or null
azureContainerUrl	string or null
azureStorageAccountName	string or null
azureSharedAccessToken	string or null
azureBlobClientId	string or null
azureBlobClientSecret	string or null
azureBlobTenantId	string or null
externalIdpTokenEndpoint	string or null
externalIdpClientId	string or null
externalIdpClientSecret	string or null
externalIdpScope	string or null
azureFilesShareName	string or null
azureFilesShareUrl	string or null
httpServerUrl	string or null
httpClientUrl	string or null
lanNetworkSharePath	string or null
lanDomain	string or null
lanUsername	string or null
lanPassword	string or null
sharePointTenantName	string or null
sharePointSiteUrl	string or null
sharePointClientId	string or null
sharePointClientSecret	string or null
sharePointDocumentLibrary	string or null
thruFileShareSiteUrl	string or null
thruFileShareUsername	string or null
thruFileSharePassword	string or null
googleCloudStorageBucketName	string or null
googleCloudStorageServiceAccountKeyJson	string or null

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

	object (thruStatus)
data	any or null

https://us.thruinc.com/api/Endpoints/testAzureBlobConnection

https://uk.thruinc.com/api/Endpoints/testAzureBlobConnection

https://eu.thruinc.com/api/Endpoints/testAzureBlobConnection

https://au.thruinc.com/api/Endpoints/testAzureBlobConnection

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "id": 0,
• "organizationId": 0,
• "name": "string",
• "code": "string",
• "location": "string",
• "ipAddress": "string",
• "cidRmask": 0,
• "description": "string",
• "thruNodeId": "string",
• "protocolId": 0,
• "endpointTypeId": 0,
• "isEnabled": true,
• "s3BucketName": "string",
• "s3AccessKey": "string",
• "s3SecretKey": "string",
• "s3RegionTypeId": 0,
• "s3ServiceUrl": "string",
• "transferSecretKey": "string",
• "transferInstallationKey": "string",
• "ftpsClientIPAddress": "string",
• "ftpsClientHost": "string",
• "ftpsClientPort": 0,
• "ftpsClientUser": "string",
• "ftpsClientPassword": "string",
• "ftpsClientAuthTypeId": 0,
• "ftpsClientCertificateId": 0,
• "sftpClientIPAddress": "string",
• "sftpClientHost": "string",
• "sftpClientPort": 0,
• "sftpClientUser": "string",
• "sftpUserPassword": "string",
• "sftpClientAuthTypeId": 0,
• "sftpClientSshKeyId": 0,
• "sftpAllowSimultaneousTransfers": true,
• "aS2RemoteUrl": "string",
• "aS2RemoteOrgIdentifier": "string",
• "aS2PublicCertificate": "string",
• "mailTo": "string",
• "mailCC": "string",
• "mailBCC": "string",
• "mailSubject": "string",
• "mailMessage": "string",
• "mailLinkExpirationId": 0,
• "azureAuthTypeId": 0,
• "azureAccessKey": "string",
• "azureConnectionString": "string",
• "azureContainerName": "string",
• "azureContainerUrl": "string",
• "azureStorageAccountName": "string",
• "azureSharedAccessToken": "string",
• "azureBlobClientId": "string",
• "azureBlobClientSecret": "string",
• "azureBlobTenantId": "string",
• "externalIdpTokenEndpoint": "string",
• "externalIdpClientId": "string",
• "externalIdpClientSecret": "string",
• "externalIdpScope": "string",
• "azureFilesShareName": "string",
• "azureFilesShareUrl": "string",
• "httpServerUrl": "string",
• "httpClientUrl": "string",
• "lanNetworkSharePath": "string",
• "lanDomain": "string",
• "lanUsername": "string",
• "lanPassword": "string",
• "sharePointTenantName": "string",
• "sharePointSiteUrl": "string",
• "sharePointClientId": "string",
• "sharePointClientSecret": "string",
• "sharePointDocumentLibrary": "string",
• "thruFileShareSiteUrl": "string",
• "thruFileShareUsername": "string",
• "thruFileSharePassword": "string",
• "googleCloudStorageBucketName": "string",
• "googleCloudStorageServiceAccountKeyJson": "string"

}

Response samples

• 200
• 400
• 401
• 403
• 404
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Tests Azure Files connection using the provided endpoint configuration

Requires organization endpoint read permissions to test Azure Files connections. Request body must contain valid EndpointEditorViewModel data.

Authorizations:

ApiKeyBearer

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

Azure Files endpoint configuration to test

id	integer <int32>
organizationId	integer <int32>
name	string or null
code	string or null
location	string or null
ipAddress	string or null
cidRmask	integer or null <int32>
description	string or null
thruNodeId	string or null
protocolId	integer <int32>
endpointTypeId	integer <int32>
isEnabled	boolean
s3BucketName	string or null
s3AccessKey	string or null
s3SecretKey	string or null
s3RegionTypeId	integer <int32>
s3ServiceUrl	string or null
transferSecretKey	string or null
transferInstallationKey	string or null
ftpsClientIPAddress	string or null
ftpsClientHost	string or null
ftpsClientPort	integer <int32>
ftpsClientUser	string or null
ftpsClientPassword	string or null
ftpsClientAuthTypeId	integer <int32>
ftpsClientCertificateId	integer or null <int32>
sftpClientIPAddress	string or null
sftpClientHost	string or null
sftpClientPort	integer <int32>
sftpClientUser	string or null
sftpUserPassword	string or null
sftpClientAuthTypeId	integer <int32>
sftpClientSshKeyId	integer or null <int32>
sftpAllowSimultaneousTransfers	boolean
aS2RemoteUrl	string or null
aS2RemoteOrgIdentifier	string or null
aS2PublicCertificate	string or null
mailTo	string or null
mailCC	string or null
mailBCC	string or null
mailSubject	string or null
mailMessage	string or null
mailLinkExpirationId	integer <int32>
azureAuthTypeId	integer <int32>
azureAccessKey	string or null
azureConnectionString	string or null
azureContainerName	string or null
azureContainerUrl	string or null
azureStorageAccountName	string or null
azureSharedAccessToken	string or null
azureBlobClientId	string or null
azureBlobClientSecret	string or null
azureBlobTenantId	string or null
externalIdpTokenEndpoint	string or null
externalIdpClientId	string or null
externalIdpClientSecret	string or null
externalIdpScope	string or null
azureFilesShareName	string or null
azureFilesShareUrl	string or null
httpServerUrl	string or null
httpClientUrl	string or null
lanNetworkSharePath	string or null
lanDomain	string or null
lanUsername	string or null
lanPassword	string or null
sharePointTenantName	string or null
sharePointSiteUrl	string or null
sharePointClientId	string or null
sharePointClientSecret	string or null
sharePointDocumentLibrary	string or null
thruFileShareSiteUrl	string or null
thruFileShareUsername	string or null
thruFileSharePassword	string or null
googleCloudStorageBucketName	string or null
googleCloudStorageServiceAccountKeyJson	string or null

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

	object (thruStatus)
data	any or null

https://us.thruinc.com/api/Endpoints/testAzureFilesConnection

https://uk.thruinc.com/api/Endpoints/testAzureFilesConnection

https://eu.thruinc.com/api/Endpoints/testAzureFilesConnection

https://au.thruinc.com/api/Endpoints/testAzureFilesConnection

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "id": 0,
• "organizationId": 0,
• "name": "string",
• "code": "string",
• "location": "string",
• "ipAddress": "string",
• "cidRmask": 0,
• "description": "string",
• "thruNodeId": "string",
• "protocolId": 0,
• "endpointTypeId": 0,
• "isEnabled": true,
• "s3BucketName": "string",
• "s3AccessKey": "string",
• "s3SecretKey": "string",
• "s3RegionTypeId": 0,
• "s3ServiceUrl": "string",
• "transferSecretKey": "string",
• "transferInstallationKey": "string",
• "ftpsClientIPAddress": "string",
• "ftpsClientHost": "string",
• "ftpsClientPort": 0,
• "ftpsClientUser": "string",
• "ftpsClientPassword": "string",
• "ftpsClientAuthTypeId": 0,
• "ftpsClientCertificateId": 0,
• "sftpClientIPAddress": "string",
• "sftpClientHost": "string",
• "sftpClientPort": 0,
• "sftpClientUser": "string",
• "sftpUserPassword": "string",
• "sftpClientAuthTypeId": 0,
• "sftpClientSshKeyId": 0,
• "sftpAllowSimultaneousTransfers": true,
• "aS2RemoteUrl": "string",
• "aS2RemoteOrgIdentifier": "string",
• "aS2PublicCertificate": "string",
• "mailTo": "string",
• "mailCC": "string",
• "mailBCC": "string",
• "mailSubject": "string",
• "mailMessage": "string",
• "mailLinkExpirationId": 0,
• "azureAuthTypeId": 0,
• "azureAccessKey": "string",
• "azureConnectionString": "string",
• "azureContainerName": "string",
• "azureContainerUrl": "string",
• "azureStorageAccountName": "string",
• "azureSharedAccessToken": "string",
• "azureBlobClientId": "string",
• "azureBlobClientSecret": "string",
• "azureBlobTenantId": "string",
• "externalIdpTokenEndpoint": "string",
• "externalIdpClientId": "string",
• "externalIdpClientSecret": "string",
• "externalIdpScope": "string",
• "azureFilesShareName": "string",
• "azureFilesShareUrl": "string",
• "httpServerUrl": "string",
• "httpClientUrl": "string",
• "lanNetworkSharePath": "string",
• "lanDomain": "string",
• "lanUsername": "string",
• "lanPassword": "string",
• "sharePointTenantName": "string",
• "sharePointSiteUrl": "string",
• "sharePointClientId": "string",
• "sharePointClientSecret": "string",
• "sharePointDocumentLibrary": "string",
• "thruFileShareSiteUrl": "string",
• "thruFileShareUsername": "string",
• "thruFileSharePassword": "string",
• "googleCloudStorageBucketName": "string",
• "googleCloudStorageServiceAccountKeyJson": "string"

}

Response samples

• 200
• 400
• 401
• 403
• 404
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Tests SharePoint connection using the provided endpoint configuration

Requires organization endpoint read permissions to test SharePoint connections. Request body must contain valid EndpointEditorViewModel data.

Authorizations:

ApiKeyBearer

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

SharePoint endpoint configuration to test

id	integer <int32>
organizationId	integer <int32>
name	string or null
code	string or null
location	string or null
ipAddress	string or null
cidRmask	integer or null <int32>
description	string or null
thruNodeId	string or null
protocolId	integer <int32>
endpointTypeId	integer <int32>
isEnabled	boolean
s3BucketName	string or null
s3AccessKey	string or null
s3SecretKey	string or null
s3RegionTypeId	integer <int32>
s3ServiceUrl	string or null
transferSecretKey	string or null
transferInstallationKey	string or null
ftpsClientIPAddress	string or null
ftpsClientHost	string or null
ftpsClientPort	integer <int32>
ftpsClientUser	string or null
ftpsClientPassword	string or null
ftpsClientAuthTypeId	integer <int32>
ftpsClientCertificateId	integer or null <int32>
sftpClientIPAddress	string or null
sftpClientHost	string or null
sftpClientPort	integer <int32>
sftpClientUser	string or null
sftpUserPassword	string or null
sftpClientAuthTypeId	integer <int32>
sftpClientSshKeyId	integer or null <int32>
sftpAllowSimultaneousTransfers	boolean
aS2RemoteUrl	string or null
aS2RemoteOrgIdentifier	string or null
aS2PublicCertificate	string or null
mailTo	string or null
mailCC	string or null
mailBCC	string or null
mailSubject	string or null
mailMessage	string or null
mailLinkExpirationId	integer <int32>
azureAuthTypeId	integer <int32>
azureAccessKey	string or null
azureConnectionString	string or null
azureContainerName	string or null
azureContainerUrl	string or null
azureStorageAccountName	string or null
azureSharedAccessToken	string or null
azureBlobClientId	string or null
azureBlobClientSecret	string or null
azureBlobTenantId	string or null
externalIdpTokenEndpoint	string or null
externalIdpClientId	string or null
externalIdpClientSecret	string or null
externalIdpScope	string or null
azureFilesShareName	string or null
azureFilesShareUrl	string or null
httpServerUrl	string or null
httpClientUrl	string or null
lanNetworkSharePath	string or null
lanDomain	string or null
lanUsername	string or null
lanPassword	string or null
sharePointTenantName	string or null
sharePointSiteUrl	string or null
sharePointClientId	string or null
sharePointClientSecret	string or null
sharePointDocumentLibrary	string or null
thruFileShareSiteUrl	string or null
thruFileShareUsername	string or null
thruFileSharePassword	string or null
googleCloudStorageBucketName	string or null
googleCloudStorageServiceAccountKeyJson	string or null

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

	object (thruStatus)
data	any or null

https://us.thruinc.com/api/Endpoints/testSharePointConnection

https://uk.thruinc.com/api/Endpoints/testSharePointConnection

https://eu.thruinc.com/api/Endpoints/testSharePointConnection

https://au.thruinc.com/api/Endpoints/testSharePointConnection

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "id": 0,
• "organizationId": 0,
• "name": "string",
• "code": "string",
• "location": "string",
• "ipAddress": "string",
• "cidRmask": 0,
• "description": "string",
• "thruNodeId": "string",
• "protocolId": 0,
• "endpointTypeId": 0,
• "isEnabled": true,
• "s3BucketName": "string",
• "s3AccessKey": "string",
• "s3SecretKey": "string",
• "s3RegionTypeId": 0,
• "s3ServiceUrl": "string",
• "transferSecretKey": "string",
• "transferInstallationKey": "string",
• "ftpsClientIPAddress": "string",
• "ftpsClientHost": "string",
• "ftpsClientPort": 0,
• "ftpsClientUser": "string",
• "ftpsClientPassword": "string",
• "ftpsClientAuthTypeId": 0,
• "ftpsClientCertificateId": 0,
• "sftpClientIPAddress": "string",
• "sftpClientHost": "string",
• "sftpClientPort": 0,
• "sftpClientUser": "string",
• "sftpUserPassword": "string",
• "sftpClientAuthTypeId": 0,
• "sftpClientSshKeyId": 0,
• "sftpAllowSimultaneousTransfers": true,
• "aS2RemoteUrl": "string",
• "aS2RemoteOrgIdentifier": "string",
• "aS2PublicCertificate": "string",
• "mailTo": "string",
• "mailCC": "string",
• "mailBCC": "string",
• "mailSubject": "string",
• "mailMessage": "string",
• "mailLinkExpirationId": 0,
• "azureAuthTypeId": 0,
• "azureAccessKey": "string",
• "azureConnectionString": "string",
• "azureContainerName": "string",
• "azureContainerUrl": "string",
• "azureStorageAccountName": "string",
• "azureSharedAccessToken": "string",
• "azureBlobClientId": "string",
• "azureBlobClientSecret": "string",
• "azureBlobTenantId": "string",
• "externalIdpTokenEndpoint": "string",
• "externalIdpClientId": "string",
• "externalIdpClientSecret": "string",
• "externalIdpScope": "string",
• "azureFilesShareName": "string",
• "azureFilesShareUrl": "string",
• "httpServerUrl": "string",
• "httpClientUrl": "string",
• "lanNetworkSharePath": "string",
• "lanDomain": "string",
• "lanUsername": "string",
• "lanPassword": "string",
• "sharePointTenantName": "string",
• "sharePointSiteUrl": "string",
• "sharePointClientId": "string",
• "sharePointClientSecret": "string",
• "sharePointDocumentLibrary": "string",
• "thruFileShareSiteUrl": "string",
• "thruFileShareUsername": "string",
• "thruFileSharePassword": "string",
• "googleCloudStorageBucketName": "string",
• "googleCloudStorageServiceAccountKeyJson": "string"

}

Response samples

• 200
• 400
• 401
• 403
• 404
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Tests file share connection using the provided endpoint configuration

Requires organization endpoint read permissions to test file share connections. Request body must contain valid EndpointEditorViewModel data.

Authorizations:

ApiKeyBearer

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

File share endpoint configuration to test

id	integer <int32>
organizationId	integer <int32>
name	string or null
code	string or null
location	string or null
ipAddress	string or null
cidRmask	integer or null <int32>
description	string or null
thruNodeId	string or null
protocolId	integer <int32>
endpointTypeId	integer <int32>
isEnabled	boolean
s3BucketName	string or null
s3AccessKey	string or null
s3SecretKey	string or null
s3RegionTypeId	integer <int32>
s3ServiceUrl	string or null
transferSecretKey	string or null
transferInstallationKey	string or null
ftpsClientIPAddress	string or null
ftpsClientHost	string or null
ftpsClientPort	integer <int32>
ftpsClientUser	string or null
ftpsClientPassword	string or null
ftpsClientAuthTypeId	integer <int32>
ftpsClientCertificateId	integer or null <int32>
sftpClientIPAddress	string or null
sftpClientHost	string or null
sftpClientPort	integer <int32>
sftpClientUser	string or null
sftpUserPassword	string or null
sftpClientAuthTypeId	integer <int32>
sftpClientSshKeyId	integer or null <int32>
sftpAllowSimultaneousTransfers	boolean
aS2RemoteUrl	string or null
aS2RemoteOrgIdentifier	string or null
aS2PublicCertificate	string or null
mailTo	string or null
mailCC	string or null
mailBCC	string or null
mailSubject	string or null
mailMessage	string or null
mailLinkExpirationId	integer <int32>
azureAuthTypeId	integer <int32>
azureAccessKey	string or null
azureConnectionString	string or null
azureContainerName	string or null
azureContainerUrl	string or null
azureStorageAccountName	string or null
azureSharedAccessToken	string or null
azureBlobClientId	string or null
azureBlobClientSecret	string or null
azureBlobTenantId	string or null
externalIdpTokenEndpoint	string or null
externalIdpClientId	string or null
externalIdpClientSecret	string or null
externalIdpScope	string or null
azureFilesShareName	string or null
azureFilesShareUrl	string or null
httpServerUrl	string or null
httpClientUrl	string or null
lanNetworkSharePath	string or null
lanDomain	string or null
lanUsername	string or null
lanPassword	string or null
sharePointTenantName	string or null
sharePointSiteUrl	string or null
sharePointClientId	string or null
sharePointClientSecret	string or null
sharePointDocumentLibrary	string or null
thruFileShareSiteUrl	string or null
thruFileShareUsername	string or null
thruFileSharePassword	string or null
googleCloudStorageBucketName	string or null
googleCloudStorageServiceAccountKeyJson	string or null

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

	object (thruStatus)
data	any or null

https://us.thruinc.com/api/Endpoints/testThruFileShareConnection

https://uk.thruinc.com/api/Endpoints/testThruFileShareConnection

https://eu.thruinc.com/api/Endpoints/testThruFileShareConnection

https://au.thruinc.com/api/Endpoints/testThruFileShareConnection

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "id": 0,
• "organizationId": 0,
• "name": "string",
• "code": "string",
• "location": "string",
• "ipAddress": "string",
• "cidRmask": 0,
• "description": "string",
• "thruNodeId": "string",
• "protocolId": 0,
• "endpointTypeId": 0,
• "isEnabled": true,
• "s3BucketName": "string",
• "s3AccessKey": "string",
• "s3SecretKey": "string",
• "s3RegionTypeId": 0,
• "s3ServiceUrl": "string",
• "transferSecretKey": "string",
• "transferInstallationKey": "string",
• "ftpsClientIPAddress": "string",
• "ftpsClientHost": "string",
• "ftpsClientPort": 0,
• "ftpsClientUser": "string",
• "ftpsClientPassword": "string",
• "ftpsClientAuthTypeId": 0,
• "ftpsClientCertificateId": 0,
• "sftpClientIPAddress": "string",
• "sftpClientHost": "string",
• "sftpClientPort": 0,
• "sftpClientUser": "string",
• "sftpUserPassword": "string",
• "sftpClientAuthTypeId": 0,
• "sftpClientSshKeyId": 0,
• "sftpAllowSimultaneousTransfers": true,
• "aS2RemoteUrl": "string",
• "aS2RemoteOrgIdentifier": "string",
• "aS2PublicCertificate": "string",
• "mailTo": "string",
• "mailCC": "string",
• "mailBCC": "string",
• "mailSubject": "string",
• "mailMessage": "string",
• "mailLinkExpirationId": 0,
• "azureAuthTypeId": 0,
• "azureAccessKey": "string",
• "azureConnectionString": "string",
• "azureContainerName": "string",
• "azureContainerUrl": "string",
• "azureStorageAccountName": "string",
• "azureSharedAccessToken": "string",
• "azureBlobClientId": "string",
• "azureBlobClientSecret": "string",
• "azureBlobTenantId": "string",
• "externalIdpTokenEndpoint": "string",
• "externalIdpClientId": "string",
• "externalIdpClientSecret": "string",
• "externalIdpScope": "string",
• "azureFilesShareName": "string",
• "azureFilesShareUrl": "string",
• "httpServerUrl": "string",
• "httpClientUrl": "string",
• "lanNetworkSharePath": "string",
• "lanDomain": "string",
• "lanUsername": "string",
• "lanPassword": "string",
• "sharePointTenantName": "string",
• "sharePointSiteUrl": "string",
• "sharePointClientId": "string",
• "sharePointClientSecret": "string",
• "sharePointDocumentLibrary": "string",
• "thruFileShareSiteUrl": "string",
• "thruFileShareUsername": "string",
• "thruFileSharePassword": "string",
• "googleCloudStorageBucketName": "string",
• "googleCloudStorageServiceAccountKeyJson": "string"

}

Response samples

• 200
• 400
• 401
• 403
• 404
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Tests Google Cloud Storage connection using the provided endpoint configuration

Requires organization endpoint read permissions to test Google Cloud Storage connections. Request body must contain valid EndpointEditorViewModel data.

Authorizations:

ApiKeyBearer

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

Google Cloud Storage endpoint configuration to test

id	integer <int32>
organizationId	integer <int32>
name	string or null
code	string or null
location	string or null
ipAddress	string or null
cidRmask	integer or null <int32>
description	string or null
thruNodeId	string or null
protocolId	integer <int32>
endpointTypeId	integer <int32>
isEnabled	boolean
s3BucketName	string or null
s3AccessKey	string or null
s3SecretKey	string or null
s3RegionTypeId	integer <int32>
s3ServiceUrl	string or null
transferSecretKey	string or null
transferInstallationKey	string or null
ftpsClientIPAddress	string or null
ftpsClientHost	string or null
ftpsClientPort	integer <int32>
ftpsClientUser	string or null
ftpsClientPassword	string or null
ftpsClientAuthTypeId	integer <int32>
ftpsClientCertificateId	integer or null <int32>
sftpClientIPAddress	string or null
sftpClientHost	string or null
sftpClientPort	integer <int32>
sftpClientUser	string or null
sftpUserPassword	string or null
sftpClientAuthTypeId	integer <int32>
sftpClientSshKeyId	integer or null <int32>
sftpAllowSimultaneousTransfers	boolean
aS2RemoteUrl	string or null
aS2RemoteOrgIdentifier	string or null
aS2PublicCertificate	string or null
mailTo	string or null
mailCC	string or null
mailBCC	string or null
mailSubject	string or null
mailMessage	string or null
mailLinkExpirationId	integer <int32>
azureAuthTypeId	integer <int32>
azureAccessKey	string or null
azureConnectionString	string or null
azureContainerName	string or null
azureContainerUrl	string or null
azureStorageAccountName	string or null
azureSharedAccessToken	string or null
azureBlobClientId	string or null
azureBlobClientSecret	string or null
azureBlobTenantId	string or null
externalIdpTokenEndpoint	string or null
externalIdpClientId	string or null
externalIdpClientSecret	string or null
externalIdpScope	string or null
azureFilesShareName	string or null
azureFilesShareUrl	string or null
httpServerUrl	string or null
httpClientUrl	string or null
lanNetworkSharePath	string or null
lanDomain	string or null
lanUsername	string or null
lanPassword	string or null
sharePointTenantName	string or null
sharePointSiteUrl	string or null
sharePointClientId	string or null
sharePointClientSecret	string or null
sharePointDocumentLibrary	string or null
thruFileShareSiteUrl	string or null
thruFileShareUsername	string or null
thruFileSharePassword	string or null
googleCloudStorageBucketName	string or null
googleCloudStorageServiceAccountKeyJson	string or null

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

	object (thruStatus)
data	any or null

https://us.thruinc.com/api/Endpoints/testGoogleCloudStorageConnection

https://uk.thruinc.com/api/Endpoints/testGoogleCloudStorageConnection

https://eu.thruinc.com/api/Endpoints/testGoogleCloudStorageConnection

https://au.thruinc.com/api/Endpoints/testGoogleCloudStorageConnection

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "id": 0,
• "organizationId": 0,
• "name": "string",
• "code": "string",
• "location": "string",
• "ipAddress": "string",
• "cidRmask": 0,
• "description": "string",
• "thruNodeId": "string",
• "protocolId": 0,
• "endpointTypeId": 0,
• "isEnabled": true,
• "s3BucketName": "string",
• "s3AccessKey": "string",
• "s3SecretKey": "string",
• "s3RegionTypeId": 0,
• "s3ServiceUrl": "string",
• "transferSecretKey": "string",
• "transferInstallationKey": "string",
• "ftpsClientIPAddress": "string",
• "ftpsClientHost": "string",
• "ftpsClientPort": 0,
• "ftpsClientUser": "string",
• "ftpsClientPassword": "string",
• "ftpsClientAuthTypeId": 0,
• "ftpsClientCertificateId": 0,
• "sftpClientIPAddress": "string",
• "sftpClientHost": "string",
• "sftpClientPort": 0,
• "sftpClientUser": "string",
• "sftpUserPassword": "string",
• "sftpClientAuthTypeId": 0,
• "sftpClientSshKeyId": 0,
• "sftpAllowSimultaneousTransfers": true,
• "aS2RemoteUrl": "string",
• "aS2RemoteOrgIdentifier": "string",
• "aS2PublicCertificate": "string",
• "mailTo": "string",
• "mailCC": "string",
• "mailBCC": "string",
• "mailSubject": "string",
• "mailMessage": "string",
• "mailLinkExpirationId": 0,
• "azureAuthTypeId": 0,
• "azureAccessKey": "string",
• "azureConnectionString": "string",
• "azureContainerName": "string",
• "azureContainerUrl": "string",
• "azureStorageAccountName": "string",
• "azureSharedAccessToken": "string",
• "azureBlobClientId": "string",
• "azureBlobClientSecret": "string",
• "azureBlobTenantId": "string",
• "externalIdpTokenEndpoint": "string",
• "externalIdpClientId": "string",
• "externalIdpClientSecret": "string",
• "externalIdpScope": "string",
• "azureFilesShareName": "string",
• "azureFilesShareUrl": "string",
• "httpServerUrl": "string",
• "httpClientUrl": "string",
• "lanNetworkSharePath": "string",
• "lanDomain": "string",
• "lanUsername": "string",
• "lanPassword": "string",
• "sharePointTenantName": "string",
• "sharePointSiteUrl": "string",
• "sharePointClientId": "string",
• "sharePointClientSecret": "string",
• "sharePointDocumentLibrary": "string",
• "thruFileShareSiteUrl": "string",
• "thruFileShareUsername": "string",
• "thruFileSharePassword": "string",
• "googleCloudStorageBucketName": "string",
• "googleCloudStorageServiceAccountKeyJson": "string"

}

Response samples

• 200
• 400
• 401
• 403
• 404
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Tests LAN connection using the provided endpoint configuration

Requires organization endpoint read permissions to test LAN connections. Request body must contain valid EndpointEditorViewModel data.

Authorizations:

ApiKeyBearer

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

LAN endpoint configuration to test

id	integer <int32>
organizationId	integer <int32>
name	string or null
code	string or null
location	string or null
ipAddress	string or null
cidRmask	integer or null <int32>
description	string or null
thruNodeId	string or null
protocolId	integer <int32>
endpointTypeId	integer <int32>
isEnabled	boolean
s3BucketName	string or null
s3AccessKey	string or null
s3SecretKey	string or null
s3RegionTypeId	integer <int32>
s3ServiceUrl	string or null
transferSecretKey	string or null
transferInstallationKey	string or null
ftpsClientIPAddress	string or null
ftpsClientHost	string or null
ftpsClientPort	integer <int32>
ftpsClientUser	string or null
ftpsClientPassword	string or null
ftpsClientAuthTypeId	integer <int32>
ftpsClientCertificateId	integer or null <int32>
sftpClientIPAddress	string or null
sftpClientHost	string or null
sftpClientPort	integer <int32>
sftpClientUser	string or null
sftpUserPassword	string or null
sftpClientAuthTypeId	integer <int32>
sftpClientSshKeyId	integer or null <int32>
sftpAllowSimultaneousTransfers	boolean
aS2RemoteUrl	string or null
aS2RemoteOrgIdentifier	string or null
aS2PublicCertificate	string or null
mailTo	string or null
mailCC	string or null
mailBCC	string or null
mailSubject	string or null
mailMessage	string or null
mailLinkExpirationId	integer <int32>
azureAuthTypeId	integer <int32>
azureAccessKey	string or null
azureConnectionString	string or null
azureContainerName	string or null
azureContainerUrl	string or null
azureStorageAccountName	string or null
azureSharedAccessToken	string or null
azureBlobClientId	string or null
azureBlobClientSecret	string or null
azureBlobTenantId	string or null
externalIdpTokenEndpoint	string or null
externalIdpClientId	string or null
externalIdpClientSecret	string or null
externalIdpScope	string or null
azureFilesShareName	string or null
azureFilesShareUrl	string or null
httpServerUrl	string or null
httpClientUrl	string or null
lanNetworkSharePath	string or null
lanDomain	string or null
lanUsername	string or null
lanPassword	string or null
sharePointTenantName	string or null
sharePointSiteUrl	string or null
sharePointClientId	string or null
sharePointClientSecret	string or null
sharePointDocumentLibrary	string or null
thruFileShareSiteUrl	string or null
thruFileShareUsername	string or null
thruFileSharePassword	string or null
googleCloudStorageBucketName	string or null
googleCloudStorageServiceAccountKeyJson	string or null

Responses

https://us.thruinc.com/api/Endpoints/testLanConnection

https://uk.thruinc.com/api/Endpoints/testLanConnection

https://eu.thruinc.com/api/Endpoints/testLanConnection

https://au.thruinc.com/api/Endpoints/testLanConnection

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "id": 0,
• "organizationId": 0,
• "name": "string",
• "code": "string",
• "location": "string",
• "ipAddress": "string",
• "cidRmask": 0,
• "description": "string",
• "thruNodeId": "string",
• "protocolId": 0,
• "endpointTypeId": 0,
• "isEnabled": true,
• "s3BucketName": "string",
• "s3AccessKey": "string",
• "s3SecretKey": "string",
• "s3RegionTypeId": 0,
• "s3ServiceUrl": "string",
• "transferSecretKey": "string",
• "transferInstallationKey": "string",
• "ftpsClientIPAddress": "string",
• "ftpsClientHost": "string",
• "ftpsClientPort": 0,
• "ftpsClientUser": "string",
• "ftpsClientPassword": "string",
• "ftpsClientAuthTypeId": 0,
• "ftpsClientCertificateId": 0,
• "sftpClientIPAddress": "string",
• "sftpClientHost": "string",
• "sftpClientPort": 0,
• "sftpClientUser": "string",
• "sftpUserPassword": "string",
• "sftpClientAuthTypeId": 0,
• "sftpClientSshKeyId": 0,
• "sftpAllowSimultaneousTransfers": true,
• "aS2RemoteUrl": "string",
• "aS2RemoteOrgIdentifier": "string",
• "aS2PublicCertificate": "string",
• "mailTo": "string",
• "mailCC": "string",
• "mailBCC": "string",
• "mailSubject": "string",
• "mailMessage": "string",
• "mailLinkExpirationId": 0,
• "azureAuthTypeId": 0,
• "azureAccessKey": "string",
• "azureConnectionString": "string",
• "azureContainerName": "string",
• "azureContainerUrl": "string",
• "azureStorageAccountName": "string",
• "azureSharedAccessToken": "string",
• "azureBlobClientId": "string",
• "azureBlobClientSecret": "string",
• "azureBlobTenantId": "string",
• "externalIdpTokenEndpoint": "string",
• "externalIdpClientId": "string",
• "externalIdpClientSecret": "string",
• "externalIdpScope": "string",
• "azureFilesShareName": "string",
• "azureFilesShareUrl": "string",
• "httpServerUrl": "string",
• "httpClientUrl": "string",
• "lanNetworkSharePath": "string",
• "lanDomain": "string",
• "lanUsername": "string",
• "lanPassword": "string",
• "sharePointTenantName": "string",
• "sharePointSiteUrl": "string",
• "sharePointClientId": "string",
• "sharePointClientSecret": "string",
• "sharePointDocumentLibrary": "string",
• "thruFileShareSiteUrl": "string",
• "thruFileShareUsername": "string",
• "thruFileSharePassword": "string",
• "googleCloudStorageBucketName": "string",
• "googleCloudStorageServiceAccountKeyJson": "string"

}

Response samples

• 400
• 401
• 403
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Retrieves recent activity data for all accessible endpoints

Requires organization endpoint read permissions to view endpoint activity.

Authorizations:

ApiKeyBearer

query Parameters

count

integer <int32> Maximum number of recent activity records to retrieve

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

Array

id	integer <int32>
name	string or null
organizationId	integer <int32>
organizationName	string or null
code	string or null
createdDate	string <date-time>
updatedDate	string or null <date-time>

https://us.thruinc.com/api/Endpoints/getRecentEndpointActivity

https://uk.thruinc.com/api/Endpoints/getRecentEndpointActivity

https://eu.thruinc.com/api/Endpoints/getRecentEndpointActivity

https://au.thruinc.com/api/Endpoints/getRecentEndpointActivity

Response samples

• 200
• 401
• 403
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Retrieves all flows associated with a specific endpoint

Requires organization endpoint read permissions to view endpoint flows.

Authorizations:

ApiKeyBearer

query Parameters

endpointId

integer <int32> Unique identifier of the endpoint to retrieve flows for

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

Array

id	integer <int32>
tenantId	integer <int32>
name	string or null
flowStatusId	integer <int32>
isBroadcast	boolean
isPublished	boolean
isIPaaSSubscription	boolean
connectorId	integer <int32>
code	string or null
description	string or null
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>
contactId	integer or null <int32>

https://us.thruinc.com/api/Endpoints/getFlows

https://uk.thruinc.com/api/Endpoints/getFlows

https://eu.thruinc.com/api/Endpoints/getFlows

https://au.thruinc.com/api/Endpoints/getFlows

Response samples

• 200
• 401
• 403
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Saves endpoint configuration and applies flows synchronously

Requires organization endpoint update permissions to save and apply flows. Request body must contain valid EndpointEditorViewModel data.

Authorizations:

ApiKeyBearer

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

Endpoint configuration with flow assignments to save and apply

id	integer <int32>
organizationId	integer <int32>
name	string or null
code	string or null
location	string or null
ipAddress	string or null
cidRmask	integer or null <int32>
description	string or null
thruNodeId	string or null
protocolId	integer <int32>
endpointTypeId	integer <int32>
isEnabled	boolean
s3BucketName	string or null
s3AccessKey	string or null
s3SecretKey	string or null
s3RegionTypeId	integer <int32>
s3ServiceUrl	string or null
transferSecretKey	string or null
transferInstallationKey	string or null
ftpsClientIPAddress	string or null
ftpsClientHost	string or null
ftpsClientPort	integer <int32>
ftpsClientUser	string or null
ftpsClientPassword	string or null
ftpsClientAuthTypeId	integer <int32>
ftpsClientCertificateId	integer or null <int32>
sftpClientIPAddress	string or null
sftpClientHost	string or null
sftpClientPort	integer <int32>
sftpClientUser	string or null
sftpUserPassword	string or null
sftpClientAuthTypeId	integer <int32>
sftpClientSshKeyId	integer or null <int32>
sftpAllowSimultaneousTransfers	boolean
aS2RemoteUrl	string or null
aS2RemoteOrgIdentifier	string or null
aS2PublicCertificate	string or null
mailTo	string or null
mailCC	string or null
mailBCC	string or null
mailSubject	string or null
mailMessage	string or null
mailLinkExpirationId	integer <int32>
azureAuthTypeId	integer <int32>
azureAccessKey	string or null
azureConnectionString	string or null
azureContainerName	string or null
azureContainerUrl	string or null
azureStorageAccountName	string or null
azureSharedAccessToken	string or null
azureBlobClientId	string or null
azureBlobClientSecret	string or null
azureBlobTenantId	string or null
externalIdpTokenEndpoint	string or null
externalIdpClientId	string or null
externalIdpClientSecret	string or null
externalIdpScope	string or null
azureFilesShareName	string or null
azureFilesShareUrl	string or null
httpServerUrl	string or null
httpClientUrl	string or null
lanNetworkSharePath	string or null
lanDomain	string or null
lanUsername	string or null
lanPassword	string or null
sharePointTenantName	string or null
sharePointSiteUrl	string or null
sharePointClientId	string or null
sharePointClientSecret	string or null
sharePointDocumentLibrary	string or null
thruFileShareSiteUrl	string or null
thruFileShareUsername	string or null
thruFileSharePassword	string or null
googleCloudStorageBucketName	string or null
googleCloudStorageServiceAccountKeyJson	string or null

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

Array

flowId	integer <int32>
flowName	string or null
success	boolean
message	string or null

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

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

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

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

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "id": 0,
• "organizationId": 0,
• "name": "string",
• "code": "string",
• "location": "string",
• "ipAddress": "string",
• "cidRmask": 0,
• "description": "string",
• "thruNodeId": "string",
• "protocolId": 0,
• "endpointTypeId": 0,
• "isEnabled": true,
• "s3BucketName": "string",
• "s3AccessKey": "string",
• "s3SecretKey": "string",
• "s3RegionTypeId": 0,
• "s3ServiceUrl": "string",
• "transferSecretKey": "string",
• "transferInstallationKey": "string",
• "ftpsClientIPAddress": "string",
• "ftpsClientHost": "string",
• "ftpsClientPort": 0,
• "ftpsClientUser": "string",
• "ftpsClientPassword": "string",
• "ftpsClientAuthTypeId": 0,
• "ftpsClientCertificateId": 0,
• "sftpClientIPAddress": "string",
• "sftpClientHost": "string",
• "sftpClientPort": 0,
• "sftpClientUser": "string",
• "sftpUserPassword": "string",
• "sftpClientAuthTypeId": 0,
• "sftpClientSshKeyId": 0,
• "sftpAllowSimultaneousTransfers": true,
• "aS2RemoteUrl": "string",
• "aS2RemoteOrgIdentifier": "string",
• "aS2PublicCertificate": "string",
• "mailTo": "string",
• "mailCC": "string",
• "mailBCC": "string",
• "mailSubject": "string",
• "mailMessage": "string",
• "mailLinkExpirationId": 0,
• "azureAuthTypeId": 0,
• "azureAccessKey": "string",
• "azureConnectionString": "string",
• "azureContainerName": "string",
• "azureContainerUrl": "string",
• "azureStorageAccountName": "string",
• "azureSharedAccessToken": "string",
• "azureBlobClientId": "string",
• "azureBlobClientSecret": "string",
• "azureBlobTenantId": "string",
• "externalIdpTokenEndpoint": "string",
• "externalIdpClientId": "string",
• "externalIdpClientSecret": "string",
• "externalIdpScope": "string",
• "azureFilesShareName": "string",
• "azureFilesShareUrl": "string",
• "httpServerUrl": "string",
• "httpClientUrl": "string",
• "lanNetworkSharePath": "string",
• "lanDomain": "string",
• "lanUsername": "string",
• "lanPassword": "string",
• "sharePointTenantName": "string",
• "sharePointSiteUrl": "string",
• "sharePointClientId": "string",
• "sharePointClientSecret": "string",
• "sharePointDocumentLibrary": "string",
• "thruFileShareSiteUrl": "string",
• "thruFileShareUsername": "string",
• "thruFileSharePassword": "string",
• "googleCloudStorageBucketName": "string",
• "googleCloudStorageServiceAccountKeyJson": "string"

}

Response samples

• 200
• 400
• 401
• 403
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Saves endpoint configuration and applies flows asynchronously

Requires organization endpoint update permissions to save and apply flows asynchronously. Request body must contain valid EndpointEditorViewModel data.

Authorizations:

ApiKeyBearer

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

Endpoint configuration with flow assignments to save and apply

id	integer <int32>
organizationId	integer <int32>
name	string or null
code	string or null
location	string or null
ipAddress	string or null
cidRmask	integer or null <int32>
description	string or null
thruNodeId	string or null
protocolId	integer <int32>
endpointTypeId	integer <int32>
isEnabled	boolean
s3BucketName	string or null
s3AccessKey	string or null
s3SecretKey	string or null
s3RegionTypeId	integer <int32>
s3ServiceUrl	string or null
transferSecretKey	string or null
transferInstallationKey	string or null
ftpsClientIPAddress	string or null
ftpsClientHost	string or null
ftpsClientPort	integer <int32>
ftpsClientUser	string or null
ftpsClientPassword	string or null
ftpsClientAuthTypeId	integer <int32>
ftpsClientCertificateId	integer or null <int32>
sftpClientIPAddress	string or null
sftpClientHost	string or null
sftpClientPort	integer <int32>
sftpClientUser	string or null
sftpUserPassword	string or null
sftpClientAuthTypeId	integer <int32>
sftpClientSshKeyId	integer or null <int32>
sftpAllowSimultaneousTransfers	boolean
aS2RemoteUrl	string or null
aS2RemoteOrgIdentifier	string or null
aS2PublicCertificate	string or null
mailTo	string or null
mailCC	string or null
mailBCC	string or null
mailSubject	string or null
mailMessage	string or null
mailLinkExpirationId	integer <int32>
azureAuthTypeId	integer <int32>
azureAccessKey	string or null
azureConnectionString	string or null
azureContainerName	string or null
azureContainerUrl	string or null
azureStorageAccountName	string or null
azureSharedAccessToken	string or null
azureBlobClientId	string or null
azureBlobClientSecret	string or null
azureBlobTenantId	string or null
externalIdpTokenEndpoint	string or null
externalIdpClientId	string or null
externalIdpClientSecret	string or null
externalIdpScope	string or null
azureFilesShareName	string or null
azureFilesShareUrl	string or null
httpServerUrl	string or null
httpClientUrl	string or null
lanNetworkSharePath	string or null
lanDomain	string or null
lanUsername	string or null
lanPassword	string or null
sharePointTenantName	string or null
sharePointSiteUrl	string or null
sharePointClientId	string or null
sharePointClientSecret	string or null
sharePointDocumentLibrary	string or null
thruFileShareSiteUrl	string or null
thruFileShareUsername	string or null
thruFileSharePassword	string or null
googleCloudStorageBucketName	string or null
googleCloudStorageServiceAccountKeyJson	string or null

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

jobId	string or null
message	string or null
	Array of objects or null (FlowJobItemDto)

https://us.thruinc.com/api/Endpoints/saveAndApplyAsync

https://uk.thruinc.com/api/Endpoints/saveAndApplyAsync

https://eu.thruinc.com/api/Endpoints/saveAndApplyAsync

https://au.thruinc.com/api/Endpoints/saveAndApplyAsync

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "id": 0,
• "organizationId": 0,
• "name": "string",
• "code": "string",
• "location": "string",
• "ipAddress": "string",
• "cidRmask": 0,
• "description": "string",
• "thruNodeId": "string",
• "protocolId": 0,
• "endpointTypeId": 0,
• "isEnabled": true,
• "s3BucketName": "string",
• "s3AccessKey": "string",
• "s3SecretKey": "string",
• "s3RegionTypeId": 0,
• "s3ServiceUrl": "string",
• "transferSecretKey": "string",
• "transferInstallationKey": "string",
• "ftpsClientIPAddress": "string",
• "ftpsClientHost": "string",
• "ftpsClientPort": 0,
• "ftpsClientUser": "string",
• "ftpsClientPassword": "string",
• "ftpsClientAuthTypeId": 0,
• "ftpsClientCertificateId": 0,
• "sftpClientIPAddress": "string",
• "sftpClientHost": "string",
• "sftpClientPort": 0,
• "sftpClientUser": "string",
• "sftpUserPassword": "string",
• "sftpClientAuthTypeId": 0,
• "sftpClientSshKeyId": 0,
• "sftpAllowSimultaneousTransfers": true,
• "aS2RemoteUrl": "string",
• "aS2RemoteOrgIdentifier": "string",
• "aS2PublicCertificate": "string",
• "mailTo": "string",
• "mailCC": "string",
• "mailBCC": "string",
• "mailSubject": "string",
• "mailMessage": "string",
• "mailLinkExpirationId": 0,
• "azureAuthTypeId": 0,
• "azureAccessKey": "string",
• "azureConnectionString": "string",
• "azureContainerName": "string",
• "azureContainerUrl": "string",
• "azureStorageAccountName": "string",
• "azureSharedAccessToken": "string",
• "azureBlobClientId": "string",
• "azureBlobClientSecret": "string",
• "azureBlobTenantId": "string",
• "externalIdpTokenEndpoint": "string",
• "externalIdpClientId": "string",
• "externalIdpClientSecret": "string",
• "externalIdpScope": "string",
• "azureFilesShareName": "string",
• "azureFilesShareUrl": "string",
• "httpServerUrl": "string",
• "httpClientUrl": "string",
• "lanNetworkSharePath": "string",
• "lanDomain": "string",
• "lanUsername": "string",
• "lanPassword": "string",
• "sharePointTenantName": "string",
• "sharePointSiteUrl": "string",
• "sharePointClientId": "string",
• "sharePointClientSecret": "string",
• "sharePointDocumentLibrary": "string",
• "thruFileShareSiteUrl": "string",
• "thruFileShareUsername": "string",
• "thruFileSharePassword": "string",
• "googleCloudStorageBucketName": "string",
• "googleCloudStorageServiceAccountKeyJson": "string"

}

Response samples

• 200
• 400
• 401
• 403
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Retrieves the status and results of an asynchronous flow application job

Requires organization endpoint read permissions to view flow application job status.

Authorizations:

ApiKeyBearer

path Parameters

jobId required

string Unique identifier of the flow application job

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

jobId	string or null
status	string or null
endpointId	integer or null <int32>
endpointName	string or null
createdAt	string <date-time>
completedAt	string or null <date-time>
errorMessage	string or null
	Array of objects or null (FlowApplyResultDto)

https://us.thruinc.com/api/Endpoints/flowApplyJob/{jobId}

https://uk.thruinc.com/api/Endpoints/flowApplyJob/{jobId}

https://eu.thruinc.com/api/Endpoints/flowApplyJob/{jobId}

https://au.thruinc.com/api/Endpoints/flowApplyJob/{jobId}

Response samples

• 200
• 401
• 403
• 404
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample