Remove a host from the defender lists

1 parameter

idstringrequired

host id

6 status codes

200successful operation

errorstringoptional

error description if any

messagestringoptional

message, can be empty

401Unauthorized

errorstringoptional

error description if any

messagestringoptional

message, can be empty

403Forbidden

errorstringoptional

error description if any

messagestringoptional

message, can be empty

404Not Found

errorstringoptional

error description if any

messagestringoptional

message, can be empty

500Internal Server Error

errorstringoptional

error description if any

messagestringoptional

message, can be empty

defaultUnexpected Error

errorstringoptional

error description if any

messagestringoptional

message, can be empty

Error handling

A 401 is returned: Unauthorized. A 403 is returned: Forbidden. A 404 is returned: Not Found. A 500 is returned: Internal Server Error. Any other status is an error: Unexpected Error.

import { SFTPGoEnterpriseAPIUnofficialOctriFullPreview } from "sftpgo-octri-preview-sdk";

const client = new SFTPGoEnterpriseAPIUnofficialOctriFullPreview({
  baseUrl: "/api/v2",
  auth: { apiKeyAuth: process.env.API_TOKEN! },
});

const result = await client.defender.deleteHostById({ id: "9b2f1c10-7a3e-4d54-8c2a-1f6b9e0d4a21" });

{
  "error": "example_value",
  "message": "This is an example message."
}

Request

Response

Errors