SFTP account

Remove an SFTP key

DELETE/api/v1/sftp-account/keys/{id}

Removes the key: it can no longer log in. A session already open stays open until the client disconnects or has been idle 15 minutes. Removing a key that is already gone is not found.

Needs a key with submit permission.

Request

Path parameters

Path parameters
Name	Type	Required	Description
id	string	required	An SFTP key ID (sfk_...).

Response

The key that was removed. Status 200.

Response fields
Name	Type	Description
id	string	An ID that starts with sfk_.
object	string	Always `sftp_key`.
deleted	boolean	Always `true`.

Errors

Errors
HTTP status	Code	What it means
401	UNAUTHORIZED	A valid API key is required. Send it as "Authorization: Bearer <key>".
403	PERMISSION_DENIED	This API key is not allowed to do that.
404	NOT_FOUND	Not found.
422	INVALID_REQUEST	The request is not valid.
504	TIMEOUT	The request took too long to finish. It may still have taken effect: look it up before sending it again with a new Idempotency-Key. What it made is found with GET /api/v1/eligibility?request_id=<this request_id>, and the same filter on /api/v1/claims and /api/v1/attachments (a key with read permission).
500	INTERNAL	Something went wrong on our side. Quote the request ID if you contact us.

Example

Example request

Shell

curl -X DELETE "https://sandbox.myclaimhouse.com/api/v1/sftp-account/keys/sfk_01JM000000E00800000000008H" \
  -H "Authorization: Bearer $CLAIMHOUSE_KEY"

Example response: 200

JSON

{
  "id": "sfk_01JM000000E00800000000008H",
  "object": "sftp_key",
  "deleted": true
}