Create a Broker Service
post
/api/broker/Services
Creates a new broker service.
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
ApplicationConfig: array
ApplicationConfig
Array of JSON objects having all the configuration values for the service
-
ClusterID: integer
Cluster ID specified for redundancyExample:
0
-
FailoverType: integer
Failover Type ID Allowed Values: - 0 => Standalone - 1 => Primary - 2 => BackupExample:
0
-
PackageName: string
The package name.Example:
presentation-app
-
PrimaryServiceID: integer
Primary Service ID specified for failoverExample:
0
-
Privileged:
Whether the process should run as a privileged user Allowed Values: - 0 => No - 1 => Yes type: integerExample:
0
-
ServerID: integer
Server ID specified for Service associationExample:
1
-
ServiceArguments: string
Optional Service program argumentsExample:
--ssl-ca=/ssl/BundleCA.crt
-
ServiceDescription: string
Optional Service human-readable descriptionExample:
This is an example description
-
ServiceName: string
Service reference NameExample:
Data backup
-
ServiceProgram: string
Service program file location & name relative to the Assure1 install directory.Example:
/opt/assure1
-
StatusID: integer
Status ID Allowed Values: - 0 => Disabled - 1 => EnabledExample:
0
Nested Schema : ApplicationConfig
Type:
array
Array of JSON objects having all the configuration values for the service
Show Source
Nested Schema : items
Type:
Show Source
object
-
BrokerApplicationConfigName: string
Name of the configuration option.Example:
LogLevel
-
BrokerApplicationConfigTypeID: integer
Broker Application Config Type IDExample:
1
-
BrokerApplicationConfigValue: string
The value saved for the configuration optionExample:
Error
-
Required: boolean
Indicates if the config value can be left blankExample:
0
Response
Supported Media Types
- application/json
200 Response
Successful operation
Nested Schema : SuccessfulAddOperation
Type:
Show Source
object
-
message: string
The response message.Example:
Added record
-
success: boolean
Whether the operation was a success (true) or a failure (false).Example:
true
Nested Schema : brokerServicesRead
Type:
Show Source
object
-
ApplicationConfig: array
ApplicationConfig
Array of JSON objects having all the configuration values for the service
-
BrokerServiceID: integer
The service ID.Example:
1
-
ClusterID: integer
Cluster ID specified for redundancyExample:
0
-
Decouple: boolean
Allows for different combinations of primary/backup service pairings or pairing services across servers that are not tied togetherExample:
1
-
FailoverType: integer
Failover Type ID Allowed Values: - 0 => Standalone - 1 => Primary - 2 => BackupExample:
0
-
FailoverTypeName: string
The failover type name.Example:
Standalone
-
Last PID: integer
Last Process ID of the running serviceExample:
4404
-
PackageName: string
The package name.Example:
presentation-app
-
PrimaryServerID: integer
DatabaseID identifying the primary server of the given server type (presentation, collection, database) in the Assure1.Servers tableExample:
1
-
PrimaryServiceID: integer
Primary Service ID specified for failoverExample:
0
-
PrimaryServiceServerID: integer
ServerID of the server primarily responsible for the serviceExample:
1
-
Privileged: integer
Whether the process should run as a privileged user Allowed Values: - 0 => No - 1 => YesExample:
0
-
ServerID: integer
The server ID the service belongs to.Example:
1
-
ServerName: string
The server name.Example:
pgbox.server.com
-
ServiceArguments: string
The optional service arguments.Example:
--ssl-ca=/ssl/BundleCA.crt
-
ServiceDescription: string
Optional Service human-readable descriptionExample:
This is an example description
-
ServiceName: string
Service reference NameExample:
Data backup
-
ServiceProgram: string
Service program file location & name relative to the Assure1 install directory.Example:
/opt/assure1
-
State: string
Indicator of the service stateExample:
Running
-
StateIcon: string
Icon for representing the Service state.Example:
OrbGreenUp.png
-
Status: string
Status based on StatusID. - If StatusID is 0, Status will be "Disabled" - If StatusID is 1, Status will be "Enabled"Example:
Disabled
-
StatusIcon: string
Status image name based on StatusID. - If StatusID is 0, StatusIcon will be "OrbRed.png" - If StatusID is 1, StatusIcon will be "OrbGreen.png"Example:
OrbRed.png
-
StatusID: integer
Status ID Allowed Values: - 0 => Disabled - 1 => EnabledExample:
0
Nested Schema : ApplicationConfig
Type:
array
Array of JSON objects having all the configuration values for the service
Show Source
Nested Schema : items
Type:
Show Source
object
-
BrokerApplicationConfigName: string
Name of the configuration option.Example:
LogLevel
-
BrokerApplicationConfigTypeID: integer
Broker Application Config Type IDExample:
1
-
BrokerApplicationConfigValue: string
The value saved for the configuration optionExample:
Error
-
Required: boolean
Indicates if the config value can be left blankExample:
0
Default Response
Failed operation
Root Schema : schema
Type:
Show Source
object
-
errors: array
errors
The list of errors reported. Validation errors will be keyed by record field.
-
message: string
The response message.Example:
Exception thrown
-
success: boolean
Whether the operation was a success (true) or a failure (false).Example:
false
Nested Schema : errors
Type:
array
The list of errors reported. Validation errors will be keyed by record field.
Show Source
Nested Schema : items
Type:
object