Open API Documentation
Complete integration reference and interactive tools for account, device, and certificate APIs.
Account
Balance, pricing, and tokensQuery Balance
Retrieve the user balance using the token
GET
v1.0.0/api/balanceGet Price
Retrieve device pricing filtered by type (instant/review), warranty, and device type. Returns the user IP address
GET
v1.0.0/api/priceQuery Token Expiry
Retrieve the expiry time and validity status of an API token
GET
v1.0.0/api/token/expireUpdate Token Expiry
Update the expiry timestamp of the current API token. Set expire_time to 0 to make it permanent.
POST
v1.1.0/api/token/expireUpdate Token
Generate a new API token and invalidate the old token immediately.
POST
v1.1.0/api/token/updateDevice Management
Register, query, and maintain devicesAdd Device (Instant)
Register a device UDID and return mobileprovision and P12 immediately
POST
v2.1.0/api/adddeviceAdd Device V2
Unified single-device add API. Switch between instant and reservation mode with one parameter while keeping legacy APIs available.
POST
v2.2.0/api/adddevice/v2Add Device (Review/Reservation)
Register a device in reservation mode. mobileprovision may be empty while Apple review is pending
POST
v2.1.0/api/addyydeviceBatch Add Devices
Batch register multiple UDIDs with flexible defaults and per-item overrides. Each item can use instant or reservation mode.
POST
v2.2.0/api/adddevice/batchGet Device Info
Query detailed device information by KID or UDID using token authentication.
GET
v1.0.0/api/device/infoGet Device List
Query the authenticated user device list with pagination and status filters.
GET
v1.0.0/api/device/listUpdate Device Remark
Update a device remark using token authentication
POST
v1.0.0/api/device/remarkSet Device Status
Update the status of a device using token authentication
POST
v1.0.0/api/device/statusRenew Device Membership
Batch update device membership expiry with flexible matching and renewal modes.
POST
v1.1.0/api/device/membership/renewCertificates
Query, download, and verify certificatesGet Certificate
Retrieve a certificate using the token and either a certificate ID or UDID. Smart selection applies when querying by UDID
GET
v1.0.0/api/getcertificateCheck Certificate Status
Check certificate status using token authentication and either a certificate KID or device UDID
GET
v1.0.0/api/device/certcheckApp Sources
App source and application management APIsList sources
List sources by page, including basic settings, subscription URLs and app counts.
GET
v1.0.0/api/appstore/manage/sourcesCreate source
Create a source with a name, announcement and encryption settings, and return its subscription URL.
POST
v1.0.0/api/appstore/manage/sourcesGet source settings
Get the source announcement, subscription URL, encryption settings and link-health alert configuration.
GET
v1.0.0/api/appstore/manage/sources/:source_idUpdate source settings
Update selected source settings, including name, announcement, encryption and alerts; omitted fields stay unchanged.
PATCH
v1.0.0/api/appstore/manage/sources/:source_idList source apps
List apps in a source by page, including versions, download URLs and publication status.
GET
v1.0.0/api/appstore/manage/sources/:source_id/appsAdd source app
Add an app to a source with its download URL, version, icon and other metadata.
POST
v1.0.0/api/appstore/manage/sources/:source_id/appsGet source app
Get the version, download URL, display metadata and publication status of a single app.
GET
v1.0.0/api/appstore/manage/sources/:source_id/apps/:app_idUpdate source app
Update the name, version, download URL or visibility of a published app.
PATCH
v1.0.0/api/appstore/manage/sources/:source_id/apps/:app_idReorder source apps
Update sort weights for 1-200 apps in the order of the submitted app IDs.
PUT
v1.0.0/api/appstore/manage/sources/:source_id/apps/orderPublish app draft
Publish a saved app draft after rule-conflict checks so its changes take effect.
POST
v1.0.0/api/appstore/manage/sources/:source_id/apps/:app_id/publishSource statistics
Get download totals, unique-device and app counts, including downloads for today and yesterday.
GET
v1.0.0/api/appstore/manage/sources/:source_id/stats/overviewQuick source setup
Create a source and up to 10 initial apps in one transaction, with idempotent retries.
POST
v1.0.0/api/appstore/manage/quick-setup