Skip to content
GET /unified/cloud-infrastructure/relational_databases

Query Parameters

Refer Specifying query parameters in Truto APIs

topologystring

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.

Possible values:
clusterinstanceunknown
1 supported
Amazon Web Services
supported
instancecluster
regionstring

AWS region to read. One call reads one region; the caller drives any multi-region loop.

1 supported
Amazon Web Services
supported
Show Truto-specific parameters
integrated_account_idstring · uuid
required·

The ID of the integrated account to use for the request.

Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_formatstring

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.

Example: unified
Possible values:
unifiedrawnormalizedstreamdebug
truto_key_bystring

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.

Example: id
truto_ignore_limitboolean

Ignores the limit query parameter.

truto_ignore_remote_databoolean

Excludes the remote_data attribute from the response.

truto_exclude_fieldsstring[]

Array of fields to exclude from the response.

Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_queryRecord<string, any>

Query parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.

Example: remote_query[foo]=bar

Response Body

debugobject

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.

data
isEmptyResultboolean
isLoopingboolean
nextCursorstring
requestOptionsRecord<string, any>
requestUrlstring
responseHeadersRecord<string, any>
resultCountnumber
next_cursorstring

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.

resultobject[]

List of Relational databases

account_refstring
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.

1 supported
Amazon Web Services
supported
collected_atstring · date-time
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.

1 supported
Amazon Web Services
supported
db_refstring
required·

The provider's own identifier for the database.

1 supported
Amazon Web Services
supported
enginestring
required·

The database engine, as the provider names it.

1 supported
Amazon Web Services
supported
idstring
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.

1 supported
Amazon Web Services
supported
locationstring
required·

Where the database sits.

1 supported
Amazon Web Services
supported
native_typestring
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.

1 supported
Amazon Web Services
supported
providerstring
required·

Which cloud this object was read from.

Possible values:
awsazuregcp
1 supported
Amazon Web Services
supported
provider_refstring
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.

1 supported
Amazon Web Services
supported
topologystring
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.

Possible values:
clusterinstanceunknown
1 supported
Amazon Web Services
supported
allow_all_ingressboolean

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.

1 supported
Amazon Web Services
supported
allowed_networksobject[]

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.

1 supported
Amazon Web Services
supported
audit_log_destination_refstring[]

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.

1 supported
Amazon Web Services
supported
backup_retention_daysinteger

How many days of backups are retained.

1 supported
Amazon Web Services
supported
deletion_protectionboolean

Whether the database is protected against deletion.

1 supported
Amazon Web Services
supported
encryption_at_restboolean

Whether storage is encrypted at rest.

1 supported
Amazon Web Services
supported
encryption_key_refstring

Reference to the encryption key.

1 supported
Amazon Web Services
supported
encryption_key_typestring

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.

Possible values:
provider_managedprovider_ownedcustomer_managednoneunknown
1 supported
Amazon Web Services
supported
engine_lifecycle_supportstring

The provider's support status for this engine version, where exposed.

1 supported
Amazon Web Services
supported
engine_versionstring

The running engine version -- the input to the end-of-support check.

1 supported
Amazon Web Services
supported
global_cluster_refstring

The global cluster this database belongs to, where it is part of one.

1 supported
Amazon Web Services
supported
high_availability_modestring

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.

Possible values:
nonesingle_standbymulti_az_clustermulti_regionzone_redundantunknown
1 supported
Amazon Web Services
supported
is_writerboolean

Whether this row is the writer of its cluster or global cluster.

1 supported
Amazon Web Services
supported
latest_restorable_timestring · date-time

The most recent point the database could be restored to.

1 supported
Amazon Web Services
supported
min_tls_versionstring

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.

1 supported
Amazon Web Services
supported
point_in_time_recoveryboolean

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.

1 supported
Amazon Web Services
supported
public_network_accessboolean

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.

1 supported
Amazon Web Services
supported
regionstring

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.

1 supported
Amazon Web Services
supported
remote_dataRecord<string, any>

Raw data returned from the remote API call.

replica_locationsstring[]

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.

1 supported
Amazon Web Services
supported
replica_refsstring[]

References to the replica databases themselves.

1 supported
Amazon Web Services
supported
security_group_refsstring[]

References to the firewall rule sets attached to this database.

1 supported
Amazon Web Services
supported
storage_encryption_typestring

The provider's own storage encryption type string, verbatim.

1 supported
Amazon Web Services
supported
tagsobject

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.

1 supported
Amazon Web Services
supported
tls_enforcedboolean

Whether TLS is required for connections. Kept separate from min_tls_version, because enforcing TLS is not the same as setting a version floor.

1 supported
Amazon Web Services
supported
unreadable_fieldsobject[]

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'.

1 supported
Amazon Web Services
supported
truto unified cloud-infrastructure relationaldatabases \
  -a '<integrated_account_id>' \
  -o json
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);
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 -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'
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);
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())