Sidebar

manual:api:reference:usermacro:delete

usermacro.delete

Description

object usermacro.delete(array hostMacroIds)

This method allows to delete host macros.

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 macros to delete.

Return values

(object) Returns an object containing the IDs of the deleted host macros under the hostmacroids property.

Examples

Deleting multiple host macros

Delete two host macros.

Request:

{
    "jsonrpc": "2.0",
    "method": "usermacro.delete",
    "params": [
        "32",
        "11"
    ],
    "auth": "3a57200802b24cda67c4e4010b50c065",
    "id": 1
}

Response:

{
    "jsonrpc": "2.0",
    "result": {
        "hostmacroids": [
            "32",
            "11"
        ]
    },
    "id": 1
}

Source

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