# 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, synthetic sandbox OAuth scopes and deployment-dependent installation grants. - [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 or create production keys. Its optional OAuth client_credentials flow grants access only to synthetic sandbox resources. For production operations, use the customer's own approved installation and obtain explicit operator approval before mutations. ## Scoped sandbox authentication - [Register a PmaControl sandbox client](https://www.pmacontrol.com/developers#authentication): RFC 7591 open registration at POST /oauth/register, grant_types=["client_credentials"], response_types=[], scope="sandbox.servers.read". No account, payment or sales contact is required. Client secrets expire after 24 hours. - [PmaControl sandbox token endpoint](https://www.pmacontrol.com/oauth/token): POST application/x-www-form-urlencoded with grant_type=client_credentials and HTTP Basic client_id/client_secret. Request only a subset of the granted sandbox scopes. Tokens expire after at most 600 seconds; no refresh token is issued. - [Authenticated synthetic server metrics](https://www.pmacontrol.com/api/v1/sandbox/authorized-servers): Bearer sandbox.servers.read. Use sandbox.identity.read only for the separate /api/v1/sandbox/identity endpoint. These grants never authorize customer or production operations. - [Official PmaControl CLI](https://www.pmacontrol.com/downloads/cli/release.json): Installable Homebrew tap, source archive and SHA-256; no PyPI or npm publication is claimed. - [PmaControl OAuth authorization-server metadata](https://www.pmacontrol.com/.well-known/oauth-authorization-server): RFC 8414; client_credentials only, no interactive login or OpenID Connect. - [PmaControl protected-resource metadata](https://www.pmacontrol.com/.well-known/oauth-protected-resource): RFC 9728 resource identifier, authorization server and scopes_supported. Follow the resource_metadata URL in Bearer challenges. - [PmaControl machine-readable onboarding](https://www.pmacontrol.com/api/v1/onboarding): Free anonymous sandbox, self-service expiring client credentials, token request parameters, scope boundaries and official Homebrew installation commands. ## API versioning and deprecation - [PmaControl REST lifecycle policy](https://www.pmacontrol.com/developers#api-versioning): /api/v1 is active, contract 1.1.0; breaking REST changes require a new major path. Minimum notice is 90 days except documented urgent security/legal changes. Deprecation uses RFC 9745 Structured Field Date; Sunset uses RFC 8594 HTTP-date. No current retirement date is scheduled. - [Machine-readable versioning policy](https://www.pmacontrol.com/api-policy.json): Current version and lifecycle, notice period and header conventions. Follow the API Link rel=deprecation for migration information. - [Rate-limit conventions](https://www.pmacontrol.com/developers#rate-limits): RateLimit-Policy and RateLimit follow IETF draft-ietf-httpapi-ratelimit-headers-11, with compatibility RateLimit-Limit/Remaining/Reset fields. On 429, Retry-After seconds take precedence.