A valid request URL is required to generate request examples{
"Workspaceid": "<string>",
"ArchiveDestination": "<string>",
"ArchiveFolder": "<string>",
"AutoTaskType": "<string>",
"AutoTaskInterval": "<string>",
"CleanupReceiveFolder": true,
"CleanupSendFolder": true,
"CleanupSentFolder": true,
"CleanupTransactions": true,
"EmailSendGridURL": "<string>",
"EmailSendGridAPIKey": "<string>",
"EmailProtocol": "<string>",
"NotifyEmail": true,
"NotifyEmailFrom": "<string>",
"NotifyEmailTo": "<string>",
"NotifyEmailSubject": "<string>",
"MaxFilesPerPort": "<string>",
"MaxWorkersPerPort": "<string>",
"SMTPServer": "<string>",
"SMTPUser": "<string>",
"SMTPPassword": "<string>",
"SMTPPort": "<string>",
"SMTPSSLMode": "<string>",
"Other": "<string>"
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}Return a single workspaces
Returns a single workspaces object using the specified key.
A valid request URL is required to generate request examples{
"Workspaceid": "<string>",
"ArchiveDestination": "<string>",
"ArchiveFolder": "<string>",
"AutoTaskType": "<string>",
"AutoTaskInterval": "<string>",
"CleanupReceiveFolder": true,
"CleanupSendFolder": true,
"CleanupSentFolder": true,
"CleanupTransactions": true,
"EmailSendGridURL": "<string>",
"EmailSendGridAPIKey": "<string>",
"EmailProtocol": "<string>",
"NotifyEmail": true,
"NotifyEmailFrom": "<string>",
"NotifyEmailTo": "<string>",
"NotifyEmailSubject": "<string>",
"MaxFilesPerPort": "<string>",
"MaxWorkersPerPort": "<string>",
"SMTPServer": "<string>",
"SMTPUser": "<string>",
"SMTPPassword": "<string>",
"SMTPPort": "<string>",
"SMTPSSLMode": "<string>",
"Other": "<string>"
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}Authorizations
Path Parameters
The key Workspaceid
Query Parameters
Select structural property
Response
workspaces response
The workspace Id.
The type of storage location where archived transactions and files should be stored (such as local file system or S3). Available values are 'LocalDisk, S3'.
The file path or folder location where Arc stores archived transaction logs and processed files for long-term retention.
The type of automated maintenance task to run. Available values are 'Delete, Archive'.
How many days of records to keep.
Include files in Receive folders in cleanup operations.
Include files in Send folders in cleanup operations.
Include files in Sent folders in cleanup operations.
Include transactions in cleanup operations.
The SendGrid API endpoint URL used when sending email notifications through the SendGrid service.
The API key required to authenticate with SendGrid for sending emails from Arc.
The email protocol to use for sending notifications. Available values are 'SMTP, SendGrid'.
Send an email to the specified email addresses when an error is encountered.
The email address used as the sender of notification emails.
A comma-separated list of notification email recipients.
The notification email subject.
The maximum number of files sent by each thread assigned to the connector.
The number of worker threads allocated to the connector for parallel processing.
The host name or IP address of your SMTP server.
The username to authenticate to your SMTP server.
The password to authenticate to your SMTP server.
The port of your SMTP server.
The SSL mode of your SMTP server.
The list of properties above is not comprehensive. You can use the API to set any profile property not listed above, using the same name/value format. All available profile default properties are returned in a GET request. You do not need to include an Other property when using additional settings that are not listed here.