Get availability of a given service

Retrieves the availability data of a specified service within a given time range. This allows users to monitor and analyze the service's uptime, downtime and degradedtime over a specific period.

Gets availability information for a specified service over a defined time period.

Query Parameter:

Name Possible Values Service Map
select up Yes
down Yes
unknown NA
undefined NA
degraded Yes
all * - (Default) Yes

Example:

GET api/v3/tenants/{clientId}/services/{serviceId}/availability?startTimestamp={startTimestamp}&endTimestamp={endTimestamp}&select=all,up,down,degraded

Path Parameters

  • clientIdstringrequired

  • serviceIdstringrequired

Responses

  • totalTimeDurationinteger

    Total time duration in seconds for which the service has been monitored.

  • upTimeDurationinteger

    Total duration in seconds for which the service was in an 'up' state.

  • downTimeDurationinteger

    Total duration in seconds for which the service was in a 'down' state.

  • degradedTimeDurationinteger

    Total duration in seconds for which the service's state was 'degraded'.

  • upPercentagenumber

    Percentage of time the service was in the 'up' state.

  • downPercentagenumber

    Percentage of time the service was in the 'down' state.

  • degradedPercentagenumber

    Percentage of time the service's state was 'degraded'.

  • allLogListarray

    List of all state logs for the service.

  • upTimeLogListarray

    List of logs when the service was in the 'up' state.

  • downTimeLogListarray

    List of logs when the service was in the 'down' state.

  • degradedTimeLogListarray

    List of logs when the service was in the 'degraded' state.

Loading Examples...