Default

List RDS Clusters

get
Authorizations
Query parameters
aws_account_idsstringOptional

Comma-separated list of AWS Account IDs

Example: 123456789012,987654321098
data_elementsstringOptional

Comma-separated list of data elements

data_categoriesstringOptional

Comma-separated list of data categories

searchstringOptional

Search clusters by identifier, append the search key with "identifier:"

sort_bystringOptional
ascbooleanOptional
limitintegerOptional
offsetintegerOptional
Responses
200
List of RDS clusters
application/json
get
GET /v1/aws/rds/clusters HTTP/1.1
Host: api.metadata.demo-001.teleskope.ai
X-API-Key: YOUR_API_KEY
Accept: */*
200

List of RDS clusters

{
  "data": [
    {
      "id": 1,
      "region": "text",
      "engine_type": "text",
      "engine_version": "text",
      "identifier": "text",
      "write_endpoint": "text",
      "read_endpoint": "text",
      "encrypted": true,
      "publicly_accessible": true,
      "open_to_the_world": true,
      "multi_az": true,
      "deletion_protection": true,
      "iam_authentication_enabled": true,
      "backup_retention_period": 1,
      "database_count": 1,
      "table_count": 1,
      "aws_account_id": 1,
      "aws_account_identifier": "text",
      "aws_account_name": "text",
      "data_elements": [
        "text"
      ],
      "data_element_categories": [
        "text"
      ],
      "personas": [
        {
          "name": "text"
        }
      ]
    }
  ],
  "total_count": 1
}

Get a specific RDS cluster

get
Authorizations
Path parameters
idintegerRequired
Responses
200
RDS cluster details
application/json
get
GET /v1/aws/rds/clusters/{id} HTTP/1.1
Host: api.metadata.demo-001.teleskope.ai
X-API-Key: YOUR_API_KEY
Accept: */*
200

RDS cluster details

{
  "id": 1,
  "region": "text",
  "engine_type": "text",
  "engine_version": "text",
  "identifier": "text",
  "write_endpoint": "text",
  "read_endpoint": "text",
  "encrypted": true,
  "publicly_accessible": true,
  "open_to_the_world": true,
  "multi_az": true,
  "deletion_protection": true,
  "iam_authentication_enabled": true,
  "backup_retention_period": 1,
  "database_count": 1,
  "table_count": 1,
  "aws_account_id": 1,
  "aws_account_identifier": "text",
  "aws_account_name": "text",
  "data_elements": [
    "text"
  ],
  "data_element_categories": [
    "text"
  ],
  "personas": [
    {
      "name": "text"
    }
  ]
}

Get a list of RDS databases

get
Authorizations
Responses
200
List of RDS databases
application/json
get
GET /v1/aws/rds/databases HTTP/1.1
Host: api.metadata.demo-001.teleskope.ai
X-API-Key: YOUR_API_KEY
Accept: */*
200

List of RDS databases

{
  "data": [
    {
      "id": 1,
      "database_name": "text",
      "schema_name": "text",
      "table_count": 1,
      "aws_account_id": 1,
      "aws_account_identifier": "text",
      "aws_account_name": "text",
      "rds_cluster_id": 1,
      "rds_cluster_identifier": "text",
      "data_elements": [
        "text"
      ],
      "data_element_categories": [
        "text"
      ],
      "personas": [
        {
          "name": "text"
        }
      ]
    }
  ],
  "total_count": 1
}

Get a specific RDS database

get
Authorizations
Path parameters
idintegerRequired
Responses
200
RDS database details
application/json
get
GET /v1/aws/rds/databases/{id} HTTP/1.1
Host: api.metadata.demo-001.teleskope.ai
X-API-Key: YOUR_API_KEY
Accept: */*
200

RDS database details

{
  "id": 1,
  "database_name": "text",
  "schema_name": "text",
  "table_count": 1,
  "aws_account_id": 1,
  "aws_account_identifier": "text",
  "aws_account_name": "text",
  "rds_cluster_id": 1,
  "rds_cluster_identifier": "text",
  "data_elements": [
    "text"
  ],
  "data_element_categories": [
    "text"
  ],
  "personas": [
    {
      "name": "text"
    }
  ]
}

List RDS tables

get
Authorizations
Responses
200
List of RDS tables
application/json
get
GET /v1/aws/rds/tables HTTP/1.1
Host: api.metadata.demo-001.teleskope.ai
X-API-Key: YOUR_API_KEY
Accept: */*
200

List of RDS tables

{
  "data": [
    {
      "id": 1,
      "table_name": "text",
      "data_size": 1,
      "row_count": 1,
      "last_scanned": "2025-06-24T23:16:29.931Z",
      "dsr_query": "text",
      "column_count": 1,
      "access_enabled": true,
      "deletion_enabled": true,
      "dsr_enabled": true,
      "aws_account_id": 1,
      "aws_account_identifier": "text",
      "aws_account_name": "text",
      "rds_cluster_id": 1,
      "rds_cluster_identifier": "text",
      "rds_database_id": 1,
      "rds_database_name": "text",
      "rds_schema_name": "text",
      "data_elements": [
        "text"
      ],
      "data_element_categories": [
        "text"
      ],
      "personas": [
        {
          "name": "text"
        }
      ]
    }
  ],
  "total_count": 1
}

Get a specific RDS table

get
Authorizations
Path parameters
idintegerRequired
Responses
200
RDS table details
application/json
get
GET /v1/aws/rds/tables/{id} HTTP/1.1
Host: api.metadata.demo-001.teleskope.ai
X-API-Key: YOUR_API_KEY
Accept: */*
200

RDS table details

{
  "id": 1,
  "table_name": "text",
  "data_size": 1,
  "row_count": 1,
  "last_scanned": "2025-06-24T23:16:29.931Z",
  "dsr_query": "text",
  "column_count": 1,
  "access_enabled": true,
  "deletion_enabled": true,
  "dsr_enabled": true,
  "aws_account_id": 1,
  "aws_account_identifier": "text",
  "aws_account_name": "text",
  "rds_cluster_id": 1,
  "rds_cluster_identifier": "text",
  "rds_database_id": 1,
  "rds_database_name": "text",
  "rds_schema_name": "text",
  "data_elements": [
    "text"
  ],
  "data_element_categories": [
    "text"
  ],
  "personas": [
    {
      "name": "text"
    }
  ]
}

Get a list of RDS columns

get
Authorizations
Responses
200
List of RDS columns
application/json
get
GET /v1/aws/rds/columns HTTP/1.1
Host: api.metadata.demo-001.teleskope.ai
X-API-Key: YOUR_API_KEY
Accept: */*
200

List of RDS columns

{
  "data": [
    {
      "id": "text",
      "column_name": "text",
      "column_type": "text",
      "identifier_id": "text",
      "identifier_name": "text",
      "access_enabled": true,
      "custom_access_label": "text",
      "deletion_enabled": true,
      "deletion_algorithm": "text",
      "no_data": true,
      "table_last_scanned": "2025-06-24T23:16:29.931Z",
      "aws_account_id": 1,
      "aws_account_identifier": "text",
      "aws_account_name": "text",
      "rds_cluster_id": 1,
      "rds_cluster_identifier": "text",
      "rds_database_id": 1,
      "rds_database_name": "text",
      "rds_schema_name": "text",
      "rds_table_id": 1,
      "rds_table_name": "text",
      "data_elements": [
        "text"
      ],
      "data_element_categories": [
        "text"
      ],
      "personas": [
        {
          "name": "text"
        }
      ]
    }
  ],
  "total_count": 1
}

Get a specific RDS column

get
Authorizations
Path parameters
idstringRequired
Responses
200
RDS column details
application/json
get
GET /v1/aws/rds/columns/{id} HTTP/1.1
Host: api.metadata.demo-001.teleskope.ai
X-API-Key: YOUR_API_KEY
Accept: */*
200

RDS column details

{
  "id": "text",
  "column_name": "text",
  "column_type": "text",
  "identifier_id": "text",
  "identifier_name": "text",
  "access_enabled": true,
  "custom_access_label": "text",
  "deletion_enabled": true,
  "deletion_algorithm": "text",
  "no_data": true,
  "table_last_scanned": "2025-06-24T23:16:29.931Z",
  "aws_account_id": 1,
  "aws_account_identifier": "text",
  "aws_account_name": "text",
  "rds_cluster_id": 1,
  "rds_cluster_identifier": "text",
  "rds_database_id": 1,
  "rds_database_name": "text",
  "rds_schema_name": "text",
  "rds_table_id": 1,
  "rds_table_name": "text",
  "data_elements": [
    "text"
  ],
  "data_element_categories": [
    "text"
  ],
  "personas": [
    {
      "name": "text"
    }
  ]
}
PreviousRDSNextModels

Was this helpful?