Filestore Module GraphQL APIs

This section will capture the APIs related with Filestore Module.

Create FTP instance 

Creating an FTP instance into Freepbx/PBXact system.

 

API - addFTPInstance

API Parameter:

Name

Required

Type

Default

Description

Name

Required

Type

Default

Description

serverName

Mandatory

String

 

Name for the FTP connection

hostName

Mandatory

String

 

Name for the FTP host

userName

Mandatory

String

 

Set FTP instance username

password

Mandatory

String

 

Set FTP instance password

port

Optional

Number

22

FTP Port default is "22"

path

Optional

String

 

Path on remote server. This must be a COMPLETE PATH, starting with a / - for example, /home/backups/freepbx. 
A path without a leading slash will not work, and will behave in unexpected ways.

transferMode

Optional

String

 

This defaults to "Passive". If your FTP server is behind a separate NAT or Firewall to this VoIP server, you should select 
"Active". In "Active" mode, the FTP server establishes a connection back to the VoIP server to receive the data. In "Passive" 
mode, the VoIP server connects to the FTP Server to send data.

timeout

Optional

Number

30

Timeout on remote server, default is 30

description

Optional

String

 

Enter a description for this connection.

fileStoreType

Optional

String

 

The FTP Servers file system type. If you are unsure set this to Auto

 

 

Query Parameters 

status message id

 

 

API Request 

mutation{   addFTPInstance(input : {         serverName: "testGql"         hostName: "100.100.100.100"         userName: "testGql"         password: "testGql"      }){     status message id   } }

 

API Response 

{   "data": {     "addFTPInstance": {       "status": true,       "message": "FTP Instance is created successfully",       "id": "12345678-1234-1234-1234-12345678"     }   } }

Update FTP instance 

Updating an FTP instance into Freepbx/PBXact system.

 

API - updateFTPInstance

API Parameter:

Name

Required

Type

Default

Description

Name

Required

Type

Default

Description

id

Mandatory

String

 

Id of FTP

serverName

Mandatory

String

 

Name for the FTP connection

hostName

Mandatory

String

 

Name for the FTP host

userName

Mandatory

String

 

Set FTP instance username

password

Mandatory

String

 

Set FTP instance password

port

Optional

Number

22

FTP Port default is "22"

path

Optional

String

 

Path on remote server. This must be a COMPLETE PATH, starting with a / - for example, /home/backups/freepbx. 
A path without a leading slash will not work, and will behave in unexpected ways.

transferMode

Optional

String

 

This defaults to "Passive". If your FTP server is behind a separate NAT or Firewall to this VoIP server, you should select 
"Active". In "Active" mode, the FTP server establishes a connection back to the VoIP server to receive the data. In "Passive" 
mode, the VoIP server connects to the FTP Server to send data.

timeout

Optional

Number

30

Timeout on remote server, default is 30

description

Optional

String

 

Enter a description for this connection.

fileStoreType

Optional

String

 

The FTP Servers file system type. If you are unsure set this to Auto

 

 

Query Parameters 

 

 

API Request 

 

API Response 

Delete FTP instance 

Delete an FTP instance into Freepbx/PBXact system.

 

API - deleteFTPInstance

API Parameter:

Name

Required

Type

Default

Description

Name

Required

Type

Default

Description

id

Mandatory

String

 

Id of FTP

 

 

Query Parameters 

 

 

API Request 

 

API Response 

 

Create S3 instance 

Creating an S3 instance into Freepbx/PBXact system.

 

API - addS3Bucket

API Parameter:

Name

Required

Type

Default

Description

Name

Required

Type

Default

Description

name

Mandatory

String

 

Display name for the S3 instance

bucketName

Mandatory

String

 

AWS bucket name

AWSRegion

Mandatory

String

 

Add AWS region

AWSAccessKey

Mandatory

String

 

Set AWS access key

AWSSecret

Mandatory

String

 

Set AWS password

 

 

Query Parameters 

 

 

API Request 

 

API Response 

Fetch Filestore Types

Fetch File store into Freepbx/PBXact system.

 

API - fetchFilestoreTypes

API Parameter- none

 

Query Parameters 

 

 

API Request 

 

API Response 


Fetch Filestore Locations

Fetch File store locations into Freepbx/PBXact system.

 

API - fetchFilestoreLocations

API Parameter- none

 

Query Parameters 

 

 

API Request 

 

API Response 

Fetch AWS regions

Fetch AWS region into Freepbx/PBXact system.

 

API - fetchAWSRegion

API Parameter- none

 

Query Parameters 

 

 

API Request 

 

API Response 


Fetch All File Stores

Fetch all file store into Freepbx/PBXact system.

 

API - fetchAllFilestores

API Parameter- none

 

Query Parameters 

 

 

API Request 

 

API Response 

Return to Documentation Home I Return to Sangoma Support