Documentation Powered by ReDoc

FileMage Gateway

Download OpenAPI specification:Download

FileMage Gateway provides a simple API to configure storage endpoints, users, and keys. Please note that all urls must end in a trailing slash, and the Content-Type header must be set to application/json.

Find out more about FileMage Gateway

Authentication

api_key

After registering an administrator account, go to the settings page to create a API key. Include this token in all calls to the API.

Example:

curl http://sftp.example.com/users/ -H "filemage-api-token: 43fb7437e3f231e481b262ca6d4de0c0"

Security Scheme Type API Key
Header parameter name: filemage-api-token

Endpoints

Create and manage storage endpoints.

List endpoints

Return a list of endpoint names and corresponding endpoint IDs.

Authorizations:
api_key

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create endpoint

Create a new endpoint using provided settings.

Authorizations:
api_key
Request Body schema: application/json

Endpoint configuration. Check cloud provider specific schemas for config parameters.

One of
id
integer

ID of endpoint.

name
string

Name of endpoint.

object

Settings specific to the Azure Blob Storage endpoint types.

Responses

Request samples

Content type
application/json
Example
BlobEndpoint
BlobEndpoint
S3Endpoint
GCSEndpoint
{
  • "id": 0,
  • "name": "string",
  • "config": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0
}

Get endpoint

Return detailed endpoint settings of specified endpoint.

Authorizations:
api_key
path Parameters
id
required
integer

ID of endpoint to return

Responses

Response samples

Content type
application/json
Example
BlobEndpoint
BlobEndpoint
S3Endpoint
GCSEndpoint
{
  • "id": 0,
  • "name": "string",
  • "config": {
    }
}

Update endpoint

Update settings of existing endpoint.

Authorizations:
api_key
path Parameters
id
required
integer

ID of endpoint to update

Request Body schema: application/json

Endpoint configuration. Check cloud provider specific schemas for config parameters.

One of
id
integer

ID of endpoint.

name
string

Name of endpoint.

object

Settings specific to the Azure Blob Storage endpoint types.

Responses

Request samples

Content type
application/json
Example
BlobEndpoint
BlobEndpoint
S3Endpoint
GCSEndpoint
{
  • "id": 0,
  • "name": "string",
  • "config": {
    }
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "fields": [
    ]
}

Delete endpoint

Authorizations:
api_key
path Parameters
id
required
integer

ID of endpoint to delete

Responses

Users

Create and manage user accounts.

List users

Return list of all active users.

Authorizations:
api_key

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create user

Authorizations:
api_key
Request Body schema: application/json

User settings

username
string

Username.

password
string

Password.

endpointId
integer

ID of endpoint to associate with user.

email
string

The email address used for password reset and welcome emails.

disabled
boolean

Password authentication disabled.

object

Specify path, and permission level of user home directory

Array of objects (Permission)

Additional folder permissions assigned to the user.

whitelist
Array of strings

IP addresses which are allowed to connect as this user.

mfaRequired
boolean

Require multi-factor authentication to be set up before allowing user to log in.

ldap
boolean

Indicates that this user should be authneticated using LDAP.

expires
string

A timestamp in ISO 8601 format indicating when the users account should no longer be accessible.

ftpDisabled
boolean

Disable FTP protocol for this user.

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "password": "string",
  • "endpointId": 0,
  • "email": "string",
  • "disabled": true,
  • "home": {
    },
  • "permissions": [
    ],
  • "whitelist": [
    ],
  • "mfaRequired": true,