Sidebar

manual:api:reference:action:exists

action.exists

Description

boolean action.exists(object filter)

This method checks if at least one action that matches the given filter criteria exists.

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

Parameters

(object) Criteria to search by.

The following parameters are supported as search criteria.

Parameter Type Description
actionid string/array IDs of actions.
name string/array Names of actions.

Return values

(boolean) Returns true if at least one action that matches the given filter criteria exists.

Examples

Check action by name

Check if an action named “Auto discovery. Linux servers.” exists.

Request:

{
    "jsonrpc": "2.0",
    "method": "action.exists",
    "params": {
        "name": "Auto discovery. Linux servers."
    },
    "auth": "3a57200802b24cda67c4e4010b50c065",
    "id": 1
}

Response:

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

Source

CAction::exists() in frontends/php/include/classes/api/services/CAction.php.