Appmixer Files API

File management

Documentation

Specifications

Schemas & Data

Other Resources

OpenAPI Specification

appmixer-files-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Appmixer Accounts Files API
  description: The Appmixer REST API provides programmatic access to manage workflows, users, accounts, apps/connectors, files, data stores, insights, and people tasks within the Appmixer embedded iPaaS platform. The API allows you to access all the features that the Appmixer UI works with.
  version: 6.1.0
  contact:
    name: Appmixer
    url: https://www.appmixer.com/
  license:
    name: Proprietary
    url: https://www.appmixer.com/terms-and-conditions
servers:
- url: https://api.{tenant}.appmixer.cloud
  description: Appmixer Cloud Tenant API
  variables:
    tenant:
      default: YOUR_TENANT
      description: Your Appmixer tenant identifier
security:
- bearerAuth: []
tags:
- name: Files
  description: File management
paths:
  /files:
    get:
      operationId: listFiles
      summary: Appmixer List files
      description: Get all files belonging to the authenticated user.
      responses:
        '200':
          description: List of files returned successfully
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/File'
        '401':
          description: Unauthorized
      tags:
      - Files
    post:
      operationId: uploadFile
      summary: Appmixer Upload a file
      description: Upload a new file to the Appmixer file management system.
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                file:
                  type: string
                  format: binary
      responses:
        '200':
          description: File uploaded successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/File'
        '401':
          description: Unauthorized
      tags:
      - Files
  /files/{fileId}:
    get:
      operationId: getFile
      summary: Appmixer Get a file
      description: Download or get details of a specific file.
      parameters:
      - name: fileId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: File returned successfully
        '401':
          description: Unauthorized
        '404':
          description: File not found
      tags:
      - Files
    delete:
      operationId: deleteFile
      summary: Appmixer Delete a file
      description: Delete a specific file.
      parameters:
      - name: fileId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: File deleted successfully
        '401':
          description: Unauthorized
        '404':
          description: File not found
      tags:
      - Files
components:
  schemas:
    File:
      type: object
      properties:
        fileId:
          type: string
        filename:
          type: string
        length:
          type: integer
        contentType:
          type: string
        createdAt:
          type: string
          format: date-time
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Access token obtained from the /user/auth endpoint. Pass as Authorization: Bearer {token} header.'