service.delete

Description

object service.delete(array **serviceIds**)

This method allows to delete services.

Services with hard-dependent child services cannot be deleted.

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

Return values

(object) Returns an object containing the IDs of the deleted services under the serviceids property.

Examples

Deleting multiple services

Delete two services.

Request:

  1. {
  2.     "jsonrpc": "2.0",
  3.     "method": "service.delete",
  4.     "params": [
  5.         "4",
  6.         "5"
  7.     ],
  8.     "auth": "3a57200802b24cda67c4e4010b50c065",
  9.     "id": 1
  10. }

Response:

  1. {
  2.     "jsonrpc": "2.0",
  3.     "result": {
  4.         "serviceids": [
  5.             "4",
  6.             "5"
  7.         ]
  8.     },
  9.     "id": 1
  10. }

Source

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