SFTP Users

get

List all current SFTP users.

Authorizations

Path parameters

station_idany ofRequired

integer · int64Optional

or

string · stringOptional

Responses

200

Success

application/json

Responseall of[]

403

Access denied.

application/json

404

Record not found.

application/json

500

A generic exception has occurred.

application/json

get

HTTPcURLJavaScriptPython

GET /api/station/{station_id}/sftp-users HTTP/1.1
Host: listen.dovafm.xyz
X-API-Key: YOUR_API_KEY
Accept: */*

[
  {
    "id": 1,
    "username": "text",
    "password": "text",
    "publicKeys": "text"
  }
]

post

Create a new SFTP user.

Authorizations

Path parameters

station_idany ofRequired

integer · int64Optional

or

string · stringOptional

Body

all ofOptional

Responses

200

Success

application/json

Responseall of

403

Access denied.

application/json

404

Record not found.

application/json

500

A generic exception has occurred.

application/json

post

HTTPcURLJavaScriptPython

POST /api/station/{station_id}/sftp-users HTTP/1.1
Host: listen.dovafm.xyz
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 64

{
  "id": 1,
  "username": "text",
  "password": "text",
  "publicKeys": "text"
}

{
  "id": 1,
  "username": "text",
  "password": "text",
  "publicKeys": "text"
}

get

Retrieve details for a single SFTP user.

Authorizations

Path parameters

station_idany ofRequired

integer · int64Optional

or

string · stringOptional

idinteger · int64Required

SFTP User ID

Responses

200

Success

application/json

Responseall of

403

Access denied.

application/json

404

Record not found.

application/json

500

A generic exception has occurred.

application/json

get

HTTPcURLJavaScriptPython

GET /api/station/{station_id}/sftp-user/{id} HTTP/1.1
Host: listen.dovafm.xyz
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "id": 1,
  "username": "text",
  "password": "text",
  "publicKeys": "text"
}

put

Update details of a single SFTP user.

Authorizations

Path parameters

station_idany ofRequired

integer · int64Optional

or

string · stringOptional

idinteger · int64Required

Remote Relay ID

Body

all ofOptional

Responses

200

Success

application/json

403

Access denied.

application/json

404

Record not found.

application/json

500

A generic exception has occurred.

application/json

put

HTTPcURLJavaScriptPython

PUT /api/station/{station_id}/sftp-user/{id} HTTP/1.1
Host: listen.dovafm.xyz
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 64

{
  "id": 1,
  "username": "text",
  "password": "text",
  "publicKeys": "text"
}

{
  "success": true,
  "message": "Changes saved successfully.",
  "formatted_message": "<b>Changes saved successfully.</b>"
}

delete

Delete a single remote relay.

Authorizations

Path parameters

station_idany ofRequired

integer · int64Optional

or

string · stringOptional

idinteger · int64Required

Remote Relay ID

Responses

200

Success

application/json

403

Access denied.

application/json

404

Record not found.

application/json

500

A generic exception has occurred.

application/json

delete

HTTPcURLJavaScriptPython

DELETE /api/station/{station_id}/sftp-user/{id} HTTP/1.1
Host: listen.dovafm.xyz
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "message": "Changes saved successfully.",
  "formatted_message": "<b>Changes saved successfully.</b>"
}