All REST Endpoints

Sort by

Task Path Method

Group by API

File Server/Configuration

Get file system configuration

Method: get

Path: {protocol}//{host}:{port}{basePath}/ic/api/fileserver/v1/filesystem/configuration

Update the file system configuration

Method: put

Path: {protocol}//{host}:{port}{basePath}/ic/api/fileserver/v1/filesystem/configuration

File Server/File System

Create a folder

Method: post

Path: {protocol}//{host}:{port}{basePath}/ic/api/fileserver/v1/filesystem/directories

Delete a folder

Method: delete

Path: {protocol}//{host}:{port}{basePath}/ic/api/fileserver/v1/filesystem/directories/{guid}

Delete a folder by path

Method: delete

Path: {protocol}//{host}:{port}{basePath}/ic/api/fileserver/v1/filesystem/root/{fsPath}

Get a folder by path

Method: get

Path: {protocol}//{host}:{port}{basePath}/ic/api/fileserver/v1/filesystem/root/{fsPath}

Get a folder by path ID

Method: get

Path: {protocol}//{host}:{port}{basePath}/ic/api/fileserver/v1/filesystem/directories/{guid}

Get folder permission

Method: get

Path: {protocol}//{host}:{port}{basePath}/ic/api/fileserver/v1/filesystem/directories/{guid}/permissions/groups/{group}

Get folder permissions

Method: get

Path: {protocol}//{host}:{port}{basePath}/ic/api/fileserver/v1/filesystem/directories/{guid}/permissions

Get root directory of file system

Method: get

Path: {protocol}//{host}:{port}{basePath}/ic/api/fileserver/v1/filesystem/root

Get user permission

Method: get

Path: {protocol}//{host}:{port}{basePath}/ic/api/fileserver/v1/filesystem/directories/{guid}/permissions/users/{user}

Update a folder

Method: put

Path: {protocol}//{host}:{port}{basePath}/ic/api/fileserver/v1/filesystem/directories/{guid}

Update a folder by path

Method: put

Path: {protocol}//{host}:{port}{basePath}/ic/api/fileserver/v1/filesystem/root/{fsPath}

Update a folder's permissions

Method: put

Path: {protocol}//{host}:{port}{basePath}/ic/api/fileserver/v1/filesystem/directories/{guid}/permissions

File Server/Groups

Delete individual group

Method: delete

Path: {protocol}//{host}:{port}{basePath}/ic/api/fileserver/v1/groups/{group}

Get individual group

Method: get

Path: {protocol}//{host}:{port}{basePath}/ic/api/fileserver/v1/groups/{group}

Search groups

Method: get

Path: {protocol}//{host}:{port}{basePath}/ic/api/fileserver/v1/groups

Update a group

Method: put

Path: {protocol}//{host}:{port}{basePath}/ic/api/fileserver/v1/groups/{group}

File Server/Services

Get all services

Method: get

Path: {protocol}//{host}:{port}{basePath}/ic/api/fileserver/v1/services

Get service instance details

Method: get

Path: {protocol}//{host}:{port}{basePath}/ic/api/fileserver/v1/serviceinstance

Get service status

Method: get

Path: {protocol}//{host}:{port}{basePath}/ic/api/fileserver/v1/services/{serviceType}

Get SFTP security supported algorithms

Method: get

Path: {protocol}//{host}:{port}{basePath}/ic/api/fileserver/v1/services/sftp/supportedSecurityAlgorithms

Get SFTP server configuration

Method: get

Path: {protocol}//{host}:{port}{basePath}/ic/api/fileserver/v1/services/sftp/configuration

Update a service

Method: put

Path: {protocol}//{host}:{port}{basePath}/ic/api/fileserver/v1/services/{serviceType}

Update SFTP service configuration

Method: put

Path: {protocol}//{host}:{port}{basePath}/ic/api/fileserver/v1/services/sftp/configuration

File Server/Users

Delete a user's metadata

Method: delete

Path: {protocol}//{host}:{port}{basePath}/ic/api/fileserver/v1/users/{user}

Delete a user's SSH public key

Method: delete

Path: {protocol}//{host}:{port}{basePath}/ic/api/fileserver/v1/users/{user}/key

Get a user's details

Method: get

Path: {protocol}//{host}:{port}{basePath}/ic/api/fileserver/v1/users/{user}

Get a user's SSH public key

Method: get

Path: {protocol}//{host}:{port}{basePath}/ic/api/fileserver/v1/users/{user}/key

Get user's permissions

Method: get

Path: {protocol}//{host}:{port}{basePath}/ic/api/fileserver/v1/users/{user}/effectivepermissions/filesystem/root/{fsPath}

Get user's permissions for root

Method: get

Path: {protocol}//{host}:{port}{basePath}/ic/api/fileserver/v1/users/{user}/effectivepermissions/filesystem/root

Search for users

Method: get

Path: {protocol}//{host}:{port}{basePath}/ic/api/fileserver/v1/users

Update a user's details

Method: put

Path: {protocol}//{host}:{port}{basePath}/ic/api/fileserver/v1/users/{user}

Update a user's SSH public key

Method: put

Path: {protocol}//{host}:{port}{basePath}/ic/api/fileserver/v1/users/{user}/key

Upload a user's SSH public key

Method: post

Path: {protocol}//{host}:{port}{basePath}/ic/api/fileserver/v1/users/{user}/key