# List all CDBs (Oracle only).

Endpoint: GET /cdbs
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.

## Response 200:

  - `200` (unknown)
    OK

## Response 200 fields (application/json):

  - `items` (array)

  - `items.id` (string)
    The CDB object entity ID.
    Example: 1-CDB-1

  - `items.name` (string)
    The name of this CDB.
    Example: Oracle CDB

  - `items.description` (string)
    The container description of this Linked CDB.
    Example: This is Oracle linked CDB.

  - `items.diagnose_no_logging_faults` (boolean)
    If true, NOLOGGING operations on this container are treated as faults and cannot be resolved manually. Otherwise, these operations are ignored.
    Example: true

  - `items.namespace_id` (string)
    The namespace id of this CDB.
    Example: 1-NAMESPACE-1

  - `items.namespace_name` (string)
    The namespace name of this CDB.
    Example: test-engine-1

  - `items.is_replica` (boolean)
    Is this a replicated object.
    Example: true

  - `items.database_version` (string)
    The version of this CDB.
    Example: 10.2.0.5.0

  - `items.environment_id` (string)
    A reference to the Environment that hosts this CDB.
    Example: 1-ENVIRONMENT-1

  - `items.size` (integer)
    The total size of the data files used by this CDB, in bytes.
    Example: 339292672

  - `items.rman_channels` (integer)
    Number of parallel channels to use.

  - `items.files_per_set` (integer)
    Number of data files to include in each RMAN backup set.

  - `items.encrypted_linking_enabled` (boolean)
    True if SnapSync data from the source should be retrieved through an encrypted connection. Enabling this feature can decrease the performance of SnapSync from the source but has no impact on the performance of VDBs created from the retrieved data.

  - `items.compressed_linking_enabled` (boolean)
    True if SnapSync data from the source should be compressed over the network. Enabling this feature will reduce network bandwidth consumption and may significantly improve throughput, especially over slow network.

  - `items.bandwidth_limit` (integer)
    Bandwidth limit (MB/s) for SnapSync and LogSync network traffic. A value of 0 means no limit.

  - `items.number_of_connections` (integer)
    Total number of transport connections to use during SnapSync.

  - `items.backup_level_enabled` (boolean)
    Boolean value indicates whether LEVEL-based incremental backups can be used on the source db.

  - `items.check_logical` (boolean)
    True if extended block checking should be used for this linked database.

  - `items.jdbc_connection_string` (string)
    The JDBC connection URL for this CDB.
    Example: jdbc:oracle:thin:@(DESCRIPTION=(ENABLE=broken)(ADDRESS=(PROTOCOL=tcp)(HOST=10.43.47.94)(PORT=1521))(CONNECT_DATA=(UR=A)(SID=production01)))

  - `items.engine_id` (string)
    A reference to the Engine that this CDB belongs to.
    Example: engine-12

  - `items.is_linked` (boolean)
    Whether this CDB is linked or not.
    Example: false

  - `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.group_name` (string)
    The name of the group containing this CDB.
    Example: Untitled

  - `items.status` (string)
    The runtime status of the vCDB.
    Example: RUNNING

  - `items.enabled` (boolean)
    Whether the CDB is enabled or not.
    Example: true

  - `items.instance_name` (string)
    The instance name of this single instance CDB.
    Example: CDBSID

  - `items.instance_number` (integer)
    The instance number of this single instance CDB.

  - `items.instances` (array)

  - `items.instances.instance_name` (string, required)
    The name of this instance. Must contain at least one non-whitespace character.

  - `items.instances.instance_number` (integer, required)
    The number of this instance.

  - `items.instances.node_reference` (string, required)
    The reference to the cluster node which the instance is running on. Must contain at least one non-whitespace character.

  - `items.instances.okv_client_id` (string)
    The id of the OKV client used for TDE keystore access. If provided, it must include at least one non-whitespace character; if omitted, the existing OKV client will be cleared.
    Example: 1-ORACLE_OKV_CLIENT-1

  - `items.oracle_services` (array)

  - `items.oracle_services.discovered` (boolean)
    Represents whether this jdbc connection string is auto discovered or not.

  - `items.oracle_services.jdbc_connection_string` (string)
    The jdbc connection string used to connect with the database.
    Example: jdbc:oracle:thin:@(DESCRIPTION=(ENABLE=broken)(ADDRESS=(PROTOCOL=tcp)(HOST=10.110.230.197)(PORT=1521))(CONNECT_DATA=(UR=A)(SERVICE_NAME=VDBOMSRBBDC6C_UJG)))

  - `items.repository_id` (string)
    The repository id of this CDB.
    Example: 1-ORACLE_INSTALL-1

  - `items.logsync_enabled` (boolean)
    True if LogSync is enabled for this dSource.

  - `items.logsync_mode` (string)
    LogSync operation mode for this dSource.
    Enum: "ARCHIVE_ONLY_MODE", "ARCHIVE_REDO_MODE", "UNDEFINED"

  - `items.logsync_interval` (integer)
    Interval between LogSync requests, in seconds.

  - `items.tde_keystore_config_type` (string)
    Oracle TDE keystore configuration type.
    Enum: "FILE", "OKV", "HSM", "OKV|FILE", "FILE|OKV", "HSM|FILE", "FILE|HSM", "OCI_VAULT", "UNSET"

  - `items.database_name` (string)
    The database name of this container database.
    Example: production01

  - `items.database_unique_name` (string)
    The unique name of the container database.
    Example: DBOMSRBBDC6C

  - `items.tde_kms_pkcs11_config_path` (string)
    The path to the TDE KMS PKC11 configuration file.
    Example: /etc/oracle/tde/kms_pkcs11.conf

  - `items.is_tde_keystore_password_set` (boolean)
    True if TDE keystore password is set for this container database.

  - `items.environment_user_ref` (string)
    The environment user reference.

  - `items.db_username` (string)
    The name of the database user.

  - `items.non_sys_username` (string)
    The username of a database user that does not have administrative privileges.

  - `items.okv_client_id` (string)
    The id of the OKV client used for TDE keystore access.
    Example: 1-ORACLE_OKV_CLIENT-1

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