# List Relational databases

> Source: https://truto.one/docs/api-reference/unified-cloud-infrastructure-api/relationaldatabases/list/

`GET /unified/cloud-infrastructure/relational_databases`

Resource: **RelationalDatabases** · API: **Unified Cloud Infrastructure API**

## Supported integrations

Amazon Web Services

## Query parameters

- **`integrated_account_id`** _(string, required)_
  The ID of the integrated account to use for the request.
- **`truto_response_format`** _(string)_
  The format of the response. - `unified` returns the response with unified mappings applied. - `raw` returns the unprocessed, raw response from the remote API. - `normalized` applies the unified mappings and returns the data in a normalized format. - `stream` returns the response as a stream, which is ideal for transmitting large datasets, files, or binary data. Using streaming mode helps to efficiently handle large payloads or real-time data flows without requiring the entire data to be buffered in memory. - `debug` returns the final unified result alongside raw remote fetch information. The response is an envelope containing `result` (identical to unified mode output) and `debug` (with `requestUrl`, `requestOptions`, `data`, `responseHeaders`, and for list operations: `nextCursor`, `isLooping`, `isEmptyResult`, `resultCount`). When the upstream body exceeds 1 MiB, `data` is replaced by `{ truto_truncated: true, truto_max_bytes, truto_excerpt }`. `debug` is `null` for static responses or when `truto_skip_api_call=true`. Defaults to `unified`.
  Allowed: `unified`, `raw`, `normalized`, `stream`, `debug`
- **`truto_key_by`** _(string)_
  By default the `result` attribute is an array of objects. This parameter allows you to specify a field in each `result` objects to use as key, which transforms the `result` array into an object with the array items keyed by the field. This is useful for when you want to use the result as a lookup table.
- **`truto_ignore_limit`** _(boolean)_
  Ignores the `limit` query parameter.
- **`truto_ignore_remote_data`** _(boolean)_
  Excludes the `remote_data` attribute from the response.
- **`truto_exclude_fields`** _(array<string>)_
  Array of fields to exclude from the response.
- **`remote_query`** _(object)_
  Query parameters to pass to the underlying API without any transformations. Refer [this guide](https://truto.one/docs/api-reference/overview/querying#remote-query-parameters) to see how to structure the query parameters.
- **`topology`** _(string)_
  Which RDS API to read. 'instance' (default) calls DescribeDBInstances, 'cluster' calls DescribeDBClusters. BOTH must be called for a complete inventory - neither returns the other's rows, and for Aurora the security posture lives on the cluster, not the instance. Instances that belong to a cluster are suppressed on the instance route to avoid double counting.
  Allowed: `cluster`, `instance`, `unknown`
- **`region`** _(string)_
  AWS region to read. One call reads one region; the caller drives any multi-region loop.

## Response body

- **`result`** _(array<object>)_
  List of Relational databases
  - **`id`** _(string, required)_
    Truto's stable unified identifier for this object. Opaque; use provider_ref to address the object in the provider's own console or API.
  - **`provider_ref`** _(string, required)_
    The provider's own unbroken identifier, passed through verbatim -- a full ARN, resource id or self-link. Never truncated, prefixed or normalised. This is the customer-facing key used to find the object in the console.
  - **`provider`** _(string, required)_
    Which cloud this object was read from.
    Allowed: `aws`, `azure`, `gcp`
  - **`account_ref`** _(string, required)_
    The account, subscription or project the object belongs to. An object with no account cannot be attributed to an environment, so this is always present for objects that live inside an account.
  - **`region`** _(string)_
    Where the object is. A compliance answer in its own right, not metadata. The literal string 'global' is emitted for genuinely global resources (for example IAM, or a GCP VPC network) rather than guessing a region. Never invented: where the provider does not return a location and none can be derived, the collector's queried region is used and that substitution is recorded in unreadable_fields.
  - **`native_type`** _(string, required)_
    The provider's own type string, unmodified -- for example 'AWS::S3::Bucket', 'aws_iam_role', 'Microsoft.Sql/servers'. Used for display and drill-down.
  - **`tags`** _(object)_
    Key-value pairs exactly as the customer set them: no case folding, no key or value normalisation, no merging of separate provider concepts. Present on every object because tags are the primary input for environment classification. An empty object means the object carries no tags; tags that could not be read are recorded in unreadable_fields instead.
  - **`collected_at`** _(string, required)_
    When Truto actually read this object from the provider, in UTC ISO 8601 with the offset present. Not when the request was made and not a provider timestamp. Drives consumer staleness rules.
  - **`unreadable_fields`** _(array<object>)_
    Per-object list of the fields that could not be read, and why -- the brief section 8.4 answer, chosen over per-field sentinel values. Each entry is an object with 'field' (the property name on this resource), 'reason' (a reason code) and an optional human-readable 'detail'. Reason codes: not_supported_by_provider, not_configured, permission_denied, not_collected, collection_error, partially_collected. An empty array means every property on this object was read successfully. A property absent from this array and null in the payload means the provider genuinely returned no value, which is different from 'we could not look'.
  - **`remote_data`** _(object)_
    Raw data returned from the remote API call.
  - **`db_ref`** _(string, required)_
    The provider's own identifier for the database.
  - **`topology`** _(string, required)_
    Whether this row is a cluster or a standalone instance. A discriminator rather than cosmetic: the two shapes carry different field names for the same posture and a shared parser silently misreads one of them.
    Allowed: `cluster`, `instance`, `unknown`
  - **`engine`** _(string, required)_
    The database engine, as the provider names it.
  - **`engine_version`** _(string)_
    The running engine version -- the input to the end-of-support check.
  - **`engine_lifecycle_support`** _(string)_
    The provider's support status for this engine version, where exposed.
  - **`location`** _(string, required)_
    Where the database sits.
  - **`public_network_access`** _(boolean)_
    Whether the database is reachable from the public network. Note this is the provider's flag, not proven reachability: true does not mean reachable and false does not mean safe, since real exposure also depends on routing.
  - **`allowed_networks`** _(array<object>)_
    Ingress rules that reach this database, as objects carrying the source range or group reference, protocol and port range. On AWS this requires joining out to the network service -- the database API returns only security group ids and a membership status -- and the join is batched per region rather than per database.
  - **`allow_all_ingress`** _(boolean)_
    Whether any allowed network rule permits the whole internet. Called out as its own field because a provider-specific allow-all rule is a common and serious misconfiguration that is easy to lose inside a rule list.
  - **`security_group_refs`** _(array<string>)_
    References to the firewall rule sets attached to this database.
  - **`encryption_at_rest`** _(boolean)_
    Whether storage is encrypted at rest.
  - **`encryption_key_type`** _(string)_
    Who manages the storage encryption key. On AWS the native field cleanly identifies provider-owned keys but deliberately merges provider-managed and customer-managed into one value; splitting them needs a key-service call that is governed by the key policy as well as IAM, so a key whose policy omits Truto's role yields permission_denied rather than a guess.
    Allowed: `provider_managed`, `provider_owned`, `customer_managed`, `none`, `unknown`
  - **`encryption_key_ref`** _(string)_
    Reference to the encryption key.
  - **`storage_encryption_type`** _(string)_
    The provider's own storage encryption type string, verbatim.
  - **`backup_retention_days`** _(integer)_
    How many days of backups are retained.
  - **`point_in_time_recovery`** _(boolean)_
    Whether point-in-time restore is available. No boolean exists on AWS -- it is derived from a non-zero backup retention period and corroborated against the provider's latest restorable time, which stays available in remote_data, because a retention integer on a fresh instance is aspirational while a populated restorable time proves backups exist now.
  - **`latest_restorable_time`** _(string)_
    The most recent point the database could be restored to.
  - **`deletion_protection`** _(boolean)_
    Whether the database is protected against deletion.
  - **`high_availability_mode`** _(string)_
    The resilience topology. Deliberately not a boolean: a single hidden standby, members spanning availability zones, and a cluster with two readable standbys describe genuinely different failure domains that one flag would flatten.
    Allowed: `none`, `single_standby`, `multi_az_cluster`, `multi_region`, `zone_redundant`, `unknown`
  - **`min_tls_version`** _(string)_
    Minimum TLS version the database will accept. Not present on any AWS database shape: it requires per-engine parameter or option group calls, and a true minimum exists only for some engines -- others expose an allow-list or three independent toggles. A parameter never set has no value element at all, so absent is not off, and a parameter group value is not the running value unless it is in sync. Expect unknown for a meaningful share of any real fleet.
  - **`tls_enforced`** _(boolean)_
    Whether TLS is required for connections. Kept separate from min_tls_version, because enforcing TLS is not the same as setting a version floor.
  - **`audit_log_destination_ref`** _(array<string>)_
    Where audit and error logs are delivered. The AWS API returns log TYPE strings only and never a log group reference, so these are string-constructed from the topology -- and the destination is created lazily on first log event, so it may not yet exist.
  - **`replica_locations`** _(array<string>)_
    Regions holding replicas of this database -- one half of the data residency answer. Derived from per-region enumeration with reverse matching, because no single AWS call covers every replication topology: the global-cluster call gives a clean cross-region view for one topology and is used as a cross-check, but three other topologies never appear in it.
  - **`replica_refs`** _(array<string>)_
    References to the replica databases themselves.
  - **`global_cluster_ref`** _(string)_
    The global cluster this database belongs to, where it is part of one.
  - **`is_writer`** _(boolean)_
    Whether this row is the writer of its cluster or global cluster.
- **`next_cursor`** _(string)_
  The cursor to use for the next page of results. Pass this value as `next_cursor` in the query parameter in the next request to get the next page of results.
- **`debug`** _(object)_
  Present only when `truto_response_format=debug`. Contains raw fetch details: `requestUrl`, `requestOptions`, `data`, `responseHeaders`, `nextCursor`, `isLooping`, `isEmptyResult`, `resultCount`. `data` is the parsed upstream body; when its JSON form exceeds 1 MiB it is replaced by `{ truto_truncated: true, truto_max_bytes, truto_excerpt }`, where `truto_excerpt` is the leading bytes of that body. The same applies to a string `requestOptions.body`. `null` for static responses or when `truto_skip_api_call=true`.
  - **`requestUrl`** _(string)_
  - **`requestOptions`** _(object)_
  - **`data`** _(unknown)_
  - **`responseHeaders`** _(object)_
  - **`nextCursor`** _(string)_
  - **`isLooping`** _(boolean)_
  - **`isEmptyResult`** _(boolean)_
  - **`resultCount`** _(number)_

## Code examples

### Truto CLI

```bash
truto unified cloud-infrastructure relationaldatabases \
  -a '<integrated_account_id>' \
  -o json
```

### Truto TS SDK

```typescript
import Truto from '@truto/truto-ts-sdk';

const truto = new Truto({
  token: '<your_api_token>',
});

const result = await truto.unifiedApi.list(
  'cloud-infrastructure',
  'relationaldatabases',
  { integrated_account_id: '<integrated_account_id>' }
);

console.log(result);
```

### Truto Python SDK

```python
import asyncio
from truto_python_sdk import TrutoApi

truto_api = TrutoApi(token="<your_api_token>")

async def main():
    async for item in truto_api.unified_api.list(
        "cloud-infrastructure",
        "relationaldatabases",
        {"integrated_account_id": "<integrated_account_id>"}
    ):
        print(item)

asyncio.run(main())
```

### curl

```bash
curl -X GET 'https://api.truto.one/unified/cloud-infrastructure/relational_databases?integrated_account_id=<integrated_account_id>' \
  -H 'Authorization: Bearer <your_api_token>' \
  -H 'Content-Type: application/json'
```

### JavaScript

```javascript
const integratedAccountId = '<integrated_account_id>';

const response = await fetch(`https://api.truto.one/unified/cloud-infrastructure/relational_databases?integrated_account_id=${integratedAccountId}`, {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer <your_api_token>',
    'Content-Type': 'application/json',
  },
});

const data = await response.json();
console.log(data);
```

### Python

```python
import requests

url = "https://api.truto.one/unified/cloud-infrastructure/relational_databases"
headers = {
    "Authorization": "Bearer <your_api_token>",
    "Content-Type": "application/json",
}
params = {
    "integrated_account_id": "<integrated_account_id>"
}

response = requests.get(url, headers=headers, params=params)
print(response.json())
```