Sign in

v4

latestSwagger 2.02026-08-0343714211.7 MB
as2_stations
AS2 Stations

List AS2 Stations

List AS2 Stations

get/as2_stations

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 and name.

If set, return records where the specified field is equal to the supplied value. Valid fields are workspace_id.

Response

A list of As2Stations objects.

idinteger

Id of the AS2 Station.

workspace_idinteger

ID of the Workspace associated with this AS2 Station.

namestring

The station's formal AS2 name.

uristring

Public URI for sending AS2 message to.

domainstring

The station's AS2 domain name.

hex_public_certificate_serialstring

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

public_certificate_md5string

MD5 hash of public certificate used for message security.

public_certificatestring

Public certificate used for message security.

private_key_md5string

MD5 hash of private key 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.

private_key_password_md5string

MD5 hash of private key password used for message security.

Example response

[
  {
    "id": 1,
    "workspace_id": 1,
    "name": "AS2 Station Name",
    "uri": "example",
    "domain": "domain.test",
    "hex_public_certificate_serial": "A5:EB:C1:95:DC:D8:2B:E7",
    "public_certificate_md5": "example",
    "public_certificate": "example",
    "private_key_md5": "example",
    "public_certificate_subject": "example",
    "public_certificate_issuer": "example",
    "public_certificate_serial": "example",
    "public_certificate_not_before": "example",
    "public_certificate_not_after": "example",
    "private_key_password_md5": "example"
  }
]