AS2 Stations

An AS2Station is a remote AS2 server that can send data into Files.com and receive data from Files.com.

List AS2 Stations

Endpoint

GET/as2_stations

Return Object

As2Station[]

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Additional Arguments

Example Request

curl https://app.files.com/api/rest/v1/as2_stations.json \
  -H 'X-FilesAPI-Key: YOUR_API_KEY'

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

Show AS2 Station

Endpoint

GET/as2_stations/{id}

Return Object

As2Station

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Request Parameters

Parameter	Description
id int64 Required	As2 Station ID.

Example Request

curl https://app.files.com/api/rest/v1/as2_stations/{id}.json \
  -H 'X-FilesAPI-Key: YOUR_API_KEY'

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

Create AS2 Station

Endpoint

POST/as2_stations

Return Object

As2Station

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Request Parameters

Parameter	Default	Description
name string Required		The station's formal AS2 name.
workspace_id int64	`0`	ID of the Workspace associated with this AS2 Station.
public_certificate string Required
private_key string Required
private_key_password string

Example Request

curl https://app.files.com/api/rest/v1/as2_stations.json \
  -X POST \
  -H 'Content-Type: application/json' \
  -d '{"name":"AS2 Station Name","workspace_id":1,"public_certificate":"public_certificate","private_key":"private_key"}' \
  -H 'X-FilesAPI-Key: YOUR_API_KEY'

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

Update AS2 Station

Endpoint

PATCH/as2_stations/{id}

Return Object

As2Station

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Request Parameters

Parameter	Description
id int64 Required	As2 Station ID.
name string	The station's formal AS2 name.
public_certificate string
private_key string
private_key_password string

Example Request

curl https://app.files.com/api/rest/v1/as2_stations/{id}.json \
  -X PATCH \
  -H 'Content-Type: application/json' \
  -d '{"name":"AS2 Station Name","public_certificate":"example"}' \
  -H 'X-FilesAPI-Key: YOUR_API_KEY'

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

Delete AS2 Station

Endpoint

DELETE/as2_stations/{id}

Return Object

No return value.

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Request Parameters

Parameter	Description
id int64 Required	As2 Station ID.

Example Request

curl https://app.files.com/api/rest/v1/as2_stations/{id}.json \
  -X DELETE \
  -H 'X-FilesAPI-Key: YOUR_API_KEY'

The As2Station Object

Some of the endpoints above return a As2Station object. The attributes of this object are listed below.

Attribute	Description
id int64	Id of the AS2 Station.
workspace_id int64	ID of the Workspace associated with this AS2 Station.
name string	The station's formal AS2 name.
uri string	Public URI for sending AS2 message to.
domain string	The station's AS2 domain name.
hex_public_certificate_serial string	Serial of public certificate used for message security in hex format.
public_certificate_md5 string	MD5 hash of public certificate used for message security.
public_certificate string	Public certificate used for message security.
private_key_md5 string	MD5 hash of private key used for message security.
public_certificate_subject string	Subject of public certificate used for message security.
public_certificate_issuer string	Issuer of public certificate used for message security.
public_certificate_serial string	Serial of public certificate used for message security.
public_certificate_not_before string	Not before value of public certificate used for message security.
public_certificate_not_after string	Not after value of public certificate used for message security.
private_key_password_md5 string	MD5 hash of private key password used for message security.

Example As2Station Object

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

AS2 Stations

List AS2 Stations

Endpoint

Return Object

Authorization Requirement

Additional Arguments

Pagination

Sorting

Filtering

Show AS2 Station

Endpoint

Return Object

Authorization Requirement

Request Parameters

Create AS2 Station

Endpoint

Return Object

Authorization Requirement

Request Parameters

Update AS2 Station

Endpoint

Return Object

Authorization Requirement

Request Parameters

Delete AS2 Station

Endpoint

Return Object

Authorization Requirement

Request Parameters

The As2Station Object