Menu
Amazon MQ
REST API Reference

Broker Reboot

To apply a new configuration to a broker, you can reboot the broker. In addition, if your broker becomes unresponsive, you can reboot it to recover from a faulty state.

Note

You can reboot only a broker with the RUNNING status.

URI

/v1/brokers/broker-id/reboot

HTTP Methods

POST

Reboots a broker.

Note

This API is asynchronous.

Path

Name Type Description

broker-id

string

The unique ID that Amazon MQ generates for the broker.

Response

Status Code Schema Description

200

None

HTTP Status Code 200: OK.

Errors

Errors

Status Code Schema Description

400

Error

HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.

404

Error

HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.

404

Error

HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.

500

Error

HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.

Schemas

Response Schemas

Example Error

{
    "errorAttribute": "TheAttributeWhichCausedTheError",
    "message": "This is the description of the error and the steps to resolve the issue."
}

Attributes

Error

Attribute Type Description

errorAttribute

string

The attribute which caused the error.

message

string

The explanation of the error.