1Get Tables List
Overview
This API retrieves the list of tables from the specified database using the provided data source connection.
Method: GET
Request URL: {kyvos-url}/rest/v2/connections/{connection-name}/databases/{database-name}/tables
Authorization
API Key: sessionid
This method authenticates requests using a session ID which acts like an API key.
BasicAuth: HTTP Authorization Scheme
This method authenticates requests using a username and password sent in the HTTP Authorization header.
Headers
Header Name | Type | Description | Possible Values |
|---|---|---|---|
sessionid | String | The session ID is the token received from the login API. Note: Session ID is required for token-based authentication. | – |
Path Parameter
Parameter Name | Type | Description | Possible Values |
|---|---|---|---|
connection-name (Required) | String | Name of the data source connection from which the list of tables is to be retrieved. | – |
database-name (Required) | String | Name of the database from which the list of tables is to be retrieved. | – |
Query Parameter
Parameter Name | Type | Description | Possible Values |
|---|---|---|---|
schema | String | Name of the schema from which the list of tables is to be retrieved. | – |
Responses
200 Success
{
"tables": [
"customers",
"orders",
"products",
"employees",
"departments"
]
}Status Code | Description |
|---|---|
401 | Authorization information is missing or invalid. |
404 | No matching record found. |
500 | Internal Server Error |