Jump to

• Request
• Response

Reload Service Configuration

get

/api/broker/Services/executeReloadConfig

Reload the configuration of the service that matches the specified ID. Not all services support reloading configurations. In general, you can only reload configurations for daemon services, where the program name ends in d, such as the Event Email Aggregator service, which uses the Emaild program. See the documentation for each application in Unified Assurance Implementation Guide.

Request

Query Parameters

• id: integer
  The ID of the broker service to reload configurations for.

  Example:

  15

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Match All

Show Source

• object SuccessfulGetOperation
  The response body for a successful get operation.
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SuccessfulGetOperation"
        },
        {
            "type":"object",
            "properties":{
                "data":{
                    "type":"object",
                    "additionalProperties":{
                        "type":"string",
                        "description":"Uses the format \"ServerName/ServiceName\" as the property or key and status of the service or process as the value."
                    },
                    "example":{
                        "server.com/testServiceName":"App Config reload acknowledged"
                    }
                }
            }
        }
    ]
}

Nested Schema : SuccessfulGetOperation

Type: object

The response body for a successful get operation.

Show Source

• message: string
  The response message.

  Example: Loaded 1 entries
• success: boolean
  Whether the operation was a success (true) or a failure (false).

  Example: true

{
    "description":"The response body for a successful get operation.",
    "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":"Loaded 1 entries"
        }
    },
    "type":"object"
}

Nested Schema : type

Type: object

Show Source

• data: object data
  Additional Properties Allowed: additionalProperties

{
    "type":"object",
    "properties":{
        "data":{
            "type":"object",
            "additionalProperties":{
                "type":"string",
                "description":"Uses the format \"ServerName/ServiceName\" as the property or key and status of the service or process as the value."
            },
            "example":{
                "server.com/testServiceName":"App Config reload acknowledged"
            }
        }
    }
}

Nested Schema : data

Type: object

Additional Properties Allowed

Show Source

• string
  Uses the format "ServerName/ServiceName" as the property or key and status of the service or process as the value.

{
    "type":"object",
    "additionalProperties":{
        "type":"string",
        "description":"Uses the format \"ServerName/ServiceName\" as the property or key and status of the service or process as the value."
    },
    "example":{
        "server.com/testServiceName":"App Config reload acknowledged"
    }
}

Example:

{
    "server.com/testServiceName":"App Config reload acknowledged"
}

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":{
                "description":"An error.",
                "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
  An error.

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

Nested Schema : items

Type: object

An error.

Back to Top