# List all PaaS Databases.

Endpoint: GET /paas-databases
Version: 3.30.0
Security: ApiKeyAuth

## Security:

  - `ApiKeyAuth` (unknown)
    apiKey in header Authorization

## Query parameters:

  - `limit` (integer)
    Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100.

  - `cursor` (string)
    Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints.

  - `sort` (string)
    The field to sort results by. A property name with a prepended '-' signifies descending order.

  - `permission` (array)
    Restrict the objects, which are allowed.

## Response 200:

  - `200` (unknown)
    OK

## Response 200 fields (application/json):

  - `items` (array)

  - `items.id` (string)
    The PaaS Database object entity ID.
    Example: db-123

  - `items.name` (string)
    The PaaS Database name.
    Example: my-db-123

  - `items.plugin_id` (string)
    Id of the PaaS plugin which manages this Database.
    Example: plugin-123

  - `items.is_snapshot_operation_target` (boolean)
    Whether this PaaS Database can be the target of a DCT snapshot operation.

  - `items.instance_id` (string)
    Id of the PaaS Instance of this Database.
    Example: instance-123

  - `items.instance_name` (string)
    Name of the PaaS Instance of this Database.
    Example: my-instance-123

  - `items.cloud_account_id` (string)
    Id of the Cloud Account to which this Database belongs.
    Example: environment-123

  - `items.cloud_account_name` (string)
    Name of the Cloud Account to which this Database belongs.
    Example: AWS-US-EAST-1

  - `items.database_engine` (string)
    Name of the database engine.
    Example: Azure SQL Server

  - `items.database_engine_version` (string)
    Version of the database engine.
    Example: 19.1.2

  - `items.status` (string)
    The management status of this PaaS Database. DISCOVERED means the database has been found by DCT but is not yet under DCT management. DCT_MANAGED means the database is actively managed by DCT. ROOT means the database serves as the root source for DCT-managed child databases.
    Enum: "DISCOVERED", "DCT_MANAGED", "ROOT"

  - `items.runtime_status` (string)
    Runtime status of the PaaS Database.
    Enum: "CREATING", "FAILED", "RUNNING", "DEPROVISIONED", "STOPPED", "DELETED_ROOT_SOURCE", "REFRESHING"

  - `items.connection_strings` (array)
    Connection strings (such as JDBC URLs) for applications to connect to the database.

  - `items.parent_database_id` (string)
    The ID of the parent PaaS Database, if this is a child database.
    Example: my-db-123

  - `items.parent_database_name` (string)
    The name of the parent PaaS Database, if this is a child database.
    Example: my-parent-db

  - `items.root_database_id` (string)
    The ID of the root PaaS Database, if this is a managed database.
    Example: my-root-123

  - `items.root_database_name` (string)
    The name of the root PaaS Database, if this is a managed database.
    Example: my-root-db

  - `items.parent_snapshot_id` (string)
    The ID of the parent PaaS Snapshot, if this is a child database.
    Example: my-snapshot-123

  - `items.is_encrypted` (boolean)
    Whether this database is encrypted or not.
    Example: true

  - `items.compliance_connector_id` (string)
    ID of the compliance connector created for this PaaS Database if any.
    Example: 123-connector-456

  - `items.database_type` (string)
    The type of database.
    Enum: "ORACLE", "RDS_POSTGRES", "MSSQL"

  - `items.owner` (string)
    The owner or responsible party for this database, typically derived from metadata or tags.

  - `items.created_time` (string)
    The timestamp when the database instance was created, in ISO 8601 date-time format.

  - `items.size_bytes` (integer)
    The size of the database in bytes.

  - `items.size_measurement_time` (string)
    The timestamp when the size of the database was retrieved, in ISO 8601 date-time format.

  - `items.size_measurement_source` (string)
    The source from where the size was retrieved.

  - `items.current_timeflow_id` (string)
    The ID of the current active PaaS Timeflow for this Database, if the database is live.
    Example: paas-timeflow-abc123

  - `items.tags` (array)

  - `items.tags.key` (string, required)
    Key of the tag
    Example: key-1

  - `items.tags.value` (string, required)
    Value of the tag
    Example: value-1

  - `items.tags.mirror_on_cloud` (boolean)
    Whether this tag is mirrored from/to the Cloud Provider account hosting the PaaS Database or Instance. Not applicable to non PaaS objects.

  - `response_metadata` (object)

  - `response_metadata.prev_cursor` (string)
    Pointer to the previous page of results. Use this value as a cursor query parameter in a subsequent request, along with limit, to navigate through the collection by virtual page.

  - `response_metadata.next_cursor` (string)
    Pointer to the next page of results. Use this value as a cursor query parameter in a subsequent request, along with limit, to navigate through the collection by virtual page.

  - `response_metadata.total` (integer)
    The total number of results. This value may not be provided.