IBM WebSphere

IBM WebSphere File Transfer API

File upload and download operations

Documentation GitHub OpenAPI

Operations 6

GET /file Download a File #

POST /file Upload a File #

DELETE /file Delete a File #

POST /file/upload Upload a File #

GET /file/download Download a File #

DELETE /file/delete Delete a 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/websphere-file-transfer-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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.

GitHub Google LinkedIn

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

OpenAPI Specification

openapi: 3.2.0
info:
  title: Websphere File Transfer API
  contact:
    name: IBM Support
    url: https://www.ibm.com/mysupport
  license:
    name: IBM International License Agreement
    url: https://www.ibm.com/legal/terms
  version: '1.0'
  description: 'Operations tagged File Transfer across 2 of this provider''s published API definitions: websphere-liberty-admin-rest-api.yml, websphere-liberty-rest-connector-api.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://localhost:9443/ibm/api
  description: Default Liberty Admin API Server
- url: https://localhost:9443/IBMJMXConnectorREST/api
  description: Default Liberty JMX REST Connector
security:
- basicAuth: []
tags:
- name: File Transfer
  description: File upload and download operations
paths:
  /file:
    get:
      operationId: downloadFile
      summary: Download a File
      description: Downloads a file from the Liberty server.
      tags:
      - File Transfer
      parameters:
      - name: path
        in: query
        required: true
        description: Path to the file on the server
        schema:
          type: string
        example: example_value
      responses:
        '200':
          description: File content
          content:
            application/octet-stream:
              schema:
                type: string
                format: binary
              examples:
                Downloadfile200Example:
                  summary: Default downloadFile 200 response
                  x-microcks-default: true
                  value: example_value
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      operationId: uploadFile
      summary: Upload a File
      description: Uploads a file to the Liberty server.
      tags:
      - File Transfer
      parameters:
      - name: path
        in: query
        required: true
        description: Destination path on the server
        schema:
          type: string
        example: example_value
      requestBody:
        required: true
        content:
          application/octet-stream:
            schema:
              type: string
              format: binary
            examples:
              UploadfileRequestExample:
                summary: Default uploadFile request
                x-microcks-default: true
                value: example_value
      responses:
        '201':
          description: File uploaded
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      operationId: deleteFile
      summary: Delete a File
      description: Deletes a file from the Liberty server.
      tags:
      - File Transfer
      parameters:
      - name: path
        in: query
        required: true
        description: Path to the file on the server
        schema:
          type: string
        example: example_value
      responses:
        '204':
          description: File deleted
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    servers:
    - url: https://localhost:9443/ibm/api
      description: Default Liberty Admin API Server
  /file/upload:
    post:
      operationId: uploadFile
      summary: Upload a File
      description: Uploads a file to the Liberty server file system.
      tags:
      - File Transfer
      parameters:
      - name: targetPath
        in: query
        required: true
        description: Target file path on the server
        schema:
          type: string
        example: example_value
      requestBody:
        required: true
        content:
          application/octet-stream:
            schema:
              type: string
              format: binary
            examples:
              UploadfileRequestExample:
                summary: Default uploadFile request
                x-microcks-default: true
                value: example_value
      responses:
        '201':
          description: File uploaded successfully
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    servers:
    - url: https://localhost:9443/IBMJMXConnectorREST/api
      description: Default Liberty JMX REST Connector
  /file/download:
    get:
      operationId: downloadFile
      summary: Download a File
      description: Downloads a file from the Liberty server file system.
      tags:
      - File Transfer
      parameters:
      - name: sourcePath
        in: query
        required: true
        description: Source file path on the server
        schema:
          type: string
        example: example_value
      responses:
        '200':
          description: File content
          content:
            application/octet-stream:
              schema:
                type: string
                format: binary
              examples:
                Downloadfile200Example:
                  summary: Default downloadFile 200 response
                  x-microcks-default: true
                  value: example_value
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    servers:
    - url: https://localhost:9443/IBMJMXConnectorREST/api
      description: Default Liberty JMX REST Connector
  /file/delete:
    delete:
      operationId: deleteFile
      summary: Delete a File
      description: Deletes a file from the Liberty server file system.
      tags:
      - File Transfer
      parameters:
      - name: path
        in: query
        required: true
        description: File path on the server
        schema:
          type: string
        example: example_value
      responses:
        '204':
          description: File deleted
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    servers:
    - url: https://localhost:9443/IBMJMXConnectorREST/api
      description: Default Liberty JMX REST Connector
components:
  responses:
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: Authentication required
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    BadRequest:
      description: Bad request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    Error:
      type: object
      properties:
        code:
          type: string
          example: example_value
        message:
          type: string
          example: example_value
        details:
          type: string
          example: example_value
      required:
      - code
      - message
    Error_2:
      type: object
      properties:
        code:
          type: string
          example: example_value
        message:
          type: string
          example: example_value
      required:
      - code
      - message
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic authentication using Liberty administrative credentials
    ltpaToken:
      type: apiKey
      in: cookie
      name: LtpaToken2
      description: LTPA token-based authentication
x-refined-from:
- websphere-liberty-admin-rest-api.yml
- websphere-liberty-rest-connector-api.yml

IBM WebSphere File Transfer API

Operations 6

Documentation

Specifications

Schemas & Data

Other Resources