COcouchbase
AI Agent Memory Servers

List Agent Memory Server Eligible Clusters

Changed on

Lists the clusters that are eligible for an agent memory server deployment.

A cluster is eligible only when all of the following hold:

  • It runs all of the data, index, query, and search services.
  • It runs Couchbase Server 8.0.0 or later.
  • It does not already have an agent memory server deployed, because the mapping between a cluster and an agent memory server is one to one.

In order to access this endpoint, the provided API key must have at least one of the following roles:

  • Organization Owner
  • Project Creator
  • Project Owner
  • Project Manager
  • Project Viewer
  • Database Data Reader/Writer
  • Database Data Reader
  • Cluster Owner
  • Cluster Data Writer
  • Cluster Data Viewer

To learn more, see Organization, Project, and Database Access Overview.

get/v4/organizations/{organizationId}/aiServices/agentMemoryServers/eligibleClusters

Request

Query parameters

projectIdstring uuid
Example:ffffffff-aaaa-1414-eeee-000000000000

The GUID4 ID of the project.

pageinteger

Sets the page you would like to view.

perPageinteger

Sets the number of results you would like to have on each page.

sortBystring[]

Sets the order of how you would like to sort the results and the key you would like to order by. Valid fields to sort the results are: name, couchbaseVersion.

sortDirection'asc' | 'desc'

The order in which the items will be sorted.

Response

Successfully listed the eligible clusters.

Example response

{
  "data": [
    {
      "id": "13d745eb-9861-4e1d-88f5-eaacfef416a2",
      "name": "my-cluster",
      "projectId": "a3b2c1d0-0000-4e57-b1f9-90bc2dcfa001",
      "projectName": "my-project",
      "couchbaseVersion": "8.0.1",
      "services": [
        "data",
        "index",
        "query",
        "search"
      ]
    }
  ],
  "cursor": {
    "pages": {
      "page": 2,
      "next": 3,
      "previous": 1,
      "last": 10,
      "perPage": 10,
      "totalItems": 10
    },
    "hrefs": {
      "first": "https://cloud.couchbase.com/v4/users?page=1&perPage=10",
      "last": "https://cloud.couchbase.com/v4/users?page=1&perPage=10",
      "previous": "https://cloud.couchbase.com/v4/users?page=1&perPage=10",
      "next": "https://cloud.couchbase.com/v4/users?page=1&perPage=10"
    }
  }
}

Changes