Documentation Powered by ReDoc

FileMage Gateway (1.2)

Download OpenAPI specification:Download

FileMage Gateway provides a simple API to configure storage endpoints, users, and keys.

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://api.filemage.io/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

200

Success

get /endpoints/
https://api.filemage.io/v2/endpoints/

Response samples

application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Create endpoint

Create a new endpoint using provided settings.

Authorizations:
api_key
Request Body schema: application/json

Endpoint configuration

name
required
string

Visual label used to identify the endpoint.

config
required
object

Settings specific to the indicated storage endpoint type.

Responses

201

Success

400

Missing or invalid fields

post /endpoints/
https://api.filemage.io/v2/endpoints/

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "name": "string",
  • "config":
    {
    }
}

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "message": "string",
  • "fields":
    [
    ]
}

Get endpoint

Return detailed endpoint settings of specified endpoint.

Authorizations:
api_key
path Parameters
id
required
integer

ID of endpoint to return

Responses

200

Success

404

Endpoint not found

get /endpoints/{id}
https://api.filemage.io/v2/endpoints/{id}

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "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

name
required
string

Visual label used to identify the endpoint.

config
required
object

Settings specific to the indicated storage endpoint type.

Responses

204

Success

400

Missing or invalid fields

404

Endpoint not found

put /endpoints/{id}
https://api.filemage.io/v2/endpoints/{id}

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "name": "string",
  • "config":
    {
    }
}

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "message": "string",
  • "fields":
    [
    ]
}

Delete endpoint

Authorizations:
api_key
path Parameters
id
required
integer

ID of endpoint to delete

Responses

204

Successful

404

Endpoint not found

delete /endpoints/{id}
https://api.filemage.io/v2/endpoints/{id}

Users

Create and manage user accounts.

List users

Return list of all active users.

Authorizations:
api_key

Responses

200

Success

get /users/
https://api.filemage.io/v2/users/

Response samples

application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

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.

disabled
bool

Password authentication disabled.

home
object

Specify path, and permission level of user home directory

permissions
Array of objects (Permission)

Additional folder permissions assigned to the user.

Responses

201

Success

400

Missing or invalid fields

post /users/
https://api.filemage.io/v2/users/

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "username": "string",
  • "password": "string",
  • "endpointId": 0,
  • "disabled": null,
  • "home":
    {
    },
  • "permissions":
    [
    ]
}

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "id": 0
}

Get user

Return detailed user settings including SSH keys.

Authorizations:
api_key
path Parameters
id
required
integer

ID of user to return

Responses

200

Success

404

User not found

get /users/{id}
https://api.filemage.io/v2/users/{id}

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "id": 0,
  • "username": "string",
  • "endpointId": 0,
  • "disabled": null,
  • "home":
    {
    },
  • "permissions":
    [
    ],
  • "keys":
    [
    ]
}

Update user

Update user settings not including keys. See Keys section for calls related to adding or removing keys.

Authorizations:
api_key
path Parameters
id
required
integer

ID of user to update

Request Body schema: application/json

User configuration

username
string

Username.

password
string

Password.

endpointId
integer

ID of endpoint to associate with user.

disabled
bool

Password authentication disabled.

home
object

Specify path, and permission level of user home directory

permissions
Array of objects (Permission)

Additional folder permissions assigned to the user.

Responses

204

successful operation

400

Missing or invalid fields

404

User not found.

put /users/{id}
https://api.filemage.io/v2/users/{id}

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "username": "string",
  • "password": "string",
  • "endpointId": 0,
  • "disabled": null,
  • "home":
    {
    },
  • "permissions":
    [
    ]
}

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "message": "string",
  • "fields":
    [
    ]
}

Delete user

Authorizations:
api_key
path Parameters
id
required
integer

ID of user to delete

Responses

200

Success

404

User not found

delete /users/{id}
https://api.filemage.io/v2/users/{id}

Keys

Create or remove user SSH keys.

Add key

Create or import a SSH key. When importing use the keyData field. To create a new key set create to true

Authorizations:
api_key
path Parameters
userId
required
integer

ID of user to associate key with

Request Body schema: application/json

Key settings

keyData
string

Contents of key file to import. Use either keyData or create.

create
bool
Default: false

Create and return a new key. Use either keyData or create.

Responses

200

Success

204

Success

404

User not found

post /users/{userId}/keys
https://api.filemage.io/v2/users/{userId}/keys

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "keyData": "string",
  • "create": false
}

Delete key

Authorizations:
api_key
path Parameters
userId
required
integer

ID of user to remove key from

keyId
required
integer

ID of key to remove

Responses

204

successful operation

404

Key not found.

delete /users/{userId}/keys/{keyId}
https://api.filemage.io/v2/users/{userId}/keys/{keyId}

Groups

Create and manage user groups.

List groups

Return list of all active groups.

Authorizations:
api_key

Responses

200

Success

get /groups/
https://api.filemage.io/v2/groups/

Response samples

application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Create group

Authorizations:
api_key
Request Body schema: application/json

Group settings

id
integer

Group ID.

name
string

Name of the group.

members
Array of strings

Usernames of members in the group.

permissions
Array of objects (Permission)

Folder permissions assigned to the group.

Responses

201

Success

400

Missing or invalid fields

post /groups/
https://api.filemage.io/v2/groups/

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "id": 0,
  • "name": "string",
  • "members":
    [
    ],
  • "permissions":
    [
    ]
}

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "message": "string",
  • "fields":
    [
    ]
}

Get group

Return group settings.

Authorizations:
api_key
path Parameters
id
required
integer

ID of group to return

Responses

200

Success

404

Group not found

get /groups/{id}
https://api.filemage.io/v2/groups/{id}

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "id": 0,
  • "name": "string",
  • "members":
    [
    ],
  • "permissions":
    [
    ]
}

Update group

Update group settings

Authorizations:
api_key
path Parameters
id
required
integer

ID of group to update

Request Body schema: application/json

User configuration

username
string

Username.

password
string

Password.

endpointId
integer

ID of endpoint to associate with user.

disabled
bool

Password authentication disabled.

home
object

Specify path, and permission level of user home directory

permissions
Array of objects (Permission)

Additional folder permissions assigned to the user.

Responses

204

successful operation

400

Missing or invalid fields

404

Group not found.

put /groups/{id}
https://api.filemage.io/v2/groups/{id}

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "username": "string",
  • "password": "string",
  • "endpointId": 0,
  • "disabled": null,
  • "home":
    {
    },
  • "permissions":
    [
    ]
}

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "message": "string",
  • "fields":
    [
    ]
}

Delete group

Authorizations:
api_key
path Parameters
id
required
integer

ID of group to delete

Responses

200

Success

404

group not found

delete /groups/{id}
https://api.filemage.io/v2/groups/{id}

Permissions

View folder permissions.

Folder permissions overview

List all paths with permissions applied.

Authorizations:
api_key

Responses

200

Success

get /permissions
https://api.filemage.io/v2/permissions

Response samples

application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Folder permission detail

List all permissions granted on the specified path.

Authorizations:
api_key
query Parameters
path
required
string

Folder path to list permissions of.

Responses

200

Success

get /permissions/query
https://api.filemage.io/v2/permissions/query

Response samples

application/json
Copy
 Expand all Collapse all
[
  • {
    }
]