Sidebar

manual:api:reference:hostinterface:delete

hostinterface.delete

Description

object hostinterface.delete(array hostInterfaceIds)

This method allows to delete host interfaces.

This method is only available to Admin and Super admin user types. Permissions to call the method can be revoked in user role settings. See User roles for more information.

Parameters

(array) IDs of the host interfaces to delete.

Return values

(object) Returns an object containing the IDs of the deleted host interfaces under the interfaceids property.

Examples

Delete a host interface

Delete the host interface with ID 30062.

Request:

{
    "jsonrpc": "2.0",
    "method": "hostinterface.delete",
    "params": [
        "30062"
    ],
    "auth": "3a57200802b24cda67c4e4010b50c065",
    "id": 1
}

Response:

{
    "jsonrpc": "2.0",
    "result": {
        "interfaceids": [
            "30062"
        ]
    },
    "id": 1
}

See also

Source

CHostInterface::delete() in ui/include/classes/api/services/CHostInterface.php.