Jump to

• Request
• Response

Update Server Version

post

/api/broker/Servers/updateServers

Updates the installed version of Unified Assurance on a selected server. You can only update to a higher version.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• servers: array servers
  Array having only one element, which is the url of the selected server for which version update is required.
• version: string
  The new version which is to be applied to the server.

  Example: 6.0.4

{
    "properties":{
        "servers":{
            "description":"Array having only one element, which is the url of the selected server for which version update is required.",
            "required":true,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "version":{
            "description":"The new version which is to be applied to the server.",
            "required":true,
            "type":"string",
            "example":"6.0.4"
        }
    }
}

Nested Schema : servers

Type: array

Array having only one element, which is the url of the selected server for which version update is required.

Show Source

• Array of: string

{
    "description":"Array having only one element, which is the url of the selected server for which version update is required.",
    "required":true,
    "type":"array",
    "items":{
        "type":"string"
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Match All

Show Source

• object SuccessfulAddOperation
  The response body for a successful add operation.
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SuccessfulAddOperation"
        },
        {
            "type":"object",
            "properties":{
                "data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "message":{
                                "type":"string"
                            }
                        },
                        "example":{
                            "message":"update started"
                        }
                    }
                }
            }
        }
    ]
}

Nested Schema : SuccessfulAddOperation

Type: object

The response body for a successful add operation.

Show Source

• message: string
  The response message.

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

  Example: true

{
    "description":"The response body for a successful add 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":"Added record"
        }
    },
    "type":"object"
}

Nested Schema : type

Type: object

Show Source

• data: array data

{
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "message":{
                        "type":"string"
                    }
                },
                "example":{
                    "message":"update started"
                }
            }
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "message":{
                "type":"string"
            }
        },
        "example":{
            "message":"update started"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• message: string

{
    "type":"object",
    "properties":{
        "message":{
            "type":"string"
        }
    },
    "example":{
        "message":"update started"
    }
}

Example:

{
    "message":"update started"
}

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