DocEvent.io Support Center

Contact Us

New Simple FTP Service via API

POST to the /sfs/service API endpoint

When posting data not all fields are required, however, the fields shown below are required for that specific Storage Type

New S3 example POST request

Request:

{
  "config": {
    "storage_type": "aws/s3",
    "aws_secret_access_key": "secret_key",
    "description": "Test creation via API",
    "bucket": "test-ftp-bucket-1",
    "aws_access_key_id": "access_key",
    "name": "TestAPI",
    "user": {
      "password": "secret-password!!",
      "username": "user-account",
      "home": "/"
    }
  }
}

Response:

{
  "sub": "d1b9cea8-bc5f-454e-94d6-0b57476554ee",
  "config": {
    "storage_type": "aws/s3",
    "aws_access_key_id": "AKIAJIIH776RQ4ZITCDA",
    "aws_secret_access_key": "encrypted_key",
    "bucket": "test-ftp-bucket-1",
    "name": "TestAPI",
    "description": "Test creation via API",
    "enable_cloud": true,
    "enable_self_hosted": true,
    "enable_ftp": true
  },
  "uuid": "0gd6oh17",
  "created": "2020-01-14T01:07:56Z"
}