# List all VDBGroups.

Endpoint: GET /vdb-groups
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, required)
    A unique identifier for the entity.
    Example: 123

  - `items.name` (string, required)
    A unique name for the entity.
    Example: my-first-vdb-group

  - `items.vdb_ids` (array)
    The list of VDB IDs in this VDB Group.
    Example: ["vdb-123","vdb-456"]

  - `items.is_locked` (boolean)
    Indicates whether the VDB Group is locked.
    Example: false

  - `items.locked_by` (integer)
    The Id of the account that locked the VDB Group.
    Example: 1

  - `items.locked_by_name` (string)
    The name of the account that locked the VDB Group.
    Example: admin

  - `items.vdb_group_source` (string)
    Source of the vdb group, default is DCT. In case of self-service container, this value would be ENGINE.
    Enum: "DCT", "ENGINE"

  - `items.ss_data_layout_id` (string)
    Data-layout Id for engine-managed vdb groups.

  - `items.vdbs` (array)
    Dictates order of operations on VDBs. Operations can be performed in parallel  for all VDBs or sequentially. Below are possible valid and invalid orderings given an example  VDB group with 3 vdbs (A, B, and C). Valid: {"vdb_id":"vdb-1", "order":"1"} {"vdb_id":"vdb-2", order:"1"} {vdb_id:"vdb-3", order:"1"} (parallel) {vdb_id:"vdb-1", order:"1"} {vdb_id:"vdb-2", order:"2"} {vdb_id:"vdb-3", order:"3"} (sequential) Invalid: {vdb_id:"vdb-1", order:"A"} {vdb_id:"vdb-2", order:"B"} {vdb_id:"vdb-3", order:"C"} (sequential) In the sequential case the vdbs with priority 1 is the first to be started and the last to be stopped. This value is set on creation of VDB groups.

  - `items.vdbs.vdb_id` (string)
    Vdb id

  - `items.vdbs.order` (integer)
    Dictates order of operations on VDBs. Operations can be performed in parallel  for all VDBs or sequentially. Below are possible valid and invalid orderings given an example  VDB group with 3 vdbs (A, B, and C). Valid: {"vdb_id":"vdb-1", "order":"1"} {"vdb_id":"vdb-2", order:"1"} {vdb_id:"vdb-3", order:"1"} (parallel) {vdb_id:"vdb-1", order:"1"} {vdb_id:"vdb-2", order:"2"} {vdb_id:"vdb-3", order:"3"} (sequential) Invalid: {vdb_id:"vdb-1", order:"A"} {vdb_id:"vdb-2", order:"B"} {vdb_id:"vdb-3", order:"C"} (sequential) In the sequential case the vdbs with priority 1 is the first to be started and the last to be stopped. This value is set on creation of VDB groups.

  - `items.vdbs.vdb_name` (string)

  - `items.vdbs.last_refresh_time_with_group_refresh` (string)
    The last time the VDB was successfully refreshed as a part of VDB Group refresh operation in UTC timezone.
    Example: 2022-05-29T15:00:00.000Z

  - `items.vdbs.in_sync` (boolean)
    Indicates if the VDB is in sync with the VDB Group or not. If this VDB is was last refreshed as part of the VDB Group then this value will be true.

  - `items.database_type` (string)
    The database type of the VDB Group. If all VDBs in the group are of the same database_type, this field will be set to that type. If the VDBs are of different database_type, this field will be set to 'Mixed'.
    Example: Oracle

  - `items.status` (string)
    The status of the VDB Group. If all VDBs in the VDB Group have the same status, this field will be set to that status. If the VDBs have different statuses, this field will be set to 'Mixed'.
    Example: RUNNING

  - `items.last_successful_refresh_to_bookmark_id` (string)
    The bookmark ID to which the VDB Group was last successfully refreshed.
    Example: bookmark-123

  - `items.last_successful_refresh_time` (string)
    The time at which the VDB Group was last successfully refreshed.
    Example: 2021-05-01T08:51:34.148Z

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

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