From Bright Pattern Documentation
< 5.3:Host-and-services-management-api-specification
Revision as of 04:09, 29 May 2024 by BpDeeplTranslateMaintenance (talk | contribs) (Updated via BpDeleteTranslateTags script)
Get Host and Services State
This method gets host and host services tenant data. Data includes host state and services data.
Request
URL | http[s]://<host>:<port>/configapi/v2/selfservice/host/<host_name> |
Method | GET |
Response
Code | Content Type | Body |
200 | Application/JSON |
{ "name":"vbox-xp.lan", "inMaintenance":false, "servers":{ "ACTIVITYSERVER":{"role":"ACTIVE","state":"STARTED"}, "AD":{"role":"ACTIVE","state":"STARTED"}, "AGENT":{"role":"ACTIVE","state":"STARTED"}, "CLIENTWEB":{"role":"ACTIVE","state":"STARTED"}, "CONFIG":{"role":"ACTIVE","state":"STARTED"}, "CRM_SERVER":{"role":"ACTIVE","state":"STARTED"}, "DB":{"role":"ACTIVE","state":"STARTED"}, "DIALER":{"role":"ACTIVE","state":"STARTED"}, "EMAIL_SERVER":{"role":"ACTIVE","state":"STARTED"}, "PORTAL":{"role":"ACTIVE","state":"STARTED"}, "PROVISIONING":{"role":"ACTIVE","state":"STARTED"}, "REPORTINGAGGREGATOR":{"role":"DISABLED","state":"STOPPED"}, "ROUTER":{"role":"ACTIVE","state":"STARTED"}, "RTDATAPROVIDER":{"role":"ACTIVE","state":"STARTED"}, "RTP":{"role":"ACTIVE","state":"STARTED"}, "SCENARIO":{"role":"ACTIVE","state":"STARTED"}, "SCHEDULER":{"role":"ACTIVE","state":"STARTED"}, "SCREEN_RECORDER":{"role":"ACTIVE","state":"STARTED"}, "SMS":{"role":"ACTIVE","state":"STARTED"}, "STAT":{"role":"ACTIVE","state":"STARTED"}, "SWITCH":{"role":"ACTIVE","state":"STARTED"} } } |
404 | Host is not found |