AWS
List Database Instances
Authentication
Connections
AWS
Guard Rails
Server Management
Jira
Organization Management
Reports
User Management
Sessions
AWS
List Database Instances
It list RDS Database Instances
POST
/
integrations
/
aws
/
rds
/
describe-db-instances
curl --request POST \
--url https://use.hoop.dev/api/integrations/aws/rds/describe-db-instances \
--header 'Content-Type: */*' \
--data '{}'
{
"items": [
{
"account_id": "123456789012",
"arn": "arn:aws:rds:us-west-2:123456789012:db:my-postgres-db",
"availability_zone": "us-west-2a",
"engine": "postgres",
"name": "my-postgres-db",
"status": "available",
"vpc_id": "vpc-0123456789abcdef0"
}
]
}
Body
*/* · object
The request body resource
The body is of type object
.
Response
200
application/json
OK
AccountID is the unique identifier for the AWS account that owns the database
Example:
"123456789012"
ARN is the Amazon Resource Name that uniquely identifies the database instance
Example:
"arn:aws:rds:us-west-2:123456789012:db:my-postgres-db"
AvailabilityZone is the AWS availability zone where the database is deployed
Example:
"us-west-2a"
Engine is the database engine type (e.g., MySQL, PostgreSQL)
Example:
"postgres"
Name is the identifier for the database instance
Example:
"my-postgres-db"
Status indicates the current state of the database instance
Example:
"available"
VpcID is the ID of the Virtual Private Cloud where the database is deployed
Example:
"vpc-0123456789abcdef0"
curl --request POST \
--url https://use.hoop.dev/api/integrations/aws/rds/describe-db-instances \
--header 'Content-Type: */*' \
--data '{}'
{
"items": [
{
"account_id": "123456789012",
"arn": "arn:aws:rds:us-west-2:123456789012:db:my-postgres-db",
"availability_zone": "us-west-2a",
"engine": "postgres",
"name": "my-postgres-db",
"status": "available",
"vpc_id": "vpc-0123456789abcdef0"
}
]
}