Salesforce

Go API endpoint: AdminAPI

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

All URIs are relative to https://api.aiware.com/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
UpdateAdminCorePost /admin/core/{CoreID}/updateThis updates a core system
UpdateApplicationPost /admin/applications/{ApplicationID}/updateThis updates an application
UpdateConfigAllPost /admin/configThis gets the config for the cluster
UpdateConfigSectionPost /admin/config/{ConfigSection}This gets the config for the cluster
UpdateConfigSectionKeyPost /admin/config/{ConfigSection}/{ConfigKey}This updates the config for the cluster for a given key
UpdateEnginesForResourcePost /admin/resource/{ResourceID}/engine/updateThis API updates the specified server type-running engine
UpdateOrganizationPost /admin/organization/{OrganizationID}/updateThis updates a organization
UpdatePermissionPost /admin/users/permission/{PermissionID}/updateThis updates a permission
UpdateResourcePost /admin/resource/{ResourceID}/updateThis API updates the specified resource
UpdateResourceMappingPost /admin/resource/{ResourceID}/mapping/{ResourceMappingID}/updateThis API updates the state of the specified resource mapping
UpdateResourceMappingStatePost /admin/resource/{ResourceID}/mapping/{ResourceMappingID}/updatestateThis API updates the state of the specified resource mapping state
UpdateResourceStatePost /admin/resource/{ResourceID}/updatestateThis API updates the state of the specified resource
UpdateRolePost /admin/users/role/{RoleID}/updateThis updates a role
UpdateServerTypePost /admin/server_type/{ServerTypeID}/updateThis API updates the specified server type
UpdateServerTypeEngineRunningPost /admin/server_type/{ServerTypeID}/engine/{EngineID}/updateThis API updates the specified server type-running engine
UpdateServicePost /admin/service/{ServiceID}/updateThis API updates a service.
UpdateTokenPost /admin/token/{TokenID}/updateThis updates a token
UpdateUserPost /admin/user/{UserID}/updateThis updates a user
UpsertServerTypesPost /admin/server_type/upsertThis API creates or updates the specified server types
UserPasswordForgotPost /admin/users/password/forgotThis api will help users to reset their password when they forgot
UserPasswordResetPost /admin/users/password/resetHelps users to reset their password
UserPasswordUpdatePost /admin/users/password/updateThis api will help users to update their password
Additional Technical Documentation Information
Properties
11/21/2024 9:51 PM
11/21/2024 9:52 PM
11/21/2024 9:52 PM
Documentation
Documentation
000005195
Translation Information
English

Powered by