API cookbook: list dSources and VDBs

This API cookbook recipe describes how to obtain a list of dSources and VDBs using the Delphix Engine API.

To obtain a list of dSources and VDBs, list available Container (also known as database) objects on the system:

List Databases

CODE

$ curl -X GET -k http://delphix-server/resources/json/delphix/database  \
    -b ~/cookies.txt -H "Content-Type: application/json"

For more information on the structure of a database object, see the /api/#Container reference on your local Delphix Engine. The following sub-types are available depending on the type of database:

OracleDatabaseContainer
MSSqlDatabaseContainer

Each database has zero or one source associated with it. This source could be a linked source, indicating that the database is a dSource, or it could be a virtual source, indicating that it is a VDB. If there are no sources, it is a detached dSource. The parentContainer property indicates the reference to the parent container, also indicating that the database is a VDB. To get runtime information about the source associated with the dSource or VDB, use the Source API with a database parameter set to the reference of the database in question.

List Sources

CODE

$ curl -X GET -k http://delphix-server/resources/json/delphix/source?database=DB_CONTAINER-13  \
    -b ~/cookies.txt -H "Content-Type: application/json"

If the virtual flag is true, the source is a VDB, otherwise it is a dSource. For more information about the contents of a source object, see the /api/#Source reference on your local Delphix Engine. The following sub-types are available depending on the type of source:

OracleSource
- OracleLinkedSource
- OracleVirtualSource
MSSqlSource
- MSSqlLinkedSource
- MSSqlVirtualSource