ipswd API (v1.0)

Download OpenAPI specification:Download

This allows you to interact with ipsw in a VERY powerful and flexible way via a RESTful API.

The ipswd design was heavily influenced by the design of dockerd. So many of the same concepts apply.

Daemon

Ping

This will return "OK" if the daemon is running.

Responses

Ping

This will return if 200 the daemon is running.

Responses

Version

This will return the daemon version info.

Responses

AEA

FcsKeys

Get fsc-keys PEM bytes for a given key.

path Parameters

key

required

string

fcs-keys.json PEM lookup key

Responses

Response samples

Content type

application/json

[0
]

DeviceList

List XCode Devices.

This will return JSON of all XCode devices.

Responses

Diff

Blobs

This will return the diff of two text blobs.

query Parameters

prev	string
curr	string

Responses

Files

This will return the diff of two text files.

query Parameters

prev	string
curr	string

Responses

Download

Latest iOS Build

Get latest iOS build.

Responses

Latest iOS Version

Get latest iOS version.

Responses

DSC

a2o

Convert virtual address to file offset.

query Parameters

path required	string path to dyld_shared_cache
addr required	integer <uint64> address to convert

Responses

Response samples

Content type

application/json

{"offset": 0,
"sub_cache": {"ext": "string",
"mapping": "string",
"stubs": true,
"uuid": "string"
}
}

a2s

Convert virtual address to symbol.

query Parameters

path required	string path to dyld_shared_cache
addrs required	Array of integers <uint64> [ items <uint64 > ] address to convert

Responses

Response samples

Content type

application/json

[{"address": 0,
"demanged": "string",
"ext": "string",
"image": "string",
"mapping": "string",
"section": "string",
"segment": "string",
"stub_island": true,
"symbol": "string",
"uuid": "string"
}
]

Imports

Get list of dylibs that import a given dylib.

query Parameters

path required	string path to dyld_shared_cache
dylib required	string dylib to search for

Responses

Response samples

Content type

application/json

{"apps": ["string"
],
"dsc": ["string"
]
}

Info

Get info about a given DSC

query Parameters

path

required

string

path to dyld_shared_cache

Responses

Response samples

Content type

application/json

{"DeviceTrees": {"property1": {"property1": {"property1": null,
"property2": null
},
"property2": {"property1": null,
"property2": null
}
},
"property2": {"property1": {"property1": null,
"property2": null
},
"property2": {"property1": null,
"property2": null
}
}
},
"Plists": {"DeviceMap": [{"BDID": 0,
"BoardConfig": "string",
"CPID": 0,
"Platform": "string",
"SCEP": 0,
"SDOM": 0
}
],
"ProductBuildVersion": "string",
"ProductVersion": "string",
"SupportedProductTypeIDs": {"property1": [0
],
"property2": [0
]
},
"SupportedProductTypes": ["string"
],
"SystemRestoreImageFileSystems": {"property1": "string",
"property2": "string"
},
"actual_minimum_system_partition": 0,
"build": "string",
"build_id": "string",
"build_identities": [{"ap_board_id": "string",
"ap_chip_id": "string",
"ap_os_long_version": "string",
"ap_security_domain": "string",
"bb_activation_manifest_key_hash": [0
],
"bb_chip_id": "string",
"bb_fdr_security_key_hash": [0
],
"bb_provisioning_manifest_key_hash": [0
],
"info": {"build_number": "string",
"code_name": "string",
"device_class": "string",
"fdr_support": true,
"minimum_system_partition": 0,
"mobile_device_min_version": "string",
"os_var_content_size": 0,
"restore_behavior": "string",
"system_partition_padding": {"property1": 0,
"property2": 0
},
"variant": "string",
"variant_contents": {"property1": "string",
"property2": "string"
}
},
"manifest": {"property1": {"build_string": "string",
"digest": [0
],
"epro": true,
"esec": true,
"info": {"property1": null,
"property2": null
},
"name": "string",
"trusted": true
},
"property2": {"build_string": "string",
"digest": [0
],
"epro": true,
"esec": true,
"info": {"property1": null,
"property2": null
},
"name": "string",
"trusted": true
}
},
"pearl_certification_root_pub": [0
],
"product_marketing_version": "string",
"unique_build_id": [0
]
}
],
"cf_bundle_identifier": "string",
"cf_bundle_info_dictionary_version": "string",
"cf_bundle_name": "string",
"cf_bundle_short_version_string": "string",
"cf_bundle_version": "string",
"device_class": "string",
"hardware_model": "string",
"manifest_version": 0,
"minimum_system_partition": 0,
"mobile_asset_properties": {"ActualMinimumSystemPartition": 0,
"ArchiveDecryptionKey": "string",
"ArchiveID": "string",
"AssetFormat": "string",
"AssetType": "string",
"AutoUpdate": true,
"BridgeVersionInfo": {"BridgeBuildGroup": "string",
"BridgeProductBuildVersion": "string",
"BridgeVersion": "string",
"CatalogURL": "string",
"IsSeed": "string",
"SEPEpoch": {"Major": 0,
"Minor": 0
}
},
"Build": "string",
"CryptexSizeInfo": [{"CryptexSize": 0,
"CryptexTag": "string"
}
],
"DataTemplateSize": 0,
"DeviceName": "string",
"Devices": ["string"
],
"DisablePreSoftwareUpdateAssetStaging": true,
"EAPFSEnabled": true,
"FirmwareBundle": "string",
"FirmwareVersionMajor": 0,
"FirmwareVersionMinor": 0,
"FirmwareVersionRelease": 0,
"InstallationSize": "string",
"InstallationSize-Snapshot": "string",
"MinimumSystemPartition": 0,
"OSVersion": "string",
"PreflightBuildManifest": [0
],
"PreflightGlobalSignatures": [0
],
"PrerequisiteBuild": "string",
"PrerequisiteOSVersion": "string",
"ProductVersionExtra": "string",
"RSEPDigest": [0
],
"Ramp": true,
"ReleaseType": "string",
"RescueMinimumSystemPartition": 0,
"RestoreVersion": "string",
"RestoreVersionInfo": {"IsSeed": true,
"RestoreBuildGroup": null,
"RestoreLongVersion": "string",
"RestoreVersion": "string"
},
"SEPDigest": [0
],
"SUConvReqd": true,
"SUDocumentationID": "string",
"SUInstallTonightEnabled": true,
"SUMultiPassEnabled": true,
"SUProductSystemName": "string",
"SUPublisher": "string",
"SplatOnly": true,
"SupportedDeviceModels": ["string"
],
"SupportedDevices": ["string"
],
"SystemPartitionPadding": {"property1": 0,
"property2": 0
},
"SystemVolumeSealingOverhead": 0,
"TargetUpdateBridgeVersion": "string",
"TrainName": "string",
"_AssetReceipt": {"AssetReceipt": "string",
"AssetSignature": "string"
},
"_CompressionAlgorithm": "string",
"_DownloadSize": 0,
"_EventRecordingServiceURL": "string",
"_IsEncrypted": true,
"_IsZipStreamable": true,
"_MasteredVersion": "string",
"_Measurement": [0
],
"_MeasurementAlgorithm": "string",
"_UnarchivedSize": 0,
"__AssetDefaultGarbageCollectionBehavior": "string",
"__BaseURL": "string",
"__CanUseLocalCacheServer": true,
"__HideInstallAlert": true,
"__QueuingServiceURL": "string",
"__RelativePath": "string"
},
"package_version": "string",
"product_build_version": "string",
"product_copyright": "string",
"product_name": "string",
"product_type": "string",
"product_version": "string",
"release_type": "string",
"required_space": 0,
"reserve_file_aware": true,
"rsep_digest": [0
],
"rseptbm_digests": [0
],
"sep_digest": [0
],
"septbm_digests": [0
],
"size_archive_root": 0,
"size_patched_binaries": 0,
"size_patched_binaries_snapshot": 0,
"supported_product_types": ["string"
],
"system_image_id": "string",
"system_partition_padding": {"property1": 0,
"property2": 0
},
"system_update_path_map": {"property1": "string",
"property2": "string"
},
"system_volume_sealing_overhead": 0,
"target_update": "string",
"type": "string"
}
}

MachO

Get MachO info for a given dylib in the DSC.

query Parameters

path required	string path to dyld_shared_cache
dylib required	string dylib to search for

Responses

Response samples

Content type

application/json

{"ByteOrder": {"String": "string"
},
"CPU": 0,
"Dysymtab": {"Extrefsymoff": 0,
"Extreloff": 0,
"Iextdefsym": 0,
"Ilocalsym": 0,
"IndirectSyms": [0
],
"Indirectsymoff": 0,
"Iundefsym": 0,
"Len": 0,
"Locreloff": 0,
"Modtaboff": 0,
"Nextdefsym": 0,
"Nextrefsyms": 0,
"Nextrel": 0,
"Nindirectsyms": 0,
"Nlocalsym": 0,
"Nlocrel": 0,
"Nmodtab": 0,
"Ntoc": 0,
"Nundefsym": 0,
"Tocoffset": 0
},
"Flags": 0,
"Loads": [{"Command": 0,
"LoadSize": 0,
"Raw": [0
],
"String": "string"
}
],
"Magic": 0,
"NCommands": 0,
"Reserved": 0,
"Sections": [{"Addr": 0,
"Align": 0,
"Flags": 0,
"Name": "string",
"Nreloc": 0,
"Offset": 0,
"Relocs": [{"Addr": 0,
"Extern": true,
"Len": 0,
"Pcrel": true,
"Scattered": true,
"Type": 0,
"Value": 0
}
],
"Reloff": 0,
"Reserved1": 0,
"Reserved2": 0,
"Reserved3": 0,
"Seg": "string",
"Size": 0,
"Type": 0
}
],
"SizeCommands": 0,
"SubCPU": 0,
"Symtab": {"Len": 0,
"Nsyms": 0,
"Stroff": 0,
"Strsize": 0,
"Symoff": 0,
"Syms": [{"Name": {"name": "string"
},
"end": 0,
"start": 0
}
]
},
"Type": 0
}

o2a

Convert file offset to virtual address

query Parameters

path required	string path to dyld_shared_cache
off required	integer <uint64> offset to convert

Responses

Response samples

Content type

application/json

{"address": 0,
"sub_cache": {"ext": "string",
"mapping": "string",
"stubs": true,
"uuid": "string"
}
}

Slide Info

Get slide info for the DSC.

query Parameters

path required	string path to dyld_shared_cache
type	string="auth" filter by mapping type

Responses

Response samples

Content type

application/json

{"Pages": [null
],
"SlideInfo": {"GetPageSize": 0,
"GetVersion": 0
},
"address": 0,
"file_offset": 0,
"flags": 0,
"init_prot": 0,
"max_prot": 0,
"name": "string",
"size": 0,
"slide_info_offset": 0,
"slide_info_size": 0
}

Split

Split the DSC into its constituent dylibs using XCode's dsc_extractor.bundle

NOTE: darwin ONLY

query Parameters

path required	string path to dyld_shared_cache
output	string the folder to output the split dylibs
xcode_path	string the path to the Xcode.app to use for splitting

Responses

Strings

Get strings in the DSC that match a given pattern.

query Parameters

path required	string path to dyld_shared_cache
pattern required	string regex to search for

Responses

Symbols

Get symbols addresses in the DSC that match a given lookup JSON payload.

query Parameters

path required	string path to dyld_shared_cache
required	Array of objects (Symbol) symbols to lookup

Responses

Webkit

Get webkit version from dylib in the DSC.

query Parameters

path

required

string

path to dyld_shared_cache

Responses

Extract

DMG

Extract DMGs from an IPSW.

Request Body schema: application/json
required

Extraction options

dmg_type	string^(app\|sys\|fs)$
flatten	boolean
insecure	boolean
ipsw	string
output	string
proxy	string
url	string

Responses

Request samples

Payload

Content type

application/json

{"dmg_type": "string",
"flatten": true,
"insecure": true,
"ipsw": "string",
"output": "string",
"proxy": "string",
"url": "string"
}

Response samples

Content type

application/json

null

DSC

Extract dyld_shared_caches from an IPSW.

Request Body schema: application/json
required

Extraction options

arches	Array of strings[ items non-empty ]
flatten	boolean
insecure	boolean
ipsw	string
output	string
proxy	string
url	string

Responses

Request samples

Payload

Content type

application/json

{"arches": ["string"
],
"flatten": true,
"insecure": true,
"ipsw": "string",
"output": "string",
"proxy": "string",
"url": "string"
}

Response samples

Content type

application/json

null

KBAG

Extract KBAGs from an IPSW.

Request Body schema: application/json
required

Extraction options

flatten	boolean
insecure	boolean
ipsw	string
output	string
pattern	string
proxy	string
url	string

Responses

Request samples

Payload

Content type

application/json

{"flatten": true,
"insecure": true,
"ipsw": "string",
"output": "string",
"pattern": "string",
"proxy": "string",
"url": "string"
}

Response samples

Content type

application/json

null

Kernel

Extract kernelcaches from an IPSW.

Request Body schema: application/json
required

Extraction options

flatten	boolean
insecure	boolean
ipsw	string
output	string
proxy	string
url	string

Responses

Request samples

Payload

Content type

application/json

{"flatten": true,
"insecure": true,
"ipsw": "string",
"output": "string",
"proxy": "string",
"url": "string"
}

Response samples

Content type

application/json

null

Pattern

Extract files from an IPSW that match a given pattern.

Request Body schema: application/json
required

Extraction options

dmgs	boolean
flatten	boolean
insecure	boolean
ipsw	string
output	string
pattern	string
proxy	string
url	string

Responses

Request samples

Payload

Content type

application/json

{"dmgs": true,
"flatten": true,
"insecure": true,
"ipsw": "string",
"output": "string",
"pattern": "string",
"proxy": "string",
"url": "string"
}

Response samples

Content type

application/json

null

SPTM

Extract SPTM and TXM Firmwares.

Request Body schema: application/json
required

Extraction options

dmgs	boolean
flatten	boolean
insecure	boolean
ipsw	string
output	string
pattern	string
proxy	string
url	string

Responses

Request samples

Payload

Content type

application/json

{"dmgs": true,
"flatten": true,
"insecure": true,
"ipsw": "string",
"output": "string",
"pattern": "string",
"proxy": "string",
"url": "string"
}

Response samples

Content type

application/json

null

USB

Info

Get info about USB connected devices.

Responses

Info

IPSW

Get IPSW info.

query Parameters

path

required

string

path to IPSW

Responses

Response samples

Content type

application/json

{"DeviceTrees": {"property1": {"property1": {"property1": null,
"property2": null
},
"property2": {"property1": null,
"property2": null
}
},
"property2": {"property1": {"property1": null,
"property2": null
},
"property2": {"property1": null,
"property2": null
}
}
},
"Plists": {"DeviceMap": [{"BDID": 0,
"BoardConfig": "string",
"CPID": 0,
"Platform": "string",
"SCEP": 0,
"SDOM": 0
}
],
"ProductBuildVersion": "string",
"ProductVersion": "string",
"SupportedProductTypeIDs": {"property1": [0
],
"property2": [0
]
},
"SupportedProductTypes": ["string"
],
"SystemRestoreImageFileSystems": {"property1": "string",
"property2": "string"
},
"actual_minimum_system_partition": 0,
"build": "string",
"build_id": "string",
"build_identities": [{"ap_board_id": "string",
"ap_chip_id": "string",
"ap_os_long_version": "string",
"ap_security_domain": "string",
"bb_activation_manifest_key_hash": [0
],
"bb_chip_id": "string",
"bb_fdr_security_key_hash": [0
],
"bb_provisioning_manifest_key_hash": [0
],
"info": {"build_number": "string",
"code_name": "string",
"device_class": "string",
"fdr_support": true,
"minimum_system_partition": 0,
"mobile_device_min_version": "string",
"os_var_content_size": 0,
"restore_behavior": "string",
"system_partition_padding": {"property1": 0,
"property2": 0
},
"variant": "string",
"variant_contents": {"property1": "string",
"property2": "string"
}
},
"manifest": {"property1": {"build_string": "string",
"digest": [0
],
"epro": true,
"esec": true,
"info": {"property1": null,
"property2": null
},
"name": "string",
"trusted": true
},
"property2": {"build_string": "string",
"digest": [0
],
"epro": true,
"esec": true,
"info": {"property1": null,
"property2": null
},
"name": "string",
"trusted": true
}
},
"pearl_certification_root_pub": [0
],
"product_marketing_version": "string",
"unique_build_id": [0
]
}
],
"cf_bundle_identifier": "string",
"cf_bundle_info_dictionary_version": "string",
"cf_bundle_name": "string",
"cf_bundle_short_version_string": "string",
"cf_bundle_version": "string",
"device_class": "string",
"hardware_model": "string",
"manifest_version": 0,
"minimum_system_partition": 0,
"mobile_asset_properties": {"ActualMinimumSystemPartition": 0,
"ArchiveDecryptionKey": "string",
"ArchiveID": "string",
"AssetFormat": "string",
"AssetType": "string",
"AutoUpdate": true,
"BridgeVersionInfo": {"BridgeBuildGroup": "string",
"BridgeProductBuildVersion": "string",
"BridgeVersion": "string",
"CatalogURL": "string",
"IsSeed": "string",
"SEPEpoch": {"Major": 0,
"Minor": 0
}
},
"Build": "string",
"CryptexSizeInfo": [{"CryptexSize": 0,
"CryptexTag": "string"
}
],
"DataTemplateSize": 0,
"DeviceName": "string",
"Devices": ["string"
],
"DisablePreSoftwareUpdateAssetStaging": true,
"EAPFSEnabled": true,
"FirmwareBundle": "string",
"FirmwareVersionMajor": 0,
"FirmwareVersionMinor": 0,
"FirmwareVersionRelease": 0,
"InstallationSize": "string",
"InstallationSize-Snapshot": "string",
"MinimumSystemPartition": 0,
"OSVersion": "string",
"PreflightBuildManifest": [0
],
"PreflightGlobalSignatures": [0
],
"PrerequisiteBuild": "string",
"PrerequisiteOSVersion": "string",
"ProductVersionExtra": "string",
"RSEPDigest": [0
],
"Ramp": true,
"ReleaseType": "string",
"RescueMinimumSystemPartition": 0,
"RestoreVersion": "string",
"RestoreVersionInfo": {"IsSeed": true,
"RestoreBuildGroup": null,
"RestoreLongVersion": "string",
"RestoreVersion": "string"
},
"SEPDigest": [0
],
"SUConvReqd": true,
"SUDocumentationID": "string",
"SUInstallTonightEnabled": true,
"SUMultiPassEnabled": true,
"SUProductSystemName": "string",
"SUPublisher": "string",
"SplatOnly": true,
"SupportedDeviceModels": ["string"
],
"SupportedDevices": ["string"
],
"SystemPartitionPadding": {"property1": 0,
"property2": 0
},
"SystemVolumeSealingOverhead": 0,
"TargetUpdateBridgeVersion": "string",
"TrainName": "string",
"_AssetReceipt": {"AssetReceipt": "string",
"AssetSignature": "string"
},
"_CompressionAlgorithm": "string",
"_DownloadSize": 0,
"_EventRecordingServiceURL": "string",
"_IsEncrypted": true,
"_IsZipStreamable": true,
"_MasteredVersion": "string",
"_Measurement": [0
],
"_MeasurementAlgorithm": "string",
"_UnarchivedSize": 0,
"__AssetDefaultGarbageCollectionBehavior": "string",
"__BaseURL": "string",
"__CanUseLocalCacheServer": true,
"__HideInstallAlert": true,
"__QueuingServiceURL": "string",
"__RelativePath": "string"
},
"package_version": "string",
"product_build_version": "string",
"product_copyright": "string",
"product_name": "string",
"product_type": "string",
"product_version": "string",
"release_type": "string",
"required_space": 0,
"reserve_file_aware": true,
"rsep_digest": [0
],
"rseptbm_digests": [0
],
"sep_digest": [0
],
"septbm_digests": [0
],
"size_archive_root": 0,
"size_patched_binaries": 0,
"size_patched_binaries_snapshot": 0,
"supported_product_types": ["string"
],
"system_image_id": "string",
"system_partition_padding": {"property1": 0,
"property2": 0
},
"system_update_path_map": {"property1": "string",
"property2": "string"
},
"system_volume_sealing_overhead": 0,
"target_update": "string",
"type": "string"
}
}

Remote IPSW

Get remote IPSW info.

query Parameters

url required	string url to IPSW
proxy	string http proxy to use
insecure	boolean ignore TLS errors

Responses

Response samples

Content type

application/json

{"DeviceTrees": {"property1": {"property1": {"property1": null,
"property2": null
},
"property2": {"property1": null,
"property2": null
}
},
"property2": {"property1": {"property1": null,
"property2": null
},
"property2": {"property1": null,
"property2": null
}
}
},
"Plists": {"DeviceMap": [{"BDID": 0,
"BoardConfig": "string",
"CPID": 0,
"Platform": "string",
"SCEP": 0,
"SDOM": 0
}
],
"ProductBuildVersion": "string",
"ProductVersion": "string",
"SupportedProductTypeIDs": {"property1": [0
],
"property2": [0
]
},
"SupportedProductTypes": ["string"
],
"SystemRestoreImageFileSystems": {"property1": "string",
"property2": "string"
},
"actual_minimum_system_partition": 0,
"build": "string",
"build_id": "string",
"build_identities": [{"ap_board_id": "string",
"ap_chip_id": "string",
"ap_os_long_version": "string",
"ap_security_domain": "string",
"bb_activation_manifest_key_hash": [0
],
"bb_chip_id": "string",
"bb_fdr_security_key_hash": [0
],
"bb_provisioning_manifest_key_hash": [0
],
"info": {"build_number": "string",
"code_name": "string",
"device_class": "string",
"fdr_support": true,
"minimum_system_partition": 0,
"mobile_device_min_version": "string",
"os_var_content_size": 0,
"restore_behavior": "string",
"system_partition_padding": {"property1": 0,
"property2": 0
},
"variant": "string",
"variant_contents": {"property1": "string",
"property2": "string"
}
},
"manifest": {"property1": {"build_string": "string",
"digest": [0
],
"epro": true,
"esec": true,
"info": {"property1": null,
"property2": null
},
"name": "string",
"trusted": true
},
"property2": {"build_string": "string",
"digest": [0
],
"epro": true,
"esec": true,
"info": {"property1": null,
"property2": null
},
"name": "string",
"trusted": true
}
},
"pearl_certification_root_pub": [0
],
"product_marketing_version": "string",
"unique_build_id": [0
]
}
],
"cf_bundle_identifier": "string",
"cf_bundle_info_dictionary_version": "string",
"cf_bundle_name": "string",
"cf_bundle_short_version_string": "string",
"cf_bundle_version": "string",
"device_class": "string",
"hardware_model": "string",
"manifest_version": 0,
"minimum_system_partition": 0,
"mobile_asset_properties": {"ActualMinimumSystemPartition": 0,
"ArchiveDecryptionKey": "string",
"ArchiveID": "string",
"AssetFormat": "string",
"AssetType": "string",
"AutoUpdate": true,
"BridgeVersionInfo": {"BridgeBuildGroup": "string",
"BridgeProductBuildVersion": "string",
"BridgeVersion": "string",
"CatalogURL": "string",
"IsSeed": "string",
"SEPEpoch": {"Major": 0,
"Minor": 0
}
},
"Build": "string",
"CryptexSizeInfo": [{"CryptexSize": 0,
"CryptexTag": "string"
}
],
"DataTemplateSize": 0,
"DeviceName": "string",
"Devices": ["string"
],
"DisablePreSoftwareUpdateAssetStaging": true,
"EAPFSEnabled": true,
"FirmwareBundle": "string",
"FirmwareVersionMajor": 0,
"FirmwareVersionMinor": 0,
"FirmwareVersionRelease": 0,
"InstallationSize": "string",
"InstallationSize-Snapshot": "string",
"MinimumSystemPartition": 0,
"OSVersion": "string",
"PreflightBuildManifest": [0
],
"PreflightGlobalSignatures": [0
],
"PrerequisiteBuild": "string",
"PrerequisiteOSVersion": "string",
"ProductVersionExtra": "string",
"RSEPDigest": [0
],
"Ramp": true,
"ReleaseType": "string",
"RescueMinimumSystemPartition": 0,
"RestoreVersion": "string",
"RestoreVersionInfo": {"IsSeed": true,
"RestoreBuildGroup": null,
"RestoreLongVersion": "string",
"RestoreVersion": "string"
},
"SEPDigest": [0
],
"SUConvReqd": true,
"SUDocumentationID": "string",
"SUInstallTonightEnabled": true,
"SUMultiPassEnabled": true,
"SUProductSystemName": "string",
"SUPublisher": "string",
"SplatOnly": true,
"SupportedDeviceModels": ["string"
],
"SupportedDevices": ["string"
],
"SystemPartitionPadding": {"property1": 0,
"property2": 0
},
"SystemVolumeSealingOverhead": 0,
"TargetUpdateBridgeVersion": "string",
"TrainName": "string",
"_AssetReceipt": {"AssetReceipt": "string",
"AssetSignature": "string"
},
"_CompressionAlgorithm": "string",
"_DownloadSize": 0,
"_EventRecordingServiceURL": "string",
"_IsEncrypted": true,
"_IsZipStreamable": true,
"_MasteredVersion": "string",
"_Measurement": [0
],
"_MeasurementAlgorithm": "string",
"_UnarchivedSize": 0,
"__AssetDefaultGarbageCollectionBehavior": "string",
"__BaseURL": "string",
"__CanUseLocalCacheServer": true,
"__HideInstallAlert": true,
"__QueuingServiceURL": "string",
"__RelativePath": "string"
},
"package_version": "string",
"product_build_version": "string",
"product_copyright": "string",
"product_name": "string",
"product_type": "string",
"product_version": "string",
"release_type": "string",
"required_space": 0,
"reserve_file_aware": true,
"rsep_digest": [0
],
"rseptbm_digests": [0
],
"sep_digest": [0
],
"septbm_digests": [0
],
"size_archive_root": 0,
"size_patched_binaries": 0,
"size_patched_binaries_snapshot": 0,
"supported_product_types": ["string"
],
"system_image_id": "string",
"system_partition_padding": {"property1": 0,
"property2": 0
},
"system_update_path_map": {"property1": "string",
"property2": "string"
},
"system_volume_sealing_overhead": 0,
"target_update": "string",
"type": "string"
}
}

OTA

Get OTA info.

query Parameters

path

required

string

path to OTA

Responses

Response samples

Content type

application/json

{"DeviceTrees": {"property1": {"property1": {"property1": null,
"property2": null
},
"property2": {"property1": null,
"property2": null
}
},
"property2": {"property1": {"property1": null,
"property2": null
},
"property2": {"property1": null,
"property2": null
}
}
},
"Plists": {"DeviceMap": [{"BDID": 0,
"BoardConfig": "string",
"CPID": 0,
"Platform": "string",
"SCEP": 0,
"SDOM": 0
}
],
"ProductBuildVersion": "string",
"ProductVersion": "string",
"SupportedProductTypeIDs": {"property1": [0
],
"property2": [0
]
},
"SupportedProductTypes": ["string"
],
"SystemRestoreImageFileSystems": {"property1": "string",
"property2": "string"
},
"actual_minimum_system_partition": 0,
"build": "string",
"build_id": "string",
"build_identities": [{"ap_board_id": "string",
"ap_chip_id": "string",
"ap_os_long_version": "string",
"ap_security_domain": "string",
"bb_activation_manifest_key_hash": [0
],
"bb_chip_id": "string",
"bb_fdr_security_key_hash": [0
],
"bb_provisioning_manifest_key_hash": [0
],
"info": {"build_number": "string",
"code_name": "string",
"device_class": "string",
"fdr_support": true,
"minimum_system_partition": 0,
"mobile_device_min_version": "string",
"os_var_content_size": 0,
"restore_behavior": "string",
"system_partition_padding": {"property1": 0,
"property2": 0
},
"variant": "string",
"variant_contents": {"property1": "string",
"property2": "string"
}
},
"manifest": {"property1": {"build_string": "string",
"digest": [0
],
"epro": true,
"esec": true,
"info": {"property1": null,
"property2": null
},
"name": "string",
"trusted": true
},
"property2": {"build_string": "string",
"digest": [0
],
"epro": true,
"esec": true,
"info": {"property1": null,
"property2": null
},
"name": "string",
"trusted": true
}
},
"pearl_certification_root_pub": [0
],
"product_marketing_version": "string",
"unique_build_id": [0
]
}
],
"cf_bundle_identifier": "string",
"cf_bundle_info_dictionary_version": "string",
"cf_bundle_name": "string",
"cf_bundle_short_version_string": "string",
"cf_bundle_version": "string",
"device_class": "string",
"hardware_model": "string",
"manifest_version": 0,
"minimum_system_partition": 0,
"mobile_asset_properties": {"ActualMinimumSystemPartition": 0,
"ArchiveDecryptionKey": "string",
"ArchiveID": "string",
"AssetFormat": "string",
"AssetType": "string",
"AutoUpdate": true,
"BridgeVersionInfo": {"BridgeBuildGroup": "string",
"BridgeProductBuildVersion": "string",
"BridgeVersion": "string",
"CatalogURL": "string",
"IsSeed": "string",
"SEPEpoch": {"Major": 0,
"Minor": 0
}
},
"Build": "string",
"CryptexSizeInfo": [{"CryptexSize": 0,
"CryptexTag": "string"
}
],
"DataTemplateSize": 0,
"DeviceName": "string",
"Devices": ["string"
],
"DisablePreSoftwareUpdateAssetStaging": true,
"EAPFSEnabled": true,
"FirmwareBundle": "string",
"FirmwareVersionMajor": 0,
"FirmwareVersionMinor": 0,
"FirmwareVersionRelease": 0,
"InstallationSize": "string",
"InstallationSize-Snapshot": "string",
"MinimumSystemPartition": 0,
"OSVersion": "string",
"PreflightBuildManifest": [0
],
"PreflightGlobalSignatures": [0
],
"PrerequisiteBuild": "string",
"PrerequisiteOSVersion": "string",
"ProductVersionExtra": "string",
"RSEPDigest": [0
],
"Ramp": true,
"ReleaseType": "string",
"RescueMinimumSystemPartition": 0,
"RestoreVersion": "string",
"RestoreVersionInfo": {"IsSeed": true,
"RestoreBuildGroup": null,
"RestoreLongVersion": "string",
"RestoreVersion": "string"
},
"SEPDigest": [0
],
"SUConvReqd": true,
"SUDocumentationID": "string",
"SUInstallTonightEnabled": true,
"SUMultiPassEnabled": true,
"SUProductSystemName": "string",
"SUPublisher": "string",
"SplatOnly": true,
"SupportedDeviceModels": ["string"
],
"SupportedDevices": ["string"
],
"SystemPartitionPadding": {"property1": 0,
"property2": 0
},
"SystemVolumeSealingOverhead": 0,
"TargetUpdateBridgeVersion": "string",
"TrainName": "string",
"_AssetReceipt": {"AssetReceipt": "string",
"AssetSignature": "string"
},
"_CompressionAlgorithm": "string",
"_DownloadSize": 0,
"_EventRecordingServiceURL": "string",
"_IsEncrypted": true,
"_IsZipStreamable": true,
"_MasteredVersion": "string",
"_Measurement": [0
],
"_MeasurementAlgorithm": "string",
"_UnarchivedSize": 0,
"__AssetDefaultGarbageCollectionBehavior": "string",
"__BaseURL": "string",
"__CanUseLocalCacheServer": true,
"__HideInstallAlert": true,
"__QueuingServiceURL": "string",
"__RelativePath": "string"
},
"package_version": "string",
"product_build_version": "string",
"product_copyright": "string",
"product_name": "string",
"product_type": "string",
"product_version": "string",
"release_type": "string",
"required_space": 0,
"reserve_file_aware": true,
"rsep_digest": [0
],
"rseptbm_digests": [0
],
"sep_digest": [0
],
"septbm_digests": [0
],
"size_archive_root": 0,
"size_patched_binaries": 0,
"size_patched_binaries_snapshot": 0,
"supported_product_types": ["string"
],
"system_image_id": "string",
"system_partition_padding": {"property1": 0,
"property2": 0
},
"system_update_path_map": {"property1": "string",
"property2": "string"
},
"system_volume_sealing_overhead": 0,
"target_update": "string",
"type": "string"
}
}

Remote OTA

Get remote OTA info.

query Parameters

url required	string url to OTA
proxy	string http proxy to use
insecure	boolean ignore TLS errors

Responses

Response samples

Content type

application/json

{"DeviceTrees": {"property1": {"property1": {"property1": null,
"property2": null
},
"property2": {"property1": null,
"property2": null
}
},
"property2": {"property1": {"property1": null,
"property2": null
},
"property2": {"property1": null,
"property2": null
}
}
},
"Plists": {"DeviceMap": [{"BDID": 0,
"BoardConfig": "string",
"CPID": 0,
"Platform": "string",
"SCEP": 0,
"SDOM": 0
}
],
"ProductBuildVersion": "string",
"ProductVersion": "string",
"SupportedProductTypeIDs": {"property1": [0
],
"property2": [0
]
},
"SupportedProductTypes": ["string"
],
"SystemRestoreImageFileSystems": {"property1": "string",
"property2": "string"
},
"actual_minimum_system_partition": 0,
"build": "string",
"build_id": "string",
"build_identities": [{"ap_board_id": "string",
"ap_chip_id": "string",
"ap_os_long_version": "string",
"ap_security_domain": "string",
"bb_activation_manifest_key_hash": [0
],
"bb_chip_id": "string",
"bb_fdr_security_key_hash": [0
],
"bb_provisioning_manifest_key_hash": [0
],
"info": {"build_number": "string",
"code_name": "string",
"device_class": "string",
"fdr_support": true,
"minimum_system_partition": 0,
"mobile_device_min_version": "string",
"os_var_content_size": 0,
"restore_behavior": "string",
"system_partition_padding": {"property1": 0,
"property2": 0
},
"variant": "string",
"variant_contents": {"property1": "string",
"property2": "string"
}
},
"manifest": {"property1": {"build_string": "string",
"digest": [0
],
"epro": true,
"esec": true,
"info": {"property1": null,
"property2": null
},
"name": "string",
"trusted": true
},
"property2": {"build_string": "string",
"digest": [0
],
"epro": true,
"esec": true,
"info": {"property1": null,
"property2": null
},
"name": "string",
"trusted": true
}
},
"pearl_certification_root_pub": [0
],
"product_marketing_version": "string",
"unique_build_id": [0
]
}
],
"cf_bundle_identifier": "string",
"cf_bundle_info_dictionary_version": "string",
"cf_bundle_name": "string",
"cf_bundle_short_version_string": "string",
"cf_bundle_version": "string",
"device_class": "string",
"hardware_model": "string",
"manifest_version": 0,
"minimum_system_partition": 0,
"mobile_asset_properties": {"ActualMinimumSystemPartition": 0,
"ArchiveDecryptionKey": "string",
"ArchiveID": "string",
"AssetFormat": "string",
"AssetType": "string",
"AutoUpdate": true,
"BridgeVersionInfo": {"BridgeBuildGroup": "string",
"BridgeProductBuildVersion": "string",
"BridgeVersion": "string",
"CatalogURL": "string",
"IsSeed": "string",
"SEPEpoch": {"Major": 0,
"Minor": 0
}
},
"Build": "string",
"CryptexSizeInfo": [{"CryptexSize": 0,
"CryptexTag": "string"
}
],
"DataTemplateSize": 0,
"DeviceName": "string",
"Devices": ["string"
],
"DisablePreSoftwareUpdateAssetStaging": true,
"EAPFSEnabled": true,
"FirmwareBundle": "string",
"FirmwareVersionMajor": 0,
"FirmwareVersionMinor": 0,
"FirmwareVersionRelease": 0,
"InstallationSize": "string",
"InstallationSize-Snapshot": "string",
"MinimumSystemPartition": 0,
"OSVersion": "string",
"PreflightBuildManifest": [0
],
"PreflightGlobalSignatures": [0
],
"PrerequisiteBuild": "string",
"PrerequisiteOSVersion": "string",
"ProductVersionExtra": "string",
"RSEPDigest": [0
],
"Ramp": true,
"ReleaseType": "string",
"RescueMinimumSystemPartition": 0,
"RestoreVersion": "string",
"RestoreVersionInfo": {"IsSeed": true,
"RestoreBuildGroup": null,
"RestoreLongVersion": "string",
"RestoreVersion": "string"
},
"SEPDigest": [0
],
"SUConvReqd": true,
"SUDocumentationID": "string",
"SUInstallTonightEnabled": true,
"SUMultiPassEnabled": true,
"SUProductSystemName": "string",
"SUPublisher": "string",
"SplatOnly": true,
"SupportedDeviceModels": ["string"
],
"SupportedDevices": ["string"
],
"SystemPartitionPadding": {"property1": 0,
"property2": 0
},
"SystemVolumeSealingOverhead": 0,
"TargetUpdateBridgeVersion": "string",
"TrainName": "string",
"_AssetReceipt": {"AssetReceipt": "string",
"AssetSignature": "string"
},
"_CompressionAlgorithm": "string",
"_DownloadSize": 0,
"_EventRecordingServiceURL": "string",
"_IsEncrypted": true,
"_IsZipStreamable": true,
"_MasteredVersion": "string",
"_Measurement": [0
],
"_MeasurementAlgorithm": "string",
"_UnarchivedSize": 0,
"__AssetDefaultGarbageCollectionBehavior": "string",
"__BaseURL": "string",
"__CanUseLocalCacheServer": true,
"__HideInstallAlert": true,
"__QueuingServiceURL": "string",
"__RelativePath": "string"
},
"package_version": "string",
"product_build_version": "string",
"product_copyright": "string",
"product_name": "string",
"product_type": "string",
"product_version": "string",
"release_type": "string",
"required_space": 0,
"reserve_file_aware": true,
"rsep_digest": [0
],
"rseptbm_digests": [0
],
"sep_digest": [0
],
"septbm_digests": [0
],
"size_archive_root": 0,
"size_patched_binaries": 0,
"size_patched_binaries_snapshot": 0,
"supported_product_types": ["string"
],
"system_image_id": "string",
"system_partition_padding": {"property1": 0,
"property2": 0
},
"system_update_path_map": {"property1": "string",
"property2": "string"
},
"system_volume_sealing_overhead": 0,
"target_update": "string",
"type": "string"
}
}

IPSW

Entitlements

Get IPSW Filesystem DMG MachO entitlements.

query Parameters

path required	string path to IPSW
pem_db	string path to AEA pem DB JSON file

Responses

Response samples

Content type

application/json

{"property1": {"property1": null,
"property2": null
},
"property2": {"property1": null,
"property2": null
}
}

Files

Get IPSW Filesystem DMG file listing.

query Parameters

path required	string path to IPSW
pem_db	string path to AEA pem DB JSON file

Responses

launchd Config

Get launchd config from IPSW Filesystem DMG.

query Parameters

path required	string path to IPSW
pem_db	string path to AEA pem DB JSON file

Responses

Kernel

Kexts

Get kernelcache KEXTs info.

query Parameters

path

required

string

path to kernelcache

Responses

Syscalls

Get kernelcache syscalls info.

query Parameters

path

required

string

path to kernelcache

Responses

Version

Get kernelcache version.

query Parameters

path

required

string

path to kernelcache

Responses

Response samples

Content type

application/json

{"arch": "string",
"cpu": "string",
"darwin": "string",
"date": "2019-08-24T14:15:22Z",
"type": "string",
"xnu": "string",
"clang": "string",
"flags": ["string"
],
"version": "string"
}

MachO

Info

Get MachO info.

query Parameters

path required	string path to MachO
arch	string architecture to get info for in universal MachO

Responses

Response samples

Content type

application/json

{"ByteOrder": {"String": "string"
},
"CPU": 0,
"Dysymtab": {"Extrefsymoff": 0,
"Extreloff": 0,
"Iextdefsym": 0,
"Ilocalsym": 0,
"IndirectSyms": [0
],
"Indirectsymoff": 0,
"Iundefsym": 0,
"Len": 0,
"Locreloff": 0,
"Modtaboff": 0,
"Nextdefsym": 0,
"Nextrefsyms": 0,
"Nextrel": 0,
"Nindirectsyms": 0,
"Nlocalsym": 0,
"Nlocrel": 0,
"Nmodtab": 0,
"Ntoc": 0,
"Nundefsym": 0,
"Tocoffset": 0
},
"Flags": 0,
"Loads": [{"Command": 0,
"LoadSize": 0,
"Raw": [0
],
"String": "string"
}
],
"Magic": 0,
"NCommands": 0,
"Reserved": 0,
"Sections": [{"Addr": 0,
"Align": 0,
"Flags": 0,
"Name": "string",
"Nreloc": 0,
"Offset": 0,
"Relocs": [{"Addr": 0,
"Extern": true,
"Len": 0,
"Pcrel": true,
"Scattered": true,
"Type": 0,
"Value": 0
}
],
"Reloff": 0,
"Reserved1": 0,
"Reserved2": 0,
"Reserved3": 0,
"Seg": "string",
"Size": 0,
"Type": 0
}
],
"SizeCommands": 0,
"SubCPU": 0,
"Symtab": {"Len": 0,
"Nsyms": 0,
"Stroff": 0,
"Strsize": 0,
"Symoff": 0,
"Syms": [{"Name": {"name": "string"
},
"end": 0,
"start": 0
}
]
},
"Type": 0
}

Strings

Get MachO strings.

query Parameters

path required	string path to MachO
arch	string architecture to get info for in universal MachO

Responses

Response samples

Content type

application/json

{"property1": {"property1": 0,
"property2": 0
},
"property2": {"property1": 0,
"property2": 0
}
}

Mount

Mount a DMG inside a given IPSW.

path Parameters

type

required

string

type of DMG to mount (app|sys|fs)

query Parameters

path required	string path to IPSW
pem_db	string path to AEA pem DB JSON file

Responses

Unmount

Unmount a previously mounted DMG.

Request Body schema: application/json
required

The unmount context (returned from /mount)

dmg_path	string
mount_point	string

Responses

Request samples

Payload

Content type

application/json

{"dmg_path": "string",
"mount_point": "string"
}

Response samples

Content type

application/json

null

Syms

DSC

Get dyld_shared_cache for a given uuid.

path Parameters

uuid

required

string

dsc UUID

Responses

Response samples

Content type

application/json

{"CreatedAt": "2019-08-24T14:15:22Z",
"DeletedAt": {"Time": "2019-08-24T14:15:22Z",
"Valid": true
},
"UpdatedAt": "2019-08-24T14:15:22Z",
"images": [{"Path": {"name": "string"
},
"Symbols": [{"Name": {"name": "string"
},
"end": 0,
"start": 0
}
],
"text_end": 0,
"text_start": 0,
"uuid": "string"
}
],
"shared_region_start": 0,
"uuid": "string"
}

Dylib

Get image from a DSC for a given uuid and address.

path Parameters

uuid required	string dsc UUID
addr required	integer pointer address

Responses

Response samples

Content type

application/json

{"Path": {"name": "string"
},
"Symbols": [{"Name": {"name": "string"
},
"end": 0,
"start": 0
}
],
"text_end": 0,
"text_start": 0,
"uuid": "string"
}

IPSW

Get IPSW for a given version OR build AND device.

query Parameters

version required	string version of IPSW
build required	string build of IPSW
device required	string device of IPSW

Responses

Response samples

Content type

application/json

{"CreatedAt": "2019-08-24T14:15:22Z",
"DeletedAt": {"Time": "2019-08-24T14:15:22Z",
"Valid": true
},
"UpdatedAt": "2019-08-24T14:15:22Z",
"buildid": "string",
"devices": [{"compatible_device_fallback": "string",
"platform": "string",
"product_description": "string",
"product_type": "string",
"target": "string",
"target_type": "string",
"target_variant": "string",
"traits": {"artwork_device_idiom": "string",
"artwork_device_subtype": 0,
"artwork_display_gamut": "string",
"artwork_dynamic_display_mode": "string",
"artwork_hosted_idioms": "string",
"artwork_scale_factor": 0,
"device_performance_memory_class": 0,
"graphics_feature_set_class": "string",
"graphics_feature_set_fallbacks": "string",
"preferred_architecture": "string"
}
}
],
"dscs": [{"CreatedAt": "2019-08-24T14:15:22Z",
"DeletedAt": {"Time": "2019-08-24T14:15:22Z",
"Valid": true
},
"UpdatedAt": "2019-08-24T14:15:22Z",
"images": [{"Path": {"name": "string"
},
"Symbols": [{"Name": {"name": "string"
},
"end": 0,
"start": 0
}
],
"text_end": 0,
"text_start": 0,
"uuid": "string"
}
],
"shared_region_start": 0,
"uuid": "string"
}
],
"file_system": [{"Path": {"name": "string"
},
"Symbols": [{"Name": {"name": "string"
},
"end": 0,
"start": 0
}
],
"text_end": 0,
"text_start": 0,
"uuid": "string"
}
],
"id": "string",
"kernels": [{"created_at": "2019-08-24T14:15:22Z",
"deleted_at": {"Time": "2019-08-24T14:15:22Z",
"Valid": true
},
"kexts": [{"Path": {"name": "string"
},
"Symbols": [{"Name": {"name": "string"
},
"end": 0,
"start": 0
}
],
"text_end": 0,
"text_start": 0,
"uuid": "string"
}
],
"updated_at": "2019-08-24T14:15:22Z",
"uuid": "string",
"version": "string"
}
],
"name": "string",
"version": "string"
}

MachO

Get MachO for a given uuid.

path Parameters

uuid

required

string

machO UUID

Responses

Response samples

Content type

application/json

{"Path": {"name": "string"
},
"Symbols": [{"Name": {"name": "string"
},
"end": 0,
"start": 0
}
],
"text_end": 0,
"text_start": 0,
"uuid": "string"
}

Rescan

Rescan symbols for a given IPSW.

query Parameters

path required	string path to IPSW
pem_db	string path to AEA pem DB JSON file
sig_dir	string path to symbolication signatures directory

Responses

Scan

Scan symbols for a given IPSW.

query Parameters

path required	string path to IPSW
pem_db	string path to AEA pem DB JSON file
sig_dir	string path to symbolication signatures directory

Responses

Symbols

Get symbols for a given uuid.

path Parameters

uuid

required

string

file UUID

Responses

Response samples

Content type

application/json

[{"Name": {"name": "string"
},
"end": 0,
"start": 0
}
]

Symbol

Get symbol for a given uuid and address.

path Parameters

uuid required	string file UUID
addr required	integer symbol address

Responses

Response samples

Content type

application/json

{"Name": {"name": "string"
},
"end": 0,
"start": 0
}

ipswd API (v1.0)

Daemon

Ping

Responses

Ping

Responses

Version

Responses

AEA

FcsKeys

path Parameters

Responses

Response samples

DeviceList

List XCode Devices.

Responses

Diff

Blobs

query Parameters

Responses

Files

query Parameters

Responses

Download

Latest iOS Build

Responses

Latest iOS Version

Responses

DSC

a2o

query Parameters

Responses

Response samples

a2s

query Parameters

Responses

Response samples

Imports

query Parameters

Responses

Response samples

Info

query Parameters

Responses

Response samples

MachO

query Parameters

Responses

Response samples

o2a

query Parameters

Responses

Response samples

Slide Info

query Parameters

Responses

Response samples

Split

query Parameters

Responses

Strings

query Parameters

Responses

Symbols

query Parameters

Responses

Webkit

query Parameters

Responses

Extract

DMG

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

DSC

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required