Sidebar

manual:api:reference:usermacro:create

usermacro.create

Description

object usermacro.create(object/array hostMacros)

This method allows to create new 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

(object/array) Host macros to create.

The method accepts host macros with the standard host macro properties.

Return values

(object) Returns an object containing the IDs of the created host macros under the hostmacroids property. The order of the returned IDs matches the order of the passed host macros.

Examples

Creating a host macro

Create a host macro “{$SNMP_COMMUNITY}” with the value “public” on host “10198”.

Request:

{
    "jsonrpc": "2.0",
    "method": "usermacro.create",
    "params": {
        "hostid": "10198",
        "macro": "{$SNMP_COMMUNITY}",
        "value": "public"
    },
    "auth": "038e1d7b1735c6a5436ee9eae095879e",
    "id": 1
}

Response:

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

Source

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