Jump to

• Request
• Response

Update a Broker Service

put

/api/broker/Services/{id}

Updates the properties of a broker service that matches the specified ID.

Request

Path Parameters

• id(required): integer(int32)
  The broker service ID.

  Example:

  1

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• ApplicationConfig: array ApplicationConfig
  Array of JSON objects having all the configuration values for the service
• ClusterID: integer
  Cluster ID specified for redundancy

  Example: 0
• FailoverType: integer
  Failover Type ID Allowed Values: - 0 => Standalone - 1 => Primary - 2 => Backup

  Example: 0
• PackageName: string
  The package name.

  Example: presentation-app
• PrimaryServiceID: integer
  Primary Service ID specified for failover

  Example: 0
• Privileged:
  Whether the process should run as a privileged user Allowed Values: - 0 => No - 1 => Yes type: integer

  Example: 0
• ServerID: integer
  Server ID specified for Service association

  Example: 1
• ServiceArguments: string
  Optional Service program arguments

  Example: --ssl-ca=/ssl/BundleCA.crt
• ServiceDescription: string
  Optional Service human-readable description

  Example: This is an example description
• ServiceName: string
  Service reference Name

  Example: 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 => Enabled

  Example: 0

{
    "properties":{
        "ServerID":{
            "description":"Server ID specified for Service association",
            "type":"integer",
            "example":"1"
        },
        "PackageName":{
            "description":"The package name.",
            "type":"string",
            "example":"presentation-app"
        },
        "ServiceName":{
            "description":"Service reference Name",
            "type":"string",
            "example":"Data backup"
        },
        "ServiceDescription":{
            "description":"Optional Service human-readable description",
            "type":"string",
            "example":"This is an example description"
        },
        "ServiceProgram":{
            "description":"Service program file location & name relative to the Assure1 install directory.",
            "type":"string",
            "example":"/opt/assure1"
        },
        "ServiceArguments":{
            "description":"Optional Service program arguments",
            "type":"string",
            "example":"--ssl-ca=/ssl/BundleCA.crt"
        },
        "FailoverType":{
            "description":"Failover Type ID\nAllowed Values:\n-  0 => Standalone\n-  1 => Primary\n-  2 => Backup",
            "type":"integer",
            "example":"0"
        },
        "PrimaryServiceID":{
            "description":"Primary Service ID specified for failover",
            "type":"integer",
            "example":"0"
        },
        "ClusterID":{
            "description":"Cluster ID specified for redundancy",
            "type":"integer",
            "example":"0"
        },
        "StatusID":{
            "description":"Status ID\nAllowed Values:\n-  0 => Disabled\n-  1 => Enabled",
            "type":"integer",
            "example":"0"
        },
        "Privileged":{
            "description":"Whether the process should run as a privileged user\nAllowed Values:\n- 0 => No\n- 1 => Yes\ntype: integer",
            "example":"0"
        },
        "ApplicationConfig":{
            "description":"Array of JSON objects having all the configuration values for the service",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "Required":{
                        "description":"Indicates if the config value can be left blank",
                        "type":"boolean",
                        "example":0
                    },
                    "BrokerApplicationConfigName":{
                        "description":"Name of the configuration option.",
                        "type":"string",
                        "example":"LogLevel"
                    },
                    "BrokerApplicationConfigValue":{
                        "description":"The value saved for the configuration option",
                        "type":"string",
                        "example":"Error"
                    },
                    "BrokerApplicationConfigTypeID":{
                        "description":"Broker Application Config Type ID",
                        "type":"integer",
                        "example":1
                    }
                }
            }
        }
    },
    "type":"object"
}

Nested Schema : ApplicationConfig

Type: array

Array of JSON objects having all the configuration values for the service

Show Source

• Array of: object items

{
    "description":"Array of JSON objects having all the configuration values for the service",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "Required":{
                "description":"Indicates if the config value can be left blank",
                "type":"boolean",
                "example":0
            },
            "BrokerApplicationConfigName":{
                "description":"Name of the configuration option.",
                "type":"string",
                "example":"LogLevel"
            },
            "BrokerApplicationConfigValue":{
                "description":"The value saved for the configuration option",
                "type":"string",
                "example":"Error"
            },
            "BrokerApplicationConfigTypeID":{
                "description":"Broker Application Config Type ID",
                "type":"integer",
                "example":1
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• BrokerApplicationConfigName: string
  Name of the configuration option.

  Example: LogLevel
• BrokerApplicationConfigTypeID: integer
  Broker Application Config Type ID

  Example: 1
• BrokerApplicationConfigValue: string
  The value saved for the configuration option

  Example: Error
• Required: boolean
  Indicates if the config value can be left blank

  Example: 0

{
    "type":"object",
    "properties":{
        "Required":{
            "description":"Indicates if the config value can be left blank",
            "type":"boolean",
            "example":0
        },
        "BrokerApplicationConfigName":{
            "description":"Name of the configuration option.",
            "type":"string",
            "example":"LogLevel"
        },
        "BrokerApplicationConfigValue":{
            "description":"The value saved for the configuration option",
            "type":"string",
            "example":"Error"
        },
        "BrokerApplicationConfigTypeID":{
            "description":"Broker Application Config Type ID",
            "type":"integer",
            "example":1
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Match All

Show Source

• object SuccessfulUpdateOperation
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SuccessfulUpdateOperation"
        },
        {
            "type":"object",
            "properties":{
                "data":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/brokerServicesRead"
                    }
                }
            }
        }
    ]
}

Nested Schema : SuccessfulUpdateOperation

Type: object

Show Source

• message: string
  The response message.

  Example: Updated record
• success: boolean
  Whether the operation was a success (true) or a failure (false).

  Example: true

{
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"true"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Updated record"
        }
    },
    "type":"object"
}

Nested Schema : type

Type: object

Show Source

• data: array data

{
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/brokerServicesRead"
            }
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object brokerServicesRead

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/brokerServicesRead"
    }
}

Nested Schema : brokerServicesRead

Type: object

Show Source

• 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 redundancy

  Example: 0
• Decouple: boolean
  Allows for different combinations of primary/backup service pairings or pairing services across servers that are not tied together

  Example: 1
• FailoverType: integer
  Failover Type ID Allowed Values: - 0 => Standalone - 1 => Primary - 2 => Backup

  Example: 0
• FailoverTypeName: string
  The failover type name.

  Example: Standalone
• Last PID: integer
  Last Process ID of the running service

  Example: 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 table

  Example: 1
• PrimaryServiceID: integer
  Primary Service ID specified for failover

  Example: 0
• PrimaryServiceServerID: integer
  ServerID of the server primarily responsible for the service

  Example: 1
• Privileged: integer
  Whether the process should run as a privileged user Allowed Values: - 0 => No - 1 => Yes

  Example: 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 description

  Example: This is an example description
• ServiceName: string
  Service reference Name

  Example: Data backup
• ServiceProgram: string
  Service program file location & name relative to the Assure1 install directory.

  Example: /opt/assure1
• State: string
  Indicator of the service state

  Example: 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 => Enabled

  Example: 0

{
    "properties":{
        "BrokerServiceID":{
            "description":"The service ID.",
            "type":"integer",
            "example":"1"
        },
        "ServerID":{
            "description":"The server ID the service belongs to.",
            "type":"integer",
            "example":"1"
        },
        "ServerName":{
            "description":"The server name.",
            "type":"string",
            "example":"pgbox.server.com"
        },
        "PackageName":{
            "description":"The package name.",
            "type":"string",
            "example":"presentation-app"
        },
        "ServiceName":{
            "description":"Service reference Name",
            "type":"string",
            "example":"Data backup"
        },
        "ServiceDescription":{
            "description":"Optional Service human-readable description",
            "type":"string",
            "example":"This is an example description"
        },
        "ServiceProgram":{
            "description":"Service program file location & name relative to the Assure1 install directory.",
            "type":"string",
            "example":"/opt/assure1"
        },
        "ServiceArguments":{
            "description":"The optional service arguments.",
            "type":"string",
            "example":"--ssl-ca=/ssl/BundleCA.crt"
        },
        "FailoverType":{
            "description":"Failover Type ID\n\nAllowed Values:\n-  0 => Standalone\n-  1 => Primary\n-  2 => Backup",
            "type":"integer",
            "example":"0"
        },
        "FailoverTypeName":{
            "description":"The failover type name.",
            "type":"string",
            "example":"Standalone"
        },
        "ClusterID":{
            "description":"Cluster ID specified for redundancy",
            "type":"integer",
            "example":"0"
        },
        "PrimaryServiceID":{
            "description":"Primary Service ID specified for failover",
            "type":"integer",
            "example":"0"
        },
        "StatusID":{
            "description":"Status ID\nAllowed Values:\n-  0 => Disabled\n-  1 => Enabled",
            "type":"integer",
            "example":"0"
        },
        "Status":{
            "description":"Status based on StatusID.\n- If StatusID is 0, Status will be \"Disabled\"\n- If StatusID is 1, Status will be \"Enabled\"",
            "type":"string",
            "example":"Disabled"
        },
        "StatusIcon":{
            "description":"Status image name based on StatusID.\n- If StatusID is 0, StatusIcon will be \"OrbRed.png\"\n- If StatusID is 1, StatusIcon will be \"OrbGreen.png\"",
            "type":"string",
            "example":"OrbRed.png"
        },
        "Privileged":{
            "description":"Whether the process should run as a privileged user\nAllowed Values:\n- 0 => No\n- 1 => Yes",
            "type":"integer",
            "example":"0"
        },
        "Last PID":{
            "description":"Last Process ID of the running service",
            "type":"integer",
            "example":"4404"
        },
        "PrimaryServerID":{
            "description":"DatabaseID identifying the primary server of the given server type (presentation, collection, database) in the Assure1.Servers table",
            "type":"integer",
            "example":"1"
        },
        "PrimaryServiceServerID":{
            "description":"ServerID of the server primarily responsible for the service",
            "type":"integer",
            "example":"1",
            "nullable":true
        },
        "Decouple":{
            "description":"Allows for different combinations of primary/backup service pairings or pairing services across servers that are not tied together",
            "type":"boolean",
            "example":"1"
        },
        "ApplicationConfig":{
            "description":"Array of JSON objects having all the configuration values for the service",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "Required":{
                        "description":"Indicates if the config value can be left blank",
                        "type":"boolean",
                        "example":0
                    },
                    "BrokerApplicationConfigName":{
                        "description":"Name of the configuration option.",
                        "type":"string",
                        "example":"LogLevel"
                    },
                    "BrokerApplicationConfigValue":{
                        "description":"The value saved for the configuration option",
                        "type":"string",
                        "example":"Error"
                    },
                    "BrokerApplicationConfigTypeID":{
                        "description":"Broker Application Config Type ID",
                        "type":"integer",
                        "example":1
                    }
                }
            }
        },
        "State":{
            "description":"Indicator of the service state",
            "type":"string",
            "example":"Running"
        },
        "StateIcon":{
            "description":"Icon for representing the Service state.",
            "type":"string",
            "example":"OrbGreenUp.png"
        }
    },
    "type":"object"
}

Nested Schema : ApplicationConfig

Type: array

Array of JSON objects having all the configuration values for the service

Show Source

• Array of: object items

{
    "description":"Array of JSON objects having all the configuration values for the service",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "Required":{
                "description":"Indicates if the config value can be left blank",
                "type":"boolean",
                "example":0
            },
            "BrokerApplicationConfigName":{
                "description":"Name of the configuration option.",
                "type":"string",
                "example":"LogLevel"
            },
            "BrokerApplicationConfigValue":{
                "description":"The value saved for the configuration option",
                "type":"string",
                "example":"Error"
            },
            "BrokerApplicationConfigTypeID":{
                "description":"Broker Application Config Type ID",
                "type":"integer",
                "example":1
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• BrokerApplicationConfigName: string
  Name of the configuration option.

  Example: LogLevel
• BrokerApplicationConfigTypeID: integer
  Broker Application Config Type ID

  Example: 1
• BrokerApplicationConfigValue: string
  The value saved for the configuration option

  Example: Error
• Required: boolean
  Indicates if the config value can be left blank

  Example: 0

{
    "type":"object",
    "properties":{
        "Required":{
            "description":"Indicates if the config value can be left blank",
            "type":"boolean",
            "example":0
        },
        "BrokerApplicationConfigName":{
            "description":"Name of the configuration option.",
            "type":"string",
            "example":"LogLevel"
        },
        "BrokerApplicationConfigValue":{
            "description":"The value saved for the configuration option",
            "type":"string",
            "example":"Error"
        },
        "BrokerApplicationConfigTypeID":{
            "description":"Broker Application Config Type ID",
            "type":"integer",
            "example":1
        }
    }
}

Default Response

Failed operation

Body ()

Root Schema : schema

Type: object

Show Source

• 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

{
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"false"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Exception thrown"
        },
        "errors":{
            "description":"The list of errors reported. Validation errors will be keyed by record field.",
            "type":"array",
            "items":{
                "type":"object"
            }
        }
    },
    "type":"object"
}

Nested Schema : errors

Type: array

The list of errors reported. Validation errors will be keyed by record field.

Show Source

• Array of: object items

{
    "description":"The list of errors reported. Validation errors will be keyed by record field.",
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

Back to Top