# Kavita Settings API

**Canonical:** https://apis.io/apis/kavita/kavita-settings-api/  
**Provider:** Kavita — https://apis.io/providers/kavita/  
**Documentation:** https://wiki.kavitareader.com/

Kavita Settings API is one of 48 APIs that [Kavita](https://apis.io/providers/kavita/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Settings. The published artifact set on APIs.io includes an OpenAPI specification.

The Settings API from Kavita — 18 operation(s) for settings.

## Operations (20)

| Method | Path | Summary |
|---|---|---|
| GET | `/api/Settings/base-url` | Returns the base url for this instance (if set) |
| GET | `/api/Settings` | Returns the server settings |
| POST | `/api/Settings` | Update Server settings |
| POST | `/api/Settings/reset` | Create api settings reset |
| POST | `/api/Settings/reset-ip-addresses` | Resets the IP Addresses |
| POST | `/api/Settings/reset-base-url` | Resets the Base url |
| GET | `/api/Settings/is-email-setup` | Is the minimum information setup for Email to work |
| GET | `/api/Settings/task-frequencies` | All values allowed for Task Scheduling APIs. A custom cron job is not included. |
| GET | `/api/Settings/library-types` | Get api settings library types |
| GET | `/api/Settings/log-levels` | Get api settings log levels |
| GET | `/api/Settings/opds-enabled` | Get api settings opds enabled |
| GET | `/api/Settings/is-valid-cron` | Is the cron expression valid for Kavita's scheduler |
| POST | `/api/Settings/test-email-url` | Sends a test email to see if email settings are hooked up correctly |
| GET | `/api/Settings/metadata-settings` | Get the metadata settings for Kavita+ users |
| POST | `/api/Settings/metadata-settings` | Update the metadata settings for Kavita+ Metadata feature |
| POST | `/api/Settings/run-metadata-mappings` | Create api settings run metadata mappings |
| POST | `/api/Settings/import-field-mappings` | Import field mappings |
| GET | `/api/Settings/oidc` | Retrieve publicly required configuration regarding Oidc |
| POST | `/api/Settings/reset-external-ids` | Create api settings reset external ids |
| POST | `/api/Settings/is-valid-authority` | Validate if the given authority is reachable from the server |

## Machine-readable artifacts (1)

- **OpenAPI** — https://artifacts.apis.io/kavita/openapi/kavita-settings-api-openapi.yml

## Other Kavita APIs (12)

- [Kavita API](https://apis.io/apis/kavita/kavita-api/)
- [Kavita Account API](https://apis.io/apis/kavita/kavita-account-api/)
- [Kavita Activity API](https://apis.io/apis/kavita/kavita-activity-api/)
- [Kavita Admin API](https://apis.io/apis/kavita/kavita-admin-api/)
- [Kavita Annotation API](https://apis.io/apis/kavita/kavita-annotation-api/)
- [Kavita Book API](https://apis.io/apis/kavita/kavita-book-api/)
- [Kavita Cbl API](https://apis.io/apis/kavita/kavita-cbl-api/)
- [Kavita Chapter API](https://apis.io/apis/kavita/kavita-chapter-api/)
- [Kavita Collection API](https://apis.io/apis/kavita/kavita-collection-api/)
- [Kavita Color Scape API](https://apis.io/apis/kavita/kavita-colorscape-api/)
- [Kavita Device API](https://apis.io/apis/kavita/kavita-device-api/)
- [Kavita Download API](https://apis.io/apis/kavita/kavita-download-api/)

## Tags

Settings

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/kavita/kavita-settings-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/kavita/.