Salesforce

Bash API endpoint: AdminAPI

« Go Back
Information
Bash API endpoint: AdminAPI
000006253
Public
Product Selection
aiWare - API
Article Details

All URIs are relative to /edge/v1

MethodHTTP requestDescription
addEngineToResourcePOST /admin/resource/{ResourceID}/engineThis API adds the engine to the resource
addServiceToResourcePOST /admin/resource/{ResourceID}/serviceThis API adds the service to the resource
addserversServerTypePOST /admin/server_type/{ServerTypeID}/addThis API add servers to the specified server type
adminTerminateClusterPOST /admin/terminateThis terminates the cluster
applyLicensePOST /admin/licenses/applyThis applies a license to aiWARE
checkAuthPOST /admin/authThis check auth for a token
clearBacklogPOST /admin/backlog/clearThis clears some or all of the currently queued tasks
createAdminApplicationPOST /admin/applications/createThis creates a new application
createAdminCorePOST /admin/cores/createThis creates a new core
createAdminOrganizationPOST /admin/organizations/createThis updates the config for the cluster for a given key
createPermissionPOST /admin/users/permission/createThis creates a new permission
createResourcePOST /admin/resource/createThis API creates a new resource definition such as a database, nsq or redis DB.
createRolePOST /admin/users/role/createThis creates a new role
createServerTypePOST /admin/server_types/createThis creates a new server type
createServerTypeEngineRunningPOST /admin/server_types/running_engine/createThis creates a new server_type_engine_running
createServicePOST /admin/service/createThis API creates a new service definition.
createTokenPOST /admin/tokens/createThis creates a new token
createUserPOST /admin/users/createThis creates a new user
deleteApplicationPOST /admin/applications/{ApplicationID}/deleteThis deletes an application
deleteLicenseDELETE /admin/licenses/{LicenseID}/deleteThis deletes a license from aiWARE
deleteOrganizationPOST /admin/organization/{OrganizationID}/deleteThis deletes the specified organization
deleteResourcePOST /admin/resource/{ResourceID}/deleteThis deletes the specified resource
deleteRolePOST /admin/users/role/{RoleID}/deleteThis deletes a role
deleteServerTypeDELETE /admin/server_type/{ServerTypeID}/deleteThis API deletes the specified server type
deleteServerTypePostPOST /admin/server_type/{ServerTypeID}/deleteThis API deletes the specified server type
deleteServerTypeRunningEngineDELETE /admin/server_type/{ServerTypeID}/engine/{EngineID}/deleteThis API deletes the running engine for a server type
deleteServicePOST /admin/services/{ServiceID}/deleteThis API deletes a specific service
deleteTokenPOST /admin/token/{TokenID}/deleteThis deletes a token
deleteUserPOST /admin/user/{UserID}/deleteThis deletes a user
desiredserversServerTypePOST /admin/server_type/{ServerTypeID}/desiredThis API add servers to the specified server type
getAdminApplicationDetailGET /admin/application/{ApplicationID}/detailThis provides information on the given application.
getAdminCoreDetailGET /admin/core/{CoreID}/detailThis provides information on the given core.
getAdminCoresGET /admin/coresThis provides a list of core systems
getAdminEngineConfigSectionKeyGET /admin/engine/{EngineID}/config/{ConfigSection}/{ConfigKey}This provides a config section key for the engine
getAdminOrganizationDetailGET /admin/organization/{OrganizationID}/detailThis gets organization detail by ID
getAdminOrganizationTokensGET /admin/organization/{OrganizationID}/tokensThis provides information on the given organization tokens.
getAdminOrganizationsGET /admin/organizationsThis provides a list of organizations
getAdminPermissionDetailGET /admin/users/permission/{PermissionID}/detailThis gets permission detail by ID
getAdminRoleDetailGET /admin/users/role/{RoleID}/detailThis gets role detail by ID
getAdminServiceConfigGET /admin/service/{ServiceID}/configThis provides all the config for the service
getAdminServiceConfigSectionGET /admin/service/{ServiceID}/config/{ConfigSection}This provides all the config for the service
getAdminServiceConfigSectionKeyGET /admin/service/{ServiceID}/config/{ConfigSection}/{ConfigKey}This provides a config section key for the service
getAdminServiceInstancesGET /admin/service/instancesThis lists the service instances available for a system
getAdminServiceInstancesByServiceIDGET /admin/service/{ServiceID}/instancesThis lists the service instances available by service ID
getAdminStatusGET /admin/statusThis provides information on the status of the aiWARE edge
getAdminTokenDetailGET /admin/token/{TokenID}/detailGet the token info by ID
getAdminTokenPermissionsGET /admin/token/{TokenID}/permissionsThis provides a list of all token permissions for a token by TokenID
getAdminTokensGET /admin/tokensThis provides information about all tokens.
getAdminUserDetailGET /admin/user/{UserID}/detailThis provides information on the given user.
getAdminUserPermissionsGET /admin/user/{UserID}/permissionsThis provides a list of all user permissions for an user by UserID
getAdminUserTokensGET /admin/user/{UserID}/tokensThis provides information on the given user.
getAdminUsersGET /admin/usersThis provides a list of users in the system
getAdminUsersPermissionGET /admin/users/permissionsThis provides a list of all user permissions in the system
getAdminUsersRolesGET /admin/users/rolesThis provides a list of user role in the system
getApplicationsGET /admin/applicationsGet the list of applications deployed and available on aiWARE
getBacklogSummaryGET /admin/backlog/summaryThis provides summary information on the current backlog
getConfigGET /admin/configThis provides all the config for the cluster
getConfigSectionGET /admin/config/{ConfigSection}This provides all the config for the cluster
getConfigSectionKeyGET /admin/config/{ConfigSection}/{ConfigKey}This provides a config section key for the cluster
getEnginesForResourceGET /admin/resource/{ResourceID}/enginesGet list of engines for resource
getLicenseDetailGET /admin/licenses/{LicenseID}/detailThis gets detail on a license key
getLicensesGET /admin/licensesThis provides a licenses on the system
getMappingsForResourceGET /admin/resource/{ResourceID}/mappingsGet list of mappings for resource
getResourceGET /admin/resource/{ResourceID}Get a resource definition
getResourceMappingDetailGET /admin/resource/{ResourceID}/mapping/{ResourceMappingID}/detailGet resource mapping detail
getResourcesGET /admin/resourcesGet the list of resources
getResourcesForEngineGET /admin/engine/{EngineID}/resourcesGet list of resources for engine
getResourcesForHostGET /admin/host/{HostID}/resourcesGet list of resources for host
getResourcesForServiceGET /admin/service/{ServiceID}/resourcesGet list of resources for service
getServerTypeGET /admin/server_type/{ServerTypeID}/detailThis provides detail on the server type
getServerTypeEngineRunningGET /admin/server_types/running_enginesThis lists the running engine with server types
getServerTypeEngineRunningDetailGET /admin/server_type/{ServerTypeID}/engine/{EngineID}/detailThis gets the detail of server type - running engine
getServerTypesGET /admin/server_typesThis lists the server types available on the system
getServiceGET /admin/service/{ServiceID}/detailThis gets the service detail
getServicesGET /admin/servicesThis lists the services available on the system
loginUserPOST /admin/users/loginThis logs a user in if successful
oauthLoginUserPOST /admin/users/oauth2_loginThis logs a user in if successful with OAuth2
registerUserPOST /admin/users/registerThis registers a new user
removeEngineForResourcePOST /admin/resource/{ResourceID}/engine/{EngineID}/deleteThis API removes the engine to the resource
removeserversServerTypePOST /admin/server_type/{ServerTypeID}/removeThis API removes servers from the specified server type
resetAllocTablePOST /admin/backlog/reset-allocThis resets the alloc table
signupInitialUserPOST /admin/users/signup/initialThis registers a new initial user

Next

See Bash API endpoints: Admin updates for all endpoints that start with update.

Additional Technical Documentation Information
Properties
1/28/2025 9:37 PM
1/28/2025 10:24 PM
1/28/2025 10:24 PM
Documentation
Documentation
000006253
Translation Information
English

Powered by