---
title: "List CMEKs"
url: "https://nov18-dev.movespot.fyi/apis/konnect-cmek-and-blob-apis-dev-0/versions/be120259-f6de-46d4-a791-efcd897c286c/operations/list-cmeks"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/konnect-cmek-and-blob-apis-dev-0/versions/be120259-f6de-46d4-a791-efcd897c286c.md

# List CMEKs

`GET` `/cmeks`

Operation ID: `list-cmeks`

List customer managed encryption keys

## Query parameters

- `page[size]` (integer, optional) - The maximum number of items to include per page. The last page of a collection may include fewer items.
- `page[after]` (string, optional) - Request the next page of data, starting with the item after this parameter.
- `page[before]` (string, optional) - Request the next page of data, starting with the item before this parameter.
- `filter` (object, optional) - Filter CMEKs returned in the response.

## Responses

- `200` - Response for CMEK listing

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Konnect CMEK and Blob APIs
  version: 0.0.1
servers:
  - url: https://us.api.konghq.com/v0
    description: United-States Production region
  - url: https://eu.api.konghq.com/v0
    description: Europe Production region
  - url: https://au.api.konghq.com/v0
    description: Australia Production region
  - url: https://me.api.konghq.com/v0
    description: Middle-East Production region
  - url: https://in.api.konghq.com/v0
    description: India Production region
  - url: https://sg.api.konghq.com/v0
    description: Singapore Production region
paths:
  /cmeks:
    get:
      operationId: list-cmeks
      summary: List CMEKs
      description: List customer managed encryption keys
      parameters:
        - $ref: "#/components/parameters/PageSize"
        - $ref: "#/components/parameters/PageAfter"
        - $ref: "#/components/parameters/PageBefore"
        - name: filter
          in: query
          description: Filter CMEKs returned in the response.
          required: false
          schema:
            type: object
            properties:
              name:
                $ref: "#/components/schemas/LegacyStringFieldFilter"
          style: deepObject
      responses:
        "200":
          $ref: "#/components/responses/CMEKCollection"
      tags:
        - CMEK
security:
  - personalAccessToken: []
  - systemAccountAccessToken: []
components:
  parameters:
    PageSize:
      name: page[size]
      description: The maximum number of items to include per page. The last page of a
        collection may include fewer items.
      required: false
      in: query
      allowEmptyValue: true
      schema:
        type: integer
        example: 10
    PageAfter:
      name: page[after]
      description: Request the next page of data, starting with the item after this
        parameter.
      required: false
      in: query
      allowEmptyValue: true
      schema:
        type: string
        example: ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ
    PageBefore:
      name: page[before]
      description: Request the next page of data, starting with the item before this
        parameter.
      required: false
      in: query
      allowEmptyValue: true
      schema:
        type: string
        example: ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ
  schemas:
    LegacyStringFieldFilter:
      description: Filter a string value field either by exact match or partial contains.
      oneOf:
        - $ref: "#/components/schemas/StringFieldEqualsFilter"
        - $ref: "#/components/schemas/StringFieldContainsFilter"
      title: StringFieldFilter
    StringFieldEqualsFilter:
      description: Filters on the given string field value by exact match.
      oneOf:
        - type: string
        - type: object
          title: StringFieldEqualsComparison
          additionalProperties: false
          properties:
            eq:
              type: string
          required:
            - eq
      title: StringFieldEqualsFilter
      x-examples:
        example-1: equals-some-value
        example-2:
          eq: some-value
    StringFieldContainsFilter:
      description: Filters on the given string field value by fuzzy match.
      type: object
      properties:
        contains:
          type: string
      additionalProperties: false
      required:
        - contains
      title: StringFieldContainsFilter
      x-examples:
        example-1:
          contains: some-value
    ListCMEKs:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: "#/components/schemas/CMEK"
        meta:
          $ref: "#/components/schemas/CursorMeta"
      required:
        - data
        - meta
    CMEK:
      type: object
      properties:
        id:
          type: string
        key_arn:
          description: The ARN of the KMS key to use for encryption
          type: string
          example: arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
        name:
          type: string
        description:
          type: string
        created_at:
          $ref: "#/components/schemas/CreatedAt"
        updated_at:
          $ref: "#/components/schemas/UpdatedAt"
      required:
        - id
        - key_arn
        - name
        - created_at
        - updated_at
    CursorMeta:
      description: Pagination metadata.
      type: object
      properties:
        page:
          $ref: "#/components/schemas/CursorMetaPage"
      required:
        - page
    CreatedAt:
      description: An ISO-8601 timestamp representation of entity creation date.
      type: string
      format: date-time
      example: 2022-11-04T20:10:06.927Z
      readOnly: true
    UpdatedAt:
      description: An ISO-8601 timestamp representation of entity update date.
      type: string
      format: date-time
      example: 2022-11-04T20:10:06.927Z
      readOnly: true
    CursorMetaPage:
      type: object
      properties:
        first:
          description: URI to the first page
          type: string
          format: path
        last:
          description: URI to the last page
          type: string
          format: path
        next:
          description: URI to the next page
          type: string
          format: path
          nullable: true
        previous:
          description: URI to the previous page
          type: string
          format: path
          nullable: true
        size:
          description: Requested page size
          type: number
          example: 10
      required:
        - size
        - next
        - previous
  responses:
    CMEKCollection:
      description: Response for CMEK listing
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/ListCMEKs"
          examples:
            CMEK Collection:
              $ref: "#/components/examples/CMEKCollection"
  examples:
    CMEKCollection:
      value:
        data:
          - id: default
            name: My KMS Key
            description: My Key Description
            key_arn: arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
            created_at: 2023-03-20T09:29:14.52Z
            updated_at: 2023-03-21T09:29:14.52Z
          - id: alt-key
            name: Alternative KMS Key
            description: My Other Key
            key_arn: arn:aws:kms:us-east-1:123456789012:key/62ab5b30-aa25-4903-be45-b6c696f75fe9
            created_at: 2024-02-20T09:29:14.52Z
            updated_at: 2024-02-21T09:29:14.52Z
        meta:
          page:
            next: /v0/cmeks?page%5Bafter%5D=f11CXlAMGEVFB0AEQw19QhNYMV5CCkFYSltZUFgPSBJHFwwWFg%3D%3D&page%5Bsize%5=1
            previous: /v0/cmeks?page%5Bbefore%5D=dl8UWVYPEUZFA0sHQw19EUVYMV5BDhcISl1WWVgNQRBBS1gSFw%3D%3D&page%5Bsize%5D=1
            size: 10
  securitySchemes:
    personalAccessToken:
      type: http
      scheme: bearer
      bearerFormat: Token
      description: >
        The personal access token is meant to be used as an alternative to
        basic-auth when accessing Konnect via APIs.

        You can generate a Personal Access Token (PAT) from the [personal access
        token page](https://cloud.konghq.com/global/account/tokens/) in the
        Konnect dashboard.

        The PAT token must be passed in the header of a request, for example:

        `curl -X GET 'https://global.api.konghq.com/v2/users/' --header
        'Authorization: Bearer kpat_xgfT...'`
    systemAccountAccessToken:
      type: http
      scheme: bearer
      bearerFormat: Token
      description: >
        The system account access token is meant for automations and
        integrations that are not directly associated with a human identity.

        You can generate a system account Access Token by creating a system
        account and then obtaining a system account access token for that
        account.

        The access token must be passed in the header of a request, for example:

        `curl -X GET 'https://global.api.konghq.com/v2/users/' --header
        'Authorization: Bearer spat_i2Ej...'`
```
