Documentation

You are viewing documentation for the development version, it may be incomplete.
Join our translation project and help translate Zabbix documentation into your native language.

Sidebar

Become a monitoring expert!
Sign up for Zabbix training

sla.update

Description

object sla.update(object/array slaids)

This method allows to update existing SLA entries.

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) SLA properties to be updated.

The slaid property must be defined for each SLA, all other properties are optional. Only the passed properties will be updated, all others will remain unchanged.

Additionally to the standard SLA properties, the method accepts the following parameters.

Parameter Type Description
service_tags array SLA service tags to replace the current SLA service tags.

At least one service tag must be specified.
schedule array SLA schedule to replace the current one.

Specifying parameter as empty will be interpreted as a 24x7 schedule.
excluded_downtimes array SLA excluded downtimes to replace the current ones.

Return values

(object) Returns an object containing the IDs of the updated SLAs under the slaids property.

Examples

Updating service tags

Make SLA with ID "5" to be calculated at monthly intervals for NoSQL related services, without changing its schedule or excluded downtimes; set SLO to 95%.

Request:

{
           "jsonrpc": "2.0",
           "method": "sla.update",
           "params": [
               {
                   "slaid": "5",
                   "name": "NoSQL Database engines",
                   "slo": "95",
                   "period": 2,
                   "service_tags": [
                       {
                           "tag": "Database",
                           "operator": "0",
                           "value": "Redis"
                       },
                       {
                           "tag": "Database",
                           "operator": "0",
                           "value": "MongoDB"
                       }
                   ]
               }
           ],
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

Response:

{
           "jsonrpc": "2.0",
           "result": {
               "slaids": [
                   "5"
               ]
           },
           "id": 1
       }

Changing the schedule of an SLA

Switch the SLA with ID "5" to a 24x7 schedule.

Request:

{
           "jsonrpc": "2.0",
           "method": "service.update",
           "params": {
               "slaid": "5",
               "schedule": []
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

Response:

{
           "jsonrpc": "2.0",
           "result": {
               "slaids": [
                   "5"
               ]
           },
           "id": 1
       }

Changing the excluded downtimes for an SLA

Add a planned 4 hour long RAM upgrade downtime on the 6th of April, 2022, while keeping (needs to be defined anew) a previously existing software upgrade planned on the 4th of July for the SLA with ID "5".

Request:

{
           "jsonrpc": "2.0",
           "method": "service.update",
           "params": {
               "slaid": "5",
               "excluded_downtimes": [
                   {
                       "name": "Software version upgrade rollout",
                       "period_from": "1648760400",
                       "period_to": "1648764900"
                   },
                   {
                       "name": "RAM upgrade",
                       "period_from": "1649192400",
                       "period_to": "1649206800"
                   }
               ]
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

Response:

{
           "jsonrpc": "2.0",
           "result": {
               "slaids": [
                   "5"
               ]
           },
           "id": 1
       }

Source

CSla::update() in ui/include/classes/api/services/CSla.php.