---
title: "Get business service availability"
method: GET
path: "/v1/objects/{object-id}/availability"
tags: ["Objects"]
---

# Get business service availability

`GET /v1/objects/{object-id}/availability`

Percentage of the requested period during which the business service was not in CRITICAL state. Downtime is recorded only on transitions into and out of CRITICAL, so a service whose failing checks never take it past DEGRADED reports 100% even when `includeTickets` returns open tickets for the same period. Applies to objects of class BusinessService only; any other class is reported as not found.

## Path parameters

- `object-id` integer, required

## Query parameters

- `from` string
- `to` string
- `includeTickets` boolean

## Response `200`

Availability for the requested period.

- object
  - `uptime` number, double — Percentage of the period the service was up, 0 to 100.
  - `from` string, date-time — Start of the period actually used. `1970-01-01T00:00:00Z` when `from` was not supplied.
  - `to` string, date-time — End of the period actually used.
  - `tickets` BusinessServiceTicket[] — Present only when `includeTickets` is true.
    - `id` integer — Ticket ID.
    - `serviceId` integer — ID of the business service the check that raised the ticket belongs to. For a ticket propagated from a child service this is the child, not the service that was queried.
    - `checkId` integer — ID of the check that raised the ticket.
    - `creationTime` string, date-time — When the check started failing.
    - `closureTime` string, date-time, nullable — When the check recovered. Null while the ticket is still open.
    - `reason` string — Failure reason recorded when the ticket was raised.
    - `checkDescription` string — Description of the check, as it read at the time.

## Other responses

- `400` — Unparseable `from` / `to`, a bound outside the accepted range, or `to` earlier than `from`.
- `401` — Unauthorized
- `403` — User does not have read access to the business service
- `404` — No business service with given ID
- `500` — Unable to read business service history from database

---

[API](https://skmtc.dev/netxms/apis/netxms-api.md) · [All operations](https://skmtc.dev/netxms/apis/netxms-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/netxms/netxms-api/revisions/b04ea2fbcedb/schema)