Cloudmersive Zip Archive API

Zip Archive operations of the Cloudmersive Document and Data Conversion API — 7 operation(s) served from https://api.cloudmersive.com and authenticated with the Apikey header. One Cloudmersive API key grants access to every API in the portfolio.

Operations 7

POST /convert/archive/zip/create Compress files to create a new zip archive #
POST /convert/archive/zip/create/encrypted Compress files to create a new, encrypted and password-protected zip archive #
POST /convert/archive/zip/create/quarantine Create an encrypted zip file to quarantine a dangerous file #
POST /convert/archive/zip/create/advanced Compress files and folders to create a new zip archive with advanced options #
POST /convert/archive/zip/extract Extract, decompress files and folders from a zip archive #
POST /convert/archive/zip/encrypt/advanced Encrypt and password protect a zip file #
POST /convert/archive/zip/decrypt Decrypt and remove password protection on a zip file #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/cloudmersive:cloudmersive-ziparchive-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

cloudmersive-ziparchive-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  version: v1
  title: convertapi Zip Archive API
  description: Convert API lets you effortlessly convert file formats and types.
servers:
- url: http://localhost
tags:
- name: ZipArchive
paths:
  /convert/archive/zip/create:
    post:
      tags:
      - ZipArchive
      summary: Compress files to create a new zip archive
      description: Create a new zip archive by compressing input files.
      operationId: ZipArchive_ZipCreate
      responses:
        '200':
          description: OK
          content:
            application/octet-stream:
              schema:
                format: byte
                title: OutputContent
                description: Output file content from the operation
                type: string
      security:
      - Apikey: []
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                inputFile1:
                  type: string
                  description: First input file to perform the operation on.
                  format: binary
                inputFile2:
                  type: string
                  description: Second input file to perform the operation on.
                  format: binary
                inputFile3:
                  type: string
                  description: Third input file to perform the operation on.
                  format: binary
                inputFile4:
                  type: string
                  description: Fourth input file to perform the operation on.
                  format: binary
                inputFile5:
                  type: string
                  description: Fifth input file to perform the operation on.
                  format: binary
                inputFile6:
                  type: string
                  description: Sixth input file to perform the operation on.
                  format: binary
                inputFile7:
                  type: string
                  description: Seventh input file to perform the operation on.
                  format: binary
                inputFile8:
                  type: string
                  description: Eighth input file to perform the operation on.
                  format: binary
                inputFile9:
                  type: string
                  description: Ninth input file to perform the operation on.
                  format: binary
                inputFile10:
                  type: string
                  description: Tenth input file to perform the operation on.
                  format: binary
              required:
              - inputFile1
  /convert/archive/zip/create/encrypted:
    post:
      tags:
      - ZipArchive
      summary: Compress files to create a new, encrypted and password-protected zip archive
      description: Create a new zip archive by compressing input files, and also applies encryption and password protection to the zip.
      operationId: ZipArchive_ZipCreateEncrypted
      parameters:
      - name: password
        in: header
        description: Password to place on the Zip file; the longer the password, the more secure
        required: true
        schema:
          type: string
      - name: encryptionAlgorithm
        in: header
        description: Encryption algorithm to use; possible values are AES-256 (recommended), AES-128, and PK-Zip (not recommended; legacy, weak encryption algorithm). Default is AES-256.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/octet-stream:
              schema:
                format: byte
                title: OutputContent
                description: Output file content from the operation
                type: string
      security:
      - Apikey: []
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                inputFile1:
                  type: string
                  description: First input file to perform the operation on.
                  format: binary
                inputFile2:
                  type: string
                  description: Second input file to perform the operation on.
                  format: binary
                inputFile3:
                  type: string
                  description: Third input file to perform the operation on.
                  format: binary
                inputFile4:
                  type: string
                  description: Fourth input file to perform the operation on.
                  format: binary
                inputFile5:
                  type: string
                  description: Fifth input file to perform the operation on.
                  format: binary
                inputFile6:
                  type: string
                  description: Sixth input file to perform the operation on.
                  format: binary
                inputFile7:
                  type: string
                  description: Seventh input file to perform the operation on.
                  format: binary
                inputFile8:
                  type: string
                  description: Eighth input file to perform the operation on.
                  format: binary
                inputFile9:
                  type: string
                  description: Ninth input file to perform the operation on.
                  format: binary
                inputFile10:
                  type: string
                  description: Tenth input file to perform the operation on.
                  format: binary
              required:
              - inputFile1
  /convert/archive/zip/create/quarantine:
    post:
      tags:
      - ZipArchive
      summary: Create an encrypted zip file to quarantine a dangerous file
      description: Create a new zip archive by compressing input files, and also applies encryption and password protection to the zip, for the purposes of quarantining the underlyikng file.
      operationId: ZipArchive_ZipCreateQuarantine
      parameters:
      - name: password
        in: header
        description: Password to place on the Zip file; the longer the password, the more secure
        required: true
        schema:
          type: string
      - name: encryptionAlgorithm
        in: header
        description: Encryption algorithm to use; possible values are AES-256 (recommended), AES-128, and PK-Zip (not recommended; legacy, weak encryption algorithm). Default is AES-256.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/octet-stream:
              schema:
                type: object
      security:
      - Apikey: []
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                inputFile1:
                  type: string
                  description: First input file to perform the operation on.
                  format: binary
              required:
              - inputFile1
  /convert/archive/zip/create/advanced:
    post:
      tags:
      - ZipArchive
      summary: Compress files and folders to create a new zip archive with advanced options
      description: Create a new zip archive by compressing input files, folders and leverage advanced options to control the structure of the resulting zip archive.
      operationId: ZipArchive_ZipCreateAdvanced
      responses:
        '200':
          description: OK
          content:
            application/octet-stream:
              schema:
                type: object
      security:
      - Apikey: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateZipArchiveRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/CreateZipArchiveRequest'
          application/xml:
            schema:
              $ref: '#/components/schemas/CreateZipArchiveRequest'
          text/xml:
            schema:
              $ref: '#/components/schemas/CreateZipArchiveRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/CreateZipArchiveRequest'
        description: Input request
        required: true
  /convert/archive/zip/extract:
    post:
      tags:
      - ZipArchive
      summary: Extract, decompress files and folders from a zip archive
      description: Extracts a zip archive by decompressing files, and folders.
      operationId: ZipArchive_ZipExtract
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ZipExtractResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ZipExtractResponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/ZipExtractResponse'
            text/xml:
              schema:
                $ref: '#/components/schemas/ZipExtractResponse'
      security:
      - Apikey: []
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                inputFile:
                  type: string
                  description: Input file to perform the operation on.
                  format: binary
              required:
              - inputFile
  /convert/archive/zip/encrypt/advanced:
    post:
      tags:
      - ZipArchive
      summary: Encrypt and password protect a zip file
      description: Encrypts and password protects an existing zip file with the specified password and encryption algorithm
      operationId: ZipArchive_ZipEncryptAdvanced
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
            text/json:
              schema:
                type: object
            application/xml:
              schema:
                type: object
            text/xml:
              schema:
                type: object
      security:
      - Apikey: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ZipEncryptionAdvancedRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/ZipEncryptionAdvancedRequest'
          application/xml:
            schema:
              $ref: '#/components/schemas/ZipEncryptionAdvancedRequest'
          text/xml:
            schema:
              $ref: '#/components/schemas/ZipEncryptionAdvancedRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/ZipEncryptionAdvancedRequest'
        description: Encryption request
        required: true
  /convert/archive/zip/decrypt:
    post:
      tags:
      - ZipArchive
      summary: Decrypt and remove password protection on a zip file
      description: Decrypts and removes password protection from an encrypted zip file with the specified password
      operationId: ZipArchive_ZipDecrypt
      parameters:
      - name: zipPassword
        in: header
        description: Required; Password for the input archive
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
            text/json:
              schema:
                type: object
            application/xml:
              schema:
                type: object
            text/xml:
              schema:
                type: object
      security:
      - Apikey: []
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                inputFile:
                  type: string
                  description: Input file to perform the operation on.
                  format: binary
              required:
              - inputFile
components:
  schemas:
    ZipEncryptionAdvancedRequest:
      description: Request to encrypt an existing Zip Archive file and protect it with a password
      type: object
      properties:
        InputFileContents:
          format: byte
          description: Input Zip File archive contents in bytes
          type: string
        Password:
          description: Password to place on the Zip file; the longer the password, the more secure
          type: string
        EncryptionAlgorithm:
          description: Encryption algorithm to use; possible values are AES-256 (recommended), AES-128, and PK-Zip (not recommended; legacy, weak encryption algorithm).  Default is AES-256.
          type: string
    ZipFile:
      description: Representation of a file in a zip file
      type: object
      properties:
        FileName:
          description: Name of this file
          type: string
        FileContents:
          format: byte
          description: Contents of this file
          type: string
    ZipDirectory:
      description: Representation of a directory in a zip file
      type: object
      properties:
        DirectoryName:
          description: Name of this directory
          type: string
        DirectoriesInDirectory:
          description: Child directories contained directly in this directory
          type: array
          items:
            $ref: '#/components/schemas/ZipDirectory'
        FilesInDirectory:
          description: Child files contained directly in this directory
          type: array
          items:
            $ref: '#/components/schemas/ZipFile'
    ZipExtractResponse:
      description: Result of performing a zip extract operation
      type: object
      properties:
        Successful:
          description: True if the operation was successful, false otherwise
          type: boolean
        FilesInZip:
          description: Top-level files in the root directory fo the zip file
          type: array
          items:
            $ref: '#/components/schemas/ZipFile'
        DirectoriesInZip:
          description: Top-level directories in the root directory of the zip; directories can contain sub-directories and files
          type: array
          items:
            $ref: '#/components/schemas/ZipDirectory'
    CreateZipArchiveRequest:
      description: Request to create a Zip Archive
      type: object
      properties:
        FilesInZip:
          description: Top-level files in the root directory fo the zip file
          type: array
          items:
            $ref: '#/components/schemas/ZipFile'
        DirectoriesInZip:
          description: Top-level directories in the root directory of the zip; directories can contain sub-directories and files
          type: array
          items:
            $ref: '#/components/schemas/ZipDirectory'
  securitySchemes:
    Apikey:
      type: apiKey
      description: API Key Authentication
      name: Apikey
      in: header
x-provenance:
  method: harvested
  publisher: Cloudmersive
  source: https://api.cloudmersive.com/convert/docs/v1/swagger
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)