# List database instances

Retrieves the specified database instances of the database schema

Endpoint: POST /v1/orgs/{org}/projects/{project}/dbschema/{dbschema}/instancelist
Version: 1.0
Security: x-api-key

## Path parameters:

  - `org` (string, required)
    Organization identifier

  - `project` (string, required)
    Project identifier

  - `dbschema` (string, required)
    Identifier of the database schema

## Header parameters:

  - `Harness-Account` (string)
    Identifier field of the account the resource is scoped to. This is required for Authorization methods other than the x-api-key header. If you are using the x-api-key header, this can be skipped.

## Query parameters:

  - `page` (integer)
    Pagination page number strategy: Specify the page number within the paginated collection related to the number of items on each page.

  - `limit` (integer)
    Pagination: Number of items to return.

  - `search_term` (string)
    This would be used to filter resources having attributes matching the search term.

  - `sort` (string)
    Parameter on the basis of which sorting is done.
    Enum: "name", "updated", "created"

  - `order` (string)
    Order on the basis of which sorting is done.
    Enum: "ASC", "DESC"

## Request fields (application/json):

  - `filterType` (string)
    filter criteria type. Example: Equals, NotEquals
    Enum: "Equals", "NotEquals"

  - `instanceTags` (array)
    an array on db instance key value pairs used against the filter

  - `instanceTags.key` (string, required)

  - `instanceTags.value` (string,null)

## Response 200 fields (application/json):

  - `branch` (string)
    branch where the instance is stored

  - `connector` (string, required)
    DB Connector

  - `context` (string)
    Liquibase context

  - `created` (integer, required)
    epoch seconds when the database instance was created

  - `identifier` (string, required)
    identifier of the database instance

  - `lastAppliedTag` (string)
    Most recent tag applied to the database

  - `lastDeployedChangeSetTag` (string, required)
    Tag on last deployed changeSet

  - `liquibaseSubstituteProperties` (object)
    properties to substitute in liquibase changelog

  - `name` (string, required)
    name of the database instance

  - `schemaId` (string)

  - `schemaIdentifier` (string)

  - `tags` (object)
    tags attached to the database instance

  - `toOnboard` (boolean)

  - `updated` (integer)
    epoch seconds when the database instance was last updated

## Response 400 fields (application/json):

  - `message` (string, required)
    error message detail

## Response 403 fields (application/json):

  - `message` (string, required)
    error message detail

## Response 404 fields (application/json):

  - `message` (string, required)
    error message detail

## Response 500 fields (application/json):

  - `message` (string, required)
    error message detail