aspera-cli 4.27.2 → 4.27.4

data/lib/aspera/schema/IBM Aspera Console-enhanced.yaml

@@ -0,0 +1,1125 @@
+# DO NOT EDIT THIS FILE MANUALLY
+# This file is automatically downloaded from:
+# https://raw.githubusercontent.com/laurent-martin/aspera-api-examples/refs/heads/main/openapi/IBM%20Aspera%20Console-enhanced.yaml
+# Use 'rake tools:openapi' to update this file
+
+openapi: 3.1.0
+info:
+  title: Aspera Console REST API
+  description: |-
+    Submit, control, and monitor Aspera FASP transfers through the Aspera Console web application.
+    All calls are made over HTTPS using HTTP Basic Auth with a valid Console account;
+    the operations a caller can perform are limited by that account's permission level in Console.
+
+    ## Version compatibility
+    The Console API is available for Console version 2.0.1 and newer; older versions do not
+    support it. Console 2.0.1 currently supports API version 1.0.
+
+    ## Token authorization
+    Console 3.2.0 and later supports token authorization: admins can submit an authorization
+    token in the JSON payload when creating a simple (or smart) transfer with the Node API.
+    In the most common case, the remote (destination) server is configured to require tokens in
+    order to allow transfers.
+    See the [Aspera Node API "Upload Setup" guide](https://developer.ibm.com/apis/catalog/aspera--aspera-node-api/api/API--aspera--aspera-node-api)
+    for an example of how to submit the token.
+
+    ## Common response codes
+    All responses use standard HTTP response codes. The commonly used codes for this API are:
+      - `200` - Success
+      - `401` - Bad, missing, or locked username/password
+      - `403` - The specific operation allows the current user to know the item exists, but
+        they cannot change it
+      - `422` - Used for other errors; a JSON body is normally returned with details, but if
+        none is returned, check the mongrel logs
+
+    ## Response content
+    If a response contains content, it is returned in JSON format with UTF-8 encoding. All
+    times are in UTC.
+  version: 1.0.0
+  x-console-api-version: "1.0"
+  x-console-minimum-version: 2.0.1
+  license:
+    url: https://ibm.com
+    name: (c) IBM. All rights reserved
+  contact:
+    name: IBM Aspera
+    url: https://developer.ibm.com/apis/catalog/aspera--aspera-console-rest-api/Developer+Guides
+servers:
+  - url: https://{host}/aspera/console/api
+    description: Aspera Console server
+    variables:
+      host:
+        default: console.example.com
+paths:
+  /transfers:
+    get:
+      operationId: getTransfers
+      summary: List transfers (TransferList)
+      description: Nearly identical to the Activity view in the Console UI. Multi-step Smart Transfers appear as multiple individual items, each with its own id.
+      parameters:
+        - name: from
+          in: query
+          description: UTC date/time, e.g. "2013-02-28 12:00:00"
+          required: true
+          schema:
+            type: string
+        - name: to
+          in: query
+          description: UTC date/time. Optional if `from` is less than 24 hours ago, otherwise required and must be no later than `from` + 24 hours. Defaults to the current time if omitted.
+          required: false
+          schema:
+            type: string
+        - name: filter1
+          in: query
+          schema:
+            $ref: "#/components/schemas/FilterField"
+        - name: comp1
+          in: query
+          schema:
+            $ref: "#/components/schemas/Comparator"
+        - name: val1
+          in: query
+          schema:
+            type: string
+        - name: filter2
+          in: query
+          description: Additional filters are joined by AND.
+          schema:
+            $ref: "#/components/schemas/FilterField"
+        - name: comp2
+          in: query
+          schema:
+            $ref: "#/components/schemas/Comparator"
+        - name: val2
+          in: query
+          schema:
+            type: string
+      responses:
+        "200":
+          description: Array of transfer summaries
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: "#/components/schemas/TransferSummary"
+        "401":
+          $ref: "#/components/responses/Unauthorized"
+        "422":
+          $ref: "#/components/responses/UnprocessableEntity"
+      tags:
+        - transfers
+    post:
+      operationId: postTransfers
+      summary: Submit a simple transfer (SimpleTransferSubmit)
+      description: Equivalent to starting a simple transfer in the Console interface.
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/SimpleTransferSubmitRequest"
+      responses:
+        "200":
+          description: New transfer created
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/IdResponse"
+        "401":
+          $ref: "#/components/responses/Unauthorized"
+        "422":
+          $ref: "#/components/responses/UnprocessableEntity"
+      tags:
+        - transfers
+  /transfers/{id}:
+    get:
+      operationId: getTransfersId
+      summary: Get transfer details (TransferDetails)
+      description: Nearly identical to the drill-down detail screen for a transfer.
+      parameters:
+        - $ref: "#/components/parameters/JobStepId"
+      responses:
+        "200":
+          description: Transfer detail
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/TransferDetail"
+        "401":
+          $ref: "#/components/responses/Unauthorized"
+        "422":
+          $ref: "#/components/responses/UnprocessableEntity"
+      tags:
+        - transfers
+  /transfers/{id}/files:
+    get:
+      operationId: getTransfersIdFiles
+      summary: List files in a transfer (TransferFileList)
+      description: Nearly identical to the file list at the bottom of the transfer details page.
+      parameters:
+        - $ref: "#/components/parameters/JobStepId"
+        - name: offset
+          in: query
+          description: How many files to skip (for pagination).
+          schema:
+            type: integer
+        - name: limit
+          in: query
+          description: Max number of items to return. Max value is currently 100.
+          required: true
+          schema:
+            type: integer
+            maximum: 100
+        - name: errors_only
+          in: query
+          description: Return only files with errors.
+          schema:
+            type: boolean
+        - name: path_match
+          in: query
+          description: String to match anywhere in the file path.
+          schema:
+            type: string
+      responses:
+        "200":
+          description: Array of files
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: "#/components/schemas/TransferFile"
+        "401":
+          $ref: "#/components/responses/Unauthorized"
+        "422":
+          $ref: "#/components/responses/UnprocessableEntity"
+      tags:
+        - transfers
+  /transfers/{id}/start:
+    put:
+      operationId: putTransfersIdStart
+      summary: Start a scheduled transfer (TransferStart)
+      description: Equivalent to clicking "start" for a scheduled transfer on the Activity page.
+      parameters:
+        - $ref: "#/components/parameters/JobStepId"
+      responses:
+        "200":
+          $ref: "#/components/responses/Ok"
+        "401":
+          $ref: "#/components/responses/Unauthorized"
+        "403":
+          $ref: "#/components/responses/Forbidden"
+        "422":
+          $ref: "#/components/responses/UnprocessableEntity"
+      tags:
+        - transfers
+  /transfers/{id}/pause:
+    put:
+      operationId: putTransfersIdPause
+      summary: Pause a transfer (TransferPause)
+      description: Equivalent to clicking "pause" for a transfer on the Activity page.
+      parameters:
+        - $ref: "#/components/parameters/JobStepId"
+      responses:
+        "200":
+          $ref: "#/components/responses/Ok"
+        "401":
+          $ref: "#/components/responses/Unauthorized"
+        "403":
+          $ref: "#/components/responses/Forbidden"
+        "422":
+          $ref: "#/components/responses/UnprocessableEntity"
+      tags:
+        - transfers
+  /transfers/{id}/resume:
+    put:
+      operationId: putTransfersIdResume
+      summary: Resume a transfer (TransferResume)
+      description: Equivalent to clicking "resume" for a transfer on the Activity page.
+      parameters:
+        - $ref: "#/components/parameters/JobStepId"
+      responses:
+        "200":
+          $ref: "#/components/responses/Ok"
+        "401":
+          $ref: "#/components/responses/Unauthorized"
+        "403":
+          $ref: "#/components/responses/Forbidden"
+        "422":
+          $ref: "#/components/responses/UnprocessableEntity"
+      tags:
+        - transfers
+  /transfers/{id}/cancel:
+    put:
+      operationId: putTransfersIdCancel
+      summary: Cancel a transfer (TransferCancel)
+      description: Equivalent to clicking "cancel" for a transfer on the Activity page.
+      parameters:
+        - $ref: "#/components/parameters/JobStepId"
+      responses:
+        "200":
+          $ref: "#/components/responses/Ok"
+        "401":
+          $ref: "#/components/responses/Unauthorized"
+        "403":
+          $ref: "#/components/responses/Forbidden"
+        "422":
+          $ref: "#/components/responses/UnprocessableEntity"
+      tags:
+        - transfers
+  /transfers/{id}/rerun:
+    post:
+      operationId: postTransfersIdRerun
+      summary: Rerun a transfer (TransferRerun)
+      description: Equivalent to clicking "rerun" for a transfer on the Activity page.
+      parameters:
+        - $ref: "#/components/parameters/JobStepId"
+      responses:
+        "200":
+          description: New transfer created from the rerun
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/IdResponse"
+        "401":
+          $ref: "#/components/responses/Unauthorized"
+        "422":
+          $ref: "#/components/responses/UnprocessableEntity"
+      tags:
+        - transfers
+  /transfers/{id}/change_rate:
+    put:
+      operationId: putTransfersIdChangeRate
+      summary: Change transfer rate (TransferChangeRate)
+      description: Equivalent to entering a new target rate in the chart on the transfer's Detail page.
+      parameters:
+        - $ref: "#/components/parameters/JobStepId"
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/ChangeRateRequest"
+      responses:
+        "200":
+          $ref: "#/components/responses/Ok"
+        "401":
+          $ref: "#/components/responses/Unauthorized"
+        "422":
+          $ref: "#/components/responses/UnprocessableEntity"
+      tags:
+        - transfers
+  /transfers/{id}/change_policy:
+    put:
+      operationId: putTransfersIdChangePolicy
+      summary: Change transfer policy (TransferChangePolicy)
+      description: Equivalent to choosing a new policy in the chart on the transfer's Detail page.
+      parameters:
+        - $ref: "#/components/parameters/JobStepId"
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/ChangePolicyRequest"
+      responses:
+        "200":
+          $ref: "#/components/responses/Ok"
+        "401":
+          $ref: "#/components/responses/Unauthorized"
+        "422":
+          $ref: "#/components/responses/UnprocessableEntity"
+      tags:
+        - transfers
+  /endpoints:
+    get:
+      operationId: getEndpoints
+      summary: List endpoints (EndPointList)
+      description: Retrieves the list of endpoints available for SimpleTransferSubmit.
+      responses:
+        "200":
+          description: Array of endpoints
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: "#/components/schemas/Endpoint"
+        "401":
+          $ref: "#/components/responses/Unauthorized"
+      tags:
+        - endpoints
+  /ssh_keys:
+    get:
+      operationId: getSshKeys
+      summary: List SSH keys (SshKeyList)
+      description: Retrieves the list of SSH keys available for use with SimpleTransferSubmit.
+      responses:
+        "200":
+          description: Array of SSH keys
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: "#/components/schemas/SshKey"
+        "401":
+          $ref: "#/components/responses/Unauthorized"
+      tags:
+        - endpoints
+  /smart_transfers:
+    get:
+      operationId: getSmartTransfers
+      summary: List Smart Transfers (SmartTransferList)
+      description: Retrieves the list of Smart Transfers the user is allowed to start.
+      responses:
+        "200":
+          description: Array of Smart Transfers
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: "#/components/schemas/SmartTransfer"
+        "401":
+          $ref: "#/components/responses/Unauthorized"
+      tags:
+        - smart-transfers
+  /smart_transfers/{id}:
+    post:
+      operationId: postSmartTransfersId
+      summary: Submit a Smart Transfer (SmartTransferSubmit)
+      description: Nearly identical to starting a simple transfer in the Console interface, but with fewer overridable settings. If the Smart Transfer does not allow selecting source items at start, including a `source` section returns an error. Multi-step Smart Transfers create multiple transfers.
+      parameters:
+        - name: id
+          in: path
+          description: Smart Transfer id
+          required: true
+          schema:
+            type: integer
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/SmartTransferSubmitRequest"
+      responses:
+        "200":
+          description: One id per transfer created (multiple for a multi-step Smart Transfer)
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: "#/components/schemas/IdResponse"
+        "401":
+          $ref: "#/components/responses/Unauthorized"
+        "422":
+          $ref: "#/components/responses/UnprocessableEntity"
+      tags:
+        - smart-transfers
+  /smart_transfers/{id}/pause:
+    put:
+      operationId: putSmartTransfersIdPause
+      summary: Pause a Smart Transfer
+      description: Present in routes.rb (`api#pause_smart_transfer`) but not described in the public API guide. Assumed to behave like TransferPause, scoped to a Smart Transfer id. Verify against the controller before relying on this.
+      parameters:
+        - name: id
+          in: path
+          description: Smart Transfer id
+          required: true
+          schema:
+            type: integer
+      responses:
+        "200":
+          $ref: "#/components/responses/Ok"
+        "401":
+          $ref: "#/components/responses/Unauthorized"
+        "422":
+          $ref: "#/components/responses/UnprocessableEntity"
+      tags:
+        - smart-transfers
+      x-undocumented: true
+  /queues/{queue_id}/items:
+    get:
+      operationId: getQueuesQueueIdItems
+      summary: Get queue contents (QueueContents)
+      description: Returns a list of items in the queue, frontmost item first.
+      parameters:
+        - name: queue_id
+          in: path
+          required: true
+          schema:
+            type: integer
+      responses:
+        "200":
+          description: Array of queue items
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: "#/components/schemas/QueueItem"
+        "401":
+          $ref: "#/components/responses/Unauthorized"
+      tags:
+        - queues
+  /queues/{queue_id}/items/{id}/move_forwards:
+    put:
+      operationId: putQueuesQueueIdItemsIdMoveForwards
+      summary: Move a queued transfer forward (QueuedTransferMoveForward)
+      description: Equivalent to clicking "Move Up" on a transfer in the displayed queue.
+      parameters:
+        - name: queue_id
+          in: path
+          required: true
+          schema:
+            type: integer
+        - $ref: "#/components/parameters/JobStepId"
+      responses:
+        "200":
+          $ref: "#/components/responses/Ok"
+        "401":
+          $ref: "#/components/responses/Unauthorized"
+        "403":
+          description: The current user does not have permission to reorder the queue.
+        "422":
+          $ref: "#/components/responses/UnprocessableEntity"
+      tags:
+        - queues
+  /queues/{queue_id}/items/{id}/move_back:
+    put:
+      operationId: putQueuesQueueIdItemsIdMoveBack
+      summary: Move a queued transfer back (QueuedTransferMoveBack)
+      description: Equivalent to clicking "Move Down" on a transfer in the displayed queue.
+      parameters:
+        - name: queue_id
+          in: path
+          required: true
+          schema:
+            type: integer
+        - $ref: "#/components/parameters/JobStepId"
+      responses:
+        "200":
+          $ref: "#/components/responses/Ok"
+        "401":
+          $ref: "#/components/responses/Unauthorized"
+        "403":
+          description: The current user does not have permission to reorder the queue.
+        "422":
+          $ref: "#/components/responses/UnprocessableEntity"
+      tags:
+        - queues
+  /email_server_update:
+    post:
+      operationId: postEmailServerUpdate
+      summary: Update email server configuration
+      description: Present in routes.rb (`api#email_server_update`) but not described in the public API guide. Payload shape is unknown; likely mirrors the "Email Server" admin settings screen. Confirm against `Api::EmailServerUpdate` / the corresponding controller action before use.
+      requestBody:
+        content:
+          application/json:
+            schema:
+              type: object
+              additionalProperties: true
+      responses:
+        "200":
+          $ref: "#/components/responses/Ok"
+        "401":
+          $ref: "#/components/responses/Unauthorized"
+        "422":
+          $ref: "#/components/responses/UnprocessableEntity"
+      tags:
+        - admin
+      x-undocumented: true
+  /nodeapi_credentials_update:
+    post:
+      operationId: postNodeapiCredentialsUpdate
+      summary: Update Node API credentials
+      description: Present in routes.rb (`api#nodeapi_credentials_update`) but not described in the public API guide. Payload shape is unknown; likely updates stored Node API credentials for a node. Confirm against the controller action before use.
+      requestBody:
+        content:
+          application/json:
+            schema:
+              type: object
+              additionalProperties: true
+      responses:
+        "200":
+          $ref: "#/components/responses/Ok"
+        "401":
+          $ref: "#/components/responses/Unauthorized"
+        "422":
+          $ref: "#/components/responses/UnprocessableEntity"
+      tags:
+        - admin
+      x-undocumented: true
+  /health/up:
+    servers:
+      - url: https://{host}/aspera/console
+        description: Aspera Console server (root scope, outside the /api prefix)
+        variables:
+          host:
+            default: console.example.com
+    get:
+      operationId: getHealthUp
+      summary: Health check
+      description: >-
+        Load-balancer / uptime probe. Unauthenticated;
+        returns success if Aspera Console process is up and responding.
+      security: []
+      responses:
+        "200":
+          description: Console is up
+        "422":
+          $ref: "#/components/responses/UnprocessableEntity"
+        "503":
+          description: Console is not healthy
+      tags:
+        - health
+      x-undocumented: true
+components:
+  parameters:
+    JobStepId:
+      name: id
+      in: path
+      required: true
+      description: Console's numeric id for the transfer (job step id).
+      schema:
+        type: integer
+  schemas:
+    FilterField:
+      type: string
+      enum:
+        - started_at
+        - stopped_at
+        - status
+        - transfer_name
+        - contact
+        - filename
+    Comparator:
+      type: string
+      enum:
+        - contain
+        - eq
+        - gt
+        - gte
+        - in
+        - lt
+        - lte
+        - is_not_null
+        - is_null
+        - match_re
+        - neq
+        - start_with
+    Error:
+      description: Error details; exact shape varies by endpoint.
+      type: object
+      additionalProperties: true
+    IdResponse:
+      type: object
+      properties:
+        id:
+          type: integer
+      required:
+        - id
+    TransferSummary:
+      type: object
+      properties:
+        bytes_transferred:
+          description: Total bytes actually transferred over the network. Bytes already present at the destination at transfer start are not counted if 'resume' was enabled.
+          type: integer
+        bytes_written:
+          description: Total bytes completed and written to disk at the destination. May exceed bytes_transferred (includes pre-existing bytes).
+          type: integer
+        contact:
+          type:
+            - string
+            - "null"
+        destination:
+          description: IP address of destination machine
+          type: string
+        error_description:
+          type:
+            - string
+            - "null"
+        eta:
+          type:
+            - string
+            - "null"
+        id:
+          type: integer
+        name:
+          type: string
+        queued_at:
+          type:
+            - string
+            - "null"
+          format: date-time
+        scheduled_start_at:
+          type:
+            - string
+            - "null"
+          format: date-time
+        source:
+          description: IP address of the source machine
+          type: string
+        started_at:
+          type:
+            - string
+            - "null"
+          format: date-time
+        started_via:
+          type: string
+        status:
+          type: string
+        stopped_at:
+          type:
+            - string
+            - "null"
+          format: date-time
+        submitted_at:
+          type:
+            - string
+            - "null"
+          format: date-time
+        total_bytes:
+          description: '"unknown" or numeric, per source node reporting'
+          oneOf:
+            - type: integer
+            - type: string
+    QueueRef:
+      type: object
+      properties:
+        queue_id:
+          type: integer
+        description:
+          type: string
+        position:
+          type: integer
+        waiting:
+          type: boolean
+    TransferDetail:
+      allOf:
+        - $ref: "#/components/schemas/TransferSummary"
+        - type: object
+          properties:
+            bytes_lost:
+              type: integer
+            comment:
+              type:
+                - string
+                - "null"
+            destination_description:
+              type:
+                - string
+                - "null"
+            destination_endpoint_id:
+              type: integer
+            destination_path:
+              type: string
+            files_completed:
+              type: integer
+            files_failed:
+              type: integer
+            files_skipped:
+              type: integer
+            initiator:
+              type: string
+              enum:
+                - source
+                - destination
+            last_calculated_rate_bps:
+              description: Periodic estimate of actual throughput. Null for short transfers where Console had no chance to compute it.
+              type:
+                - integer
+                - "null"
+            min_rate_kbps:
+              type: integer
+            network_delay_ms:
+              type: integer
+            policy:
+              type: string
+            queues:
+              type: array
+              items:
+                $ref: "#/components/schemas/QueueRef"
+            session_uuid:
+              type: string
+            source_description:
+              type:
+                - string
+                - "null"
+            source_endpoint_id:
+              type: integer
+            source_paths:
+              description: Specified source items from the ascp command. Truncated to approximately 4KB, so may not contain the full list.
+              type: array
+              items:
+                type: string
+            target_rate_kbps:
+              type: integer
+            total_files:
+              type: integer
+            transport:
+              type: string
+            transport_encryption:
+              type: string
+    TransferFile:
+      type: object
+      properties:
+        bytes_transferred:
+          type: integer
+        bytes_written:
+          type: integer
+        error_description:
+          type:
+            - string
+            - "null"
+        id:
+          type: integer
+        path:
+          type: string
+        size:
+          type: integer
+        started_at:
+          type: string
+        status:
+          type: string
+        stopped_at:
+          type: string
+    Endpoint:
+      type: object
+      properties:
+        credential_type:
+          type:
+            - string
+            - "null"
+          enum:
+            - password
+            - ssh_key
+            - none
+            - null
+        description:
+          type:
+            - string
+            - "null"
+        dest:
+          type: boolean
+        endpoint_type:
+          type: string
+          enum:
+            - Personal
+            - Node
+        id:
+          type: integer
+        ip_address:
+          type: string
+        login:
+          type: string
+        source:
+          type: boolean
+        ssh_key_id:
+          type:
+            - integer
+            - "null"
+        ssh_port:
+          type: integer
+    SshKey:
+      type: object
+      properties:
+        filename_on_node:
+          type: string
+        id:
+          type: integer
+        name:
+          type: string
+    SmartTransfer:
+      type: object
+      properties:
+        id:
+          type: integer
+        name:
+          type: string
+        owner:
+          type: string
+    QueueItem:
+      type: object
+      properties:
+        item_id:
+          type: integer
+        waiting:
+          type: boolean
+    ChangeRateRequest:
+      type: object
+      properties:
+        min_rate_kbps:
+          description: Normally "0". String type per API, despite the numeric value.
+          type: string
+        target_rate_kbps:
+          type: string
+      required:
+        - min_rate_kbps
+        - target_rate_kbps
+    ChangePolicyRequest:
+      type: object
+      properties:
+        policy:
+          type: string
+          enum:
+            - Fair
+            - Fixed
+            - Trickle
+      required:
+        - policy
+    RetriesSpec:
+      type: object
+      properties:
+        enable:
+          type: boolean
+        attempts:
+          type: integer
+        interval_seconds:
+          type: integer
+    ContentProtectionSpec:
+      type: object
+      properties:
+        enable:
+          type: boolean
+        password:
+          type: string
+    ResumeSpec:
+      type: object
+      properties:
+        enable:
+          type: boolean
+        comparison_method:
+          type: string
+          enum:
+            - Attributes
+            - Sparse Checksum
+            - Full Checksum
+    DeleteSourceFilesSpec:
+      type: object
+      properties:
+        enable:
+          type: boolean
+        also_delete_empty_directories:
+          type: boolean
+    NotificationSpec:
+      type: object
+      properties:
+        email_address:
+          type: string
+          format: email
+        start_template_id:
+          type: integer
+        success_template_id:
+          type: integer
+        error_template_id:
+          type: integer
+    TransferSourceSpec:
+      description: If the referenced endpoint has credential_type null, password or ssh_key_id is required. If its ip_address is "*", ip_address is required here. If its user is "*", user is required here.
+      type: object
+      properties:
+        endpoint_id:
+          type:
+            - integer
+            - "null"
+        ip_address:
+          type: string
+        port:
+          type: integer
+        user:
+          type: string
+        authentication_method:
+          type: string
+          enum:
+            - password
+            - ssh_key
+        password:
+          type: string
+        ssh_key_id:
+          type:
+            - integer
+            - "null"
+        paths:
+          type: array
+          items:
+            type: string
+        source_base:
+          description: Path prefix to remove from source paths.
+          type:
+            - string
+            - "null"
+    TransferDestinationSpec:
+      type: object
+      properties:
+        endpoint_id:
+          type:
+            - integer
+            - "null"
+        ip_address:
+          type: string
+        port:
+          type: integer
+        user:
+          type: string
+        authentication_method:
+          type: string
+          enum:
+            - password
+            - ssh_key
+        password:
+          type: string
+        ssh_key_id:
+          type:
+            - integer
+            - "null"
+        path:
+          type: string
+    SimpleTransferSubmitRequest:
+      type: object
+      properties:
+        name:
+          type: string
+        comment:
+          type: string
+        source:
+          $ref: "#/components/schemas/TransferSourceSpec"
+        destination:
+          $ref: "#/components/schemas/TransferDestinationSpec"
+        udp_port:
+          type: integer
+        target_rate_kbps:
+          type: integer
+        minimum_rate_kbps:
+          type: integer
+        policy:
+          type: string
+          enum:
+            - low
+            - fair
+            - high
+            - fixed
+        retries:
+          $ref: "#/components/schemas/RetriesSpec"
+        content_protection:
+          $ref: "#/components/schemas/ContentProtectionSpec"
+        transport_encryption:
+          type: string
+          enum:
+            - none
+            - aes-128
+        resume:
+          $ref: "#/components/schemas/ResumeSpec"
+        overwrite_policy:
+          type: string
+          enum:
+            - Always
+            - Diff
+            - DiffAndOlder
+            - Never
+        preserve_file_timestamps:
+          type: boolean
+        delete_source_files_after_transfer:
+          $ref: "#/components/schemas/DeleteSourceFilesSpec"
+        exclude_file_filter:
+          type:
+            - string
+            - "null"
+        symbolic_links:
+          type:
+            - string
+            - "null"
+          enum:
+            - follow
+            - copy
+            - copy+force
+            - skip
+            - null
+        mtu_size:
+          type:
+            - integer
+            - "null"
+        read_block_size:
+          type:
+            - integer
+            - "null"
+        write_block_size:
+          type:
+            - integer
+            - "null"
+        notifications:
+          type: array
+          items:
+            $ref: "#/components/schemas/NotificationSpec"
+        scheduled_start:
+          type:
+            - string
+            - "null"
+          format: date-time
+      required:
+        - source
+        - destination
+    SmartTransferSourceOverride:
+      type: object
+      properties:
+        paths:
+          type: array
+          items:
+            type: string
+        source_base:
+          type:
+            - string
+            - "null"
+    SmartTransferSubmitRequest:
+      type: object
+      properties:
+        name:
+          type:
+            - string
+            - "null"
+        comment:
+          type: string
+        source:
+          description: Omit entirely if the Smart Transfer does not allow selecting source items at start — including this section in that case returns an error.
+          allOf:
+            - $ref: "#/components/schemas/SmartTransferSourceOverride"
+        scheduled_start:
+          type:
+            - string
+            - "null"
+          format: date-time
+  responses:
+    Ok:
+      description: Success
+    Unauthorized:
+      description: Bad, missing, or locked username/password
+    Forbidden:
+      description: The operation lets the current user know the item exists, but they do not have permission to change it.
+    UnprocessableEntity:
+      description: Error. A JSON body with details is normally returned; if absent, check the mongrel logs.
+      content:
+        application/json:
+          schema:
+            $ref: "#/components/schemas/Error"
+  securitySchemes:
+    basicAuth:
+      type: http
+      scheme: basic
+      description: Username and password of a valid Console account.
+tags:
+  - name: transfers
+    description: Submit, control, and monitor individual transfers
+  - name: smart-transfers
+    description: Pre-configured Smart Transfer templates
+  - name: queues
+    description: Reorder items on transfer queues
+  - name: endpoints
+    description: Source/destination endpoints and SSH keys available to the account
+  - name: admin
+    description: Undocumented administrative actions
+  - name: health
+    description: Unauthenticated liveness/health-check endpoint for load balancers
+security:
+  - basicAuth: []