All REST Endpoints
File Server/Configuration
- Get file system configuration
- Method: getPath:
{protocol}//{host}:{port}{basePath}/ic/api/fileserver/v1/filesystem/configuration
- Update the file system configuration
- Method: putPath:
{protocol}//{host}:{port}{basePath}/ic/api/fileserver/v1/filesystem/configuration
File Server/File System
- Create a folder
- Method: postPath:
{protocol}//{host}:{port}{basePath}/ic/api/fileserver/v1/filesystem/directories
- Delete a folder
- Method: deletePath:
{protocol}//{host}:{port}{basePath}/ic/api/fileserver/v1/filesystem/directories/{guid}
- Delete a folder by path
- Method: deletePath:
{protocol}//{host}:{port}{basePath}/ic/api/fileserver/v1/filesystem/root/{fsPath}
- Get a folder by path
- Method: getPath:
{protocol}//{host}:{port}{basePath}/ic/api/fileserver/v1/filesystem/root/{fsPath}
- Get a folder by path ID
- Method: getPath:
{protocol}//{host}:{port}{basePath}/ic/api/fileserver/v1/filesystem/directories/{guid}
- Get folder permission
- Method: getPath:
{protocol}//{host}:{port}{basePath}/ic/api/fileserver/v1/filesystem/directories/{guid}/permissions/groups/{group}
- Get folder permissions
- Method: getPath:
{protocol}//{host}:{port}{basePath}/ic/api/fileserver/v1/filesystem/directories/{guid}/permissions
- Get root directory of file system
- Method: getPath:
{protocol}//{host}:{port}{basePath}/ic/api/fileserver/v1/filesystem/root
- Get user permission
- Method: getPath:
{protocol}//{host}:{port}{basePath}/ic/api/fileserver/v1/filesystem/directories/{guid}/permissions/users/{user}
- Update a folder
- Method: putPath:
{protocol}//{host}:{port}{basePath}/ic/api/fileserver/v1/filesystem/directories/{guid}
- Update a folder by path
- Method: putPath:
{protocol}//{host}:{port}{basePath}/ic/api/fileserver/v1/filesystem/root/{fsPath}
- Update a folder's permissions
- Method: putPath:
{protocol}//{host}:{port}{basePath}/ic/api/fileserver/v1/filesystem/directories/{guid}/permissions
File Server/Groups
- Delete individual group
- Method: deletePath:
{protocol}//{host}:{port}{basePath}/ic/api/fileserver/v1/groups/{group}
- Get individual group
- Method: getPath:
{protocol}//{host}:{port}{basePath}/ic/api/fileserver/v1/groups/{group}
- Search groups
- Method: getPath:
{protocol}//{host}:{port}{basePath}/ic/api/fileserver/v1/groups
- Update a group
- Method: putPath:
{protocol}//{host}:{port}{basePath}/ic/api/fileserver/v1/groups/{group}
File Server/Services
- Get all services
- Method: getPath:
{protocol}//{host}:{port}{basePath}/ic/api/fileserver/v1/services
- Get service instance details
- Method: getPath:
{protocol}//{host}:{port}{basePath}/ic/api/fileserver/v1/serviceinstance
- Get service status
- Method: getPath:
{protocol}//{host}:{port}{basePath}/ic/api/fileserver/v1/services/{serviceType}
- Get SFTP security supported algorithms
- Method: getPath:
{protocol}//{host}:{port}{basePath}/ic/api/fileserver/v1/services/sftp/supportedSecurityAlgorithms
- Get SFTP server configuration
- Method: getPath:
{protocol}//{host}:{port}{basePath}/ic/api/fileserver/v1/services/sftp/configuration
- Update a service
- Method: putPath:
{protocol}//{host}:{port}{basePath}/ic/api/fileserver/v1/services/{serviceType}
- Update SFTP service configuration
- Method: putPath:
{protocol}//{host}:{port}{basePath}/ic/api/fileserver/v1/services/sftp/configuration
File Server/Users
- Delete a user's metadata
- Method: deletePath:
{protocol}//{host}:{port}{basePath}/ic/api/fileserver/v1/users/{user}
- Delete a user's SSH public key
- Method: deletePath:
{protocol}//{host}:{port}{basePath}/ic/api/fileserver/v1/users/{user}/key
- Get a user's details
- Method: getPath:
{protocol}//{host}:{port}{basePath}/ic/api/fileserver/v1/users/{user}
- Get a user's SSH public key
- Method: getPath:
{protocol}//{host}:{port}{basePath}/ic/api/fileserver/v1/users/{user}/key
- Get user's permissions
- Method: getPath:
{protocol}//{host}:{port}{basePath}/ic/api/fileserver/v1/users/{user}/effectivepermissions/filesystem/root/{fsPath}
- Get user's permissions for root
- Method: getPath:
{protocol}//{host}:{port}{basePath}/ic/api/fileserver/v1/users/{user}/effectivepermissions/filesystem/root
- Search for users
- Method: getPath:
{protocol}//{host}:{port}{basePath}/ic/api/fileserver/v1/users
- Update a user's details
- Method: putPath:
{protocol}//{host}:{port}{basePath}/ic/api/fileserver/v1/users/{user}
- Update a user's SSH public key
- Method: putPath:
{protocol}//{host}:{port}{basePath}/ic/api/fileserver/v1/users/{user}/key
- Upload a user's SSH public key
- Method: postPath:
{protocol}//{host}:{port}{basePath}/ic/api/fileserver/v1/users/{user}/key