JetStream Logo JetStream API
2.9.4

Getting Started

  • Requirements
    • Python API
    • Command Line API
    • Linux (64-bit)
    • macOS (64-bit)
    • Windows (64-bit)
  • Installation
    • Install
    • Update
    • Uninstall
  • Using JetStream API
    • Python
    • Command Line

API

  • Python API
    • JetStream
      • JetStream
      • Method Summary
      • Method Documentation
        • JetStream.api()
        • JetStream.api_listen()
    • APIInterface
      • APIInterface
      • Attributes
        • APIInterface.api_version
        • APIInterface.serverAddress
        • APIInterface.serverPort
        • APIInterface.timeoutSeconds
      • Method Summary
      • Method Documentation
        • APIInterface.connect()
        • APIInterface.disconnect()
        • APIInterface.get_cipher()
        • APIInterface.get_listen_socket()
        • APIInterface.get_server_certificate()
        • APIInterface.get_server_certificate_info()
        • APIInterface.is_connected()
        • APIInterface.is_secured()
        • APIInterface.listen()
        • APIInterface.secure_socket()
        • APIInterface.send_command()
    • RecvInterface
      • RecvInterface
      • Method Summary
      • Method Documentation
        • RecvInterface.addAuthorizedClientAsync()
        • RecvInterface.allowOnlyAuthorizedClientsAsync()
        • RecvInterface.getSourcesAsync()
        • RecvInterface.getTransfersAsync()
        • RecvInterface.removeAuthorizedClientAsync()
    • SendInterface
      • SendInterface
      • Method Summary
      • Method Documentation
        • SendInterface.createDestination()
        • SendInterface.createManifest()
        • SendInterface.createSharedToken()
        • SendInterface.createTransfer()
        • SendInterface.deleteDestination()
        • SendInterface.deleteManifest()
        • SendInterface.deleteObjectUserData()
        • SendInterface.deleteSharedToken()
        • SendInterface.deleteTransfer()
        • SendInterface.failTransfer()
        • SendInterface.getConnection()
        • SendInterface.getConnections()
        • SendInterface.getDestination()
        • SendInterface.getDestinations()
        • SendInterface.getManifest()
        • SendInterface.getManifestFiles()
        • SendInterface.getManifests()
        • SendInterface.getSharedToken()
        • SendInterface.getSharedTokens()
        • SendInterface.getTransfer()
        • SendInterface.getTransfers()
        • SendInterface.resumeTransferAsync()
        • SendInterface.schedulePingAsync()
        • SendInterface.setPriorityLanesAsync()
        • SendInterface.setSendRateMaxAsync()
        • SendInterface.setTransferPriorityAsync()
        • SendInterface.setTransferSendRateMaxAsync()
        • SendInterface.suspendTransferAsync()
        • SendInterface.updateConnectionParamsAsync()
        • SendInterface.updateObjectUserData()
        • SendInterface.updateSharedToken()
        • SendInterface.updateTransferDefaults()
        • SendInterface.waitForManifest()
        • SendInterface.waitForTransfer()
    • ServerInterface
      • ServerInterface
      • Method Summary
      • Method Documentation
        • ServerInterface.addWranglerAsync()
        • ServerInterface.auth()
        • ServerInterface.authAsync()
        • ServerInterface.authToken()
        • ServerInterface.createAPIToken()
        • ServerInterface.deleteAPIToken()
        • ServerInterface.deleteSandboxMapping()
        • ServerInterface.deleteWrangler()
        • ServerInterface.duAsync()
        • ServerInterface.echo()
        • ServerInterface.garbageCollect()
        • ServerInterface.getAPIToken()
        • ServerInterface.getAPITokens()
        • ServerInterface.getEventLog()
        • ServerInterface.getIdleReceiverPort()
        • ServerInterface.getIdleReceiverPortAsync()
        • ServerInterface.getRequestResult()
        • ServerInterface.getRequestStatus()
        • ServerInterface.getSandboxMappings()
        • ServerInterface.getServerInfo()
        • ServerInterface.getThirdPartyLicenses()
        • ServerInterface.getWranglers()
        • ServerInterface.lsAsync()
        • ServerInterface.lsListAsync()
        • ServerInterface.lsRootsAsync()
        • ServerInterface.mkFileAsync()
        • ServerInterface.mkdirAsync()
        • ServerInterface.mvAsync()
        • ServerInterface.recvDiscoverPacketAsync()
        • ServerInterface.rmAsync()
        • ServerInterface.sendDiscoverPacketAsync()
        • ServerInterface.setExternalAddress()
        • ServerInterface.setLicenseKeyAsync()
        • ServerInterface.setSandboxMapping()
        • ServerInterface.sleep()
        • ServerInterface.superuser()
        • ServerInterface.terminate()
        • ServerInterface.updateAPIToken()
        • ServerInterface.updateBandwidthLimits()
        • ServerInterface.updateGarbageCollectSettings()
        • ServerInterface.wrangler()
    • Helper
      • Helper
        • Helper
        • Method Summary
        • Method Documentation
      • TransferObject
        • TransferObject
        • Method Summary
        • Method Documentation
    • Constants
      • API_VERSION
      • BUILD_VERSION
      • DEFAULT_API_PORT
      • DEFAULT_SERVER_ADDRESS
      • DEFAULT_TIMEOUT_SECONDS
      • FILETYPE_DIRECTORY
      • FILETYPE_REGULAR_FILE
      • MIN_CIPHER_ENCRYPTED_128
      • MIN_CIPHER_ENCRYPTED_256
      • MIN_CIPHER_NONE
      • MIN_CIPHER_UNENCRYPTED
      • OVERWRITE_ALWAYS
      • OVERWRITE_IN_PLACE_SAME_SIZE
      • OVERWRITE_NEVER
      • OVERWRITE_VERSIONED
      • PERMISSIONS
      • SYMLINKS_COPY_CONTENTS
      • SYMLINKS_IGNORE
      • TRANSFER_FLAG_NONE
      • TRANSFER_FLAG_READ
      • TRANSFER_FLAG_READ_WRITE
      • TRANSFER_FLAG_WRITE
      • TRANSFER_FLAG_WRITE_MTIME
      • TRANSFER_FLAG_WRITE_ONLY_NEWER
    • Errors
      • Exception Hierarchy
      • APIConnectionUnavailableError
      • APIMethodDeprecatedError
      • APIMethodNotFoundError
      • ApiVersionError
      • CommandError
      • ConnectionNotFoundError
      • DestinationNotFoundError
      • FileSystemError
      • FileSystemOperationNotSupportedError
      • InsufficientPermissionsError
      • InvalidCredentialsError
      • InvalidLicenseError
      • InvalidParameterError
      • InvalidParameterFormatError
      • JetStreamClientException
      • JetstreamClientException
      • ManifestNotFoundError
      • NotAuthenticatedError
      • NotConnectedError
      • OperationFailedError
      • PacketTooBigError
      • ProtocolError
      • RequestNotFoundError
      • ResourceUnavailableError
      • SharedTokenNotFoundError
      • TransferNotFoundError
      • UnsupportedSSLVersionError
      • APIConnectionUnavailableError
      • APIMethodDeprecatedError
      • APIMethodNotFoundError
      • ApiVersionError
      • CommandError
      • ConnectionNotFoundError
      • DestinationNotFoundError
      • FileSystemError
      • FileSystemOperationNotSupportedError
      • InsufficientPermissionsError
      • InvalidCredentialsError
      • InvalidLicenseError
      • InvalidParameterError
      • InvalidParameterFormatError
      • JetStreamClientException
      • JetstreamClientException
      • ManifestNotFoundError
      • NotAuthenticatedError
      • NotConnectedError
      • OperationFailedError
      • PacketTooBigError
      • ProtocolError
      • RequestNotFoundError
      • ResourceUnavailableError
      • SharedTokenNotFoundError
      • TransferNotFoundError
      • UnsupportedSSLVersionError
    • Sample Scripts
    • Examples
      • Python API Examples
        • Connecting To A Server
        • Authenticating With a Server
        • Creating a Manifest
        • Monitoring a Manifest
        • Deleting a Manifest
        • Creating a Destination
        • Creating a Transfer
        • Monitoring A Transfer
        • Creating a Shared Token
        • Using a Shared Token
      • Helper Examples
        • getFileMappings
        • getFilteredManifestFiles
        • getTransferFlags
        • sendFiles
      • Sample scripts
        • Upload script (Client-to-Server)
        • Download script (Server-to-Client)
        • One-way sync (Server-to-Server)
        • Bi-directional sync (Server-to-Server)
        • Uni-directional sync (Server-to-Server)
      • Automatic startup
  • Console API
    • Synopsis
    • Description
    • Options
      • jetstream api
        • Options
    • Environment
    • Examples
      • Console API Examples
        • Connecting To A Server
        • Creating a Manifest
        • Monitoring a Manifest
        • Creating a Destination
        • Creating a Transfer
        • Monitoring A Transfer
  • Structures
    • Connection Structure
    • Destination Structure
      • Destination Transfer Defaults Structure
    • Discover Packet Structure
    • Event Log Structure
    • Garbage Collect Structure
    • Manifest Structure
    • Manifest Files Structure
      • File Mapping Structure
    • Source Structure
    • Receive Transfer Structure
    • Request Structure
    • Server Information Structure
      • Receiver Server Information Structure
      • Server Bandwidth Limits Structure
      • Server Configuration Structure
        • Cloud File Cache Structure
        • Garbage Collection Structure
      • Server License Structure
      • Server User Structure
    • Token Structure
    • Transfer Structure
  • Asynchronous Commands
    • RequestId
    • Using A RequestId
    • Expiry Of A RequestId
    • Asynchronous Requests vs Ongoing Tasks
  • Timestamps

Reference

  • Release Notes
    • 2.9.4 (API 42)
    • 2.9.3 (API 41)
    • 2.9.2 (API 40)
    • 2.9.1 (API 39)
    • 2.9.0 (API 38)
    • 2.8.3 (API 37)
    • 2.8.2 (API 37)
    • 2.8.1 (API 36)
    • 2.8.0 (API 36)
    • 2.7.2 (API 35)
    • 2.7.1 (API 35)
    • 2.6.5 (API 35)
    • 2.6.4 (API 35)
    • 2.6.3 (API 34)
    • 2.6.2 (API 34)
    • 2.6.1 (API 34)
    • 2.6.0 (API 34)
    • 2.5.3 (API 33)
    • 2.5.2 (API 33)
    • 2.5.1 (API 33)
    • 2.5.0 (API 32)
    • 2.4.0 (API 31)
    • 2.3.1 (API 30)
    • 2.3.0 (API 30)
    • 2.2.1 (API 29)
    • 2.2.0 (API 29)
    • 2.1.0 (API 28)
    • 2.0.2 (API 27)
    • 2.0.1 (API 27)
    • 2.0.0 (API 27)
  • Known Issues
  • Contact
  • Index
JetStream API
  • Docs »
  • Python API

Python API¶

  • JetStream
  • APIInterface
  • RecvInterface
  • SendInterface
  • ServerInterface
  • Helper
  • Constants
  • Errors
  • Sample Scripts

Examples¶

  • Python API Examples
    • Connecting To A Server
    • Authenticating With a Server
    • Creating a Manifest
    • Monitoring a Manifest
    • Deleting a Manifest
    • Creating a Destination
    • Creating a Transfer
    • Monitoring A Transfer
    • Creating a Shared Token
    • Using a Shared Token
  • Helper Examples
    • getFileMappings
    • getFilteredManifestFiles
    • getTransferFlags
    • sendFiles
  • Sample scripts
    • Upload script (Client-to-Server)
    • Download script (Server-to-Client)
    • One-way sync (Server-to-Server)
    • Bi-directional sync (Server-to-Server)
    • Uni-directional sync (Server-to-Server)
  • Automatic startup
Next Previous

© Copyright 2025, Jet Digital Inc.. Last updated on Jan 15, 2025 at 12:17.

JetStream API v: 2.9.4
Versions
Documentation version list could not be retrieved.
JetStream Documentation Reference
Client
Server
API