# PmaControl

> PmaControl is a MariaDB / MySQL observability and operations platform for DBAs and operations teams, covering ProxySQL and Galera alongside database servers.

This website publishes public product documentation and a read-only discovery API. Customer infrastructure is accessed through a separately administered PmaControl installation. Public discovery never returns customer database metrics or credentials.

## PmaControl developer resources

- [PmaControl developer portal](https://www.pmacontrol.com/developers): Quickstart, authentication boundaries and API reference.
- [PmaControl OpenAPI specification](https://www.pmacontrol.com/openapi.json): Machine-readable contract for the public discovery API.
- [PmaControl API capabilities](https://www.pmacontrol.com/api/v1/capabilities): Anonymous product and API metadata.
- [PmaControl API permissions](https://www.pmacontrol.com/api/v1/permissions): Public permissions and deployment-dependent installation grants; no OAuth server advertised.
- [PmaControl documentation](https://www.pmacontrol.com/en/site/documentation/): Installation, monitoring, replication, backup, security and integrations.
- [PmaControl sitemap](https://www.pmacontrol.com/sitemap.xml): Indexable website pages.

- [PmaControl free sandbox](https://www.pmacontrol.com/api/v1/sandbox/servers): Fixed synthetic MariaDB / MySQL metrics, read-only and keyless; no production data or authentication simulation.

- [PmaControl function definitions](https://www.pmacontrol.com/functions.json): Strict Responses function definitions generated from OpenAPI. Execute the matching GET operationId yourself; omit null optional query arguments.

## Product and contact

- [PmaControl homepage](https://www.pmacontrol.com/): Product overview; request Accept: text/markdown for Markdown.
- [PmaControl plans](https://www.pmacontrol.com/en/site/offers/): Current deployment plans.
- [PmaControl Pro trial](https://www.pmacontrol.com/en/site/trial/): Existing three-month evaluation, email verification and installation UUID required.
- [PmaControl contact](https://www.pmacontrol.com/en/site/contact/): Product and support enquiries.

- [About PmaControl](https://www.pmacontrol.com/about): Product, team and contact details.
- [PmaControl privacy](https://www.pmacontrol.com/privacy): Public-site data handling and privacy enquiries.

## When to use PmaControl

- [Investigate MariaDB / MySQL performance](https://www.pmacontrol.com/en/site/doc/digest/): Use PmaControl to examine slow query digests, execution plans and performance metrics on an authorized installation. Start with read-only evidence; never infer a production diagnosis from the public discovery API.
- [Understand replication and topology](https://www.pmacontrol.com/en/site/doc/dot3/): Use PmaControl to inspect server relationships, replication and Galera topology before proposing recovery or routing changes.
- [Plan monitoring and incident response](https://www.pmacontrol.com/en/site/doc/monitoring/): Use PmaControl when a DBA or operations team needs database observability, contextual alerts and documented recovery procedures.
- [Find an integration entry point](https://www.pmacontrol.com/openapi.json): Fetch the public schema, call getPmaControlCapabilities, then listPmaControlDocumentation with language set to fr, en, pl, ru, zh or ar. Request only the permissions required on a separately authorized installation.

## Agent calling instructions

- [Start with capabilities](https://www.pmacontrol.com/api/v1/capabilities): Use GET with Accept: application/json. These public operations need no credentials and do not mutate infrastructure.
- [Read permission boundaries](https://www.pmacontrol.com/api/v1/permissions): Public discovery.read grants no customer access. Instance permissions are version-dependent; obtain a tenant-scoped machine credential from that installation's administrator. Never send installation credentials to this website.
- [Handle missing resources](https://www.pmacontrol.com/llms.txt): For website pages use Accept: text/markdown. A missing page returns HTTP 404 and recovery links. API errors use application/problem+json with code, message and resolution; inspect the HTTP status and do not treat an error as valid product data.
- [Choose the right access path](https://www.pmacontrol.com/developers): The public API is for product discovery and documentation. It cannot execute SQL, inspect customer infrastructure, create production keys or issue OAuth tokens. For production operations, use the customer's own approved installation and obtain explicit operator approval before mutations.