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.
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 |
Create a new endpoint using provided settings.
Endpoint configuration
name required | string Visual label used to identify the endpoint. |
required | object Settings specific to the indicated storage endpoint type. |
{- "name": "string",
- "config": {
- "accountKey": "string",
- "accountName": "string",
- "containerName": "string",
- "type": "azure"
}
}
{- "message": "string",
- "fields": [
- "string"
]
}
Return detailed endpoint settings of specified endpoint.
id required | integer ID of endpoint to return |
{- "id": 0,
- "name": "string",
- "config": {
- "accountKey": "string",
- "accountName": "string",
- "containerName": "string",
- "type": "azure"
}
}
Update settings of existing endpoint.
id required | integer ID of endpoint to update |
Endpoint configuration
name required | string Visual label used to identify the endpoint. |
required | object Settings specific to the indicated storage endpoint type. |
{- "name": "string",
- "config": {
- "accountKey": "string",
- "accountName": "string",
- "containerName": "string",
- "type": "azure"
}
}
{- "message": "string",
- "fields": [
- "string"
]
}
[- {
- "id": 0,
- "username": "string",
- "endpointName": "string"
}
]
User settings
username | string Username. |
password | string Password. |
endpointId | integer ID of endpoint to associate with user. |
disabled | bool Password authentication disabled. |
object Specify path, and permission level of user home directory | |
Array of objects (Permission) Additional folder permissions assigned to the user. |
{- "username": "string",
- "password": "string",
- "endpointId": 0,
- "disabled": null,
- "home": {
- "path": "string",
- "sub": null,
- "grants": "string"
}, - "permissions": [
- {
- "path": "string",
- "sub": null,
- "grants": "string"
}
]
}
{- "id": 0
}
Return detailed user settings including SSH keys.
id required | integer ID of user to return |
{- "id": 0,
- "username": "string",
- "endpointId": 0,
- "disabled": null,
- "home": {
- "path": "string",
- "sub": null,
- "grants": "string"
}, - "permissions": [
- {
- "path": "string",
- "sub": null,
- "grants": "string"
}
], - "keys": [
- {
- "id": 0,
- "fingerprint": "string"
}
]
}
Update user settings not including keys. See Keys
section for calls related to adding or removing keys.
id required | integer ID of user to update |
User configuration
username | string Username. |
password | string Password. |
endpointId | integer ID of endpoint to associate with user. |
disabled | bool Password authentication disabled. |
object Specify path, and permission level of user home directory | |
Array of objects (Permission) Additional folder permissions assigned to the user. |
{- "username": "string",
- "password": "string",
- "endpointId": 0,
- "disabled": null,
- "home": {
- "path": "string",
- "sub": null,
- "grants": "string"
}, - "permissions": [
- {
- "path": "string",
- "sub": null,
- "grants": "string"
}
]
}