| API | Protocol | Base URL | Docs | Reference | OpenAPI | SDKs |
|---|---|---|---|---|---|---|
| Mysql Classic Protocol | rest | mysql://localhost:3306 | link | — | — | — |
| X Devapi | rest | mysqlx://localhost:33060 | link | — | — | — |
| Connectors And Apis Manual | rest | mysql://localhost:3306 | link | — | — | — |
| Connector Python | rest | mysql://localhost:3306 | link | — | — | — |
| Connector J | rest | jdbc:mysql://localhost:3306 | link | — | — | — |
| Connector Nodejs | rest | mysqlx://localhost:33060 | link | — | — | — |
| Connector Cpp | rest | mysql://localhost:3306 | link | — | — | — |
| Connector Odbc | rest | odbc://localhost:3306 | link | — | — | — |
| C API | rest | mysql://localhost:3306 | link | — | — | — |
Actions (12)
Schemas · 9
- Delete Using FilterDELETE http://<HOST>:<PORT>/<ServiceAlias>/<SchemaAlias>/<ObjectAlias>/?q={FilterClause}
Delete rows from the object that match the REST filter clause.
documented - Get Object DataGET http://<HOST>:<PORT>/<ServiceAlias>/<SchemaAlias>/<ObjectAlias>/
Retrieve data rows from a REST-enabled object (table or view).
documented - Get Object MetadataGET http://<HOST>:<PORT>/<ServiceAlias>/<SchemaAlias>/metadata-catalog/{ObjectAlias}/
Retrieve metadata for a specific REST-enabled database object (table, view or procedure).
documented - Get Schema MetadataGET http://<HOST>:<PORT>/<ServiceAlias>/<SchemaAlias>/metadata-catalog/
Retrieve the list of resources (objects) available within the specified REST-enabled schema.
documented - Get Table Data Using PaginationGET http://<HOST>:<PORT>/<ServiceAlias>/<SchemaAlias>/<ObjectAlias>/?offset={Offset}&limit={Limit}
Retrieve a paginated slice of rows from the REST-enabled object.
documented - Get Table Data Using QueryGET http://<HOST>:<PORT>/<ServiceAlias>/<SchemaAlias>/<ObjectAlias>/?q={FilterClause}
Retrieve data from the object filtered by a REST FilterObject clause.
documented - Get Table Row Using Primary KeyGET http://<HOST>:<PORT>/<ServiceAlias>/<SchemaAlias>/<ObjectAlias>/{KeyValues}
Retrieve a single row from the object by specifying its primary key values.
documented - Insert Table RowPOST http://<HOST>:<PORT>/<ServiceAlias>/<SchemaAlias>/<ObjectAlias>/
Insert a new row into the REST-enabled object.
documented - Update/Insert Table RowPUT http://<HOST>:<PORT>/<ServiceAlias>/<SchemaAlias>/<ObjectAlias>/<KeyValues>
Update an existing row or insert a new row into the REST-enabled object.
documented
Authentication · 3
- Login (MRS Authentication)POST http://<HOST>:<PORT>/<ServiceAlias>/<AuthPath>/login
Authenticate a REST user using the MRS SCRAM-style authentication workflow.
documented - Login (MySQL Internal Authentication)POST http://<HOST>:<PORT>/<ServiceAlias>/<AuthPath>/login
Authenticate a REST user using the MySQL Internal authentication workflow.
documented - Start OAuth LoginGET http://<HOST>:<PORT>/<ServiceAlias>/authentication/login?authApp={provider}
Initiate the OAuth login flow by redirecting the user to the provider’s authentication page.
documented