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

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

# Vault

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.

## 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
components:
  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
```
