Salesforce

Go API endpoint: HostAPI

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

All URIs are relative to https://api.aiware.com/edge/v1

MethodHTTP requestDescription
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
1/29/2025 9:09 PM
1/29/2025 9:09 PM
11/21/2024 10:00 PM
Documentation
Documentation
000004306
Translation Information
English

Powered by