app-settings

← All modules

2 endpoints.

GET /api/v1/app-settings

List App Settings

Every tab this site has, with its current (secret-masked) values.

200 — Successful Response

{}

---

PUT /api/v1/app-settings/{slug}

Update App Settings

Parameters

Name	In	Required	Type	Description
slug	path	yes	string

Request body

{
  "properties": {
    "values": {
      "additionalProperties": true,
      "type": "object",
      "title": "Values"
    }
  },
  "type": "object",
  "required": [
    "values"
  ],
  "title": "AppSettingsIn",
  "description": "A flat ``{field_key: value}`` patch. Keys the registry doesn't declare are\ndropped by ``apply_update`` rather than rejected — a client sending a field\nthat was removed from the registry should not get a 422 for it."
}

200 — Successful Response

{}

422 — Validation Error

{
  "properties": {
    "detail": {
      "items": {
        "properties": {
          "loc": {
            "items": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "integer"
                }
              ]
            },
            "type": "array",
            "title": "Location"
          },
          "msg": {
            "type": "string",
            "title": "Message"
          },
          "type": {
            "type": "string",
            "title": "Error Type"
          }
        },
        "type": "object",
        "required": [
          "loc",
          "msg",
          "type"
        ],
        "title": "ValidationError"
      },
      "type": "array",
      "title": "Detail"
    }
  },
  "type": "object",
  "title": "HTTPValidationError"
}