# List all CDBs (Oracle only).

Endpoint: GET /cdbs
Version: 3.17.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.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.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)
    The name of this instance.

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

  - `items.instances.node_reference` (string)
    The reference to the cluster node which the instance is running on.

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

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