Sidebar

manual:api:reference:hostgroup:iswritable

hostgroup.iswritable

Description

boolean hostgroup.iswritable(array hostGroupIds)

This method checks if the given host groups are available for writing.

This method is deprecated and will be removed in the future. Please use hostgroup.get instead.

Parameters

(array) IDs of the host groups to check.

Return values

(boolean) Returns true if the given host groups are available for writing.

Examples

Check multiple host groups

Check if the two host groups are writable.

Request:

{
    "jsonrpc": "2.0",
    "method": "hostgroup.iswritable",
    "params": [
        "5",
        "7"
    ],
    "auth": "038e1d7b1735c6a5436ee9eae095879e",
    "id": 1
}

Response:

{
    "jsonrpc": "2.0",
    "result": true,
    "id": 1
}

See also

Source

CHostGroup::isWritable() in frontends/php/include/classes/api/services/CHostGroup.php.