Skip to content
/
List all vdbs.

List all vdbs.

Request

Security
ApiKeyAuth
Query
limitinteger, [ 1 .. 1000 ]

Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100.

Default:100
Example:limit=50
cursorstring, [ 1 .. 4096 ] characters

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.

sortstring or null

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

Enum:"id""-id""database_name""-database_name""database_type""-database_type""name""-name""database_version""-database_version"
Example:sort=id
permissionstring(PermissionEnum)

Restrict the objects, which are allowed.

Enum:"READ""UPDATE""DELETE""EXECUTE""CANCEL""MIGRATE""REFRESH""DISABLE""ENABLE""ABANDON"
Example:permission=READ
curl -i -X GET \
  'https://help-api.delphix.com/_mock/data-control-tower/continuous-data/23.0.0/continuous-data-apis-dct-23.0.0/vdbs?limit=50&cursor=string&sort=id&permission=READ' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
itemsArray of objects(VDB)
errorsArray of objects(Errors)

Sadly, sometimes requests to the API are not successful. Failures can occur for a wide range of reasons. The Errors object contains information about full or partial failures which might have occurred during the request.

response_metadataobject(PaginatedResponseMetadata)
Response
{
  "items": [
    { … }
  ],
  "errors": [
    { … }
  ],
  "response_metadata": {
    "prev_cursor": "string",
    "next_cursor": "string",
    "total": 0
  }
}