---
title: "List API keys"
method: GET
path: "/v4/organizations/{organizationId}/aiServices/models/apiKeys"
tags: ["Model Services API Keys (AI Data Plane)"]
---

# List API keys

`GET /v4/organizations/{organizationId}/aiServices/models/apiKeys`

## Request

- Base URL: `https://cloudapi.cloud.couchbase.com`
- URL: `https://cloudapi.cloud.couchbase.com/v4/organizations/{organizationId}/aiServices/models/apiKeys`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/couchbase/apis/couchbase-capella-management-api/docs/v4/organizations/:organizationId/aiServices/models/apiKeys/get.ts> (a function with typed inputs; its response is checked against the schema)

Lists all API keys for the given region in an organization.

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](https://docs.couchbase.com/cloud/organizations/organization-projects-overview.html).

## Query parameters

- `page` integer
- `perPage` integer
- `sortBy` string[]
- `sortDirection` 'asc' | 'desc'
- `filterBy` string

## Response `200`

Successfully listed all the API keys.

- ListLanguageModelAPIKeysResponse
  - `data` GetLanguageModelAPIKeyResponse[], required
    - `keyId` string: Unique identifier for the Language Model API key
    - `name` string: Name of the Language Model API key
    - `description` string: Description of the Language Model API Key
    - `expiry` number, float: Expiry of the API key in number of days. Maximum value is 365 days.
    - `allowedCIDRs` string[]: List of IP addresses or CIDR blocks that are allowed to use this API key.
    - `allowedModels` object[]: List of allowed models for this API key. Returns "*" if all models in the region are allowed, or specific model IDs if restricted.
      - `id` string, required: Unique identifier for the model
      - `name` string, required: Name of the model
    - `region` string: The region where the API key will be created. The apikey created in a region can access all the models available in that region.
    - `audit` CouchbaseAuditData
      - `createdBy` string, required: The user who created the resource; this will be a UUID4 ID for standard users and will be a string such as "internal-support" for internal Couchbase support users.
      - `createdAt` string, date-time, required: The RFC3339 timestamp associated with when the resource was initially created.
      - `modifiedBy` string, required: The user who last modified the resource; this will be a UUID4 ID for standard users and will be a string such as "internal-support" for internal Couchbase support users.
      - `modifiedAt` string, date-time, required: The RFC3339 timestamp associated with when the resource was last modified.
      - `version` integer, required: The version of the document. This value is incremented each time the resource is modified.
  - `cursor` Cursor, required
    - `pages` Pages, required
      - `page` integer, required: Current page of results, starting from page 1.
      - `next` integer: Number of the next page of results. Not set on the last page.
      - `previous` integer: Number of the previous page of results. Not set on the first page.
      - `last` integer, required: Number of the last page of results.
      - `perPage` integer, required: Number of items displayed in each page.
      - `totalItems` integer, required: Total items found by the given query.
    - `hrefs` Hrefs, required
      - `first` string, uri, required: The base URL, endpoint, and path parameters required to fetch the first page of results.
      - `last` string, uri, required: The base URL, endpoint, and path parameters required to fetch the last page of results.
      - `previous` string, uri, required: The base URL, endpoint, and path parameters required to fetch the previous page of results. Empty if there is no previous page.
      - `next` string, uri, required: The base URL, endpoint, and path parameters required to fetch the next page of results. Empty if there is no next page.

## Other responses

- `401`: The client does not have the valid credentials to access this resource.
- `403`: The client does not have the necessary permissions to access this resource.
- `422`: Request validation error.
- `500`: An unexpected error occurred in the server while processing this request.

## Changes

- **2026-08-06** `e67df5d1f74e`: 2 info
  - api tag `Model Services API Keys (AI Data Plane)` added
  - api tag `Model Services API Keys (AI Services)` removed

[Operation history](https://skmtc.dev/couchbase/apis/couchbase-capella-management-api/changes/v4/organizations/:organizationId/aiServices/models/apiKeys/get.md)

---

[API](https://skmtc.dev/couchbase/apis/couchbase-capella-management-api.md) - [All operations](https://skmtc.dev/couchbase/apis/couchbase-capella-management-api/llms.txt) - [OpenAPI document](https://skmtc.dev/couchbase/apis/couchbase-capella-management-api/revisions/a5e88bcf71cb?raw)