API Reference

Find real API operations and task actions by business module. Platform administration operations have a separate section.

Authentication and errors · View all downloads

Cloud Phone Management

• List Cloud Phones
• View Cloud Phone Details
• View Cloud Phone Statistics
• Create Cloud Phones: Get creation options and capacity for the current Cloud Card · Create Cloud Phones
• Power On
• Power Off
• Restart
• Rename a Cloud Phone
• Manage Cloud Phone Groups: List Cloud Phone groups · Update the Core Cloud Phone name or group
• Recycle Cloud Phones
• Restore Recycled Cloud Phones
• Permanently Delete Cloud Phones
• Repair Cloud Phones
• Factory Reset
• Reset as New Device
• Check Available Operations
• View Internal Network Addresses
• View Current Configuration
• Set Resolution
• Set Screen Orientation
• View Device Profiles: Get available legacy device-profile fields · Read a redacted device profile
• Update Device Profiles
• Manage Saved Configuration: Read six groups of redacted saved container settings · Manage Saved Configuration
• Set Network Proxy
• Check Proxy Egress
• Set DNS
• Simulate Incoming SMS

Image Management

• List Available Images
• View Compatible Device Models
• Create Cloud Phones from Images: Get creation options and capacity for the current Cloud Card · Create Cloud Phones from Images

Task Management

• Check Operation Conditions
• Submit Single or Batch Operations
• View Progress and Results
• View Task History
• Request Task Cancellation
• Find an Original Submission
• Verify Operations with Unknown Results

App Management

• List Installed Apps
• Browse Available Apps
• Install Uploaded Apps
• Install Apps from Links
• Start Apps
• Stop Apps
• Restart Apps
• Uninstall Apps
• List App Accessibility Services
• Configure App Accessibility Services
• Open App Accessibility Entry
• Hide App Accessibility Entry

File Management

• Upload Files: Create a cloud file upload session · Upload one file part · Merge parts and validate the file
• List Cloud Files
• View File Status
• Download Cloud Files: Issue a short-lived file download ticket · Read ready file content · Read a file using a short-lived ticket
• Delete Cloud Files
• Send Uploaded Files to Phones
• Send Files from Links
• Capture Cloud Phone Screenshots: Capture Cloud Phone Screenshots · Get cloud file status · Issue a short-lived file download ticket

Backup Management

• Check Backup Availability
• Create Backups
• View Backup History
• Download Backups
• Delete Backups
• Create Cloud Phones from Backups: Import a backup into the specified Cloud Card and create a new Cloud Phone · Create Cloud Phones from Backups

Screen Streaming and Preview

• Stream and Control Cloud Phones
• View Read-Only Previews
• Set Camera Images
• Set Camera Media

Cloud Card and Machine Room Resources

• List Cloud Cards
• View Cloud Card Details
• View Cloud Card Statistics
• View Machine Rooms

Access Authorization

• Grant Restricted Access
• Update Access Authorization
• Find Business Login Authorization
• Revoke Specific Access
• Revoke Business Login Access

Platform administration

Compatible Power-On Endpoint

Retains an endpoint for existing clients. The customer catalog describes power-on as one capability to avoid duplicate entries.

• Compatibility power-on endpoint: create a persistent task

Platform Version and Capability Lookup

Helps technical teams identify the Core version and global integration capabilities; it is not a customer business module.

• Get Core version and global capabilities

Service Credential Maintenance

Used by technical staff for trusted server integration and administrator credential lifecycle management.

• Create a service Key/Secret
• Disable a service credential

Cloud Card Allocation and Release Handover

Used by administrators for resource reservation, allocation, and cleanup handover. It is separate from Cloud Phone recycling and user access authorization.

• Reserve a Cloud Card and begin technical handover
• Allocate a reserved Cloud Card to a service identity
• Begin Cloud Card release
• Confirm cleanup and complete Cloud Card release

Service Health and Worker Readiness Checks

Used by deployment monitoring to check processes, data dependencies, and background Task processing. It does not indicate that a particular device is available.

• Check process liveness
• Check database and Redis readiness
• Check global background-task readiness

Machine Room Credential Maintenance

Used by platform technical staff to query, issue, rotate, disable, and revoke credentials for Machine Room connections.

• Get machine-room credential status without returning secrets
• Issue a machine-room credential for the first time
• Rotate a machine-room credential
• Disable a machine-room credential
• Revoke a machine-room credential

Machine Room Media Endpoint Configuration

Configures screen streaming infrastructure; it is not presented as a user screen streaming operation.

• Configure a machine-room media endpoint

Resume Subsequent Operations after an Unknown Task Result

Requires explicit human confirmation and only allows subsequent operations to continue. The original unknown result and cleanup restrictions remain. This is not a retry, a success result, or cancellation.

• Allow subsequent operations while preserving unknown task outcomes and cleanup gates

Device Command Execution

Intended for technical staff with device debugging permissions, rather than routine business use by semi-technical customers.

• Device Command Execution