[comment]: # aside:1
[comment]: # ({9e9adb41-b1a89f1b})
# Service object
The following objects are directly related to the `service` API.
[comment]: # ({/9e9adb41-b1a89f1b})
[comment]: # ({64f35abb-5d7a3d70})
### Service
The service object has the following properties.
|Property|[Type](/manual/api/reference_commentary#data-types)|Description|
|--|--|------|
|serviceid|ID|ID of the service.
[Property behavior](/manual/api/reference_commentary#property-behavior):
- *read-only*
- *required* for update operations|
|algorithm|integer|Status calculation rule. Only applicable if child services exist.
Possible values:
0 - set status to OK;
1 - most critical if all children have problems;
2 - most critical of child services.
[Property behavior](/manual/api/reference_commentary#property-behavior):
- *required* for create operations|
|name|string|Name of the service.
[Property behavior](/manual/api/reference_commentary#property-behavior):
- *required* for create operations|
|sortorder|integer|Position of the service used for sorting.
Possible values: 0-999.
[Property behavior](/manual/api/reference_commentary#property-behavior):
- *required* for create operations|
|weight|integer|Service weight.
Possible values: 0-1000000.
Default: 0.|
|propagation\_rule|integer|Status propagation rule.
Possible values:
0 - *(default)* propagate service status as is - without any changes;
1 - increase the propagated status by a given `propagation_value` (by 1 to 5 severities);
2 - decrease the propagated status by a given `propagation_value` (by 1 to 5 severities);
3 - ignore this service - the status is not propagated to the parent service at all;
4 - set fixed service status using a given `propagation_value`.
[Property behavior](/manual/api/reference_commentary#property-behavior):
- *required* if `propagation_value` is set|
|propagation\_value|integer|Status propagation value.
Possible values if `propagation_rule` is set to "0" or "3":
0 - Not classified.
Possible values if `propagation_rule` is set to "1" or "2":
1 - Information;
2 - Warning;
3 - Average;
4 - High;
5 - Disaster.
Possible values if `propagation_rule` is set to "4":
-1 - OK;
0 - Not classified;
1 - Information;
2 - Warning;
3 - Average;
4 - High;
5 - Disaster.
[Property behavior](/manual/api/reference_commentary#property-behavior):
- *required* if `propagation_rule` is set|
|status|integer|Whether the service is in OK or problem state.
If the service is in a problem state, `status` equals either the severity of the most critical problem or the highest status of a child service in a problem state.
If the service is in OK state, `status` is equal to: -1.
[Property behavior](/manual/api/reference_commentary#property-behavior):
- *read-only*|
|description|string|Description of the service.|
|uuid|string|Universal unique identifier, used for linking imported services to already existing ones. Auto-generated, if not given.|
|created_at|integer|Unix timestamp when service was created.|
|readonly|integer|Access to the service.
Possible values:
0 - Read-write;
1 - Read-only.
[Property behavior](/manual/api/reference_commentary#property-behavior):
- *read-only*|
[comment]: # ({/64f35abb-5d7a3d70})
[comment]: # ({dd16f497-c2041847})
### Status rule
The status rule object has the following properties.
|Property|[Type](/manual/api/reference_commentary#data-types)|Description|
|--|--|------|
|type|integer|Condition for setting (New status) status.
Possible values:
0 - if at least (N) child services have (Status) status or above;
1 - if at least (N%) of child services have (Status) status or above;
2 - if less than (N) child services have (Status) status or below;
3 - if less than (N%) of child services have (Status) status or below;
4 - if weight of child services with (Status) status or above is at least (W);
5 - if weight of child services with (Status) status or above is at least (N%);
6 - if weight of child services with (Status) status or below is less than (W);
7 - if weight of child services with (Status) status or below is less than (N%).
Where:
- N (W) is `limit_value`;
- (Status) is `limit_status`;
- (New status) is `new_status`.
[Property behavior](/manual/api/reference_commentary#property-behavior):
- *required*|
|limit\_value|integer|Limit value.
Possible values:
- for N and W: 1-100000;
- for N%: 1-100.
[Property behavior](/manual/api/reference_commentary#property-behavior):
- *required*|
|limit\_status|integer|Limit status.
Possible values:
-1 - OK;
0 - Not classified;
1 - Information;
2 - Warning;
3 - Average;
4 - High;
5 - Disaster.
[Property behavior](/manual/api/reference_commentary#property-behavior):
- *required*|
|new\_status|integer|New status value.
Possible values:
0 - Not classified;
1 - Information;
2 - Warning;
3 - Average;
4 - High;
5 - Disaster.
[Property behavior](/manual/api/reference_commentary#property-behavior):
- *required*|
[comment]: # ({/dd16f497-c2041847})
[comment]: # ({72128b59-c301cfb2})
### Service tag
The service tag object has the following properties.
|Property|[Type](/manual/api/reference_commentary#data-types)|Description|
|--|--|------|
|tag|string|Service tag name.
[Property behavior](/manual/api/reference_commentary#property-behavior):
- *required*|
|value|string|Service tag value.|
[comment]: # ({/72128b59-c301cfb2})
[comment]: # ({92be70e8-e6daa7b4})
### Service alarm
::: noteclassic
Service alarms cannot be directly created, updated or deleted via the Zabbix API.
:::
The service alarm objects represent a service's state change.
It has the following properties.
|Property |[Type](/manual/api/reference_commentary#data-types)|Description|
|--|--|------|
|clock|timestamp|Time when the service state change has happened.|
|value|integer|Status of the service.
Refer to the [service `status` property](object#service) for a list of possible values.|
[comment]: # ({/92be70e8-e6daa7b4})
[comment]: # ({88aae5fd-6b88d3dc})
### Problem tag
Problem tags allow linking services with problem events.
The problem tag object has the following properties.
|Property|[Type](/manual/api/reference_commentary#data-types)|Description|
|--|--|------|
|tag|string|Problem tag name.
[Property behavior](/manual/api/reference_commentary#property-behavior):
- *required*|
|operator|integer|Mapping condition [operator](/manual/it_services/service_tree#service-configuration).
Possible values:
0 - *(default)* Equals;
2 - Contains.|
|value|string|Problem tag value.|
[comment]: # ({/88aae5fd-6b88d3dc})