VMOSCloud OpenAPI 3.1 Spec
This page describes how to get the VMOSCloud OpenAPI 3.1 spec file for AI assistants, code generators, and tools. The spec matches the API Documentation in content; only the format is machine-readable OpenAPI.
📥 Download OpenAPI spec file — For Postman, Swagger Editor, AI tools
How to get it:
- Browser download: Click here to download openapi.yaml, or open
https://your-docs-domain/vmoscloud/doc/en/server/openapi.yaml. If the browser opens the file instead of downloading, right‑click the link and choose “Save link as”. - Command line:
curl https://your-docs-domain/vmoscloud/doc/en/server/openapi.yaml -o vmoscloud-openapi.yaml - Direct import: Use the URL above in Postman, Swagger Editor, or other tools to import the spec.
About the spec
- Scope: Same endpoints as in API Documentation — instance management, resources, apps, tasks, cloud phone, email, dynamic/static proxy, TK automation, SDK token.
- Request/response: Paths, methods, summaries, and parameter names match the API doc; for full types and examples see API Documentation.
- Authentication: HMAC-SHA256 (headers
x-date,x-host,Content-Type,authorization). See Getting Started.
Full spec
Full OpenAPI 3.1 spec below. You can copy from this page or download via the link above.
openapi: 3.1.0
info:
title: VMOSCloud OpenAPI
description: |
VMOSCloud server OpenAPI spec for AI/LLM/code assistants and tools.
API descriptions and request/response params match OpenAPI.md.
Auth and signing see Getting Started example.md.
version: "1.0.0"
servers:
- url: https://api.vmoscloud.com
description: VMOSCloud API server
security:
- VMOSCloudHMAC: []
tags:
- name: Instance Management
- name: Resource Management
- name: Application Management
- name: Task Management
- name: Cloud Phone Management
- name: Email Verification Service
- name: Dynamic Proxy Service
- name: Static Residential Proxy Service
- name: TK Automation
- name: SDK Token
paths:
/vcpcloud/api/padApi/setWifiList:
post:
tags:
- Instance Management
summary: Modify instance WIFI properties
operationId: vcpcloud_api_padApi_setWifiList_post
description: |
Request params (names/types per OpenAPI.md): "padCodes[], wifiJsonList[], SSID, BSSID, MAC, IP, gateway, DNS1, DNS2, hessid, anqpDomainId, capabilities, level, linkSpeed, txLinkSpeed, rxLinkSpeed, frequency, distance, distanceSd, channelWidth"
requestBody:
required: true
content:
application/json:
schema:
type: object
description: See OpenAPI.md request body/params for this API
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/api/padApi/padDetails:
post:
tags:
- Instance Management
summary: Instance details (pending)
operationId: vcpcloud_api_padApi_padDetails_post
description: |
Request params (names/types per OpenAPI.md): "padCodes[], padIps[], vmStatus, controlStatus, faultStatus, deviceStatus"
requestBody:
required: true
content:
application/json:
schema:
type: object
description: See OpenAPI.md request body/params for this API
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/api/padApi/restart:
post:
tags:
- Instance Management
summary: Instance restart
operationId: vcpcloud_api_padApi_restart_post
description: |
Request params (names/types per OpenAPI.md): "padCodes[]"
requestBody:
required: true
content:
application/json:
schema:
type: object
description: See OpenAPI.md request body/params for this API
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/api/padApi/reset:
post:
tags:
- Instance Management
summary: Instance reset
operationId: vcpcloud_api_padApi_reset_post
description: |
Request params (names/types per OpenAPI.md): "padCodes[]"
requestBody:
required: true
content:
application/json:
schema:
type: object
description: See OpenAPI.md request body/params for this API
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/api/padApi/padProperties:
post:
tags:
- Instance Management
summary: Query instance properties
operationId: vcpcloud_api_padApi_padProperties_post
description: |
Request params (names/types per OpenAPI.md): padCode
requestBody:
required: true
content:
application/json:
schema:
type: object
description: See OpenAPI.md request body/params for this API
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/api/padApi/batchPadProperties:
post:
tags:
- Instance Management
summary: Batch query instance properties
operationId: vcpcloud_api_padApi_batchPadProperties_post
description: |
Request params (names/types per OpenAPI.md): "padCodes[]"
requestBody:
required: true
content:
application/json:
schema:
type: object
description: See OpenAPI.md request body/params for this API
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/api/padApi/updatePadProperties:
post:
tags:
- Instance Management
summary: Modify instance properties (dynamic)
operationId: vcpcloud_api_padApi_updatePadProperties_post
description: |
Request params (names/types per OpenAPI.md): "padCodes[], modemPersistPropertiesList[], propertiesName, propertiesValue, modemPropertiesList[], systemPersistPropertiesList[], systemPropertiesList[], settingPropertiesList[], oaidPropertiesList[]"
requestBody:
required: true
content:
application/json:
schema:
type: object
description: See OpenAPI.md request body/params for this API
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/api/padApi/updatePadAndroidProp:
post:
tags:
- Instance Management
summary: Modify instance Android modification props (restart required)
operationId: vcpcloud_api_padApi_updatePadAndroidProp_post
description: |
Request params (names/types per OpenAPI.md): padCode, restart, props, ro.product.vendor.name
requestBody:
required: true
content:
application/json:
schema:
type: object
description: See OpenAPI.md request body/params for this API
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/api/padApi/updateSIM:
post:
tags:
- Instance Management
summary: Modify SIM by country code
operationId: vcpcloud_api_padApi_updateSIM_post
description: |
Request params (names/types per OpenAPI.md): padCode, countryCode, props, ro.product.vendor.name
requestBody:
required: true
content:
application/json:
schema:
type: object
description: See OpenAPI.md request body/params for this API
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/api/padApi/dissolveRoom:
post:
tags:
- Instance Management
summary: Stop streaming
operationId: vcpcloud_api_padApi_dissolveRoom_post
description: |
Request params (names/types per OpenAPI.md): "padCodes[]"
requestBody:
required: true
content:
application/json:
schema:
type: object
description: See OpenAPI.md request body/params for this API
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/api/padApi/checkIP:
post:
tags:
- Instance Management
summary: Smart IP proxy detection
operationId: vcpcloud_api_padApi_checkIP_post
description: |
Request params (names/types per OpenAPI.md): host, port, account, password, type, country, ip, loc, city, region, timezone
requestBody:
required: true
content:
application/json:
schema:
type: object
description: See OpenAPI.md request body/params for this API
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/api/padApi/smartIp:
post:
tags:
- Instance Management
summary: Set smart IP
operationId: vcpcloud_api_padApi_smartIp_post
description: |
Request params (names/types per OpenAPI.md): "padCodes[], host, port, account, password, type, mode, bypassPackageList[], bypassIpList[], bypassDomainList[]"
requestBody:
required: true
content:
application/json:
schema:
type: object
description: See OpenAPI.md request body/params for this API
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/api/padApi/notSmartIp:
post:
tags:
- Instance Management
summary: Cancel smart IP
operationId: vcpcloud_api_padApi_notSmartIp_post
description: |
Request params (names/types per OpenAPI.md): "padCodes[]"
requestBody:
required: true
content:
application/json:
schema:
type: object
description: See OpenAPI.md request body/params for this API
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/api/padApi/getTaskStatus:
post:
tags:
- Instance Management
summary: Device task result query (smart IP)
operationId: vcpcloud_api_padApi_getTaskStatus_post
description: |
Request params (names/types per OpenAPI.md): taskId
requestBody:
required: true
content:
application/json:
schema:
type: object
description: See OpenAPI.md request body/params for this API
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/api/padApi/getListInstalledApp:
post:
tags:
- Instance Management
summary: Get installed apps for specified instances
operationId: vcpcloud_api_padApi_getListInstalledApp_post
description: |
Request params (names/types per OpenAPI.md): "padCodeList[]"
requestBody:
required: true
content:
application/json:
schema:
type: object
description: See OpenAPI.md request body/params for this API
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/api/padApi/updateTimeZone:
post:
tags:
- Instance Management
summary: Modify instance timezone
operationId: vcpcloud_api_padApi_updateTimeZone_post
description: |
Request params (names/types per OpenAPI.md): "timeZone, padCodes[]"
requestBody:
required: true
content:
application/json:
schema:
type: object
description: See OpenAPI.md request body/params for this API
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/api/padApi/updateLanguage:
post:
tags:
- Instance Management
summary: Modify instance language
operationId: vcpcloud_api_padApi_updateLanguage_post
description: |
Request params (names/types per OpenAPI.md): "language, country, padCodes[]"
requestBody:
required: true
content:
application/json:
schema:
type: object
description: See OpenAPI.md request body/params for this API
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/api/padApi/gpsInjectInfo:
post:
tags:
- Instance Management
summary: Set instance GPS
operationId: vcpcloud_api_padApi_gpsInjectInfo_post
description: |
Request params (names/types per OpenAPI.md): "longitude, latitude, altitude, speed, bearing, horizontalAccuracyMeters, padCodes[]"
requestBody:
required: true
content:
application/json:
schema:
type: object
description: See OpenAPI.md request body/params for this API
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/open/network/proxy/info:
post:
tags:
- Instance Management
summary: Query instance proxy info (pending)
operationId: vcpcloud_open_network_proxy_info_post
description: |
Request params (names/types per OpenAPI.md): "padCodes[], padCode"
requestBody:
required: true
content:
application/json:
schema:
type: object
description: See OpenAPI.md request body/params for this API
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/api/padApi/replacePad:
post:
tags:
- Instance Management
summary: One-key new device
operationId: vcpcloud_api_padApi_replacePad_post
description: |
Request params (names/types per OpenAPI.md): "padCodes[], countryCode, realPhoneTemplateId, androidProp, replacementRealAdiFlag, excludeRealPhoneTemplateIds[], certificate, wipeData, wipeSpecificData[]"
requestBody:
required: true
content:
application/json:
schema:
type: object
description: See OpenAPI.md request body/params for this API
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/api/padApi/country:
get:
tags:
- Instance Management
summary: Query one-key new device supported countries
operationId: vcpcloud_api_padApi_country_get
description: |
Request params (names/types per OpenAPI.md): None
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/api/padApi/updateContacts:
post:
tags:
- Instance Management
summary: Update contacts
operationId: vcpcloud_api_padApi_updateContacts_post
description: |
Request params (names/types per OpenAPI.md): "padCodes[], fileUniqueId, operateType, info[], firstName, phone, email"
requestBody:
required: true
content:
application/json:
schema:
type: object
description: See OpenAPI.md request body/params for this API
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/api/padApi/setProxy:
post:
tags:
- Instance Management
summary: Set instance proxy
operationId: vcpcloud_api_padApi_setProxy_post
description: |
Request params (names/types per OpenAPI.md): "account, password, ip, port, enable, padCodes[], proxyType, proxyName, bypassPackageList[], bypassIpList[], bypassDomainList[], sUoT"
requestBody:
required: true
content:
application/json:
schema:
type: object
description: See OpenAPI.md request body/params for this API
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/api/padApi/listInstalledApp:
post:
tags:
- Instance Management
summary: Real-time query installed app list
operationId: vcpcloud_api_padApi_listInstalledApp_post
description: |
Request params (names/types per OpenAPI.md): "padCodes[], appName"
requestBody:
required: true
content:
application/json:
schema:
type: object
description: See OpenAPI.md request body/params for this API
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/api/padApi/setKeepAliveApp:
post:
tags:
- Instance Management
summary: Set app keep-alive
operationId: vcpcloud_api_padApi_setKeepAliveApp_post
description: |
Request params (names/types per OpenAPI.md): "padCodes[], applyAllInstances, appInfos[], serverName"
requestBody:
required: true
content:
application/json:
schema:
type: object
description: See OpenAPI.md request body/params for this API
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/api/padApi/setHideAppList:
post:
tags:
- Instance Management
summary: Set app hide (pending)
operationId: vcpcloud_api_padApi_setHideAppList_post
description: |
Request params (names/types per OpenAPI.md): "padCodes[], appInfos[], packageName"
requestBody:
required: true
content:
application/json:
schema:
type: object
description: See OpenAPI.md request body/params for this API
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/api/padApi/replaceRealAdiTemplate:
post:
tags:
- Instance Management
summary: Modify real device ADI template
operationId: vcpcloud_api_padApi_replaceRealAdiTemplate_post
description: |
Request params (names/types per OpenAPI.md): "padCodes[], wipeData, realPhoneTemplateId"
requestBody:
required: true
content:
application/json:
schema:
type: object
description: See OpenAPI.md request body/params for this API
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/api/padApi/asyncCmd:
post:
tags:
- Instance Management
summary: Async execute ADB command
operationId: vcpcloud_api_padApi_asyncCmd_post
description: |
Request params (names/types per OpenAPI.md): "padCodes[], scriptContent"
requestBody:
required: true
content:
application/json:
schema:
type: object
description: See OpenAPI.md request body/params for this API
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/api/padApi/switchRoot:
post:
tags:
- Instance Management
summary: Switch Root permission
operationId: vcpcloud_api_padApi_switchRoot_post
description: |
Request params (names/types per OpenAPI.md): "padCodes[], globalRoot, packageName, rootStatus"
requestBody:
required: true
content:
application/json:
schema:
type: object
description: See OpenAPI.md request body/params for this API
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/api/padApi/screenshot:
post:
tags:
- Instance Management
summary: Local screenshot
operationId: vcpcloud_api_padApi_screenshot_post
description: |
Request params (names/types per OpenAPI.md): "padCodes[], rotation, broadcast, definition, resolutionHeight, resolutionWidth"
requestBody:
required: true
content:
application/json:
schema:
type: object
description: See OpenAPI.md request body/params for this API
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/api/padApi/getLongGenerateUrl:
post:
tags:
- Instance Management
summary: Get instance real-time preview image
operationId: vcpcloud_api_padApi_getLongGenerateUrl_post
description: |
Request params (names/types per OpenAPI.md): "padCodes[], format, height, width, quality"
requestBody:
required: true
content:
application/json:
schema:
type: object
description: See OpenAPI.md request body/params for this API
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/api/padApi/upgradeImage:
post:
tags:
- Instance Management
summary: Upgrade image
operationId: vcpcloud_api_padApi_upgradeImage_post
description: |
Request params (names/types per OpenAPI.md): "padCodes[], imageId, wipeData, enableCpuCoreConfig"
requestBody:
required: true
content:
application/json:
schema:
type: object
description: See OpenAPI.md request body/params for this API
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/api/padApi/virtualRealSwitch:
post:
tags:
- Instance Management
summary: Upgrade real device image
operationId: vcpcloud_api_padApi_virtualRealSwitch_post
description: |
Request params (names/types per OpenAPI.md): "padCodes[], imageId, wipeData, realPhoneTemplateId, upgradeImageConvertType, screenLayoutId, certificate, deviceAndroidProps, enableCpuCoreConfig"
requestBody:
required: true
content:
application/json:
schema:
type: object
description: See OpenAPI.md request body/params for this API
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/api/padApi/templateList:
post:
tags:
- Instance Management
summary: Paginated get real device templates
operationId: vcpcloud_api_padApi_templateList_post
description: |
Request params (names/types per OpenAPI.md): page, rows
requestBody:
required: true
content:
application/json:
schema:
type: object
description: See OpenAPI.md request body/params for this API
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/api/padApi/modelInfo:
post:
tags:
- Instance Management
summary: Batch get instance model info (pending)
operationId: vcpcloud_api_padApi_modelInfo_post
description: |
Request params (names/types per OpenAPI.md): "padCodes[]"
requestBody:
required: true
content:
application/json:
schema:
type: object
description: See OpenAPI.md request body/params for this API
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/api/padApi/setSpeed:
post:
tags:
- Instance Management
summary: Set instance bandwidth (pending)
operationId: vcpcloud_api_padApi_setSpeed_post
description: |
Request params (names/types per OpenAPI.md): "padCodes[], upBandwidth, downBandwidth"
requestBody:
required: true
content:
application/json:
schema:
type: object
description: See OpenAPI.md request body/params for this API
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/api/padApi/openOnlineAdb:
post:
tags:
- Instance Management
summary: Enable/disable ADB
operationId: vcpcloud_api_padApi_openOnlineAdb_post
description: |
Request params (names/types per OpenAPI.md): "padCodes[], openStatus"
requestBody:
required: true
content:
application/json:
schema:
type: object
description: See OpenAPI.md request body/params for this API
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/api/padApi/adb:
post:
tags:
- Instance Management
summary: Get ADB connection info
operationId: vcpcloud_api_padApi_adb_post
description: |
Request params (names/types per OpenAPI.md): padCode, enable
requestBody:
required: true
content:
application/json:
schema:
type: object
description: See OpenAPI.md request body/params for this API
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/api/padApi/batch/adb:
post:
tags:
- Instance Management
summary: Batch get ADB connection info (pending)
operationId: vcpcloud_api_padApi_batch_adb_post
description: |
Request params (names/types per OpenAPI.md): "padCodes[], enable"
requestBody:
required: true
content:
application/json:
schema:
type: object
description: See OpenAPI.md request body/params for this API
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/api/padApi/simulateTouch:
post:
tags:
- Instance Management
summary: Simulate touch
operationId: vcpcloud_api_padApi_simulateTouch_post
description: |
Request params (names/types per OpenAPI.md): "padCodes[], width, height, pointCount, positions[]"
requestBody:
required: true
content:
application/json:
schema:
type: object
description: See OpenAPI.md request body/params for this API
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/api/padApi/padTaskDetail:
post:
tags:
- Instance Management
summary: Instance operation task details
operationId: vcpcloud_api_padApi_padTaskDetail_post
description: |
Request params (names/types per OpenAPI.md): "taskIds[], taskId"
requestBody:
required: true
content:
application/json:
schema:
type: object
description: See OpenAPI.md request body/params for this API
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/api/padApi/executeScriptInfo:
post:
tags:
- Instance Management
summary: Get instance script execution result (pending)
operationId: vcpcloud_api_padApi_executeScriptInfo_post
description: |
Request params (names/types per OpenAPI.md): taskIds
requestBody:
required: true
content:
application/json:
schema:
type: object
description: See OpenAPI.md request body/params for this API
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/api/padApi/screenshotInfo:
post:
tags:
- Instance Management
summary: Get instance screenshot result (pending)
operationId: vcpcloud_api_padApi_screenshotInfo_post
description: |
Request params (names/types per OpenAPI.md): taskIds
requestBody:
required: true
content:
application/json:
schema:
type: object
description: See OpenAPI.md request body/params for this API
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/api/padApi/padExecuteTaskInfo:
post:
tags:
- Instance Management
summary: Instance restart/reset execution result (pending)
operationId: vcpcloud_api_padApi_padExecuteTaskInfo_post
description: |
Request params (names/types per OpenAPI.md): taskIds
requestBody:
required: true
content:
application/json:
schema:
type: object
description: See OpenAPI.md request body/params for this API
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/api/padApi/infos:
post:
tags:
- Instance Management
summary: Instance group list / instance list info
operationId: vcpcloud_api_padApi_infos_post
description: |
Request params (names/types per OpenAPI.md): "page, rows, padType, padCodes[]"
requestBody:
required: true
content:
application/json:
schema:
type: object
description: See OpenAPI.md request body/params for this API
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/api/padApi/addPhoneRecord:
post:
tags:
- Instance Management
summary: Import call records
operationId: vcpcloud_api_padApi_addPhoneRecord_post
description: |
Request params (names/types per OpenAPI.md): "padCodes[], callRecords[]"
requestBody:
required: true
content:
application/json:
schema:
type: object
description: See OpenAPI.md request body/params for this API
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/api/padApi/inputText:
post:
tags:
- Instance Management
summary: Cloud phone text input
operationId: vcpcloud_api_padApi_inputText_post
description: |
Request params (names/types per OpenAPI.md): "padCodes[], text, code, msg, ts, data[], padCode, taskId, vmStatus, taskStatus"
requestBody:
required: true
content:
application/json:
schema:
type: object
description: See OpenAPI.md request body/params for this API
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/api/padApi/simulateSendSms:
post:
tags:
- Instance Management
summary: Simulate send SMS
operationId: vcpcloud_api_padApi_simulateSendSms_post
description: |
Request params (names/types per OpenAPI.md): "padCodes[], senderNumber, smsContent"
requestBody:
required: true
content:
application/json:
schema:
type: object
description: See OpenAPI.md request body/params for this API
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/api/padApi/resetGAID:
post:
tags:
- Instance Management
summary: Reset GAID
operationId: vcpcloud_api_padApi_resetGAID_post
description: |
Request params (names/types per OpenAPI.md): "padCodes[], resetGmsType, oprBy, taskSource"
requestBody:
required: true
content:
application/json:
schema:
type: object
description: See OpenAPI.md request body/params for this API
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/api/padApi/injectAudioToMic:
post:
tags:
- Instance Management
summary: Inject audio to instance microphone
operationId: vcpcloud_api_padApi_injectAudioToMic_post
description: |
Request params (names/types per OpenAPI.md): "padCodes[], url, fileUniqueId, enable"
requestBody:
required: true
content:
application/json:
schema:
type: object
description: See OpenAPI.md request body/params for this API
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/api/padApi/localPodBackup:
post:
tags:
- Instance Management
summary: Create local instance backup (pending)
operationId: vcpcloud_api_padApi_localPodBackup_post
description: |
Request params (names/types per OpenAPI.md): padCode, backupName, backupPath, ossConfig, credentialType
requestBody:
required: true
content:
application/json:
schema:
type: object
description: See OpenAPI.md request body/params for this API
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/api/padApi/localPodRestore:
post:
tags:
- Instance Management
summary: Create local instance restore (pending)
operationId: vcpcloud_api_padApi_localPodRestore_post
description: |
Request params (names/types per OpenAPI.md): backupId, padCode, ossConfig, credentialType
requestBody:
required: true
content:
application/json:
schema:
type: object
description: See OpenAPI.md request body/params for this API
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/api/padApi/localPodBackupSelectPage:
post:
tags:
- Instance Management
summary: Local instance backup result query (pending)
operationId: vcpcloud_api_padApi_localPodBackupSelectPage_post
description: |
Request params (names/types per OpenAPI.md): "page, rows, padCodes[], padCode"
requestBody:
required: true
content:
application/json:
schema:
type: object
description: See OpenAPI.md request body/params for this API
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/api/padApi/cleanAppHome:
post:
tags:
- Instance Management
summary: Clear processes and return to desktop (pending)
operationId: vcpcloud_api_padApi_cleanAppHome_post
description: |
Request params (names/types per OpenAPI.md): "padCodes[]"
requestBody:
required: true
content:
application/json:
schema:
type: object
description: See OpenAPI.md request body/params for this API
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/api/padApi/unmannedLive:
post:
tags:
- Instance Management
summary: Unmanned live streaming
operationId: vcpcloud_api_padApi_unmannedLive_post
description: |
Request params (names/types per OpenAPI.md): "padCodes[], injectSwitch, injectLoop, injectUrl, injectUrls[]"
requestBody:
required: true
content:
application/json:
schema:
type: object
description: See OpenAPI.md request body/params for this API
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/api/padApi/injectPicture:
post:
tags:
- Instance Management
summary: Image injection (pending)
operationId: vcpcloud_api_padApi_injectPicture_post
description: |
Request params (names/types per OpenAPI.md): "padCodes[], injectSwitch, injectLoop, injectUrl"
requestBody:
required: true
content:
application/json:
schema:
type: object
description: See OpenAPI.md request body/params for this API
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/api/padApi/addUserRom:
post:
tags:
- Instance Management
summary: Upload user image
operationId: vcpcloud_api_padApi_addUserRom_post
description: |
Request params (names/types per OpenAPI.md): name, updateLog, androidVersion, version, downloadUrl, packageSize
requestBody:
required: true
content:
application/json:
schema:
type: object
description: See OpenAPI.md request body/params for this API
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/api/padApi/replacement:
post:
tags:
- Instance Management
summary: Device replacement
operationId: vcpcloud_api_padApi_replacement_post
description: |
Request params (names/types per OpenAPI.md): padCode
requestBody:
required: true
content:
application/json:
schema:
type: object
description: See OpenAPI.md request body/params for this API
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/api/padApi/confirmTransfer:
post:
tags:
- Instance Management
summary: Transfer cloud phone
operationId: vcpcloud_api_padApi_confirmTransfer_post
description: |
Request params (names/types per OpenAPI.md): "padCodes[], makeOverMobilePhone"
requestBody:
required: true
content:
application/json:
schema:
type: object
description: See OpenAPI.md request body/params for this API
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/api/padApi/setHideAccessibilityAppList:
post:
tags:
- Instance Management
summary: Hide accessibility service
operationId: vcpcloud_api_padApi_setHideAccessibilityAppList_post
description: |
Request params (names/types per OpenAPI.md): "padCodes[], appInfos[], packageName"
requestBody:
required: true
content:
application/json:
schema:
type: object
description: See OpenAPI.md request body/params for this API
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/api/padApi/uninstallApp:
post:
tags:
- Application Management
summary: Uninstall app
operationId: vcpcloud_api_padApi_uninstallApp_post
description: |
Request params (names/types per OpenAPI.md): "apkPackageList[], padCodeList[]"
requestBody:
required: true
content:
application/json:
schema:
type: object
description: See OpenAPI.md request body/params for this API
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/api/padApi/startApp:
post:
tags:
- Application Management
summary: Start app
operationId: vcpcloud_api_padApi_startApp_post
description: |
Request params (names/types per OpenAPI.md): "pkgName, padCodes[]"
requestBody:
required: true
content:
application/json:
schema:
type: object
description: See OpenAPI.md request body/params for this API
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/api/padApi/stopApp:
post:
tags:
- Application Management
summary: Stop app
operationId: vcpcloud_api_padApi_stopApp_post
description: |
Request params (names/types per OpenAPI.md): "pkgName, padCodes[]"
requestBody:
required: true
content:
application/json:
schema:
type: object
description: See OpenAPI.md request body/params for this API
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/api/padApi/restartApp:
post:
tags:
- Application Management
summary: Restart app
operationId: vcpcloud_api_padApi_restartApp_post
description: |
Request params (names/types per OpenAPI.md): "pkgName, padCodes[]"
requestBody:
required: true
content:
application/json:
schema:
type: object
description: See OpenAPI.md request body/params for this API
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/api/padApi/uploadFileV3:
post:
tags:
- Application Management
summary: Upload file via URL
operationId: vcpcloud_api_padApi_uploadFileV3_post
description: |
Request params (names/types per OpenAPI.md): "padCodes[], padCode, autoInstall, fileUniqueId, customizeFilePath, fileName, packageName, url, md5, isAuthorization, iconPath"
requestBody:
required: true
content:
application/json:
schema:
type: object
description: See OpenAPI.md request body/params for this API
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/api/padApi/uploadFile:
post:
tags:
- Application Management
summary: Upload file to cloud storage
operationId: vcpcloud_api_padApi_uploadFile_post
description: |
Request params (names/types per OpenAPI.md): file
requestBody:
required: true
content:
application/json:
schema:
type: object
description: See OpenAPI.md request body/params for this API
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/api/padApi/deleteOssFiles:
post:
tags:
- Application Management
summary: Delete cloud storage files
operationId: vcpcloud_api_padApi_deleteOssFiles_post
description: |
Request params (names/types per OpenAPI.md): "files[], urls[]"
requestBody:
required: true
content:
application/json:
schema:
type: object
description: See OpenAPI.md request body/params for this API
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/api/padApi/selectFiles:
post:
tags:
- Application Management
summary: Query user file list
operationId: vcpcloud_api_padApi_selectFiles_post
description: |
Request params (names/types per OpenAPI.md): None
requestBody:
required: true
content:
application/json:
schema:
type: object
description: See OpenAPI.md request body/params for this API
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/api/padApi/fileTaskDetail:
post:
tags:
- Task Management
summary: File task details
operationId: vcpcloud_api_padApi_fileTaskDetail_post
description: |
Request params (names/types per OpenAPI.md): "taskIds[], taskId"
requestBody:
required: true
content:
application/json:
schema:
type: object
description: See OpenAPI.md request body/params for this API
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/api/padApi/createMoneyOrder:
post:
tags:
- Cloud Phone Management
summary: Create/renew cloud phone
operationId: vcpcloud_api_padApi_createMoneyOrder_post
description: |
Request params (names/types per OpenAPI.md): androidVersionName, goodId, goodNum, autoRenew, equipmentId
requestBody:
required: true
content:
application/json:
schema:
type: object
description: See OpenAPI.md request body/params for this API
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/api/padApi/userPadList:
post:
tags:
- Cloud Phone Management
summary: Cloud phone list
operationId: vcpcloud_api_padApi_userPadList_post
description: |
Request params (names/types per OpenAPI.md): "padCode, equipmentIds[]"
requestBody:
required: true
content:
application/json:
schema:
type: object
description: See OpenAPI.md request body/params for this API
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/api/padApi/padInfo:
post:
tags:
- Cloud Phone Management
summary: Cloud phone info query
operationId: vcpcloud_api_padApi_padInfo_post
description: |
Request params (names/types per OpenAPI.md): padCode
requestBody:
required: true
content:
application/json:
schema:
type: object
description: See OpenAPI.md request body/params for this API
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/api/padApi/getCloudGoodList:
get:
tags:
- Cloud Phone Management
summary: SKU package list
operationId: vcpcloud_api_padApi_getCloudGoodList_get
description: |
Request params (names/types per OpenAPI.md): androidVersion
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/api/padApi/createMoneyProOrder:
post:
tags:
- Cloud Phone Management
summary: Device presale purchase
operationId: vcpcloud_api_padApi_createMoneyProOrder_post
description: |
Request params (names/types per OpenAPI.md): androidVersionName, goodId, goodNum, autoRenew
requestBody:
required: true
content:
application/json:
schema:
type: object
description: See OpenAPI.md request body/params for this API
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/api/padApi/queryProOrderList:
post:
tags:
- Cloud Phone Management
summary: Query presale order result details
operationId: vcpcloud_api_padApi_queryProOrderList_post
description: |
Request params (names/types per OpenAPI.md): proBuyStatus, orderId
requestBody:
required: true
content:
application/json:
schema:
type: object
description: See OpenAPI.md request body/params for this API
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/api/padApi/imageVersionList:
post:
tags:
- Cloud Phone Management
summary: Android image version list
operationId: vcpcloud_api_padApi_imageVersionList_post
description: |
Request params (names/types per OpenAPI.md): padCode
requestBody:
required: true
content:
application/json:
schema:
type: object
description: See OpenAPI.md request body/params for this API
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/api/padApi/createByTimingOrder:
post:
tags:
- Cloud Phone Management
summary: Create timing device order
operationId: vcpcloud_api_padApi_createByTimingOrder_post
description: |
Request params (names/types per OpenAPI.md): goodId, goodNum
requestBody:
required: true
content:
application/json:
schema:
type: object
description: See OpenAPI.md request body/params for this API
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/api/padApi/timingPadOn:
post:
tags:
- Cloud Phone Management
summary: Timing device power on
operationId: vcpcloud_api_padApi_timingPadOn_post
description: |
Request params (names/types per OpenAPI.md): "padCodes[], defCode, netStorageResUnitCode"
requestBody:
required: true
content:
application/json:
schema:
type: object
description: See OpenAPI.md request body/params for this API
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/api/padApi/timingPadOff:
post:
tags:
- Cloud Phone Management
summary: Timing device power off
operationId: vcpcloud_api_padApi_timingPadOff_post
description: |
Request params (names/types per OpenAPI.md): "padCodes[], isBackUp, remark"
requestBody:
required: true
content:
application/json:
schema:
type: object
description: See OpenAPI.md request body/params for this API
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/api/padApi/timingPadDel:
post:
tags:
- Cloud Phone Management
summary: Timing device destroy
operationId: vcpcloud_api_padApi_timingPadDel_post
description: |
Request params (names/types per OpenAPI.md): "padCodes[]"
requestBody:
required: true
content:
application/json:
schema:
type: object
description: See OpenAPI.md request body/params for this API
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/api/padApi/vcTimingBackupList:
get:
tags:
- Cloud Phone Management
summary: Storage resource package list
operationId: vcpcloud_api_padApi_vcTimingBackupList_get
description: |
Request params (names/types per OpenAPI.md): None
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/api/padApi/getRenewStorageInfo:
get:
tags:
- Cloud Phone Management
summary: Cloud storage remaining capacity
operationId: vcpcloud_api_padApi_getRenewStorageInfo_get
description: |
Request params (names/types per OpenAPI.md): None
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/api/padApi/getVcStorageGoods:
get:
tags:
- Cloud Phone Management
summary: Cloud storage product list
operationId: vcpcloud_api_padApi_getVcStorageGoods_get
description: |
Request params (names/types per OpenAPI.md): None
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/api/padApi/buyStorageGoods:
post:
tags:
- Cloud Phone Management
summary: Purchase cloud storage expansion
operationId: vcpcloud_api_padApi_buyStorageGoods_post
description: |
Request params (names/types per OpenAPI.md): storageId, autoRenewOrder
requestBody:
required: true
content:
application/json:
schema:
type: object
description: See OpenAPI.md request body/params for this API
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/api/padApi/selectAutoRenew:
get:
tags:
- Cloud Phone Management
summary: Cloud storage renewal details query
operationId: vcpcloud_api_padApi_selectAutoRenew_get
description: |
Request params (names/types per OpenAPI.md): None
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/api/padApi/renewsStorageGoods:
post:
tags:
- Cloud Phone Management
summary: Aggregate renew cloud storage products
operationId: vcpcloud_api_padApi_renewsStorageGoods_post
description: |
Request params (names/types per OpenAPI.md): autoRenewOrder
requestBody:
required: true
content:
application/json:
schema:
type: object
description: See OpenAPI.md request body/params for this API
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/api/padApi/updateRenewStorageStatus:
get:
tags:
- Cloud Phone Management
summary: Cloud storage auto-renewal switch
operationId: vcpcloud_api_padApi_updateRenewStorageStatus_get
description: |
Request params (names/types per OpenAPI.md): renewStorageStatus
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/api/padApi/deleteUploadFiles:
post:
tags:
- Cloud Phone Management
summary: Delete backup resource package data
operationId: vcpcloud_api_padApi_deleteUploadFiles_post
description: |
Request params (names/types per OpenAPI.md): "backupIds[]"
requestBody:
required: true
content:
application/json:
schema:
type: object
description: See OpenAPI.md request body/params for this API
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/api/padApi/toggleProcessHide:
post:
tags:
- Cloud Phone Management
summary: Show or hide app process
operationId: vcpcloud_api_padApi_toggleProcessHide_post
description: |
Request params (names/types per OpenAPI.md): "padCodes[], show, packageName"
requestBody:
required: true
content:
application/json:
schema:
type: object
description: See OpenAPI.md request body/params for this API
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/api/padApi/getEmailServiceList:
get:
tags:
- Email Verification Service
summary: Get email service list
operationId: vcpcloud_api_padApi_getEmailServiceList_get
description: |
Request params (names/types per OpenAPI.md): None
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/api/padApi/getEmailTypeList:
get:
tags:
- Email Verification Service
summary: Get email type and remaining stock
operationId: vcpcloud_api_padApi_getEmailTypeList_get
description: |
Request params (names/types per OpenAPI.md): serviceId
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/api/padApi/createEmailOrder:
post:
tags:
- Email Verification Service
summary: Create email order
operationId: vcpcloud_api_padApi_createEmailOrder_post
description: |
Request params (names/types per OpenAPI.md): serviceId, emailTypeId, goodNum
requestBody:
required: true
content:
application/json:
schema:
type: object
description: See OpenAPI.md request body/params for this API
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/api/padApi/getEmailOrder:
get:
tags:
- Email Verification Service
summary: Query purchased email list
operationId: vcpcloud_api_padApi_getEmailOrder_get
description: |
Request params (names/types per OpenAPI.md): page, size, serviceId, email, status
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/api/padApi/getEmailCode:
get:
tags:
- Email Verification Service
summary: Refresh get email verification code
operationId: vcpcloud_api_padApi_getEmailCode_get
description: |
Request params (names/types per OpenAPI.md): orderId
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/api/padApi/getDynamicGoodService:
get:
tags:
- Dynamic Proxy Service
summary: Query dynamic proxy product list
operationId: vcpcloud_api_padApi_getDynamicGoodService_get
description: |
Request params (names/types per OpenAPI.md): None
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/api/padApi/getDynamicProxyRegion:
get:
tags:
- Dynamic Proxy Service
summary: Query dynamic proxy region list
operationId: vcpcloud_api_padApi_getDynamicProxyRegion_get
description: |
Request params (names/types per OpenAPI.md): None
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/api/padApi/queryCurrentTrafficBalance:
get:
tags:
- Dynamic Proxy Service
summary: Get dynamic proxy current balance
operationId: vcpcloud_api_padApi_queryCurrentTrafficBalance_get
description: |
Request params (names/types per OpenAPI.md): None
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/api/padApi/getDynamicProxyHost:
get:
tags:
- Dynamic Proxy Service
summary: Query supported server regions
operationId: vcpcloud_api_padApi_getDynamicProxyHost_get
description: |
Request params (names/types per OpenAPI.md): None
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/api/padApi/buyDynamicProxy:
post:
tags:
- Dynamic Proxy Service
summary: Purchase dynamic proxy traffic package
operationId: vcpcloud_api_padApi_buyDynamicProxy_post
description: |
Request params (names/types per OpenAPI.md): goodId, goodNum, autoRenewOrder
requestBody:
required: true
content:
application/json:
schema:
type: object
description: See OpenAPI.md request body/params for this API
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/api/padApi/createProxy:
post:
tags:
- Dynamic Proxy Service
summary: Create dynamic proxy
operationId: vcpcloud_api_padApi_createProxy_post
description: |
Request params (names/types per OpenAPI.md): city, countryCode, goodNum, proxyHost, proxyType, proxyUseType, state, time
requestBody:
required: true
content:
application/json:
schema:
type: object
description: See OpenAPI.md request body/params for this API
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/api/padApi/getProxys:
get:
tags:
- Dynamic Proxy Service
summary: Query dynamic proxy list
operationId: vcpcloud_api_padApi_getProxys_get
description: |
Request params (names/types per OpenAPI.md): page, rows
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/api/padApi/getDynamicProxyOrders:
post:
tags:
- Dynamic Proxy Service
summary: Query dynamic proxy order list
operationId: vcpcloud_api_padApi_getDynamicProxyOrders_post
description: |
Request params (names/types per OpenAPI.md): page, rows, completeStartTime, completeEndTime
requestBody:
required: true
content:
application/json:
schema:
type: object
description: See OpenAPI.md request body/params for this API
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/api/padApi/batchPadConfigProxy:
post:
tags:
- Dynamic Proxy Service
summary: Configure dynamic proxy for instances
operationId: vcpcloud_api_padApi_batchPadConfigProxy_post
description: |
Request params (names/types per OpenAPI.md): "padCodes[], setProxyFlag, proxyIds[]"
requestBody:
required: true
content:
application/json:
schema:
type: object
description: See OpenAPI.md request body/params for this API
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/api/padApi/selectBatchPadProxyTask:
post:
tags:
- Dynamic Proxy Service
summary: Query batch instance set proxy task
operationId: vcpcloud_api_padApi_selectBatchPadProxyTask_post
description: |
Request params (names/types per OpenAPI.md): taskId
requestBody:
required: true
content:
application/json:
schema:
type: object
description: See OpenAPI.md request body/params for this API
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/api/padApi/getDynamicProxyAutomaticRenewal:
get:
tags:
- Dynamic Proxy Service
summary: Query dynamic proxy auto-renewal info
operationId: vcpcloud_api_padApi_getDynamicProxyAutomaticRenewal_get
description: |
Request params (names/types per OpenAPI.md): None
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/api/padApi/setAutoRenewSwitch:
post:
tags:
- Dynamic Proxy Service
summary: Set dynamic proxy auto-renewal switch
operationId: vcpcloud_api_padApi_setAutoRenewSwitch_post
description: |
Request params (names/types per OpenAPI.md): autoRenewOrder
requestBody:
required: true
content:
application/json:
schema:
type: object
description: See OpenAPI.md request body/params for this API
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/api/padApi/delProxyByIds:
post:
tags:
- Dynamic Proxy Service
summary: Delete dynamic proxy
operationId: vcpcloud_api_padApi_delProxyByIds_post
description: |
Request params (names/types per OpenAPI.md): "ids[]"
requestBody:
required: true
content:
application/json:
schema:
type: object
description: See OpenAPI.md request body/params for this API
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/api/padApi/proxyGoodList:
get:
tags:
- Static Residential Proxy Service
summary: Get static residential product list
operationId: vcpcloud_api_padApi_proxyGoodList_get
description: |
Request params (names/types per OpenAPI.md): None
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/api/padApi/getProxyRegion:
get:
tags:
- Static Residential Proxy Service
summary: Get static residential supported countries/cities
operationId: vcpcloud_api_padApi_getProxyRegion_get
description: |
Request params (names/types per OpenAPI.md): None
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/api/padApi/createProxyOrder:
post:
tags:
- Static Residential Proxy Service
summary: Static residential product purchase
operationId: vcpcloud_api_padApi_createProxyOrder_post
description: |
Request params (names/types per OpenAPI.md): proxyGoodId, region, num, country, proxyAddress, autoRenew
requestBody:
required: true
content:
application/json:
schema:
type: object
description: See OpenAPI.md request body/params for this API
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/api/padApi/selectProxyOrderList:
post:
tags:
- Static Residential Proxy Service
summary: Static residential proxy order details
operationId: vcpcloud_api_padApi_selectProxyOrderList_post
description: |
Request params (names/types per OpenAPI.md): page, rows
requestBody:
required: true
content:
application/json:
schema:
type: object
description: See OpenAPI.md request body/params for this API
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/api/padApi/createRenewProxyOrder:
post:
tags:
- Static Residential Proxy Service
summary: Static residential proxy renewal
operationId: vcpcloud_api_padApi_createRenewProxyOrder_post
description: |
Request params (names/types per OpenAPI.md): proxyGoodId, proxyIps, autoRenew
requestBody:
required: true
content:
application/json:
schema:
type: object
description: See OpenAPI.md request body/params for this API
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/api/padApi/queryProxyList:
post:
tags:
- Static Residential Proxy Service
summary: Query static residential proxy list
operationId: vcpcloud_api_padApi_queryProxyList_post
description: |
Request params (names/types per OpenAPI.md): current, size
requestBody:
required: true
content:
application/json:
schema:
type: object
description: See OpenAPI.md request body/params for this API
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/api/padApi/autoTaskList:
post:
tags:
- TK Automation
summary: Automation task list query
operationId: vcpcloud_api_padApi_autoTaskList_post
description: |
Request params (names/types per OpenAPI.md): "taskIds[], taskType, page, rows"
requestBody:
required: true
content:
application/json:
schema:
type: object
description: See OpenAPI.md request body/params for this API
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/api/padApi/addAutoTask:
post:
tags:
- TK Automation
summary: Create automation task
operationId: vcpcloud_api_padApi_addAutoTask_post
description: |
Request params (names/types per OpenAPI.md): "taskName, remarks, taskType, list[]"
requestBody:
required: true
content:
application/json:
schema:
type: object
description: See OpenAPI.md request body/params for this API
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/api/padApi/reExecutionAutoTask:
post:
tags:
- TK Automation
summary: Automation task retry
operationId: vcpcloud_api_padApi_reExecutionAutoTask_post
description: |
Request params (names/types per OpenAPI.md): "taskIds[], plannedExecutionTime"
requestBody:
required: true
content:
application/json:
schema:
type: object
description: See OpenAPI.md request body/params for this API
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/api/padApi/cancelAutoTask:
post:
tags:
- TK Automation
summary: Automation task cancel
operationId: vcpcloud_api_padApi_cancelAutoTask_post
description: |
Request params (names/types per OpenAPI.md): "taskIds[]"
requestBody:
required: true
content:
application/json:
schema:
type: object
description: See OpenAPI.md request body/params for this API
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/api/padApi/stsTokenByPadCode:
post:
tags:
- SDK Token
summary: Get SDK temporary token by padCode
operationId: vcpcloud_api_padApi_stsTokenByPadCode_post
description: |
Request params (names/types per OpenAPI.md): padCode
requestBody:
required: true
content:
application/json:
schema:
type: object
description: See OpenAPI.md request body/params for this API
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vcpcloud/api/padApi/clearStsToken:
post:
tags:
- SDK Token
summary: Clear SDK authorization token
operationId: vcpcloud_api_padApi_clearStsToken_post
description: |
Request params (names/types per OpenAPI.md): token
requestBody:
required: true
content:
application/json:
schema:
type: object
description: See OpenAPI.md request body/params for this API
responses:
"200":
description: JSON { code, msg, ts, data }; code=200 success
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
components:
securitySchemes:
VMOSCloudHMAC:
type: http
scheme: custom
description: |
HMAC-SHA256 signature. Required headers: x-date (UTC ISO 8601), x-host (api.vmoscloud.com),
Content-Type (application/json), authorization (HMAC-SHA256).
Format: HMAC-SHA256 Credential={AccessKey}, SignedHeaders=content-type;host;x-content-sha256;x-date, Signature={Signature}
Steps see Getting Started example.md.
schemas:
ApiResponse:
type: object
properties:
code:
type: integer
description: Business code; 200 = success
msg:
type: string
description: Message
ts:
type: integer
description: Timestamp
data:
description: Business data; structure per OpenAPI.md per-API response
Usage
- AI / codegen: Pass the
openapi.yamlURL or file to your AI or OpenAPI code generator. - Testing: Import into Postman or Insomnia; implement HMAC-SHA256 auth as in Getting Started.
Related docs
- API Documentation — Full API reference
- Getting Started — Auth and signing
- LLMs.txt (AI Quick Reference) — Plain-text quick reference