connections

Close connection

Terminates an active connection

delete/connections/{connectionID}

Request

Base URL
/api/v2 (relative, and the document was published on a file host, not at the API’s origin)
Auth
- HTTP bearer
- or API key in header X-SFTPGO-API-KEY
TypeScript
https://skmtc.dev/kanton-bern/apis/sftpgo/docs/connections/:connectionID/delete.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

connectionIDstring required

ID of the connection to close

Response

successful operation

messagestring

message, can be empty

errorstring

error description if any

Changes

No recorded changes to this operation across all 1 revision of this API.