---
title: "Get a realm"
url: "https://nov18-dev.movespot.fyi/apis/konnect-regional-consumers-auth-api-dev-0/versions/192f3a87-bed4-44a6-8a07-738cc91d6a11/operations/retrieve-realm"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/konnect-regional-consumers-auth-api-dev-0/versions/192f3a87-bed4-44a6-8a07-738cc91d6a11.md

# Get a realm

`GET` `/{realmId}/v1`

Operation ID: `retrieve-realm`

## Path parameters

- `realmId` (string, uuid, required) - ID of the realm

## Responses

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

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Konnect regional consumers auth api
  version: 0.0.1
servers:
  - url: https://us.api.konghq.com
    description: United-States Production region
  - url: https://eu.api.konghq.com
    description: Europe Production region
  - url: https://au.api.konghq.com
    description: Australia Production region
  - url: https://me.api.konghq.com
    description: Middle-East Production region
  - url: https://in.api.konghq.com
    description: India Production region
  - url: https://sg.api.konghq.com
    description: Singapore Production region
paths:
  /{realmId}/v1:
    parameters:
      - $ref: "#/components/parameters/realmId"
    get:
      operationId: retrieve-realm
      summary: Get a realm
      responses:
        "200":
          description: success
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/AuthConsumerRealm"
        "404":
          $ref: "#/components/responses/NotFound"
      tags:
        - realms
components:
  parameters:
    realmId:
      name: realmId
      in: path
      required: true
      description: ID of the realm
      schema:
        type: string
        format: uuid
  schemas:
    AuthConsumerRealm:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        ttl:
          type: integer
        negative_ttl:
          type: integer
        consumer_groups:
          $ref: "#/components/schemas/ConsumerGroups"
      required:
        - id
        - name
        - ttl
        - negative_ttl
        - consumer_groups
    ConsumerGroups:
      description: >
        A list of consumer groups that the Consumer is in.

        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
      title: ConsumerGroups
    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
  responses:
    NotFound:
      description: Not Found
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/NotFoundError"
          examples:
            NotFoundExample:
              $ref: "#/components/examples/NotFoundExample"
  examples:
    NotFoundExample:
      value:
        status: 404
        title: Not Found
        instance: kong:trace:6816496025408232265
        detail: Not Found
```
