Delete an SFTP user

DELETE /v2/sftp-users/{sftpUserId}/

API version

v2

Request method

DELETE

Operation ID

sftp-user-delete-sftp-user

---

Request

• sftpUserIdstring

  required

  ID of the SFTPUser to be deleted.

Responses

No response content specified.

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -X DELETE \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v2/sftp-users/string

JavaScript SDK

import { MittwaldAPIV2Client } from "@mittwald/api-client";
import { assertStatus } from "@mittwald/api-client-commons";
  
const client = MittwaldAPIClient.newWithToken(process.env.MITTWALD_API_TOKEN);
const response = await client.sshsftpUser.sftpUserDeleteSftpUser({
  "sftpUserId": "string"
});

assertStatus(response, 204);
  

PHP SDK

use \Mittwald\ApiClient\Generated\V2\Clients\SSHSFTPUser\SftpUserDeleteSftpUser\SftpUserDeleteSftpUserRequest;
  
$client = MittwaldAPIClient::newWithToken(getenv('MITTWALD_API_TOKEN'));

$request = (new SftpUserDeleteSftpUserRequest(
  sftpUserId: "string"
));
$response = $client->sshsftpUser()->sftpUserDeleteSftpUser($request);

var_dump($response->getBody();