List channels

The type of this object, always core.IntegrationPartnerChannelHTTP. Required where the member it is sent in accepts several types.

Whether the channel is in use. Only active channels take part at runtime: logins on the platform's servers and the matching of incoming data to a partner skip inactive ones. A partner whose status is INACTIVE makes all its channels read as false in the channel list.

Whether the transfers over this channel are written to the communication log. null or left out keeps the stored value; a channel that never stored the setting reads as true.

Number of days the communication log keeps this channel's entries; 0 and up are stored, -1 removes the setting so the communication log service's global retention applies. Only used while communicationLogEnabled is on. null or left out keeps the stored value; a channel that never stored one reads -1.

The way data flows over the channel: IN (the partner sends to the platform), OUT (the platform sends to the partner) or IN_AND_OUT. Left out or null on create it defaults to IN; it cannot be set to null afterwards. JMS, AMQP 0-9-1, AMQP 1.0, Google Pub/Sub, cloud storage and SMB channels are always IN_AND_OUT: that is their default, any other value is refused, and a patch sending null there changes nothing. A legacy channel of these types stored with neither flag set reads IN_AND_OUT and has both flags set by its next write. Any other channel stored before this member existed, with no direction, reads back without it until one is written.

Authentication realm of the partner's login: a login on the platform's HTTP server only finds this channel when the realm of the protected area being called matches.

Numeric id of the channel, assigned by the server on create; on the channel resource a value sent in the body is ignored. Profiles reference a channel by this id, looked up with GET /platform/api/partners/preview/{partnerId}/channels.

Whether the channel stays on the platform's own server and is not synchronized to a DMZ server (the editor's "Invisible to DMZ" switch). null or left out keeps the stored value; a new channel is visible to the DMZ, except a new SMB channel, which is stored invisible unless it sends false. A new JMS, AMQP 0-9-1, AMQP 1.0, Google Pub/Sub and cloud storage channel is stored invisible to the DMZ, as the editor does; there the member reads absent, a value sent is ignored and a stored channel keeps its flag.

Id of one of the platform's own certificates (with private key) that this channel uses. Must reference an existing certificate.

User name the platform authenticates with at the partner's HTTP server; its password is not settable through this API. null or left out keeps the stored value.

Display name of the channel. Must be unique among the partner's channels of the same type.

Name of the rate-limit policy applied to requests the partner sends through this HTTP channel. Global is built in. null or left out keeps the stored value; a blank string clears it.

Id of the partner's certificate (public key) in the certificate store that this channel uses, the counterpart of localCertificateId. Must reference an existing certificate.

User name the partner logs in with on the platform's HTTP server (HTTP authentication); its password is not settable through this API. Must be unique among all HTTP channels. Left out, the server fills an AUTO_CREATE_... placeholder that nobody can log in with.

Base URL of the partner's server. An HTTP response unit that names this channel takes the host (and the port, if the unit sets none) from it when its own host is empty or <serverurl>, and replaces <serverurl> in its URL with this URL's path; an HTTP cron job replaces <serverurl> with the whole URL.

The type of this object, always core.IntegrationPartnerChannelSFTP. Required where the member it is sent in accepts several types.

Whether the channel is in use. Only active channels take part at runtime: logins on the platform's servers and the matching of incoming data to a partner skip inactive ones. A partner whose status is INACTIVE makes all its channels read as false in the channel list.

Whether the transfers over this channel are written to the communication log. null or left out keeps the stored value; a channel that never stored the setting reads as true.

Number of days the communication log keeps this channel's entries; 0 and up are stored, -1 removes the setting so the communication log service's global retention applies. Only used while communicationLogEnabled is on. null or left out keeps the stored value; a channel that never stored one reads -1.

The way data flows over the channel: IN (the partner sends to the platform), OUT (the platform sends to the partner) or IN_AND_OUT. Left out or null on create it defaults to IN; it cannot be set to null afterwards. JMS, AMQP 0-9-1, AMQP 1.0, Google Pub/Sub, cloud storage and SMB channels are always IN_AND_OUT: that is their default, any other value is refused, and a patch sending null there changes nothing. A legacy channel of these types stored with neither flag set reads IN_AND_OUT and has both flags set by its next write. Any other channel stored before this member existed, with no direction, reads back without it until one is written.

Host name or IP address of the partner's SFTP server - no scheme, port or path. Used when the platform connects to the partner; a host set in the cron job or response unit overrides it. {"host": null, "port": null} clears the address.

Numeric id of the channel, assigned by the server on create; on the channel resource a value sent in the body is ignored. Profiles reference a channel by this id, looked up with GET /platform/api/partners/preview/{partnerId}/channels.

Whether the channel stays on the platform's own server and is not synchronized to a DMZ server (the editor's "Invisible to DMZ" switch). null or left out keeps the stored value; a new channel is visible to the DMZ, except a new SMB channel, which is stored invisible unless it sends false. A new JMS, AMQP 0-9-1, AMQP 1.0, Google Pub/Sub and cloud storage channel is stored invisible to the DMZ, as the editor does; there the member reads absent, a value sent is ignored and a stored channel keeps its flag.

Fingerprint of the host key the partner's SFTP server must present when the platform connects; compared case-insensitively together with keyType, and the connection fails on a mismatch. Left blank, any host key is accepted.

Type of the host key the partner's SFTP server must present, as the SSH library reports it; checked together with keyFingerprint.

User name the platform logs in with at the partner's SFTP server (SSH login); its password is not settable through this API. null or left out keeps the stored value.

Display name of the channel. Must be unique among the partner's channels of the same type.

TCP port of the partner's SFTP server. Requires host. A port set in the cron job or response unit overrides it.

Id of the local certificate holding the key pair the platform authenticates with (public-key authentication) when it connects to the partner's SFTP server. Must reference an existing certificate with an SSH common name.

User name the partner logs in with on the platform's SFTP server; its password is remotePassword, its public keys are remoteCertificateIds. Must be unique among all SFTP channels. Left out, the server fills an AUTO_CREATE_... placeholder that nobody can log in with.

The password the partner logs in with on the platform's server as remoteId. A secret: a read returns it encrypted, a write accepts that encrypted value unchanged or the cleartext as "PLAIN:<text>". Required on create. A channel that has one cannot be changed to an empty one; a channel stored without one stays writable without. null or left out keeps the stored value. Holds a secret. A read returns it encrypted; a write accepts either that encrypted form or the cleartext behind a "PLAIN:" prefix, and rejects anything else.

Directory on the Lobster server that becomes the partner's home when it logs in to the platform's SFTP server as remoteId (relative paths resolve against the server's working directory). Not a path on the partner's server. Without one the partner's file paths resolve against the server's working directory. Left out or blank on create, the server picks <client default channel directory>ssh/<id hash> like the channel editor and creates that directory, on the DMZ too where one is configured; a directory given here is not created. A stored directory cannot be changed to a blank one (422), which an overwrite patch that leaves the member out would do.

Whether the partner, logged in on the platform's SFTP server, sees a virtual file system with its home directory as the root (/) instead of the real path of the home directory. null or left out keeps the stored value; a new channel shows the real path.

Character set the SFTP/SCP server and client use for file names on the wire, e.g. ISO-8859-1. Not validated on save. Leaving it out keeps the stored value, null or an empty string removes it so the SSH library's default applies.

The type of this object, always core.IntegrationPartnerChannelCloudStorage. Required where the member it is sent in accepts several types.

Whether the channel is in use. Only active channels take part at runtime: logins on the platform's servers and the matching of incoming data to a partner skip inactive ones. A partner whose status is INACTIVE makes all its channels read as false in the channel list.

Provider-specific extra value: the AWS region for S3, the project id for GOOGLE_CLOUD, the Microsoft tenant for ONEDRIVE_M365 (filled with common when left out on create), the storage account for Azure with OAuth2. Required on create for S3 and GOOGLE_CLOUD, and for these three providers a write may not blank it.

The id the channel authenticates with at the provider - the access key id for S3, the Google e-mail for GOOGLE_CLOUD, the storage account name for Azure with shared key, the app's client id for the OAuth providers. An identifier, not a secret. Required on create; a write may not blank it. Two channels must not share the same provider, applicationId and additionalParam while neither has a secret yet.

Whether the transfers over this channel are written to the communication log. null or left out keeps the stored value; a channel that never stored the setting reads as true.

Number of days the communication log keeps this channel's entries; 0 and up are stored, -1 removes the setting so the communication log service's global retention applies. Only used while communicationLogEnabled is on. null or left out keeps the stored value; a channel that never stored one reads -1.

The way data flows over the channel: IN (the partner sends to the platform), OUT (the platform sends to the partner) or IN_AND_OUT. Left out or null on create it defaults to IN; it cannot be set to null afterwards. JMS, AMQP 0-9-1, AMQP 1.0, Google Pub/Sub, cloud storage and SMB channels are always IN_AND_OUT: that is their default, any other value is refused, and a patch sending null there changes nothing. A legacy channel of these types stored with neither flag set reads IN_AND_OUT and has both flags set by its next write. Any other channel stored before this member existed, with no direction, reads back without it until one is written.

Numeric id of the channel, assigned by the server on create; on the channel resource a value sent in the body is ignored. Profiles reference a channel by this id, looked up with GET /platform/api/partners/preview/{partnerId}/channels.

Whether the channel stays on the platform's own server and is not synchronized to a DMZ server (the editor's "Invisible to DMZ" switch). null or left out keeps the stored value; a new channel is visible to the DMZ, except a new SMB channel, which is stored invisible unless it sends false. A new JMS, AMQP 0-9-1, AMQP 1.0, Google Pub/Sub and cloud storage channel is stored invisible to the DMZ, as the editor does; there the member reads absent, a value sent is ignored and a stored channel keeps its flag.

Whether the channel runs the older of the two cloud client implementations; true for a channel that never stored a choice. Read-only: it decides where the secret is kept.

Display name of the channel. Must be unique among the partner's channels of the same type.

For AZURE_FILE and AZURE_BLOB: true when the channel authenticates with OAuth2 (then tenant and additionalParam apply), false for a shared key. Read-only.

OAuth2 token endpoint the channel refreshes its access token at. Derived by the platform from provider (and the tenant) once the channel is authorised; usually empty before. Read-only.

The cloud service this channel connects to. Required on create and fixed afterwards; an explicit null keeps the stored provider.

Microsoft tenant (directory) id or domain, used to build the OAuth2 token URL of an AZURE_FILE or AZURE_BLOB channel that authenticates with OAuth2 instead of a shared key (see oauth2Authentication).

The type of this object, always core.IntegrationPartnerChannelMail. Required where the member it is sent in accepts several types.

Whether the channel is in use. Only active channels take part at runtime: logins on the platform's servers and the matching of incoming data to a partner skip inactive ones. A partner whose status is INACTIVE makes all its channels read as false in the channel list.

Whether the transfers over this channel are written to the communication log. null or left out keeps the stored value; a channel that never stored the setting reads as true.

Number of days the communication log keeps this channel's entries; 0 and up are stored, -1 removes the setting so the communication log service's global retention applies. Only used while communicationLogEnabled is on. null or left out keeps the stored value; a channel that never stored one reads -1.

The way data flows over the channel: IN (the partner sends to the platform), OUT (the platform sends to the partner) or IN_AND_OUT. Left out or null on create it defaults to IN; it cannot be set to null afterwards. JMS, AMQP 0-9-1, AMQP 1.0, Google Pub/Sub, cloud storage and SMB channels are always IN_AND_OUT: that is their default, any other value is refused, and a patch sending null there changes nothing. A legacy channel of these types stored with neither flag set reads IN_AND_OUT and has both flags set by its next write. Any other channel stored before this member existed, with no direction, reads back without it until one is written.

Cipher for encrypting outgoing mails; used only when the channel sends encrypted. Not validated on save. null or left out keeps the stored value.

Numeric id of the channel, assigned by the server on create; on the channel resource a value sent in the body is ignored. Profiles reference a channel by this id, looked up with GET /platform/api/partners/preview/{partnerId}/channels.

IMAP folder mail is fetched from; a directory set in the IMAP cron job overrides it.

Largest incoming mail accepted on this channel, in bytes. Must be at most 1073741824 (1024 MB). null (or leaving it out on create) means no limit, and an unlimited channel reads back null.

Whether the channel stays on the platform's own server and is not synchronized to a DMZ server (the editor's "Invisible to DMZ" switch). null or left out keeps the stored value; a new channel is visible to the DMZ, except a new SMB channel, which is stored invisible unless it sends false. A new JMS, AMQP 0-9-1, AMQP 1.0, Google Pub/Sub and cloud storage channel is stored invisible to the DMZ, as the editor does; there the member reads absent, a value sent is ignored and a stored channel keeps its flag.

Id of one of the platform's own certificates (with private key) that this channel uses. Must reference an existing certificate.

The platform's own mail address on this channel; matched case-insensitively, so an incoming mail is assigned to the channel whatever case it is addressed in, while the address is stored and read back as given. Unless the channel stores its own SMTP or retrieval user name, the platform logs in with this address, so changing it changes that login too. null or left out keeps the stored value.

Id of the platform's own certificate (with private key) it presents as TLS client certificate when it connects to the partner. Must reference an existing certificate. Leaving it out keeps the stored value, null or an empty string removes it.

Display name of the channel. Must be unique among the partner's channels of the same type.

Whether the messages the partner sends over this channel must be encrypted. Leaving it out keeps the stored value, null resets it to false; a new channel accepts unencrypted messages.

Whether the messages the partner sends over this channel must be signed. Leaving it out keeps the stored value, null resets it to false; a new channel accepts unsigned messages.

Id of the partner's certificate (public key) in the certificate store that this channel uses, the counterpart of localCertificateId. Must reference an existing certificate.

The partner's mail address, stored in lower case; an SMTP response unit sends to it unless the unit names its own receiver. A channel that receives mail should hold exactly one address; this API does not check. Left out, the server fills a placeholder address (mail...@mail.org).

Id of the partner's certificate (public key) it must present as TLS client certificate when it connects to the platform. Must reference an existing certificate. Leaving it out keeps the stored value, null or an empty string removes it.

SASL mechanism for the POP3/IMAP login when mail is fetched through this channel; left out, the mail library negotiates one.

POP3/IMAP server the platform fetches mail from through this channel (pop3://, pop3s://, pop3es://, imap://, imaps:// or imapes://; the s variants are TLS, the es variants STARTTLS). Another scheme is accepted as given and fails when mail is retrieved. null or left out keeps the stored value.

Whether the messages the platform sends over this channel are compressed. Leaving it out keeps the stored value, null resets it to false; a new channel does not compress.

Whether the messages the platform sends over this channel are encrypted. Leaving it out keeps the stored value, null resets it to false; a new channel does not encrypt.

Whether the messages the platform sends over this channel are signed. Leaving it out keeps the stored value, null resets it to false; a new channel does not sign.

Hash algorithm for signing outgoing mails; used only when the channel sends signed. Not validated on save. null or left out keeps the stored value.

SASL mechanism for the SMTP login, case-insensitive; OAuth2 tokens are not settable through this API. Left out, the mail library negotiates one.

SMTP server that mails to this partner are sent through (smtp:// default port 25, smtps:// 465, smtpes:// for STARTTLS). A host or port set in the SMTP response unit overrides it.

The type of this object, always core.IntegrationPartnerChannelX400. Required where the member it is sent in accepts several types.

Whether the channel is in use. Only active channels take part at runtime: logins on the platform's servers and the matching of incoming data to a partner skip inactive ones. A partner whose status is INACTIVE makes all its channels read as false in the channel list.

Whether the transfers over this channel are written to the communication log. null or left out keeps the stored value; a channel that never stored the setting reads as true.

Number of days the communication log keeps this channel's entries; 0 and up are stored, -1 removes the setting so the communication log service's global retention applies. Only used while communicationLogEnabled is on. null or left out keeps the stored value; a channel that never stored one reads -1.

The way data flows over the channel: IN (the partner sends to the platform), OUT (the platform sends to the partner) or IN_AND_OUT. Left out or null on create it defaults to IN; it cannot be set to null afterwards. JMS, AMQP 0-9-1, AMQP 1.0, Google Pub/Sub, cloud storage and SMB channels are always IN_AND_OUT: that is their default, any other value is refused, and a patch sending null there changes nothing. A legacy channel of these types stored with neither flag set reads IN_AND_OUT and has both flags set by its next write. Any other channel stored before this member existed, with no direction, reads back without it until one is written.

Numeric id of the channel, assigned by the server on create; on the channel resource a value sent in the body is ignored. Profiles reference a channel by this id, looked up with GET /platform/api/partners/preview/{partnerId}/channels.

Whether the channel stays on the platform's own server and is not synchronized to a DMZ server (the editor's "Invisible to DMZ" switch). null or left out keeps the stored value; a new channel is visible to the DMZ, except a new SMB channel, which is stored invisible unless it sends false. A new JMS, AMQP 0-9-1, AMQP 1.0, Google Pub/Sub and cloud storage channel is stored invisible to the DMZ, as the editor does; there the member reads absent, a value sent is ignored and a stored channel keeps its flag.

The platform's own O/R address toward this partner: the sender of messages sent through this channel (unless the response unit names one), and incoming messages must be addressed to it.

The largest TPDU (transport data unit) in bytes the X.400 client uses. 0 restores the default; leaving it out keeps the stored value, null restores it too.

Display name of the channel. Must be unique among the partner's channels of the same type.

Presentation selector the X.400 client addresses on the X.400 server. Left out, the client's default applies; [empty] sends an explicitly empty value.

The partner's O/R address: the receiver of messages sent through this channel (unless the response unit names one), and an incoming message is assigned to this channel by its sender address (compared in upper case). Left out, the server fills a placeholder address (S=dummy;A=VIAT;C=DE;O=...).

Whether the X.400 mailbox can filter the messages it hands out by address. Leaving it out keeps the stored value, null resets it to false.

Session selector the X.400 client addresses on the X.400 server. Left out, the client's default applies; [empty] sends an explicitly empty value.

Transport access point (TSAP) the X.400 client sends when connecting to the X.400 server. Left out, the client's default applies; [empty] sends an explicitly empty value.

Configuration directory of the legacy UAFI X.400 interface. Stored only: the editor does not show it and the built-in X.400 client does not use it.

Incoming directory of the legacy UAFI X.400 interface. Stored only: the editor does not show it and the built-in X.400 client does not use it.

Outgoing directory of the legacy UAFI X.400 interface. Stored only: the editor does not show it and the built-in X.400 client does not use it.

The type of this object, always core.IntegrationPartnerChannelAS2. Required where the member it is sent in accepts several types.

Whether the channel is in use. Only active channels take part at runtime: logins on the platform's servers and the matching of incoming data to a partner skip inactive ones. A partner whose status is INACTIVE makes all its channels read as false in the channel list.

The partner's AS2 endpoint that outgoing messages are posted to; an AS2 response unit without its own URL uses it.

Whether the transfers over this channel are written to the communication log. null or left out keeps the stored value; a channel that never stored the setting reads as true.

Number of days the communication log keeps this channel's entries; 0 and up are stored, -1 removes the setting so the communication log service's global retention applies. Only used while communicationLogEnabled is on. null or left out keeps the stored value; a channel that never stored one reads -1.

The way data flows over the channel: IN (the partner sends to the platform), OUT (the platform sends to the partner) or IN_AND_OUT. Left out or null on create it defaults to IN; it cannot be set to null afterwards. JMS, AMQP 0-9-1, AMQP 1.0, Google Pub/Sub, cloud storage and SMB channels are always IN_AND_OUT: that is their default, any other value is refused, and a patch sending null there changes nothing. A legacy channel of these types stored with neither flag set reads IN_AND_OUT and has both flags set by its next write. Any other channel stored before this member existed, with no direction, reads back without it until one is written.

Cipher for encrypting outgoing messages; used only when the channel sends encrypted. Not validated on save.

Numeric id of the channel, assigned by the server on create; on the channel resource a value sent in the body is ignored. Profiles reference a channel by this id, looked up with GET /platform/api/partners/preview/{partnerId}/channels.

Whether the channel stays on the platform's own server and is not synchronized to a DMZ server (the editor's "Invisible to DMZ" switch). null or left out keeps the stored value; a new channel is visible to the DMZ, except a new SMB channel, which is stored invisible unless it sends false. A new JMS, AMQP 0-9-1, AMQP 1.0, Google Pub/Sub and cloud storage channel is stored invisible to the DMZ, as the editor does; there the member reads absent, a value sent is ignored and a stored channel keeps its flag.

Id of one of the platform's own certificates (with private key) that this channel uses. Must reference an existing certificate.

Id of the platform's own certificate (with private key) that signs the messages it sends over this channel. Must reference an existing certificate. Reads as absent while the channel signs with localCertificateId, which is what applies when it is unset. Leaving it out keeps the stored value, null or an empty string removes it.

Id of the platform's own certificate (with private key) it presents as TLS client certificate when it connects to the partner. Must reference an existing certificate. Reads as absent while the channel uses localCertificateId, which applies when it is unset. Leaving it out keeps the stored value, null or an empty string removes it.

Hash algorithm the MDN (receipt) is signed with, e.g. SHA256. Not validated on save. Leaving it out keeps the stored value, null or an empty string removes it.

Which MDN (receipt) the platform requests for outgoing messages: DEFAULT = the AS2 service's system setting, SYNCHRON = returned in the HTTP response, ASYNCHRON = sent later to the MDN URL. A channel stored with another code reads back without mdnMode, and a write that leaves it out keeps that code.

Display name of the channel. Must be unique among the partner's channels of the same type.

The partner's AS2 id: sent as AS2-To on outgoing messages, and an incoming message is assigned to this channel by its AS2-From. Left out, the server fills an AUTO_CREATE_... placeholder that no partner sends.

Whether the messages the partner sends over this channel must be encrypted. Leaving it out keeps the stored value, null resets it to false; a new channel accepts unencrypted messages.

Whether the messages the partner sends over this channel must be signed. Leaving it out keeps the stored value, null resets it to false; a new channel accepts unsigned messages.

Id of the partner's certificate (public key) in the certificate store that this channel uses, the counterpart of localCertificateId. Must reference an existing certificate.

Id of the partner's certificate (public key) that the signature of the messages it sends over this channel is checked against. Must reference an existing certificate. Reads as absent while the channel checks against remoteCertificateId, which is what applies when it is unset. Leaving it out keeps the stored value, null or an empty string removes it.

Id of the partner's certificate (public key) it must present as TLS client certificate when it connects to the platform. Must reference an existing certificate. Reads as absent while the channel expects remoteCertificateId, which applies when it is unset. Leaving it out keeps the stored value, null or an empty string removes it.

Whether the security settings of the message signature are removed (the editor's "Remove security settings of signature" switch). Leaving it out keeps the stored value, null resets it to false; a new channel keeps them.

Whether outgoing messages are sent with chunked transfer encoding, split into blocks, instead of with a content length. Leaving it out keeps the stored value, null resets it to false; a new channel does not chunk.

Whether the messages the platform sends over this channel are compressed. Leaving it out keeps the stored value, null resets it to false; a new channel does not compress.

Whether the messages the platform sends over this channel are encrypted. Leaving it out keeps the stored value, null resets it to false; a new channel does not encrypt.

URL the partner sends the asynchronous MDN (receipt) to; only used with mdnMode ASYNCHRON. Must be an HTTP or HTTPS URL. Leaving it out keeps the stored value, null or an empty string removes it.

Whether the messages the platform sends over this channel are signed. Leaving it out keeps the stored value, null resets it to false; a new channel does not sign.

Hash algorithm for signing outgoing messages; used only when the channel sends signed. Not validated on save.

The platform's own AS2 id toward this partner: sent as AS2-From on outgoing messages and expected as AS2-To on incoming ones. Required on create; a write may not blank it. Together with partnerAs2Id it must be unique among AS2 channels.

The type of this object, always core.IntegrationPartnerChannelOFTP. Required where the member it is sent in accepts several types.

Whether the certificates are exchanged with this partner automatically. Leaving it out keeps the stored value, null resets it to false.

Whether the channel is in use. Only active channels take part at runtime: logins on the platform's servers and the matching of incoming data to a partner skip inactive ones. A partner whose status is INACTIVE makes all its channels read as false in the channel list.

Whether the transfers over this channel are written to the communication log. null or left out keeps the stored value; a channel that never stored the setting reads as true.

Number of days the communication log keeps this channel's entries; 0 and up are stored, -1 removes the setting so the communication log service's global retention applies. Only used while communicationLogEnabled is on. null or left out keeps the stored value; a channel that never stored one reads -1.

The credit count of the OFTP session. 0 removes the setting; leaving it out keeps the stored value, null removes it too.

The way data flows over the channel: IN (the partner sends to the platform), OUT (the platform sends to the partner) or IN_AND_OUT. Left out or null on create it defaults to IN; it cannot be set to null afterwards. JMS, AMQP 0-9-1, AMQP 1.0, Google Pub/Sub, cloud storage and SMB channels are always IN_AND_OUT: that is their default, any other value is refused, and a patch sending null there changes nothing. A legacy channel of these types stored with neither flag set reads IN_AND_OUT and has both flags set by its next write. Any other channel stored before this member existed, with no direction, reads back without it until one is written.

Whether the platform may send the change-direction command twice in a row. Leaving it out keeps the stored value, null resets it to false.

Whether the partner's end-to-end responses must be signed. Leaving it out keeps the stored value, null resets it to false.

The encryption algorithm for OFTP messages. Leaving it out keeps the stored value, null resets it to AES256.

The partner's OFTP server the platform connects to; oftps:// uses TLS (commonly port 6619).

The size of the exchange buffer in bytes. 0 removes the setting; leaving it out keeps the stored value, null removes it too.

Numeric id of the channel, assigned by the server on create; on the channel resource a value sent in the body is ignored. Profiles reference a channel by this id, looked up with GET /platform/api/partners/preview/{partnerId}/channels.

Whether the channel stays on the platform's own server and is not synchronized to a DMZ server (the editor's "Invisible to DMZ" switch). null or left out keeps the stored value; a new channel is visible to the DMZ, except a new SMB channel, which is stored invisible unless it sends false. A new JMS, AMQP 0-9-1, AMQP 1.0, Google Pub/Sub and cloud storage channel is stored invisible to the DMZ, as the editor does; there the member reads absent, a value sent is ignored and a stored channel keeps its flag.

Id of one of the platform's own certificates (with private key) that this channel uses. Must reference an existing certificate.

The platform's own OFTP identifier (SSID) toward this partner. Required on create; a write may not blank it.

The highest OFTP protocol release the platform offers. Leaving it out keeps the stored value, null restores the default.

Display name of the channel. Must be unique among the partner's channels of the same type.

The name of the trusted service list the partner's certificate is checked against. An empty string restores the default; leaving it out keeps the stored value, null restores it too.

Id of the platform's own certificate (with private key) that takes over as localCertificateId once it is activated, for a certificate exchange in preparation. Must reference an existing certificate. Leaving it out keeps the stored value, null or an empty string removes it.

Id of the partner's certificate (public key) that takes over as remoteCertificateId once it is activated, for a certificate exchange in preparation. Must reference an existing certificate. Leaving it out keeps the stored value, null or an empty string removes it.

Whether the messages the partner sends over this channel must be encrypted. Leaving it out keeps the stored value, null resets it to false; a new channel accepts unencrypted messages.

Whether the messages the partner sends over this channel must be signed. Leaving it out keeps the stored value, null resets it to false; a new channel accepts unsigned messages.

The subject of the partner's certificate the platform looks for when remoteCertificateId names none. Leaving it out keeps the stored value, null or an empty string removes it.

Id of the partner's certificate (public key) in the certificate store that this channel uses, the counterpart of localCertificateId. Must reference an existing certificate.

The partner's OFTP identifier - the SSID it presents when it connects, which assigns the session to this channel. Must be unique among OFTP channels. Left out, the server fills an AUTO_CREATE_... placeholder that no partner presents.

Whether the partner must authenticate securely. Leaving it out keeps the stored value, null resets it to false.

Whether an interrupted send is never resumed, but started again from the beginning. Leaving it out keeps the stored value, null resets it to false.

Whether the messages the platform sends over this channel are compressed. Leaving it out keeps the stored value, null resets it to false; a new channel does not compress.

Whether the messages the platform sends over this channel are encrypted. Leaving it out keeps the stored value, null resets it to false; a new channel does not encrypt.

Whether the messages the platform sends over this channel are signed. Leaving it out keeps the stored value, null resets it to false; a new channel does not sign.

The signature algorithm for OFTP messages. Leaving it out keeps the stored value, null resets it to SHA1.

Whether the SFID of every incoming file must match one the partner is allowed to send. Leaving it out keeps the stored value, null resets it to false.

The TLS cipher suite to use. An empty string removes the preference; leaving it out keeps the stored value, null resets it to the default.

The directory on the platform incoming files of this partner go to. An empty string removes it; leaving it out keeps the stored value, null removes it too.

The directory on the platform outgoing files for this partner are taken from. An empty string removes it; leaving it out keeps the stored value, null removes it too.

The X.25 window size. 0 removes the setting; leaving it out keeps the stored value, null removes it too.

The type of this object, always core.IntegrationPartnerChannelAS4. Required where the member it is sent in accepts several types.

Whether the channel is in use. Only active channels take part at runtime: logins on the platform's servers and the matching of incoming data to a partner skip inactive ones. A partner whose status is INACTIVE makes all its channels read as false in the channel list.

Whether the transfers over this channel are written to the communication log. null or left out keeps the stored value; a channel that never stored the setting reads as true.

Number of days the communication log keeps this channel's entries; 0 and up are stored, -1 removes the setting so the communication log service's global retention applies. Only used while communicationLogEnabled is on. null or left out keeps the stored value; a channel that never stored one reads -1.

The way data flows over the channel: IN (the partner sends to the platform), OUT (the platform sends to the partner) or IN_AND_OUT. Left out or null on create it defaults to IN; it cannot be set to null afterwards. JMS, AMQP 0-9-1, AMQP 1.0, Google Pub/Sub, cloud storage and SMB channels are always IN_AND_OUT: that is their default, any other value is refused, and a patch sending null there changes nothing. A legacy channel of these types stored with neither flag set reads IN_AND_OUT and has both flags set by its next write. Any other channel stored before this member existed, with no direction, reads back without it until one is written.

Cipher for encrypting outgoing messages; used only when the channel sends encrypted. Not validated on save. Leaving it out keeps the stored value, null resets it to the default, an empty string removes it.

The partner's AS4 message service endpoint that outgoing messages are pushed to.

Numeric id of the channel, assigned by the server on create; on the channel resource a value sent in the body is ignored. Profiles reference a channel by this id, looked up with GET /platform/api/partners/preview/{partnerId}/channels.

Whether the channel stays on the platform's own server and is not synchronized to a DMZ server (the editor's "Invisible to DMZ" switch). null or left out keeps the stored value; a new channel is visible to the DMZ, except a new SMB channel, which is stored invisible unless it sends false. A new JMS, AMQP 0-9-1, AMQP 1.0, Google Pub/Sub and cloud storage channel is stored invisible to the DMZ, as the editor does; there the member reads absent, a value sent is ignored and a stored channel keeps its flag.

Id of one of the platform's own certificates (with private key) that this channel uses. Must reference an existing certificate.

Id of the platform's own certificate (with private key) that signs the messages it sends over this channel. Must reference an existing certificate. Reads as absent while the channel signs with localCertificateId, which is what applies when it is unset. Leaving it out keeps the stored value, null or an empty string removes it.

Id of the platform's own certificate (with private key) it presents as TLS client certificate when it connects to the partner. Must reference an existing certificate. Reads as absent while the channel uses localCertificateId, which applies when it is unset. Leaving it out keeps the stored value, null or an empty string removes it.

Which MDN (receipt) the platform requests for outgoing messages: DEFAULT = the AS4 service's system setting, SYNCHRON = returned in the HTTP response, ASYNCHRON = sent later to sendingMdnUrl. A channel stored with another code reads back without mdnMode, and a write that leaves it out or sends null keeps that code. Otherwise leaving it out keeps the stored value and null resets it to DEFAULT.

Display name of the channel. Must be unique among the partner's channels of the same type.

Whether the messages the partner sends over this channel must be encrypted. Leaving it out keeps the stored value, null resets it to false; a new channel accepts unencrypted messages.

Whether the messages the partner sends over this channel must be signed. Leaving it out keeps the stored value, null resets it to false; a new channel accepts unsigned messages.

Id of the partner's certificate (public key) in the certificate store that this channel uses, the counterpart of localCertificateId. Must reference an existing certificate.

The partner's AS4 id, the receiver of messages sent through this channel. Left out, the server fills an AUTO_CREATE_... placeholder.

Id of the partner's certificate (public key) that the signature of the messages it sends over this channel is checked against. Must reference an existing certificate. Reads as absent while the channel checks against remoteCertificateId, which is what applies when it is unset. Leaving it out keeps the stored value, null or an empty string removes it.

Id of the partner's certificate (public key) it must present as TLS client certificate when it connects to the platform. Must reference an existing certificate. Reads as absent while the channel expects remoteCertificateId, which applies when it is unset. Leaving it out keeps the stored value, null or an empty string removes it.

Whether the messages the platform sends over this channel are compressed. Leaving it out keeps the stored value, null resets it to false; a new channel does not compress.

Whether the messages the platform sends over this channel are encrypted. Leaving it out keeps the stored value, null resets it to false; a new channel does not encrypt.

URL the partner sends the asynchronous MDN (receipt) to; only used with mdnMode ASYNCHRON. Must be an HTTP or HTTPS URL. Leaving it out keeps the stored value, null or an empty string removes it.

Whether the messages the platform sends over this channel are signed. Leaving it out keeps the stored value, null resets it to false; a new channel does not sign.

Hash algorithm for signing outgoing messages; used only when the channel sends signed. Not validated on save. Leaving it out keeps the stored value, null resets it to the default, an empty string removes it.

The type of this object, always core.IntegrationPartnerChannelAmqp10. Required where the member it is sent in accepts several types.

Whether the channel is in use. Only active channels take part at runtime: logins on the platform's servers and the matching of incoming data to a partner skip inactive ones. A partner whose status is INACTIVE makes all its channels read as false in the channel list.

How the platform authenticates at the broker: OAUTH2 fetches a token with the oauth2 credentials and sends it in the SASL exchange; OAUTH2_CBS sends that token to the broker's $cbs node after connecting, as Azure Service Bus requires; BASIC logs in with basic.username and basic.password. An explicit null keeps the stored mode.

Whether the transfers over this channel are written to the communication log. null or left out keeps the stored value; a channel that never stored the setting reads as true.

Number of days the communication log keeps this channel's entries; 0 and up are stored, -1 removes the setting so the communication log service's global retention applies. Only used while communicationLogEnabled is on. null or left out keeps the stored value; a channel that never stored one reads -1.

The way data flows over the channel: IN (the partner sends to the platform), OUT (the platform sends to the partner) or IN_AND_OUT. Left out or null on create it defaults to IN; it cannot be set to null afterwards. JMS, AMQP 0-9-1, AMQP 1.0, Google Pub/Sub, cloud storage and SMB channels are always IN_AND_OUT: that is their default, any other value is refused, and a patch sending null there changes nothing. A legacy channel of these types stored with neither flag set reads IN_AND_OUT and has both flags set by its next write. Any other channel stored before this member existed, with no direction, reads back without it until one is written.

Address of the AMQP 1.0 broker (default ports 5672 for amqp://, 5671 for amqps://); ws:// and wss:// connect over WebSocket, with path / when the URL has none. amqps:// and wss:// use TLS, which the OAuth2 modes require. Required on create; an explicit null keeps the stored address.

Numeric id of the channel, assigned by the server on create; on the channel resource a value sent in the body is ignored. Profiles reference a channel by this id, looked up with GET /platform/api/partners/preview/{partnerId}/channels.

Whether the channel stays on the platform's own server and is not synchronized to a DMZ server (the editor's "Invisible to DMZ" switch). null or left out keeps the stored value; a new channel is visible to the DMZ, except a new SMB channel, which is stored invisible unless it sends false. A new JMS, AMQP 0-9-1, AMQP 1.0, Google Pub/Sub and cloud storage channel is stored invisible to the DMZ, as the editor does; there the member reads absent, a value sent is ignored and a stored channel keeps its flag.

Id of one of the platform's own certificates (with private key) that this channel uses. Must reference an existing certificate.

Display name of the channel. Must be unique among the partner's channels of the same type.

Id of the partner's certificate (public key) in the certificate store that this channel uses, the counterpart of localCertificateId. Must reference an existing certificate.

Internal identity of the channel, generated by the server (an AUTO_CREATE_... value); it has no meaning for the broker connection and cannot be written.

The type of this object, always core.IntegrationPartnerChannelIoT. Required where the member it is sent in accepts several types.

Whether the channel is in use. Only active channels take part at runtime: logins on the platform's servers and the matching of incoming data to a partner skip inactive ones. A partner whose status is INACTIVE makes all its channels read as false in the channel list.

Whether the transfers over this channel are written to the communication log. null or left out keeps the stored value; a channel that never stored the setting reads as true.

Number of days the communication log keeps this channel's entries; 0 and up are stored, -1 removes the setting so the communication log service's global retention applies. Only used while communicationLogEnabled is on. null or left out keeps the stored value; a channel that never stored one reads -1.

The way data flows over the channel: IN (the partner sends to the platform), OUT (the platform sends to the partner) or IN_AND_OUT. Left out or null on create it defaults to IN; it cannot be set to null afterwards. JMS, AMQP 0-9-1, AMQP 1.0, Google Pub/Sub, cloud storage and SMB channels are always IN_AND_OUT: that is their default, any other value is refused, and a patch sending null there changes nothing. A legacy channel of these types stored with neither flag set reads IN_AND_OUT and has both flags set by its next write. Any other channel stored before this member existed, with no direction, reads back without it until one is written.

Address of the partner's endpoint. Stored on the channel; the platform's OPC UA server does not use it when the partner logs in.

Numeric id of the channel, assigned by the server on create; on the channel resource a value sent in the body is ignored. Profiles reference a channel by this id, looked up with GET /platform/api/partners/preview/{partnerId}/channels.

Whether the channel stays on the platform's own server and is not synchronized to a DMZ server (the editor's "Invisible to DMZ" switch). null or left out keeps the stored value; a new channel is visible to the DMZ, except a new SMB channel, which is stored invisible unless it sends false. A new JMS, AMQP 0-9-1, AMQP 1.0, Google Pub/Sub and cloud storage channel is stored invisible to the DMZ, as the editor does; there the member reads absent, a value sent is ignored and a stored channel keeps its flag.

Id of one of the platform's own certificates (with private key) that this channel uses. Must reference an existing certificate.

Display name of the channel. Must be unique among the partner's channels of the same type.

OPC UA security policy name; reads back as None when unset. Stored only: neither the platform's OPC UA server nor its OPC UA client connections read it.

Id of the partner's certificate (public key) in the certificate store that this channel uses, the counterpart of localCertificateId. Must reference an existing certificate.

User name the partner's OPC UA client logs in with on the platform's OPC UA server; only active channels are accepted, and the password is not settable through this API. Must be unique among IoT channels. Left out, the server fills an AUTO_CREATE_... placeholder that nobody can log in with.

The type of this object, always core.IntegrationPartnerChannelGooglePubSub. Required where the member it is sent in accepts several types.

Whether the channel is in use. Only active channels take part at runtime: logins on the platform's servers and the matching of incoming data to a partner skip inactive ones. A partner whose status is INACTIVE makes all its channels read as false in the channel list.

Whether the transfers over this channel are written to the communication log. null or left out keeps the stored value; a channel that never stored the setting reads as true.

Number of days the communication log keeps this channel's entries; 0 and up are stored, -1 removes the setting so the communication log service's global retention applies. Only used while communicationLogEnabled is on. null or left out keeps the stored value; a channel that never stored one reads -1.

The way data flows over the channel: IN (the partner sends to the platform), OUT (the platform sends to the partner) or IN_AND_OUT. Left out or null on create it defaults to IN; it cannot be set to null afterwards. JMS, AMQP 0-9-1, AMQP 1.0, Google Pub/Sub, cloud storage and SMB channels are always IN_AND_OUT: that is their default, any other value is refused, and a patch sending null there changes nothing. A legacy channel of these types stored with neither flag set reads IN_AND_OUT and has both flags set by its next write. Any other channel stored before this member existed, with no direction, reads back without it until one is written.

HTTP(S) endpoint URL used by the channel.

Numeric id of the channel, assigned by the server on create; on the channel resource a value sent in the body is ignored. Profiles reference a channel by this id, looked up with GET /platform/api/partners/preview/{partnerId}/channels.

Whether the channel stays on the platform's own server and is not synchronized to a DMZ server (the editor's "Invisible to DMZ" switch). null or left out keeps the stored value; a new channel is visible to the DMZ, except a new SMB channel, which is stored invisible unless it sends false. A new JMS, AMQP 0-9-1, AMQP 1.0, Google Pub/Sub and cloud storage channel is stored invisible to the DMZ, as the editor does; there the member reads absent, a value sent is ignored and a stored channel keeps its flag.

Display name of the channel. Must be unique among the partner's channels of the same type.

The type of this object, always core.IntegrationPartnerChannelSMB. Required where the member it is sent in accepts several types.

Whether the channel is in use. Only active channels take part at runtime: logins on the platform's servers and the matching of incoming data to a partner skip inactive ones. A partner whose status is INACTIVE makes all its channels read as false in the channel list.

Whether the transfers over this channel are written to the communication log. null or left out keeps the stored value; a channel that never stored the setting reads as true.

Number of days the communication log keeps this channel's entries; 0 and up are stored, -1 removes the setting so the communication log service's global retention applies. Only used while communicationLogEnabled is on. null or left out keeps the stored value; a channel that never stored one reads -1.

The way data flows over the channel: IN (the partner sends to the platform), OUT (the platform sends to the partner) or IN_AND_OUT. Left out or null on create it defaults to IN; it cannot be set to null afterwards. JMS, AMQP 0-9-1, AMQP 1.0, Google Pub/Sub, cloud storage and SMB channels are always IN_AND_OUT: that is their default, any other value is refused, and a patch sending null there changes nothing. A legacy channel of these types stored with neither flag set reads IN_AND_OUT and has both flags set by its next write. Any other channel stored before this member existed, with no direction, reads back without it until one is written.

Host name or IP address of the SMB file server - no scheme, port or path. Replaces <SMBHOST> in the file path of a cron job or response unit that uses this channel. Required on create; a write may not blank it.

Numeric id of the channel, assigned by the server on create; on the channel resource a value sent in the body is ignored. Profiles reference a channel by this id, looked up with GET /platform/api/partners/preview/{partnerId}/channels.

Whether the channel stays on the platform's own server and is not synchronized to a DMZ server (the editor's "Invisible to DMZ" switch). null or left out keeps the stored value; a new channel is visible to the DMZ, except a new SMB channel, which is stored invisible unless it sends false. A new JMS, AMQP 0-9-1, AMQP 1.0, Google Pub/Sub and cloud storage channel is stored invisible to the DMZ, as the editor does; there the member reads absent, a value sent is ignored and a stored channel keeps its flag.

Identity of the channel, composed by the server as //<host>/<smbUser>@<smbDomain> in lower case; it follows host, smbUser and smbDomain and cannot be written. It is the channel's uniqueness key, so a channel without smbUser reads //<host>/null@<smbDomain> (without a domain, no @ part) and collides with every other such channel on the same host.

Display name of the channel. Must be unique among the partner's channels of the same type.

Internal identity of the channel, generated by the server (an AUTO_CREATE_... value); it has no meaning for the SMB connection and cannot be written.

Share name, stored as the path of the channel's smb:// address (a leading / is added). Needs host. The file cron job and response unit take only the host from the channel, so name the share in their file path as well.

Windows domain the SMB login authenticates in; a domain set in the cron job or response unit wins. Required on create; a write may not blank it.

Account used during SMB authentication, next to smbDomain. Required on create; a write may not blank it. null or left out keeps the stored value.

The type of this object, always core.IntegrationPartnerChannelFTP. Required where the member it is sent in accepts several types.

Whether the channel is in use. Only active channels take part at runtime: logins on the platform's servers and the matching of incoming data to a partner skip inactive ones. A partner whose status is INACTIVE makes all its channels read as false in the channel list.

Whether the transfers over this channel are written to the communication log. null or left out keeps the stored value; a channel that never stored the setting reads as true.

Number of days the communication log keeps this channel's entries; 0 and up are stored, -1 removes the setting so the communication log service's global retention applies. Only used while communicationLogEnabled is on. null or left out keeps the stored value; a channel that never stored one reads -1.

The way data flows over the channel: IN (the partner sends to the platform), OUT (the platform sends to the partner) or IN_AND_OUT. Left out or null on create it defaults to IN; it cannot be set to null afterwards. JMS, AMQP 0-9-1, AMQP 1.0, Google Pub/Sub, cloud storage and SMB channels are always IN_AND_OUT: that is their default, any other value is refused, and a patch sending null there changes nothing. A legacy channel of these types stored with neither flag set reads IN_AND_OUT and has both flags set by its next write. Any other channel stored before this member existed, with no direction, reads back without it until one is written.

Host name or IP address of the partner's FTP server - no scheme, port or path. Used when the platform connects to the partner; a host set in the cron job or response unit overrides it. {"host": null, "port": null} clears the address.

Numeric id of the channel, assigned by the server on create; on the channel resource a value sent in the body is ignored. Profiles reference a channel by this id, looked up with GET /platform/api/partners/preview/{partnerId}/channels.

Whether the channel stays on the platform's own server and is not synchronized to a DMZ server (the editor's "Invisible to DMZ" switch). null or left out keeps the stored value; a new channel is visible to the DMZ, except a new SMB channel, which is stored invisible unless it sends false. A new JMS, AMQP 0-9-1, AMQP 1.0, Google Pub/Sub and cloud storage channel is stored invisible to the DMZ, as the editor does; there the member reads absent, a value sent is ignored and a stored channel keeps its flag.

Id of one of the platform's own certificates (with private key) that this channel uses. Must reference an existing certificate.

User name the platform logs in with at the partner's FTP server; its password is not settable through this API. null or left out keeps the stored value.

Display name of the channel. Must be unique among the partner's channels of the same type.

Whether the partner, logged in on the platform's FTP server as remoteId, is confined to its home directory (remotePath) and cannot change to a directory above it. null or left out keeps the stored value; a new channel is not confined.

TCP port of the partner's FTP server; left out, the address carries no port. Requires host. A port set in the cron job or response unit overrides it.

Id of the partner's certificate (public key) in the certificate store that this channel uses, the counterpart of localCertificateId. Must reference an existing certificate.

User name the partner logs in with on the platform's FTP server; its password is remotePassword. Must be unique among all FTP channels. Left out, the server fills an AUTO_CREATE_... placeholder that nobody can log in with.

The password the partner logs in with on the platform's server as remoteId. A secret: a read returns it encrypted, a write accepts that encrypted value unchanged or the cleartext as "PLAIN:<text>". Required on create. A channel that has one cannot be changed to an empty one; a channel stored without one stays writable without. null or left out keeps the stored value. Holds a secret. A read returns it encrypted; a write accepts either that encrypted form or the cleartext behind a "PLAIN:" prefix, and rejects anything else.

Directory on the Lobster server that becomes the partner's home when it logs in to the platform's FTP server as remoteId (relative paths resolve against the server's working directory). Not a path on the partner's server. The FTP server refuses every login to a channel without one. Left out or blank on create, the server picks <client default channel directory>ftp/<id hash> like the channel editor and creates that directory, on the DMZ too where one is configured; a directory given here is not created. A stored directory cannot be changed to a blank one (422), which an overwrite patch that leaves the member out would do.

Whether the control connection's TLS session is reused for the data connections of an FTPS transfer when the platform connects to the partner; some servers refuse a data connection without it. Leaving it out keeps the stored value, null resets it to true; a new channel reuses the session.

Whether the partner, logged in on the platform's FTP server, sees a virtual file system with its home directory as the root (/) instead of the real path of the home directory. Leaving it out keeps the stored value, null resets it to false; a new channel shows the real path.

The type of this object, always core.IntegrationPartnerChannelFax. Required where the member it is sent in accepts several types.

Whether the channel is in use. Only active channels take part at runtime: logins on the platform's servers and the matching of incoming data to a partner skip inactive ones. A partner whose status is INACTIVE makes all its channels read as false in the channel list.

Whether the transfers over this channel are written to the communication log. null or left out keeps the stored value; a channel that never stored the setting reads as true.

Number of days the communication log keeps this channel's entries; 0 and up are stored, -1 removes the setting so the communication log service's global retention applies. Only used while communicationLogEnabled is on. null or left out keeps the stored value; a channel that never stored one reads -1.

Header line sent with faxes to this partner; left out, the fax service's default applies.

Station id sent with faxes to this partner; left out, the fax service's default applies.

The way data flows over the channel: IN (the partner sends to the platform), OUT (the platform sends to the partner) or IN_AND_OUT. Left out or null on create it defaults to IN; it cannot be set to null afterwards. JMS, AMQP 0-9-1, AMQP 1.0, Google Pub/Sub, cloud storage and SMB channels are always IN_AND_OUT: that is their default, any other value is refused, and a patch sending null there changes nothing. A legacy channel of these types stored with neither flag set reads IN_AND_OUT and has both flags set by its next write. Any other channel stored before this member existed, with no direction, reads back without it until one is written.

Fax header the partner is expected to send. Stored only: neither the editor nor the fax service uses it.