---
title: "Create encryption material"
url: "https://nov18-dev.movespot.fyi/apis/konnect-cmek-and-blob-apis-dev-0/versions/be120259-f6de-46d4-a791-efcd897c286c/operations/create-encryption-material"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/konnect-cmek-and-blob-apis-dev-0/versions/be120259-f6de-46d4-a791-efcd897c286c.md

# Create encryption material

`POST` `/materials/encryption`

Operation ID: `create-encryption-material`

Create encryption material for in-app encryption

## Header parameters

- `X-Konnect-CMEK-Id` (string, optional) - The CMEK ID to use for encryption and decryption

## Responses

- `201` - Response for encryption material
- `400` - Bad Request

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Konnect CMEK and Blob APIs
  version: 0.0.1
servers:
  - url: https://us.api.konghq.com/v0
    description: United-States Production region
  - url: https://eu.api.konghq.com/v0
    description: Europe Production region
  - url: https://au.api.konghq.com/v0
    description: Australia Production region
  - url: https://me.api.konghq.com/v0
    description: Middle-East Production region
  - url: https://in.api.konghq.com/v0
    description: India Production region
  - url: https://sg.api.konghq.com/v0
    description: Singapore Production region
paths:
  /materials/encryption:
    post:
      operationId: create-encryption-material
      summary: Create encryption material
      description: Create encryption material for in-app encryption
      parameters:
        - $ref: "#/components/parameters/xKonnectCMEKId"
      responses:
        "201":
          $ref: "#/components/responses/EncryptionMaterial"
        "400":
          $ref: "#/components/responses/BadRequest"
      tags:
        - Envelope Encryption
security:
  - personalAccessToken: []
  - systemAccountAccessToken: []
components:
  parameters:
    xKonnectCMEKId:
      name: X-Konnect-CMEK-Id
      in: header
      description: The CMEK ID to use for encryption and decryption
      required: false
      schema:
        type: string
        default: default
  responses:
    EncryptionMaterial:
      description: Response for encryption material
      content:
        application/json:
          schema:
            type: object
            properties:
              encrypted_data_key:
                description: The encrypted data key used for encryption, base64 encoded. This
                  key is used to retrieve the plaintext data key for decryption
                  and should be stored along with the encrypted data.
                type: string
                example: ZW5jcnlwdGlvbi1rZXk=
              plaintext_data_key:
                description: The plaintext data key used for encryption, base64 encoded. This
                  key is used to encrypt the data key and should be thrown away
                  after use.
                type: string
                example: ZGVjcnlwdGlvbi1tYXRlcmlhbA==
            required:
              - encrypted_data_key
              - plaintext_data_key
    BadRequest:
      description: Bad Request
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/BadRequestError"
  schemas:
    BadRequestError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          required:
            - invalid_parameters
          properties:
            invalid_parameters:
              $ref: "#/components/schemas/InvalidParameters"
    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
    InvalidParameters:
      description: invalid parameters
      type: array
      items:
        oneOf:
          - $ref: "#/components/schemas/InvalidParameterStandard"
          - $ref: "#/components/schemas/InvalidParameterMinimumLength"
          - $ref: "#/components/schemas/InvalidParameterMaximumLength"
          - $ref: "#/components/schemas/InvalidParameterChoiceItem"
          - $ref: "#/components/schemas/InvalidParameterDependentItem"
      minItems: 1
      nullable: false
      uniqueItems: true
    InvalidParameterStandard:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          $ref: "#/components/schemas/InvalidRules"
        source:
          type: string
          example: body
        reason:
          type: string
          example: is a required field
          readOnly: true
      additionalProperties: false
      required:
        - field
        - reason
    InvalidParameterMinimumLength:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - min_length
            - min_digits
            - min_lowercase
            - min_uppercase
            - min_symbols
            - min_items
            - min
          nullable: false
          readOnly: true
        minimum:
          type: integer
          example: 8
        source:
          type: string
          example: body
        reason:
          type: string
          example: must have at least 8 characters
          readOnly: true
      additionalProperties: false
      required:
        - field
        - reason
        - rule
        - minimum
    InvalidParameterMaximumLength:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - max_length
            - max_items
            - max
          nullable: false
          readOnly: true
        maximum:
          type: integer
          example: 8
        source:
          type: string
          example: body
        reason:
          type: string
          example: must not have more than 8 characters
          readOnly: true
      additionalProperties: false
      required:
        - field
        - reason
        - rule
        - maximum
    InvalidParameterChoiceItem:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - enum
          nullable: false
          readOnly: true
        reason:
          type: string
          example: is a required field
          readOnly: true
        choices:
          type: array
          items: {}
          minItems: 1
          nullable: false
          readOnly: true
          uniqueItems: true
        source:
          type: string
          example: body
      additionalProperties: false
      required:
        - field
        - reason
        - rule
        - choices
    InvalidParameterDependentItem:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - dependent_fields
          nullable: true
          readOnly: true
        reason:
          type: string
          example: is a required field
          readOnly: true
        dependents:
          type: array
          items: {}
          nullable: true
          readOnly: true
          uniqueItems: true
        source:
          type: string
          example: body
      additionalProperties: false
      required:
        - field
        - rule
        - reason
        - dependents
    InvalidRules:
      description: invalid parameters rules
      type: string
      enum:
        - required
        - is_array
        - is_base64
        - is_boolean
        - is_date_time
        - is_integer
        - is_null
        - is_number
        - is_object
        - is_string
        - is_uuid
        - is_fqdn
        - is_arn
        - unknown_property
        - missing_reference
        - is_label
        - matches_regex
        - invalid
        - is_supported_network_availability_zone_list
        - is_supported_network_cidr_block
        - is_supported_provider_region
        - type
      nullable: true
      readOnly: true
  securitySchemes:
    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...'`
    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...'`
```
