Salesforce

Bash API endpoint: HostAPI

« Go Back
Information
Bash API endpoint: HostAPI
000006256
Public
Product Selection
aiWare - API
Article Details

All URIs are relative to /edge/v1

drainHostPOST /host/{HostID}/drainPut this host into drain mode. A host in drain mode will not have work assigned to engines on the host.
getHostCpuUsageGET /hosts/cpu_usageGet host cpu usage
getHostDetailGET /host/{HostID}/detailGet the latest info of the host
getHostMemoryUsageGET /engine/memory_usageGet host memory usage
getHostStatusGET /host/{HostID}/statusGet the latest status of the host
getHostsGET /hostsThis provides a list of hosts in the system
getHostsCountsGET /hosts/countsGet the server counts in a time-range
getHostsCountsByTypeGET /hosts/counts_by_typeGet the server counts in a time-range
getHostsLaunchGET /host/{HostID}/launchThis provides a list of host launches in the system
hostAlertPOST /host/alertNotifies the controller about a system alert.
launchHostPOST /host/launchLaunch a new host with a particular server type
pauseHostPOST /host/{HostID}/pausePause all engines on this host.
registerEngineInstancePOST /host/{HostID}/engine/registerRegister a new engine instance
registerHostPOST /host/registerUpdate the Host Status
resumeHostPOST /host/{HostID}/resumeResume all engines on this host.
terminateHostPOST /host/{HostID}/terminateDelete the host/agent record. Any work still running on this host will be restarted on other hosts.
updateHostStatusPOST /host/{HostID}/updatestatusUpdate the Host Status
Additional Technical Documentation Information
Properties
2/4/2025 11:31 PM
2/4/2025 11:33 PM
2/4/2025 11:33 PM
Documentation
Documentation
000006256
Translation Information
English

Powered by