---
title: "Get a Vault"
url: "https://nov18-dev.movespot.fyi/apis/konnect-runtime-groups-configuration-0/versions/af18902c-58f1-49d7-8ec2-9987b4e0d1bd/operations/get-vault"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/konnect-runtime-groups-configuration-0/versions/af18902c-58f1-49d7-8ec2-9987b4e0d1bd.md

# Get a Vault

`GET` `/runtime-groups/{runtimeGroupId}/core-entities/vaults/{vault_id_or_prefix}`

Operation ID: `get-vault`

Get a Vault using ID or prefix. Vault entities are used to configure different Vault connectors.

## Path parameters

- `vault_id_or_prefix` (string, required) - The unique identifier or the prefix of the Vault to retrieve.
- `runtimeGroupId` (string, required) - The ID of your runtime group. This variable is available in the Konnect manager

## Query parameters

- `offset` (string, optional) - Offset from which to return the next set of resources. Use the value of the 'offset' field from the response of a list operation as input here to paginate through all the resources
- `size` (integer, optional) - Number of resources to be returned.
- `tags` (string, optional) - A list of tags to filter the list of resources on. Multiple tags can be concatenated using ',' to mean AND or using '/' to mean OR.

## Responses

- `200` - Successfully fetched Vault
- `404` - Resource does not exist

## OpenAPI definition

```yaml
openapi: 3.0.0
info:
  title: Konnect Runtime Groups Configuration
  version: 0.0.1
servers:
  - url: https://us.api.konghq.com/v2
    description: United-States Production region
  - url: https://eu.api.konghq.com/v2
    description: Europe Production region
  - url: https://au.api.konghq.com/v2
    description: Australia Production region
  - url: https://me.api.konghq.com/v2
    description: Middle-East Production region
  - url: https://in.api.konghq.com/v2
    description: India Production region
  - url: https://sg.api.konghq.com/v2
    description: Singapore Production region
paths:
  /runtime-groups/{runtimeGroupId}/core-entities/vaults/{vault_id_or_prefix}:
    parameters:
      - $ref: "#/components/parameters/vault_id_or_prefix"
      - $ref: "#/components/parameters/runtimeGroupId"
    get:
      operationId: get-vault
      summary: Get a Vault
      description: |-
        Get a Vault using ID or prefix.

        Vault entities are used to configure different Vault connectors.
      parameters:
        - $ref: "#/components/parameters/pagination-offset"
        - $ref: "#/components/parameters/pagination-size"
        - $ref: "#/components/parameters/pagination-tags-filter"
      responses:
        "200":
          description: Successfully fetched Vault
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Vault"
        "404":
          description: Resource does not exist
      tags:
        - Vaults
security:
  - konnectAccessToken: []
  - personalAccessToken: []
components:
  parameters:
    vault_id_or_prefix:
      name: vault_id_or_prefix
      in: path
      required: true
      schema:
        type: string
        example: env
      description: The unique identifier or the prefix of the Vault to retrieve.
    runtimeGroupId:
      name: runtimeGroupId
      in: path
      required: true
      schema:
        type: string
        example: 9524ec7d-36d9-465d-a8c5-83a3c9390458
      description: The ID of your runtime group. This variable is available in the
        Konnect manager
    pagination-offset:
      description: Offset from which to return the next set of resources. Use the
        value of the 'offset' field from the response of a list operation as
        input here to paginate through all the resources
      in: query
      name: offset
      schema:
        type: string
    pagination-size:
      description: Number of resources to be returned.
      in: query
      name: size
      schema:
        type: integer
        default: 100
        maximum: 1000
        minimum: 1
    pagination-tags-filter:
      description: A list of tags to filter the list of resources on. Multiple tags
        can be concatenated using ',' to mean AND or using '/' to mean OR.
      example: tag1,tag2
      in: query
      name: tags
      schema:
        type: string
  schemas:
    Vault:
      description: Vault entities are used to configure different Vault connectors.
        Examples of Vaults are Environment Variables, Hashicorp Vault and AWS
        Secrets Manager. Configuring a Vault allows referencing the secrets with
        other entities. For example a certificate entity can store a reference
        to a certificate and key, stored in a vault, instead of storing the
        certificate and key within the entity. This allows a proper separation
        of secrets and configuration and prevents secret sprawl.
      type: object
      properties:
        config:
          description: The configuration properties for the Vault which can be found on
            the vaults' documentation page.
          type: object
        created_at:
          description: Unix epoch when the resource was created.
          type: integer
          example: 1422386534
        description:
          description: The description of the Vault entity.
          type: string
          example: This vault is used to retrieve redis database access credentials
        id:
          type: string
          example: B2A30E8F-C542-49CF-8015-FB674987D1A5
        name:
          description: The name of the Vault that's going to be added. Currently, the
            Vault implementation must be installed in every Kong instance.
          type: string
          example: env
        prefix:
          description: The unique prefix (or identifier) for this Vault configuration. The
            prefix is used to load the right Vault configuration and
            implementation when referencing secrets with the other entities.
          type: string
          example: env
        tags:
          description: An optional set of strings associated with the Vault for grouping
            and filtering.
          type: array
          items:
            type: string
            example: database-credentials
        updated_at:
          description: Unix epoch when the resource was last updated.
          type: integer
          example: 1422386534
      example:
        config:
          prefix: ENV_PREFIX
        description: environment variable based vault
        id: 2747d1e5-8246-4f65-a939-b392f1ee17f8
        name: env
        tags:
          - foo
          - bar
      x-examples:
        Example Vault:
          id: B2A30E8F-C542-49CF-8015-FB674987D1A5
          prefix: env
          name: env
          description: This vault is used to retrieve redis database access credentials
          config:
            prefix: SSL_
          created_at: 1422386534
          updated_at: 1422386534
          tags:
            - database-credentials
            - data-plane
  securitySchemes:
    konnectAccessToken:
      type: http
      scheme: bearer
      description: >-
        The Konnect access token is meant to be used by the Konnect dashboard
        and the decK CLI to

        authenticate with.
    personalAccessToken:
      type: http
      scheme: bearer
      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 in the Konnect
        dashboard.
```
