> For the complete documentation index, see [llms.txt](https://mariadb.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://mariadb.com/docs/maxscale/reference/maxscale-rest-api.md).

# MaxScale REST API

- [MaxScale Admin User Resource](https://mariadb.com/docs/maxscale/reference/maxscale-rest-api/maxscale-admin-user-resource.md): Manage administrative access to MaxScale. Learn to create, update, and delete admin users and manage their credentials for the REST API and MaxCtrl.
- [MaxScale Filter Resource](https://mariadb.com/docs/maxscale/reference/maxscale-rest-api/maxscale-filter-resource.md): Configure database traffic filters programmatically. This resource enables you to retrieve, create, and modify filter instances and their runtime parameters.
- [MaxScale Listener Resource](https://mariadb.com/docs/maxscale/reference/maxscale-rest-api/maxscale-listener-resource.md): Manage network listeners via the REST API. Use this resource to define ports, protocols, and service associations for handling incoming client connections.
- [MaxScale MaxScale Resource](https://mariadb.com/docs/maxscale/reference/maxscale-rest-api/maxscale-maxscale-resource.md): Retrieve global instance details. Access version information, manage global configuration parameters, and monitor the logging status of your MaxScale instance.
- [MaxScale Monitor Resource](https://mariadb.com/docs/maxscale/reference/maxscale-rest-api/maxscale-monitor-resource.md): Control server monitoring modules. This resource allows you to configure monitors, check cluster health status, and modify monitoring parameters dynamically.
- [MaxScale Object Resource](https://mariadb.com/docs/maxscale/reference/maxscale-rest-api/maxscale-object-resource.md): Interact with generic MaxScale objects. This endpoint provides a unified interface for retrieving and managing configuration objects across the instance.
- [MaxScale REST API](https://mariadb.com/docs/maxscale/reference/maxscale-rest-api/maxscale-rest-api.md): Understand the fundamentals of the MaxScale REST API. This guide details API versioning, JSON Web Token authentication, and the standard JSON response format.
- [MaxScale Role Resource](https://mariadb.com/docs/maxscale/reference/maxscale-rest-api/maxscale-role-resource.md): Define and assign access roles. This resource allows you to manage permissions for MaxScale administrative users, controlling their access to API resources.
- [MaxScale Server Resource](https://mariadb.com/docs/maxscale/reference/maxscale-rest-api/maxscale-server-resource.md): Administer backend database servers. Use this resource to add, remove, or modify server definitions and view their current runtime state and statistics.
- [MaxScale Service Resource](https://mariadb.com/docs/maxscale/reference/maxscale-rest-api/maxscale-service-resource.md): Configure routing services. This resource manages the core services that define how MaxScale routes and balances traffic between clients and backend servers.
- [MaxScale Session Resource](https://mariadb.com/docs/maxscale/reference/maxscale-rest-api/maxscale-session-resource.md): Inspect and manage active client sessions. This resource allows you to view connected clients, check session details, and terminate specific connections.
- [MaxScale SQL Resource](https://mariadb.com/docs/maxscale/reference/maxscale-rest-api/maxscale-sql-resource.md): Execute SQL statements via the API. This resource provides an interface for running queries against backend servers or ODBC targets directly over HTTP.
