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) or 'cluster'. Call both for a complete inventory, as neither returns the other's rows. Instances belonging to a cluster are suppressed on the instance route.

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

idstring
required·

Truto's stable unified identifier for this object. Opaque; use provider_id to address the object in the provider's own console or API.

1 supported
Amazon Web Services
supported
accountstring

The account, subscription or project this object belongs to.

References: Accounts → id
1 supported
Amazon Web Services
supported
allow_all_ingressboolean

Whether any allowed network rule permits the whole internet.

1 supported
Amazon Web Services
supported
allowed_networksobject[]

Ingress rules that reach this database.

1 supported
Amazon Web Services
supported
4 properties
from_portinteger

Lowest port allowed.

protocolstring

The protocol allowed.

source_idstring

The source range or security group allowed in.

to_portinteger

Highest port allowed.

attached_rule_setsobject[]

The firewall rule sets attached to this database.

1 supported
Amazon Web Services
supported
1 property
idstring

The target's id.

audit_log_destinationsobject[]

Where audit and error logs are delivered. AWS creates the destination on first write, so a row here can name a log group that does not exist yet.

1 supported
Amazon Web Services
supported
1 property
idstring

The target's id.

backup_retention_daysinteger

How many days of backups are retained.

1 supported
Amazon Web Services
supported
collected_atstring · date-time

When Truto actually read this object from the provider, in UTC ISO 8601 with the offset present — not the request time, and not a provider timestamp.

1 supported
Amazon Web Services
supported
created_atstring

When the object was created at the provider, in UTC ISO 8601. Null when the provider does not record one - see unreadable_fields.

1 supported
Amazon Web Services
supported
db_idstring

The provider's own identifier for the database.

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_keyobject

The key protecting the database at rest.

References: ManagedKeys → id
1 supported
Amazon Web Services
supported
1 property
idstring

The target's id.

encryption_key_typestring

Who manages the storage encryption key. AWS merges provider-managed and customer-managed into one value (only provider-owned is distinguishable); resolving further may yield permission_denied.

Possible values:
provider_managedprovider_ownedcustomer_managednoneunknown
1 supported
Amazon Web Services
supported
enginestring

The database engine, as the provider names it.

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 database engine version currently running.

1 supported
Amazon Web Services
supported
global_cluster_idstring

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

1 supported
Amazon Web Services
supported
high_availability_modestring

The database's high-availability topology, distinguishing standby, multi-AZ, and multi-region configurations.

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
locationstring

Where the database sits.

1 supported
Amazon Web Services
supported
min_tls_versionstring

Minimum TLS version accepted. Often not derivable on AWS: some engines have no true minimum, only an allow-list or independent toggles, and an absent parameter isn't the same as off.

1 supported
Amazon Web Services
supported
native_typestring

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
point_in_time_recoveryboolean

Whether point-in-time restore is available. AWS has no such flag; this is derived from backup retention and cross-checked against latest_restorable_time.

1 supported
Amazon Web Services
supported
providerstring

Which cloud this object was read from.

Possible values:
awsazuregcp
1 supported
Amazon Web Services
supported
provider_idstring

The provider's own identifier, passed through verbatim — a full ARN, resource id, or self-link. Never truncated, prefixed, or normalized.

1 supported
Amazon Web Services
supported
public_network_accessboolean

The provider's public-network-access flag, not proven reachability: true doesn't mean reachable, and false doesn't mean safe — actual exposure also depends on routing.

1 supported
Amazon Web Services
supported
regionstring

Where the object is located. 'global' denotes genuinely global resources (e.g. IAM, GCP VPC networks) rather than a guessed region. A substituted region (when none is derivable) is flagged 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.

1 supported
Amazon Web Services
supported
replicasobject[]

The replica databases themselves.

1 supported
Amazon Web Services
supported
1 property
idstring

The target's id.

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, key/value normalization, or merging of separate provider concepts. An empty object means no tags; tags that could not be read appear in unreadable_fields instead.

1 supported
Amazon Web Services
supported
tls_enforcedboolean

Whether TLS is required for connections, independent of any minimum version floor.

1 supported
Amazon Web Services
supported
topologystring

Whether this row represents a cluster or a standalone instance.

Possible values:
clusterinstanceunknown
1 supported
Amazon Web Services
supported
unreadable_fieldsobject[]

Fields on this object that could not be read, and why. An empty array means everything was read. Use this to tell a real value from a missing one.

1 supported
Amazon Web Services
supported
3 properties
detailstring

Explanation of the reason, where one adds anything.

fieldstring

The property on this resource that could not be read.

reasonstring

Why the field could not be read. available_on_get: Not read on list to keep the list fast; call GET for this resource's id to get it.

Possible values:
not_supported_by_providernot_configuredpermission_deniednot_collectedcollection_errorpartially_collectedavailable_on_get
updated_atstring

When the object was last modified at the provider, in UTC ISO 8601. Null when the provider does not record one - see unreadable_fields.

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())