Salesforce

Java API endpoint: EngineAPI

« Go Back
Information
Java API endpoint: EngineAPI
000008193
Public
Product Selection
aiWare - API
Article Details
createBuildPOST /admin/build/createThis API creates a new engine build
createEnginePOST /admin/engine/createThis API creates a new engine
createEngineCategoryPOST /admin/engine/category/createThis API creates a new engine category
createJobForEnginePOST /engine/{EngineID}/createjobThis API create a job for the engine
deleteBuildPostPOST /admin/build/{BuildID}/deleteThis API deletes a specific build
deleteEnginePostPOST /admin/engine/{EngineID}/deleteThis API delets an engine
deleteEngineTemplateDELETE /engine/{EngineID}/template/{EngineTemplateName}Delete the template of the engine given its ID and template name
getEngineBuildGET /admin/build/{BuildID}/detailThis gets a particular build
getEngineBuildsGET /admin/engine/{EngineID}/buildsGet the list of builds deployed and available on aiWARE for a particular engine
getEngineBuildsByStateGET /engine/buildsThe api returns engine build records by build state
getEngineBuildsToDownloadGET /engine/builds/downloadsThe api returns latest downloadable engine build records for each engine
getEngineCategoriesGET /admin/engine/categoriesThis provides a list of engine categories
getEngineCategoryDetailGET /admin/engine/category/{EngineCategoryID}/detailThis provides detail for an engine category
getEngineContainerCountGET /engine/container_countGet engine container count
getEngineDetailGET /admin/engine/{EngineID}/detailThis API provides the engine detail result
getEngineInstanceDetailGET /engine/instance/{EngineInstanceID}/detailGet information about an engine Instance
getEngineInstanceListGET /engine/instancesGet engines instances with filtering
getEngineInstanceLogsGET /engine/instance/{EngineInstanceID}/logsGet engine instance logs as a zip file
getEngineInstanceStatusGET /engine/instance/{EngineInstanceID}/statusGet the latest status of the engine instance
getEngineInstanceWorkPOST /engine/instance/{EngineInstanceID}/getworkGet a work request
getEngineInstanceWorkDetailGET /engine/instance/{EngineInstanceID}/workdetailGet detail of the work being done by the engine instance
getEngineInstancesGET /engine/{EngineID}/instancesGet information about the instances of an engine
getEngineLaunchDetailGET /engine/{EngineID}/launch/{LaunchID}/detailThis API returns the list of launches for this engine
getEngineLaunchesGET /engine/{EngineID}/launchesThis API returns the list of launches for this engine
getEngineStatsGET /admin/engine/statsThis gets useful engine statistics
getEngineTemplateGET /engine/{EngineID}/template/{EngineTemplateName}Get the template of the engine given its ID and template name -- if EngineTeamplateName==`all`, all the templates for the engines will be returned
getEnginesGET /admin/enginesGet the list of engines deployed and available on aiWARE
getJobsBacklogCountByEnginePOST /proc/jobs/backlog_count_by_engineGet backlog count by engine
getResourcesForEngineInstanceGET /engine/instance/{EngineInstanceID}/resourcesGet resources for engine instance
pauseBuildPOST /admin/build/{BuildID}/pauseThis API pauses a build so that tasks based on this engine build will not run.
pauseEnginePOST /admin/engine/{EngineID}/pauseThis API pauses an engine so that tasks based on this engine will not run.
registerEngineInstanceNoAuthPOST /engine/instance/registerRegister a new engine instance without authorization
replaceEnginePOST /admin/engine/{EngineID}/replaceThis API replaced an engine so that tasks based on this engine will not run.
resumeBuildPOST /admin/build/{BuildID}/resumeThis API resumes a build so that tasks based on this engine build will start running.
resumeEnginePOST /admin/engine/{EngineID}/resumeThis API resumes a build so that tasks based on this engine build will start running.
terminateEngineInstancePOST /engine/instance/{EngineInstanceID}/terminateDelete the engine instance record
updateEnginePOST /admin/engine/{EngineID}/updateThis API updates the specified engine
updateEngineBuildPOST /admin/build/{BuildID}/updateThis API updates the specified engine
updateEngineBuildStatePOST /engine/build/{BuildID}/stateUpdate the Engine Build State
updateEngineCategoryPOST /admin/engine/category/{EngineCategoryID}/updateThis updates the specified engine category
updateEngineInstanceStatusPOST /engine/instance/{EngineInstanceID}/updatestatusUpdate the Engine Instance Status. Heartbeat to communicate back to controller both aggregated work and delta work from last heartbeat
upsertEngineTemplatePOST /engine/{EngineID}/template/{EngineTemplateName}Create or Update the template of the engine given its ID and template name

 

Additional Technical Documentation Information
Properties
4/24/2025 5:53 PM
5/20/2025 6:40 PM
5/20/2025 6:40 PM
Documentation
Documentation
000008193
Translation Information
English

Powered by