---
title: "List realms"
url: "https://nov18-dev.movespot.fyi/apis/konnect-centrally-managed-consumers-admin-api-0/versions/84f5e371-6d0e-45b1-b943-fe4dc428c317/operations/list-realms"
---

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

# List realms

`GET` `/realms`

Operation ID: `list-realms`

List all available realms. The full configuration of each Realm is returned under the `data` key

## 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[before]` (string, optional) - Request the next page of data, starting with the item before this parameter.
- `page[after]` (string, optional) - Request the next page of data, starting with the item after this parameter.

## Responses

- `200` - success

## 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:
    get:
      operationId: list-realms
      summary: List realms
      description: >
        List all available realms. The full configuration of each Realm is
        returned under the `data` key
      parameters:
        - $ref: "#/components/parameters/PageSize"
        - $ref: "#/components/parameters/PageBefore"
        - $ref: "#/components/parameters/PageAfter"
      responses:
        "200":
          description: success
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListRealms"
              examples:
                ListRealms:
                  $ref: "#/components/examples/ListRealms"
      tags:
        - Realms
security:
  - systemAccountAccessToken: []
  - personalAccessToken: []
  - konnectAccessToken: []
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
    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
    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
  schemas:
    ListRealms:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: "#/components/schemas/ConsumerRealm"
        meta:
          $ref: "#/components/schemas/CursorMeta"
      required:
        - data
        - meta
    ConsumerRealm:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        ttl:
          $ref: "#/components/schemas/RealmTTL"
        negative_ttl:
          $ref: "#/components/schemas/NegativeTTL"
        consumer_groups:
          $ref: "#/components/schemas/RealmConsumerGroups"
        allowed_control_planes:
          $ref: "#/components/schemas/AllowedControlPlanes"
        allow_all_control_planes:
          $ref: "#/components/schemas/AllowAllControlPlanes"
        created_at:
          $ref: "#/components/schemas/CreatedAt"
        updated_at:
          $ref: "#/components/schemas/UpdatedAt"
      required:
        - id
        - name
        - allowed_control_planes
        - allow_all_control_planes
        - ttl
        - negative_ttl
        - consumer_groups
        - created_at
        - updated_at
    CursorMeta:
      description: Pagination metadata.
      type: object
      properties:
        page:
          $ref: "#/components/schemas/CursorMetaPage"
      required:
        - page
    RealmTTL:
      description: >
        The time in minutes that the Consumer will be cached in memory on a
        running Gateway if it is

        successfully loaded from Konnect.
      type: integer
      default: 10
      minimum: 5
    NegativeTTL:
      description: >
        If a running Gateway triggers a lookup for a Consumer that cannot be
        authenticated this realm, a `negative_ttl`

        is set. The Gateway will not try to lookup the Consumer in Konnect for
        `negative_ttl` minutes.


        A Consumer will be cached for `negative_ttl` if they do not exist in the
        Realm, or if the provided credentials

        are invalid.
      type: integer
      default: 10
      minimum: 5
    RealmConsumerGroups:
      description: >
        A list of consumer groups to automatically add to any consumers created
        within this Realm.

        If `consumer_groups` are provided on the Consumer object _and_ on the
        Realm, the Consumer will be placed in all defined consumer groups.
      type: array
      items:
        type: string
        uniqueItems: true
      format: set
      title: RealmConsumerGroups
    AllowedControlPlanes:
      description: >
        List of control plane ids that are allowed to use the realm. This is
        used when `allow_all_control_planes` value

        is set to false.
      type: array
      items:
        type: string
        uniqueItems: true
      format: set
    AllowAllControlPlanes:
      description: >
        Allow all control planes to use the realm. When this value is set it
        takes precedence on `allowed_control_planes`.
      type: boolean
      nullable: false
    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
  examples:
    ListRealms:
      value:
        data:
          - id: 2cec70a4-d197-495c-8f3e-c0a1199d1da4
            name: Jason
            ttl: 15
            negative_ttl: 10
            consumer_groups:
              - api-developer
            allowed_control_planes:
              - 55ec70a4-d197-495c-8f3e-c0a1199d1da4
            allow_all_control_planes: false
            created_at: 2023-03-20T09:29:14.52Z
            updated_at: 2023-03-21T09:29:14.52Z
        meta:
          page:
            size: 1
            previous: null
            next: /v1/realms?page%5Bafter%5D=f1kZXVdYF0VFUEcBGA1%2BGUEAMV5CDBRYSlwKUF9fHRREQ10XFQ%3D%3D
  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.
```
