HomeGuidesAPI Reference
API Reference
GuidesAPI ReferenceGitHubAirheads Developer Community
  1. Orchestrator REST APIs
  2. availabilityTimeSettings

Configure appliance business hours for KPI availability calculations

post
http://127.0.0.1:8080/stats/config/applianceBusinessHours

Creates or updates business hour configurations (KPI Time Settings) for one or more appliances. Validates all parameters including nePk existence, hour ranges (0-23), and timezone validity before persisting to ClickHouse database. Logs system action on success or failure.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Array of appliance business hour configurations. Each configuration specifies an appliance and its working hours for availability metrics.

Array of business hour configurations to apply to appliances.

Business hour configuration for a single appliance defining working hours (KPI Time Settings) for availability calculations. When iscustombusinesshour is false, 24/7 monitoring is used regardless of other settings.

string
required
^\d+\.NE$

Network Element Primary Key - unique appliance identifier assigned by Orchestrator. Format: '.NE'.

boolean
Defaults to false

Enable custom business hours. When false, availability is calculated 24/7 ignoring start/end hours.

integer
0 to 23
Defaults to 0

Business day start hour (24-hour format). Only applied when iscustombusinesshour is true.

integer
0 to 23
Defaults to 0

Business day end hour (24-hour format). Only applied when iscustombusinesshour is true.

string
Defaults to UTC

Timezone for interpreting business hours. Use Java TimeZone ID or 'Use appliance timezone' to inherit from appliance /datetime config.

Responses

Updated about 11 hours ago

Did this page help you?
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 11 hours ago

Did this page help you?