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

Command

files-cli as2-stations list

Output

Outputs a list of As2Station objects according to the output format.

Authorization Requirement

Requires a Site-Wide API key, or a User API key or session from a Site Administrator or a Workspace Administrator for the relevant workspace.

Additional Arguments

Example Request

files-cli as2-stations list

Show AS2 Station

Command

files-cli as2-stations find

Output

Outputs a As2Station object according to the output format.

Authorization Requirement

Requires a Site-Wide API key, or a User API key or session from a Site Administrator or a Workspace Administrator for the relevant workspace.

Flags

FlagDescription
--id=
int64
Required		As2 Station ID.

Example Request

files-cli as2-stations find \
  --id=1

Create AS2 Station

Command

files-cli as2-stations create

Output

Outputs a As2Station object according to the output format.

Authorization Requirement

Requires a Site-Wide API key, or a User API key or session from a Site Administrator or a Workspace Administrator for the relevant workspace.

Flags

FlagDefaultDescription
--name=
string
Required		The station's formal AS2 name.
--workspace-id=
int64		0ID of the Workspace associated with this AS2 Station.
--public-certificate=
string		Public certificate used for message security.
--private-key=
string		PEM-encoded private key matching public_certificate.
--private-key-password=
string		Password for the PEM-encoded private key.
--pkcs12=
string		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-password=
string		Password for pkcs12. The file and password are used only for import; the extracted certificate and private key are stored as PEM.

Example Request

files-cli as2-stations create \
  --name="AS2 Station Name"

Update AS2 Station

Command

files-cli as2-stations update

Output

Outputs a As2Station object according to the output format.

Authorization Requirement

Requires a Site-Wide API key, or a User API key or session from a Site Administrator or a Workspace Administrator for the relevant workspace.

Flags

FlagDescription
--id=
int64
Required		As2 Station ID.
--name=
string		The station's formal AS2 name.
--public-certificate=
string		Public certificate used for message security.
--private-key=
string		PEM-encoded private key matching public_certificate.
--private-key-password=
string		Password for the PEM-encoded private key.
--pkcs12=
string		Base64-encoded PKCS#12 (.pfx or .p12) file containing the identity's replacement certificate and private key. Provide this instead of public_certificate and private_key.
--pkcs12-password=
string		Password for pkcs12. The file and password are used only for import; the extracted certificate and private key are stored as PEM.

Example Request

files-cli as2-stations update \
  --id=1 \
  --name="AS2 Station Name"

Delete AS2 Station

Command

files-cli as2-stations delete

Output

No output is returned.

Authorization Requirement

Requires a Site-Wide API key, or a User API key or session from a Site Administrator or a Workspace Administrator for the relevant workspace.

Flags

FlagDescription
--id=
int64
Required		As2 Station ID.

Example Request

files-cli as2-stations delete \
  --id=1

The As2Station Object

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

AttributeDescription
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.