Settings Management APIs

  1. Update System Settings

    • Endpoint: PUT /api/v1/setting

    • Use Case: An admin modifies global or service-specific settings, such as enabling two-factor authentication or adjusting API rate limits. This ensures real-time configuration updates without requiring system downtime.

  2. Retrieve Specific Setting

    • Endpoint: GET /api/v1/setting/{*path}

    • Use Case: A developer fetches the current value of a specific setting to verify configurations before deploying a new feature. This helps maintain consistency across different environments.

  3. Delete a Setting

    • Endpoint: DELETE /api/v1/setting/{*path}

    • Use Case: An admin removes outdated or deprecated settings to maintain a clean and efficient system configuration. This prevents conflicts with new updates and ensures system security.

Last updated