response = client.databases.list()
const response = await client.databases.list();
curl -X GET 'https://api.hydradb.com/databases' \
-H "Authorization: Bearer <your_api_key>" \
-H "API-Version: 2"
{
"success": true,
"data": {
"databases": ["acme_corp", "my_first_database"],
"failed_databases": [],
"message": "Successfully retrieved database IDs"
},
"error": null,
"meta": {
"request_id": "9d13aef4-02f4-4e73-8c62-4c2601d04f9d",
"latency_ms": 12.3
}
}
{
"success": true,
"data": {
"databases": ["acme_corp"],
"failed_databases": [
{
"database": "staging_import",
"error": "Provisioning failed. Re-create the database to retry."
}
],
"message": "Successfully retrieved database IDs"
},
"error": null,
"meta": {
"request_id": "9d13aef4-02f4-4e73-8c62-4c2601d04f9d",
"latency_ms": 12.3
}
}
{
"success": false,
"data": null,
"error": {
"code": "UNAUTHORIZED",
"message": "Missing, expired, or invalid API key"
},
"meta": {
"request_id": "9d13aef4-02f4-4e73-8c62-4c2601d04f9d",
"latency_ms": 4.8
}
}
Databases
List Databases
List the databases your API key can see, including any that failed to provision.
GET
/
databases
response = client.databases.list()
const response = await client.databases.list();
curl -X GET 'https://api.hydradb.com/databases' \
-H "Authorization: Bearer <your_api_key>" \
-H "API-Version: 2"
{
"success": true,
"data": {
"databases": ["acme_corp", "my_first_database"],
"failed_databases": [],
"message": "Successfully retrieved database IDs"
},
"error": null,
"meta": {
"request_id": "9d13aef4-02f4-4e73-8c62-4c2601d04f9d",
"latency_ms": 12.3
}
}
{
"success": true,
"data": {
"databases": ["acme_corp"],
"failed_databases": [
{
"database": "staging_import",
"error": "Provisioning failed. Re-create the database to retry."
}
],
"message": "Successfully retrieved database IDs"
},
"error": null,
"meta": {
"request_id": "9d13aef4-02f4-4e73-8c62-4c2601d04f9d",
"latency_ms": 12.3
}
}
{
"success": false,
"data": null,
"error": {
"code": "UNAUTHORIZED",
"message": "Missing, expired, or invalid API key"
},
"meta": {
"request_id": "9d13aef4-02f4-4e73-8c62-4c2601d04f9d",
"latency_ms": 4.8
}
}
Lists the databases your API key can see. Active and provisioning databases are in
Failed provisioning: A database in
data.databases; databases whose provisioning failed are in data.failed_databases. A listed database is not necessarily ready: confirm with Database Status before you ingest.
response = client.databases.list()
const response = await client.databases.list();
curl -X GET 'https://api.hydradb.com/databases' \
-H "Authorization: Bearer <your_api_key>" \
-H "API-Version: 2"
{
"success": true,
"data": {
"databases": ["acme_corp", "my_first_database"],
"failed_databases": [],
"message": "Successfully retrieved database IDs"
},
"error": null,
"meta": {
"request_id": "9d13aef4-02f4-4e73-8c62-4c2601d04f9d",
"latency_ms": 12.3
}
}
{
"success": true,
"data": {
"databases": ["acme_corp"],
"failed_databases": [
{
"database": "staging_import",
"error": "Provisioning failed. Re-create the database to retry."
}
],
"message": "Successfully retrieved database IDs"
},
"error": null,
"meta": {
"request_id": "9d13aef4-02f4-4e73-8c62-4c2601d04f9d",
"latency_ms": 12.3
}
}
{
"success": false,
"data": null,
"error": {
"code": "UNAUTHORIZED",
"message": "Missing, expired, or invalid API key"
},
"meta": {
"request_id": "9d13aef4-02f4-4e73-8c62-4c2601d04f9d",
"latency_ms": 4.8
}
}
data.failed_databases carries diagnostic entries (see the Provisioning issue tab). Fix the reported issue, re-create the database with POST /databases, and poll status again before ingesting.
Related resources
- Before this: Create Database: create or re-create a database
- After this: Database Status: check provisioning readiness
- Related: Database Stats: row counts for one database
- Related: Delete Database: remove a database
- Guide: Databases and Collections
Authorizations
Send your API key as Authorization: Bearer <your_api_key>.
Response
OK
Show child attributes
Show child attributes
Example:
{
"databases": ["acme_corp", "research_kb"],
"failed_databases": [
{
"database": "acme_corp",
"error": "",
"tenant_id": "tenant_1234"
}
],
"failed_tenant_ids": [
{
"database": "acme_corp",
"error": "",
"tenant_id": "tenant_1234"
}
],
"message": "Success",
"tenant_ids": ["tenant_1234", "tenant_5678"]
}
Error details on failure, or null on success.
Show child attributes
Show child attributes
Example:
null
Show child attributes
Show child attributes
Example:
{
"collection": "team_docs",
"database": "acme_corp",
"latency_ms": 12.3,
"request_id": "9d13aef4-02f4-4e73-8c62-4c2601d04f9d",
"source_type": "file",
"sub_tenant_id": "sub_tenant_4567",
"tenant_id": "tenant_1234",
"warnings": [
{
"code": "acl_ignored_by_connector_enforcement",
"message": "This connector enforces ACL, so the request's acl was ignored."
}
]
}
Whether the request succeeded.
Example:
true
Was this page helpful?