v4

latestSwagger 2.02026-08-0343714211.7 MB

as2_partners

AS2 Partners

List AS2 Partners

get/as2_partners

Query parameters

cursorstring

Used for pagination. When a list request has more records available, cursors are provided in the response headers X-Files-Cursor-Next and X-Files-Cursor-Prev. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.

per_pageinteger

Number of records to show per page. (Max: 10000, 1,000 or less is recommended).

If set, sort records by the specified field in either asc or desc direction. Valid fields are workspace_id, as2_station_id or name.

If set, return records where the specified field is equal to the supplied value. Valid fields are as2_station_id and workspace_id. Valid field combinations are [ workspace_id, as2_station_id ].

Response

A list of As2Partners objects.

idinteger

ID of the AS2 Partner.

workspace_idinteger

ID of the Workspace associated with this AS2 Partner.

as2_station_idinteger

ID of the AS2 Station associated with this partner.

namestring

The partner's formal AS2 name.

uristring

Public URI where we will send the AS2 messages (via HTTP/HTTPS).

server_certificate'require_match' | 'allow_any'

Should we require that the remote HTTP server have a valid SSL Certificate for HTTPS? (This only applies to Outgoing AS2 message from Files.com to a Partner.)

http_auth_usernamestring

Username to send to server for HTTP Authentication.

additional_http_headersobject

Additional HTTP Headers for outgoing message sent to this partner.

default_mime_typestring

Default mime type of the file attached to the encrypted message

mdn_validation_level'none' | 'weak' | 'normal' | 'strict' | 'auto'

How should Files.com evaluate message transfer success based on a partner's MDN response? This setting does not affect MDN storage; all MDNs received from a partner are always stored. none: MDN is stored for informational purposes only, a successful HTTPS transfer is a successful AS2 transfer. weak: Inspect the MDN for MIC and Disposition only. normal: weak plus validate MDN signature matches body, strict: normal but do not allow signatures from self-signed or incorrectly purposed certificates. auto: Automatically set the correct value for this setting based on next mdn received.

signature_validation_level'normal' | 'none' | 'auto'

Should Files.com require signatures on incoming AS2 messages? normal: require that incoming messages are signed with a valid matching signature. none: Unsigned incoming messages are allowed. auto: Automatically set the correct value for this setting based on next message received.

enable_dedicated_ipsboolean

If true, we will use your site's dedicated IPs for all outbound connections to this AS2 Partner.

hex_public_certificate_serialstring

Serial of public certificate used for message security in hex format.

public_certificatestring

Public certificate used for message security.

public_certificate_md5string

MD5 hash of public certificate used for message security.

public_certificate_subjectstring

Subject of public certificate used for message security.

public_certificate_issuerstring

Issuer of public certificate used for message security.

public_certificate_serialstring

Serial of public certificate used for message security.

public_certificate_not_beforestring

Not before value of public certificate used for message security.

public_certificate_not_afterstring

Not after value of public certificate used for message security.

Example response

[
  {
    "id": 1,
    "workspace_id": 1,
    "as2_station_id": 1,
    "name": "AS2 Partner Name",
    "uri": "example",
    "server_certificate": "require_match",
    "http_auth_username": "username",
    "additional_http_headers": {
      "key": "example value"
    },
    "default_mime_type": "application/octet-stream",
    "mdn_validation_level": "none",
    "signature_validation_level": "normal",
    "enable_dedicated_ips": true,
    "hex_public_certificate_serial": "A5:EB:C1:95:DC:D8:2B:E7",
    "public_certificate": "example",
    "public_certificate_md5": "example",
    "public_certificate_subject": "example",
    "public_certificate_issuer": "example",
    "public_certificate_serial": "example",
    "public_certificate_not_before": "example",
    "public_certificate_not_after": "example"
  }
]