Skip to main content

ConfigurationListResponse

Response for listing all configurations grouped by category.

categories object[]required
  • Array [
    • keyKey (string)required
    nameName (string)required
    descriptionDescription (string)required
    orderOrder (integer)required
  • ]
    • configurations objectrequired
    property name* object[]
  • Array [
    • keyKey (string)required
    nameName (string)required
    descriptionDescription (string)required
    categoryCategory (string)required
    value_typeValue Type (string)required
    value object
    anyOf
    sourceSource (string)required
    requires_restartRequires Restart (boolean)required
    is_sensitiveIs Sensitive (boolean)required
    is_readonlyIs Readonly (boolean)required
    is_write_onlyIs Write Only (boolean)required
    allow_emptyAllow Empty (boolean)
    Default value: false
    validation_rules objectrequired
    property name*any
    updated_at object
    anyOf
    string
    error object
    anyOf
    string
  • ]
    • ConfigurationListResponse
    {
      "categories": [
        {
          "key": "string",
          "name": "string",
          "description": "string",
          "order": 0
        }
      ],
      "configurations": {}
    }