| Name |
Type |
Description |
Notes |
| type |
ImageType |
|
|
| encoding |
ImageEncoding |
|
|
| encapsulated |
bool |
Whether the uploaded file is a ZIP wrapper the server should unzip. Leave this unset or false when you upload a file directly (a one-shot multipart create defaults it to false); only browser-style wrapped uploads set it to true. |
[optional] |
| name |
str |
Name for the image. In a multipart upload it defaults to the filename of the uploaded file; in a JSON request you must supply it. Names do not have to be unique. For `partition` images this must be the name of the partition to replace. |
[optional] |
| full_path |
str |
Not for normal API use. Registers a file that already exists on the server instead of uploading one; it is used by cluster installation tools. Leave it unset. |
[optional] |
| project_id |
str |
Optional. Puts the image in this project. You must have access to the project (otherwise 403). Project images count against the project's storage quota. Lifetime. The image is deleted automatically when the project is deleted, which makes a scratch project a simple way to clean up test uploads. Booting from it. Project firmware images do not appear in `GET /v3/models/{model}/software`. To create a device from one, pass the image `id` as `fwPackage` to `POST /v3/instances`; no install step is needed. Also pass `osVersion` or `osBuild`; if you do not know them, read them from the file first with `POST /v3/images/{imageId}/fwinfo`. Models whose `supportsCustomFirmwareImage` is false reject an image ID in `fwPackage`. Side effect: if the project already holds 5 or more images that are not attached to an instance, the oldest of them is deleted to make room. Ignored when `instanceId` is set: the image then belongs to that instance's project. Leave both unset to create a domain-level image. |
[optional] |
| instance_id |
str |
Optional. Attaches the image to this instance (device). The instance must exist (otherwise 404), and the image is placed in the instance's project. The instance can be running, paused or off. Lifetime. The image is deleted automatically when the instance is deleted. Side effect: any image of the same `type` already attached to the instance is deleted first, so each instance keeps at most one image per type. For `partition` images only the one with the same `name` is replaced. MATRIX types (`mast-*`) are never deleted this way, so a device can keep a history of MATRIX files. |
[optional] |
| file |
bytearray |
Multipart requests only: the file contents. Send the `type` and other fields before this part. Omit it (or use a JSON request) to create the record now and upload the contents later. |
[optional] |
from corellium.models.create_image_body import CreateImageBody
# TODO update the JSON string below
json = "{}"
# create an instance of CreateImageBody from a JSON string
create_image_body_instance = CreateImageBody.from_json(json)
# print the JSON string representation of the object
print(CreateImageBody.to_json())
# convert the object into a dict
create_image_body_dict = create_image_body_instance.to_dict()
# create an instance of CreateImageBody from a dict
create_image_body_from_dict = CreateImageBody.from_dict(create_image_body_dict)[Back to Model list] [Back to API list] [Back to README]