Database

List Database

Endpoint to list all Database items

post/database-server/get-list

Request

Request body

limitnumber

Maximum number of items to return. Defaults to 10.

skipnumber

Number of items to skip for pagination. Defaults to 0.

Example request

{
  "query": {
    "createdAt": {
      "_type": "GreaterThan",
      "value": "2026-01-01T00:00:00.000Z"
    },
    "name": {
      "_type": "Search",
      "value": "example"
    }
  },
  "select": {
    "_id": true,
    "createdAt": true,
    "updatedAt": true,
    "name": true,
    "dbSystem": true,
    "dbVersion": true,
    "discoverySource": true,
    "kubernetesNamespace": true
  },
  "sort": {
    "createdAt": "DESC"
  }
}

Response

Successful response

countnumber

Example response

{
  "data": [
    {
      "_id": "123e4567-e89b-12d3-a456-426614174000",
      "createdAt": {
        "_type": "DateTime",
        "value": "2023-10-01T12:00:00Z"
      },
      "updatedAt": {
        "_type": "DateTime",
        "value": "2023-10-01T12:00:00Z"
      },
      "deletedAt": {
        "_type": "DateTime",
        "value": "2023-10-01T12:00:00Z"
      },
      "version": 42,
      "projectId": "123e4567-e89b-12d3-a456-426614174000",
      "name": "PostgreSQL orders-db.internal:5432",
      "slug": "example-slug-value",
      "description": "Primary PostgreSQL database for the orders service",
      "databaseIdentifier": "postgresql|orders-db.internal:5432",
      "workloadIdentifier": "postgresql|kubernetes:prod-cluster/data/statefulset/orders-db",
      "dbSystem": "postgresql",
      "serverAddress": "orders-db.internal",
      "serverPort": 42,
      "dbVersion": "16.4",
      "discoverySource": "collector",
      "kubernetesClusterId": "123e4567-e89b-12d3-a456-426614174000",
      "kubernetesNamespace": "data",
      "workloadKind": "StatefulSet",
      "workloadName": "orders-db",
      "dockerHostId": "123e4567-e89b-12d3-a456-426614174000",
      "podmanHostId": "123e4567-e89b-12d3-a456-426614174000",
      "memberEntityKeys": {
        "key": "value",
        "nested": {
          "data": 123
        }
      },
      "instanceCount": 42,
      "otelCollectorStatus": "connected",
      "collectorLastSeenAt": {
        "_type": "DateTime",
        "value": "2023-10-01T12:00:00Z"
      },
      "agentVersion": "1.0.0",
      "engineReadings": {
        "key": "value",
        "nested": {
          "data": 123
        }
      },
      "engineReadingsAt": {
        "_type": "DateTime",
        "value": "2023-10-01T12:00:00Z"
      },
      "engineHealth": "healthy",
      "lastSeenAt": {
        "_type": "DateTime",
        "value": "2023-10-01T12:00:00Z"
      },
      "autoArchivedAt": {
        "_type": "DateTime",
        "value": "2023-10-01T12:00:00Z"
      },
      "manuallyRestoredAt": {
        "_type": "DateTime",
        "value": "2023-10-01T12:00:00Z"
      },
      "dbSystemSource": "container",
      "workloadLastSeenAt": {
        "_type": "DateTime",
        "value": "2023-10-01T12:00:00Z"
      },
      "automaticAssignments": {
        "key": "value",
        "nested": {
          "data": 123
        }
      },
      "createdByUserId": "123e4567-e89b-12d3-a456-426614174000",
      "isArchived": true,
      "archivedAt": {
        "_type": "DateTime",
        "value": "2023-10-01T12:00:00Z"
      },
      "archivedByUserId": "123e4567-e89b-12d3-a456-426614174000",
      "deletedByUserId": "123e4567-e89b-12d3-a456-426614174000",
      "labels": [
        {
          "_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
        }
      ],
      "retainTelemetryDataForDays": 42,
      "telemetryRetentionConfig": {
        "key": "value",
        "nested": {
          "data": 123
        }
      },
      "isAiInvestigationEnabled": true,
      "aiRemediationMode": "RequireApproval",
      "aiCommandAllowlist": {
        "key": "value",
        "nested": {
          "data": 123
        }
      },
      "aiAccessLastVerifiedAt": {
        "_type": "DateTime",
        "value": "2023-10-01T12:00:00Z"
      },
      "aiAccessLastError": "This is an example of longer text content that might be stored in this field.",
      "aiAccessConfiguredAt": {
        "_type": "DateTime",
        "value": "2023-10-01T12:00:00Z"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.