FIfiles
as2_stations
AS2 Stations

Create AS2 Station

Changed on

Create AS2 Station

post/as2_stations

Request

  • Base URL
    https://app.files.com/api/rest/v1
  • URL
    https://app.files.com/api/rest/v1/as2_stations
  • Auth
    none declared

Request body multipart/form-data

namestring required

The station's formal AS2 name, unique across all Workspaces on the Site.

workspace_idinteger

ID of the Workspace associated with this AS2 Station.

public_certificatestring

Public certificate used for message security.

private_keystring

PEM-encoded private key matching public_certificate.

private_key_passwordstring

Password for the PEM-encoded private key.

pkcs12string

Base64-encoded PKCS#12 (.pfx or .p12) file containing the identity's certificate and private key. Provide this instead of public_certificate and private_key.

pkcs12_passwordstring

Password for pkcs12. The file and password are used only for import; the extracted certificate and private key are stored as PEM.

Example request

{
  "name": "AS2 Station Name",
  "workspace_id": 1,
  "public_certificate": "example"
}

Response

The As2Stations object.

idinteger

Id of the AS2 Station.

workspace_idinteger

ID of the Workspace associated with this AS2 Station.

namestring

The station's formal AS2 name, unique across all Workspaces on the Site.

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"
}

Changes