Sign in

v1

latestOpenAPI 3.0.22026-08-062794201004.1 KB
AI Data Plane Providers

List providers

Lists all the Provider integrations configured a given organization. Use the providerType to filter on the type of Provider.

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

  • Organization Owner

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

get/v4/organizations/{organizationId}/aiServices/providers

Query parameters

pageinteger

Sets the page you would like to view.

perPageinteger

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

providerType'awsS3' | 'openAI' | 'awsBedrock'

Type of provider to filter on. By default all providers are returned.

Response

Successfully listed all the providers under the organization.

Example response

{
  "data": [
    {
      "id": "provider1-ffffffff-aaaa-1414-eeee-000000000000",
      "name": "my-aws-s3-provider",
      "type": "awsS3",
      "audit": {
        "createdBy": "ffffffff-aaaa-1414-eeee-000000000000",
        "createdAt": "2021-09-01T12:34:56Z",
        "modifiedBy": "ffffffff-aaaa-1414-eeee-000000000000",
        "modifiedAt": "2021-09-01T12:34:56Z",
        "version": 1
      }
    }
  ],
  "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"
    }
  }
}