Update Rmq Configuration

Update Rmq Configuration
Modify RMQ

Updates an existing RabbitMQ (RMQ) configuration identified by UUID. Validates connectivity before applying changes.

Request
URI
PUT
https://{server}:9443/api/admin/global/config/rmq/{uuid}
COPY
Path Parameters
string
uuid
Required

The UUID of the RMQ configuration to update

uuid example
f6a7b8c9-d0e1-2345-f123-456789012345
Request Body
RmqUuidPutRequestBody of type(s) application/json
Required 
{
    "data": {
        "items": [
            {
                "config": {
                    "vhost": "/vcd_tenant",
                    "UUID": "f6a7b8c9-d0e1-2345-f123-456789012345",
                    "hosts": [
                        {
                            "host": "rmq.vcd.example.com",
                            "port": "5672",
                            "userName": "admin",
                            "password": "Uk1RUGFzc3dvcmQxMjMh"
                        }
                    ]
                }
            }
        ]
    }
}
object
data
Optional

data

Authentication
This operation uses the following authentication methods.
Responses
200

RMQ configuration updated successfully

Returns RmqGetResponse200 of type(s) application/json 
{
    "data": {
        "items": [
            {
                "section": "rmq",
                "config": {
                    "hosts": [
                        {
                            "host": "rmq.vcd.example.com",
                            "port": "5672",
                            "userName": "admin"
                        }
                    ],
                    "UUID": "f6a7b8c9-d0e1-2345-f123-456789012345"
                }
            }
        ]
    }
}
object
data
Required

data


400

Bad request - validation failed or connection test failed

Returns ErrorResponse of type(s) application/json 
{
    "isSuccess": false,
    "message": "Unable to connect to RabbitMQ server. Please verify configuration.",
    "httpStatusCode": 400
}
boolean
isSuccess
Required

Indicates if the operation was successful

string
message
Required

Human-readable error message

integer
httpStatusCode
Required

HTTP status code


404

Configuration not found

Returns ErrorResponse of type(s) application/json 
{
    "isSuccess": false,
    "message": "Failed modify item: f6a7b8c9-d0e1-2345-f123-456789012345, section: rmq. Config does not exists.",
    "httpStatusCode": 404
}
boolean
isSuccess
Required

Indicates if the operation was successful

string
message
Required

Human-readable error message

integer
httpStatusCode
Required

HTTP status code


500

Internal server error - update failed

Returns ErrorResponse of type(s) application/json 
{
    "isSuccess": false,
    "message": "Unable to update RMQ configuration",
    "httpStatusCode": 500
}
boolean
isSuccess
Required

Indicates if the operation was successful

string
message
Required

Human-readable error message

integer
httpStatusCode
Required

HTTP status code


Code Samples
COPY
                    curl -X PUT -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/api/admin/global/config/rmq/{uuid}
On This Page
Vcd Configuration Operations
GET
Get Vcd Configuration
POST
Add Vcd Configuration
PUT
Update Vcd Configuration
GET
Get Rmq Configuration
POST
Add Rmq Configuration
PUT
Update Rmq Configuration