Sidebar

manual:api:reference:maintenance:delete

maintenance.delete

Description

object maintenance.delete(array maintenanceIds)

This method allows to delete maintenances.

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

Return values

(object) Returns an object containing the IDs of the deleted maintenances under the maintenanceids property.

Examples

Deleting multiple maintenances

Delete two maintenanaces.

Request:

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

Response:

{
    "jsonrpc": "2.0",
    "result": {
        "maintenanceids": [
            "3",
            "1"
        ]
    },
    "id": 1
}

Source

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