openapi: 3.2.0
info:
  contact:
    email: support@akeyless.io
    name: Akeyless
    url: http://akeyless.io
  description: The purpose of this application is to provide access to Akeyless API.
  title: Akeyless Create Key API
  version: '2.0'
servers:
- url: https://api.akeyless.io/
tags:
- name: Create Key
paths:
  /create-key:
    post:
      operationId: createKey
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/createKey'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/createKeyOutput'
          description: createKeyResponse wraps response body.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JSONError'
          description: 'errorResponse wraps any error to return it as a JSON object with one "error"

            field.'
      tags:
      - Create Key
      x-codegen-request-body-name: body
      summary: Create key
      x-summary-source: derived
components:
  schemas:
    Duration:
      description: 'A Duration represents the elapsed time between two instants

        as an int64 nanosecond count. The representation limits the

        largest representable duration to approximately 290 years.'
      format: int64
      type: integer
      x-go-package: time
    createKey:
      description: 'createKey is a command that creates a new key. [Deprecated: Use command create-dfc-key]'
      properties:
        alg:
          description: 'Key type; options: [AES128GCM, AES256GCM, AES128SIV, AES256SIV, AES128CBC, AES256CBC, RSA1024,

            RSA2048, RSA3072, RSA4096]'
          type: string
          x-go-name: Alg
        customer-frg-id:
          description: 'The customer fragment ID that will be used to create the key (if empty,

            the key will be created independently of a customer fragment)'
          type: string
          x-go-name: CustomerFragmentID
        delete_protection:
          description: Protection from accidental deletion of this item
          type: string
          x-go-name: ItemProtected
        description:
          description: Description of the object
          type: string
          x-go-name: Description
        json:
          description: Set output format to JSON
          type: boolean
          x-go-name: Json
        metadata:
          description: Deprecated - use description
          type: string
          x-go-name: Metadata
        name:
          description: Key name
          type: string
          x-go-name: KeyName
        split-level:
          default: 2
          description: 'The number of fragments that the item will be split into (not includes

            customer fragment)'
          format: int64
          type: integer
          x-go-name: SplitLevel
        tag:
          description: List of the tags attached to this key
          items:
            type: string
          type: array
          x-go-name: Tags
        token:
          description: Authentication token (see `/auth` and `/configure`)
          type: string
          x-go-name: Profile
        uid-token:
          description: The universal identity token, Required only for universal_identity authentication
          type: string
          x-go-name: UIDToken
      required:
      - alg
      - name
      type: object
      x-go-package: akeyless.io/akeyless-main-repo/go/src/client/commands
    createKeyOutput:
      example:
        display_id: display_id
        item_id: 0
        fragment_results:
        - null
        - null
      properties:
        display_id:
          type: string
          x-go-name: DisplayId
        fragment_results:
          items:
            $ref: '#/components/schemas/Duration'
          type: array
          x-go-name: FragmentResults
        item_id:
          format: int64
          type: integer
          x-go-name: ItemId
      type: object
      x-go-package: akeyless.io/akeyless-main-repo/go/src/client/commands
    JSONError:
      properties:
        error:
          type: string
          x-go-name: Err
      title: JSONError wraps an error with JSON object.
      type: object
      x-go-package: akeyless.io/akeyless-main-repo/go/src/client