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 for a User

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