CLcloudamqp
RabbitMQ Config

List available settings

Changed on

Retrieve a list of all RabbitMQ settings that are exposed to changes

get/config/available_settings

Request

  • Base URL
    https://api.cloudamqp.com/api
  • URL
    https://api.cloudamqp.com/api/config/available_settings
  • Auth
    HTTP basic

Response

Successful response

namestring

Setting name

type'boolean' | 'int' | 'float' | 'symbol' | 'bitstring'

Setting type

descstring

Setting description

version_requirementstring

Minimum RabbitMQ version required

defaultunknown
minnumber

Minimum value (for numeric types)

maxnumber

Maximum value (for numeric types)

valueunknown
validboolean

Whether the current value is valid

unitstring

Unit of measurement for the value when present (e.g. MiB)

scalenumber

Multiplier applied to convert the raw value into unit

requiredboolean

Whether the setting is required

Example response

[
  {
    "name": "ra.wal_max_size_bytes",
    "type": "int",
    "desc": "Maximum size in MiB of the Raft write-ahead log kept in memory before it is rolled over to disk. The default is chosen automatically based on your plan's memory. On plan changes, this resets to the new plan's default, unless your current value is already lower, in which case it's preserved. RabbitMQ restart required.",
    "default": 512,
    "min": 16,
    "max": 512,
    "value": 67108864,
    "valid": true,
    "unit": "MiB",
    "scale": 1048576,
    "required": true
  }
]

Changes

  • 462af002e0feRevision changes
    • warning

      added the new bitstring enum value to the / response property for the response status