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
}
}
The response separates active or provisioning databases (in
data.databases) from databases whose provisioning failed (in data.failed_databases). Use Database Status to confirm readiness before ingestion.
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
}
}
Retrying a failed database
A database indata.failed_databases carries diagnostic entries (see the Provisioning issue tab). Fix the reported issue, re-create it with POST /databases, and poll status again before ingesting.
Related Resources
- Create: Create Database
- Inspect: Database Status
- Inspect: Database Stats
- Delete: Delete Database
- Read more: Concepts: Multi-Tenant Support
Authorizations
API key sent as a Bearer token: "Bearer prefix.secret"
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"]
}
Null on success; an object with code and message on failure.
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": "team_docs",
"tenant_id": "acme_corp"
}
Whether the request succeeded.
Example:
true
Was this page helpful?