---
title: "Get a key"
url: "https://nov18-dev.movespot.fyi/apis/konnect-centrally-managed-consumers-admin-api-0/versions/84f5e371-6d0e-45b1-b943-fe4dc428c317/operations/get-consumer-key"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/konnect-centrally-managed-consumers-admin-api-0/versions/84f5e371-6d0e-45b1-b943-fe4dc428c317.md

# Get a key

`GET` `/realms/{realmId}/consumers/{consumerId}/keys/{keyId}`

Operation ID: `get-consumer-key`

Returns the key entity. This operation does **NOT** return the key itself. The key is only available at the time of creation.

## Path parameters

- `realmId` (string, uuid, required) - ID of the realm
- `consumerId` (string, required) - ID of the of the consumer
- `keyId` (string, required) - ID of the key

## Responses

- `200` - success
- `404` - Not Found

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Konnect Centrally Managed Consumers admin api
  version: 0.0.1
servers:
  - url: https://us.api.konghq.com/v1
    description: United-States Production region
  - url: https://eu.api.konghq.com/v1
    description: Europe Production region
  - url: https://au.api.konghq.com/v1
    description: Australia Production region
  - url: https://me.api.konghq.com/v1
    description: Middle-East Production region
  - url: https://in.api.konghq.com/v1
    description: India Production region
  - url: https://sg.api.konghq.com/v1
    description: Singapore Production region
paths:
  /realms/{realmId}/consumers/{consumerId}/keys/{keyId}:
    parameters:
      - $ref: "#/components/parameters/realmId"
      - $ref: "#/components/parameters/consumerId"
      - $ref: "#/components/parameters/keyId"
    get:
      operationId: get-consumer-key
      summary: Get a key
      description: >
        Returns the key entity. This operation does **NOT** return the key
        itself. The key is only available at the time of creation.
      responses:
        "200":
          description: success
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiKey"
              examples:
                ApiKey:
                  $ref: "#/components/examples/ApiKey"
        "404":
          $ref: "#/components/responses/NotFound"
      tags:
        - Centrally Managed Keys
security:
  - systemAccountAccessToken: []
  - personalAccessToken: []
  - konnectAccessToken: []
components:
  parameters:
    realmId:
      name: realmId
      in: path
      required: true
      description: ID of the realm
      schema:
        type: string
        format: uuid
    consumerId:
      name: consumerId
      in: path
      required: true
      description: ID of the of the consumer
      schema:
        type: string
    keyId:
      name: keyId
      in: path
      required: true
      description: ID of the key
      schema:
        type: string
  schemas:
    ApiKey:
      type: object
      properties:
        id:
          type: string
        created_at:
          $ref: "#/components/schemas/CreatedAt"
        tags:
          $ref: "#/components/schemas/Tags"
        type:
          $ref: "#/components/schemas/KeyTypeEnum"
      required:
        - id
        - created_at
        - type
        - tags
    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
    Tags:
      type: array
      items:
        type: string
      uniqueItems: true
    KeyTypeEnum:
      type: string
      enum:
        - legacy
        - new
    NotFoundError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 404
            title:
              example: Not Found
            type:
              example: https://httpstatuses.com/404
            instance:
              example: kong:trace:1234567890
            detail:
              example: Not found
    BaseError:
      description: standard error
      type: object
      properties:
        status:
          description: >
            The HTTP status code of the error. Useful when passing the response

            body to child properties in a frontend UI. Must be returned as an
            integer.
          type: integer
          readOnly: true
        title:
          description: |
            A short, human-readable summary of the problem. It should not
            change between occurences of a problem, except for localization.
            Should be provided as "Sentence case" for direct use in the UI.
          type: string
          readOnly: true
        type:
          description: The error type.
          type: string
          readOnly: true
        instance:
          description: |
            Used to return the correlation ID back to the user, in the format
            kong:trace:<correlation_id>. This helps us find the relevant logs
            when a customer reports an issue.
          type: string
          readOnly: true
        detail:
          description: >
            A human readable explanation specific to this occurence of the
            problem.

            This field may contain request/entity data to help the user
            understand

            what went wrong. Enclose variable values in square brackets. Should
            be

            provided as "Sentence case" for direct use in the UI.
          type: string
          readOnly: true
      required:
        - status
        - title
        - instance
        - detail
      title: Error
  examples:
    ApiKey:
      value:
        id: 2cec70a4-d197-495c-8f3e-c0a1199d1da4
        created_at: 2023-03-20T09:29:14.52Z
        tags:
          - one
          - two
        type: new
    NotFoundExample:
      value:
        status: 404
        title: Not Found
        instance: kong:trace:6816496025408232265
        detail: Not Found
  responses:
    NotFound:
      description: Not Found
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/NotFoundError"
          examples:
            NotFoundExample:
              $ref: "#/components/examples/NotFoundExample"
  securitySchemes:
    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...'`
    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...'`
    konnectAccessToken:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        The Konnect access token is meant to be used by the Konnect dashboard
        and the decK CLI authenticate with.
```
