openapi: 3.1.0
info:
  title: Infinidat InfiniBox REST API (7.3)
  version: '7.3'
  summary: Management REST API served by every InfiniBox / InfiniBox SSA array.
  description: 'Derived faithfully from Infinidat''s own published Postman collection for the InfiniBox 7.3 API (https://github.com/Infinidat/api_7_3).
    The InfiniBox REST API is served by each array on-premises at https://<infinibox-host>/api/rest, so there is no single
    public base URL; the server below is a template. Operations, paths, parameters, request bodies and example responses are
    carried over verbatim from the collection - nothing has been invented. This is a partial surface: the collection carries
    47 requests (46 against the array, one external Okta SSO redirect), which normalize to 40 operations across 38 paths.
    The full InfiniAPI surface documented on support.infinidat.com is larger.'
  contact:
    name: INFINIDAT Support
    url: https://support.infinidat.com/hc/en-us
  x-derived-from: postman/infinidat-infinibox-7-3-postman.json
  x-derivation-method: derived
servers:
- url: https://{infinibox_host}/api/rest
  description: The management API of a single InfiniBox array (the collection's {{sutURI}} variable).
  variables:
    infinibox_host:
      default: infinibox.example.com
      description: Hostname or management IP of the InfiniBox system.
security:
- basicAuth: []
- sessionCookie: []
components:
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic authentication with an InfiniBox user, as used by InfiniSDK.
    sessionCookie:
      type: apiKey
      in: cookie
      name: sessionid
      description: Session established by POST /users/login and torn down by POST /users/logout.
  schemas:
    InfiniBoxEnvelope:
      type: object
      description: Standard InfiniBox response envelope observed in the collection's saved examples.
      properties:
        result:
          description: The requested object or array of objects.
        metadata:
          $ref: '#/components/schemas/InfiniBoxMetadata'
        error:
          oneOf:
          - type: 'null'
          - $ref: '#/components/schemas/InfiniBoxError'
    InfiniBoxMetadata:
      type: object
      description: Pagination / readiness metadata returned alongside every result.
      properties:
        ready:
          type: boolean
        number_of_objects:
          type: integer
        page:
          type: integer
        page_size:
          type: integer
        pages_total:
          type: integer
    InfiniBoxError:
      type: object
      description: Error object carried on the envelope's error field.
      properties:
        code:
          type: string
        message:
          type: string
        severity:
          type: string
        reasons:
          type: array
          items:
            type: string
  parameters:
    page:
      name: page
      in: query
      required: false
      schema:
        type: integer
        default: 1
      description: 1-based page number (InfiniSDK efficient-querying guide).
    page_size:
      name: page_size
      in: query
      required: false
      schema:
        type: integer
        default: 50
        maximum: 1000
      description: Objects per page; default 50, maximum 1000.
    fields:
      name: fields
      in: query
      required: false
      schema:
        type: string
      description: Comma-separated list of fields to return.
    sort:
      name: sort
      in: query
      required: false
      schema:
        type: string
      description: Field to sort by; prefix with - to reverse.
paths:
  /components:
    get:
      operationId: componentsGet
      summary: COMPONENTS Get
      tags:
      - components
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InfiniBoxEnvelope'
        '401':
          description: Unauthenticated. The session is missing, expired or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InfiniBoxError'
      parameters:
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/page_size'
      - $ref: '#/components/parameters/fields'
      - $ref: '#/components/parameters/sort'
  /components/racks/{rack_id}/nodes:
    get:
      operationId: nodeGetNodes
      summary: NODE Get Nodes
      tags:
      - components
      parameters:
      - name: rack_id
        in: path
        required: true
        schema:
          type: string
        description: Path variable carried verbatim from the InfiniBox 7.3 Postman collection.
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/page_size'
      - $ref: '#/components/parameters/fields'
      - $ref: '#/components/parameters/sort'
      responses:
        '200':
          description: NODE Get Nodes (saved example omitted here for size; see postman/infinidat-infinibox-7-3-postman.json)
        '401':
          description: Unauthenticated. The session is missing, expired or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InfiniBoxError'
  /components/racks/{rack_id}/nodes/{node_id}:
    get:
      operationId: nodeGetNode
      summary: NODE Get Node
      tags:
      - components
      parameters:
      - name: rack_id
        in: path
        required: true
        schema:
          type: string
        description: Path variable carried verbatim from the InfiniBox 7.3 Postman collection.
      - name: node_id
        in: path
        required: true
        schema:
          type: string
        description: Path variable carried verbatim from the InfiniBox 7.3 Postman collection.
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/page_size'
      - $ref: '#/components/parameters/fields'
      - $ref: '#/components/parameters/sort'
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InfiniBoxEnvelope'
        '401':
          description: Unauthenticated. The session is missing, expired or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InfiniBoxError'
      x-collection-aliases:
      - NODE Get Node 1 (Set Active) Copy
      - NODE Get Node 2 (Set Active)
      - NODE Get Node 3 (Set Active)
  /components/racks/{rack_id}/nodes/{node_id}/ib_ports:
    get:
      operationId: nodeAGetIbPorts
      summary: NODE(A) Get Ib Ports
      tags:
      - components
      parameters:
      - name: rack_id
        in: path
        required: true
        schema:
          type: string
        description: Path variable carried verbatim from the InfiniBox 7.3 Postman collection.
      - name: node_id
        in: path
        required: true
        schema:
          type: string
        description: Path variable carried verbatim from the InfiniBox 7.3 Postman collection.
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/page_size'
      - $ref: '#/components/parameters/fields'
      - $ref: '#/components/parameters/sort'
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InfiniBoxEnvelope'
        '401':
          description: Unauthenticated. The session is missing, expired or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InfiniBoxError'
  /components/racks/{rack_id}/nodes/{node_id}/pgs:
    get:
      operationId: nodeAGetPortGroups
      summary: NODE(A) Get Port Groups
      tags:
      - components
      parameters:
      - name: rack_id
        in: path
        required: true
        schema:
          type: string
        description: Path variable carried verbatim from the InfiniBox 7.3 Postman collection.
      - name: node_id
        in: path
        required: true
        schema:
          type: string
        description: Path variable carried verbatim from the InfiniBox 7.3 Postman collection.
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/page_size'
      - $ref: '#/components/parameters/fields'
      - $ref: '#/components/parameters/sort'
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InfiniBoxEnvelope'
        '401':
          description: Unauthenticated. The session is missing, expired or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InfiniBoxError'
  /components/racks/{rack_id}/support_appliances:
    get:
      operationId: saGetAppliances
      summary: SA Get Appliances
      tags:
      - components
      parameters:
      - name: rack_id
        in: path
        required: true
        schema:
          type: string
        description: Path variable carried verbatim from the InfiniBox 7.3 Postman collection.
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/page_size'
      - $ref: '#/components/parameters/fields'
      - $ref: '#/components/parameters/sort'
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InfiniBoxEnvelope'
        '401':
          description: Unauthenticated. The session is missing, expired or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InfiniBoxError'
  /components/racks/{rack_id}/support_appliances/{support_appliance_id}:
    get:
      operationId: saGetFirstAppliance
      summary: SA Get first Appliance
      tags:
      - components
      parameters:
      - name: rack_id
        in: path
        required: true
        schema:
          type: string
        description: Path variable carried verbatim from the InfiniBox 7.3 Postman collection.
      - name: support_appliance_id
        in: path
        required: true
        schema:
          type: string
        description: Path variable carried verbatim from the InfiniBox 7.3 Postman collection.
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/page_size'
      - $ref: '#/components/parameters/fields'
      - $ref: '#/components/parameters/sort'
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InfiniBoxEnvelope'
        '401':
          description: Unauthenticated. The session is missing, expired or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InfiniBoxError'
  /config:
    get:
      operationId: configGet
      summary: CONFIG Get
      tags:
      - config
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InfiniBoxEnvelope'
        '401':
          description: Unauthenticated. The session is missing, expired or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InfiniBoxError'
      parameters:
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/page_size'
      - $ref: '#/components/parameters/fields'
      - $ref: '#/components/parameters/sort'
  /config/ldap:
    post:
      operationId: ldapCreateAUserRepository
      summary: LDAP Create a User Repository
      tags:
      - config
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              name: admin
              bind_username: admin
              bind_password: '123456'
              use_ldaps: true
              ldap_port: 389
              repository_type: LDAP
              servers:
              - infinidat.com
              schema_definition:
                group_class: groupOfNames
                group_memberof_attribute: memberof
                group_name_attribute: cn
                groups_basedn: ''
                user_class: posixAccount
                username_attribute: uid
                users_basedn: ''
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InfiniBoxEnvelope'
        '401':
          description: Unauthenticated. The session is missing, expired or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InfiniBoxError'
  /config/ldap/:
    get:
      operationId: ldapGetRepositories
      summary: LDAP Get Repositories
      tags:
      - config
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InfiniBoxEnvelope'
        '401':
          description: Unauthenticated. The session is missing, expired or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InfiniBoxError'
      parameters:
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/page_size'
      - $ref: '#/components/parameters/fields'
      - $ref: '#/components/parameters/sort'
  /config/ldap/reload:
    post:
      operationId: ldapReload
      summary: LDAP Reload
      tags:
      - config
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InfiniBoxEnvelope'
        '401':
          description: Unauthenticated. The session is missing, expired or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InfiniBoxError'
  /config/ldap/resolve_domain:
    post:
      operationId: ldapResolveDomain
      summary: LDAP Resolve Domain
      tags:
      - config
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InfiniBoxEnvelope'
        '401':
          description: Unauthenticated. The session is missing, expired or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InfiniBoxError'
  /config/ldap/set_order:
    post:
      operationId: ldapReorder
      summary: LDAP Reorder
      tags:
      - config
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example: "[\n    {{ldapIds}}\n]"
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InfiniBoxEnvelope'
        '401':
          description: Unauthenticated. The session is missing, expired or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InfiniBoxError'
  /config/ldap/test:
    post:
      operationId: ldapTestRepositoryComminucation
      summary: LDAP Test Repository Comminucation
      tags:
      - config
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              name: admin
              domain_name: ad2k8r2.local
              bind_username: admin
              bind_password: '123456'
              use_ldaps: false
              ldap_port: 80
              repository_type: ActiveDirectory
              servers:
              - 172.20.84.246
              schema_definition:
                user_class: user
                username_attribute: sAMAccountName
                users_basedn: ''
                group_class: group
                group_name_attribute: cn
                group_memberof_attribute: memberof
                groups_basedn: ''
              id: 33
              search_order: 0
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InfiniBoxEnvelope'
        '401':
          description: Unauthenticated. The session is missing, expired or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InfiniBoxError'
  /config/ldap/{ldap_id}:
    get:
      operationId: ldapGetFirstRepository
      summary: LDAP Get first Repository
      tags:
      - config
      parameters:
      - name: ldap_id
        in: path
        required: true
        schema:
          type: string
        description: Path variable carried verbatim from the InfiniBox 7.3 Postman collection.
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/page_size'
      - $ref: '#/components/parameters/fields'
      - $ref: '#/components/parameters/sort'
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InfiniBoxEnvelope'
        '401':
          description: Unauthenticated. The session is missing, expired or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InfiniBoxError'
    put:
      operationId: ldapUpdateTheRepositoryAttributes
      summary: LDAP Update the repository attributes
      tags:
      - config
      parameters:
      - name: ldap_id
        in: path
        required: true
        schema:
          type: string
        description: Path variable carried verbatim from the InfiniBox 7.3 Postman collection.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              servers:
              - 1.0.0.9
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InfiniBoxEnvelope'
        '401':
          description: Unauthenticated. The session is missing, expired or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InfiniBoxError'
  /config/ldap/{ldap_id}/test:
    post:
      operationId: ldapTestLDAPByID
      summary: LDAP Test LDAP by ID
      tags:
      - config
      parameters:
      - name: ldap_id
        in: path
        required: true
        schema:
          type: string
        description: Path variable carried verbatim from the InfiniBox 7.3 Postman collection.
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InfiniBoxEnvelope'
        '401':
          description: Unauthenticated. The session is missing, expired or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InfiniBoxError'
  /config/ldap/{ldap_id}/test_group:
    post:
      operationId: ldapTestGroupByLDAPID
      summary: LDAP Test Group by LDAP ID
      tags:
      - config
      parameters:
      - name: ldap_id
        in: path
        required: true
        schema:
          type: string
        description: Path variable carried verbatim from the InfiniBox 7.3 Postman collection.
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InfiniBoxEnvelope'
        '401':
          description: Unauthenticated. The session is missing, expired or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InfiniBoxError'
  /config/security:
    get:
      operationId: configSecurityGet
      summary: CONFIG Security Get
      tags:
      - config
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InfiniBoxEnvelope'
        '401':
          description: Unauthenticated. The session is missing, expired or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InfiniBoxError'
      parameters:
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/page_size'
      - $ref: '#/components/parameters/fields'
      - $ref: '#/components/parameters/sort'
  /filesystems:
    get:
      operationId: fsGetAllFilesystems
      summary: FS Get all filesystems
      tags:
      - filesystems
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InfiniBoxEnvelope'
        '401':
          description: Unauthenticated. The session is missing, expired or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InfiniBoxError'
      parameters:
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/page_size'
      - $ref: '#/components/parameters/fields'
      - $ref: '#/components/parameters/sort'
  /filesystems/{id}:
    get:
      operationId: fsGetFilesystemByID
      summary: FS Get filesystem by ID
      tags:
      - filesystems
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
        description: Path variable carried verbatim from the InfiniBox 7.3 Postman collection.
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/page_size'
      - $ref: '#/components/parameters/fields'
      - $ref: '#/components/parameters/sort'
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InfiniBoxEnvelope'
        '401':
          description: Unauthenticated. The session is missing, expired or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InfiniBoxError'
  /hosts:
    post:
      operationId: hostCreate
      summary: HOST Create
      tags:
      - hosts
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              name: auto-Host4Test-b961d0cf-c5
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InfiniBoxEnvelope'
        '401':
          description: Unauthenticated. The session is missing, expired or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InfiniBoxError'
  /metadata/:
    get:
      operationId: metatdata
      summary: Metatdata
      tags:
      - metadata
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InfiniBoxEnvelope'
        '401':
          description: Unauthenticated. The session is missing, expired or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InfiniBoxError'
      x-collection-aliases:
      - Volumes
      parameters:
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/page_size'
      - $ref: '#/components/parameters/fields'
      - $ref: '#/components/parameters/sort'
  /metadata/{object_id}:
    get:
      operationId: metatdataGetByObject
      summary: Metatdata Get by Object
      tags:
      - metadata
      parameters:
      - name: object_id
        in: path
        required: true
        schema:
          type: string
        description: Path variable carried verbatim from the InfiniBox 7.3 Postman collection.
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/page_size'
      - $ref: '#/components/parameters/fields'
      - $ref: '#/components/parameters/sort'
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InfiniBoxEnvelope'
        '401':
          description: Unauthenticated. The session is missing, expired or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InfiniBoxError'
    put:
      operationId: metatdataAddToStorageEntity
      summary: Metatdata Add to Storage Entity
      tags:
      - metadata
      parameters:
      - name: object_id
        in: path
        required: true
        schema:
          type: string
        description: Path variable carried verbatim from the InfiniBox 7.3 Postman collection.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              fs: ext2
              obj:
                xxx: yyy
                zzz:
                - 1
                - 2
                - 3
                - 4
                - 5
                fff:
                  ggg: ppp
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InfiniBoxEnvelope'
        '401':
          description: Unauthenticated. The session is missing, expired or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InfiniBoxError'
  /pools:
    get:
      operationId: poolGetPools
      summary: POOL Get Pools
      tags:
      - pools
      responses:
        '200':
          description: POOL Get Pools (saved example omitted here for size; see postman/infinidat-infinibox-7-3-postman.json)
        '401':
          description: Unauthenticated. The session is missing, expired or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InfiniBoxError'
      x-collection-aliases:
      - POOL Set Active Pool by ID
      - POOL Set Active Pool by Name
      parameters:
      - name: id
        in: query
        required: false
        schema:
          type: string
        example: '358'
      - name: name
        in: query
        required: false
        schema:
          type: string
        example: orens-pool1
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/page_size'
      - $ref: '#/components/parameters/fields'
      - $ref: '#/components/parameters/sort'
  /system/capacity/total_virtual_capacity:
    get:
      operationId: systemGetTotalVirtualCapacity
      summary: SYSTEM Get Total Virtual Capacity
      tags:
      - system
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InfiniBoxEnvelope'
        '401':
          description: Unauthenticated. The session is missing, expired or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InfiniBoxError'
      parameters:
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/page_size'
      - $ref: '#/components/parameters/fields'
      - $ref: '#/components/parameters/sort'
  /system/certificates/upload_csr:
    post:
      operationId: certificateUploadCsr
      summary: Certificate upload csr
      tags:
      - system
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InfiniBoxEnvelope'
        '401':
          description: Unauthenticated. The session is missing, expired or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InfiniBoxError'
  /system/eula:
    get:
      operationId: systemGetEULA
      summary: SYSTEM Get EULA
      tags:
      - system
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InfiniBoxEnvelope'
        '401':
          description: Unauthenticated. The session is missing, expired or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InfiniBoxError'
      parameters:
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/page_size'
      - $ref: '#/components/parameters/fields'
      - $ref: '#/components/parameters/sort'
  /system/health_state:
    get:
      operationId: systemGetHealthState
      summary: SYSTEM Get Health State
      tags:
      - system
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InfiniBoxEnvelope'
        '401':
          description: Unauthenticated. The session is missing, expired or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InfiniBoxError'
      parameters:
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/page_size'
      - $ref: '#/components/parameters/fields'
      - $ref: '#/components/parameters/sort'
  /system/kms:
    get:
      operationId: configKMSGet
      summary: CONFIG KMS Get
      tags:
      - system
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InfiniBoxEnvelope'
        '401':
          description: Unauthenticated. The session is missing, expired or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InfiniBoxError'
      parameters:
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/page_size'
      - $ref: '#/components/parameters/fields'
      - $ref: '#/components/parameters/sort'
  /system/kms/set_configuration:
    put:
      operationId: configKMSSet
      summary: CONFIG KMS Set
      tags:
      - system
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              kms_username: iboxffff
              kms_password: abcd
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InfiniBoxEnvelope'
        '401':
          description: Unauthenticated. The session is missing, expired or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InfiniBoxError'
  /system/kms/upload_infinibox_certificate_and_key:
    post:
      operationId: configKMSUploadCertificateAndKey
      summary: CONFIG KMS Upload Certificate and key
      tags:
      - system
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InfiniBoxEnvelope'
        '401':
          description: Unauthenticated. The session is missing, expired or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InfiniBoxError'
  /system/kms/upload_kms_ca_certificate:
    post:
      operationId: configKMSUploadCACertificate
      summary: CONFIG KMS Upload CA Certificate
      tags:
      - system
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example: "{ \n    \"kms_ca_certificate\": \"-----BEGIN CERTIFICATE-----\\nMIIFoDCCA4igAwIBAgIQLvGDjBJCdAKXgkBtFGZnpzANBgkqhkiG9w0BAQsFADBa\\\
              nMQswCQYDVQQGEwJVUzELMAkGA1UECBMCTUQxEDAOBgNVBAcTB0JlbGNhbXAxEDAO\\nBgNVBAoTB0dlbWFsdG8xGjAYBgNVBAMTEUtleVNlY3VyZSBSb290IENBMB4XDTIz\\\
              nMDgwNzA3NDAwMFoXDTMzMDgwNDA3NDAwMFowWjELMAkGA1UEBhMCVVMxCzAJBgNV\\nBAgTAk1EMRAwDgYDVQQHEwdCZWxjYW1wMRAwDgYDVQQKEwdHZW1hbHRvMRowGAYD\\\
              nVQQDExFLZXlTZWN1cmUgUm9vdCBDQTCCAiIwDQYJKoZIhvcNAQEBBQADggIPADCC\\nAgoCggIBANWz033BRw3RXkDSkW7En1EFPO0VSYI083n5BsdMth4pqkYknRz9diOK\\\
              nsrGA5DaBRXmU4Hmip9sFvfvVFtHmfadegqG/1iizfDtfiw9zPJA+UO1Sg81J9smK\\n9cX4VtMUMWe8ljie1Vn/89/vgJ6BAFoa1pYap3oF1iU2SdDnFsibXMOQBaSAz1XK\\\
              ny10iBdzPyNvojYz2NQz3fw04M1hdlXJLIuT6ShJLKiTGbbIEbabJlHBj8L+gOUQ2\\nkClk+fzVbFkiJZAWf5Zdje7UCG7fj5haSxlkAch9Rw22JIiEwmFFLyYq/rMupGV4\\\
              n7JolNTaypnGBnvdx64CY3veiOjTYkLo0H1WWqe5Bf/xtcOazFVVWWkr4MeZsFJsb\\nn3XHUSISkQdWJHa9XjZPoNu3pWoLqvY4N/izAhfoUKrsYQCejhDlxaAH99/PZpKG\\\
              nWWDtZ5z1wTGiSOFt5qb30apJy8GsO2a/Czz76Hk4s0llX5aRXD4HrNG/Id2+PTdm\\nLvTnJ6/NLDaOuDwOQZRE/xvu0zIU9HzVsyzPpKsmUevWyyma+WPy9uLWQy5dSSI8\\\
              ntT6pABQzIksb6nNcAHPN5uosvGHmcyi+oSXOCuAfyOZTuSlgegBMUYa6OMer2kBv\\nzP2Ab7YJjx3qHGz3C9U083W7m9suXxHvHZFB88DJcQyyXDfa6UYHAgMBAAGjYjBg\\\
              nMA4GA1UdDwEB/wQEAwIBBjAPBgNVHRMBAf8EBTADAQH/MB0GA1UdDgQWBBQu0oK4\\nV2zUUO2OyNUhy/g+wn797zAeBgNVHREEFzAVgRNzdXBwb3J0QGdlbWFsdG8uY29t\\\
              nMA0GCSqGSIb3DQEBCwUAA4ICAQCAuGXfkqKxBG2Y6TmEnYSx/Ki0+Ae85giTuKMA\\npApkRqErjXi+4SKR8m7e4JeJq3TKEEUaZgtOVzpQxmIVur1WoJDsfcBX574CI2lB\\\
              nkw8UOfhOF+Zp9VtJnzK8EN6ajx+jpJQvikMDHttQfRcAHbEzltzk17DWF9hU+aTA\\nfi2BA4Puqe7K+cIilGUErJVdaEYYtmsVkVxhS+zbx+D71DbOmiayj8sGUr7xm6Lp\\\
              n33+N1cZISecXvNWZCnEasEqIhRj8GE2BUr7B5CfZPn6C03zS00mg9fJg9f+NvFFv\\nn0R2btAnzGlxF+25dOaWTLntILDKRgLut5cZTUuRPlzcS49zmpbCP6EKuqTVS4dA\\\
              nx7crWtpfjBASusfhs7/7sMwl6uGcjbATvm9JlbFkimtiCg6P4oHf/vEDR283DJos\\nxCl+2QJu/y561ejtp2V97PT+G1zM7bKeCEzFPDQ5wvX9OdXoTrE13u2L9doj2pdy\\\
              nT7A7lrsIv1OyJjMtwQzlop2eLudPb2f8XbB5tMZaMwKkcxMKsOyJIpt0DINbqRc8\\nJWTCPaK/zE9JB2ocUjihn63tE7lW4L+1lSVVC87cyUAPfw4WLYVzQCkf7GyNewrC\\\
              n834XrmUGm/YCzbykEKWiEOqOTMMqFp4Gon46Y7AxmzBn8ugKSPH3atOjPKy1nko0\\nKxTsOg==\\n-----END CERTIFICATE-----\\n\""
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InfiniBoxEnvelope'
        '401':
          description: Unauthenticated. The session is missing, expired or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InfiniBoxError'
  /system/name:
    get:
      operationId: systemGetName
      summary: SYSTEM Get Name
      tags:
      - system
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InfiniBoxEnvelope'
        '401':
          description: Unauthenticated. The session is missing, expired or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InfiniBoxError'
      parameters:
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/page_size'
      - $ref: '#/components/parameters/fields'
      - $ref: '#/components/parameters/sort'
  /system/ready:
    get:
      operationId: systemGetReadyStatus
      summary: SYSTEM Get Ready status
      tags:
      - system
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InfiniBoxEnvelope'
        '401':
          description: Unauthenticated. The session is missing, expired or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InfiniBoxError'
      parameters:
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/page_size'
      - $ref: '#/components/parameters/fields'
      - $ref: '#/components/parameters/sort'
  /system/security:
    get:
      operationId: systemGetSecurity
      summary: SYSTEM Get Security
      tags:
      - system
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InfiniBoxEnvelope'
        '401':
          description: Unauthenticated. The session is missing, expired or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InfiniBoxError'
      parameters:
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/page_size'
      - $ref: '#/components/parameters/fields'
      - $ref: '#/components/parameters/sort'
  /system/stats:
    get:
      operationId: systemGetStatistics
      summary: SYSTEM Get Statistics
      tags:
      - system
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InfiniBoxEnvelope'
        '401':
          description: Unauthenticated. The session is missing, expired or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InfiniBoxError'
      parameters:
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/page_size'
      - $ref: '#/components/parameters/fields'
      - $ref: '#/components/parameters/sort'
  /users/login:
    post:
      operationId: login
      summary: Login
      tags:
      - users
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              username: '{{username}}'
              password: '{{password}}'
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InfiniBoxEnvelope'
        '401':
          description: Unauthenticated. The session is missing, expired or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InfiniBoxError'
  /users/logout:
    post:
      operationId: logout
      summary: Logout
      tags:
      - users
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InfiniBoxEnvelope'
        '401':
          description: Unauthenticated. The session is missing, expired or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InfiniBoxError'