{"openapi":"3.0.3","info":{"version":"7.14.0-36732","title":"Corellium API","description":"REST API to manage your virtual devices."},"servers":[{"url":"https://{serverName}/api","description":"","variables":{"serverName":{"default":"app.corellium.com"}}}],"security":[{"BearerAuth":[]}],"tags":[{"name":"Activity"},{"name":"Agent"},{"name":"Authentication"},{"name":"Billing"},{"name":"Cluster"},{"name":"Config"},{"name":"CoreTrace"},{"name":"Domain"},{"name":"Domain Auth Providers"},{"name":"FirmwareService"},{"name":"Flavors"},{"name":"HyperTrace"},{"name":"Hypertune"},{"name":"Hypervisor Hooks"},{"name":"Images"},{"name":"Instances"},{"name":"Interconnects"},{"name":"Invites"},{"name":"Models"},{"name":"NetConnect"},{"name":"Netdump"},{"name":"Projects"},{"name":"RAM Dump"},{"name":"Roles"},{"name":"SnapshotSharing"},{"name":"Snapshots"},{"name":"Status"},{"name":"Storage"},{"name":"TOTP"},{"name":"Teams"},{"name":"Users"},{"name":"WebPlayer"}],"paths":{"/v3/interconnects":{"post":{"operationId":"v3CreateInterconnect","x-sdk-method":"interconnects.create","summary":"Create I/O Interconnect","description":"Creates an I/O interconnect: a virtual wire, hub or switch that links interfaces on your devices so they can talk to each other, as if you had cabled real hardware together (for example connecting the Ethernet ports of two boards). Give it a `name`, the `projectId`, a `protocol` and `type`, and the device `interfaces` to connect; every device must be in that project. Returns the new interconnect, which starts with status `detached`.\n\nYou can also connect or disconnect one device interface later with `POST /v3/instances/{instanceId}/interfaces` and `DELETE /v3/instances/{instanceId}/interfaces/{interfaceId}`; those device-level calls require the configurable I/O license feature.","tags":["Interconnects"],"security":[{"BearerAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateInterconnectV3Body"}}}},"responses":{"200":{"description":"Created interconnect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Interconnect"}}}},"400":{"description":"The request was invalid, for example a missing or malformed field. The body says which field; fix it before retrying.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Something went wrong on the platform side. Retrying may help; if it keeps failing, contact support with the response body.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}},"get":{"operationId":"v3ListInterconnects","x-sdk-method":"interconnects.list","summary":"List I/O Interconnects","description":"Lists the I/O interconnects in your projects, with their status and how many devices each connects. Filter by name, protocol, type, status or project, sort with `sort`, and page with `limit` and `offset`.","tags":["Interconnects"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"integer","minimum":1,"maximum":1000,"default":100,"description":"Most results to return in one page. Whole number from 1 to 1000; defaults to 100. A value outside that range is rejected with 400."},"required":false,"description":"Most results to return in one page. Whole number from 1 to 1000; defaults to 100. A value outside that range is rejected with 400.","name":"limit","in":"query"},{"schema":{"type":"integer","nullable":true,"minimum":0,"default":0,"description":"How many results to skip before this page starts; defaults to 0. To get the next page, add `limit` to the previous `offset`."},"required":false,"description":"How many results to skip before this page starts; defaults to 0. To get the next page, add `limit` to the previous `offset`.","name":"offset","in":"query"},{"schema":{"type":"string","description":"Filter by interconnect name (case insensitive).","example":"vpn-gateway"},"required":false,"description":"Filter by interconnect name (case insensitive).","name":"name","in":"query"},{"schema":{"type":"string","description":"Filter by protocol (comma separated).","example":"eth"},"required":false,"description":"Filter by protocol (comma separated).","name":"protocol","in":"query"},{"schema":{"type":"string","enum":["hub","switch"],"description":"Filter by type (comma separated)."},"required":false,"description":"Filter by type (comma separated).","name":"type","in":"query"},{"schema":{"type":"string","enum":["attached","detached","connected"],"description":"Filter by status (comma separated)."},"required":false,"description":"Filter by status (comma separated).","name":"status","in":"query"},{"schema":{"type":"string","description":"Sort order (e.g. \"name\" for ascending, \"-name\" for descending, comma separated).","example":"-name"},"required":false,"description":"Sort order (e.g. \"name\" for ascending, \"-name\" for descending, comma separated).","name":"sort","in":"query"},{"schema":{"type":"string","description":"Filter by project ID (comma separated).","example":"1c41b1bc-4f53-48a8-b690-ad30611e1960"},"required":false,"description":"Filter by project ID (comma separated).","name":"projectId","in":"query"}],"responses":{"200":{"description":"Successfully retrieved interconnects.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InterconnectList"}}}},"400":{"description":"The request was invalid, for example a missing or malformed field. The body says which field; fix it before retrying.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Something went wrong on the platform side. Retrying may help; if it keeps failing, contact support with the response body.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v3/interconnects/:interconnectId":{"get":{"operationId":"v3GetInterconnect","x-sdk-method":"interconnects.get","summary":"Get Interconnect","description":"Returns one I/O interconnect, including which device interfaces it connects and its current status.","tags":["Interconnects"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"The interconnect identifier.","example":"56494514-33f7-4fc2-9fdc-865e3957e6d3"},"required":true,"description":"The interconnect identifier.","name":"interconnectId","in":"path"}],"responses":{"200":{"description":"Successfully retrieved interconnect details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Interconnect"}}}},"400":{"description":"The request was invalid, for example a missing or malformed field. The body says which field; fix it before retrying.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Something went wrong on the platform side. Retrying may help; if it keeps failing, contact support with the response body.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}},"delete":{"operationId":"v3DeleteInterconnect","x-sdk-method":"interconnects.delete","summary":"Delete I/O Interconnect","description":"Deletes an I/O interconnect, disconnecting every device interface on it. The devices themselves are not affected.\n\nDeletes are idempotent: an unknown `interconnectId`, or one that is not visible to the caller, is a successful no-op that still returns 204, and\nrepeated calls return 204 as well. A 404 means the request path did not match a delete route, not\nthat the target was missing.","tags":["Interconnects"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"The interconnect identifier.","example":"56494514-33f7-4fc2-9fdc-865e3957e6d3"},"required":true,"description":"The interconnect identifier.","name":"interconnectId","in":"path"}],"responses":{"204":{"description":"Successfully deleted interconnect."},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Something went wrong on the platform side. Retrying may help; if it keeps failing, contact support with the response body.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}},"put":{"operationId":"v3UpdateInterconnect","x-sdk-method":"interconnects.update","summary":"Update I/O Interconnect","description":"Replaces an interconnect's `name` and full list of connected `interfaces`. Interfaces you leave out are disconnected. `projectId`, `protocol` and `type` cannot be changed; if you send them they must match the current values. To change only some fields, use `v3PatchInterconnect`.","tags":["Interconnects"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"The interconnect identifier.","example":"56494514-33f7-4fc2-9fdc-865e3957e6d3"},"required":true,"description":"The interconnect identifier.","name":"interconnectId","in":"path"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateInterconnectV3Body"}}}},"responses":{"200":{"description":"Successfully updated interconnect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Interconnect"}}}},"400":{"description":"The request was invalid, for example a missing or malformed field. The body says which field; fix it before retrying.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Something went wrong on the platform side. Retrying may help; if it keeps failing, contact support with the response body.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}},"patch":{"operationId":"v3PatchInterconnect","x-sdk-method":"interconnects.patch","summary":"Patch I/O Interconnect","description":"Changes only the fields you send: `name` and/or `interfaces`. When you send `interfaces`, it replaces the whole list of connected interfaces. Returns the updated interconnect.","tags":["Interconnects"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"The interconnect identifier.","example":"56494514-33f7-4fc2-9fdc-865e3957e6d3"},"required":true,"description":"The interconnect identifier.","name":"interconnectId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchInterconnectBody"}}}},"responses":{"200":{"description":"Successfully updated interconnect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Interconnect"}}}},"400":{"description":"The request was invalid, for example a missing or malformed field. The body says which field; fix it before retrying.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Something went wrong on the platform side. Retrying may help; if it keeps failing, contact support with the response body.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v3/snapshots/{snapshotId}/share":{"post":{"operationId":"v3ShareSnapshot","x-sdk-method":"snapshots.share","summary":"Create or update snapshot sharing","description":"Shares one of your snapshots so other people can create devices from it, or stops sharing it. Choose who can use it with `sharingType` (see `SnapshotSharingType`); for `passwordPublicLink` also set `password`. The response is the snapshot with its `sharing` details, including the `accessCode` to give to the people you share with. Send `notShared` to stop sharing. Returns 403 if snapshot sharing, or that sharing type, is not enabled for your domain or license.","tags":["SnapshotSharing"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Snapshot identifier.","example":"c67af9c0-26cd-4233-9782-436c842b60db"},"required":true,"description":"Snapshot identifier.","name":"snapshotId","in":"path"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShareSnapshotBody"}}}},"responses":{"200":{"description":"Snapshot sharing configuration updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Snapshot"}}}},"400":{"description":"The request was invalid, for example a missing or malformed field. The body says which field; fix it before retrying.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Snapshot not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiNotFoundError"}}}}}}},"/v3/snapshots/accept":{"post":{"operationId":"v3AcceptSharedSnapshot","x-sdk-method":"snapshots.accept","summary":"Accept a shared snapshot","description":"Checks that you may use a snapshot someone shared with you, using the access code they gave you (and the password, for `passwordPublicLink`). Returns the snapshot.\n\nTo create a device from it, call `POST /v3/instances` with `sharedSnapshot` set to the snapshot's `id` (and `sharedSnapshotPassword` for password-protected shares). Returns 403 if the snapshot is not shared with you, for example it is limited to another domain or you are not on its member list.","tags":["SnapshotSharing"],"security":[{"BearerAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AcceptSnapshotBody"}}}},"responses":{"200":{"description":"Successfully accepted shared snapshot.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Snapshot"}}}},"400":{"description":"The request was invalid, for example a missing or malformed field. The body says which field; fix it before retrying.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Snapshot not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiNotFoundError"}}}}}}},"/v3/snapshots/{snapshotId}/permissions":{"post":{"operationId":"v3SetSnapshotPermissions","x-sdk-method":"snapshots.setPermissions","summary":"Set member list","description":"Sets who may use a snapshot shared by email invitation: send the full list of members, by email address or user ID. The list replaces the previous one. If the snapshot was not shared yet, this shares it with sharing type `emailInvite`. Returns the snapshot with its updated `sharing` details.","tags":["SnapshotSharing"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Snapshot identifier.","example":"c67af9c0-26cd-4233-9782-436c842b60db"},"required":true,"description":"Snapshot identifier.","name":"snapshotId","in":"path"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetSnapshotPermissionsBody"}}}},"responses":{"200":{"description":"Successfully updated the members who have access to the snapshot.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Snapshot"}}}},"400":{"description":"The request was invalid, for example a missing or malformed field. The body says which field; fix it before retrying.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Snapshot not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiNotFoundError"}}}}}},"delete":{"operationId":"v3DeleteSnapshotPermissions","x-sdk-method":"snapshots.deletePermissions","summary":"Delete member(s)","description":"Deletes one or more members from the list of members who have access to the snapshot.\n\nMembers that do not currently have access are ignored rather than reported as an error.\nDeletes are idempotent: an unknown `snapshotId` is a successful no-op that still returns 204, and\nrepeated calls return 204 as well. A 404 means the request path did not match a delete route, not\nthat the target was missing.","tags":["SnapshotSharing"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Snapshot identifier.","example":"c67af9c0-26cd-4233-9782-436c842b60db"},"required":true,"description":"Snapshot identifier.","name":"snapshotId","in":"path"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetSnapshotPermissionsBody"}}}},"responses":{"204":{"description":"Member(s) removed from the snapshot; empty body."},"400":{"description":"Invalid request body, or malformed snapshot ID.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v3/snapshots/shared":{"get":{"operationId":"v3GetSharedSnapshots","x-sdk-method":"snapshots.getShared","summary":"Fetch shared snapshots","description":"Lists snapshots involving you: `sharedWithUser` holds snapshots other people shared with you, and `sharedByUser` holds snapshots you shared. Use it to find a snapshot to create a device from, or to review what you are sharing.","tags":["SnapshotSharing"],"security":[{"BearerAuth":[]}],"responses":{"200":{"description":"Successfully retrieved shared snapshots.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SharedSnapshotsResponse"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v3/snapshots/{snapshotId}":{"get":{"operationId":"v3GetSnapshot","x-sdk-method":"snapshots.getById","summary":"Get snapshot","description":"Returns one snapshot by its ID, including its status and sharing details. Works for snapshots of your devices; use `v3AcceptSharedSnapshot` for snapshots shared with you.","tags":["Snapshots"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Snapshot identifier.","example":"c67af9c0-26cd-4233-9782-436c842b60db"},"required":true,"description":"Snapshot identifier.","name":"snapshotId","in":"path"}],"responses":{"200":{"description":"Successfully retrieved snapshot.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Snapshot"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Snapshot not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiNotFoundError"}}}}}},"patch":{"operationId":"v3UpdateSnapshot","x-sdk-method":"snapshots.updateById","summary":"Update snapshot name","description":"Renames a snapshot. Send the new `name`. Returns the updated snapshot.","tags":["Snapshots"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Snapshot identifier.","example":"c67af9c0-26cd-4233-9782-436c842b60db"},"required":true,"description":"Snapshot identifier.","name":"snapshotId","in":"path"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"New name for the snapshot.","example":"Clean boot"}},"required":["name"]}}}},"responses":{"200":{"description":"Successfully updated snapshot name.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Snapshot"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Snapshot not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiNotFoundError"}}}}}},"delete":{"operationId":"v3DeleteSnapshot","x-sdk-method":"snapshots.deleteById","summary":"Delete a snapshot","description":"Delete a snapshot by ID. Deletion is asynchronous: the snapshot is marked `deleting` and the\ncall returns 204 before the underlying storage has been reclaimed.\n\nDeletes are idempotent: an unknown `snapshotId`, or a snapshot that was already deleted, is a successful no-op that still returns 204, and\nrepeated calls return 204 as well. A 404 means the request path did not match a delete route, not\nthat the target was missing.\nA repeat therefore returns 204 both while the snapshot is still present in the `deleting` state and after\nit has disappeared.","tags":["Snapshots"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Snapshot identifier.","example":"c67af9c0-26cd-4233-9782-436c842b60db"},"required":true,"description":"Snapshot identifier.","name":"snapshotId","in":"path"}],"responses":{"204":{"description":"Successfully deleted snapshot; empty body."},"400":{"description":"Malformed snapshot ID.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v3/instances":{"get":{"operationId":"v3ListInstances","x-sdk-method":"instances.list","summary":"List Instances","description":"Lists the devices (instances) you can access across your projects. Results are paginated with `limit` and `offset`; use `name` to find a device by name. To list only one project's devices, use `GET /v3/projects/{projectId}/instances`.","tags":["Instances"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"integer","minimum":1,"maximum":1000,"default":100,"description":"Most results to return in one page. Whole number from 1 to 1000; defaults to 100. A value outside that range is rejected with 400."},"required":false,"description":"Most results to return in one page. Whole number from 1 to 1000; defaults to 100. A value outside that range is rejected with 400.","name":"limit","in":"query"},{"schema":{"type":"integer","nullable":true,"minimum":0,"default":0,"description":"How many results to skip before this page starts; defaults to 0. To get the next page, add `limit` to the previous `offset`."},"required":false,"description":"How many results to skip before this page starts; defaults to 0. To get the next page, add `limit` to the previous `offset`.","name":"offset","in":"query"},{"schema":{"type":"string","description":"Optionally filter by instance name.","example":"My iPhone 13 Pro"},"required":false,"description":"Optionally filter by instance name.","name":"name","in":"query"},{"schema":{"type":"array","items":{"type":"string"},"description":"Attributes to include in instance return.","example":["name","state"]},"required":false,"description":"Attributes to include in instance return.","name":"returnAttr","in":"query"}],"responses":{"200":{"description":"Paginated list of instances.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstanceList"}}}},"400":{"description":"The request was invalid, for example a missing or malformed field. The body says which field; fix it before retrying.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}},"post":{"operationId":"v3CreateInstance","x-sdk-method":"instances.create","summary":"Create a device","description":"Creates a new virtual device (instance) in a project. This returns quickly with the new `id` and `state: \"creating\"`; the device is then built in the background, which can take several minutes. Poll `v3GetInstanceState` (or `v3GetInstance`) until the state is `on` before using it. If it becomes `error`, read the instance's `error` field.\n\n**Minimum request:** `projectId`, `flavor`, and `osVersion` and/or `osBuild`.\n\n**Typical steps:**\n1. `GET /v3/models`: pick a model and note its `flavor`, allowed cores, and memory.\n2. `GET /v3/models/{model}/software`: pick a build and note its `osVersion` and `osBuild`.\n3. `POST /v3/instances` with `{ \"projectId\", \"flavor\", \"osVersion\", \"osBuild\" }`. Add `name` so you can find it later, and `bootOptions` (for example `cores`, `ram`) to change the defaults.\n4. Poll the state until `on`.\n\n**How the operating system is chosen.** With both `osVersion` and `osBuild`, that exact build is used. With only `osBuild`, the build with that ID is used. With only `osVersion`, the newest build of that version is used. To boot your own firmware file instead, set `fwPackage`.\n\nSome options need license features (for example creating devices from custom firmware, or custom model definitions via `charmBootArgs`); using one your license lacks returns 403.","tags":["Instances"],"security":[{"BearerAuth":[]}],"requestBody":{"required":true,"description":"The VM definition to create.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateInstanceBody"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateInstanceResponse"}}}},"400":{"description":"Invalid instance definition.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"Instance could not be created due to a conflict.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiConflictError"}}}}}}},"/v3/instances/{instanceId}":{"get":{"operationId":"v3GetInstance","x-sdk-method":"instances.get","summary":"Get a device","description":"Returns everything about one device: its name, model, operating system, state, boot options, network details and consoles. Use `state` to see whether it is ready, and `error` to see why it failed. Pass `returnAttr` to get only some fields.","tags":["Instances"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Instance ID.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"required":true,"description":"Instance ID.","name":"instanceId","in":"path"},{"schema":{"type":"array","items":{"type":"string"},"description":"Attributes to include in instance return.","example":["name","state"]},"required":false,"description":"Attributes to include in instance return.","name":"returnAttr","in":"query"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Instance"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Instance not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiNotFoundError"}}}}}},"patch":{"operationId":"v3PatchInstance","x-sdk-method":"instances.patch","summary":"Change device settings","description":"Changes a device's settings. Send only the fields you want to change: `name` (the label shown in lists), `bootOptions` (for example `cores`, `ram`, boot arguments), `proxy` (which device ports are forwarded, and whether they are reachable from outside the project), and `straceFilter` (which processes CoreTrace records, by name, process ID or thread ID; see `v3ListThreads`). Returns the updated device. This call does not turn the device on or off; use `v3StartInstance`, `v3StopInstance`, `v3RebootInstance`, `v3PauseInstance` and `v3UnpauseInstance` for that.","tags":["Instances"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Instance ID.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"required":true,"description":"Instance ID.","name":"instanceId","in":"path"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchInstanceBody"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Instance"}}}},"400":{"description":"The request was invalid, for example a missing or malformed field. The body says which field; fix it before retrying.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Instance not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiNotFoundError"}}}}}},"delete":{"operationId":"v3DeleteInstance","x-sdk-method":"instances.delete","summary":"Remove Instance","description":"Removes the instance. Deletion is asynchronous: the call schedules the teardown and returns\n204 immediately, while the instance remains visible in a `deleting` state until teardown completes.\n\nAn `instanceId` that does not exist also returns 204. The API cannot tell a call with an invalid ID apart\nfrom a second call made to confirm an earlier delete succeeded, so both succeed. Repeated calls return 204 as well. A 404 means the request path did not match a delete route, not\nthat the target was missing.\nA repeat therefore returns 204 both while the record is still present in the `deleting` state and after it\nhas disappeared.","tags":["Instances"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Instance ID.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"required":true,"description":"Instance ID.","name":"instanceId","in":"path"}],"responses":{"204":{"description":"No content"},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v3/instances/{instanceId}/read-only":{"patch":{"operationId":"v3PatchInstanceReadOnly","x-sdk-method":"instances.patchReadOnly","summary":"Update Instance Read Only","description":"Turns read-only mode on or off for the device. Returns the updated device.","tags":["Instances"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Instance ID.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"required":true,"description":"Instance ID.","name":"instanceId","in":"path"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchInstanceReadOnlyBody"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Instance"}}}},"400":{"description":"The request was invalid, for example a missing or malformed field. The body says which field; fix it before retrying.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Instance not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiNotFoundError"}}}}}}},"/v3/instances/{instanceId}/console":{"get":{"operationId":"v3GetInstanceConsole","x-sdk-method":"instances.getConsole","summary":"Get console websocket URL","description":"Get console WebSocket URL.\n\nInstances can have more than one console. To connect to a specific console:\n1. Call Get Instance and read the `consoles` array.\n2. Take the `id` of the console you want and remove the `port-` prefix (e.g. `port-uart7-cons` becomes `uart7-cons`).\n3. Pass that value as the `type` query parameter (e.g. `?type=uart7-cons`).\n\nIf `type` is omitted, the default console (`cons`) is used. Some models have no default console and require `type`.","tags":["Instances"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Instance ID.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"required":true,"description":"Instance ID.","name":"instanceId","in":"path"},{"schema":{"type":"string","description":"Console to connect to: a `consoles[].id` from Get Instance with the `port-` prefix removed. Defaults to `cons`.","example":"uart7-cons"},"required":false,"description":"Console to connect to: a `consoles[].id` from Get Instance with the `port-` prefix removed. Defaults to `cons`.","name":"type","in":"query"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstanceConsoleEndpoint"}}}},"400":{"description":"Invalid console type, or type omitted on a model without a default console.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Instance not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiNotFoundError"}}}}}}},"/v3/instances/{instanceId}/kernel-authorize":{"get":{"operationId":"v3KernelPreauthorize","x-sdk-method":"instances.preauthorizeKernelDownload","summary":"Get a kernel download token","description":"Returns a short-lived token that authorizes downloading this device's kernel file without an `Authorization` header, for loading into a disassembler or debugger. Download with `GET /v1/preauthed/{token}/{filename}`. The token works only for this device's kernel and expires when your current session token expires.","tags":["Instances"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Instance ID.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"required":true,"description":"Instance ID.","name":"instanceId","in":"path"}],"responses":{"200":{"description":"Token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Token"}}}},"400":{"description":"The request was invalid, for example a missing or malformed field. The body says which field; fix it before retrying.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v3/instances/{instanceId}/token/validate":{"post":{"operationId":"v3ValidateInstanceToken","x-sdk-method":"instances.validateToken","summary":"Check a device connection token","description":"Checks whether a connection token issued for this device is still valid. Returns 204 if it is. This call needs no `Authorization` header; the token in the body is what is checked.","tags":["Instances"],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Instance ID.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"required":true,"description":"Instance ID.","name":"instanceId","in":"path"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenValidateBody"}}}},"responses":{"204":{"description":"Token is valid."},"400":{"description":"The request was invalid, for example a missing or malformed field. The body says which field; fix it before retrying.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Instance not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiNotFoundError"}}}}}}},"/v3/instances/{instanceId}/networkMonitor.pcap":{"get":{"operationId":"v3DownloadNetworkMonitorPcap","x-sdk-method":"instances.downloadNetworkMonitorPcap","summary":"Download the Network Monitor capture","description":"Downloads the traffic recorded by Network Monitor (see `v3StartNetworkMonitor`) as a pcap file. Save it with a `.pcap` extension and open it in a packet analyzer such as Wireshark. Download while monitoring runs or after stopping it.","tags":["Instances"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Instance ID.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"required":true,"description":"Instance ID.","name":"instanceId","in":"path"}],"responses":{"200":{"description":"PCAP file.","content":{"application/vnd.tcpdump.pcap":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"The request was invalid, for example a missing or malformed field. The body says which field; fix it before retrying.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v3/instances/{instanceId}/netdump.pcap":{"get":{"operationId":"v3DownloadNetdumpPcap","x-sdk-method":"instances.downloadNetdumpPcap","summary":"Download the Enhanced Network Monitor capture","description":"Downloads the packets recorded by Enhanced Network Monitor (see `v3StartNetdump`) as a pcapng file, which packet analyzers such as Wireshark open directly. Requires the Enhanced Network Monitor feature (403 otherwise).","tags":["Instances","Netdump"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Instance ID.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"required":true,"description":"Instance ID.","name":"instanceId","in":"path"}],"responses":{"200":{"description":"PCAPNG file.","content":{"application/vnd.tcpdump.pcap":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"The request was invalid, for example a missing or malformed field. The body says which field; fix it before retrying.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v3/instances/{instanceId}/start":{"post":{"operationId":"v3StartInstance","x-sdk-method":"instances.start","summary":"Turn a device on","description":"Turns on a device that is `off`. Returns 204 as soon as the start is accepted; the device then boots in the background. Poll `v3GetInstanceState` until it is `on`. Returns 409 if the device is already on.\n\n**Starting paused (`paused: true`).** The device is powered on but no code runs until you call `v3UnpauseInstance` or resume it from a debugger. This is the standard way to debug a device from its very first instruction, for example custom or IoT firmware, or code that runs early in boot:\n1. Upload your firmware and create the device (or stop an existing one).\n2. `v3StartInstance` with `{ \"paused\": true }`.\n3. Connect your debugger (for example GDB) to the device's debug port, shown in the device's connection details.\n4. Load symbols from your firmware or kernel file, set breakpoints, or load code into memory.\n5. Continue execution from the debugger (`c` in GDB).\n\nOnce a debugger is attached, pause and resume from the debugger rather than with `v3PauseInstance` / `v3UnpauseInstance`: GDB expects to control pausing itself, and pausing through the API can confuse its session.\n\n**Network monitoring (`sockCap: true`).** Starts the device with process network monitoring enabled, so network activity can be attributed to the processes that made it.","tags":["Instances"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Instance ID.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"required":true,"description":"Instance ID.","name":"instanceId","in":"path"}],"requestBody":{"description":"Start options.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartInstanceBody"}}}},"responses":{"204":{"description":"No content"},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Instance not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiNotFoundError"}}}},"409":{"description":"Instance is already started.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiConflictError"}}}}}}},"/v3/instances/{instanceId}/stop":{"post":{"operationId":"v3StopInstance","x-sdk-method":"instances.stop","summary":"Turn a device off","description":"Turns a running device off. By default (`soft: true`) the operating system is asked to shut down cleanly. Send `{ \"soft\": false }` to force an immediate stop instead; use it when a clean shutdown does not finish. Returns 204 once the stop is accepted; poll `v3GetInstanceState` until it is `off`. Returns 409 if the device is already off. A stopped device keeps its storage and can be turned on again with `v3StartInstance`.","tags":["Instances"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Instance ID.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"required":true,"description":"Instance ID.","name":"instanceId","in":"path"}],"requestBody":{"description":"Stop options.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopInstanceBody"}}}},"responses":{"204":{"description":"No content"},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Instance not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiNotFoundError"}}}},"409":{"description":"Instance is currently in an off state.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiConflictError"}}}}}}},"/v3/instances/{instanceId}/reboot":{"post":{"operationId":"v3RebootInstance","x-sdk-method":"instances.reboot","summary":"Restart a device","description":"Restarts a running device. Returns 204 once the reboot is accepted; the state becomes `rebooting` and then `on`. Poll `v3GetInstanceState` to see when it is back.","tags":["Instances"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Instance ID.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"required":true,"description":"Instance ID.","name":"instanceId","in":"path"}],"responses":{"204":{"description":"No content"},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Instance not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiNotFoundError"}}}}}}},"/v3/instances/{instanceId}/pause":{"post":{"operationId":"v3PauseInstance","x-sdk-method":"instances.pause","summary":"Pause a device","description":"Freezes a running device in place without shutting it down: it stops executing but keeps its memory and state, so `v3UnpauseInstance` resumes it exactly where it stopped. The state becomes `paused`.","tags":["Instances"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Instance ID.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"required":true,"description":"Instance ID.","name":"instanceId","in":"path"}],"responses":{"204":{"description":"No content"},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Instance not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiNotFoundError"}}}}}}},"/v3/instances/{instanceId}/unpause":{"post":{"operationId":"v3UnpauseInstance","x-sdk-method":"instances.unpause","summary":"Resume a paused device","description":"Resumes a device that was paused with `v3PauseInstance`, or started with `paused: true`. It continues from exactly where it stopped.","tags":["Instances"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Instance ID.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"required":true,"description":"Instance ID.","name":"instanceId","in":"path"}],"responses":{"204":{"description":"No content"},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Instance not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiNotFoundError"}}}}}}},"/v3/instances/{instanceId}/state":{"get":{"operationId":"v3GetInstanceState","x-sdk-method":"instances.getState","summary":"Get a device's state","description":"Returns only the device's current state (for example `creating`, `on`, `off`), as a bare JSON string. This is the call to poll while waiting for a device to finish creating, starting, stopping or rebooting. See `InstanceState` for what each value means.","tags":["Instances"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Instance ID.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"required":true,"description":"Instance ID.","name":"instanceId","in":"path"},{"schema":{"type":"array","items":{"type":"string"},"description":"The attributes to return.","example":["name","state"]},"required":false,"description":"The attributes to return.","name":"returnAttr","in":"query"}],"responses":{"200":{"description":"Current instance state.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstanceState"}}}},"400":{"description":"The request was invalid, for example a missing or malformed field. The body says which field; fix it before retrying.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Instance not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiNotFoundError"}}}},"409":{"description":"The request conflicts with the current state of the resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiConflictError"}}}}}}},"/v3/instances/{instanceId}/gpios":{"get":{"operationId":"v3GetInstanceGpios","x-sdk-method":"instances.getGpios","summary":"Read board LEDs, buttons and switches","description":"Returns the current state of the simulated LEDs, buttons and switches (GPIO pins) on an IoT or embedded board model, for example whether an LED your firmware drives is lit. The device must be running. Phone models do not have these, and the request fails for them. See `GpiosState` for the format.","tags":["Instances"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Instance ID.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"required":true,"description":"Instance ID.","name":"instanceId","in":"path"}],"responses":{"200":{"description":"Current GPIO state.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GpiosState"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Instance not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiNotFoundError"}}}}}},"put":{"operationId":"v3SetInstanceGpios","x-sdk-method":"instances.setGpios","summary":"Press board buttons or flip switches","description":"Sets the state of the simulated buttons and switches (GPIO pins) on an IoT or embedded board model, as if you pressed a button or flipped a switch on real hardware; your firmware sees the change. Send the full bank layout you got from `v3GetInstanceGpios`, with the bits you want changed. Returns the state after the change. The device must be running.","tags":["Instances"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Instance ID.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"required":true,"description":"Instance ID.","name":"instanceId","in":"path"}],"requestBody":{"required":true,"description":"New GPIO state.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GpiosState"}}}},"responses":{"200":{"description":"Current GPIOs state.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GpiosState"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Instance not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiNotFoundError"}}}}}}},"/v3/instances/{instanceId}/peripherals":{"get":{"operationId":"v3GetInstancePeripherals","x-sdk-method":"instances.getPeripherals","summary":"Read simulated sensors","description":"Returns the current values of the device's simulated sensors and hardware: motion (accelerometer, gyroscope, compass), environment (temperature, light, pressure, humidity, proximity), GPS location, battery, and biometric bypass. Only values the device reports are included; a missing field does not mean zero. See `PeripheralsData`.","tags":["Instances"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Instance ID.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"required":true,"description":"Instance ID.","name":"instanceId","in":"path"}],"responses":{"200":{"description":"Current peripherals state.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PeripheralsData"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Instance not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiNotFoundError"}}}}}},"put":{"operationId":"v3SetInstancePeripherals","x-sdk-method":"instances.setPeripherals","summary":"Change simulated sensors","description":"Changes what the device's simulated sensors report to apps, for example to fake a GPS location, a low battery, or a tilt. Send only the fields you want to change. The new values are saved with the device and then the current readings are returned.\n\nA field is applied only if its feature is enabled for the device (motion, environment, location, battery, biometric bypass); values for disabled features are ignored silently, so check the response. `biometricPass: 1` makes fingerprint and face checks succeed.","tags":["Instances"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Instance ID.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"required":true,"description":"Instance ID.","name":"instanceId","in":"path"}],"requestBody":{"required":true,"description":"New peripherals state.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PeripheralsData"}}}},"responses":{"200":{"description":"Current peripherals state.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PeripheralsData"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Instance not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiNotFoundError"}}}}}}},"/v3/instances/{instanceId}/restoreBackup":{"post":{"operationId":"v3RestoreBackup","x-sdk-method":"instances.restoreBackup","summary":"Restore a backup onto a device","description":"Restores the backup attached to this device, replacing the device's data with the backup's contents. First attach the backup file by uploading it with `POST /v3/images` using `type: \"backup\"` and `instanceId` set to this device. Returns 204 once the restore has been scheduled; it runs in the background, so poll `v3GetInstanceState` until the device settles.\n\nSupply `password` if the backup is encrypted. Fails with 404 if no backup is attached. Requires the backup-restore license feature (403 otherwise).","tags":["Instances"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Instance ID.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"required":true,"description":"Instance ID.","name":"instanceId","in":"path"}],"requestBody":{"description":"Restore backup data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestoreBackupBody"}}}},"responses":{"204":{"description":"No content"},"400":{"description":"The request was invalid, for example a missing or malformed field. The body says which field; fix it before retrying.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v3/instances/{instanceId}/screenshot.{format}":{"get":{"operationId":"v3GetInstanceScreenshot","x-sdk-method":"instances.getScreenshot","summary":"Take a screenshot","description":"Captures what the device's screen shows right now and returns it as an image. Choose the file type in the path: `screenshot.png` or `screenshot.jpeg`. Use `scale` to shrink it: `scale=2` returns half the width and height, `scale=4` a quarter; the default 1 is full size. The device must be running.","tags":["Instances"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Instance ID.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"required":true,"description":"Instance ID.","name":"instanceId","in":"path"},{"schema":{"type":"string","enum":["png","jpeg"],"description":"Image file type: `png` (lossless, larger) or `jpeg` (smaller)."},"required":true,"description":"Image file type: `png` (lossless, larger) or `jpeg` (smaller).","name":"format","in":"path"},{"schema":{"type":"integer","nullable":true,"description":"Shrink factor. The image is 1/N of full size in each direction. Whole number; defaults to 1 (full size).","example":2},"required":false,"description":"Shrink factor. The image is 1/N of full size in each direction. Whole number; defaults to 1 (full size).","name":"scale","in":"query"}],"responses":{"200":{"description":"Screenshot.","content":{"image/png":{"schema":{"$ref":"#/components/schemas/Screenshot"}},"image/jpeg":{"schema":{"$ref":"#/components/schemas/Screenshot"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Instance not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiNotFoundError"}}}}}}},"/v3/instances/{instanceId}/rotate":{"post":{"operationId":"v3RotateInstance","x-sdk-method":"instances.rotate","summary":"Rotate the device","description":"Turns the device to a new orientation, as if you rotated the phone in your hand; apps receive the rotation event. `orientation` is 1 = portrait, 2 = portrait upside down, 3 = landscape (top of device on the left), 4 = landscape (top of device on the right).","tags":["Instances"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Instance ID.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"required":true,"description":"Instance ID.","name":"instanceId","in":"path"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RotateBody"}}}},"responses":{"204":{"description":"No content"},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Instance not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiNotFoundError"}}}}}}},"/v3/instances/{instanceId}/input":{"post":{"operationId":"v3PostInstanceInput","x-sdk-method":"instances.sendInput","summary":"Provide Instance Input","description":"Sends a touch or button event to the VM. Events in the request array are processed in order.\n\nEach element of the request array is one of:\n- **TouchInputRequest** – holds buttons (or keys) and/or touches at a screen position.\n  - Set `buttons` to `[\"finger\"]` to press down and `[]` to release all buttons.\n  - Omit `buttons` to leave the current press state unchanged.\n  - `position` is an array of per-finger `[x, y]` coordinates. May be omitted for button-only input.\n- **TouchCurveInputRequest** – animates a drag/swipe from `start` to `end` over `duration` ms.\n  - Optional `bezierPoints` shape the path; omit for a straight-line drag.\n- **TextInputRequest** – types the given text.\n\nButtons (or keys) accepted by `buttons` / `startButtons` / `endButtons` are an array of strings,\neach either a single ASCII character or one of the following keywords:\n- VM buttons (case-insensitive): `finger`, `homeButton`, `holdButton` (Power/Hold),\n  `volumeUp`, `volumeDown`, `backButton`, `overviewButton`. `ringerSwitch` is not supported.\n- Keyboard key names: `again`, `alt`, `alterase`, `apostrophe`, `back`, `backslash`, `backspace`,\n  `bassboost`, `bookmarks`, `bsp`, `calc`, `camera`, `cancel`, `caps`, `capslock`, `chat`, `close`,\n  `closecd`, `comma`, `compose`, `computer`, `config`, `connect`, `copy`, `ctrl`, `cut`,\n  `cyclewindows`, `dashboard`, `del`, `delete`, `deletefile`, `dot`, `down`, `edit`, `eject`,\n  `ejectclose`, `email`, `end`, `enter`, `equal`, `esc`, `escape`, `exit`, `f1`–`f24`, `fastfwd`,\n  `file`, `finance`, `find`, `forward`, `front`, `grave`, `hangeul`, `hanja`, `help`,\n  `henkan`, `home`, `homepage`, `hp`, `hrgn`, `ins`, `insert`, `iso`, `k102`, `kp0`–`kp9`,\n  `kpasterisk`, `kpcomma`, `kpdot`, `kpenter`, `kpequal`, `kpjpcomma`, `kpleftparen`, `kpminus`,\n  `kpplus`, `kpplusminus`, `kprightparen`, `kpslash`, `ktkn`, `ktknhrgn`, `left`, `leftalt`,\n  `leftbrace`, `leftctrl`, `leftmeta`, `leftshift`, `linefeed`, `macro`, `mail`, `menu`, `meta`,\n  `minus`, `move`, `msdos`, `muhenkan`, `mute`, `new`, `next`, `numlock`, `open`, `pagedown`,\n  `pageup`, `paste`, `pause`, `pausecd`, `pgdn`, `pgup`, `phone`, `play`, `playcd`, `playpause`,\n  `power`, `previous`, `print`, `prog1`–`prog4`, `props`, `question`, `record`, `redo`, `refresh`,\n  `return`, `rewind`, `right`, `rightalt`, `rightbrace`, `rightctrl`, `rightmeta`, `rightshift`,\n  `ro`, `rotate`, `scale`, `screenlock`, `scrolldown`, `scrolllock`, `scrollup`, `search`,\n  `semicolon`, `sendfile`, `setup`, `shift`, `shop`, `slash`, `sleep`, `sound`, `space`, `sport`,\n  `stop`, `stopcd`, `suspend`, `sysrq`, `tab`, `undo`, `up`, `voldown`, `volup`, `wakeup`, `www`,\n  `xfer`, `yen`, `zkhk`.\n\nUse `finger:1` to press the fingerprint sensor (see the `fingerprint` example).","tags":["Instances"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Instance ID.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"required":true,"description":"Instance ID.","name":"instanceId","in":"path"}],"requestBody":{"required":true,"description":"Array of input events to send to the VM.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/InstanceInputBody"}},"examples":{"tap":{"summary":"100ms tap at (300, 600)","value":[{"buttons":["finger"],"position":[[300,600]],"wait":0},{"buttons":[],"wait":100}]},"swipe":{"summary":"One-finger swipe upward","value":[{"startButtons":["finger"],"start":[[300,600]],"bezierPoints":[[[350,500]],[[375,450]]],"end":[[400,400]],"endButtons":[],"duration":200}]},"type":{"summary":"Type text","value":[{"text":"Hello, world"}]},"tapThenType":{"summary":"Tap a text field then type","value":[{"buttons":["finger"],"position":[[300,600]],"wait":0},{"buttons":[],"wait":100},{"text":"Hello, world"}]},"fingerprint":{"summary":"Press and release the fingerprint sensor","value":[{"buttons":["finger:1"]},{"buttons":[],"wait":500}]}}}}},"responses":{"200":{"description":"ETA of input completion in milliseconds.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InputResponse"}}}},"400":{"description":"Invalid input (e.g. unknown button name or malformed position).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Instance not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiNotFoundError"}}}}}}},"/v3/instances/{instanceId}/consoleLog":{"get":{"operationId":"v3GetInstanceConsoleLog","x-sdk-method":"instances.getConsoleLog","summary":"Read the console log","description":"Returns the text output of the device's main console (serial output from boot messages, the kernel and system services) as plain text. Useful for seeing why a device will not boot. For a live, interactive console, use `v3GetInstanceConsole` instead.","tags":["Instances"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Instance ID.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"required":true,"description":"Instance ID.","name":"instanceId","in":"path"}],"responses":{"200":{"description":"Current console log.","content":{"text/plain":{"schema":{"type":"string","example":"Starting SpringBoard..."}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v3/instances/{instanceId}/panics":{"get":{"operationId":"v3GetInstancePanics","x-sdk-method":"instances.getPanics","summary":"List kernel panics","description":"Returns the kernel panics (crashes of the operating system itself) recorded on this device, as a list of panic records. An empty list means none have happened since the last clear. Clear them with `v3ClearInstancePanics`.","tags":["Instances"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Instance ID.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"required":true,"description":"Instance ID.","name":"instanceId","in":"path"}],"responses":{"200":{"description":"Array of panics.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"nullable":true}}}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}},"delete":{"operationId":"v3ClearInstancePanics","x-sdk-method":"instances.clearPanics","summary":"Clear kernel panics","description":"Deletes the recorded kernel panics for this device, so the next `v3GetInstancePanics` shows only new ones. An unknown `instanceId` is a successful no-op that returns 204.","tags":["Instances"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Instance ID.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"required":true,"description":"Instance ID.","name":"instanceId","in":"path"}],"responses":{"204":{"description":"No content"},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v3/instances/{instanceId}/media/play":{"post":{"operationId":"v3MediaPlay","x-sdk-method":"instances.mediaPlay","summary":"Play a video or audio file into the device","description":"Plays a media file into the device, so apps receive it as if it came from the device's camera (video) and microphone (audio). Use it to test camera or scanning features, for example feeding a QR code video to an app. Open the camera app on the device to see it.\n\nGive exactly one source: `imageId` of a `media` image you uploaded with `POST /v3/images`, or a `url` the platform can download the file from. Returns 204 once playback starts. Call `v3MediaStop` to stop it.","tags":["Instances"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Instance ID.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"required":true,"description":"Instance ID.","name":"instanceId","in":"path"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MediaPlayBody"}}}},"responses":{"204":{"description":"No content"},"400":{"description":"The request was invalid, for example a missing or malformed field. The body says which field; fix it before retrying.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Instance not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiNotFoundError"}}}},"409":{"description":"The request conflicts with the current state of the resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiConflictError"}}}}}}},"/v3/instances/{instanceId}/media/stop":{"post":{"operationId":"v3MediaStop","x-sdk-method":"instances.mediaStop","summary":"Stop playing media","description":"Stops media started with `v3MediaPlay`.","tags":["Instances"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Instance ID.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"required":true,"description":"Instance ID.","name":"instanceId","in":"path"}],"responses":{"204":{"description":"No content"},"400":{"description":"The request was invalid, for example a missing or malformed field. The body says which field; fix it before retrying.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Instance not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiNotFoundError"}}}}}}},"/v3/instances/{instanceId}/strace":{"delete":{"operationId":"v3ClearCoreTrace","x-sdk-method":"coreTrace.clear","summary":"Clear CoreTrace output","description":"Deletes the CoreTrace (system call trace) output recorded so far on this device, so the next download contains only new activity. Tracing keeps running if it is on. Requires the CoreTrace license feature (403 otherwise). An unknown `instanceId` is a successful no-op that returns 204.","tags":["CoreTrace","Instances"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Instance ID.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"required":true,"description":"Instance ID.","name":"instanceId","in":"path"}],"responses":{"204":{"description":"No content"},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v3/instances/{instanceId}/strace/enable":{"post":{"operationId":"v3StartCoreTrace","x-sdk-method":"coreTrace.start","summary":"Start CoreTrace","description":"Starts CoreTrace on a running device. CoreTrace records the system calls made by processes on the device, so you can see what an app does at the operating-system level (files opened, network connections, processes started).\n\n**Workflow:**\n1. `v3StartCoreTrace` (this call).\n2. Use the device or app you want to observe. Optionally list running processes with `v3ListThreads`, and limit tracing to some of them with `straceFilter` on `v3PatchInstance`.\n3. `v3StopCoreTrace`.\n4. `v3StracePreauthorize` to get a download token, then download the trace.\n5. `v3ClearCoreTrace` to discard it before the next run.\n\nReturns 400 if this device does not support CoreTrace, and 403 if your license does not include it.","tags":["CoreTrace","Instances"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Instance ID.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"required":true,"description":"Instance ID.","name":"instanceId","in":"path"}],"responses":{"204":{"description":"No content"},"400":{"description":"The request was invalid, for example a missing or malformed field. The body says which field; fix it before retrying.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v3/instances/{instanceId}/strace/disable":{"post":{"operationId":"v3StopCoreTrace","x-sdk-method":"coreTrace.stop","summary":"Stop CoreTrace","description":"Stops CoreTrace on this device. The trace recorded so far is kept, so you can download it with `v3StracePreauthorize`. Requires the CoreTrace license feature.","tags":["CoreTrace","Instances"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Instance ID.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"required":true,"description":"Instance ID.","name":"instanceId","in":"path"}],"responses":{"204":{"description":"No content"},"400":{"description":"The request was invalid, for example a missing or malformed field. The body says which field; fix it before retrying.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v3/instances/{instanceId}/ramdump/start":{"post":{"operationId":"v3StartRamDump","x-sdk-method":"ramDump.start","summary":"Start a RAM dump","description":"Captures the full contents of the device's memory to a file, for offline analysis with memory forensics tools. Returns 202 as soon as the dump has started; it is written in the background, and large memory sizes take a while. Download it with `v3RamDumpPreauthorize` when it is done, and delete it with `v3ClearRamDump`. Requires the RAM dump license feature (403 otherwise).","tags":["RAM Dump","Instances"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Instance ID.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"required":true,"description":"Instance ID.","name":"instanceId","in":"path"}],"responses":{"202":{"description":"RAM dump started."},"400":{"description":"The request was invalid, for example a missing or malformed field. The body says which field; fix it before retrying.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"The request conflicts with the current state of the resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiConflictError"}}}}}}},"/v3/instances/{instanceId}/ramdump":{"delete":{"operationId":"v3ClearRamDump","x-sdk-method":"ramDump.clear","summary":"Delete a RAM dump","description":"Deletes this device's RAM dump file. Returns 204 whether or not a dump existed. Requires the RAM dump license feature. An unknown `instanceId` is a successful no-op that returns 204.","tags":["RAM Dump","Instances"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Instance ID.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"required":true,"description":"Instance ID.","name":"instanceId","in":"path"}],"responses":{"204":{"description":"No content"},"400":{"description":"The request was invalid, for example a missing or malformed field. The body says which field; fix it before retrying.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v3/instances/{instanceId}/ramdump-authorize":{"get":{"operationId":"v3RamDumpPreauthorize","x-sdk-method":"ramDump.preauthorize","summary":"Get a RAM dump download token","description":"Returns a short-lived token that authorizes downloading this device's RAM dump without an `Authorization` header, so you can hand the link to a download manager or browser. Download with `GET /v1/preauthed/{token}/{filename}`. The token works only for this device's RAM dump and expires when your current session token expires. Requires the RAM dump license feature.","tags":["RAM Dump","Instances"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Instance ID.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"required":true,"description":"Instance ID.","name":"instanceId","in":"path"}],"responses":{"200":{"description":"Token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Token"}}}},"400":{"description":"The request was invalid, for example a missing or malformed field. The body says which field; fix it before retrying.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v3/instances/{instanceId}/strace/thread-list":{"get":{"operationId":"v3ListThreads","x-sdk-method":"coreTrace.listThreads","summary":"List running processes (CoreTrace)","description":"Lists the processes running on the device with their threads, including each process's `processId` and name and each thread's `taskId`. Use it to pick which processes to trace with CoreTrace (set `straceFilter` on `v3PatchInstance`). The device must be running.","tags":["CoreTrace","Instances"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Instance ID.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"required":true,"description":"Instance ID.","name":"instanceId","in":"path"}],"responses":{"200":{"description":"Threads.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/KernelTask"}}}}},"400":{"description":"The request was invalid, for example a missing or malformed field. The body says which field; fix it before retrying.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v3/instances/{instanceId}/strace-authorize":{"get":{"operationId":"v3StracePreauthorize","x-sdk-method":"coreTrace.preauthorize","summary":"Get a CoreTrace download token","description":"Returns a short-lived token that authorizes downloading this device's CoreTrace output without an `Authorization` header. Download with `GET /v1/preauthed/{token}/{filename}`. The token works only for this device's trace and expires when your current session token expires.","tags":["CoreTrace","Instances"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Instance ID.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"required":true,"description":"Instance ID.","name":"instanceId","in":"path"}],"responses":{"200":{"description":"Token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Token"}}}},"400":{"description":"The request was invalid, for example a missing or malformed field. The body says which field; fix it before retrying.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v3/instances/{instanceId}/btrace-authorize":{"get":{"operationId":"v3BtracePreauthorize","x-sdk-method":"hyperTrace.preauthorize","summary":"Get a HyperTrace download token","description":"Returns a short-lived token that authorizes downloading this device's HyperTrace output without an `Authorization` header. Download with `GET /v1/preauthed/{token}/{filename}`. The token works only for this device's trace and expires when your current session token expires.","tags":["HyperTrace","Instances"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Instance ID.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"required":true,"description":"Instance ID.","name":"instanceId","in":"path"}],"responses":{"200":{"description":"Token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Token"}}}},"400":{"description":"The request was invalid, for example a missing or malformed field. The body says which field; fix it before retrying.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v3/instances/{instanceId}/btrace-kcrange":{"get":{"operationId":"v3GetInstanceKcrange","x-sdk-method":"hyperTrace.getKcrange","summary":"List kernel extension address ranges","description":"Lists the kernel extensions loaded on the device with the memory address range each occupies. Pass a `range` to `v3StartHyperTrace` to trace code in just that extension. The device must be running.","tags":["HyperTrace","Instances"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Instance ID.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"required":true,"description":"Instance ID.","name":"instanceId","in":"path"}],"responses":{"200":{"description":"Kcranges.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Kcrange"}}}}},"400":{"description":"The request was invalid, for example a missing or malformed field. The body says which field; fix it before retrying.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Instance not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiNotFoundError"}}}}}}},"/v3/instances/{instanceId}/btrace":{"delete":{"operationId":"v3ClearHyperTrace","x-sdk-method":"hyperTrace.clear","summary":"Clear HyperTrace output","description":"Deletes the HyperTrace output recorded so far on this device. An unknown `instanceId` is a successful no-op that returns 204.","tags":["HyperTrace","Instances"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Instance ID.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"required":true,"description":"Instance ID.","name":"instanceId","in":"path"}],"responses":{"204":{"description":"No content"},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v3/instances/{instanceId}/btrace/enable":{"post":{"operationId":"v3StartHyperTrace","x-sdk-method":"hyperTrace.start","summary":"Start HyperTrace","description":"Starts HyperTrace on a running device. HyperTrace records which kernel code runs inside the address ranges you choose, without changing the device's software, so you can measure kernel code coverage.\n\n**Workflow:** list kernel extensions with `v3GetInstanceKcrange`, start tracing with the `ranges` you want (this call), exercise the device, stop with `v3StopHyperTrace`, then download with `v3BtracePreauthorize`. Clear old output with `v3ClearHyperTrace`.","tags":["HyperTrace","Instances"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Instance ID.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"required":true,"description":"Instance ID.","name":"instanceId","in":"path"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnableBtraceBody"}}}},"responses":{"204":{"description":"No content"},"400":{"description":"The request was invalid, for example a missing or malformed field. The body says which field; fix it before retrying.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v3/instances/{instanceId}/btrace/disable":{"post":{"operationId":"v3StopHyperTrace","x-sdk-method":"hyperTrace.stop","summary":"Stop HyperTrace","description":"Stops HyperTrace on this device. The trace recorded so far is kept for download with `v3BtracePreauthorize`.","tags":["HyperTrace","Instances"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Instance ID.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"required":true,"description":"Instance ID.","name":"instanceId","in":"path"}],"responses":{"204":{"description":"No content"},"400":{"description":"The request was invalid, for example a missing or malformed field. The body says which field; fix it before retrying.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v3/instances/{instanceId}/hooks/execute":{"post":{"operationId":"v3ExecuteHyperTraceHooks","x-sdk-method":"hooks.execute","summary":"Run hypervisor hooks","description":"Activates the hypervisor hooks configured for this device. A hook is a small patch, written in a C-like (`csmfcc`) or assembly-like (`csmfvm`) language, that runs whenever the device executes a chosen memory address; create and manage hooks with the Hypervisor Hooks endpoints (`POST /v3/instances/{instanceId}/hooks`). Only hooks marked `enabled` run. Does nothing if no hooks are configured.","tags":["Hypervisor Hooks","Instances"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Instance ID.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"required":true,"description":"Instance ID.","name":"instanceId","in":"path"}],"responses":{"204":{"description":"No content"},"400":{"description":"The request was invalid, for example a missing or malformed field. The body says which field; fix it before retrying.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v3/instances/{instanceId}/hooks/clear":{"post":{"operationId":"v3ClearHyperTraceHooks","x-sdk-method":"hooks.clear","summary":"Stop hypervisor hooks","description":"Deactivates the hypervisor hooks on this device, so they stop running. The hook definitions are kept and can be activated again with `v3ExecuteHyperTraceHooks`.","tags":["Hypervisor Hooks","Instances"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Instance ID.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"required":true,"description":"Instance ID.","name":"instanceId","in":"path"}],"responses":{"204":{"description":"No content"},"400":{"description":"The request was invalid, for example a missing or malformed field. The body says which field; fix it before retrying.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v3/instances/{instanceId}/sslsplit/enable":{"post":{"operationId":"v3StartNetworkMonitor","x-sdk-method":"instances.startNetworkMonitor","summary":"Start Network Monitor","description":"Starts Network Monitor on this device. It records the device's network traffic, including HTTPS traffic decrypted by intercepting its encryption, so you can see what apps send and receive. Download the capture as a pcap file (open it with Wireshark) with `v3DownloadNetworkMonitorPcap`. Apps that pin their certificates may refuse the intercepted connections. Requires the Network Monitor license feature (403 otherwise).","tags":["Instances"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Instance ID.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"required":true,"description":"Instance ID.","name":"instanceId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnableSslsplitBody"}}}},"responses":{"204":{"description":"No content"},"400":{"description":"The request was invalid, for example a missing or malformed field. The body says which field; fix it before retrying.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v3/instances/{instanceId}/sslsplit/disable":{"post":{"operationId":"v3StopNetworkMonitor","x-sdk-method":"instances.stopNetworkMonitor","summary":"Stop Network Monitor","description":"Stops Network Monitor on this device. The capture so far can still be downloaded with `v3DownloadNetworkMonitorPcap`. Requires the Network Monitor license feature.","tags":["Instances"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Instance ID.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"required":true,"description":"Instance ID.","name":"instanceId","in":"path"}],"responses":{"204":{"description":"No content"},"400":{"description":"The request was invalid, for example a missing or malformed field. The body says which field; fix it before retrying.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v3/instances/{instanceId}/netdump/enable":{"post":{"operationId":"v3StartNetdump","x-sdk-method":"instances.startNetdump","summary":"Start Enhanced Network Monitor","description":"Starts Enhanced Network Monitor on this device. It captures raw network packets, and every filter in the body is optional: limit the capture to certain ports, protocols, hosts, or process names to keep it small. Download it with `v3DownloadNetdumpPcap`. Requires the Enhanced Network Monitor feature (403 otherwise).","tags":["Instances","Netdump"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Instance ID.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"required":true,"description":"Instance ID.","name":"instanceId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnableNetdumpBody"}}}},"responses":{"204":{"description":"No content"},"400":{"description":"The request was invalid, for example a missing or malformed field. The body says which field; fix it before retrying.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v3/instances/{instanceId}/netdump/disable":{"post":{"operationId":"v3StopNetdump","x-sdk-method":"instances.stopNetdump","summary":"Stop Enhanced Network Monitor","description":"Stops Enhanced Network Monitor on this device. The capture so far can still be downloaded with `v3DownloadNetdumpPcap`.","tags":["Instances","Netdump"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Instance ID.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"required":true,"description":"Instance ID.","name":"instanceId","in":"path"}],"responses":{"204":{"description":"No content"},"400":{"description":"The request was invalid, for example a missing or malformed field. The body says which field; fix it before retrying.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v3/instances/{instanceId}/exposeport/enable":{"post":{"operationId":"v3EnableExposePort","x-sdk-method":"instances.enableExposePort","summary":"Expose the device port","description":"Turns on the exposed port for this device, for device access. This runs as a background task on the device; returns 204 once it is scheduled. Undo with `v3DisableExposePort`.","tags":["Instances"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Instance ID.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"required":true,"description":"Instance ID.","name":"instanceId","in":"path"}],"responses":{"204":{"description":"No content"},"400":{"description":"The request was invalid, for example a missing or malformed field. The body says which field; fix it before retrying.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v3/instances/{instanceId}/exposeport/disable":{"post":{"operationId":"v3DisableExposePort","x-sdk-method":"instances.disableExposePort","summary":"Stop exposing the device port","description":"Turns off the exposed port enabled with `v3EnableExposePort`. Runs as a background task on the device; returns 204 once it is scheduled.","tags":["Instances"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Instance ID.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"required":true,"description":"Instance ID.","name":"instanceId","in":"path"}],"responses":{"204":{"description":"No content"},"400":{"description":"The request was invalid, for example a missing or malformed field. The body says which field; fix it before retrying.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v3/instances/{instanceId}/message":{"post":{"operationId":"v3InjectMessage","x-sdk-method":"instances.injectMessage","summary":"Send an SMS message to an iOS device","description":"Delivers a text message to an iOS device as if it arrived over the cellular network, so apps see a normal incoming SMS. Useful for testing one-time-password and verification-code flows. Send either `number` (the sender's phone number) and `message` (the text), or `raw` with the message bytes in hexadecimal for low-level testing. The device must be running.","tags":["Instances"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Instance ID.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"required":true,"description":"Instance ID.","name":"instanceId","in":"path"}],"requestBody":{"required":true,"description":"Message data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageBody"}}}},"responses":{"204":{"description":"No content"},"400":{"description":"The request was invalid, for example a missing or malformed field. The body says which field; fix it before retrying.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v3/instances/{instance}/image-upload/{type}/{imageId}/{name}":{"get":{"operationId":"v3GetInstanceImageUpload","x-sdk-method":"instances.getImageUpload","summary":"Get image upload status","description":"Checks the progress of a chunked upload made with `v3PutInstanceImageUpload`, or downloads the finished file. With chunk parameters (`resumableChunkNumber` and friends) it returns 200 if that chunk is already stored and 204 if it still needs to be sent; without them it downloads the image file.","tags":["Instances"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Instance ID.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"required":true,"description":"Instance ID.","name":"instance","in":"path"},{"schema":{"type":"string","enum":["iotfirmware","kernel","devicetree","ramdisk","loaderfile","media","sepfw","seprom","bootrom","llb","iboot","ibootdata","fw","fwasset","partition","extension","vmfile","backup","activity-export","ufd","mast-wordlist","mast-report","mast-frida","pongo","clbi"],"description":"What kind of file this is, for example `fw` for firmware or `kernel`. Uses the same values as `type` on `POST /v3/images`; see `ImageType` for what each means. Types that need a license feature your license lacks are rejected with 403."},"required":true,"description":"What kind of file this is, for example `fw` for firmware or `kernel`. Uses the same values as `type` on `POST /v3/images`; see `ImageType` for what each means. Types that need a license feature your license lacks are rejected with 403.","name":"type","in":"path"},{"schema":{"type":"string","format":"uuid","description":"An ID you choose for the new image: generate a random UUID once per file and use the same value for every chunk of that file. The image record is created with this ID when the first chunk arrives. Use a new UUID for each new upload."},"required":true,"description":"An ID you choose for the new image: generate a random UUID once per file and use the same value for every chunk of that file. The image record is created with this ID when the first chunk arrives. Use a new UUID for each new upload.","name":"imageId","in":"path"},{"schema":{"type":"string","description":"The file name to store, URL-encoded (for example `my%20firmware.ipsw`). Becomes the image `name`."},"required":true,"description":"The file name to store, URL-encoded (for example `my%20firmware.ipsw`). Becomes the image `name`.","name":"name","in":"path"},{"schema":{"type":"integer","description":"Chunk number. When present the response reports whether that chunk was already stored (200) or still needs to be uploaded (204) instead of returning the image file."},"required":false,"description":"Chunk number. When present the response reports whether that chunk was already stored (200) or still needs to be uploaded (204) instead of returning the image file.","name":"resumableChunkNumber","in":"query"}],"responses":{"200":{"description":"An empty JSON object when a probed chunk is already stored, the image bytes when the file is stored locally, or the image metadata when no file has been stored yet.","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary","description":"Image file contents."}},"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":{"nullable":true}}}}},"204":{"description":"The probed chunk is not stored yet and still needs to be uploaded."},"302":{"description":"The image is stored in S3; follow the Location header to download it.","headers":{"Location":{"schema":{"type":"string","format":"uri","description":"URL the client is redirected to.","example":"https://storage.example.com/images/3e1354a3-fb10-46c0-8b05-56e28edbde69/file?X-Amz-Expires=900&X-Amz-Signature=<signature>"},"required":true,"description":"URL the client is redirected to."}}},"400":{"description":"The image identifier is invalid or the image record is missing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"No image with the given identifier.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiNotFoundError"}}}}}},"put":{"operationId":"v3PutInstanceImageUpload","x-sdk-method":"instances.putImageUpload","summary":"Upload image chunk","description":"Uploads one chunk of a file attached to this device, using the same resumable protocol as `PUT /v3/images/{imageId}/file`. You choose the image ID (a new random UUID) and the image record is created on the first chunk; `type` and `name` in the path set the image type and name. Because the image is attached to the device, it replaces any image of the same `type` already attached (for `partition`, only the one with the same `name`), and it is deleted when the device is deleted. The web interface uses this route, for example to replace a kernel. For your own code, `POST /v3/images` with `instanceId` followed by `PUT /v3/images/{imageId}/file` is easier to follow. Returns 200 with an empty object for each stored chunk.","tags":["Instances"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Instance ID.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"required":true,"description":"Instance ID.","name":"instance","in":"path"},{"schema":{"type":"string","enum":["iotfirmware","kernel","devicetree","ramdisk","loaderfile","media","sepfw","seprom","bootrom","llb","iboot","ibootdata","fw","fwasset","partition","extension","vmfile","backup","activity-export","ufd","mast-wordlist","mast-report","mast-frida","pongo","clbi"],"description":"What kind of file this is, for example `fw` for firmware or `kernel`. Uses the same values as `type` on `POST /v3/images`; see `ImageType` for what each means. Types that need a license feature your license lacks are rejected with 403."},"required":true,"description":"What kind of file this is, for example `fw` for firmware or `kernel`. Uses the same values as `type` on `POST /v3/images`; see `ImageType` for what each means. Types that need a license feature your license lacks are rejected with 403.","name":"type","in":"path"},{"schema":{"type":"string","format":"uuid","description":"An ID you choose for the new image: generate a random UUID once per file and use the same value for every chunk of that file. The image record is created with this ID when the first chunk arrives. Use a new UUID for each new upload."},"required":true,"description":"An ID you choose for the new image: generate a random UUID once per file and use the same value for every chunk of that file. The image record is created with this ID when the first chunk arrives. Use a new UUID for each new upload.","name":"imageId","in":"path"},{"schema":{"type":"string","description":"The file name to store, URL-encoded (for example `my%20firmware.ipsw`). Becomes the image `name`."},"required":true,"description":"The file name to store, URL-encoded (for example `my%20firmware.ipsw`). Becomes the image `name`.","name":"name","in":"path"},{"schema":{"type":"integer","nullable":true,"description":"Which chunk this is, counting from 1."},"required":false,"description":"Which chunk this is, counting from 1.","name":"resumableChunkNumber","in":"query"},{"schema":{"type":"integer","nullable":true,"description":"The size, in bytes, you split the file into. Use the same value for every chunk; only the last chunk may be smaller. If you send `corelliumChecksum`, this must equal the block size inside it."},"required":false,"description":"The size, in bytes, you split the file into. Use the same value for every chunk; only the last chunk may be smaller. If you send `corelliumChecksum`, this must equal the block size inside it.","name":"resumableChunkSize","in":"query"},{"schema":{"type":"integer","nullable":true,"description":"Actual size in bytes of this chunk's body."},"required":false,"description":"Actual size in bytes of this chunk's body.","name":"resumableCurrentChunkSize","in":"query"},{"schema":{"type":"integer","nullable":true,"description":"Size of the whole file in bytes."},"required":false,"description":"Size of the whole file in bytes.","name":"resumableTotalSize","in":"query"},{"schema":{"type":"integer","nullable":true,"description":"How many chunks the whole file is split into. The upload completes when the last one arrives."},"required":false,"description":"How many chunks the whole file is split into. The upload completes when the last one arrives.","name":"resumableTotalChunks","in":"query"},{"schema":{"type":"string","description":"Optional expected checksum of the whole file, formatted `algorithm$blockSize$hash`. When given, the finished upload is checked and rejected (and the image removed) if it does not match. Required for firmware (`fw`) uploads on air-gapped deployments."},"required":false,"description":"Optional expected checksum of the whole file, formatted `algorithm$blockSize$hash`. When given, the finished upload is checked and rejected (and the image removed) if it does not match. Required for firmware (`fw`) uploads on air-gapped deployments.","name":"corelliumChecksum","in":"query"},{"schema":{"type":"string","description":"Device model (`flavor` from `GET /v3/models`) the image is for. Needed for `partition` uploads when the image is not attached to a device, so the partition name can be checked against that model."},"required":false,"description":"Device model (`flavor` from `GET /v3/models`) the image is for. Needed for `partition` uploads when the image is not attached to a device, so the partition name can be checked against that model.","name":"flavor","in":"query"},{"schema":{"type":"string","enum":["plain","encrypted"],"description":"How the file is stored: `plain` (normal) or `encrypted`. Only read on the first chunk, when the image record is created; later chunks cannot change it."},"required":false,"description":"How the file is stored: `plain` (normal) or `encrypted`. Only read on the first chunk, when the image record is created; later chunks cannot change it.","name":"x-corellium-image-encoding","in":"header"},{"schema":{"type":"boolean","description":"Whether the uploaded file is a ZIP wrapper the platform should unpack. Send false to store the file exactly as uploaded. Only read on the first chunk, when the image record is created."},"required":false,"description":"Whether the uploaded file is a ZIP wrapper the platform should unpack. Send false to store the file exactly as uploaded. Only read on the first chunk, when the image record is created.","name":"x-corellium-image-encapsulated","in":"header"},{"schema":{"type":"integer","nullable":true,"description":"Size of the whole file in bytes. Send it on every chunk: the platform uses it to check up front that there is room for the entire file, and answers 507 if there is not, before storing any data."},"required":false,"description":"Size of the whole file in bytes. Send it on every chunk: the platform uses it to check up front that there is room for the entire file, and answers 507 if there is not, before storing any data.","name":"x-corellium-total-file-size","in":"header"},{"schema":{"type":"string","description":"Password of a password-protected file (for example encrypted firmware), used to check the file after upload. Leave out for normal files."},"required":false,"description":"Password of a password-protected file (for example encrypted firmware), used to check the file after upload. Leave out for normal files.","name":"x-corellium-image-password","in":"header"}],"requestBody":{"required":true,"content":{"application/octet-stream":{"schema":{"type":"string","format":"binary","description":"Raw bytes of this chunk, or of the whole file when unchunked."}}}},"responses":{"200":{"description":"Chunk stored. The body is an empty JSON object. Send the next chunk; the image is finished when the last chunk arrives.","content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":{"nullable":true}}}}},"400":{"description":"Invalid chunk or upload parameters, unreadable body, or a missing/mismatched corelliumChecksum for a firmware upload.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"No image with the given identifier.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiNotFoundError"}}}},"507":{"description":"The image pool does not have enough space for this upload.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InsufficientStorageError"}}}}}}},"/v3/instances/{instanceId}/quickConnectCommand":{"get":{"operationId":"v3GetInstanceQuickConnectCommand","x-sdk-method":"instances.getQuickConnectCommand","summary":"Get the SSH quick-connect command","description":"Returns a ready-to-paste SSH command for connecting to this device, as a JSON string. Run it in a terminal on a computer that can reach the device, for example one connected with the project VPN (`GET /v3/projects/{projectId}/vpnconfig/{format}`).","tags":["Instances"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Instance ID.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"required":true,"description":"Instance ID.","name":"instanceId","in":"path"}],"responses":{"200":{"description":"Quick connect command.","content":{"application/json":{"schema":{"type":"string","example":"ssh corellium@10.0.5.23 -p 2222"}}}},"400":{"description":"The request was invalid, for example a missing or malformed field. The body says which field; fix it before retrying.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v3/instances/{instanceId}/upgrade":{"post":{"operationId":"v3UpgradeInstance","x-sdk-method":"instances.upgrade","summary":"Upgrade the iOS version","description":"Upgrades an iOS device to a newer iOS version while keeping it as the same device. Returns 202 with `state: \"updating\"` once accepted; the upgrade runs in the background, so poll `v3GetInstanceState` until it is `on`. Pick the version from `GET /v3/models/{model}/software`. Use `osVersion`; the old `os` field is rejected. Requires the OS update license feature (403 otherwise).","tags":["Instances"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Instance ID.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"required":true,"description":"Instance ID.","name":"instanceId","in":"path"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstanceUpgradeBody"}}}},"responses":{"202":{"description":"Upgrade started.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstanceUpgradeResponse"}}}},"400":{"description":"The request was invalid, for example a missing or malformed field. The body says which field; fix it before retrying.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v3/instances/{instanceId}/interfaces":{"post":{"operationId":"v3AttachInstanceInterface","x-sdk-method":"instances.attachInterface","summary":"Connect an I/O interface","description":"Connects one of this device's I/O interfaces (for example a GPIO bank, `gpio/0`) to an I/O interconnect, a virtual wire that links interfaces on different devices so they can signal each other. Create the interconnect first with the Interconnects endpoints. Requires the configurable I/O license feature (403 otherwise).","tags":["Instances"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Instance ID.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"required":true,"description":"Instance ID.","name":"instanceId","in":"path"}],"requestBody":{"required":true,"description":"Interface attachment request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AttachInterfaceBody"}}}},"responses":{"204":{"description":"No content"},"400":{"description":"The request was invalid, for example a missing or malformed field. The body says which field; fix it before retrying.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Instance not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiNotFoundError"}}}}}}},"/v3/instances/{instanceId}/interfaces/{interfaceId}":{"delete":{"operationId":"v3DetachInstanceInterface","x-sdk-method":"instances.detachInterface","summary":"Disconnect an I/O interface","description":"Disconnects one of this device's I/O interfaces from an I/O interconnect. Requires the configurable I/O license feature.\n\nDeletes are idempotent: an unknown instance, interconnect or interface, including one that was already detached, is a successful no-op that still returns 204, and\nrepeated calls return 204 as well. A 404 means the request path did not match a delete route, not\nthat the target was missing.","tags":["Instances"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Instance ID.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"required":true,"description":"Instance ID.","name":"instanceId","in":"path"},{"schema":{"type":"string","description":"Interface ID.","example":"gpio/0"},"required":true,"description":"Interface ID.","name":"interfaceId","in":"path"}],"requestBody":{"required":true,"description":"Interface detachment request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DetachInterfaceBody"}}}},"responses":{"204":{"description":"No content"},"400":{"description":"The request was invalid, for example a missing or malformed field. The body says which field; fix it before retrying.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v3/cluster/nodes":{"get":{"operationId":"v3ListClusterNodes","x-required-roles":["cluster-administrator"],"x-sdk-method":"cluster.nodes.list","summary":"List cluster nodes","description":"**Required role:** Cluster administrator.\n\nLists the servers (nodes) that make up this Corellium cluster, with their status and resources. Use it to check cluster health or find a node before opening its console. Requires a cluster administrator. Results are paginated.","tags":["Cluster"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"integer","minimum":1,"maximum":1000,"default":100,"description":"Most results to return in one page. Whole number from 1 to 1000; defaults to 100. A value outside that range is rejected with 400."},"required":false,"description":"Most results to return in one page. Whole number from 1 to 1000; defaults to 100. A value outside that range is rejected with 400.","name":"limit","in":"query"},{"schema":{"type":"integer","nullable":true,"minimum":0,"default":0,"description":"How many results to skip before this page starts; defaults to 0. To get the next page, add `limit` to the previous `offset`."},"required":false,"description":"How many results to skip before this page starts; defaults to 0. To get the next page, add `limit` to the previous `offset`.","name":"offset","in":"query"}],"responses":{"200":{"description":"Paginated list of cluster nodes.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NodeList"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Cluster administrator permissions required. Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-badges":[{"name":"Cluster administrator"}]}},"/v3/cluster/nodes/{nodeId}":{"get":{"operationId":"v3GetClusterNode","x-required-roles":["cluster-administrator"],"x-sdk-method":"cluster.nodes.get","summary":"Get cluster node","description":"**Required role:** Cluster administrator.\n\nReturns details for one server (node) in the cluster, identified by the ID from `v3ListClusterNodes`. Requires a cluster administrator.","tags":["Cluster"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","description":"Node identifier.","example":"2x3ZOdu4pshouoY0kttRPoiIk5s"},"required":true,"description":"Node identifier.","name":"nodeId","in":"path"}],"responses":{"200":{"description":"Node details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NodeInformation"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Cluster administrator permissions required. Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Node not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiNotFoundError"}}}}},"x-badges":[{"name":"Cluster administrator"}]}},"/v3/cluster/nodes/{nodeId}/console":{"get":{"operationId":"v3GetClusterNodeConsole","x-required-roles":["cluster-administrator"],"x-sdk-method":"cluster.nodes.getConsole","summary":"Get node console websocket URL","description":"**Required role:** Cluster administrator.\n\nReturns a WebSocket URL for a terminal session on one cluster server (node), for maintenance and troubleshooting. Open the URL with a WebSocket client to get the console stream. Requires a cluster administrator.","tags":["Cluster"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","description":"Node identifier.","example":"2x3ZOdu4pshouoY0kttRPoiIk5s"},"required":true,"description":"Node identifier.","name":"nodeId","in":"path"}],"responses":{"200":{"description":"Console WebSocket URL.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NodeConsoleEndpoint"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Cluster administrator permissions required. Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Node not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiNotFoundError"}}}}},"x-badges":[{"name":"Cluster administrator"}]}},"/v3/cluster/config":{"get":{"operationId":"v3GetClusterConfig","x-required-roles":["cluster-administrator"],"x-sdk-method":"cluster.config.get","summary":"Get cluster configuration","description":"**Required role:** Cluster administrator.\n\nReturns the settings that apply to the whole cluster. Requires a cluster administrator.","tags":["Cluster"],"security":[{"BearerAuth":[]}],"responses":{"200":{"description":"Cluster configuration object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClusterConfig"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Cluster administrator permissions required. Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-badges":[{"name":"Cluster administrator"}]},"patch":{"operationId":"v3PatchClusterConfig","x-required-roles":["cluster-administrator"],"x-sdk-method":"cluster.config.patch","summary":"Update cluster configuration","description":"**Required role:** Cluster administrator.\n\nChanges cluster-wide settings and applies them on every controller node. Send only the settings you want to change. Requires a cluster administrator.","tags":["Cluster"],"security":[{"BearerAuth":[]}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchClusterConfigBody"}}}},"responses":{"200":{"description":"Configuration updated successfully."},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Cluster administrator permissions required. Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Configuration update failed on one or more nodes.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClusterConfigUpdateError"}}}}},"x-badges":[{"name":"Cluster administrator"}]}},"/v3/cluster/snapshots":{"get":{"operationId":"v3ListClusterSnapshots","x-required-roles":["cluster-administrator"],"x-sdk-method":"cluster.snapshots.list","summary":"List cluster snapshots","description":"**Required role:** Cluster administrator.\n\nLists device snapshots across the whole cluster, for administrators managing storage. Requires a cluster administrator and the cluster snapshot management feature (`clusterSnapshotMgmt`). Results are paginated. For one device's snapshots, use `GET /v3/instances/{instanceId}/snapshots` instead.","tags":["Cluster"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"integer","minimum":1,"maximum":1000,"default":100,"description":"Number of entries to return.","example":100},"required":false,"description":"Number of entries to return.","name":"limit","in":"query"},{"schema":{"type":"integer","nullable":true,"minimum":0,"default":0,"description":"Number of rows to skip.","example":0},"required":false,"description":"Number of rows to skip.","name":"offset","in":"query"},{"schema":{"type":"string","description":"Filter by springboard snapshot flag.","example":"true"},"required":false,"description":"Filter by springboard snapshot flag.","name":"springboard","in":"query"},{"schema":{"type":"string","description":"Filter by live snapshot flag.","example":"true"},"required":false,"description":"Filter by live snapshot flag.","name":"live","in":"query"},{"schema":{"type":"string","description":"Filter by fresh snapshot flag.","example":"false"},"required":false,"description":"Filter by fresh snapshot flag.","name":"fresh","in":"query"},{"schema":{"type":"string","description":"Filter by device name.","example":"iPhone 13 Pro"},"required":false,"description":"Filter by device name.","name":"deviceName","in":"query"},{"schema":{"type":"string","description":"Filter by task being executed on the snapshot.","example":"creating"},"required":false,"description":"Filter by task being executed on the snapshot.","name":"task","in":"query"},{"schema":{"type":"string","description":"Fuzzy search on snapshot and instance name or ID.","example":"pre-update"},"required":false,"description":"Fuzzy search on snapshot and instance name or ID.","name":"search","in":"query"},{"schema":{"type":"string","nullable":true,"format":"date-time","description":"Filter to this date (based on createdAt).","example":"2026-05-22T13:58:34.000Z"},"required":false,"description":"Filter to this date (based on createdAt).","name":"to","in":"query"},{"schema":{"type":"string","nullable":true,"format":"date-time","description":"Filter from this date (based on createdAt).","example":"2026-05-22T00:00:00.000Z"},"required":false,"description":"Filter from this date (based on createdAt).","name":"from","in":"query"},{"schema":{"type":"string","enum":["createdAt","-createdAt","updatedAt","-updatedAt","name","-name","status","-status","type","-type"],"default":"-createdAt","description":"Sort field and direction.","example":"-createdAt"},"required":false,"description":"Sort field and direction.","name":"orderBy","in":"query"}],"responses":{"200":{"description":"Paginated list of cluster snapshots.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClusterSnapshotList"}}}},"400":{"description":"Invalid query parameter(s).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Cluster administrator permissions required. The clusterSnapshotMgmt feature must be enabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-badges":[{"name":"Cluster administrator"}]}},"/v3/cluster/snapshots/{snapshotId}":{"get":{"operationId":"v3GetClusterSnapshot","x-required-roles":["cluster-administrator"],"x-sdk-method":"cluster.snapshots.get","summary":"Get cluster snapshot","description":"**Required role:** Cluster administrator.\n\nReturns one snapshot from the cluster-wide list. Requires a cluster administrator and the cluster snapshot management feature (`clusterSnapshotMgmt`).","tags":["Cluster"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Snapshot identifier.","example":"c67af9c0-26cd-4233-9782-436c842b60db"},"required":true,"description":"Snapshot identifier.","name":"snapshotId","in":"path"}],"responses":{"200":{"description":"Cluster snapshot details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClusterSnapshot"}}}},"400":{"description":"Invalid snapshot ID.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Cluster administrator permissions required. The clusterSnapshotMgmt feature must be enabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Snapshot not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiNotFoundError"}}}}},"x-badges":[{"name":"Cluster administrator"}]},"delete":{"operationId":"v3DeleteClusterSnapshot","x-required-roles":["cluster-administrator"],"x-sdk-method":"cluster.snapshots.delete","summary":"Delete cluster snapshot","description":"**Required role:** Cluster administrator.\n\nDeletes a snapshot from the cluster, for example to free storage. Snapshots that are in use, still being created, or were just restored cannot be deleted (400). Requires a cluster administrator and the cluster snapshot management feature (`clusterSnapshotMgmt`).\n\nDeletes are idempotent: an unknown `snapshotId`, or a snapshot that was already deleted, is a successful no-op that still returns 204, and\nrepeated calls return 204 as well. A 404 means the request path did not match a delete route, not\nthat the target was missing.","tags":["Cluster"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Snapshot identifier.","example":"c67af9c0-26cd-4233-9782-436c842b60db"},"required":true,"description":"Snapshot identifier.","name":"snapshotId","in":"path"}],"responses":{"204":{"description":"Snapshot deleted."},"400":{"description":"Snapshot cannot be deleted (in use, still creating, or freshly restored).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Cluster administrator permissions required. The clusterSnapshotMgmt feature must be enabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-badges":[{"name":"Cluster administrator"}]}},"/v3/cluster/storage":{"get":{"operationId":"v3ListClusterStorage","x-required-roles":["cluster-administrator"],"x-sdk-method":"cluster.storage.list","summary":"List cluster storage devices","description":"**Required role:** Cluster administrator.\n\nLists the physical storage devices (for example USB drives) attached to the cluster's servers, for cluster administrators. Requires a cluster administrator. Requires the serverAttachedStorage feature. Not available on cloud installations.","tags":["Storage"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"integer","minimum":1,"maximum":1000,"default":100,"description":"Maximum results to return.","example":100},"required":false,"description":"Maximum results to return.","name":"limit","in":"query"},{"schema":{"type":"integer","nullable":true,"minimum":0,"default":0,"description":"Results to skip.","example":0},"required":false,"description":"Results to skip.","name":"offset","in":"query"},{"schema":{"type":"string","description":"Filter by identifier (comma-separated for multiple).","example":"73357171-23a0-4a3e-8661-216dbfbdd7ab"},"required":false,"description":"Filter by identifier (comma-separated for multiple).","name":"id","in":"query"},{"schema":{"type":"string","description":"Filter by device name (partial match).","example":"sdb1"},"required":false,"description":"Filter by device name (partial match).","name":"device","in":"query"},{"schema":{"type":"string","description":"Filter by filesystem type (comma-separated).","example":"ext4"},"required":false,"description":"Filter by filesystem type (comma-separated).","name":"fsType","in":"query"},{"schema":{"type":"string","description":"Filter by filesystem UUID (partial match).","example":"4a3f2e1d"},"required":false,"description":"Filter by filesystem UUID (partial match).","name":"fsUuid","in":"query"},{"schema":{"type":"string","description":"Filter by label (partial match).","example":"EXTERNAL"},"required":false,"description":"Filter by label (partial match).","name":"label","in":"query"},{"schema":{"type":"string","description":"Filter by serial number (partial match).","example":"0123456789"},"required":false,"description":"Filter by serial number (partial match).","name":"serial","in":"query"},{"schema":{"type":"string","description":"Filter by vendor (partial match).","example":"SanDisk"},"required":false,"description":"Filter by vendor (partial match).","name":"vendor","in":"query"},{"schema":{"type":"string","description":"Filter by model (partial match).","example":"Ultra"},"required":false,"description":"Filter by model (partial match).","name":"model","in":"query"},{"schema":{"type":"string","enum":["RO","RW"],"description":"Filter by mount policy."},"required":false,"description":"Filter by mount policy.","name":"mountPolicy","in":"query"},{"schema":{"type":"string","enum":["mounted","unmounted"],"description":"Filter by mount status."},"required":false,"description":"Filter by mount status.","name":"status","in":"query"},{"schema":{"type":"string","description":"Sort order (e.g. 'device' or '-device').","example":"-device"},"required":false,"description":"Sort order (e.g. 'device' or '-device').","name":"sort","in":"query"}],"responses":{"200":{"description":"Paginated list of attached storage devices.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StorageDeviceList"}}}},"400":{"description":"Invalid query parameter(s).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Cluster administrator permissions required. The serverAttachedStorage feature must be enabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-badges":[{"name":"Cluster administrator"}]}},"/v3/cluster/storage/{id}/attach":{"post":{"operationId":"v3AttachClusterStorage","x-required-roles":["cluster-administrator"],"x-sdk-method":"cluster.storage.attach","summary":"Attach storage device","description":"**Required role:** Cluster administrator.\n\nMounts an attached storage device so its files can be used. Mounting runs in the background: returns 202 when the mount has been queued, or 200 if the device is already mounted. Browse its files with `GET /v3/storage/{id}/files/{path}`. Requires a cluster administrator. Requires the serverAttachedStorage feature. Not available on cloud installations.","tags":["Storage"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Storage device identifier.","example":"73357171-23a0-4a3e-8661-216dbfbdd7ab"},"required":true,"description":"Storage device identifier.","name":"id","in":"path"}],"responses":{"200":{"description":"Device is already mounted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StorageAlreadyMountedResponse"}}}},"202":{"description":"Mount job queued.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StorageAttachResponse"}}}},"400":{"description":"Server-attached storage is not available on cloud installations.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Cluster administrator permissions required. The serverAttachedStorage feature must be enabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Storage device not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiNotFoundError"}}}},"500":{"description":"Failed to queue the mount job.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StorageQueueError"}}}}},"x-badges":[{"name":"Cluster administrator"}]}},"/v3/cluster/storage/{id}/eject":{"post":{"operationId":"v3EjectClusterStorage","x-required-roles":["cluster-administrator"],"x-sdk-method":"cluster.storage.eject","summary":"Eject storage device","description":"**Required role:** Cluster administrator.\n\nUnmounts an attached storage device so it can be unplugged safely. Unmounting runs in the background: returns 202 when the unmount has been queued, or 200 if the device is already unmounted. Requires a cluster administrator. Requires the serverAttachedStorage feature. Not available on cloud installations.","tags":["Storage"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Storage device identifier.","example":"73357171-23a0-4a3e-8661-216dbfbdd7ab"},"required":true,"description":"Storage device identifier.","name":"id","in":"path"}],"responses":{"200":{"description":"Device is already unmounted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StorageEjectAlreadyUnmountedResponse"}}}},"202":{"description":"Unmount job queued.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StorageAttachResponse"}}}},"400":{"description":"Server-attached storage is not available on cloud installations.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Cluster administrator permissions required. The serverAttachedStorage feature must be enabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Storage device not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiNotFoundError"}}}},"500":{"description":"Failed to queue the unmount job.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StorageQueueError"}}}}},"x-badges":[{"name":"Cluster administrator"}]}},"/v3/cluster/firmware-service/config":{"get":{"operationId":"v3GetFirmwareServiceConfig","x-required-roles":["cluster-administrator"],"x-sdk-method":"firmwareService.getConfig","summary":"Get firmware service configuration","description":"**Required role:** Cluster administrator.\n\nReturns the settings of the cluster firmware service: the cluster-wide catalog of operating-system builds that devices can be created from (what `GET /v3/models/{model}/software` lists). Settings control things such as whether firmware is downloaded and cached. Requires a cluster administrator. Change them with `v3PatchFirmwareServiceConfig`.","tags":["FirmwareService"],"security":[{"BearerAuth":[]}],"responses":{"200":{"description":"Firmware service configuration.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FirmwareServiceConfig"}}}},"400":{"description":"The request was invalid, for example a missing or malformed field. The body says which field; fix it before retrying.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"403":{"description":"Cluster administrator permissions required. Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-badges":[{"name":"Cluster administrator"}]},"patch":{"operationId":"v3PatchFirmwareServiceConfig","x-required-roles":["cluster-administrator"],"x-sdk-method":"firmwareService.patchConfig","summary":"Update firmware service configuration","description":"**Required role:** Cluster administrator.\n\nChanges firmware service settings. Send only the settings you want to change; they are merged into the current settings, and the full result is returned. Requires a cluster administrator.","tags":["FirmwareService"],"security":[{"BearerAuth":[]}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchFirmwareServiceConfigBody"}}}},"responses":{"200":{"description":"The full merged settings after the update.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FirmwareServiceSettings"}}}},"400":{"description":"The request was invalid, for example a missing or malformed field. The body says which field; fix it before retrying.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"403":{"description":"Cluster administrator permissions required. Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-badges":[{"name":"Cluster administrator"}]}},"/v3/cluster/firmware-service/devices":{"get":{"operationId":"v3ListFirmwareDevices","x-required-roles":["cluster-administrator"],"x-sdk-method":"firmwareService.listDevices","summary":"List firmware service devices","description":"**Required role:** Cluster administrator.\n\nLists the device models the firmware service has firmware records for. Requires a cluster administrator. Results are paginated.","tags":["FirmwareService"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"integer","minimum":1,"maximum":10000,"default":100,"description":"Number of results to return."},"required":false,"description":"Number of results to return.","name":"limit","in":"query"},{"schema":{"type":"integer","nullable":true,"minimum":0,"default":0,"description":"Index of the first row to return."},"required":false,"description":"Index of the first row to return.","name":"offset","in":"query"},{"schema":{"type":"string","description":"Case-insensitive partial match across key fields.","example":"iPhone13"},"required":false,"description":"Case-insensitive partial match across key fields.","name":"search","in":"query"},{"schema":{"type":"string","description":"Comma-separated sort fields; prefix with \"-\" for descending order.","example":"-createdAt"},"required":false,"description":"Comma-separated sort fields; prefix with \"-\" for descending order.","name":"order","in":"query"},{"schema":{"type":"string","description":"Filter by exact type.","example":"ios"},"required":false,"description":"Filter by exact type.","name":"type","in":"query"},{"schema":{"type":"string","description":"Filter by exact model.","example":"iPhone13,2"},"required":false,"description":"Filter by exact model.","name":"model","in":"query"},{"schema":{"type":"string","description":"Filter by exact name.","example":"iPhone 12"},"required":false,"description":"Filter by exact name.","name":"name","in":"query"},{"schema":{"type":"string","description":"Filter by exact platform.","example":"t8101"},"required":false,"description":"Filter by exact platform.","name":"platform","in":"query"},{"schema":{"type":"string","description":"Filter by exact hardware model.","example":"d53gap"},"required":false,"description":"Filter by exact hardware model.","name":"hwModel","in":"query"}],"responses":{"200":{"description":"Paginated list of devices.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FirmwareDeviceList"}}}},"400":{"description":"The request was invalid, for example a missing or malformed field. The body says which field; fix it before retrying.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"403":{"description":"Cluster administrator permissions required. Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"The resource does not exist, or you cannot see it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiNotFoundError"}}}}},"x-badges":[{"name":"Cluster administrator"}]}},"/v3/cluster/firmware-service/firmwares":{"get":{"operationId":"v3ListFirmwares","x-required-roles":["cluster-administrator"],"x-sdk-method":"firmwareService.listFirmwares","summary":"List firmwares","description":"**Required role:** Cluster administrator.\n\nLists the firmware builds in the cluster firmware catalog, including builds installed with `POST /v3/images/install-firmware`. Requires a cluster administrator. Results are paginated. Users see the builds for one model with `GET /v3/models/{model}/software`.","tags":["FirmwareService"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"integer","minimum":1,"maximum":10000,"default":100,"description":"Number of results to return."},"required":false,"description":"Number of results to return.","name":"limit","in":"query"},{"schema":{"type":"integer","nullable":true,"minimum":0,"default":0,"description":"Index of the first row to return."},"required":false,"description":"Index of the first row to return.","name":"offset","in":"query"},{"schema":{"type":"string","description":"Case-insensitive partial match across key fields.","example":"iPhone13"},"required":false,"description":"Case-insensitive partial match across key fields.","name":"search","in":"query"},{"schema":{"type":"string","description":"Comma-separated sort fields; prefix with \"-\" for descending order.","example":"-createdAt"},"required":false,"description":"Comma-separated sort fields; prefix with \"-\" for descending order.","name":"order","in":"query"},{"schema":{"type":"string","description":"Filter by exact filename.","example":"firmware.ipsw"},"required":false,"description":"Filter by exact filename.","name":"filename","in":"query"},{"schema":{"type":"string","description":"Filter by exact model.","example":"iPhone13,2"},"required":false,"description":"Filter by exact model.","name":"model","in":"query"},{"schema":{"type":"string","description":"Filter by exact type.","example":"ios"},"required":false,"description":"Filter by exact type.","name":"type","in":"query"},{"schema":{"type":"string","description":"Filter by exact version.","example":"17.5"},"required":false,"description":"Filter by exact version.","name":"version","in":"query"},{"schema":{"type":"string","description":"Filter by exact build ID.","example":"21F79"},"required":false,"description":"Filter by exact build ID.","name":"buildId","in":"query"},{"schema":{"type":"string","description":"Filter by exact asset URL/ID.","example":"https://example.com/firmware-assets/asset.bin"},"required":false,"description":"Filter by exact asset URL/ID.","name":"firmwareAssets","in":"query"},{"schema":{"type":"string","description":"Filter by exact Corellium checksum (upload preflight).","example":"sha256$1048576$2cf24dba5fb0a30e26e83b2ac5b9e29e1b161e5c1fa7425e73043362938b9824"},"required":false,"description":"Filter by exact Corellium checksum (upload preflight).","name":"corelliumChecksum","in":"query"},{"schema":{"type":"boolean","description":"Filter by installed status.","example":true},"required":false,"description":"Filter by installed status.","name":"installed","in":"query"}],"responses":{"200":{"description":"Paginated list of firmwares.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FirmwareList"}}}},"400":{"description":"The request was invalid, for example a missing or malformed field. The body says which field; fix it before retrying.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"403":{"description":"Cluster administrator permissions required. Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"The resource does not exist, or you cannot see it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiNotFoundError"}}}}},"x-badges":[{"name":"Cluster administrator"}]}},"/v3/cluster/firmware-service/firmwares/{filename}":{"delete":{"operationId":"v3DeleteFirmware","x-required-roles":["cluster-administrator"],"x-sdk-method":"firmwareService.deleteFirmware","summary":"Delete a firmware","description":"**Required role:** Cluster administrator.\n\nRemoves a firmware build from the cluster firmware catalog, so it can no longer be chosen when creating devices. Identify it by its filename from `v3ListFirmwares`. Requires a cluster administrator.\n\nThis endpoint proxies the request to the firmware service. A filename the service no longer has is a\nsuccessful no-op: both a successful upstream delete and an upstream \"not there\" answer 204, and repeated\ncalls return 204 as well. A firmware-service outage or refusal is still reported as a failure.","tags":["FirmwareService"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","description":"Firmware filename.","example":"firmware.ipsw"},"required":true,"description":"Firmware filename.","name":"filename","in":"path"}],"responses":{"204":{"description":"Firmware deleted."},"400":{"description":"The request was invalid, for example a missing or malformed field. The body says which field; fix it before retrying.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"403":{"description":"Cluster administrator permissions required. Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"The request conflicts with the current state of the resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiConflictError"}}}}},"x-badges":[{"name":"Cluster administrator"}]}},"/v3/cluster/firmware-service/firmware-assets":{"get":{"operationId":"v3ListFirmwareAssets","x-required-roles":["cluster-administrator"],"x-sdk-method":"firmwareService.listAssets","summary":"List firmware assets","description":"**Required role:** Cluster administrator.\n\nLists the firmware assets stored in the cluster: side files some firmware needs in order to boot, such as Apple decryption keys. A firmware build lists the asset URLs it needs; device creation fails if one is missing. Requires a cluster administrator. Results are paginated.","tags":["FirmwareService"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"integer","minimum":1,"maximum":10000,"default":100,"description":"Number of results to return."},"required":false,"description":"Number of results to return.","name":"limit","in":"query"},{"schema":{"type":"integer","nullable":true,"minimum":0,"default":0,"description":"Index of the first row to return."},"required":false,"description":"Index of the first row to return.","name":"offset","in":"query"},{"schema":{"type":"string","description":"Case-insensitive partial match across key fields.","example":"iPhone13"},"required":false,"description":"Case-insensitive partial match across key fields.","name":"search","in":"query"},{"schema":{"type":"string","description":"Comma-separated sort fields; prefix with \"-\" for descending order.","example":"-createdAt"},"required":false,"description":"Comma-separated sort fields; prefix with \"-\" for descending order.","name":"order","in":"query"},{"schema":{"$ref":"#/components/schemas/FirmwareAssetFilter"},"required":false,"description":"Exact-match filters (filter[url], filter[domain]).","name":"filter","in":"query"}],"responses":{"200":{"description":"Paginated list of firmware assets.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FirmwareAssetList"}}}},"400":{"description":"The request was invalid, for example a missing or malformed field. The body says which field; fix it before retrying.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"403":{"description":"Cluster administrator permissions required. Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"The resource does not exist, or you cannot see it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiNotFoundError"}}}}},"x-badges":[{"name":"Cluster administrator"}]},"post":{"operationId":"v3CreateFirmwareAssets","x-required-roles":["cluster-administrator"],"x-sdk-method":"firmwareService.createAssets","summary":"Add firmware assets","description":"**Required role:** Cluster administrator.\n\nAdds firmware assets to the cluster, so firmware that needs them can boot. Returns 201 with the firmware service's response message. Requires a cluster administrator. For a single project, `POST /v3/projects/{projectId}/firmware-assets` fetches missing assets by URL; on air-gapped deployments, upload them and use `POST /v3/images/install-firmware-assets`.","tags":["FirmwareService"],"security":[{"BearerAuth":[]}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateFirmwareAssetsBody"}}}},"responses":{"201":{"description":"Firmware assets added.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FirmwareAssetsCreatedBody"}}}},"400":{"description":"The request was invalid, for example a missing or malformed field. The body says which field; fix it before retrying.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"403":{"description":"Cluster administrator permissions required. Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"The resource does not exist, or you cannot see it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiNotFoundError"}}}}},"x-badges":[{"name":"Cluster administrator"}]}},"/v3/cluster/firmware-service/firmware-assets/{assetUrl}":{"delete":{"operationId":"v3DeleteFirmwareAsset","x-required-roles":["cluster-administrator"],"x-sdk-method":"firmwareService.deleteAsset","summary":"Delete a firmware asset","description":"**Required role:** Cluster administrator.\n\nRemoves a firmware asset from the cluster. Firmware that needs it can no longer boot until it is added again. Requires a cluster administrator.\n\nThis endpoint proxies the request to the firmware service. An asset the service no longer has is a\nsuccessful no-op: both a successful upstream delete and an upstream \"not there\" answer 204, and repeated\ncalls return 204 as well. A firmware-service outage or refusal is still reported as a failure.","tags":["FirmwareService"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","description":"Firmware asset URL, passed as the raw (un-encoded) value. Generated SDK clients percent-encode it into the request path automatically; only when composing the HTTP request path by hand (e.g. curl) does the caller percent-encode it, once, like any path segment.","example":"https://example.com/firmware-assets/asset.bin"},"required":true,"description":"Firmware asset URL, passed as the raw (un-encoded) value. Generated SDK clients percent-encode it into the request path automatically; only when composing the HTTP request path by hand (e.g. curl) does the caller percent-encode it, once, like any path segment.","name":"assetUrl","in":"path"}],"responses":{"204":{"description":"Firmware asset deleted."},"400":{"description":"The request was invalid, for example a missing or malformed field. The body says which field; fix it before retrying.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"403":{"description":"Cluster administrator permissions required. Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-badges":[{"name":"Cluster administrator"}]}},"/v3/cluster/firmware-service/firmware-assets/{assetUrl}/extended":{"get":{"operationId":"v3GetFirmwareAssetExtended","x-required-roles":["cluster-administrator"],"x-sdk-method":"firmwareService.getAssetExtended","summary":"Get extended firmware asset info","description":"**Required role:** Cluster administrator.\n\nShows where a firmware asset is used: the firmware builds that need it and the devices using those builds. Check this before deleting an asset. Requires a cluster administrator.","tags":["FirmwareService"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","description":"Firmware asset URL, passed as the raw (un-encoded) value. Generated SDK clients percent-encode it into the request path automatically; only when composing the HTTP request path by hand (e.g. curl) does the caller percent-encode it, once, like any path segment.","example":"https://example.com/firmware-assets/asset.bin"},"required":true,"description":"Firmware asset URL, passed as the raw (un-encoded) value. Generated SDK clients percent-encode it into the request path automatically; only when composing the HTTP request path by hand (e.g. curl) does the caller percent-encode it, once, like any path segment.","name":"assetUrl","in":"path"}],"responses":{"200":{"description":"Extended firmware asset info.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExtendedFirmwareAssetInfo"}}}},"400":{"description":"The request was invalid, for example a missing or malformed field. The body says which field; fix it before retrying.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"403":{"description":"Cluster administrator permissions required. Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"The resource does not exist, or you cannot see it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiNotFoundError"}}}}},"x-badges":[{"name":"Cluster administrator"}]}},"/v3/activity":{"get":{"operationId":"v3ListActivities","x-sdk-method":"activity.list","summary":"Get resource activities","description":"Returns the activity log: a record of what happened in your domain, such as devices created, started and deleted, users signing in, and settings changed, with who did it and when. You only see events your role allows. Filter by device, project, user, time range or free text, and page with `limit` and `offset`. For a full download of many records, use `v3CreateActivityExport` instead.","tags":["Activity"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"anyOf":[{"type":"string"},{"$ref":"#/components/schemas/ActivityResourceStartsWithFilter"},{"$ref":"#/components/schemas/ActivityResourceNotStartsWithFilter"}],"description":"Resource equality or LHS prefix filter. Examples: `resource=value`, `resource[startsWith]=value`, and `resource[!startsWith]=value`.","example":"instance.created"},"required":false,"description":"Resource equality or LHS prefix filter. Examples: `resource=value`, `resource[startsWith]=value`, and `resource[!startsWith]=value`.","name":"resource","in":"query"},{"schema":{"type":"integer","minimum":1,"maximum":100,"default":10,"description":"Number of entries to return.","example":10},"required":false,"description":"Number of entries to return.","name":"limit","in":"query"},{"schema":{"type":"integer","nullable":true,"minimum":0,"default":0,"description":"Number of results to skip."},"required":false,"description":"Number of results to skip.","name":"offset","in":"query"},{"schema":{"type":"string","pattern":"^-?[a-zA-Z_]+$","default":"-createdAt","description":"Field to sort by, for example `createdAt`. Prefix with `-` for newest or largest first. Defaults to `-createdAt` (newest first).","example":"-createdAt"},"required":false,"description":"Field to sort by, for example `createdAt`. Prefix with `-` for newest or largest first. Defaults to `-createdAt` (newest first).","name":"orderBy","in":"query"},{"schema":{"type":"string","description":"Only activity about this device.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"required":false,"description":"Only activity about this device.","name":"instanceId","in":"query"},{"schema":{"type":"string","description":"Only activity in this project.","example":"1c41b1bc-4f53-48a8-b690-ad30611e1960"},"required":false,"description":"Only activity in this project.","name":"projectId","in":"query"},{"schema":{"type":"string","description":"Only activity performed by this user (user ID).","example":"e8c5b7ea-aa5f-4a4a-bdca-0c67060b5320"},"required":false,"description":"Only activity performed by this user (user ID).","name":"actor","in":"query"},{"schema":{"type":"string","description":"Free-text search. Applied last, as a loose match on the results that pass the other filters.","example":"iPhone15,2"},"required":false,"description":"Free-text search. Applied last, as a loose match on the results that pass the other filters.","name":"search","in":"query"},{"schema":{"type":"string","nullable":true,"format":"date-time","description":"Only activity at or before this time (ISO 8601).","example":"2026-05-22T13:58:34.000Z"},"required":false,"description":"Only activity at or before this time (ISO 8601).","name":"to","in":"query"},{"schema":{"type":"string","nullable":true,"format":"date-time","description":"Only activity at or after this time (ISO 8601).","example":"2026-05-22T00:00:00.000Z"},"required":false,"description":"Only activity at or after this time (ISO 8601).","name":"from","in":"query"}],"responses":{"200":{"description":"List of activities.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActivityListResponse"}}}},"400":{"description":"Invalid query parameter(s) or column name.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v3/activity/export":{"post":{"operationId":"v3CreateActivityExport","x-required-roles":["domain-administrator"],"x-sdk-method":"activity.createExport","summary":"Start activity export","description":"**Required role:** Domain administrator.\n\nStarts building a file of activity records for download, for audits or offline analysis. Requires a domain administrator and the user-logging license feature (403 otherwise).\n\nChoose the file format with the `Accept` header: `application/json` or `text/csv` (any other value returns 400). The body takes the same filters as `v3ListActivities`, but the export is not paginated: it contains every matching record.\n\n**Workflow:**\n1. `v3CreateActivityExport` (this call). Returns 201 with an `id` like `activity-export/<UUID>`.\n2. Poll `v3GetActivityExportStatus` with the `<UUID>` part until `status` is `complete`.\n3. `v3DownloadActivity` with the same UUID to get the file.","tags":["Activity"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"$ref":"#/components/schemas/ActivityExportFormat"},"required":true,"description":"Specifies the activity export file format.","name":"accept","in":"header"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateActivityExportBody"}}}},"responses":{"201":{"description":"Export task accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateActivityExportResponse"}}}},"400":{"description":"Invalid request body or export rejected.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"403":{"description":"Domain administrator permissions required. Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-badges":[{"name":"Domain administrator"}]},"get":{"operationId":"v3GetActivityExportTasks","x-required-roles":["domain-administrator"],"x-sdk-method":"activity.listExportTasks","summary":"Get all export tasks for user","description":"**Required role:** Domain administrator.\n\nLists the activity exports you have started, with each one's status and the filters it used. Requires a domain administrator and the user-logging license feature. Results are paginated with `limit` and `offset`.","tags":["Activity"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"integer","minimum":1,"maximum":1000,"default":100,"description":"Most results to return in one page. Whole number from 1 to 1000; defaults to 100. A value outside that range is rejected with 400."},"required":false,"description":"Most results to return in one page. Whole number from 1 to 1000; defaults to 100. A value outside that range is rejected with 400.","name":"limit","in":"query"},{"schema":{"type":"integer","nullable":true,"minimum":0,"default":0,"description":"How many results to skip before this page starts; defaults to 0. To get the next page, add `limit` to the previous `offset`."},"required":false,"description":"How many results to skip before this page starts; defaults to 0. To get the next page, add `limit` to the previous `offset`.","name":"offset","in":"query"}],"responses":{"200":{"description":"List of export tasks.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActivityExportTaskList"}}}},"403":{"description":"Domain administrator permissions required. Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-badges":[{"name":"Domain administrator"}]}},"/v3/activity/export/{taskId}":{"get":{"operationId":"v3GetActivityExportStatus","x-required-roles":["domain-administrator"],"x-sdk-method":"activity.getExportStatus","summary":"Get export task status","description":"**Required role:** Domain administrator.\n\nReturns the status of an activity export started with `v3CreateActivityExport`. Pass the UUID part of the export `id`. Poll until `status` is `complete`, then call `v3DownloadActivity`. Finished tasks are cleaned up, so a task that no longer exists is reported as `complete`. Requires a domain administrator and the user-logging license feature.","tags":["Activity"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","example":"722cdce5-6f71-4f4a-b2b6-c00f11c015f6"},"required":true,"name":"taskId","in":"path"}],"responses":{"200":{"description":"Task status.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActivityExportStatus"}}}},"403":{"description":"Domain administrator permissions required. Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-badges":[{"name":"Domain administrator"}]}},"/v3/activity/export/{taskId}/download":{"get":{"operationId":"v3DownloadActivity","x-required-roles":["domain-administrator"],"x-sdk-method":"activity.download","summary":"Download activity for a given task","description":"**Required role:** Domain administrator.\n\nDownloads the file produced by a finished activity export, as JSON or CSV depending on the format you asked for. Pass the UUID part of the export `id`. Returns 404 if the file is not ready or does not exist; check `v3GetActivityExportStatus` first. Requires a domain administrator and the user-logging license feature.","tags":["Activity"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","example":"722cdce5-6f71-4f4a-b2b6-c00f11c015f6"},"required":true,"name":"taskId","in":"path"}],"responses":{"200":{"description":"Activity export file download.","content":{"application/json":{"schema":{"type":"string","format":"binary","description":"Raw JSON activity export file."}},"text/csv":{"schema":{"type":"string","format":"binary","description":"Raw CSV activity export file."}}}},"400":{"description":"Unable to get image export type.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"403":{"description":"Domain administrator permissions required. Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Task not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiNotFoundError"}}}}},"x-badges":[{"name":"Domain administrator"}]}},"/v3/billing/summary":{"get":{"operationId":"v3GetBillingSummary","x-required-roles":["domain-administrator"],"x-sdk-method":"billing.getSummary","summary":"Get billing summary","description":"**Required role:** Domain administrator.\n\nReturns the charges building up for your domain in the current billing period on a usage-based plan: when the period started and ends, the running total, the billing threshold, and a line item per charged activity. Returns `pendingUsageBased: null` if your domain is not on a usage-based plan. Requires a domain administrator.","tags":["Billing"],"security":[{"BearerAuth":[]}],"responses":{"200":{"description":"Billing summary.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingSummary"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Domain administrator permissions required. Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-badges":[{"name":"Domain administrator"}]}},"/v3/billing/subscription":{"get":{"operationId":"v3GetSubscription","x-sdk-method":"billing.getSubscription","summary":"Get the current subscription","description":"Returns your domain's current subscription: which plan you are on and its status. Use it to check what your account includes or whether a cancellation is scheduled.","tags":["Billing"],"security":[{"BearerAuth":[]}],"responses":{"200":{"description":"Subscription detail.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Subscription"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v3/billing/subscription/metered/usage":{"get":{"operationId":"v3GetMeteredSubscriptionUsage","x-required-roles":["domain-administrator"],"x-sdk-method":"billing.getMeteredUsage","summary":"Get metered subscription usage","description":"**Required role:** Domain administrator.\n\nFor domains on a metered plan, returns how much has been used in the current billing period: units (hours) included in the plan, units used beyond it, the rate for extra use, and the amounts billed and still outstanding. Amounts are in cents. Requires a domain administrator.","tags":["Billing"],"security":[{"BearerAuth":[]}],"responses":{"200":{"description":"Metered subscription usage.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MeteredSubscriptionUsage"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Domain administrator permissions required. Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-badges":[{"name":"Domain administrator"}]}},"/v3/billing/usage":{"get":{"operationId":"v3GetDeviceUsage","x-sdk-method":"billing.getDeviceUsage","summary":"Get device usage","description":"Returns how much your domain's devices have been used in the current billing period.","tags":["Billing"],"security":[{"BearerAuth":[]}],"responses":{"200":{"description":"Device usage.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceUsage"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v3/billing/cancel":{"post":{"operationId":"v3CancelSubscription","x-required-roles":["domain-administrator"],"x-sdk-method":"billing.cancel","summary":"Cancel a subscription","description":"**Required role:** Domain administrator.\n\nCancels your domain's subscription. Requires an administrator. By default it acts on your own domain; only a cloud administrator may pass another `domainId`. Set `deleteDomain: true` to also delete the domain and everything in it, which cannot be undone. A cancellation that has not taken effect yet can be reversed with `v3UncancelSubscription`.","tags":["Billing"],"security":[{"BearerAuth":[]}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancelSubscriptionBody"}}}},"responses":{"204":{"description":"Subscription canceled."},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Domain administrator permissions required. Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-badges":[{"name":"Domain administrator"}]}},"/v3/billing/uncancel":{"post":{"operationId":"v3UncancelSubscription","x-required-roles":["domain-administrator"],"x-sdk-method":"billing.uncancel","summary":"Uncancel a subscription","description":"**Required role:** Domain administrator.\n\nReverses a scheduled cancellation, so the subscription continues as before: the pending cancellation is cleared and the scheduled shut-off is removed. Requires an administrator; acts on your own domain unless a cloud administrator passes another `domainId`.","tags":["Billing"],"security":[{"BearerAuth":[]}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UncancelSubscriptionBody"}}}},"responses":{"204":{"description":"Subscription reactivated."},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Domain administrator permissions required. Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-badges":[{"name":"Domain administrator"}]}},"/v3/billing/trials/subscribe":{"post":{"operationId":"v3SubscribeToTrial","x-sdk-method":"billing.subscribeToTrial","summary":"Subscribe to a trial","description":"Creates a new trial domain for someone who has a trial invitation. Needs no sign-in: the invitation details in the body identify the person. Used by the trial sign-up page.","tags":["Billing"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscribeToTrialBody"}}}},"responses":{"200":{"description":"Trial subscription result.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscribeToTrialResponse"}}}},"400":{"description":"The request was invalid, for example a missing or malformed field. The body says which field; fix it before retrying.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}}}}},"/v3/domain/image-upload/{type}/{imageId}/{name}":{"put":{"operationId":"v3PutDomainImageUpload","x-required-roles":["domain-administrator","cloud-administrator"],"x-sdk-method":"domain.putImageUpload","summary":"Upload image chunk","description":"**Required role:** Domain administrator on on-site deployments; cloud administrator on cloud deployments.\n\nUploads one chunk of a file as a domain-level image: one that belongs to no project or instance and is available across your domain. Requires a domain administrator (on-site) or cloud administrator. Works like `v3PutProjectImageUpload`: you choose the image ID (a new random UUID), the record is created on the first chunk, and `type` and `name` in the path set the image type and name. A domain-level `fw` image is offered as a choice when anyone in the domain creates a device of the matching model, without an install step. The result is the same as `POST /v3/images` with no `projectId` or `instanceId` followed by `PUT /v3/images/{imageId}/file`, which applies the same administrator rule to chunk uploads.","tags":["Domain"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","enum":["iotfirmware","kernel","devicetree","ramdisk","loaderfile","media","sepfw","seprom","bootrom","llb","iboot","ibootdata","fw","fwasset","partition","extension","vmfile","backup","activity-export","ufd","mast-wordlist","mast-report","mast-frida","pongo","clbi"],"description":"What kind of file this is, for example `fw` for firmware or `kernel`. Uses the same values as `type` on `POST /v3/images`; see `ImageType` for what each means. Types that need a license feature your license lacks are rejected with 403."},"required":true,"description":"What kind of file this is, for example `fw` for firmware or `kernel`. Uses the same values as `type` on `POST /v3/images`; see `ImageType` for what each means. Types that need a license feature your license lacks are rejected with 403.","name":"type","in":"path"},{"schema":{"type":"string","format":"uuid","description":"An ID you choose for the new image: generate a random UUID once per file and use the same value for every chunk of that file. The image record is created with this ID when the first chunk arrives. Use a new UUID for each new upload."},"required":true,"description":"An ID you choose for the new image: generate a random UUID once per file and use the same value for every chunk of that file. The image record is created with this ID when the first chunk arrives. Use a new UUID for each new upload.","name":"imageId","in":"path"},{"schema":{"type":"string","description":"The file name to store, URL-encoded (for example `my%20firmware.ipsw`). Becomes the image `name`."},"required":true,"description":"The file name to store, URL-encoded (for example `my%20firmware.ipsw`). Becomes the image `name`.","name":"name","in":"path"},{"schema":{"type":"integer","nullable":true,"description":"Which chunk this is, counting from 1."},"required":false,"description":"Which chunk this is, counting from 1.","name":"resumableChunkNumber","in":"query"},{"schema":{"type":"integer","nullable":true,"description":"The size, in bytes, you split the file into. Use the same value for every chunk; only the last chunk may be smaller. If you send `corelliumChecksum`, this must equal the block size inside it."},"required":false,"description":"The size, in bytes, you split the file into. Use the same value for every chunk; only the last chunk may be smaller. If you send `corelliumChecksum`, this must equal the block size inside it.","name":"resumableChunkSize","in":"query"},{"schema":{"type":"integer","nullable":true,"description":"Actual size in bytes of this chunk's body."},"required":false,"description":"Actual size in bytes of this chunk's body.","name":"resumableCurrentChunkSize","in":"query"},{"schema":{"type":"integer","nullable":true,"description":"Size of the whole file in bytes."},"required":false,"description":"Size of the whole file in bytes.","name":"resumableTotalSize","in":"query"},{"schema":{"type":"integer","nullable":true,"description":"How many chunks the whole file is split into. The upload completes when the last one arrives."},"required":false,"description":"How many chunks the whole file is split into. The upload completes when the last one arrives.","name":"resumableTotalChunks","in":"query"},{"schema":{"type":"string","description":"Optional expected checksum of the whole file, formatted `algorithm$blockSize$hash`. When given, the finished upload is checked and rejected (and the image removed) if it does not match. Required for firmware (`fw`) uploads on air-gapped deployments."},"required":false,"description":"Optional expected checksum of the whole file, formatted `algorithm$blockSize$hash`. When given, the finished upload is checked and rejected (and the image removed) if it does not match. Required for firmware (`fw`) uploads on air-gapped deployments.","name":"corelliumChecksum","in":"query"},{"schema":{"type":"string","description":"Device model (`flavor` from `GET /v3/models`) the image is for. Needed for `partition` uploads when the image is not attached to a device, so the partition name can be checked against that model."},"required":false,"description":"Device model (`flavor` from `GET /v3/models`) the image is for. Needed for `partition` uploads when the image is not attached to a device, so the partition name can be checked against that model.","name":"flavor","in":"query"},{"schema":{"type":"string","enum":["plain","encrypted"],"description":"How the file is stored: `plain` (normal) or `encrypted`. Only read on the first chunk, when the image record is created; later chunks cannot change it."},"required":false,"description":"How the file is stored: `plain` (normal) or `encrypted`. Only read on the first chunk, when the image record is created; later chunks cannot change it.","name":"x-corellium-image-encoding","in":"header"},{"schema":{"type":"boolean","description":"Whether the uploaded file is a ZIP wrapper the platform should unpack. Send false to store the file exactly as uploaded. Only read on the first chunk, when the image record is created."},"required":false,"description":"Whether the uploaded file is a ZIP wrapper the platform should unpack. Send false to store the file exactly as uploaded. Only read on the first chunk, when the image record is created.","name":"x-corellium-image-encapsulated","in":"header"},{"schema":{"type":"integer","nullable":true,"description":"Size of the whole file in bytes. Send it on every chunk: the platform uses it to check up front that there is room for the entire file, and answers 507 if there is not, before storing any data."},"required":false,"description":"Size of the whole file in bytes. Send it on every chunk: the platform uses it to check up front that there is room for the entire file, and answers 507 if there is not, before storing any data.","name":"x-corellium-total-file-size","in":"header"},{"schema":{"type":"string","description":"Password of a password-protected file (for example encrypted firmware), used to check the file after upload. Leave out for normal files."},"required":false,"description":"Password of a password-protected file (for example encrypted firmware), used to check the file after upload. Leave out for normal files.","name":"x-corellium-image-password","in":"header"}],"requestBody":{"required":true,"content":{"application/octet-stream":{"schema":{"type":"string","format":"binary","description":"Raw bytes of this chunk, or of the whole file when unchunked."}}}},"responses":{"200":{"description":"Chunk stored. The body is an empty JSON object. Send the next chunk; the image is finished when the last chunk arrives.","content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":{"nullable":true}}}}},"400":{"description":"Invalid chunk or upload parameters, unreadable body, or a missing/mismatched corelliumChecksum for a firmware upload.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Domain administrator permissions required on on-site deployments; cloud administrator permissions required on cloud deployments. Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"No image with the given identifier.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiNotFoundError"}}}},"507":{"description":"The image pool does not have enough space for this upload.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InsufficientStorageError"}}}}},"x-badges":[{"name":"Deployment administrator"}]},"get":{"operationId":"v3GetDomainImageUpload","x-required-roles":["domain-administrator","cloud-administrator"],"x-sdk-method":"domain.getImageUpload","summary":"Get image upload status","description":"**Required role:** Domain administrator on on-site deployments; cloud administrator on cloud deployments.\n\nChecks the progress of a chunked upload made with `v3PutDomainImageUpload`, or downloads the finished file. With chunk parameters (`resumableChunkNumber` and friends) it returns 200 if that chunk is already stored and 204 if it still needs to be sent; without them it downloads the image file.","tags":["Domain"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","enum":["iotfirmware","kernel","devicetree","ramdisk","loaderfile","media","sepfw","seprom","bootrom","llb","iboot","ibootdata","fw","fwasset","partition","extension","vmfile","backup","activity-export","ufd","mast-wordlist","mast-report","mast-frida","pongo","clbi"],"description":"What kind of file this is, for example `fw` for firmware or `kernel`. Uses the same values as `type` on `POST /v3/images`; see `ImageType` for what each means. Types that need a license feature your license lacks are rejected with 403."},"required":true,"description":"What kind of file this is, for example `fw` for firmware or `kernel`. Uses the same values as `type` on `POST /v3/images`; see `ImageType` for what each means. Types that need a license feature your license lacks are rejected with 403.","name":"type","in":"path"},{"schema":{"type":"string","format":"uuid","description":"An ID you choose for the new image: generate a random UUID once per file and use the same value for every chunk of that file. The image record is created with this ID when the first chunk arrives. Use a new UUID for each new upload."},"required":true,"description":"An ID you choose for the new image: generate a random UUID once per file and use the same value for every chunk of that file. The image record is created with this ID when the first chunk arrives. Use a new UUID for each new upload.","name":"imageId","in":"path"},{"schema":{"type":"string","description":"The file name to store, URL-encoded (for example `my%20firmware.ipsw`). Becomes the image `name`."},"required":true,"description":"The file name to store, URL-encoded (for example `my%20firmware.ipsw`). Becomes the image `name`.","name":"name","in":"path"},{"schema":{"type":"integer","description":"Chunk number. When present the response reports whether that chunk was already stored (200) or still needs to be uploaded (204) instead of returning the image file."},"required":false,"description":"Chunk number. When present the response reports whether that chunk was already stored (200) or still needs to be uploaded (204) instead of returning the image file.","name":"resumableChunkNumber","in":"query"}],"responses":{"200":{"description":"An empty JSON object when a probed chunk is already stored, the image bytes when the file is stored locally, or the image metadata when no file has been stored yet.","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary","description":"Image file contents."}},"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":{"nullable":true}}}}},"204":{"description":"The probed chunk is not stored yet and still needs to be uploaded."},"302":{"description":"The image is stored in S3; follow the Location header to download it.","headers":{"Location":{"schema":{"type":"string","format":"uri","description":"URL the client is redirected to.","example":"https://storage.example.com/images/3e1354a3-fb10-46c0-8b05-56e28edbde69/file?X-Amz-Expires=900&X-Amz-Signature=<signature>"},"required":true,"description":"URL the client is redirected to."}}},"400":{"description":"The image identifier is invalid or the image record is missing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Domain administrator permissions required on on-site deployments; cloud administrator permissions required on cloud deployments. Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"No image with the given identifier.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiNotFoundError"}}}}},"x-badges":[{"name":"Deployment administrator"}]}},"/v3/domain/software":{"get":{"operationId":"v3ListDomainSoftware","x-required-roles":["domain-administrator"],"x-sdk-method":"domain.listSoftware","summary":"List domain-level firmware images","description":"**Required role:** Domain administrator.\n\nLists the firmware images uploaded at domain level (not in a project or instance), one entry per device model. Requires a domain administrator. Use it to find the `imageId` of a domain firmware upload, for example to delete it with `DELETE /v3/images/{imageId}`. These images also appear in `GET /v3/models/{model}/software` for the matching model.","tags":["Domain"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"integer","minimum":1,"maximum":1000,"default":100,"description":"Most results to return in one page. Whole number from 1 to 1000; defaults to 100. A value outside that range is rejected with 400."},"required":false,"description":"Most results to return in one page. Whole number from 1 to 1000; defaults to 100. A value outside that range is rejected with 400.","name":"limit","in":"query"},{"schema":{"type":"integer","nullable":true,"minimum":0,"default":0,"description":"How many results to skip before this page starts; defaults to 0. To get the next page, add `limit` to the previous `offset`."},"required":false,"description":"How many results to skip before this page starts; defaults to 0. To get the next page, add `limit` to the previous `offset`.","name":"offset","in":"query"}],"responses":{"200":{"description":"Paginated list of domain firmware uploads.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DomainSoftwareList"}}}},"400":{"description":"Invalid limit or offset.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Domain administrator permissions required. Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-badges":[{"name":"Domain administrator"}]}},"/v3/domain/{domainId}/auth":{"post":{"operationId":"v3CreateDomainAuthProvider","x-required-roles":["domain-administrator"],"x-sdk-method":"domain.authProviders.create","summary":"Create a new auth provider for a domain","description":"**Required role:** Domain administrator.\n\nCreate a new auth provider for a domain.","tags":["Domain Auth Providers"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Domain identifier.","example":"c29762d1-45d7-489d-a3a2-9dadc43978ba"},"required":true,"description":"Domain identifier.","name":"domainId","in":"path"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDomainAuthProviderBody"}}}},"responses":{"200":{"description":"Auth provider created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDomainAuthProviderResponse"}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"403":{"description":"Domain administrator permissions required. Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-badges":[{"name":"Domain administrator"}]},"get":{"operationId":"v3ListDomainAuthProviders","x-required-roles":["domain-administrator"],"x-sdk-method":"domain.authProviders.list","summary":"Return all configured auth providers for a domain (including globally configured providers)","description":"**Required role:** Domain administrator.\n\nReturn all configured auth providers for a domain (including globally configured providers).","tags":["Domain Auth Providers"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Domain identifier.","example":"c29762d1-45d7-489d-a3a2-9dadc43978ba"},"required":true,"description":"Domain identifier.","name":"domainId","in":"path"},{"schema":{"type":"integer","minimum":1,"maximum":1000,"default":100,"description":"Most results to return in one page. Whole number from 1 to 1000; defaults to 100. A value outside that range is rejected with 400."},"required":false,"description":"Most results to return in one page. Whole number from 1 to 1000; defaults to 100. A value outside that range is rejected with 400.","name":"limit","in":"query"},{"schema":{"type":"integer","nullable":true,"minimum":0,"default":0,"description":"How many results to skip before this page starts; defaults to 0. To get the next page, add `limit` to the previous `offset`."},"required":false,"description":"How many results to skip before this page starts; defaults to 0. To get the next page, add `limit` to the previous `offset`.","name":"offset","in":"query"}],"responses":{"200":{"description":"List of auth providers.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DomainAuthProvidersList"}}}},"403":{"description":"Domain administrator permissions required. Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-badges":[{"name":"Domain administrator"}]}},"/v3/domain/{domainId}/auth/{providerId}":{"put":{"operationId":"v3UpdateDomainAuthProvider","x-required-roles":["domain-administrator"],"x-sdk-method":"domain.authProviders.update","summary":"Update an auth provider for a domain","description":"**Required role:** Domain administrator.\n\nUpdate an auth provider for a domain.","tags":["Domain Auth Providers"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Domain identifier.","example":"c29762d1-45d7-489d-a3a2-9dadc43978ba"},"required":true,"description":"Domain identifier.","name":"domainId","in":"path"},{"schema":{"type":"string","description":"Provider identifier.","example":"sso.example.com"},"required":true,"description":"Provider identifier.","name":"providerId","in":"path"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDomainAuthProviderBody"}}}},"responses":{"200":{"description":"Updated auth provider.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DomainAuthProviderResponse"}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"403":{"description":"Domain administrator permissions required. Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-badges":[{"name":"Domain administrator"}]},"patch":{"operationId":"v3PatchDomainAuthProvider","x-required-roles":["domain-administrator"],"x-sdk-method":"domain.authProviders.patch","summary":"Partially update an auth provider for a domain","description":"**Required role:** Domain administrator.\n\nPartially update an auth provider for a domain.","tags":["Domain Auth Providers"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Domain identifier.","example":"c29762d1-45d7-489d-a3a2-9dadc43978ba"},"required":true,"description":"Domain identifier.","name":"domainId","in":"path"},{"schema":{"type":"string","description":"Provider identifier.","example":"sso.example.com"},"required":true,"description":"Provider identifier.","name":"providerId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchDomainAuthProviderBody"}}}},"responses":{"200":{"description":"Updated auth provider.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DomainAuthProviderResponse"}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"403":{"description":"Domain administrator permissions required. Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-badges":[{"name":"Domain administrator"}]},"delete":{"operationId":"v3DeleteDomainAuthProvider","x-required-roles":["domain-administrator"],"x-sdk-method":"domain.authProviders.delete","summary":"Delete an auth provider from a domain","description":"**Required role:** Domain administrator.\n\nDelete an auth provider from a domain.\n\nDeletes are idempotent: a `providerId` that is not attached to the domain, or an unknown `domainId`, is a successful no-op that still returns 204, and\nrepeated calls return 204 as well. A 404 means the request path did not match a delete route, not\nthat the target was missing.\nThe underlying provider record is only removed when no other domain still references it, and default\nproviders are never removed.","tags":["Domain Auth Providers"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Domain identifier.","example":"c29762d1-45d7-489d-a3a2-9dadc43978ba"},"required":true,"description":"Domain identifier.","name":"domainId","in":"path"},{"schema":{"type":"string","description":"Provider identifier.","example":"sso.example.com"},"required":true,"description":"Provider identifier.","name":"providerId","in":"path"}],"responses":{"204":{"description":"Successfully deleted auth provider."},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Domain administrator permissions required. Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-badges":[{"name":"Domain administrator"}]}},"/v3/domain/welcome":{"post":{"operationId":"v3CreateDomainWelcomeMessage","x-required-roles":["domain-administrator"],"x-sdk-method":"domain.createWelcomeMessage","summary":"Create a welcome message for a domain","description":"**Required role:** Domain administrator.\n\nCreates a new welcome message for the authenticated user's domain admin, or updates the existing one. The message is sanitized to prevent XSS.","tags":["Domain"],"security":[{"BearerAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetDomainWelcomeMessageBody"}}}},"responses":{"200":{"description":"Welcome message created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DomainWelcomeMessageResponse"}}}},"400":{"description":"Validation error (e.g. empty message).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Domain administrator permissions required. Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-badges":[{"name":"Domain administrator"}]},"patch":{"operationId":"v3PatchDomainWelcomeMessage","x-required-roles":["domain-administrator"],"x-sdk-method":"domain.patchWelcomeMessage","summary":"Update a welcome message for a domain","description":"**Required role:** Domain administrator.\n\nUpdates a new welcome message for the authenticated user's domain admin, or updates the existing one. The message is sanitized to prevent XSS.","tags":["Domain"],"security":[{"BearerAuth":[]}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchDomainWelcomeMessageBody"}}}},"responses":{"200":{"description":"Updated welcome message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DomainWelcomeMessageResponse"}}}},"400":{"description":"Validation error (e.g. empty message or no fields provided).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Domain administrator permissions required. Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"No welcome message exists for this domain.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiNotFoundError"}}}}},"x-badges":[{"name":"Domain administrator"}]},"get":{"operationId":"v3GetDomainWelcomeMessage","x-sdk-method":"domain.getWelcomeMessage","summary":"Get the welcome message for the authenticated user's domain","description":"Retrieves the welcome message for the domain.","tags":["Domain"],"security":[{"BearerAuth":[]}],"responses":{"200":{"description":"Domain welcome message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DomainWelcomeMessageResponse"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"No welcome message exists for this domain.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiNotFoundError"}}}}}},"delete":{"operationId":"v3DeleteDomainWelcomeMessage","x-required-roles":["domain-administrator"],"x-sdk-method":"domain.deleteWelcomeMessage","summary":"Delete the welcome message for the authenticated user's domain","description":"**Required role:** Domain administrator.\n\nDelete the welcome message for the authenticated user's domain.\n\nDeletes are idempotent: a domain with no welcome message is a successful no-op that still returns 204, and\nrepeated calls return 204 as well. A 404 means the request path did not match a delete route, not\nthat the target was missing.","tags":["Domain"],"security":[{"BearerAuth":[]}],"responses":{"204":{"description":"Welcome message deleted."},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Domain administrator permissions required. Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-badges":[{"name":"Domain administrator"}]}},"/v3/images/{imageId}":{"get":{"operationId":"v3GetImage","x-sdk-method":"images.get","summary":"Get image metadata","description":"Returns metadata for a single image. File contents are not returned by this endpoint.","tags":["Images"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","example":"3e1354a3-fb10-46c0-8b05-56e28edbde69"},"required":true,"name":"imageId","in":"path"}],"responses":{"200":{"description":"Image metadata.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Image"}}}},"404":{"description":"No image with the given imageId.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiNotFoundError"}}}}}},"delete":{"operationId":"v3DeleteImage","x-sdk-method":"images.delete","summary":"Delete an image","description":"Permanently deletes the image. This action cannot be undone.\n\nDeletion is synchronous. Deletes are idempotent: an unknown `imageId`, or an image that has already been deleted, is a successful no-op that still returns 204, and\nrepeated calls return 204 as well. A 404 means the request path did not match a delete route, not\nthat the target was missing.","tags":["Images"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","example":"3e1354a3-fb10-46c0-8b05-56e28edbde69"},"required":true,"name":"imageId","in":"path"}],"responses":{"204":{"description":"Image deleted; empty body."},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}},"post":{"operationId":"v3UploadImageData","x-sdk-method":"images.uploadData","summary":"Upload image file contents","description":"Uploads the whole file for an image created with [`createImage`](#tag/images/POST/v3/images), in a single `multipart/form-data` request with the file in the `file` part. Returns the updated image, whose `size` and checksums are now filled in.\n\nSupply `corelliumChecksum` to have the server verify the file: if the uploaded contents do not match, the upload is rejected with 400 and the image is removed. Compute it with the same algorithm and block size you pass in the value (`algorithm$blockSize$hash`).\n\nThe upload counts against the owning project's storage quota. If the connection drops, the whole file must be sent again. For large images (firmware in particular) use [`uploadImageChunk`](#tag/images/PUT/v3/images/{imageId}/file), which can resume.","tags":["Images"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","example":"3e1354a3-fb10-46c0-8b05-56e28edbde69"},"required":true,"name":"imageId","in":"path"},{"schema":{"type":"string","description":"Optional. Expected Corellium checksum of the whole file, formatted `algorithm$blockSize$hash` (for example `sha256$1048576$<hex>`). When supplied, the upload is rejected and the image removed if the file does not match.","example":"sha256$1048576$e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"},"required":false,"description":"Optional. Expected Corellium checksum of the whole file, formatted `algorithm$blockSize$hash` (for example `sha256$1048576$<hex>`). When supplied, the upload is rejected and the image removed if the file does not match.","name":"corelliumChecksum","in":"query"}],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary"}},"required":["file"]}}}},"responses":{"200":{"description":"Upload accepted; updated image metadata returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Image"}}}},"400":{"description":"Invalid upload or checksum mismatch.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"No image with the given imageId.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiNotFoundError"}}}},"409":{"description":"An image with conflicting identity already exists.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiConflictError"}}}}}}},"/v3/images/{imageId}/fwinfo":{"post":{"operationId":"v3GetImageFirmwareInfo","x-sdk-method":"images.getFirmwareInfo","summary":"Get firmware info embedded in an image","description":"Reads the version information built into an uploaded firmware file, without installing it or creating a device. Use it to check what a file is before you install it or create a device from it: which operating-system version and build it contains, and which device models it supports.\n\nWorks on these kinds of uploaded files: an Apple iOS firmware file (IPSW), a Corellium firmware package (`.coreimg`), a Cellebrite firmware image, a Cellebrite extraction (UFD), and a Corellium extension. The image must be fully uploaded first; see [`createImage`](#tag/images/POST/v3/images).\n\nThe request body is optional:\n  - `password`: needed only if the file is encrypted. A wrong password returns 400.\n  - `extended`: set to `true` to also get chip and board details and the supported device model this firmware matches (`device`). Use the matched model's `flavor` when you create an instance.\n\nReturns 404 if the image does not exist, or if the file contains no version information that can be read (for example, it is not firmware).","tags":["Images"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","example":"3e1354a3-fb10-46c0-8b05-56e28edbde69"},"required":true,"name":"imageId","in":"path"}],"requestBody":{"required":false,"description":"Optional decryption password and extended-info flag.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetFirmwareInfoBody"}}}},"responses":{"200":{"description":"Firmware info parsed from the image.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImageFirmwareInfo"}}}},"400":{"description":"Invalid request body, or the supplied password is wrong.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"No permission for the image's project.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"No image with the given imageId, no firmware info file inside it, or the info was unparseable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiNotFoundError"}}}},"409":{"description":"The image backing file is not currently accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiConflictError"}}}}}}},"/v3/images/install-firmware":{"post":{"operationId":"v3InstallFirmware","x-sdk-method":"images.installFirmware","summary":"Install firmware cluster-wide","description":"Makes an uploaded `fw` image available for creating devices across the whole cluster. After it is installed, the firmware appears in `GET /v3/models/{model}/software` for the matching model and can be chosen when creating an instance.\n\n**Workflow:**\n  1. [`createImage`](#tag/images/POST/v3/images) with `{ \"name\": \"...\", \"type\": \"fw\", \"encoding\": \"plain\" }` as JSON. Keep the returned `id`.\n  2. Upload the file with [`uploadImageData`](#tag/images/POST/v3/images/{imageId}) or, for large files, [`uploadImageChunk`](#tag/images/PUT/v3/images/{imageId}/file). Supplying `corelliumChecksum` there lets the server verify the file.\n  3. **`installFirmware`** with `{ \"imageId\": \"<id>\" }`. Returns a `taskId`.\n  4. Poll [`getInstallFirmwareStatus`](#tag/images/GET/v3/images/install-firmware/{taskId}) with the `taskId` until `status` is `complete` or `error`.\n\n**What happens.** The server hands the file to the firmware service and returns 201 with a `taskId` as soon as the hand-off succeeds; installation continues in the background and can take a long time (up to 45 minutes for files around 10 GB). The source image is deleted from `/v3/images` at the moment of hand-off, before installation finishes. If installation then fails, upload the file again to retry.\n\nA 400 can mean the firmware service rejected the image's checksum. Check that the file uploaded completely and, if you supplied `corelliumChecksum`, that it was correct.","tags":["Images"],"security":[{"BearerAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstallFirmwareBody"}}}},"responses":{"201":{"description":"Install task accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstallFirmwareResponse"}}}},"400":{"description":"Invalid request body, or firmware checksum rejected.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"No firmware-type Image with the given imageId.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiNotFoundError"}}}}}}},"/v3/images/install-firmware-assets":{"post":{"operationId":"v3InstallFirmwareAssets","x-sdk-method":"images.installFirmwareAssets","summary":"Install firmware assets cluster-wide","description":"Installs an uploaded firmware-assets JSON blob for cluster-wide use. On success\nthe source Image is deleted from the Images store. The blob is forwarded to the firmware\nservice, which merges it into the cluster-wide firmware-assets manifest.\n \n**This is step 3 of the firmware-assets-install workflow:**\n  1. [`createImage`](#tag/images/POST/v3/images) with `{ name: 'fcs-keys.json', type: 'fwasset' }` → returns an `imageId`.\n  2. [`uploadImageData`](#tag/images/POST/v3/images/{imageId}) with the assets file → uploads contents.\n  3. **`installFirmwareAssets`** with `{ imageId }` → installs the assets.\n \nUnlike [`installFirmware`](#tag/images/POST/v3/images/install-firmware), this endpoint completes synchronously\nand returns the firmware service's response message directly; there is no task to poll.","tags":["Images"],"security":[{"BearerAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstallFirmwareAssetsBody"}}}},"responses":{"200":{"description":"Assets installed (or no-op if assets already present).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstallFirmwareAssetsResponse"}}}},"400":{"description":"Invalid request body, or image contents are not valid JSON.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"No fwasset-type Image with the given imageId, or image is on a remote coordinator.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiNotFoundError"}}}}}}},"/v3/images/install-firmware/{taskId}":{"get":{"operationId":"v3GetInstallFirmwareStatus","x-sdk-method":"images.getInstallFirmwareStatus","summary":"Get install-firmware task status","description":"Returns the current status of a firmware installation task previously created via\n[`installFirmware`](#tag/images/POST/v3/images/install-firmware). Clients should poll this endpoint until\n`status` is `complete` or `error`.","tags":["Images"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","example":"722cdce5-6f71-4f4a-b2b6-c00f11c015f6"},"required":true,"name":"taskId","in":"path"}],"responses":{"200":{"description":"Task status.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstallFirmwareStatusResponse"}}}},"400":{"description":"The request was invalid, for example a missing or malformed field. The body says which field; fix it before retrying.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"No install-firmware task with the given taskId.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiNotFoundError"}}}}}}},"/v3/images":{"get":{"operationId":"v3ListImages","x-sdk-method":"images.list","summary":"List image metadata","description":"Lists the images you can see: images in your projects plus domain-level images. File contents are not included; use the download or upload endpoints for those.\n\nSet `projectId` to list only one project's images. Results are paginated with `limit` and `offset`.\n\nInstalled firmware is not listed here: once `installFirmware` hands an image off, it disappears from this list and shows up in `GET /v3/models/{model}/software` instead.","tags":["Images"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"integer","minimum":1,"maximum":1000,"default":100,"description":"Most results to return in one page. Whole number from 1 to 1000; defaults to 100. A value outside that range is rejected with 400."},"required":false,"description":"Most results to return in one page. Whole number from 1 to 1000; defaults to 100. A value outside that range is rejected with 400.","name":"limit","in":"query"},{"schema":{"type":"integer","nullable":true,"minimum":0,"default":0,"description":"How many results to skip before this page starts; defaults to 0. To get the next page, add `limit` to the previous `offset`."},"required":false,"description":"How many results to skip before this page starts; defaults to 0. To get the next page, add `limit` to the previous `offset`.","name":"offset","in":"query"},{"schema":{"type":"string","format":"uuid","description":"Filter results to a single project.","example":"1c41b1bc-4f53-48a8-b690-ad30611e1960"},"required":false,"description":"Filter results to a single project.","name":"projectId","in":"query"}],"responses":{"200":{"description":"Paginated list of image metadata.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImageList"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}},"post":{"operationId":"v3CreateImage","x-sdk-method":"images.create","summary":"Create an image","description":"Creates an image: a stored file such as firmware, a kernel, a partition, or a MATRIX wordlist. Every upload starts here. The response is the new image, including its `id`.\n\n**Choosing how to upload the file:**\n  - **Two steps (recommended).** Send this request as `application/json` without a file; it returns **201**. Then upload the contents with [`uploadImageData`](#tag/images/POST/v3/images/{imageId}) (one request) or [`uploadImageChunk`](#tag/images/PUT/v3/images/{imageId}/file) (in pieces, resumable, best for large files). This is the only way to have the server verify the file against a `corelliumChecksum`.\n  - **One step.** Send this request as `multipart/form-data` with the file in a `file` part; it returns **200** once the file is stored. Put the `type` field before the `file` part. Convenient for small files, but no checksum verification.\n\nThe response body is the same image in both cases; the status code (201 or 200) tells you whether the file was included.\n\n**Where the image lives** depends on the optional IDs:\n  - `instanceId` set: attached to that device. Replaces the device's existing image of the same type.\n  - `projectId` set: stored in that project and counted against its quota.\n  - Neither: a domain-level image. Domain-level `fw` and `clbi` images are also offered when you create a device, in addition to installed firmware.\nSee the `projectId` and `instanceId` fields for side effects.\n\nOther upload endpoints (`PUT /v3/projects/{projectId}/image-upload/...`, `PUT /v3/instances/{instanceId}/image-upload/...`, `PUT /v3/domain/image-upload/...`) use the same chunked protocol but create the image on the first chunk instead of requiring this call. They exist mainly for the web interface; new code should use this endpoint followed by [`uploadImageChunk`](#tag/images/PUT/v3/images/{imageId}/file).\n\n`name` is not unique; sending the same request twice creates two images. For firmware, continue with [`installFirmware`](#tag/images/POST/v3/images/install-firmware) or [`installFirmwareAssets`](#tag/images/POST/v3/images/install-firmware-assets).","tags":["Images"],"security":[{"BearerAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateImageBody"}}}},"responses":{"200":{"description":"Image created with file uploaded (multipart).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Image"}}}},"201":{"description":"Image metadata created (JSON only); upload separately.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Image"}}}},"400":{"description":"Missing or invalid image fields.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"The instance named by `instanceId` does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiNotFoundError"}}}}}}},"/v3/images/{imageId}/file":{"put":{"operationId":"v3UploadImageChunk","x-sdk-method":"images.uploadChunk","summary":"Upload one chunk of an image file","description":"Uploads a single chunk of an Image previously created via\n[`createImage`](#tag/images/POST/v3/images), using the resumable upload protocol. This is the\nrecommended way to upload large images: the transfer survives interruptions, because any\nchunk can be re-sent and already-stored chunks can be skipped.\n \n**Chunked upload workflow:**\n  1. [`createImage`](#tag/images/POST/v3/images) with `{ name, type, encoding }` → returns an `imageId`.\n  2. Split the file into fixed-size chunks and **`uploadImageChunk`** each one with the\n     `resumable*` query parameters describing it. Chunks may be uploaded in any order and\n     concurrently.\n  3. Optionally probe a chunk with [`getImageChunk`](#tag/images/GET/v3/images/{imageId}/file) before\n     (re-)sending it, so an interrupted upload only re-sends what is missing.\n \nThe image is finalized automatically by the request that completes the chunk set, so the\nlast chunk to arrive also validates `corelliumChecksum` (when supplied) and runs the\nfirmware post-processing. Re-sending a chunk that was already stored is safe. If the upload\nfails for any reason other than a retryable transport error, the partially uploaded image is\ndeleted, so the client must create a new image record before retrying.\n \nThe image's `encoding` and `encapsulated` settings are fixed when the record is created by\n[`createImage`](#tag/images/POST/v3/images) and cannot be changed by a chunk request.","tags":["Images"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","example":"3e1354a3-fb10-46c0-8b05-56e28edbde69"},"required":true,"name":"imageId","in":"path"},{"schema":{"type":"integer","minimum":0,"exclusiveMinimum":true,"description":"Chunk sequence number.","example":1},"required":true,"description":"Chunk sequence number.","name":"resumableChunkNumber","in":"query"},{"schema":{"type":"integer","minimum":0,"exclusiveMinimum":true,"description":"Size of each chunk.","example":1048576},"required":true,"description":"Size of each chunk.","name":"resumableChunkSize","in":"query"},{"schema":{"type":"integer","minimum":0,"exclusiveMinimum":true,"description":"Size of the current chunk.","example":1048576},"required":true,"description":"Size of the current chunk.","name":"resumableCurrentChunkSize","in":"query"},{"schema":{"type":"integer","minimum":0,"exclusiveMinimum":true,"description":"Total file size.","example":2147483648},"required":true,"description":"Total file size.","name":"resumableTotalSize","in":"query"},{"schema":{"type":"integer","minimum":0,"exclusiveMinimum":true,"description":"Total number of chunks.","example":2048},"required":true,"description":"Total number of chunks.","name":"resumableTotalChunks","in":"query"},{"schema":{"type":"string","description":"Client-side identifier of the file being uploaded.","example":"2147483648-customfirmwareipsw"},"required":false,"description":"Client-side identifier of the file being uploaded.","name":"resumableIdentifier","in":"query"},{"schema":{"type":"string","description":"Original filename.","example":"custom-firmware.ipsw"},"required":false,"description":"Original filename.","name":"resumableFilename","in":"query"},{"schema":{"type":"string","description":"Relative path.","example":"custom-firmware.ipsw"},"required":false,"description":"Relative path.","name":"resumableRelativePath","in":"query"},{"schema":{"type":"string","description":"MIME type.","example":"application/octet-stream"},"required":false,"description":"MIME type.","name":"resumableType","in":"query"},{"schema":{"type":"string","description":"Expected Corellium checksum of the complete file, formatted `algorithm$blockSize$hash`.\nWhen supplied, every chunk is re-hashed and the upload is rejected (and the image removed) unless the\nrecomputed checksum matches. The chunk size used for the upload must equal the block size embedded in\nthe checksum. Required for `fw` uploads on airgapped deployments.","example":"sha256$1048576$e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"},"required":false,"description":"Expected Corellium checksum of the complete file, formatted `algorithm$blockSize$hash`.\nWhen supplied, every chunk is re-hashed and the upload is rejected (and the image removed) unless the\nrecomputed checksum matches. The chunk size used for the upload must equal the block size embedded in\nthe checksum. Required for `fw` uploads on airgapped deployments.","name":"corelliumChecksum","in":"query"},{"schema":{"type":"string","description":"Total size of the whole file in bytes. Send it on every chunk so the image-pool pre-flight check sees the full upload size rather than the size of a single chunk.","example":"2147483648"},"required":false,"description":"Total size of the whole file in bytes. Send it on every chunk so the image-pool pre-flight check sees the full upload size rather than the size of a single chunk.","name":"x-corellium-total-file-size","in":"header"}],"requestBody":{"required":true,"content":{"application/octet-stream":{"schema":{"type":"string","format":"binary","description":"Raw bytes of this chunk."}}}},"responses":{"204":{"description":"Chunk stored; empty body."},"400":{"description":"Invalid chunk parameters, checksum mismatch, chunk size differing from the block size of corelliumChecksum, or a missing corelliumChecksum for an airgapped firmware upload.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"No permission for the image's project, or the image is site-wide and the caller is not a domain (on-site) or cloud administrator.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"No image with the given imageId; create it before uploading chunks.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiNotFoundError"}}}},"413":{"description":"The upload exceeds the project's storage quota, or the size limit for this image type (ramdisk, kernel).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UploadSizeError"}}}},"507":{"description":"The local image pool does not have enough free space for this upload.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InsufficientStorageError"}}}}}},"get":{"operationId":"v3GetImageChunk","x-sdk-method":"images.getChunk","summary":"Check whether an image chunk was already uploaded","description":"Probes whether a single chunk of a chunked upload is already stored, so an\ninterrupted upload can resume without re-sending data. Used together with\n[`uploadImageChunk`](#tag/images/PUT/v3/images/{imageId}/file).\n \nReturns 200 when the chunk is present and 204 when it still needs to be uploaded. The\nchunk is identified exactly as in the upload request, by `resumableChunkNumber`,\n`resumableChunkSize` and `resumableCurrentChunkSize`, all of which are required. The image\nmust already exist; an unknown `imageId` is a 404 rather than a 204.","tags":["Images"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","example":"3e1354a3-fb10-46c0-8b05-56e28edbde69"},"required":true,"name":"imageId","in":"path"},{"schema":{"type":"integer","minimum":0,"exclusiveMinimum":true,"description":"Chunk sequence number.","example":1},"required":true,"description":"Chunk sequence number.","name":"resumableChunkNumber","in":"query"},{"schema":{"type":"integer","minimum":0,"exclusiveMinimum":true,"description":"Size of each chunk.","example":1048576},"required":true,"description":"Size of each chunk.","name":"resumableChunkSize","in":"query"},{"schema":{"type":"integer","minimum":0,"exclusiveMinimum":true,"description":"Size of the current chunk.","example":1048576},"required":true,"description":"Size of the current chunk.","name":"resumableCurrentChunkSize","in":"query"}],"responses":{"200":{"description":"The chunk is already stored; empty JSON body.","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"204":{"description":"The chunk is missing and still needs to be uploaded."},"400":{"description":"Invalid or missing chunk parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"No permission for the image's project, or the image is site-wide and the caller is not a domain (on-site) or cloud administrator.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"No image with the given imageId.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiNotFoundError"}}}}}}},"/v3/instances/{instanceId}/agent/v1/app/ready":{"get":{"operationId":"v3GetAppReadyAgent","x-sdk-method":"agent.apps.getReady","summary":"Check if app subsystem is ready","description":"Checks whether the device's agent is ready to manage apps. The agent is a helper service running inside the device that carries out the Agent calls (installing and running apps, reading and writing files, and so on). It starts after the device boots, so a device that just turned `on` may not be ready yet. Call this first and wait until it reports ready before using the other Agent endpoints.","tags":["Agent"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Instance ID.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"required":true,"description":"Instance ID.","name":"instanceId","in":"path"}],"responses":{"200":{"description":"App agent state.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentAppReadyResponse"}}}},"400":{"description":"Agent error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentError"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v3/instances/{instanceId}/agent/v1/app/install":{"post":{"operationId":"v3InstallAgent","x-sdk-method":"agent.apps.install","summary":"Install app at path","description":"Installs an app from a package file that is already on the device, for example an `.ipa` (iOS) or `.apk` (Android). Returns 204 once installed.\n\n**Installing an app from your computer:**\n1. `v3GetAppReadyAgent`: wait until the agent is ready.\n2. `v3GetTempFileAgent`: get a free temporary path on the device.\n3. `v3UploadFileAgent`: upload the package to that path.\n4. `v3InstallAgent` (this call) with that `path`.\n5. `v3ListAppsAgent` to find the app's bundle ID, then `v3RunAppAgent` to start it.","tags":["Agent"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Instance ID.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"required":true,"description":"Instance ID.","name":"instanceId","in":"path"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentInstallBody"}}}},"responses":{"204":{"description":"App installed successfully."},"400":{"description":"Agent error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentError"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v3/instances/{instanceId}/agent/v1/app/apps":{"get":{"operationId":"v3ListAppsAgent","x-sdk-method":"agent.apps.list","summary":"List apps","description":"Lists the apps installed on the device, with each app's bundle ID (for example `com.android.egg`) and name. The bundle ID is what the run, kill and uninstall calls need.","tags":["Agent"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Instance ID.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"required":true,"description":"Instance ID.","name":"instanceId","in":"path"},{"schema":{"type":"string","enum":["0","1"],"description":"Whether to include each app icon in the response."},"required":false,"description":"Whether to include each app icon in the response.","name":"loadIcons","in":"query"}],"responses":{"200":{"description":"Installed apps info.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentAppsList"}}}},"400":{"description":"Agent error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentError"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"The agent returned an invalid app list.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v3/instances/{instanceId}/agent/v1/app/apps/update":{"get":{"operationId":"v3ListAppsStatusAgent","x-sdk-method":"agent.apps.getStatus","summary":"List apps status","description":"Returns, for every installed app, whether it is currently running. Use it to check that an app started after `v3RunAppAgent`, or stopped after `v3KillAppAgent`.","tags":["Agent"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Instance ID.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"required":true,"description":"Instance ID.","name":"instanceId","in":"path"}],"responses":{"200":{"description":"Installed apps status info.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentAppsStatusList"}}}},"400":{"description":"Agent error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentError"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v3/instances/{instanceId}/agent/v1/app/icons":{"get":{"operationId":"v3ListAppIconsAgent","x-sdk-method":"agent.apps.getIcons","summary":"List app icons","description":"List app icons as base64-encoded data for the specified bundle IDs.","tags":["Agent"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Instance ID.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"required":true,"description":"Instance ID.","name":"instanceId","in":"path"},{"schema":{"type":"array","items":{"type":"string"},"description":"One or more app bundle IDs to fetch icons for.","example":["com.corellium.cafe"]},"required":true,"description":"One or more app bundle IDs to fetch icons for.","name":"bundleId","in":"query"}],"responses":{"200":{"description":"App icons keyed by bundle ID.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentIconsResponse"}}}},"400":{"description":"Agent error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentError"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v3/instances/{instanceId}/agent/v1/app/apps/{bundleId}/run":{"post":{"operationId":"v3RunAppAgent","x-sdk-method":"agent.apps.run","summary":"Run an app","description":"Launches an installed app on the device, identified by its bundle ID from `v3ListAppsAgent`. Returns 204 once the launch has been requested; check `v3ListAppsStatusAgent` to confirm it is running.","tags":["Agent"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Instance ID.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"required":true,"description":"Instance ID.","name":"instanceId","in":"path"},{"schema":{"type":"string","description":"App bundle ID.","example":"com.corellium.cafe"},"required":true,"description":"App bundle ID.","name":"bundleId","in":"path"}],"responses":{"204":{"description":"App started successfully."},"400":{"description":"Agent error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentError"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v3/instances/{instanceId}/agent/v1/app/apps/{bundleId}/kill":{"post":{"operationId":"v3KillAppAgent","x-sdk-method":"agent.apps.kill","summary":"Kill an app","description":"Force-quits a running app on the device, identified by its bundle ID. The app stays installed; start it again with `v3RunAppAgent`.","tags":["Agent"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Instance ID.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"required":true,"description":"Instance ID.","name":"instanceId","in":"path"},{"schema":{"type":"string","description":"App bundle ID.","example":"com.corellium.cafe"},"required":true,"description":"App bundle ID.","name":"bundleId","in":"path"}],"responses":{"204":{"description":"App killed successfully."},"400":{"description":"Agent error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentError"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v3/instances/{instanceId}/agent/v1/app/apps/{bundleId}/uninstall":{"post":{"operationId":"v3UninstallAppAgent","x-sdk-method":"agent.apps.uninstall","summary":"Uninstall an app","description":"Removes an app from the device, identified by its bundle ID.","tags":["Agent"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Instance ID.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"required":true,"description":"Instance ID.","name":"instanceId","in":"path"},{"schema":{"type":"string","description":"App bundle ID.","example":"com.corellium.cafe"},"required":true,"description":"App bundle ID.","name":"bundleId","in":"path"}],"responses":{"204":{"description":"App uninstalled successfully."},"400":{"description":"Agent error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentError"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v3/instances/{instanceId}/agent/v1/file/device/{filePath}":{"get":{"operationId":"v3GetFileAgent","x-sdk-method":"agent.files.get","summary":"Download a file from VM","description":"Downloads one file from the device's filesystem, given its full path on the device (for example `/tmp/log.txt`). The response body is the raw file. For large files, use `v3PreauthorizeFileDownloadAgent` so the download does not have to pass through your SDK client.","tags":["Agent"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Instance ID.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"required":true,"description":"Instance ID.","name":"instanceId","in":"path"},{"schema":{"type":"string","description":"Path to the file on the VM filesystem.","example":"/var/tmp/agent.log"},"required":true,"description":"Path to the file on the VM filesystem.","name":"filePath","in":"path","x-sdk-preserve-slashes":true}],"responses":{"200":{"description":"File contents.","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary","description":"Raw file bytes."}}}},"400":{"description":"Agent error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentError"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}},"put":{"operationId":"v3UploadFileAgent","x-sdk-method":"agent.files.upload","summary":"Upload a file to VM","description":"Writes a file onto the device's filesystem at the given full path, replacing any file already there. Send the raw file bytes as the body. Use `v3GetTempFileAgent` first if you just need somewhere to put a file, for example an app package to install.","tags":["Agent"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Instance ID.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"required":true,"description":"Instance ID.","name":"instanceId","in":"path"},{"schema":{"type":"string","description":"Path to the file on the VM filesystem.","example":"/var/tmp/agent.log"},"required":true,"description":"Path to the file on the VM filesystem.","name":"filePath","in":"path","x-sdk-preserve-slashes":true}],"requestBody":{"required":true,"content":{"application/octet-stream":{"schema":{"type":"string","format":"binary","description":"Raw file bytes to write."}}}},"responses":{"204":{"description":"File uploaded successfully."},"400":{"description":"Agent error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentError"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}},"patch":{"operationId":"v3SetFileAttributesAgent","x-sdk-method":"agent.files.setAttributes","summary":"Change attributes of a file on VM","description":"Changes a file on the device: move or rename it (`path`), change its permissions (`mode`), or change its owner. Send only what you want to change.","tags":["Agent"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Instance ID.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"required":true,"description":"Instance ID.","name":"instanceId","in":"path"},{"schema":{"type":"string","description":"Path to the file on the VM filesystem.","example":"/var/tmp/agent.log"},"required":true,"description":"Path to the file on the VM filesystem.","name":"filePath","in":"path","x-sdk-preserve-slashes":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentFileAttributesBody"}}}},"responses":{"204":{"description":"File attributes updated successfully."},"400":{"description":"Agent error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentError"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}},"delete":{"operationId":"v3DeleteFileAgent","x-sdk-method":"agent.files.delete","summary":"Delete a file on VM","description":"Delete a file from the VM filesystem.\n\nDeletes are idempotent: an unknown `instanceId`, or a path the on-device agent no longer has, is a successful no-op that still returns 204, and\nrepeated calls return 204 as well. A 404 means the request path did not match a delete route, not\nthat the target was missing.\nOther agent-reported failures, and an unreachable agent, are still reported as failures.","tags":["Agent"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Instance ID.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"required":true,"description":"Instance ID.","name":"instanceId","in":"path"},{"schema":{"type":"string","description":"Path to the file on the VM filesystem.","example":"/var/tmp/agent.log"},"required":true,"description":"Path to the file on the VM filesystem.","name":"filePath","in":"path","x-sdk-preserve-slashes":true}],"responses":{"204":{"description":"File deleted successfully."},"400":{"description":"Agent error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentError"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v3/instances/{instanceId}/agent-authorize/v1/file/device/{filePath}":{"post":{"operationId":"v3PreauthorizeFileDownloadAgent","x-sdk-method":"agent.files.preauthorizeDownload","summary":"Pre-authorize a file download from VM","description":"Returns a short-lived token for downloading one device file directly (for example from a browser or download manager) without an `Authorization` header and without buffering it in your SDK client. Download it with `GET /v1/preauthed/{token}/{filename}`. The token works only for this file and expires with your current session.","tags":["Agent"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Instance ID.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"required":true,"description":"Instance ID.","name":"instanceId","in":"path"},{"schema":{"type":"string","description":"Path to the file on the VM filesystem.","example":"/var/tmp/agent.log"},"required":true,"description":"Path to the file on the VM filesystem.","name":"filePath","in":"path","x-sdk-preserve-slashes":true}],"responses":{"200":{"description":"Preauthorized download token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentFileDownloadToken"}}}},"400":{"description":"The request was invalid, for example a missing or malformed field. The body says which field; fix it before retrying.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v3/instances/{instanceId}/agent-authorize/v1/file/download":{"post":{"operationId":"v3PreauthorizeFileArchiveDownloadAgent","x-sdk-method":"agent.files.preauthorizeArchiveDownload","summary":"Pre-authorize an archive download from VM","description":"Returns a short-lived token for downloading several files and folders from the device as one ZIP archive, built on the server. List the paths to include in the body, then download with `GET /v1/preauthed/{token}/{filename}`. The token expires with your current session.","tags":["Agent"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Instance ID.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"required":true,"description":"Instance ID.","name":"instanceId","in":"path"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentFileArchiveDownloadBody"}}}},"responses":{"200":{"description":"Preauthorized archive download token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentFileDownloadToken"}}}},"400":{"description":"The request was invalid, for example a missing or malformed field. The body says which field; fix it before retrying.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v3/instances/{instanceId}/agent/v1/file/temp":{"post":{"operationId":"v3GetTempFileAgent","x-sdk-method":"agent.files.getTemp","summary":"Get a temp file path on VM","description":"Returns an unused temporary file path on the device, free at the moment of the call. Use it as the target for `v3UploadFileAgent`, for example to stage an app package before `v3InstallAgent`.","tags":["Agent"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Instance ID.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"required":true,"description":"Instance ID.","name":"instanceId","in":"path"}],"responses":{"200":{"description":"Temporary file path.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentTempFileResponse"}}}},"400":{"description":"Agent error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentError"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v3/instances/{instanceId}/agent/v1/system/setHostname":{"post":{"operationId":"v3SetHostnameAgent","x-sdk-method":"agent.system.setHostname","summary":"Set instance hostname","description":"Set the hostname of the instance.","tags":["Agent"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Instance ID.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"required":true,"description":"Instance ID.","name":"instanceId","in":"path"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSystemSetHostnameBody"}}}},"responses":{"200":{"description":"Hostname set successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSystemResult"}}}},"400":{"description":"Agent error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentError"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v3/instances/{instanceId}/agent/v1/system/setDeviceProperties":{"post":{"operationId":"v3SetDevicePropertiesAgent","x-sdk-method":"agent.system.setDeviceProperties","summary":"Set device properties","description":"Set device properties (model and manufacturer ID) of the instance (Android only).","tags":["Agent"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Instance ID.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"required":true,"description":"Instance ID.","name":"instanceId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSystemSetDevicePropertiesBody"}}}},"responses":{"200":{"description":"Device properties updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSystemResult"}}}},"400":{"description":"Agent error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentError"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v3/instances/{instanceId}/agent/v1/system/shutdown":{"post":{"operationId":"v3ShutdownAgent","x-sdk-method":"agent.system.shutdown","summary":"Shut down instance","description":"Shut down the instance.","tags":["Agent"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Instance ID.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"required":true,"description":"Instance ID.","name":"instanceId","in":"path"}],"responses":{"204":{"description":"Shutdown initiated successfully."},"400":{"description":"Agent error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentError"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v3/instances/{instanceId}/agent/v1/system/network":{"get":{"operationId":"v3GetNetworkAgent","x-sdk-method":"agent.system.getNetwork","summary":"Get eth0 IP address","description":"Get the IP address bound to eth0 (Android only).","tags":["Agent"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Instance ID.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"required":true,"description":"Instance ID.","name":"instanceId","in":"path"}],"responses":{"200":{"description":"IP address of eth0.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSystemNetworkResponse"}}}},"400":{"description":"Agent error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentError"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v3/instances/{instanceId}/agent/v1/system/getprop":{"post":{"operationId":"v3GetPropAgent","x-sdk-method":"agent.system.getProp","summary":"Get a system property","description":"Get the value of a system property (Android only).","tags":["Agent"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Instance ID.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"required":true,"description":"Instance ID.","name":"instanceId","in":"path"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSystemGetPropBody"}}}},"responses":{"200":{"description":"Value of the requested property.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSystemGetPropResponse"}}}},"400":{"description":"Agent error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentError"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v3/instances/{instanceId}/agent/v1/system/install-opengapps":{"post":{"operationId":"v3InstallOpenGappsAgent","x-sdk-method":"agent.system.installOpenGapps","summary":"Install OpenGApps","description":"Download and install OpenGApps on the instance (Android only).","tags":["Agent"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Instance ID.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"required":true,"description":"Instance ID.","name":"instanceId","in":"path"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSystemInstallOpenGappsBody"}}}},"responses":{"204":{"description":"OpenGApps installation started successfully."},"400":{"description":"Agent error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentError"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v3/instances/{instanceId}/agent/v1/system/adbauth":{"get":{"operationId":"v3GetAdbAuthAgent","x-sdk-method":"agent.system.getAdbAuth","summary":"Get ADB auth setting","description":"Get the current ADB authorization setting (Android only).","tags":["Agent"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Instance ID.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"required":true,"description":"Instance ID.","name":"instanceId","in":"path"}],"responses":{"200":{"description":"Current ADB auth setting.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSystemAdbAuth"}}}},"400":{"description":"Agent error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentError"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}},"put":{"operationId":"v3SetAdbAuthAgent","x-sdk-method":"agent.system.setAdbAuth","summary":"Set ADB auth setting","description":"Enable or disable ADB authorization (Android only).","tags":["Agent"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Instance ID.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"required":true,"description":"Instance ID.","name":"instanceId","in":"path"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSystemAdbAuth"}}}},"responses":{"204":{"description":"ADB auth setting updated successfully."},"400":{"description":"Agent error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentError"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v3/instances/{instanceId}/agent/v1/system/lock":{"post":{"operationId":"v3LockAgent","x-sdk-method":"agent.system.lock","summary":"Lock device","description":"Lock the device (iOS only).","tags":["Agent"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Instance ID.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"required":true,"description":"Instance ID.","name":"instanceId","in":"path"}],"responses":{"204":{"description":"Device locked successfully."},"400":{"description":"Agent error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentError"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v3/instances/{instanceId}/agent/v1/system/unlock":{"post":{"operationId":"v3UnlockAgent","x-sdk-method":"agent.system.unlock","summary":"Unlock device","description":"Unlock the device (iOS only).","tags":["Agent"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Instance ID.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"required":true,"description":"Instance ID.","name":"instanceId","in":"path"}],"responses":{"204":{"description":"Device unlocked successfully."},"400":{"description":"Agent error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentError"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v3/instances/{instanceId}/agent/v1/profile/profiles":{"get":{"operationId":"v3ListProfilesAgent","x-sdk-method":"agent.profiles.list","summary":"List profiles","description":"List the configuration profiles installed on the VM.","tags":["Agent"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Instance ID.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"required":true,"description":"Instance ID.","name":"instanceId","in":"path"}],"responses":{"200":{"description":"Installed profiles.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentProfileListResponse"}}}},"400":{"description":"Agent error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentError"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v3/instances/{instanceId}/agent/v1/profile/install":{"post":{"operationId":"v3InstallProfileAgent","x-sdk-method":"agent.profiles.install","summary":"Install a profile","description":"Install a configuration profile on the VM.","tags":["Agent"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Instance ID.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"required":true,"description":"Instance ID.","name":"instanceId","in":"path"}],"requestBody":{"required":true,"content":{"application/octet-stream":{"schema":{"type":"string","format":"binary","description":"Raw profile bytes to install."}}}},"responses":{"204":{"description":"Profile installed successfully."},"400":{"description":"Agent error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentError"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v3/instances/{instanceId}/agent/v1/profile/profiles/{profileId}":{"delete":{"operationId":"v3UninstallProfileAgent","x-sdk-method":"agent.profiles.uninstall","summary":"Uninstall a profile","description":"Uninstall a configuration profile from the VM.\n\nDeletes are idempotent: an unknown `instanceId`, or a profile that is not installed, is a successful no-op that still returns 204, and\nrepeated calls return 204 as well. A 404 means the request path did not match a delete route, not\nthat the target was missing.\nOther agent-reported failures, and an unreachable agent, are still reported as failures.","tags":["Agent"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Instance ID.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"required":true,"description":"Instance ID.","name":"instanceId","in":"path"},{"schema":{"type":"string","description":"The profile identifier.","example":"com.apple.wifi.managed"},"required":true,"description":"The profile identifier.","name":"profileId","in":"path"}],"responses":{"204":{"description":"Profile uninstalled successfully."},"400":{"description":"Agent error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentError"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v3/instances/{instanceId}/agent/v1/frida/run-frida":{"post":{"operationId":"v3RunFridaAgent","x-sdk-method":"agent.frida.run","summary":"Run Frida","description":"Attach Frida to a target process on the VM.","tags":["Agent"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Instance ID.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"required":true,"description":"Instance ID.","name":"instanceId","in":"path"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentFridaRunBody"}}}},"responses":{"200":{"description":"Frida attached successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentFridaResponse"}}}},"400":{"description":"Agent error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentError"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v3/instances/{instanceId}/agent/v1/frida/run-frida-ps":{"post":{"operationId":"v3ListFridaProcessesAgent","x-sdk-method":"agent.frida.listProcesses","summary":"List Frida processes","description":"Run frida-ps on the VM and return the list of processes.","tags":["Agent"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Instance ID.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"required":true,"description":"Instance ID.","name":"instanceId","in":"path"}],"responses":{"200":{"description":"Frida process list.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentFridaProcessList"}}}},"400":{"description":"Agent error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentError"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v3/instances/{instanceId}/agent/v1/frida/run-frida-kill":{"post":{"operationId":"v3KillFridaAgent","x-sdk-method":"agent.frida.kill","summary":"Kill Frida","description":"Stop the running Frida session on the VM.","tags":["Agent"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Instance ID.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"required":true,"description":"Instance ID.","name":"instanceId","in":"path"}],"responses":{"200":{"description":"Frida killed successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentFridaResponse"}}}},"400":{"description":"Agent error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentError"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v3/instances/{instanceId}/agent/v1/remoteit/status":{"get":{"operationId":"v3GetRemoteItStatusAgent","x-sdk-method":"agent.remoteIt.getStatus","summary":"Get Remote.It status","description":"Get the installation status of the Remote.It package on the VM (RPi only).","tags":["Agent"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Instance ID.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"required":true,"description":"Instance ID.","name":"instanceId","in":"path"}],"responses":{"200":{"description":"Current Remote.It status.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentRemoteItStatus"}}}},"400":{"description":"Agent error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentError"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"The resource does not exist, or you cannot see it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiNotFoundError"}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v3/instances/{instanceId}/agent/v1/remoteit/install":{"post":{"operationId":"v3InstallRemoteItAgent","x-sdk-method":"agent.remoteIt.install","summary":"Install Remote.It","description":"Install the Remote.It package on the VM (RPi only). The device name and platform code are derived server-side from the instance and its flavor.","tags":["Agent"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Instance ID.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"required":true,"description":"Instance ID.","name":"instanceId","in":"path"}],"responses":{"200":{"description":"Remote.It status after install.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentRemoteItStatus"}}}},"400":{"description":"Agent error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentError"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"The resource does not exist, or you cannot see it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiNotFoundError"}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v3/instances/{instanceId}/agent/v1/remoteit/uninstall":{"post":{"operationId":"v3UninstallRemoteItAgent","x-sdk-method":"agent.remoteIt.uninstall","summary":"Uninstall Remote.It","description":"Uninstall the Remote.It package from the VM (RPi only).","tags":["Agent"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Instance ID.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"required":true,"description":"Instance ID.","name":"instanceId","in":"path"}],"responses":{"200":{"description":"Remote.It status after uninstall.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentRemoteItStatus"}}}},"400":{"description":"Agent error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentError"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"The resource does not exist, or you cannot see it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiNotFoundError"}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v3/instances/{instanceId}/agent/v1/container/containers":{"get":{"operationId":"v3ListContainersAgent","x-sdk-method":"agent.containers.list","summary":"List containers","description":"List the nested containers on the VM (Android only).","tags":["Agent"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Instance ID.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"required":true,"description":"Instance ID.","name":"instanceId","in":"path"}],"responses":{"200":{"description":"List of containers.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentContainerList"}}}},"400":{"description":"Agent error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentError"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v3/instances/{instanceId}/agent/v1/container/containers/{containerId}/start":{"post":{"operationId":"v3StartContainerAgent","x-sdk-method":"agent.containers.start","summary":"Start a container","description":"Start a nested container on the VM (Android only).","tags":["Agent"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Instance ID.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"required":true,"description":"Instance ID.","name":"instanceId","in":"path"},{"schema":{"type":"string","description":"Container identifier (the numeric suffix of the container name, e.g. \"1\" for container1).","example":"1"},"required":true,"description":"Container identifier (the numeric suffix of the container name, e.g. \"1\" for container1).","name":"containerId","in":"path"}],"responses":{"204":{"description":"Container started."},"400":{"description":"Agent error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentError"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v3/instances/{instanceId}/agent/v1/container/containers/{containerId}/stop":{"post":{"operationId":"v3StopContainerAgent","x-sdk-method":"agent.containers.stop","summary":"Stop a container","description":"Stop a nested container on the VM (Android only).","tags":["Agent"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Instance ID.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"required":true,"description":"Instance ID.","name":"instanceId","in":"path"},{"schema":{"type":"string","description":"Container identifier (the numeric suffix of the container name, e.g. \"1\" for container1).","example":"1"},"required":true,"description":"Container identifier (the numeric suffix of the container name, e.g. \"1\" for container1).","name":"containerId","in":"path"}],"responses":{"204":{"description":"Container stopped."},"400":{"description":"Agent error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentError"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v3/instances/{instanceId}/agent/v1/container/containers/{containerId}/is-healthy":{"get":{"operationId":"v3GetContainerHealthAgent","x-sdk-method":"agent.containers.getHealth","summary":"Get container health","description":"Check whether a nested container is healthy (Android only).","tags":["Agent"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Instance ID.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"required":true,"description":"Instance ID.","name":"instanceId","in":"path"},{"schema":{"type":"string","description":"Container identifier (the numeric suffix of the container name, e.g. \"1\" for container1).","example":"1"},"required":true,"description":"Container identifier (the numeric suffix of the container name, e.g. \"1\" for container1).","name":"containerId","in":"path"}],"responses":{"200":{"description":"Container health.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentContainerHealth"}}}},"400":{"description":"Agent error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentError"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v3/instances/{instanceId}/agent/v1/container/containers/{containerId}/start-application/{packageName}/{activityName}":{"post":{"operationId":"v3StartContainerAppAgent","x-sdk-method":"agent.containers.startApp","summary":"Start an app in a container","description":"Start an Android application in a nested container (Android only).","tags":["Agent"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Instance ID.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"required":true,"description":"Instance ID.","name":"instanceId","in":"path"},{"schema":{"type":"string","description":"Container identifier (the numeric suffix of the container name, e.g. \"1\" for container1).","example":"1"},"required":true,"description":"Container identifier (the numeric suffix of the container name, e.g. \"1\" for container1).","name":"containerId","in":"path"},{"schema":{"type":"string","description":"Android package name of the application.","example":"com.corellium.cafe"},"required":true,"description":"Android package name of the application.","name":"packageName","in":"path"},{"schema":{"type":"string","description":"Android activity name to launch.","example":"com.corellium.cafe.MainActivity"},"required":true,"description":"Android activity name to launch.","name":"activityName","in":"path"}],"responses":{"204":{"description":"Application started."},"400":{"description":"Agent error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentError"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v3/instances/{instanceId}/agent/v1/container/containers/{containerId}/start-application-and-monitor/{packageName}/{activityName}":{"post":{"operationId":"v3StartContainerAppMonitoredAgent","x-sdk-method":"agent.containers.startAppMonitored","summary":"Start and monitor an app in a container","description":"Start an Android application in a nested container and monitor it (Android only).","tags":["Agent"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Instance ID.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"required":true,"description":"Instance ID.","name":"instanceId","in":"path"},{"schema":{"type":"string","description":"Container identifier (the numeric suffix of the container name, e.g. \"1\" for container1).","example":"1"},"required":true,"description":"Container identifier (the numeric suffix of the container name, e.g. \"1\" for container1).","name":"containerId","in":"path"},{"schema":{"type":"string","description":"Android package name of the application.","example":"com.corellium.cafe"},"required":true,"description":"Android package name of the application.","name":"packageName","in":"path"},{"schema":{"type":"string","description":"Android activity name to launch.","example":"com.corellium.cafe.MainActivity"},"required":true,"description":"Android activity name to launch.","name":"activityName","in":"path"}],"responses":{"204":{"description":"Application started and monitored."},"400":{"description":"Agent error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentError"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v3/instances/{instanceId}/agent/v1/container/containers/{containerId}/stop-application-if-monitored":{"post":{"operationId":"v3StopContainerAppAgent","x-sdk-method":"agent.containers.stopApp","summary":"Stop a monitored app in a container","description":"Stop the monitored Android application in a nested container, if one is monitored (Android only).","tags":["Agent"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Instance ID.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"required":true,"description":"Instance ID.","name":"instanceId","in":"path"},{"schema":{"type":"string","description":"Container identifier (the numeric suffix of the container name, e.g. \"1\" for container1).","example":"1"},"required":true,"description":"Container identifier (the numeric suffix of the container name, e.g. \"1\" for container1).","name":"containerId","in":"path"}],"responses":{"204":{"description":"Application stopped."},"400":{"description":"Agent error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentError"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v3/invites":{"get":{"operationId":"v3ListInvites","x-required-roles":["domain-administrator","project-administrator"],"x-sdk-method":"invites.list","summary":"List invites","description":"**Required role:** Domain administrator or project administrator.\n\nLists invitations that have been sent in your domain but not yet used or revoked, with each invite's email and the teams and projects it will grant. Requires a domain or project administrator. Results are paginated with `limit` and `offset`.","tags":["Invites"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"integer","minimum":1,"maximum":1000,"default":100,"description":"Most results to return in one page. Whole number from 1 to 1000; defaults to 100. A value outside that range is rejected with 400."},"required":false,"description":"Most results to return in one page. Whole number from 1 to 1000; defaults to 100. A value outside that range is rejected with 400.","name":"limit","in":"query"},{"schema":{"type":"integer","nullable":true,"minimum":0,"default":0,"description":"How many results to skip before this page starts; defaults to 0. To get the next page, add `limit` to the previous `offset`."},"required":false,"description":"How many results to skip before this page starts; defaults to 0. To get the next page, add `limit` to the previous `offset`.","name":"offset","in":"query"}],"responses":{"200":{"description":"Paginated list of invitations.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvitesListResponse"}}}},"400":{"description":"The request was invalid, for example a missing or malformed field. The body says which field; fix it before retrying.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"403":{"description":"Domain administrator or project administrator permissions required. Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-badges":[{"name":"Domain or project administrator"}]},"post":{"operationId":"v3CreateInvites","x-required-roles":["domain-administrator","project-administrator"],"x-sdk-method":"invites.create","summary":"Create invites","description":"**Required role:** Domain administrator or project administrator.\n\nInvites people by email to create an account in your domain. Requires a domain or project administrator. Each person is emailed a signup link; they create their account with `v3SignupFromInvite`. Use `settings` to add them to teams and give them project access automatically when they sign up.\n\nThe response has one entry per email address: either the created `invite`, or an `error`. An address fails if someone in your domain already uses it, or if it already has a pending invite. To email a pending invite again, send the same address with `resend: true`; this issues a new signup link and the old one stops working.","tags":["Invites"],"security":[{"BearerAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateInvitesBody"}}}},"responses":{"200":{"description":"Invite results keyed by email.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateInvitesResponse"}}}},"403":{"description":"Domain administrator or project administrator permissions required. Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-badges":[{"name":"Domain or project administrator"}]}},"/v3/invites-by-token":{"post":{"operationId":"v3GetInviteByToken","x-sdk-method":"invites.getByToken","summary":"Get an invite by token","description":"Looks up an invitation from the token in a signup link, so a signup page can show which domain and email the invite is for before the person creates their account. Needs no sign-in. Returns 403 if the invite has expired, the token does not match, or the domain is disabled, and 404 if no invite has this token.","tags":["Invites"],"security":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetInviteByTokenBody"}}}},"responses":{"200":{"description":"The invitation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvitationByToken"}}}},"400":{"description":"Missing or invalid token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"403":{"description":"The invite has expired, its token does not match, or its domain is disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"No invite with the given token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiNotFoundError"}}}}}}},"/v3/invites/edit":{"post":{"operationId":"v3EditInvites","x-required-roles":["domain-administrator","project-administrator"],"x-sdk-method":"invites.edit","summary":"Edit invites","description":"**Required role:** Domain administrator or project administrator.\n\nChanges the teams and projects a pending invite will grant when the person signs up. Requires a domain or project administrator. Only the first invite matching the given IDs is changed, so send one ID per request. Team and project IDs not in your domain are dropped. Returns the invite after the change. The person is not emailed again.","tags":["Invites"],"security":[{"BearerAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EditInvitesBody"}}}},"responses":{"200":{"description":"The edited invite.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Invitation"}}}},"403":{"description":"Domain administrator or project administrator permissions required. Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-badges":[{"name":"Domain or project administrator"}]}},"/v3/invites/revoke":{"post":{"operationId":"v3RevokeInvites","x-required-roles":["domain-administrator","project-administrator"],"x-sdk-method":"invites.revoke","summary":"Revoke invites","description":"**Required role:** Domain administrator or project administrator.\n\nCancels pending invites, so their signup links stop working. Requires a domain or project administrator. Returns how many invites were removed; IDs that do not match a pending invite in your domain are ignored. People who already signed up are not affected; remove their accounts with `DELETE /v3/users/{userId}`.","tags":["Invites"],"security":[{"BearerAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RevokeInvitesBody"}}}},"responses":{"200":{"description":"Number of invites revoked.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RevokeInvitesResponse"}}}},"403":{"description":"Domain administrator or project administrator permissions required. Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-badges":[{"name":"Domain or project administrator"}]}},"/v3/invites/signup":{"post":{"operationId":"v3SignupFromInvite","x-sdk-method":"invites.signup","summary":"Sign up from an invite","description":"Creates a new user account from the token in an invitation email. Needs no sign-in. The account uses the invited email (or `email` from a single sign-on provider, if given) as its username. The teams and project access set on the invite are applied, and the invite is then used up. If your domain requires agreeing to its terms, `agreed` must be true. Returns 403 if the invite has expired or the domain is disabled, and 404 if the token is unknown or already used.","tags":["Invites"],"security":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InviteSignupBody"}}}},"responses":{"200":{"description":"The created user.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InviteSignupResponse"}}}},"400":{"description":"Invalid signup parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"No invite with the given token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiNotFoundError"}}}}}}},"/v3/models":{"get":{"operationId":"v3GetModels","x-sdk-method":"models.list","summary":"List device models","description":"Lists every device model you can create an instance of. Call it first when creating a device: pick a model, then list its software with `v3GetModelSoftware`, then create the instance with `POST /v3/instances`.\n\nThe list only includes models your account can use. iOS models are left out if iOS is disabled for your domain, models from vendors your domain has not enabled are left out, and beta models appear only on deployments that allow them.\n\nEach entry tells you what you need to create a valid instance:\n- `flavor`: the value to pass as `flavor` when creating the instance.\n- `cores`, `coresMin`, `coresMax`, `coresStep`, `coresAllowed`: which CPU core counts are allowed.\n- `ram`, `ramMin`, `ramMax`: allowed memory, in MiB.\n- `hasSoftware`: false means there is no operating system available for this model yet, so an instance cannot be created from a standard build.\n- `mast`: whether MATRIX assessments work on it.\n\n**Caching.** The response carries an `ETag` header. Send it back as `If-None-Match` on later calls; if nothing has changed you get 304 with no body and can reuse your copy.","tags":["Models"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","description":"An ETag a previous response carried, quotes included.","example":"\"20184446fd197a424d5221fc7bfcd0084414c4b1ba822cac6f8f2221ebc80d06\""},"required":false,"description":"An ETag a previous response carried, quotes included.","name":"if-none-match","in":"header"}],"responses":{"200":{"description":"Supported device configurations.","headers":{"ETag":{"schema":{"type":"string","description":"Entity tag for this body. Send it back unchanged as `If-None-Match` to make the next request conditional.","example":"\"20184446fd197a424d5221fc7bfcd0084414c4b1ba822cac6f8f2221ebc80d06\""},"required":true,"description":"Entity tag for this body. Send it back unchanged as `If-None-Match` to make the next request conditional."}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Model"}}}}},"304":{"description":"The resource is unchanged since the ETag given in If-None-Match.","headers":{"ETag":{"schema":{"type":"string","description":"Entity tag for this body. Send it back unchanged as `If-None-Match` to make the next request conditional.","example":"\"20184446fd197a424d5221fc7bfcd0084414c4b1ba822cac6f8f2221ebc80d06\""},"required":true,"description":"Entity tag for this body. Send it back unchanged as `If-None-Match` to make the next request conditional."}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v3/models/{model}/software":{"get":{"operationId":"v3GetModelSoftware","x-sdk-method":"models.getSoftware","summary":"List software for a model","description":"Lists the operating-system builds you can install on a new instance of one model. Identify the model by its flavor ID (for example `iphone17a`) or its product identifier. Each entry's `osVersion` and `osBuild` are the values to pass to `POST /v3/instances`.\n\n**Where the list comes from.** It includes vendor builds the platform supports for this model (for example public iOS releases), firmware installed cluster-wide with `POST /v3/images/install-firmware`, and firmware uploaded at domain level with `POST /v3/images` (no `projectId` or `instanceId`). It does **not** include images that belong to a project or instance; to boot one of those, reference it explicitly when creating the instance.\n\n**Choosing a build.**\n- `installed: true` builds are already on your deployment and start fastest. Others are downloaded when first used.\n- On Android there are usually two builds per version; `rooted` tells them apart. MATRIX needs the rooted build.\n- `springboardSnapshot` present means the build supports rapid start.\n\nReturns 404 if the model is unknown or has no software.","tags":["Models"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","description":"Which model to list software for: a flavor ID (the `flavor` value from `v3GetModels`, for example \"iphone17a\") or a product identifier such as \"iPhone18,4\". Only a flavor ID returns `springboardSnapshot`.","example":"iphone17a"},"required":true,"description":"Which model to list software for: a flavor ID (the `flavor` value from `v3GetModels`, for example \"iphone17a\") or a product identifier such as \"iPhone18,4\". Only a flavor ID returns `springboardSnapshot`.","name":"model","in":"path"}],"responses":{"200":{"description":"Supported software loads for this model.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ModelFirmware"}}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"No software found for the given model.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiNotFoundError"}}}}}}},"/v3/projects":{"get":{"operationId":"v3ListProjects","x-sdk-method":"projects.list","summary":"List projects","description":"Lists the projects you can access. A project is a workspace that holds devices (instances), the files uploaded for them, and a share of your domain's resources (CPU cores, memory and device count). Almost every other call needs a project ID, so this is usually the first call after you sign in.\n\nResults are paginated with `limit` and `offset`. Use `name` to find one project by its exact name (not case-sensitive). Each entry includes its quotas, current usage, and the number of authorized keys.","tags":["Projects"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"integer","minimum":1,"maximum":1000,"default":100,"description":"Most results to return in one page. Whole number from 1 to 1000; defaults to 100. A value outside that range is rejected with 400."},"required":false,"description":"Most results to return in one page. Whole number from 1 to 1000; defaults to 100. A value outside that range is rejected with 400.","name":"limit","in":"query"},{"schema":{"type":"integer","nullable":true,"minimum":0,"default":0,"description":"How many results to skip before this page starts; defaults to 0. To get the next page, add `limit` to the previous `offset`."},"required":false,"description":"How many results to skip before this page starts; defaults to 0. To get the next page, add `limit` to the previous `offset`.","name":"offset","in":"query"},{"schema":{"type":"string","description":"Filter by exact project name (case-insensitive).","example":"Default Project"},"required":false,"description":"Filter by exact project name (case-insensitive).","name":"name","in":"query"}],"responses":{"200":{"description":"Paginated list of projects.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectList"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}},"post":{"operationId":"v3CreateProject","x-required-roles":["domain-administrator"],"x-sdk-method":"projects.create","summary":"Create a project","description":"**Required role:** Domain administrator.\n\nCreates a new project in your domain. Requires a domain administrator.\n\n**Give it quota, or it cannot run devices.** A new project created without `quotas` has zero quota. Quota is reserved out of your domain's total allowance, so if the whole allowance is already reserved by other projects, lower one of them with `v3PatchProject` first.\n\nWhen you set `quotas`, `cores` is required. `instances` is derived from `cores` if you leave it out, and memory is always calculated from cores (6144 MiB per core); any `ram` you send is ignored.\n\nReturns 201 with the new project, including its `id`.","tags":["Projects"],"security":[{"BearerAuth":[]}],"requestBody":{"required":true,"description":"Project to create.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateProjectBody"}}}},"responses":{"201":{"description":"The created project.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Project"}}}},"400":{"description":"The project payload is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Domain administrator permissions required. Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-badges":[{"name":"Domain administrator"}]}},"/v3/projects/{projectId}":{"get":{"operationId":"v3GetProject","x-sdk-method":"projects.get","summary":"Get a project","description":"Returns one project with its settings, quotas, and current resource usage (`quotasUsed`). Compare `quotas` with `quotasUsed` to see whether there is room for another device before creating one. Returns 404 if the project does not exist and 403 if you cannot access it.","tags":["Projects"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"ID of the project. Get it from `v3ListProjects`, or from the `id` returned when the project was created.","example":"1c41b1bc-4f53-48a8-b690-ad30611e1960"},"required":true,"description":"ID of the project. Get it from `v3ListProjects`, or from the `id` returned when the project was created.","name":"projectId","in":"path"}],"responses":{"200":{"description":"The requested project.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Project"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"No project with the given identifier.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiNotFoundError"}}}}}},"patch":{"operationId":"v3PatchProject","x-sdk-method":"projects.patch","summary":"Update a project","description":"Changes a project's name, settings or quotas. Send only the fields you want to change.\n\n- `settings` is merged into the existing settings: fields you leave out keep their current values.\n- `quotas` follows the same rules as on create: `cores` is required, `instances` is derived when omitted, and memory is always calculated from cores.\n- Changing the network connection (`settings.connection`) is refused with 400 while any device in the project is running. Stop the devices first.\n\nReturns the updated project.","tags":["Projects"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"ID of the project. Get it from `v3ListProjects`, or from the `id` returned when the project was created.","example":"1c41b1bc-4f53-48a8-b690-ad30611e1960"},"required":true,"description":"ID of the project. Get it from `v3ListProjects`, or from the `id` returned when the project was created.","name":"projectId","in":"path"}],"requestBody":{"required":true,"description":"Fields to update.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchProjectBody"}}}},"responses":{"200":{"description":"The updated project.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Project"}}}},"400":{"description":"The update payload is invalid, or the network connection cannot be changed while instances are active.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"No project with the given identifier.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiNotFoundError"}}}}}},"delete":{"operationId":"v3DeleteProject","x-required-roles":["domain-administrator"],"x-sdk-method":"projects.delete","summary":"Delete a project","description":"**Required role:** Domain administrator.\n\nDeletes a project together with every file (image) uploaded to it. Requires a domain administrator.\n\nThe project must not contain any devices: if it does, the request fails with 409 and nothing is deleted. Delete the devices first with `DELETE /v3/instances/{instanceId}` and wait until they are gone.\n\nDeletes are idempotent: an unknown `projectId`, or a project that was already deleted, is a successful no-op that still returns 204, and\nrepeated calls return 204 as well. A 404 means the request path did not match a delete route, not\nthat the target was missing.","tags":["Projects"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"ID of the project. Get it from `v3ListProjects`, or from the `id` returned when the project was created.","example":"1c41b1bc-4f53-48a8-b690-ad30611e1960"},"required":true,"description":"ID of the project. Get it from `v3ListProjects`, or from the `id` returned when the project was created.","name":"projectId","in":"path"}],"responses":{"204":{"description":"The project was deleted."},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Domain administrator permissions required. Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"The project still contains devices and cannot be deleted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiConflictError"}}}}},"x-badges":[{"name":"Domain administrator"}]}},"/v3/projects/{projectId}/instances":{"get":{"operationId":"v3ListProjectInstances","x-sdk-method":"projects.listInstances","summary":"List project instances","description":"Lists the devices (instances) in a project, with their ID, name and current state. Results are paginated with `limit` and `offset`; use `name` to find a device by its exact name. For full device details, call `GET /v3/instances/{instanceId}`.","tags":["Projects"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"ID of the project. Get it from `v3ListProjects`, or from the `id` returned when the project was created.","example":"1c41b1bc-4f53-48a8-b690-ad30611e1960"},"required":true,"description":"ID of the project. Get it from `v3ListProjects`, or from the `id` returned when the project was created.","name":"projectId","in":"path"},{"schema":{"type":"integer","minimum":1,"maximum":1000,"default":100,"description":"Most results to return in one page. Whole number from 1 to 1000; defaults to 100. A value outside that range is rejected with 400."},"required":false,"description":"Most results to return in one page. Whole number from 1 to 1000; defaults to 100. A value outside that range is rejected with 400.","name":"limit","in":"query"},{"schema":{"type":"integer","nullable":true,"minimum":0,"default":0,"description":"How many results to skip before this page starts; defaults to 0. To get the next page, add `limit` to the previous `offset`."},"required":false,"description":"How many results to skip before this page starts; defaults to 0. To get the next page, add `limit` to the previous `offset`.","name":"offset","in":"query"},{"schema":{"type":"string","description":"Filter by exact instance name.","example":"My Device"},"required":false,"description":"Filter by exact instance name.","name":"name","in":"query"}],"responses":{"200":{"description":"Paginated list of instances in the project.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectInstanceList"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"No project with the given identifier.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiNotFoundError"}}}}}}},"/v3/projects/{projectId}/keys":{"get":{"operationId":"v3ListProjectKeys","x-sdk-method":"projects.keys.list","summary":"List project keys","description":"Lists the public keys authorized on this project. Keys let you connect to the project's devices over SSH, or to Android devices over ADB, without a password. Returns 403 if your deployment is not licensed for key pairing.","tags":["Projects"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"ID of the project. Get it from `v3ListProjects`, or from the `id` returned when the project was created.","example":"1c41b1bc-4f53-48a8-b690-ad30611e1960"},"required":true,"description":"ID of the project. Get it from `v3ListProjects`, or from the `id` returned when the project was created.","name":"projectId","in":"path"},{"schema":{"type":"integer","minimum":1,"maximum":1000,"default":100,"description":"Most results to return in one page. Whole number from 1 to 1000; defaults to 100. A value outside that range is rejected with 400."},"required":false,"description":"Most results to return in one page. Whole number from 1 to 1000; defaults to 100. A value outside that range is rejected with 400.","name":"limit","in":"query"},{"schema":{"type":"integer","nullable":true,"minimum":0,"default":0,"description":"How many results to skip before this page starts; defaults to 0. To get the next page, add `limit` to the previous `offset`."},"required":false,"description":"How many results to skip before this page starts; defaults to 0. To get the next page, add `limit` to the previous `offset`.","name":"offset","in":"query"}],"responses":{"200":{"description":"Paginated list of authorized keys.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectKeyList"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"This deployment is not licensed for SSH key pairing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"No project with the given identifier.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiNotFoundError"}}}}}},"post":{"operationId":"v3CreateProjectKey","x-required-roles":["domain-administrator","project-administrator"],"x-sdk-method":"projects.keys.create","summary":"Add a project key","description":"**Required role:** Domain administrator or project administrator.\n\nAuthorizes a public key on the project, so its holder can connect to the project's devices. Requires a domain or project administrator.\n\nSet `kind` to `ssh` for SSH access or `adb` for Android Debug Bridge access, and put the public key (never the private key) in `key`, in the same one-line format as an OpenSSH `authorized_keys` entry. `label` is an optional note to help you recognise the key later. Returns 400 if the key cannot be parsed.","tags":["Projects"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"ID of the project. Get it from `v3ListProjects`, or from the `id` returned when the project was created.","example":"1c41b1bc-4f53-48a8-b690-ad30611e1960"},"required":true,"description":"ID of the project. Get it from `v3ListProjects`, or from the `id` returned when the project was created.","name":"projectId","in":"path"}],"requestBody":{"required":true,"description":"Key to add.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateProjectKeyBody"}}}},"responses":{"201":{"description":"The added authorized key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectKey"}}}},"400":{"description":"The supplied public key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Domain administrator or project administrator permissions required. This deployment is not licensed for SSH key pairing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"No project with the given identifier.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiNotFoundError"}}}}},"x-badges":[{"name":"Domain or project administrator"}]}},"/v3/projects/{projectId}/keys/{keyId}":{"delete":{"operationId":"v3DeleteProjectKey","x-required-roles":["domain-administrator","project-administrator"],"x-sdk-method":"projects.keys.delete","summary":"Delete a project key","description":"**Required role:** Domain administrator or project administrator.\n\nRemoves an authorized key from the project, so it can no longer be used to connect to the project's devices. Requires a domain or project administrator.\n\nDeletes are idempotent: a `keyId` that is not present on the project, or an unknown `projectId`, is a successful no-op that still returns 204, and\nrepeated calls return 204 as well. A 404 means the request path did not match a delete route, not\nthat the target was missing.","tags":["Projects"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"ID of the project. Get it from `v3ListProjects`, or from the `id` returned when the project was created.","example":"1c41b1bc-4f53-48a8-b690-ad30611e1960"},"required":true,"description":"ID of the project. Get it from `v3ListProjects`, or from the `id` returned when the project was created.","name":"projectId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Project key identifier.","example":"9c1098dc-e881-41fb-b3af-e2d5ddd55d86"},"required":true,"description":"Project key identifier.","name":"keyId","in":"path"}],"responses":{"204":{"description":"The authorized key was removed."},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Domain administrator or project administrator permissions required. Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-badges":[{"name":"Domain or project administrator"}]}},"/v3/projects/{projectId}/firmware-assets":{"post":{"operationId":"v3FetchProjectFirmwareAssets","x-sdk-method":"projects.fetchFirmwareAssets","summary":"Fetch firmware assets for a project","description":"Asks the platform to download firmware assets (for example the decryption keys some iOS versions need to boot) from the given URLs and store them for your domain. Use it when device creation reports that assets are missing: the missing asset URLs appear in that error and in each firmware entry. The response lists which URLs were newly stored, which were already present, and which failed and why. Returns 409 if downloading assets is turned off on this deployment (for example an air-gapped one); there, upload the assets as a file and install them with `POST /v3/images/install-firmware-assets` instead.","tags":["Projects"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"ID of the project. Get it from `v3ListProjects`, or from the `id` returned when the project was created.","example":"1c41b1bc-4f53-48a8-b690-ad30611e1960"},"required":true,"description":"ID of the project. Get it from `v3ListProjects`, or from the `id` returned when the project was created.","name":"projectId","in":"path"}],"requestBody":{"required":true,"description":"Firmware asset URLs to fetch.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FetchFirmwareAssetsBody"}}}},"responses":{"200":{"description":"The fetch result reported by the firmware service.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FetchFirmwareAssetsResponse"}}}},"400":{"description":"The asset URL payload is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"No project with the given identifier.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiNotFoundError"}}}},"409":{"description":"Fetching firmware assets is disabled on this cluster.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiConflictError"}}}},"503":{"description":"The firmware service is currently unavailable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v3/projects/{projectId}/network/status":{"get":{"operationId":"v3GetProjectNetworkStatus","x-sdk-method":"projects.getNetworkStatus","summary":"Get project network status","description":"Returns the state of the project's outbound VPN connection (the connection set in `settings.connection`), such as whether it is connected, and error details if it is not. Use it to check that device traffic is flowing through your VPN.","tags":["Projects"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"ID of the project. Get it from `v3ListProjects`, or from the `id` returned when the project was created.","example":"1c41b1bc-4f53-48a8-b690-ad30611e1960"},"required":true,"description":"ID of the project. Get it from `v3ListProjects`, or from the `id` returned when the project was created.","name":"projectId","in":"path"}],"responses":{"200":{"description":"The project network connection status.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NetworkStatus"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"No project with the given identifier.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiNotFoundError"}}}}}}},"/v3/projects/{projectId}/network/log":{"get":{"operationId":"v3GetProjectNetworkLog","x-sdk-method":"projects.getNetworkLog","summary":"Get project network log","description":"Returns the log of the project's outbound VPN connection as plain text. Use it to diagnose a connection that will not come up.","tags":["Projects"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"ID of the project. Get it from `v3ListProjects`, or from the `id` returned when the project was created.","example":"1c41b1bc-4f53-48a8-b690-ad30611e1960"},"required":true,"description":"ID of the project. Get it from `v3ListProjects`, or from the `id` returned when the project was created.","name":"projectId","in":"path"}],"responses":{"200":{"description":"The project network connection log.","content":{"text/plain":{"schema":{"type":"string","description":"Network connection log text.","example":"Connected to VPN gateway 10.0.0.1"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"No project with the given identifier.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiNotFoundError"}}}}}}},"/v3/projects/{projectId}/vpnconfig/{format}":{"get":{"operationId":"v3GetProjectVpnConfig","x-sdk-method":"projects.getVpnConfig","summary":"Get project VPN configuration","description":"Downloads a VPN configuration that lets your computer join the project's device network, so you can reach the devices directly (for example by SSH or a local debugger). Set `format` to 'ovpn' to get an OpenVPN profile to import into any OpenVPN client. Any other value returns a zip for the Tunnelblick client on macOS. Returns 400 if the project does not have a VPN endpoint yet.","tags":["Projects"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"ID of the project. Get it from `v3ListProjects`, or from the `id` returned when the project was created.","example":"1c41b1bc-4f53-48a8-b690-ad30611e1960"},"required":true,"description":"ID of the project. Get it from `v3ListProjects`, or from the `id` returned when the project was created.","name":"projectId","in":"path"},{"schema":{"type":"string","description":"VPN configuration format: 'ovpn' for an OpenVPN profile; any other value returns a Tunnelblick zip.","example":"ovpn"},"required":true,"description":"VPN configuration format: 'ovpn' for an OpenVPN profile; any other value returns a Tunnelblick zip.","name":"format","in":"path"}],"responses":{"200":{"description":"The VPN configuration, as a text OpenVPN profile or a binary Tunnelblick zip.","content":{"application/x-openvpn-profile":{"schema":{"type":"string","description":"OpenVPN configuration document.","example":"client\ndev tun\nproto udp\nremote vpn.example.com 1194"}},"application/zip":{"schema":{"type":"string","format":"binary","description":"Tunnelblick configuration zip."}}}},"400":{"description":"The project does not have an active VPN IP or port.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"No project with the given identifier.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiNotFoundError"}}}}}}},"/v3/projects/{projectId}/preauth-vpn-config/{filename}":{"post":{"operationId":"v3PreauthVpnConfig","x-sdk-method":"projects.preauthorizeVpnConfig","summary":"Pre-authorize a VPN configuration download","description":"Pre-authorize a VPN configuration download. Returns a short-lived signed token that authorizes the download without an Authorization header, so it can be embedded in a plain download URL: GET /v1/preauthed-vpn-configs/{token}/{filename}. The token carries the client identifier and the format, and expires with the calling session token.","tags":["Projects"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"ID of the project. Get it from `v3ListProjects`, or from the `id` returned when the project was created.","example":"1c41b1bc-4f53-48a8-b690-ad30611e1960"},"required":true,"description":"ID of the project. Get it from `v3ListProjects`, or from the `id` returned when the project was created.","name":"projectId","in":"path"},{"schema":{"type":"string","description":"VPN configuration filename, as '<clientId>.<format>'. The client identifier becomes the common name of the issued client certificate; a format of 'ovpn' yields an OpenVPN profile and any other value yields a Tunnelblick zip.","example":"researcher-laptop.ovpn"},"required":true,"description":"VPN configuration filename, as '<clientId>.<format>'. The client identifier becomes the common name of the issued client certificate; a format of 'ovpn' yields an OpenVPN profile and any other value yields a Tunnelblick zip.","name":"filename","in":"path"}],"responses":{"200":{"description":"A short-lived signed token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VpnConfigPreauthorization"}}}},"400":{"description":"The project does not have an active VPN IP or port.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"No project with the given identifier.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiNotFoundError"}}}}}}},"/v3/projects/{projectId}/image-upload/{type}/{imageId}/{name}":{"get":{"operationId":"v3GetProjectImageUpload","x-sdk-method":"projects.getImageUpload","summary":"Get image upload status","description":"Checks the progress of a chunked upload made with `v3PutProjectImageUpload`, or downloads the finished file.\n\n- **With chunk parameters** (`resumableChunkNumber` and friends): returns 200 if that chunk is already stored, or 204 if it still needs to be sent. Use this to resume an interrupted upload without re-sending data.\n- **Without them:** downloads the image file.","tags":["Projects"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"ID of the project. Get it from `v3ListProjects`, or from the `id` returned when the project was created.","example":"1c41b1bc-4f53-48a8-b690-ad30611e1960"},"required":true,"description":"ID of the project. Get it from `v3ListProjects`, or from the `id` returned when the project was created.","name":"projectId","in":"path"},{"schema":{"type":"string","enum":["iotfirmware","kernel","devicetree","ramdisk","loaderfile","media","sepfw","seprom","bootrom","llb","iboot","ibootdata","fw","fwasset","partition","extension","vmfile","backup","activity-export","ufd","mast-wordlist","mast-report","mast-frida","pongo","clbi"],"description":"What kind of file this is, for example `fw` for firmware or `kernel`. Uses the same values as `type` on `POST /v3/images`; see `ImageType` for what each means. Types that need a license feature your license lacks are rejected with 403."},"required":true,"description":"What kind of file this is, for example `fw` for firmware or `kernel`. Uses the same values as `type` on `POST /v3/images`; see `ImageType` for what each means. Types that need a license feature your license lacks are rejected with 403.","name":"type","in":"path"},{"schema":{"type":"string","format":"uuid","description":"An ID you choose for the new image: generate a random UUID once per file and use the same value for every chunk of that file. The image record is created with this ID when the first chunk arrives. Use a new UUID for each new upload."},"required":true,"description":"An ID you choose for the new image: generate a random UUID once per file and use the same value for every chunk of that file. The image record is created with this ID when the first chunk arrives. Use a new UUID for each new upload.","name":"imageId","in":"path"},{"schema":{"type":"string","description":"The file name to store, URL-encoded (for example `my%20firmware.ipsw`). Becomes the image `name`."},"required":true,"description":"The file name to store, URL-encoded (for example `my%20firmware.ipsw`). Becomes the image `name`.","name":"name","in":"path"},{"schema":{"type":"integer","description":"Chunk number. When present the response reports whether that chunk was already stored (200) or still needs to be uploaded (204) instead of returning the image file."},"required":false,"description":"Chunk number. When present the response reports whether that chunk was already stored (200) or still needs to be uploaded (204) instead of returning the image file.","name":"resumableChunkNumber","in":"query"}],"responses":{"200":{"description":"An empty JSON object when a probed chunk is already stored, the image bytes when the file is stored locally, or the image metadata when no file has been stored yet.","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary","description":"Image file contents."}},"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":{"nullable":true}}}}},"204":{"description":"The probed chunk is not stored yet and still needs to be uploaded."},"302":{"description":"The image is stored in S3; follow the Location header to download it.","headers":{"Location":{"schema":{"type":"string","format":"uri","description":"URL the client is redirected to.","example":"https://storage.example.com/images/3e1354a3-fb10-46c0-8b05-56e28edbde69/file?X-Amz-Expires=900&X-Amz-Signature=<signature>"},"required":true,"description":"URL the client is redirected to."}}},"400":{"description":"The image identifier is invalid or the image record is missing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"No image with the given identifier.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiNotFoundError"}}}}}},"put":{"operationId":"v3PutProjectImageUpload","x-sdk-method":"projects.putImageUpload","summary":"Upload image chunk","description":"Uploads one chunk of a file into this project, using the same resumable protocol as `PUT /v3/images/{imageId}/file`. The difference is that you choose the image ID yourself (a new random UUID) and the image record is created automatically when the first chunk arrives, so no `POST /v3/images` call is needed. The `type` and `name` in the path set the image type and name. The image belongs to the project and is deleted with it. The web interface uses this route when uploading firmware while creating a device. For your own code, `POST /v3/images` followed by `PUT /v3/images/{imageId}/file` is easier to follow. Returns 200 with an empty object for each stored chunk. If an upload fails for a reason other than a network error, the partial image is deleted.","tags":["Projects"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"ID of the project. Get it from `v3ListProjects`, or from the `id` returned when the project was created.","example":"1c41b1bc-4f53-48a8-b690-ad30611e1960"},"required":true,"description":"ID of the project. Get it from `v3ListProjects`, or from the `id` returned when the project was created.","name":"projectId","in":"path"},{"schema":{"type":"string","enum":["iotfirmware","kernel","devicetree","ramdisk","loaderfile","media","sepfw","seprom","bootrom","llb","iboot","ibootdata","fw","fwasset","partition","extension","vmfile","backup","activity-export","ufd","mast-wordlist","mast-report","mast-frida","pongo","clbi"],"description":"What kind of file this is, for example `fw` for firmware or `kernel`. Uses the same values as `type` on `POST /v3/images`; see `ImageType` for what each means. Types that need a license feature your license lacks are rejected with 403."},"required":true,"description":"What kind of file this is, for example `fw` for firmware or `kernel`. Uses the same values as `type` on `POST /v3/images`; see `ImageType` for what each means. Types that need a license feature your license lacks are rejected with 403.","name":"type","in":"path"},{"schema":{"type":"string","format":"uuid","description":"An ID you choose for the new image: generate a random UUID once per file and use the same value for every chunk of that file. The image record is created with this ID when the first chunk arrives. Use a new UUID for each new upload."},"required":true,"description":"An ID you choose for the new image: generate a random UUID once per file and use the same value for every chunk of that file. The image record is created with this ID when the first chunk arrives. Use a new UUID for each new upload.","name":"imageId","in":"path"},{"schema":{"type":"string","description":"The file name to store, URL-encoded (for example `my%20firmware.ipsw`). Becomes the image `name`."},"required":true,"description":"The file name to store, URL-encoded (for example `my%20firmware.ipsw`). Becomes the image `name`.","name":"name","in":"path"},{"schema":{"type":"integer","nullable":true,"description":"Which chunk this is, counting from 1."},"required":false,"description":"Which chunk this is, counting from 1.","name":"resumableChunkNumber","in":"query"},{"schema":{"type":"integer","nullable":true,"description":"The size, in bytes, you split the file into. Use the same value for every chunk; only the last chunk may be smaller. If you send `corelliumChecksum`, this must equal the block size inside it."},"required":false,"description":"The size, in bytes, you split the file into. Use the same value for every chunk; only the last chunk may be smaller. If you send `corelliumChecksum`, this must equal the block size inside it.","name":"resumableChunkSize","in":"query"},{"schema":{"type":"integer","nullable":true,"description":"Actual size in bytes of this chunk's body."},"required":false,"description":"Actual size in bytes of this chunk's body.","name":"resumableCurrentChunkSize","in":"query"},{"schema":{"type":"integer","nullable":true,"description":"Size of the whole file in bytes."},"required":false,"description":"Size of the whole file in bytes.","name":"resumableTotalSize","in":"query"},{"schema":{"type":"integer","nullable":true,"description":"How many chunks the whole file is split into. The upload completes when the last one arrives."},"required":false,"description":"How many chunks the whole file is split into. The upload completes when the last one arrives.","name":"resumableTotalChunks","in":"query"},{"schema":{"type":"string","description":"Optional expected checksum of the whole file, formatted `algorithm$blockSize$hash`. When given, the finished upload is checked and rejected (and the image removed) if it does not match. Required for firmware (`fw`) uploads on air-gapped deployments."},"required":false,"description":"Optional expected checksum of the whole file, formatted `algorithm$blockSize$hash`. When given, the finished upload is checked and rejected (and the image removed) if it does not match. Required for firmware (`fw`) uploads on air-gapped deployments.","name":"corelliumChecksum","in":"query"},{"schema":{"type":"string","description":"Device model (`flavor` from `GET /v3/models`) the image is for. Needed for `partition` uploads when the image is not attached to a device, so the partition name can be checked against that model."},"required":false,"description":"Device model (`flavor` from `GET /v3/models`) the image is for. Needed for `partition` uploads when the image is not attached to a device, so the partition name can be checked against that model.","name":"flavor","in":"query"},{"schema":{"type":"string","enum":["plain","encrypted"],"description":"How the file is stored: `plain` (normal) or `encrypted`. Only read on the first chunk, when the image record is created; later chunks cannot change it."},"required":false,"description":"How the file is stored: `plain` (normal) or `encrypted`. Only read on the first chunk, when the image record is created; later chunks cannot change it.","name":"x-corellium-image-encoding","in":"header"},{"schema":{"type":"boolean","description":"Whether the uploaded file is a ZIP wrapper the platform should unpack. Send false to store the file exactly as uploaded. Only read on the first chunk, when the image record is created."},"required":false,"description":"Whether the uploaded file is a ZIP wrapper the platform should unpack. Send false to store the file exactly as uploaded. Only read on the first chunk, when the image record is created.","name":"x-corellium-image-encapsulated","in":"header"},{"schema":{"type":"integer","nullable":true,"description":"Size of the whole file in bytes. Send it on every chunk: the platform uses it to check up front that there is room for the entire file, and answers 507 if there is not, before storing any data."},"required":false,"description":"Size of the whole file in bytes. Send it on every chunk: the platform uses it to check up front that there is room for the entire file, and answers 507 if there is not, before storing any data.","name":"x-corellium-total-file-size","in":"header"},{"schema":{"type":"string","description":"Password of a password-protected file (for example encrypted firmware), used to check the file after upload. Leave out for normal files."},"required":false,"description":"Password of a password-protected file (for example encrypted firmware), used to check the file after upload. Leave out for normal files.","name":"x-corellium-image-password","in":"header"}],"requestBody":{"required":true,"content":{"application/octet-stream":{"schema":{"type":"string","format":"binary","description":"Raw bytes of this chunk, or of the whole file when unchunked."}}}},"responses":{"200":{"description":"Chunk stored. The body is an empty JSON object. Send the next chunk; the image is finished when the last chunk arrives.","content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":{"nullable":true}}}}},"400":{"description":"Invalid chunk or upload parameters, unreadable body, or a missing/mismatched corelliumChecksum for a firmware upload.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"No image with the given identifier.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiNotFoundError"}}}},"507":{"description":"The image pool does not have enough space for this upload.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InsufficientStorageError"}}}}}}},"/v3/teams":{"get":{"operationId":"v3ListTeams","x-sdk-method":"teams.list","summary":"List teams","description":"Lists the teams in your domain. A team is a named group of users; giving a team a role on a project (with the Roles endpoints) gives every member that access, which is easier than granting each user separately. Includes the built-in `all-users` team, which always contains everyone in the domain. Available for Enterprise accounts only.","tags":["Teams"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"integer","minimum":1,"maximum":1000,"default":100,"description":"Most results to return in one page. Whole number from 1 to 1000; defaults to 100. A value outside that range is rejected with 400."},"required":false,"description":"Most results to return in one page. Whole number from 1 to 1000; defaults to 100. A value outside that range is rejected with 400.","name":"limit","in":"query"},{"schema":{"type":"integer","nullable":true,"minimum":0,"default":0,"description":"How many results to skip before this page starts; defaults to 0. To get the next page, add `limit` to the previous `offset`."},"required":false,"description":"How many results to skip before this page starts; defaults to 0. To get the next page, add `limit` to the previous `offset`.","name":"offset","in":"query"}],"responses":{"200":{"description":"Paginated list of teams.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TeamsListResponse"}}}},"400":{"description":"The request was invalid, for example a missing or malformed field. The body says which field; fix it before retrying.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}},"post":{"operationId":"v3CreateTeam","x-required-roles":["domain-administrator"],"x-sdk-method":"teams.create","summary":"Create a team","description":"**Required role:** Domain administrator.\n\nCreates an empty team in your domain and returns its ID. Requires a domain administrator. Next, add members with `v3AddUserToTeam` and give the team project access with `PUT /v3/roles/projects/{projectId}/teams/{teamId}/roles/{roleId}`. Available for Enterprise accounts only.","tags":["Teams"],"security":[{"BearerAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateTeamBody"}}}},"responses":{"201":{"description":"Team created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TeamCreated"}}}},"400":{"description":"The request was invalid, for example a missing or malformed field. The body says which field; fix it before retrying.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"403":{"description":"Domain administrator permissions required. Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-badges":[{"name":"Domain administrator"}]}},"/v3/teams/{teamId}":{"patch":{"operationId":"v3UpdateTeam","x-required-roles":["domain-administrator"],"x-sdk-method":"teams.update","summary":"Update a team","description":"**Required role:** Domain administrator.\n\nRenames a team or changes its settings. Requires a domain administrator. Available for Enterprise accounts only.","tags":["Teams"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Team identifier.","example":"089c8ffd-ca4d-4d35-80ab-0847d18b7213"},"required":true,"description":"Team identifier.","name":"teamId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateTeamBody"}}}},"responses":{"204":{"description":"Team updated."},"403":{"description":"Domain administrator permissions required. Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"No team with the given teamId.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiNotFoundError"}}}}},"x-badges":[{"name":"Domain administrator"}]},"delete":{"operationId":"v3DeleteTeam","x-required-roles":["domain-administrator"],"x-sdk-method":"teams.delete","summary":"Delete a team","description":"**Required role:** Domain administrator.\n\nDeletes a team. Requires a domain administrator. The users in it are not deleted, but they lose any project access they had only through this team. Available for Enterprise accounts only.\n\nDeletes are idempotent: a `teamId` that does not exist, including one that was already deleted, is a successful no-op that still returns 204, and\nrepeated calls return 204 as well. A 404 means the request path did not match a delete route, not\nthat the target was missing.","tags":["Teams"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Team identifier.","example":"089c8ffd-ca4d-4d35-80ab-0847d18b7213"},"required":true,"description":"Team identifier.","name":"teamId","in":"path"}],"responses":{"204":{"description":"Team deleted."},"403":{"description":"Domain administrator permissions required. Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-badges":[{"name":"Domain administrator"}]}},"/v3/teams/{teamId}/users/{userId}":{"put":{"operationId":"v3AddUserToTeam","x-required-roles":["domain-administrator"],"x-sdk-method":"teams.addUser","summary":"Add a user to a team","description":"**Required role:** Domain administrator.\n\nAdds a user to a team, so the user gets every project role the team has. Requires a domain administrator. Available for Enterprise accounts only.","tags":["Teams"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Team identifier.","example":"089c8ffd-ca4d-4d35-80ab-0847d18b7213"},"required":true,"description":"Team identifier.","name":"teamId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"User identifier.","example":"e8c5b7ea-aa5f-4a4a-bdca-0c67060b5320"},"required":true,"description":"User identifier.","name":"userId","in":"path"}],"responses":{"204":{"description":"User added to team."},"403":{"description":"Domain administrator permissions required. Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-badges":[{"name":"Domain administrator"}]},"delete":{"operationId":"v3RemoveUserFromTeam","x-required-roles":["domain-administrator"],"x-sdk-method":"teams.removeUser","summary":"Remove a user from a team","description":"**Required role:** Domain administrator.\n\nRemoves a user from a team, so the user loses the project access they had only through this team. Requires a domain administrator. Available for Enterprise accounts only.\n\nRemoval is idempotent: if the user is not a member of the team, the call is a no-op and still returns 204.\nRepeated calls therefore also return 204. A `teamId` or `userId` that does not exist is also a successful\nno-op that returns 204.","tags":["Teams"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Team identifier.","example":"089c8ffd-ca4d-4d35-80ab-0847d18b7213"},"required":true,"description":"Team identifier.","name":"teamId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"User identifier.","example":"e8c5b7ea-aa5f-4a4a-bdca-0c67060b5320"},"required":true,"description":"User identifier.","name":"userId","in":"path"}],"responses":{"204":{"description":"User removed from team, or was not a member."},"403":{"description":"Domain administrator permissions required. Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-badges":[{"name":"Domain administrator"}]}},"/v3/totp/generate":{"post":{"operationId":"v3GenerateTotp","x-sdk-method":"totp.generate","summary":"Generate a TOTP secret","description":"Step 1 of turning on two-factor sign-in (TOTP: six-digit codes from an authenticator app such as Google Authenticator, 1Password or Authy). Creates a new secret and returns it both as text (`secret`) and as a QR code image. Show the QR code to the user to scan with their authenticator app, or let them type the secret in.\n\nNothing is turned on yet, and the secret is not saved: two-factor sign-in starts only after step 2, `v3EnableTotp`, succeeds. Keep the `secret` value; step 2 needs it. Calling this again creates a different secret. Returns 403 if your deployment is not licensed for two-factor sign-in.","tags":["TOTP"],"security":[{"BearerAuth":[]}],"responses":{"200":{"description":"Generated TOTP secret and QR code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TotpGenerateResponse"}}}},"400":{"description":"Invalid token format.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"401":{"description":"Invalid login token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Multi-factor authentication is not licensed for this deployment.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"User not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiNotFoundError"}}}}}}},"/v3/totp/enable":{"post":{"operationId":"v3EnableTotp","x-sdk-method":"totp.enable","summary":"Enable TOTP for this user","description":"Step 2 of turning on two-factor sign-in. Send the `secret` from `v3GenerateTotp`, the current six-digit code (`totpToken`) the authenticator app shows for it, and your account `password`. If the password is right and the code matches, two-factor sign-in is turned on and a confirmation email is sent.\n\nFrom then on, signing in with a username and password also needs `totpToken` (see `v3AuthLogin`). The response is a fresh login result with a new session token; use it for later requests. Returns 401 if the password or code is wrong; generate a new code and retry.","tags":["TOTP"],"security":[{"BearerAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TotpEnableBody"}}}},"responses":{"200":{"description":"TOTP enabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoginResult"}}}},"400":{"description":"The request was invalid, for example a missing or malformed field. The body says which field; fix it before retrying.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"401":{"description":"Invalid login token, password, or TOTP token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Multi-factor authentication is not licensed for this deployment.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"User not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiNotFoundError"}}}}}}},"/v3/totp/disable":{"post":{"operationId":"v3DisableTotp","x-sdk-method":"totp.disable","summary":"Disable TOTP for this user","description":"Turns two-factor sign-in off for your account. Send your `password` and a current six-digit code (`totpToken`) from your authenticator app. On success a confirmation email is sent, signing in no longer needs a code, and the response is a fresh login result with a new session token. Returns 401 if the password or code is wrong.","tags":["TOTP"],"security":[{"BearerAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TotpDisableBody"}}}},"responses":{"200":{"description":"TOTP disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoginResult"}}}},"400":{"description":"The request was invalid, for example a missing or malformed field. The body says which field; fix it before retrying.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"401":{"description":"Invalid login token, password, or TOTP token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Multi-factor authentication is not licensed for this deployment.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v3/users":{"post":{"operationId":"v3CreateUser","x-required-roles":["domain-administrator"],"x-sdk-method":"users.create","summary":"Create a user","description":"**Required role:** Domain administrator.\n\nCreates a user account in your domain directly, with a username and password you choose, without sending an invitation. Requires a domain administrator. Returns 201 with the new user's ID. To let people set their own password instead, invite them with `POST /v3/invites`. A new user has no project access until you grant it with the Roles endpoints or add them to a team.","tags":["Users"],"security":[{"BearerAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateUserBody"}}}},"responses":{"201":{"description":"User created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserCreated"}}}},"400":{"description":"The request was invalid, for example a missing or malformed field. The body says which field; fix it before retrying.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"403":{"description":"Domain administrator permissions required. Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-badges":[{"name":"Domain administrator"}]}},"/v3/users/me":{"patch":{"operationId":"v3UpdateOwnProfile","x-sdk-method":"users.updateProfile","summary":"Update your profile","description":"Updates the caller's own display name. Needs no administrator role. Users created through an authentication provider cannot change their label, because the provider owns it.","tags":["Users"],"security":[{"BearerAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateOwnProfileBody"}}}},"responses":{"204":{"description":"Profile updated."},"400":{"description":"The label is missing, empty, or longer than 100 characters; the body has a field other than `label`; or the user was created through an authentication provider.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"401":{"description":"The session token is missing, invalid, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v3/users/{userId}":{"patch":{"operationId":"v3PatchUser","x-sdk-method":"users.patch","summary":"Update a user","description":"Changes a user's account details, such as their name, display label, email or password. Send only the fields you want to change. Only cluster administrators may set or change `clusterAdministrator`, which gives a user control over the whole cluster.","tags":["Users"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"User identifier.","example":"e8c5b7ea-aa5f-4a4a-bdca-0c67060b5320"},"required":true,"description":"User identifier.","name":"userId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchUserBody"}}}},"responses":{"204":{"description":"User updated."},"400":{"description":"The request was invalid, for example a missing or malformed field. The body says which field; fix it before retrying.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}},"delete":{"operationId":"v3DeleteUser","x-required-roles":["domain-administrator"],"x-sdk-method":"users.delete","summary":"Delete a user","description":"**Required role:** Domain administrator.\n\nDeletes the user identified by the given userId.\n\nDeletes are idempotent: a `userId` that does not exist, including one that was already deleted, is a successful no-op that still returns 204, and\nrepeated calls return 204 as well. A 404 means the request path did not match a delete route, not\nthat the target was missing.","tags":["Users"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"User identifier.","example":"e8c5b7ea-aa5f-4a4a-bdca-0c67060b5320"},"required":true,"description":"User identifier.","name":"userId","in":"path"}],"responses":{"204":{"description":"User deleted."},"403":{"description":"Domain administrator permissions required. Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-badges":[{"name":"Domain administrator"}]}},"/v3/users/agree":{"post":{"operationId":"v3AgreeToTerms","x-sdk-method":"users.agreeToTerms","summary":"Agree to terms","description":"Records that you, the signed-in user, accept the current terms and conditions, and returns the time of agreement. The web interface calls this when it shows the terms; call it yourself if your domain requires agreement before using the platform.","tags":["Users"],"security":[{"BearerAuth":[]}],"responses":{"200":{"description":"Terms accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgreedAck"}}}},"401":{"description":"The session token is missing, invalid, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v3/users/change-password":{"post":{"operationId":"v3ChangePassword","x-sdk-method":"users.changePassword","summary":"Change password","description":"Changes a password when you know the current one. Needs no sign-in: send the user's ID in `user`, the current password in `oldPassword`, and the new one in `newPassword`. Returns 204 on success and 403 if the old password is wrong. If you have forgotten the password, use the reset flow instead (`v3SendResetLink`).","tags":["Users"],"security":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChangePasswordBody"}}}},"responses":{"204":{"description":"Password changed."},"400":{"description":"The request was invalid, for example a missing or malformed field. The body says which field; fix it before retrying.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"401":{"description":"The user does not exist or the old password is wrong.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidCredentialsError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v3/users/reset-password":{"post":{"operationId":"v3ResetPassword","x-sdk-method":"users.resetPassword","summary":"Reset password","description":"Step 3 of resetting a forgotten password. Send the `token` from the reset email, the `newPassword`, and, if the account has two-factor sign-in turned on, a current six-digit code in `totpToken`. Returns 204 when the password has been changed; sign in with the new password.\n\n**Reset flow:**\n1. `v3SendResetLink` with the account's email address.\n2. Optionally `v3GetResetLinkInfo` with the token from the email, to show which account is being reset.\n3. `v3ResetPassword` (this call).\n\nReturns 401 if the token is invalid or expired, or the two-factor code is wrong.","tags":["Users"],"security":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResetPasswordBody"}}}},"responses":{"204":{"description":"Password reset."},"400":{"description":"Password reset token must be supplied.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"401":{"description":"The one-time code is incorrect, or the reset token failed verification.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResetUnauthorizedResponse"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v3/users/send-reset-link":{"post":{"operationId":"v3SendResetLink","x-sdk-method":"users.sendResetLink","summary":"Send a password reset link","description":"Step 1 of resetting a forgotten password: emails a password reset link to the given address, if it belongs to an account in the domain you are calling. Needs no sign-in. Always returns 204, whether or not the address matched an account, so the response does not reveal which emails are registered. The link contains the token used by `v3ResetPassword`.","tags":["Users"],"security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendResetLinkBody"}}}},"responses":{"204":{"description":"Reset link sent (if the email matched an account)."},"400":{"description":"The request body failed validation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v3/users/reset-link-info":{"post":{"operationId":"v3GetResetLinkInfo","x-sdk-method":"users.getResetLinkInfo","summary":"Get reset link info","description":"Step 2 (optional) of resetting a forgotten password: checks the token from a reset email and returns the account it belongs to (user ID, username and domain), so a reset page can show whose password is being changed. Needs no sign-in. Returns 400 or 401 if the token is missing, invalid or expired.","tags":["Users"],"security":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetResetLinkInfoBody"}}}},"responses":{"200":{"description":"Reset link info.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResetLinkInfo"}}}},"400":{"description":"Token was not supplied, or is not a password reset token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"401":{"description":"The reset token failed verification: malformed, tampered with, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v3/auth/login":{"post":{"operationId":"v3AuthLogin","x-sdk-method":"auth.login","summary":"Log in","description":"**Start here.** Almost every other call needs you to prove who you are by sending a token in the `Authorization` header: `Authorization: Bearer <token>`. There are two kinds of token:\n\n- **API token (best for scripts and automation).** A long-lived key you create once, in the web interface or with `POST /v3/auth/apitoken`. It is shown only once, so store it safely. You can send it directly as the Bearer token on every request, or exchange it here for a session token by sending `apiToken`.\n- **Session token.** A short-lived token (a JWT) returned by this call. Send it as the Bearer token until `expiration`, then log in again or renew it by sending it back as `token`.\n\nSupply one of three credential types; when more than one is present they are resolved in this fixed order of precedence: (1) `username` + `password` (plus `totpToken`, a six-digit code from your authenticator app, when two-factor sign-in is enabled); (2) `token`, an existing session token, renewed for a fresh one; (3) `apiToken`, a persistent API key created by the user, not issued by login. The first credential type present wins and the rest are ignored. For example, sending both username/password and an apiToken authenticates via username/password. On success the response contains a newly-regenerated session token, its `expiration` time, and the session itself: the authenticated user and their domain. The apiToken is never returned. Renewing a Webplayer token instead returns the Webplayer session `identifier` and no `user`.\n\nA 403 means the credentials were wrong (or a required two-factor code was missing or wrong).","tags":["Authentication"],"security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoginBody"}}}},"responses":{"200":{"description":"Authentication succeeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoginResult"}}}},"400":{"description":"Missing or invalid credentials in the request body.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"403":{"description":"Invalid username or password.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v3/auth/logout":{"post":{"operationId":"v3AuthLogout","x-sdk-method":"auth.logout","summary":"Log out","description":"Ends the current session: the session token you send becomes invalid, so later requests with it fail with 401. For OpenID Connect (single sign-on) users this also ends the session with the identity provider. API tokens are not affected; remove one with `v3DeleteApiToken`.","tags":["Authentication"],"security":[{"BearerAuth":[]}],"responses":{"204":{"description":"Logout succeeded."},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v3/auth/apitoken":{"post":{"operationId":"v3GenerateApiToken","x-sdk-method":"auth.apiToken.generate","summary":"Generate API token","description":"Creates a new API token for you: a long-lived key for scripts, CI jobs and SDKs, so they do not need your password. The response contains the token; it is shown only this once and cannot be retrieved later, so store it somewhere safe (for example a secrets manager). Each user has one API token at a time: generating a new one replaces the old one, which stops working immediately. Use it as `Authorization: Bearer <apiToken>`, or exchange it for a session token with `v3AuthLogin`.","tags":["Authentication"],"security":[{"BearerAuth":[]}],"responses":{"200":{"description":"A freshly generated API token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiTokenResult"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}},"delete":{"operationId":"v3DeleteApiToken","x-sdk-method":"auth.apiToken.delete","summary":"Delete API token","description":"Deletes your API token, so it can no longer be used to sign in. Scripts using it will get 401 until you give them a new one from `v3GenerateApiToken`.\n\nDeletes are idempotent: a request made when no API token is saved is a successful no-op that still returns 204, and\nrepeated calls return 204 as well. A 404 means the request path did not match a delete route, not\nthat the target was missing.","tags":["Authentication"],"security":[{"BearerAuth":[]}],"responses":{"204":{"description":"The API token was deleted, or no token was saved."},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v3/auth/providers":{"get":{"operationId":"v3ListAuthProviders","x-sdk-method":"auth.providers.list","summary":"List authentication providers","description":"Lists the ways users can sign in to your domain, such as username and password or single sign-on (SSO) through an identity provider like Okta. Needs no sign-in, so a login page can call it to show the right buttons. To sign in with an SSO provider, send the user's browser to its `authorizationUrl`.","tags":["Authentication"],"security":[],"parameters":[{"schema":{"type":"integer","minimum":1,"maximum":1000,"default":100,"description":"Most results to return in one page. Whole number from 1 to 1000; defaults to 100. A value outside that range is rejected with 400."},"required":false,"description":"Most results to return in one page. Whole number from 1 to 1000; defaults to 100. A value outside that range is rejected with 400.","name":"limit","in":"query"},{"schema":{"type":"integer","nullable":true,"minimum":0,"default":0,"description":"How many results to skip before this page starts; defaults to 0. To get the next page, add `limit` to the previous `offset`."},"required":false,"description":"How many results to skip before this page starts; defaults to 0. To get the next page, add `limit` to the previous `offset`.","name":"offset","in":"query"}],"responses":{"200":{"description":"Paginated list of configured authentication providers.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthProvidersListResponse"}}}},"400":{"description":"The request was invalid, for example a missing or malformed field. The body says which field; fix it before retrying.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v3/auth/providers/types":{"get":{"operationId":"v3ListAuthProviderTypes","x-required-roles":["domain-administrator"],"x-sdk-method":"auth.providers.listTypes","summary":"List authentication provider types","description":"**Required role:** Domain administrator.\n\nReturn schemas describing the supported authentication provider types.","tags":["Authentication"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"integer","minimum":1,"maximum":1000,"default":100,"description":"Most results to return in one page. Whole number from 1 to 1000; defaults to 100. A value outside that range is rejected with 400."},"required":false,"description":"Most results to return in one page. Whole number from 1 to 1000; defaults to 100. A value outside that range is rejected with 400.","name":"limit","in":"query"},{"schema":{"type":"integer","nullable":true,"minimum":0,"default":0,"description":"How many results to skip before this page starts; defaults to 0. To get the next page, add `limit` to the previous `offset`."},"required":false,"description":"How many results to skip before this page starts; defaults to 0. To get the next page, add `limit` to the previous `offset`.","name":"offset","in":"query"}],"responses":{"200":{"description":"Paginated list of supported authentication provider types.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthProviderTypesListResponse"}}}},"400":{"description":"The request was invalid, for example a missing or malformed field. The body says which field; fix it before retrying.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"403":{"description":"Domain administrator permissions required. Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-badges":[{"name":"Domain administrator"}]}},"/v3/auth/providers/fetch-metadata":{"get":{"operationId":"v3FetchAuthProviderMetadata","x-sdk-method":"auth.providers.fetchMetadata","summary":"Fetch SAML metadata","description":"Fetch SAML metadata XML from a trusted provider URL. The URL must be HTTPS and from an allowed domain.","tags":["Authentication"],"security":[],"parameters":[{"schema":{"type":"string","format":"uri","description":"HTTPS URL of the SAML metadata endpoint to fetch.","example":"https://sso.okta.com/app/exk1a2b3c4d5e6f7g8h9/sso/saml/metadata"},"required":true,"description":"HTTPS URL of the SAML metadata endpoint to fetch.","name":"url","in":"query"}],"responses":{"200":{"description":"SAML metadata document.","content":{"application/xml":{"schema":{"type":"string","description":"XML document."}}}},"400":{"description":"Missing or non-HTTPS URL parameter.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"403":{"description":"The URL domain is not in the allowed list.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v3/auth/providers/{providerId}/authorization_url":{"get":{"operationId":"v3GetAuthProviderAuthorizationUrl","x-sdk-method":"auth.providers.getAuthorizationUrl","summary":"Get provider authorization URL","description":"Starts single sign-on with the given identity provider by redirecting the caller's browser there (302). Open this URL in a browser, not from a script: after the user signs in at the provider, the provider sends the browser back to the callback route, which finishes signing in.","tags":["Authentication"],"security":[],"parameters":[{"schema":{"type":"string","description":"Provider identifier.","example":"sso.example.com"},"required":true,"description":"Provider identifier.","name":"providerId","in":"path"},{"schema":{"type":"string","enum":["trial","signup","trial-granted"],"description":"Sign-up flow type."},"required":false,"description":"Sign-up flow type.","name":"type","in":"query"},{"schema":{"type":"string","description":"Sign-up code for subscriber invites and trial requests.","example":"INVITE1234"},"required":false,"description":"Sign-up code for subscriber invites and trial requests.","name":"code","in":"query"},{"schema":{"type":"string","description":"Sign-up email (may differ from SSO email).","example":"jane.doe@example.com"},"required":false,"description":"Sign-up email (may differ from SSO email).","name":"email","in":"query"},{"schema":{"type":"string","description":"Sign-up token for a team invite.","example":"<token>"},"required":false,"description":"Sign-up token for a team invite.","name":"token","in":"query"}],"responses":{"302":{"description":"Success — redirects the caller to the identity provider's authorization URL.","headers":{"Location":{"schema":{"type":"string","format":"uri","description":"URL the client is redirected to.","example":"https://idp.example.com/oauth2/authorize?client_id=corellium&response_type=code&redirect_uri=https%3A%2F%2Facme-corp.example.com%2Fapi%2Fv3%2Fauth%2Fproviders%2F8036ef76-8194-4a7c-95b2-42606a5d0171%2Fcallback&state=%3Cstate%3E"},"required":true,"description":"URL the client is redirected to."}}},"404":{"description":"No provider with the given providerId.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiNotFoundError"}}}}}}},"/v3/auth/providers/{providerId}/callback":{"get":{"operationId":"v3GetAuthProviderCallback","x-sdk-method":"auth.providers.getCallback","summary":"Authentication provider callback (GET)","description":"Handle the final authorization response from an SSO provider and redirect back to the client.","tags":["Authentication"],"security":[],"parameters":[{"schema":{"type":"string","description":"Provider identifier.","example":"sso.example.com"},"required":true,"description":"Provider identifier.","name":"providerId","in":"path"},{"schema":{"type":"string","description":"Error code from the provider.","example":"access_denied"},"required":false,"description":"Error code from the provider.","name":"error","in":"query"},{"schema":{"type":"string","description":"Error description from the provider.","example":"The user denied the request."},"required":false,"description":"Error description from the provider.","name":"error_description","in":"query"}],"responses":{"302":{"description":"Success — redirects the caller back to the application after handling the callback.","headers":{"Location":{"schema":{"type":"string","format":"uri","description":"URL the client is redirected to.","example":"/finish-login?t=<token>"},"required":true,"description":"URL the client is redirected to."}}}}},"post":{"operationId":"v3PostAuthProviderCallback","x-sdk-method":"auth.providers.postCallback","summary":"Authentication provider callback (POST)","description":"Handle the final authorization response from an SSO provider (POST binding) and redirect back to the client.","tags":["Authentication"],"security":[],"parameters":[{"schema":{"type":"string","description":"Provider identifier.","example":"sso.example.com"},"required":true,"description":"Provider identifier.","name":"providerId","in":"path"}],"responses":{"302":{"description":"Success — redirects the caller back to the application after handling the callback.","headers":{"Location":{"schema":{"type":"string","format":"uri","description":"URL the client is redirected to.","example":"/finish-login?t=<token>"},"required":true,"description":"URL the client is redirected to."}}}}}},"/v3/auth/providers/{providerId}/spmetadata":{"get":{"operationId":"v3GetAuthProviderSpMetadata","x-sdk-method":"auth.providers.getSpMetadata","summary":"Get service provider metadata","description":"Return the SAML service provider metadata XML for the given authentication provider.","tags":["Authentication"],"security":[],"parameters":[{"schema":{"type":"string","description":"Provider identifier.","example":"sso.example.com"},"required":true,"description":"Provider identifier.","name":"providerId","in":"path"}],"responses":{"200":{"description":"Service provider metadata document.","content":{"application/xml":{"schema":{"type":"string","description":"XML document."}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"The provider does not expose service provider metadata.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiNotFoundError"}}}}}}},"/v3/config":{"get":{"operationId":"v3GetConfig","x-sdk-method":"config.get","summary":"Get deployment configuration","description":"Returns how this Corellium deployment is set up: its version, whether it is on-site or cloud, whether it is air-gapped, the sign-in providers offered, limits such as the per-device snapshot limit (`snapshotLimit`) and the maximum kernel and ramdisk upload sizes, and which optional features are turned on. Needs no sign-in, so a client can call it first to adapt to the deployment before the user signs in. Build-time feature flags may add further boolean properties beyond those listed.","tags":["Config"],"security":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfigResponse"}}}}}}},"/v3/flavors/{flavorId}":{"get":{"operationId":"v3GetFrame","x-sdk-method":"flavors.getFrame","summary":"Get the device frame layout for a model","description":"Returns the layout of the on-screen device frame (the picture of the phone drawn around the screen) for a model: its size, where the screen sits inside it, and where the home button is. Use it to draw a device image around a screenshot or live display. `flavorId` is a model `flavor` from `GET /v3/models`. Returns 404 if the model has no frame.","tags":["Flavors"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","description":"Flavor ID.","example":"iphone8"},"required":true,"description":"Flavor ID.","name":"flavorId","in":"path"}],"responses":{"200":{"description":"Frame for the flavor.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlavorFrame"}}}},"404":{"description":"No frame found for the given flavor ID.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiNotFoundError"}}}}}}},"/v3/flavors/{flavorId}/image":{"get":{"operationId":"v3GetFrameImage","x-sdk-method":"flavors.getFrameImage","summary":"Get the device frame image for a model","description":"Downloads the picture of the device frame (the phone body drawn around the screen) for a model, to combine with the layout from `v3GetFrame`. Returns 404 if the model has no frame image.","tags":["Flavors"],"parameters":[{"schema":{"type":"string","description":"Flavor ID.","example":"iphone8"},"required":true,"description":"Flavor ID.","name":"flavorId","in":"path"}],"responses":{"200":{"description":"Frame image file.","content":{"application/octet-stream":{"schema":{"$ref":"#/components/schemas/FlavorImage"}}}},"404":{"description":"No frame image found for the given flavor ID.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiNotFoundError"}}}}}}},"/v3/flavors/{flavorId}/productimage":{"get":{"operationId":"v3GetProductImage","x-sdk-method":"flavors.getProductImage","summary":"Get the product image for a model","description":"Downloads a product picture of the device model, for example to show in a model picker. Returns 404 if the model has no product image.","tags":["Flavors"],"parameters":[{"schema":{"type":"string","description":"Flavor ID.","example":"iphone8"},"required":true,"description":"Flavor ID.","name":"flavorId","in":"path"}],"responses":{"200":{"description":"Product image file.","content":{"application/octet-stream":{"schema":{"$ref":"#/components/schemas/FlavorImage"}}}},"404":{"description":"No product image found for the given flavor ID.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiNotFoundError"}}}}}}},"/v3/instances/{instanceId}/hooks":{"get":{"operationId":"v3ListHooks","x-sdk-method":"hooks.list","summary":"List hypervisor hooks for an instance","description":"Lists the hypervisor hooks set up on a device. A hook is a small piece of code, written in a C-like or assembly-like language, that the hypervisor runs whenever the device executes a chosen memory address, without changing the software on the device. Use hooks to log values, change behavior, or bypass checks while testing. Results are paginated; `sort` orders them by creation date.","tags":["Hypervisor Hooks"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Instance identifier.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"required":true,"description":"Instance identifier.","name":"instanceId","in":"path"},{"schema":{"type":"integer","minimum":1,"maximum":1000,"default":100,"description":"Most results to return in one page. Whole number from 1 to 1000; defaults to 100. A value outside that range is rejected with 400."},"required":false,"description":"Most results to return in one page. Whole number from 1 to 1000; defaults to 100. A value outside that range is rejected with 400.","name":"limit","in":"query"},{"schema":{"type":"integer","nullable":true,"minimum":0,"default":0,"description":"How many results to skip before this page starts; defaults to 0. To get the next page, add `limit` to the previous `offset`."},"required":false,"description":"How many results to skip before this page starts; defaults to 0. To get the next page, add `limit` to the previous `offset`.","name":"offset","in":"query"},{"schema":{"type":"string","enum":["ASC","DESC"],"default":"DESC","description":"Sort order by creation date."},"required":false,"description":"Sort order by creation date.","name":"sort","in":"query"}],"responses":{"200":{"description":"List of hypervisor hooks.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HookList"}}}},"400":{"description":"Invalid query parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}},"post":{"operationId":"v3CreateHook","x-sdk-method":"hooks.create","summary":"Create a hypervisor hook for an instance","description":"Adds a hypervisor hook to a device: the `patch` code runs each time the device executes `address`. Hooks are enabled by default. Activate the device's hooks with `POST /v3/instances/{instanceId}/hooks/execute` and deactivate them with `.../hooks/clear`. Returns 201 with the new hook.","tags":["Hypervisor Hooks"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Instance identifier.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"required":true,"description":"Instance identifier.","name":"instanceId","in":"path"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateHookBody"}}}},"responses":{"201":{"description":"Hook created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Hook"}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v3/hooks/{hookId}":{"get":{"operationId":"v3GetHook","x-sdk-method":"hooks.get","summary":"Get a hypervisor hook by ID","description":"Returns one hypervisor hook, including its address, patch code and whether it is enabled.","tags":["Hypervisor Hooks"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Hook identifier.","example":"2a1192e8-c7de-4981-bc11-c87fd1f12d13"},"required":true,"description":"Hook identifier.","name":"hookId","in":"path"}],"responses":{"200":{"description":"Hook.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Hook"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"No hook with the given hookId.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiNotFoundError"}}}}}},"put":{"operationId":"v3UpdateHook","x-sdk-method":"hooks.update","summary":"Update a hypervisor hook","description":"Changes a hypervisor hook. Send only the fields you want to change, for example `enabled: false` to switch it off without deleting it. Returns the updated hook.","tags":["Hypervisor Hooks"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Hook identifier.","example":"2a1192e8-c7de-4981-bc11-c87fd1f12d13"},"required":true,"description":"Hook identifier.","name":"hookId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateHookBody"}}}},"responses":{"200":{"description":"Updated hook.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Hook"}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"No hook with the given hookId.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiNotFoundError"}}}}}},"delete":{"operationId":"v3DeleteHook","x-sdk-method":"hooks.delete","summary":"Delete a hypervisor hook","description":"Deletes a hypervisor hook from its device.\n\nDeletes are idempotent: an unknown `hookId`, or a hook that was already deleted, is a successful no-op that still returns 204, and\nrepeated calls return 204 as well. A 404 means the request path did not match a delete route, not\nthat the target was missing.","tags":["Hypervisor Hooks"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Hook identifier.","example":"2a1192e8-c7de-4981-bc11-c87fd1f12d13"},"required":true,"description":"Hook identifier.","name":"hookId","in":"path"}],"responses":{"204":{"description":"Hook deleted."},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v3/hypertune/hash":{"get":{"operationId":"v3HypertuneHash","x-sdk-method":"hypertune.hash","summary":"Get Hypertune state hash","description":"Returns a short fingerprint of the current feature-flag settings for this cluster. The web interface compares it with its cached copy and downloads the full settings with `v3HypertuneInit` only when it changes. Most API clients do not need this.","tags":["Hypertune"],"parameters":[{"schema":{"type":"string","description":"Hypertune access token."},"required":false,"description":"Hypertune access token.","name":"token","in":"query"},{"schema":{"type":"string","description":"Hypertune branch name."},"required":false,"description":"Hypertune branch name.","name":"branch","in":"query"},{"schema":{"type":"string","description":"URL-encoded Hypertune SDK request body."},"required":false,"description":"URL-encoded Hypertune SDK request body.","name":"body","in":"query"}],"responses":{"200":{"description":"Hypertune state hash.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HypertuneHashResponse"}}}}}}},"/v3/hypertune/init":{"get":{"operationId":"v3HypertuneInit","x-sdk-method":"hypertune.init","summary":"Get Hypertune initialization data","description":"Returns the full feature-flag settings for this cluster, which the web interface uses to decide which features to show. Most API clients do not need this; use `GET /v3/config` to learn what a deployment supports.","tags":["Hypertune"],"parameters":[{"schema":{"type":"string","description":"Hypertune access token."},"required":false,"description":"Hypertune access token.","name":"token","in":"query"},{"schema":{"type":"string","description":"Hypertune branch name."},"required":false,"description":"Hypertune branch name.","name":"branch","in":"query"},{"schema":{"type":"string","description":"URL-encoded Hypertune SDK request body."},"required":false,"description":"URL-encoded Hypertune SDK request body.","name":"body","in":"query"}],"responses":{"200":{"description":"Hypertune initialization data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HypertuneInitResponse"}}}}}}},"/v3/instances/{instanceId}/snapshots":{"get":{"operationId":"v3ListInstanceSnapshots","x-sdk-method":"snapshots.list","summary":"List instance snapshots","description":"Lists the snapshots saved for one device, with each snapshot's ID, name and status. A snapshot is a saved copy of the device's storage at a moment in time; restore it with `v3RestoreInstanceSnapshot` to put the device back to that state. Results are paginated with `limit` and `offset`.","tags":["Snapshots","Instances"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Instance identifier.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"required":true,"description":"Instance identifier.","name":"instanceId","in":"path"},{"schema":{"type":"integer","minimum":1,"maximum":1000,"default":100,"description":"Most results to return in one page. Whole number from 1 to 1000; defaults to 100. A value outside that range is rejected with 400."},"required":false,"description":"Most results to return in one page. Whole number from 1 to 1000; defaults to 100. A value outside that range is rejected with 400.","name":"limit","in":"query"},{"schema":{"type":"integer","nullable":true,"minimum":0,"default":0,"description":"How many results to skip before this page starts; defaults to 0. To get the next page, add `limit` to the previous `offset`."},"required":false,"description":"How many results to skip before this page starts; defaults to 0. To get the next page, add `limit` to the previous `offset`.","name":"offset","in":"query"}],"responses":{"200":{"description":"Paginated list of snapshots for the instance.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstanceSnapshotsList"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Instance not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiNotFoundError"}}}}}},"post":{"operationId":"v3CreateInstanceSnapshot","x-sdk-method":"snapshots.create","summary":"Create instance snapshot","description":"Saves a snapshot of the device's current state, so you can return to it later with `v3RestoreInstanceSnapshot`. Take one before a risky change (an app install, a jailbreak step, an OS change) to be able to undo it.\n\n**Running or off.** A device that is off can always be snapshotted. A running device can only be snapshotted if its model supports live snapshots; otherwise the request fails with 400, so stop the device first (`v3StopInstance`).\n\nThe snapshot is saved in the background: the response is the new snapshot with status `creating`. Poll `v3GetInstanceSnapshot` until it is ready. Each device can keep a limited number of snapshots (`snapshotLimit` in `GET /v3/config`); at the limit, delete an old one first.","tags":["Snapshots","Instances"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Instance identifier.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"required":true,"description":"Instance identifier.","name":"instanceId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSnapshotBody"}}}},"responses":{"200":{"description":"Created snapshot.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Snapshot"}}}},"400":{"description":"Instance not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v3/instances/{instanceId}/snapshots/{snapshotId}":{"get":{"operationId":"v3GetInstanceSnapshot","x-sdk-method":"snapshots.get","summary":"Get instance snapshot","description":"Returns one snapshot of this device, including its status. Poll it after `v3CreateInstanceSnapshot` until the snapshot has finished `creating`.","tags":["Snapshots","Instances"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Instance identifier.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"required":true,"description":"Instance identifier.","name":"instanceId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Snapshot identifier.","example":"c67af9c0-26cd-4233-9782-436c842b60db"},"required":true,"description":"Snapshot identifier.","name":"snapshotId","in":"path"}],"responses":{"200":{"description":"Instance snapshot details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Snapshot"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Instance or snapshot not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiNotFoundError"}}}}}},"patch":{"operationId":"v3PatchInstanceSnapshot","x-sdk-method":"snapshots.patch","summary":"Update an instance snapshot","description":"Renames a snapshot. Send the new `name`. Returns the updated snapshot.","tags":["Snapshots","Instances"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Instance identifier.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"required":true,"description":"Instance identifier.","name":"instanceId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Snapshot identifier.","example":"c67af9c0-26cd-4233-9782-436c842b60db"},"required":true,"description":"Snapshot identifier.","name":"snapshotId","in":"path"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSnapshotBody"}}}},"responses":{"200":{"description":"Updated snapshot.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Snapshot"}}}},"400":{"description":"Validation error or no changes provided.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}},"delete":{"operationId":"v3DeleteInstanceSnapshot","x-sdk-method":"snapshots.delete","summary":"Delete an instance snapshot","description":"Delete an instance snapshot. Deletion is asynchronous: the snapshot is marked `deleting` and\nthe call returns 204 before the underlying storage has been reclaimed.\n\nDeletes are idempotent: an unknown `snapshotId`, or an unknown `instanceId`, is a successful no-op that still returns 204, and\nrepeated calls return 204 as well. A 404 means the request path did not match a delete route, not\nthat the target was missing.\nA repeat therefore returns 204 both while the snapshot is still present in the `deleting` state and after\nit has disappeared.","tags":["Snapshots","Instances"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Instance identifier.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"required":true,"description":"Instance identifier.","name":"instanceId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Snapshot identifier.","example":"c67af9c0-26cd-4233-9782-436c842b60db"},"required":true,"description":"Snapshot identifier.","name":"snapshotId","in":"path"}],"responses":{"204":{"description":"Snapshot deleted; empty body."},"400":{"description":"Malformed snapshot ID.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v3/instances/{instanceId}/snapshots/{snapshotId}/restore":{"post":{"operationId":"v3RestoreInstanceSnapshot","x-sdk-method":"snapshots.restore","summary":"Restore instance snapshot","description":"Puts the device back to the state saved in a snapshot, replacing its current storage. Anything changed since the snapshot was taken is lost; take a new snapshot first if you want to keep it. The restore runs in the background and starts the device from the snapshot; returns 204 once it has been accepted. Poll `v3GetInstanceState` until the device is `on`.","tags":["Snapshots","Instances"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Instance identifier.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"required":true,"description":"Instance identifier.","name":"instanceId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Snapshot identifier.","example":"c67af9c0-26cd-4233-9782-436c842b60db"},"required":true,"description":"Snapshot identifier.","name":"snapshotId","in":"path"}],"responses":{"204":{"description":"Restore snapshot accepted."},"400":{"description":"Invalid snapshot ID.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v3/network/connections/{id}":{"get":{"operationId":"v3GetNetworkConnection","x-sdk-method":"netConnect.get","summary":"Fetch an existing Network Connection","description":"Returns one network connection: its settings and, for each project using it, the connection's current state there. A network connection routes a project's outbound device traffic through a network you control, such as a VPN or a VLAN. You must have the domain administrator or project administrator role to fetch a network connection.","tags":["NetConnect"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Network Connection Identifier.","example":"0eb5d1e7-2c10-42b1-95fc-30e4e4885cd7"},"required":true,"description":"Network Connection Identifier.","name":"id","in":"path"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProviderNetworkConnection"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"The resource does not exist, or you cannot see it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiNotFoundError"}}}}}},"put":{"operationId":"v3UpdateNetworkConnection","x-sdk-method":"netConnect.update","summary":"Update Network Connection","description":"Replaces all of a network connection's settings. To change only some of them, use `v3PartialUpdateNetworkConnection`. You must have the domain administrator role to update a network connection.","tags":["NetConnect"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Network Connection Identifier.","example":"0eb5d1e7-2c10-42b1-95fc-30e4e4885cd7"},"required":true,"description":"Network Connection Identifier.","name":"id","in":"path"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateNetworkConnectionBody"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProviderNetworkConnection"}}}},"400":{"description":"The request was invalid, for example a missing or malformed field. The body says which field; fix it before retrying.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}},"patch":{"operationId":"v3PartialUpdateNetworkConnection","x-sdk-method":"netConnect.patch","summary":"Update Network Connection (patch)","description":"Only updates the specified attributes. You must have the domain administrator role to update a network connection.","tags":["NetConnect"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Network Connection Identifier.","example":"0eb5d1e7-2c10-42b1-95fc-30e4e4885cd7"},"required":true,"description":"Network Connection Identifier.","name":"id","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartialUpdateNetworkConnectionBody"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProviderNetworkConnection"}}}},"400":{"description":"The request was invalid, for example a missing or malformed field. The body says which field; fix it before retrying.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}},"delete":{"operationId":"v3DeleteNetworkConnection","x-sdk-method":"netConnect.delete","summary":"Delete an existing Network Connection","description":"Delete an existing Network Connection. You must have the domain administrator role to delete a\nnetwork connection.\n\nDeletes are idempotent: an unknown `id`, or a connection that was already deleted, is a successful no-op that still returns 204, and\nrepeated calls return 204 as well. A 404 means the request path did not match a delete route, not\nthat the target was missing.\nA connection still attached to projects returns 400 unless `force` is set.","tags":["NetConnect"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Network Connection Identifier.","example":"0eb5d1e7-2c10-42b1-95fc-30e4e4885cd7"},"required":true,"description":"Network Connection Identifier.","name":"id","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"force":{"type":"boolean","default":false,"description":"Force the operation through constraint checks (e.g. stopping active instances)."}}}}}},"responses":{"204":{"description":"No content"},"400":{"description":"The network connection is still in use by one or more projects.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v3/network/connections":{"get":{"operationId":"v3ListNetworkConnections","x-sdk-method":"netConnect.list","summary":"List available network connections","description":"Lists the network connections set up in your domain. A network connection routes a project's outbound device traffic through a network you control, such as a VPN or a VLAN; a project uses one when its `settings.connection` is set to the connection's ID (see `PATCH /v3/projects/{projectId}`). You must have the domain administrator or project administrator role to list network connections.","tags":["NetConnect"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"integer","minimum":1,"maximum":1000,"default":100,"description":"Most results to return in one page. Whole number from 1 to 1000; defaults to 100. A value outside that range is rejected with 400."},"required":false,"description":"Most results to return in one page. Whole number from 1 to 1000; defaults to 100. A value outside that range is rejected with 400.","name":"limit","in":"query"},{"schema":{"type":"integer","nullable":true,"minimum":0,"default":0,"description":"How many results to skip before this page starts; defaults to 0. To get the next page, add `limit` to the previous `offset`."},"required":false,"description":"How many results to skip before this page starts; defaults to 0. To get the next page, add `limit` to the previous `offset`.","name":"offset","in":"query"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NetworkConnections"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}},"post":{"operationId":"v3CreateNetworkConnection","x-sdk-method":"netConnect.create","summary":"Create a new Network Connection","description":"Creates a network connection that projects can route their outbound device traffic through. Pick a provider type from `v3ListNetworkProviders` and supply its settings; for a VLAN, pick a physical interface from `v3ListNetworkInterfaces`. VLAN networks are only supported in bridged networking mode. Afterwards, attach it to a project by setting the project's `settings.connection`. You must have the domain administrator role to create a network connection.","tags":["NetConnect"],"security":[{"BearerAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateNetworkConnectionBody"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ProviderNetworkConnection"}}}}},"400":{"description":"The request was invalid, for example a missing or malformed field. The body says which field; fix it before retrying.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v3/network/providers":{"get":{"operationId":"v3ListNetworkProviders","x-sdk-method":"netConnect.listProviders","summary":"List available network providers","description":"Provides a list of registered network providers to be used when creating network connections via [`createNetworkConnection`](#tag/netconnect/POST/v3/network/connections). You must have the domain administrator role to list network providers.","tags":["NetConnect"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"integer","minimum":1,"maximum":1000,"default":100,"description":"Most results to return in one page. Whole number from 1 to 1000; defaults to 100. A value outside that range is rejected with 400."},"required":false,"description":"Most results to return in one page. Whole number from 1 to 1000; defaults to 100. A value outside that range is rejected with 400.","name":"limit","in":"query"},{"schema":{"type":"integer","nullable":true,"minimum":0,"default":0,"description":"How many results to skip before this page starts; defaults to 0. To get the next page, add `limit` to the previous `offset`."},"required":false,"description":"How many results to skip before this page starts; defaults to 0. To get the next page, add `limit` to the previous `offset`.","name":"offset","in":"query"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NetworkConnectionProviders"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v3/network/interfaces":{"get":{"operationId":"v3ListNetworkInterfaces","x-sdk-method":"netConnect.listInterfaces","summary":"List available physical network interfaces","description":"Lists the physical network ports on the server that can carry a VLAN network connection. Use one of these names when creating a VLAN connection. You must have the domain administrator role to list network interfaces.","tags":["NetConnect"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"integer","minimum":1,"maximum":1000,"default":100,"description":"Most results to return in one page. Whole number from 1 to 1000; defaults to 100. A value outside that range is rejected with 400."},"required":false,"description":"Most results to return in one page. Whole number from 1 to 1000; defaults to 100. A value outside that range is rejected with 400.","name":"limit","in":"query"},{"schema":{"type":"integer","nullable":true,"minimum":0,"default":0,"description":"How many results to skip before this page starts; defaults to 0. To get the next page, add `limit` to the previous `offset`."},"required":false,"description":"How many results to skip before this page starts; defaults to 0. To get the next page, add `limit` to the previous `offset`.","name":"offset","in":"query"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NetworkInterfaces"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v3/roles":{"get":{"operationId":"v3ListRoles","x-required-roles":["domain-administrator","project-administrator"],"x-sdk-method":"roles.list","summary":"List all role assignments for the caller's domain","description":"**Required role:** Domain administrator or project administrator.\n\nLists who has which role on which project in your domain, for both individual users and teams: each entry names a role and either a `user` or a `team`, plus the `project`. Use it to audit access. Requires a domain or project administrator. Available for Enterprise accounts only.","tags":["Roles"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"integer","minimum":1,"maximum":1000,"default":100,"description":"Most results to return in one page. Whole number from 1 to 1000; defaults to 100. A value outside that range is rejected with 400."},"required":false,"description":"Most results to return in one page. Whole number from 1 to 1000; defaults to 100. A value outside that range is rejected with 400.","name":"limit","in":"query"},{"schema":{"type":"integer","nullable":true,"minimum":0,"default":0,"description":"How many results to skip before this page starts; defaults to 0. To get the next page, add `limit` to the previous `offset`."},"required":false,"description":"How many results to skip before this page starts; defaults to 0. To get the next page, add `limit` to the previous `offset`.","name":"offset","in":"query"}],"responses":{"200":{"description":"Paginated list of role assignments.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RolesListResponse"}}}},"400":{"description":"The request was invalid, for example a missing or malformed field. The body says which field; fix it before retrying.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"403":{"description":"Domain administrator or project administrator permissions required. Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-badges":[{"name":"Domain or project administrator"}]}},"/v3/roles/deployments":{"get":{"operationId":"v3ListDeploymentRoles","x-required-roles":["domain-administrator","project-administrator"],"x-sdk-method":"roles.deployments.list","summary":"List deployment role assignments","description":"**Required role:** Domain administrator or project administrator.\n\nReturns paginated role assignments scoped to deployments. Available for Enterprise accounts only.","tags":["Roles"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"integer","minimum":1,"maximum":1000,"default":100,"description":"Most results to return in one page. Whole number from 1 to 1000; defaults to 100. A value outside that range is rejected with 400."},"required":false,"description":"Most results to return in one page. Whole number from 1 to 1000; defaults to 100. A value outside that range is rejected with 400.","name":"limit","in":"query"},{"schema":{"type":"integer","nullable":true,"minimum":0,"default":0,"description":"How many results to skip before this page starts; defaults to 0. To get the next page, add `limit` to the previous `offset`."},"required":false,"description":"How many results to skip before this page starts; defaults to 0. To get the next page, add `limit` to the previous `offset`.","name":"offset","in":"query"}],"responses":{"200":{"description":"Paginated list of deployment role assignments.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RolesListResponse"}}}},"400":{"description":"The request was invalid, for example a missing or malformed field. The body says which field; fix it before retrying.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"403":{"description":"Domain administrator or project administrator permissions required. Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-badges":[{"name":"Domain or project administrator"}]}},"/v3/roles/projects/{projectId}/users/{userId}/roles/{roleId}":{"put":{"operationId":"v3AddUserRoleToProject","x-required-roles":["domain-administrator","project-administrator"],"x-sdk-method":"roles.projects.addUser","summary":"Add user role to project","description":"**Required role:** Domain administrator or project administrator.\n\nGives a user a role on a project: `member` to use the project and its devices, or `admin` to also manage it. This is how a new user gets access to a project. Requires a domain administrator, or a project administrator of that project. Returns 404 if the project, user or role does not exist. Available for Enterprise accounts only.","tags":["Roles"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Project identifier.","example":"1c41b1bc-4f53-48a8-b690-ad30611e1960"},"required":true,"description":"Project identifier.","name":"projectId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"User identifier.","example":"e8c5b7ea-aa5f-4a4a-bdca-0c67060b5320"},"required":true,"description":"User identifier.","name":"userId","in":"path"},{"schema":{"type":"string","description":"Role to grant or remove: `admin` or `member`. See `RoleName`.","example":"admin"},"required":true,"description":"Role to grant or remove: `admin` or `member`. See `RoleName`.","name":"roleId","in":"path"}],"responses":{"204":{"description":"Role assigned."},"400":{"description":"The request was invalid, for example a missing or malformed field. The body says which field; fix it before retrying.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"403":{"description":"Domain administrator or project administrator permissions required. Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Project, user, or role not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiNotFoundError"}}}}},"x-badges":[{"name":"Domain or project administrator"}]},"delete":{"operationId":"v3RemoveUserRoleFromProject","x-required-roles":["domain-administrator","project-administrator"],"x-sdk-method":"roles.projects.removeUser","summary":"Remove user role from project","description":"**Required role:** Domain administrator or project administrator.\n\nTakes a role on a project away from a user, so they lose that access (unless they also have it through a team). Requires a domain administrator, or a project administrator of that project. Available for Enterprise accounts only.\n\nRevocation is idempotent: if the user does not currently hold that role in the project, the call is a\nno-op and still returns 204. Repeated calls therefore also return 204. A `projectId` or `userId` that does not exist\nis also a successful no-op that returns 204. A project administrator acting on another\nproject in their own domain receives 403.\nAn unrecognized `roleId` returns 400.","tags":["Roles"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Project identifier.","example":"1c41b1bc-4f53-48a8-b690-ad30611e1960"},"required":true,"description":"Project identifier.","name":"projectId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"User identifier.","example":"e8c5b7ea-aa5f-4a4a-bdca-0c67060b5320"},"required":true,"description":"User identifier.","name":"userId","in":"path"},{"schema":{"type":"string","description":"Role to grant or remove: `admin` or `member`. See `RoleName`.","example":"admin"},"required":true,"description":"Role to grant or remove: `admin` or `member`. See `RoleName`.","name":"roleId","in":"path"}],"responses":{"204":{"description":"Role removed, or the user did not hold the role."},"400":{"description":"Unrecognized role.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"403":{"description":"Domain administrator or project administrator permissions required. Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-badges":[{"name":"Domain or project administrator"}]}},"/v3/roles/projects/{projectId}/teams/{teamId}/roles/{roleId}":{"put":{"operationId":"v3AddTeamRoleToProject","x-required-roles":["domain-administrator","project-administrator"],"x-sdk-method":"roles.projects.addTeam","summary":"Add team role to project","description":"**Required role:** Domain administrator or project administrator.\n\nGives every member of a team a role on a project. Pass `all-users` as `teamId` to give the role to everyone in your domain. People added to the team later get the access automatically. Requires a domain administrator, or a project administrator of that project. Available for Enterprise accounts only.","tags":["Roles"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Project identifier.","example":"1c41b1bc-4f53-48a8-b690-ad30611e1960"},"required":true,"description":"Project identifier.","name":"projectId","in":"path"},{"schema":{"type":"string","description":"Team ID from `GET /v3/teams`, or `all-users` to grant the role to everyone in your domain at once.","example":"089c8ffd-ca4d-4d35-80ab-0847d18b7213"},"required":true,"description":"Team ID from `GET /v3/teams`, or `all-users` to grant the role to everyone in your domain at once.","name":"teamId","in":"path"},{"schema":{"type":"string","description":"Role to grant or remove: `admin` or `member`. See `RoleName`.","example":"admin"},"required":true,"description":"Role to grant or remove: `admin` or `member`. See `RoleName`.","name":"roleId","in":"path"}],"responses":{"204":{"description":"Role assigned."},"400":{"description":"The request was invalid, for example a missing or malformed field. The body says which field; fix it before retrying.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"403":{"description":"Domain administrator or project administrator permissions required. Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Project, team, or role not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiNotFoundError"}}}}},"x-badges":[{"name":"Domain or project administrator"}]},"delete":{"operationId":"v3RemoveTeamRoleFromProject","x-required-roles":["domain-administrator","project-administrator"],"x-sdk-method":"roles.projects.removeTeam","summary":"Remove team role from project","description":"**Required role:** Domain administrator or project administrator.\n\nTakes a role on a project away from a team, so its members lose the access they had through it. Requires a domain administrator, or a project administrator of that project. Available for Enterprise accounts only.\n\nRevocation is idempotent: if the team does not currently hold that role in the project, the call is a\nno-op and still returns 204. Repeated calls therefore also return 204. A `projectId` or `teamId` that does not exist\nis also a successful no-op that returns 204. A project administrator acting on another\nproject in their own domain receives 403.\nAn unrecognized `roleId` returns 400.","tags":["Roles"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Project identifier.","example":"1c41b1bc-4f53-48a8-b690-ad30611e1960"},"required":true,"description":"Project identifier.","name":"projectId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Team identifier.","example":"089c8ffd-ca4d-4d35-80ab-0847d18b7213"},"required":true,"description":"Team identifier.","name":"teamId","in":"path"},{"schema":{"type":"string","description":"Role to grant or remove: `admin` or `member`. See `RoleName`.","example":"admin"},"required":true,"description":"Role to grant or remove: `admin` or `member`. See `RoleName`.","name":"roleId","in":"path"}],"responses":{"204":{"description":"Role removed, or the team did not hold the role."},"400":{"description":"Unrecognized role.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"403":{"description":"Domain administrator or project administrator permissions required. Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-badges":[{"name":"Domain or project administrator"}]}},"/v3/roles/deployments/{deploymentId}/users/{userId}/roles/{roleId}":{"put":{"operationId":"v3AddUserRoleToDeployment","x-required-roles":["domain-administrator"],"x-sdk-method":"roles.deployments.addUser","summary":"Add user role to deployment","description":"**Required role:** Domain administrator.\n\nGrants a user a role within a deployment. Available for Enterprise accounts only.","tags":["Roles"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","description":"Deployment identifier.","example":"prod-us-east"},"required":true,"description":"Deployment identifier.","name":"deploymentId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"User identifier.","example":"e8c5b7ea-aa5f-4a4a-bdca-0c67060b5320"},"required":true,"description":"User identifier.","name":"userId","in":"path"},{"schema":{"type":"string","description":"Role identifier.","example":"admin"},"required":true,"description":"Role identifier.","name":"roleId","in":"path"}],"responses":{"204":{"description":"Role assigned."},"400":{"description":"The request was invalid, for example a missing or malformed field. The body says which field; fix it before retrying.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"403":{"description":"Domain administrator permissions required. Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Deployment, user, or role not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiNotFoundError"}}}}},"x-badges":[{"name":"Domain administrator"}]},"delete":{"operationId":"v3RemoveUserRoleFromDeployment","x-required-roles":["domain-administrator"],"x-sdk-method":"roles.deployments.removeUser","summary":"Remove user role from deployment","description":"**Required role:** Domain administrator.\n\nRevokes a user role within a deployment. Available for Enterprise accounts only.\n\nRevocation is idempotent: if the user does not currently hold that role in the deployment, the call is a\nno-op and still returns 204. Repeated calls therefore also return 204. A `deploymentId` or `userId` that does not exist\nis also a successful no-op that returns 204.","tags":["Roles"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","description":"Deployment identifier.","example":"prod-us-east"},"required":true,"description":"Deployment identifier.","name":"deploymentId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"User identifier.","example":"e8c5b7ea-aa5f-4a4a-bdca-0c67060b5320"},"required":true,"description":"User identifier.","name":"userId","in":"path"},{"schema":{"type":"string","description":"Role identifier.","example":"admin"},"required":true,"description":"Role identifier.","name":"roleId","in":"path"}],"responses":{"204":{"description":"Role removed, or the user did not hold the role."},"400":{"description":"The request was invalid, for example a missing or malformed field. The body says which field; fix it before retrying.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"403":{"description":"Domain administrator permissions required. Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-badges":[{"name":"Domain administrator"}]}},"/v3/roles/deployments/{deploymentId}/teams/{teamId}/roles/{roleId}":{"put":{"operationId":"v3AddTeamRoleToDeployment","x-required-roles":["domain-administrator"],"x-sdk-method":"roles.deployments.addTeam","summary":"Add team role to deployment","description":"**Required role:** Domain administrator.\n\nGrants a team a role within a deployment. Available for Enterprise accounts only.","tags":["Roles"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","description":"Deployment identifier.","example":"prod-us-east"},"required":true,"description":"Deployment identifier.","name":"deploymentId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Team identifier.","example":"089c8ffd-ca4d-4d35-80ab-0847d18b7213"},"required":true,"description":"Team identifier.","name":"teamId","in":"path"},{"schema":{"type":"string","description":"Role identifier.","example":"admin"},"required":true,"description":"Role identifier.","name":"roleId","in":"path"}],"responses":{"204":{"description":"Role assigned."},"400":{"description":"The request was invalid, for example a missing or malformed field. The body says which field; fix it before retrying.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"403":{"description":"Domain administrator permissions required. Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Deployment, team, or role not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiNotFoundError"}}}}},"x-badges":[{"name":"Domain administrator"}]},"delete":{"operationId":"v3RemoveTeamRoleFromDeployment","x-required-roles":["domain-administrator"],"x-sdk-method":"roles.deployments.removeTeam","summary":"Remove team role from deployment","description":"**Required role:** Domain administrator.\n\nRevokes a team role within a deployment. Available for Enterprise accounts only.\n\nRevocation is idempotent: if the team does not currently hold that role in the deployment, the call is a\nno-op and still returns 204. Repeated calls therefore also return 204. A `deploymentId` or `teamId` that does not exist\nis also a successful no-op that returns 204.","tags":["Roles"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","description":"Deployment identifier.","example":"prod-us-east"},"required":true,"description":"Deployment identifier.","name":"deploymentId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Team identifier.","example":"089c8ffd-ca4d-4d35-80ab-0847d18b7213"},"required":true,"description":"Team identifier.","name":"teamId","in":"path"},{"schema":{"type":"string","description":"Role identifier.","example":"admin"},"required":true,"description":"Role identifier.","name":"roleId","in":"path"}],"responses":{"204":{"description":"Role removed, or the team did not hold the role."},"400":{"description":"The request was invalid, for example a missing or malformed field. The body says which field; fix it before retrying.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"403":{"description":"Domain administrator permissions required. Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-badges":[{"name":"Domain administrator"}]}},"/v3/ready":{"get":{"operationId":"v3Ready","x-sdk-method":"status.ready","summary":"Check that the API is ready","description":"Health check. Returns 204 (no body) when the API is up and accepting requests, and 503 while it is shutting down. Needs no sign-in, so monitoring tools and scripts can call it before doing real work, for example to wait for a deployment to come back after an upgrade.","tags":["Status"],"responses":{"204":{"description":"API is ready for queries."},"503":{"description":"API is not ready.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v3/storage":{"get":{"operationId":"v3ListStorage","x-sdk-method":"storage.list","summary":"List server-attached storage devices","description":"Lists the physical storage devices (for example USB drives or disks) plugged into an on-site Corellium server, with their name, filesystem, label, vendor, whether they are mounted, and whether they are mounted read-only (`RO`) or read-write (`RW`). Use a device's `id` with `v3ListStorageFiles` to browse its contents. For cluster administrators on on-site deployments; not available on cloud installations. Results are paginated and can be filtered and sorted with the query parameters.","tags":["Storage"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"integer","minimum":1,"maximum":1000,"default":100,"description":"Most results to return in one page. Whole number from 1 to 1000; defaults to 100. A value outside that range is rejected with 400."},"required":false,"description":"Most results to return in one page. Whole number from 1 to 1000; defaults to 100. A value outside that range is rejected with 400.","name":"limit","in":"query"},{"schema":{"type":"integer","nullable":true,"minimum":0,"default":0,"description":"How many results to skip before this page starts; defaults to 0. To get the next page, add `limit` to the previous `offset`."},"required":false,"description":"How many results to skip before this page starts; defaults to 0. To get the next page, add `limit` to the previous `offset`.","name":"offset","in":"query"},{"schema":{"type":"string","description":"Sort order (prefix a field with \"-\" for descending).","example":"-createdAt"},"required":false,"description":"Sort order (prefix a field with \"-\" for descending).","name":"sort","in":"query"},{"schema":{"type":"string","description":"Filter by identifier (comma separated).","example":"73357171-23a0-4a3e-8661-216dbfbdd7ab,9f2b6c04-58ad-4d61-b0e7-1ac9d8e07f35"},"required":false,"description":"Filter by identifier (comma separated).","name":"identifier","in":"query"},{"schema":{"type":"string","description":"Filter by device name (partial match).","example":"sdb"},"required":false,"description":"Filter by device name (partial match).","name":"device","in":"query"},{"schema":{"type":"string","description":"Filter by filesystem type (comma separated).","example":"ext4,exfat"},"required":false,"description":"Filter by filesystem type (comma separated).","name":"fsType","in":"query"},{"schema":{"type":"string","enum":["RO","RW"],"description":"Filter by mount policy."},"required":false,"description":"Filter by mount policy.","name":"mountPolicy","in":"query"},{"schema":{"type":"string","enum":["mounted","unmounted"],"description":"Filter by mount status."},"required":false,"description":"Filter by mount status.","name":"status","in":"query"}],"responses":{"200":{"description":"List of storage devices.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StorageList"}}}},"400":{"description":"The request was invalid, for example a missing or malformed field. The body says which field; fix it before retrying.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v3/storage/{id}/files/{path}":{"get":{"operationId":"v3ListStorageFiles","x-sdk-method":"storage.listFiles","summary":"List storage files","description":"Lists the files and folders at one path on a server-attached storage device (see `v3ListStorage`), with each entry's name, type, size and modification time. Use `/` to list the top level, then pass a folder's path to go deeper. The path must be a folder; a file path returns 400, and paths that try to leave the device (for example with `..`) are rejected. Returns 404 if the device or path does not exist.","tags":["Storage"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Storage device identifier.","example":"73357171-23a0-4a3e-8661-216dbfbdd7ab"},"required":true,"description":"Storage device identifier.","name":"id","in":"path"},{"schema":{"type":"string","description":"Folder to list, relative to the top of the storage device. Slashes are kept as path separators.","example":"/var/mobile/Media"},"required":true,"description":"Folder to list, relative to the top of the storage device. Slashes are kept as path separators.","name":"path","in":"path","x-sdk-preserve-slashes":true},{"schema":{"type":"integer","minimum":1,"maximum":1000,"default":100,"description":"Most results to return in one page. Whole number from 1 to 1000; defaults to 100. A value outside that range is rejected with 400."},"required":false,"description":"Most results to return in one page. Whole number from 1 to 1000; defaults to 100. A value outside that range is rejected with 400.","name":"limit","in":"query"},{"schema":{"type":"integer","nullable":true,"minimum":0,"default":0,"description":"How many results to skip before this page starts; defaults to 0. To get the next page, add `limit` to the previous `offset`."},"required":false,"description":"How many results to skip before this page starts; defaults to 0. To get the next page, add `limit` to the previous `offset`.","name":"offset","in":"query"},{"schema":{"type":"string","description":"Sort order (prefix a field with \"-\" for descending).","example":"-lastModifiedTime"},"required":false,"description":"Sort order (prefix a field with \"-\" for descending).","name":"sort","in":"query"},{"schema":{"type":"string","description":"Filter by name (case-insensitive exact match, comma separated).","example":"firmware.ipsw,boot.img"},"required":false,"description":"Filter by name (case-insensitive exact match, comma separated).","name":"name","in":"query"},{"schema":{"type":"string","description":"Filter by type (case-insensitive partial match, e.g. \"file\" or \"dir\").","example":"file"},"required":false,"description":"Filter by type (case-insensitive partial match, e.g. \"file\" or \"dir\").","name":"type","in":"query"}],"responses":{"200":{"description":"List of files and directories.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StorageFileList"}}}},"400":{"description":"Invalid path or query parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"No storage device or path with the given identifier.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiNotFoundError"}}}}}}},"/v3/version":{"get":{"operationId":"v3GetVersion","x-sdk-method":"version.get","summary":"Get the platform version","description":"Returns which version of the Corellium platform you are talking to: the product version (for example `7.4.0-28212`), plus the build it came from. Include it when reporting a problem to support, or check it to see whether a feature you need is available on this deployment.","tags":["Config"],"security":[{"BearerAuth":[]}],"responses":{"200":{"description":"Version and build identity of the running deployment.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeploymentVersion"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v3/webplayer":{"post":{"operationId":"v3CreateWebPlayerSession","x-required-roles":["domain-administrator"],"x-sdk-method":"webPlayer.create","summary":"Create a webplayer session","description":"**Required role:** Domain administrator.\n\nCreates a Web Player session: a limited token that lets someone use one device, embedded in your own web page, without giving them a Corellium account. Requires a domain administrator.\n\nChoose the device (`projectId`, `instanceId`), how long the session lasts (`expiresIn`, at least 1800 seconds), and which parts of the device interface the viewer may use (`features`). Pass the returned `token` to the Web Player in your page. The website domains configured for embedding are listed by `v3GetWebPlayerAllowedDomains` and set with `webplayer.allowedDomains` on `PATCH /v3/domain`. End the session early with `v3DeleteWebPlayerSession`.","tags":["WebPlayer"],"security":[{"BearerAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateWebPlayerSessionBody"}}}},"responses":{"200":{"description":"Session created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebPlayerCreatedSession"}}}},"400":{"description":"The request was invalid, for example a missing or malformed field. The body says which field; fix it before retrying.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Domain administrator permissions required. Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-badges":[{"name":"Domain administrator"}]},"get":{"operationId":"v3ListWebPlayerSessions","x-required-roles":["domain-administrator"],"x-sdk-method":"webPlayer.list","summary":"List webplayer sessions","description":"**Required role:** Domain administrator.\n\nLists the Web Player sessions in your domain, with each session's ID, token and expiration. Requires a domain administrator. Results are paginated with `limit` and `offset`.","tags":["WebPlayer"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"integer","minimum":1,"maximum":1000,"default":100,"description":"Most results to return in one page. Whole number from 1 to 1000; defaults to 100. A value outside that range is rejected with 400."},"required":false,"description":"Most results to return in one page. Whole number from 1 to 1000; defaults to 100. A value outside that range is rejected with 400.","name":"limit","in":"query"},{"schema":{"type":"integer","nullable":true,"minimum":0,"default":0,"description":"How many results to skip before this page starts; defaults to 0. To get the next page, add `limit` to the previous `offset`."},"required":false,"description":"How many results to skip before this page starts; defaults to 0. To get the next page, add `limit` to the previous `offset`.","name":"offset","in":"query"}],"responses":{"200":{"description":"Paginated list of webplayer sessions.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebPlayerSessionListResponse"}}}},"400":{"description":"The request was invalid, for example a missing or malformed field. The body says which field; fix it before retrying.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Domain administrator permissions required. Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-badges":[{"name":"Domain administrator"}]}},"/v3/webplayer/allowedDomains":{"get":{"operationId":"v3GetWebPlayerAllowedDomains","x-sdk-method":"webPlayer.getAllowedDomains","summary":"Get allowed webplayer domains","description":"Returns the website domains configured for embedding the Web Player (`webplayer.allowedDomains` in your domain settings). Change the list with `PATCH /v3/domain`.","tags":["WebPlayer"],"security":[{"BearerAuth":[]}],"responses":{"200":{"description":"Allowed domains.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebPlayerAllowedDomains"}}}},"400":{"description":"The request was invalid, for example a missing or malformed field. The body says which field; fix it before retrying.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v3/webplayer/{sessionId}":{"get":{"operationId":"v3GetWebPlayerSession","x-required-roles":["domain-administrator"],"x-sdk-method":"webPlayer.get","summary":"Get a webplayer session","description":"**Required role:** Domain administrator.\n\nReturns one Web Player session, including its token and expiration. Requires a domain administrator.","tags":["WebPlayer"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Webplayer session identifier.","example":"a3569608-10e1-41c7-99fa-1a7d1f336c58"},"required":true,"description":"Webplayer session identifier.","name":"sessionId","in":"path"}],"responses":{"200":{"description":"The webplayer session.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/WebPlayerSession"}}}}},"400":{"description":"The request was invalid, for example a missing or malformed field. The body says which field; fix it before retrying.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Domain administrator permissions required. Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"No session with the given sessionId.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiNotFoundError"}}}}},"x-badges":[{"name":"Domain administrator"}]},"delete":{"operationId":"v3DeleteWebPlayerSession","x-required-roles":["domain-administrator"],"x-sdk-method":"webPlayer.delete","summary":"Delete a webplayer session","description":"**Required role:** Domain administrator.\n\nEnds a Web Player session: its token stops working, so the embedded viewer loses access to the device. Requires a domain administrator. The device itself is not affected.\n\nDeletes are idempotent: an unknown `sessionId` is a successful no-op that still returns 204, and\nrepeated calls return 204 as well. A 404 means the request path did not match a delete route, not\nthat the target was missing.","tags":["WebPlayer"],"security":[{"BearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Webplayer session identifier.","example":"a3569608-10e1-41c7-99fa-1a7d1f336c58"},"required":true,"description":"Webplayer session identifier.","name":"sessionId","in":"path"}],"responses":{"204":{"description":"Session torn down, or no such session; empty body."},"400":{"description":"The request was invalid, for example a missing or malformed field. The body says which field; fix it before retrying.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserErrorResponse"}}}},"401":{"description":"Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Domain administrator permissions required. Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-badges":[{"name":"Domain administrator"}]}}},"components":{"schemas":{"Interconnect":{"type":"object","properties":{"name":{"type":"string","minLength":1,"description":"A name to recognise the interconnect by.","example":"vpn-gateway"},"type":{"type":"string","enum":["hub","switch"],"description":"How the interconnect behaves: `hub` passes every signal to every connected interface; `switch` routes traffic between endpoints."},"projectId":{"type":"string","format":"uuid","description":"Project the interconnect belongs to. Every device listed in `interfaces` must be in this project, otherwise the request fails with 400. Cannot be changed later.","example":"1c41b1bc-4f53-48a8-b690-ad30611e1960"},"interfaces":{"$ref":"#/components/schemas/InterfacesSchema"},"id":{"type":"string","format":"uuid","description":"The interconnect identifier.","example":"56494514-33f7-4fc2-9fdc-865e3957e6d3"},"protocol":{"type":"string","minLength":1,"description":"The protocol used by the interconnect.","example":"eth"},"status":{"type":"string","enum":["attached","detached","connected"],"description":"The current status of the interconnect."},"instanceCount":{"type":"integer","minimum":0,"description":"Number of unique instances connected to this interconnect.","example":2},"createdAt":{"type":"string","format":"date-time","description":"Creation timestamp.","example":"2026-03-14T09:12:47.000Z"},"updatedAt":{"type":"string","format":"date-time","description":"Last update timestamp.","example":"2026-03-17T11:41:05.000Z"}},"required":["name","type","projectId","interfaces","id","protocol","status","instanceCount","createdAt","updatedAt"]},"InterfacesSchema":{"type":"array","items":{"type":"object","properties":{"deviceId":{"type":"string","format":"uuid","description":"ID of the device (instance) whose interface to connect.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"interfaceId":{"type":"string","pattern":"^[a-z0-9:]+\\/[0-9]+$","description":"Which interface on that device, written `<name>/<number>` (for example `eth0:1/2` or `gpio/0`). The device model decides which interfaces exist.","example":"eth0:1/2"}},"required":["deviceId","interfaceId"]}},"UserErrorResponse":{"anyOf":[{"$ref":"#/components/schemas/UserError"},{"$ref":"#/components/schemas/UserErrors"}]},"UserError":{"type":"object","properties":{"error":{"type":"string","description":"Human-readable explanation of what was wrong with the request. Show it to the user or log it; do not parse it, because the wording can change.","example":"Invalid button requested to be held"},"errorID":{"type":"string","enum":["UserError"],"description":"Always `UserError`: the request itself was invalid. Fix the request before retrying; sending it again unchanged fails the same way."},"field":{"type":"string","description":"Name of the request field that was rejected, when the error is about one field.","example":"inputButtons"},"validator":{"type":"string","description":"Validator that rejected the field.","example":"isIn"},"projectIds":{"type":"array","items":{"type":"string"},"description":"Projects still using this resource, when the error is a usage conflict.","example":["1c41b1bc-4f53-48a8-b690-ad30611e1960"]},"missingFwAssets":{"type":"array","items":{"type":"string"},"description":"Firmware asset URLs required by the target firmware but absent from the domain, when field is 'firmware_asset'.","example":["https://example.com/firmware-assets/asset.bin"]}},"required":["error","errorID"]},"UserErrors":{"type":"object","properties":{"error":{"type":"string","description":"Summary of the problem. The individual problems are listed in `errors`.","example":"One or more fields were rejected"},"errorID":{"type":"string","enum":["UserErrors"],"description":"Always `UserErrors`: more than one field in the request was invalid."},"errors":{"type":"array","items":{"$ref":"#/components/schemas/UserError"},"description":"One entry per rejected field. Fix every one before retrying."}},"required":["error","errorID","errors"]},"ApiError":{"type":"object","properties":{"error":{"type":"string","description":"Human-readable explanation of the error.","example":"Access denied"},"errorID":{"type":"string","description":"Short machine-readable error name, for example `PermissionDenied` or `NotFound`. Use this, not `error`, to decide what to do in code.","example":"PermissionDenied"},"originalError":{"type":"string","description":"When the platform failed while talking to another service, the error that service reported. Useful when reporting a problem to support.","example":"connect ECONNREFUSED 192.0.2.10:443"}},"required":["error","errorID"]},"CreateInterconnectV3Body":{"type":"object","properties":{"name":{"type":"string","minLength":1,"description":"A name to recognise the interconnect by.","example":"vpn-gateway"},"type":{"type":"string","enum":["hub","switch"],"description":"How the interconnect behaves: `hub` passes every signal to every connected interface; `switch` routes traffic between endpoints."},"interfaces":{"$ref":"#/components/schemas/InterfacesSchema"},"projectId":{"type":"string","format":"uuid","description":"Project the interconnect belongs to. Every device listed in `interfaces` must be in this project, otherwise the request fails with 400. Cannot be changed later.","example":"1c41b1bc-4f53-48a8-b690-ad30611e1960"},"protocol":{"$ref":"#/components/schemas/InterconnectProtocol"}},"required":["name","type","interfaces","projectId","protocol"]},"InterconnectProtocol":{"type":"string","enum":["can","uart","i2c","spi","gpio","usbh","eth"],"description":"Kind of signal the interconnect carries, for example `eth` for Ethernet. Choose the protocol that matches the interfaces you connect. Cannot be changed later."},"InterconnectList":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/Interconnect"},"description":"Array of interconnects."},"count":{"type":"integer","minimum":0,"description":"Number of results in this page. Can be less than `limit` on the last page.","example":25},"total":{"type":"integer","minimum":0,"description":"Number of results across all pages, after any filters.","example":137},"limit":{"type":"integer","minimum":0,"description":"The page size that was used (your `limit`, or the default 100).","example":25},"offset":{"type":"integer","minimum":0,"description":"The offset that was used (your `offset`, or the default 0).","example":0},"hasMore":{"type":"boolean","description":"True if more results exist after this page. To read everything, keep requesting with `offset` increased by `limit` until this is false.","example":true}},"required":["results","count","total","limit","offset","hasMore"]},"UpdateInterconnectV3Body":{"type":"object","properties":{"name":{"type":"string","minLength":1,"description":"A name to recognise the interconnect by.","example":"vpn-gateway"},"interfaces":{"$ref":"#/components/schemas/InterfacesSchema"},"type":{"type":"string","enum":["hub","switch"],"description":"How the interconnect behaves: `hub` passes every signal to every connected interface; `switch` routes traffic between endpoints."},"projectId":{"type":"string","format":"uuid","description":"Project the interconnect belongs to. Every device listed in `interfaces` must be in this project, otherwise the request fails with 400. Cannot be changed later.","example":"1c41b1bc-4f53-48a8-b690-ad30611e1960"},"protocol":{"$ref":"#/components/schemas/InterconnectProtocol"}},"required":["name","interfaces"]},"PatchInterconnectBody":{"type":"object","properties":{"name":{"type":"string","minLength":1,"description":"A name to recognise the interconnect by.","example":"vpn-gateway"},"interfaces":{"$ref":"#/components/schemas/InterfacesSchema"}}},"Snapshot":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The snapshot identifier.","example":"c67af9c0-26cd-4233-9782-436c842b60db"},"name":{"type":"string","description":"The snapshot name.","example":"Clean boot"},"instance":{"type":"string","format":"uuid","description":"The UUID of the instance that this snapshot is of.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"status":{"$ref":"#/components/schemas/SnapshotStatus"},"date":{"type":"number","description":"Date that the snapshot was created (UNIX epoch milliseconds).","example":1773479567000},"fresh":{"type":"boolean","description":"Denotes whether snapshot was created immediately after the device was restored.","example":true},"live":{"type":"boolean","description":"Live snapshot (included state and memory).","example":false},"local":{"type":"boolean","description":"Denotes whether the snapshot has a local storage type.","example":true},"model":{"type":"string","description":"The device model.","example":"iPhone 13 Pro"},"sharing":{"$ref":"#/components/schemas/SnapshotSharing"}},"required":["id","name","instance","status","date","local","sharing"]},"SnapshotStatus":{"type":"object","properties":{"task":{"type":"string","description":"The current task being performed on the snapshot.","example":"none"},"created":{"type":"boolean","description":"Indicates if the snapshot has been successfully created.","example":true}},"description":"The status of the snapshot."},"SnapshotSharing":{"type":"object","properties":{"sharingType":{"$ref":"#/components/schemas/SnapshotSharingType"},"accessCode":{"type":"string","description":"Access code of shared snapshot.","example":"X7QK9P2M"},"sharedOn":{"type":"string","format":"date-time","description":"Date of when the snapshot was first shared with member.","example":"2026-03-16T08:22:19.000Z"},"sharedBy":{"$ref":"#/components/schemas/SnapshotOwner"},"members":{"type":"array","items":{"$ref":"#/components/schemas/SnapshotMember"},"description":"The email addresses or user ids of the members."}},"required":["sharingType"],"description":"The sharing information of the snapshot."},"SnapshotSharingType":{"type":"string","enum":["publicLink","domainRestrictedLink","passwordPublicLink","emailInvite","notShared"],"description":"Who can use a shared snapshot:\n- `publicLink`: anyone who has the access code.\n- `domainRestrictedLink`: only signed-in users in the owner's domain who have the access code.\n- `passwordPublicLink`: anyone who has the access code and the password.\n- `emailInvite`: only the people listed as members (see `v3SetSnapshotPermissions`).\n- `notShared`: sharing is turned off.\n\nEach type must also be allowed by your domain's snapshot sharing settings (`PATCH /v3/domain`); a type that is not allowed is refused with 403."},"SnapshotOwner":{"type":"object","properties":{"name":{"type":"string","description":"The name of the owner.","example":"Jane Doe"},"email":{"type":"string","description":"The email of the member.","example":"jane.doe@example.com"}},"required":["name","email"],"description":"The owner of the snapshot."},"SnapshotMember":{"type":"object","properties":{"email":{"type":"string","description":"The email of the member.","example":"jane.doe@example.com"},"inviteSentAt":{"type":"string","nullable":true,"format":"date-time","description":"The date when the invite was sent.","example":"2026-03-16T08:22:19.000Z"},"sharedOn":{"type":"string","format":"date-time","description":"Date of when the snapshot was first shared with member.","example":"2026-03-16T08:22:19.000Z"},"userId":{"type":"string","nullable":true,"format":"uuid","description":"The member's user ID.","example":"e8c5b7ea-aa5f-4a4a-bdca-0c67060b5320"},"name":{"type":"string","nullable":true,"description":"The user's label or name.","example":"Jane Doe"}},"required":["email","inviteSentAt"]},"ApiNotFoundError":{"type":"object","properties":{"error":{"type":"string","description":"Human-readable explanation of what was not found.","example":"instance with instanceId=f7f9832a-f824-416f-a5ea-4adfe34754b5 not found"},"errorID":{"type":"string","description":"Short machine-readable error name, usually `NotFound`.","example":"NotFound"},"name":{"type":"string","description":"Kind of object that was not found, for example `instance`.","example":"instance"},"params":{"type":"object","additionalProperties":{"nullable":true},"description":"The identifiers from your request that were looked up.","example":{"instanceId":"f7f9832a-f824-416f-a5ea-4adfe34754b5"}}},"required":["error","errorID"]},"ShareSnapshotBody":{"type":"object","properties":{"sharingType":{"$ref":"#/components/schemas/SnapshotSharingType"},"password":{"type":"string","nullable":true,"description":"Password to require from anyone accepting the snapshot. Required when sharingType is passwordPublicLink, and ignored for every other sharing type. Never returned by the API once set.","example":"<redacted>"}},"required":["sharingType"]},"AcceptSnapshotBody":{"type":"object","properties":{"accessCode":{"type":"string","description":"The access code the snapshot's owner gave you (shown in `sharing.accessCode` on their snapshot).","example":"X7QK9P2M"},"password":{"type":"string","nullable":true,"description":"Password of the shared snapshot, as set when it was shared. Required when the snapshot was shared with sharing type passwordPublicLink.","example":"<redacted>"}},"required":["accessCode"]},"SetSnapshotPermissionsBody":{"type":"object","properties":{"members":{"type":"array","items":{"type":"string"},"description":"The people who may use the snapshot, by email address or user ID. Used with sharing type `emailInvite`.","example":["jane.doe@example.com"]}},"required":["members"]},"SharedSnapshotsResponse":{"type":"object","properties":{"sharedWithUser":{"type":"array","items":{"$ref":"#/components/schemas/SharedSnapshot"},"description":"Snapshots shared with the logged-in user."},"sharedByUser":{"type":"array","items":{"$ref":"#/components/schemas/SharedSnapshot"},"description":"Snapshots shared by the logged-in user."}},"required":["sharedWithUser","sharedByUser"]},"SharedSnapshot":{"type":"object","properties":{"sharedOn":{"type":"string","format":"date-time","description":"Date of when the snapshot was first shared with member.","example":"2026-03-16T08:22:19.000Z"},"sharedWithMember":{"type":"string","description":"The member who the snapshot was shared with. Only present in sharedWithUser.","example":"jane.doe@example.com"},"sharingType":{"$ref":"#/components/schemas/SnapshotSharingType"},"sharedBy":{"$ref":"#/components/schemas/SnapshotOwner"},"id":{"type":"string","format":"uuid","description":"The snapshot identifier.","example":"c67af9c0-26cd-4233-9782-436c842b60db"},"date":{"type":"number","description":"Date that the snapshot was created (UNIX epoch milliseconds).","example":1773479567000},"hwPac":{"type":"number","description":"Denotes whether this snapshot requires a compute node with hardware PAC enabled.","example":1},"instance":{"type":"string","format":"uuid","description":"The UUID of the instance that this snapshot is of.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"live":{"type":"boolean","description":"Live snapshot (included state and memory).","example":false},"local":{"type":"boolean","description":"Denotes whether the snapshot has a local storage type.","example":true},"model":{"type":"string","default":"","description":"The device model.","example":"iPhone 13 Pro"},"type":{"type":"string","description":"Device type of the instance this snapshot belongs to.","example":"ios"},"name":{"type":"string","description":"The snapshot name.","example":"Clean boot"},"status":{"$ref":"#/components/schemas/SnapshotStatus"},"fresh":{"type":"boolean","description":"Denotes whether snapshot was created immediately after the device was restored.","example":true},"sharing":{"$ref":"#/components/schemas/SnapshotSharing"}},"required":["sharingType","id","date","hwPac","instance","local","name","status"]},"InstanceList":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/Instance"},"description":"Results for this page."},"count":{"type":"integer","minimum":0,"description":"Number of results in this page. Can be less than `limit` on the last page.","example":25},"total":{"type":"integer","minimum":0,"description":"Number of results across all pages, after any filters.","example":137},"limit":{"type":"integer","minimum":0,"description":"The page size that was used (your `limit`, or the default 100).","example":25},"offset":{"type":"integer","minimum":0,"description":"The offset that was used (your `offset`, or the default 0).","example":0},"hasMore":{"type":"boolean","description":"True if more results exist after this page. To read everything, keep requesting with `offset` increased by `limit` until this is false.","example":true}},"required":["results","count","total","limit","offset","hasMore"]},"Instance":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Instance identifier.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"name":{"type":"string","description":"Instance name.","example":"My iPhone 13 Pro"},"key":{"type":"string","description":"Key used to encrypt the instance (hex).","example":"<redacted>"},"flavor":{"type":"string","description":"The flavor identifier of this instance.","example":"iphone13p"},"flavorName":{"type":"string","description":"Human-readable flavor name.","example":"iPhone 13 Pro"},"type":{"type":"string","description":"Device type.","example":"ios"},"project":{"type":"string","format":"uuid","description":"The project ID of the project this instance belongs to.","example":"1c41b1bc-4f53-48a8-b690-ad30611e1960"},"domainName":{"type":"string","description":"Domain name associated with this instance's project.","example":"acme-corp"},"state":{"$ref":"#/components/schemas/InstanceState"},"stateChanged":{"type":"string","nullable":true,"format":"date-time","description":"Time the state of the instance last changed; null before the first transition.","example":"2026-03-16T08:22:19.000Z"},"startedAt":{"type":"string","nullable":true,"format":"date-time","description":"Time the instance was started, NULL if currently SHUTOFF.","example":"2026-03-16T08:22:19.000Z"},"userTask":{"type":"string","nullable":true,"description":"Currently executing user task.","example":"snapshot"},"taskState":{"$ref":"#/components/schemas/InstanceTaskState"},"error":{"type":"string","nullable":true,"description":"Current error state if any.","example":"Failed to start instance: insufficient capacity"},"restoreStatus":{"$ref":"#/components/schemas/InstanceRestoreStatus"},"readOnly":{"$ref":"#/components/schemas/InstanceReadOnlyStatus"},"bootOptions":{"$ref":"#/components/schemas/InstanceBootOptions"},"serviceIp":{"type":"string","description":"Services IP address.","example":"10.0.10.5"},"wifiIp":{"type":"string","description":"LAN IP address.","example":"192.168.1.50"},"wifiMac":{"type":"string","description":"WiFi MAC address.","example":"02:00:00:aa:bb:cc"},"secondaryIp":{"type":"string","description":"Secondary interface LAN IP address (if supported).","example":"192.168.1.51"},"portAdb":{"type":"string","description":"ADB port number.","example":"5555"},"portUsb":{"type":"string","description":"USB port number.","example":"2222"},"portGdb":{"type":"string","description":"GDB port number.","example":"5039"},"portSepGdb":{"type":"string","description":"SEP GDB port number.","example":"5040"},"portCons":{"type":"string","description":"Default console port number.","example":"2000"},"portSepCons":{"type":"string","description":"SEP console port number.","example":"2001"},"portSysCons":{"type":"string","description":"System console port number.","example":"2002"},"portUsbmuxd":{"type":"string","description":"USBMuxD port number.","example":"2003"},"portFrida":{"type":"string","description":"Frida instrumentation port number.","example":"27042"},"portSockcap":{"type":"string","description":"Socket capture port number.","example":"2004"},"portModelGw":{"type":"string","description":"Model gateway port number.","example":"2005"},"consoles":{"type":"array","items":{"$ref":"#/components/schemas/InstanceConsole"},"description":"Available console connections."},"interfaces":{"type":"array","items":{"$ref":"#/components/schemas/InstanceInterfaceStatus"},"description":"Available configurable interfaces and their attachment status."},"services":{"$ref":"#/components/schemas/InstanceServices"},"panicked":{"type":"boolean","description":"Whether the instance has panicked.","example":false},"created":{"type":"string","format":"date-time","description":"Time instance was created.","example":"2026-03-14T09:12:47.000Z"},"model":{"type":"string","description":"Model of virtual machine device.","example":"d63ap"},"fwPackage":{"type":"string","description":"URL that the package used to create this instance is available at.","example":"https://example.com/firmware.ipsw"},"osVersion":{"type":"string","description":"OS version.","example":"17.5"},"osBuild":{"type":"string","description":"OS build.","example":"21F79"},"agent":{"$ref":"#/components/schemas/InstanceAgentState"},"netMon":{"$ref":"#/components/schemas/InstanceNetmonState"},"netDump":{"$ref":"#/components/schemas/InstanceNetdumpState"},"coreTrace":{"$ref":"#/components/schemas/InstanceTraceState"},"hyperTrace":{"$ref":"#/components/schemas/InstanceHyperTraceState"},"exposePort":{"type":"string","nullable":true,"description":"Currently exposed port, if any.","example":"8080"},"fault":{"type":"boolean","nullable":true,"description":"Whether the instance is in a fault state.","example":false},"patches":{"type":"array","items":{"type":"string"},"description":"Patches applied to the instance.","example":["jailbroken"]},"createdBy":{"$ref":"#/components/schemas/CreatedBy"},"uefiBootloader":{"$ref":"#/components/schemas/InstanceUefiBootloader"},"orientation":{"type":"number","description":"Device orientation.","example":1},"mast":{"type":"boolean","description":"Whether MATRIX is enabled.","example":true},"wanAccess":{"type":"boolean","description":"Whether WAN access is enabled.","example":true}},"required":["id","name","key","flavor","type","project","state","stateChanged","startedAt","created"]},"InstanceState":{"type":"string","enum":["on","off","booting","deleting","creating","restoring","paused","rebooting","error"],"description":"What the device is doing right now.\n- `creating`: being built after `v3CreateInstance`. Not usable yet; poll until it changes.\n- `booting`: starting up. Wait for `on`.\n- `on`: running and usable.\n- `paused`: stopped mid-run and held in place; `v3UnpauseInstance` resumes it.\n- `rebooting`: restarting after `v3RebootInstance`.\n- `restoring`: being restored from a snapshot or backup.\n- `off`: shut down. `v3StartInstance` turns it on.\n- `deleting`: being removed after `v3DeleteInstance`.\n- `error`: something went wrong. See the instance's `error` field."},"InstanceTaskState":{"type":"string","description":"Current task state if any (e.g. 'none', 'starting', 'stopping', 'pausing', 'unpausing', 'rebooting', 'building').","example":"none"},"InstanceRestoreStatus":{"type":"object","properties":{"type":{"type":"string","description":"Restore type: 0=Not Restore, 1=Restore, 2=CloneFromSnapshot.","example":"1"},"stage":{"type":"string","description":"Restore stage.","example":"download-images"},"progress":{"anyOf":[{"type":"string"},{"type":"number"}],"description":"Stage progress (0-100). Serialized as a string when non-zero; emitted as the number 0 at the start of a restore, and absent when no restore is in progress.","example":"45"},"totalProgress":{"anyOf":[{"type":"string"},{"type":"number"}],"description":"Total restore progress (0-100). Serialized as a string when non-zero; emitted as the number 0 at the start of a restore, and absent when no restore is in progress.","example":"72"},"heading":{"type":"string","description":"Current heading for progress modal.","example":"Restoring device"},"description":{"type":"string","description":"Current description for progress modal.","example":"Extracting firmware components"}}},"InstanceReadOnlyStatus":{"type":"object","nullable":true,"properties":{"readOnlyStatus":{"type":"string","description":"Overall progress of flipping read-only state.","example":"disabling"}},"required":["readOnlyStatus"]},"InstanceBootOptions":{"type":"object","properties":{"bootArgs":{"type":"string","description":"Boot arguments passed to the kernel at normal boot.","example":"-v debug=0x8 keepsyms=1"},"restoreBootArgs":{"type":"string","description":"Boot arguments passed to the kernel during restore.","example":"-v debug=0x8 keepsyms=1"},"udid":{"type":"string","description":"Boot UDID.","example":"00008030-001A2D423C29802E"},"ecid":{"type":"string","description":"Assigned ECID (hex).","example":"0x1a2b3c4d5e6f"},"randomSeed":{"type":"string","description":"Random seed provided to boot, if any.","example":"deadbeefcafebabe"},"pac":{"type":"boolean","description":"Enable Pointer Authentication Codes (PAC), the Apple processor feature that signs pointers to block memory-corruption attacks.","example":true},"aprr":{"type":"boolean","description":"Enable APRR, the Apple processor feature that controls memory page permissions (used by kernel protections).","example":true},"cores":{"type":"number","description":"Number of CPU cores for the device. Only models whose `dynamicHardwareChanges` is true in `GET /v3/models` honor this; others always use the model default. The value must be between the model's `coresMin` and `coresMax`; a value outside that range is silently replaced by the model default rather than rejected, so check the device afterwards.","example":4},"ram":{"type":"number","description":"Memory for the device, in MiB (1024 MiB = 1 GiB). Only models whose `dynamicHardwareChanges` is true honor this; others always use the model default. The value must be between the model's `ramMin` and `ramMax`, and at most 1 GiB per CPU core; otherwise the request fails with 400.","example":6144},"additionalTags":{"type":"array","items":{"$ref":"#/components/schemas/CharmTag"},"description":"Additional boot tags to apply to the instance. Each value must be one of the supported charm boot tags.","example":["kalloc"]},"kernel":{"$ref":"#/components/schemas/InstanceBootOptionsKernel"},"pongo":{"$ref":"#/components/schemas/InstanceBootOptionsPongo"},"serial":{"type":"string","description":"Device serial number.","example":"C39ABCDEFGH1"},"noSnapshotMount":{"type":"boolean","description":"Do not mount iOS snapshot (iOS only).","example":false},"kernelSlide":{"type":"string","description":"Kernel slide value (iOS only).","example":"0x18000000"},"cdHashes":{"type":"array","items":{"type":"string"},"description":"Hashes of trusted binaries (iOS only).","example":["a1b2c3d4e5f60718293a4b5c6d7e8f90"]},"imei":{"type":"string","description":"IMEI.","example":"359268000000000"},"imsi":{"type":"string","description":"IMSI.","example":"310150123456789"},"ssid0":{"type":"string","description":"WiFi SSID.","example":"CorelliumWiFi"},"ssid1":{"type":"string","description":"Secondary WiFi SSID.","example":"CorelliumWiFi-5G"},"wifiMac":{"type":"string","description":"WiFi MAC address.","example":"02:00:00:aa:bb:cc"},"modelId":{"type":"string","description":"Device model identifier.","example":"SM-G973F"},"manufacturerId":{"type":"string","description":"Device manufacturer identifier.","example":"samsung"},"kernelPatches":{"type":"string","description":"Kernel patches to apply.","example":"patch1,patch2"},"stopOnFault":{"type":"boolean","default":true,"description":"Leaves the VM in the paused state on hypervisor vault if false."},"bootAddr":{"type":"string","description":"Boot address.","example":"0x800000000"},"tzen":{"type":"boolean","nullable":true,"description":"Enable TrustZone security.","example":true},"authorizedKeys":{"type":"string","description":"SSH authorized keys to install on the instance.","example":"ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIGFhYmJjY2RkZWVmZmdnaGhpaWpqa2trbGxtbW5ubm9v user@example.com"},"vMMIO":{"type":"array","items":{"type":"object","properties":{"start":{"type":"string","description":"Start address for beginning of vMMIO range.","example":"0x9000000"},"size":{"type":"string","description":"The size of the range to use for vMMIO.","example":"0x1000"},"irq":{"type":"string","description":"System IRQs, 1-16 ranges must be specified","example":"33-36"}},"required":["start","size","irq"]},"description":"Parameters to export a VM address space range (and IRQ & DMA functionality) over TCP to different models running on different machines or inside a different VM."},"fvp":{"$ref":"#/components/schemas/InstanceBootOptionsFvp"}}},"CharmTag":{"type":"string","enum":["kalloc","gpu","no-keyboard","nodevmode","sep-cons-ext","iboot-jailbreak","llb-jailbreak","rom-jailbreak","noappaslr","nodyldaslr","objdetect"],"description":"A valid charm boot tag."},"InstanceBootOptionsKernel":{"type":"object","properties":{"firmwarePath":{"type":"string","description":"Relative path within the firmware to the bundled kernel file.","example":"kernelcache"}},"required":["firmwarePath"]},"InstanceBootOptionsPongo":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Pongo image ID. Uploaded pongo images are keyed by UUID, like other instance images.","example":"3e1354a3-fb10-46c0-8b05-56e28edbde69"},"name":{"type":"string","description":"File name.","example":"pongo.bin"},"size":{"type":"number","description":"File size.","example":1048576}},"required":["id","name","size"]},"InstanceBootOptionsFvp":{"type":"object","properties":{"modelBinary":{"type":"string","description":"FVP model binary path. Populated by the server from the flavor; clients should not set this.","example":"/usr/local/fvp/bin/FVP_Base_RevC-2xAEMvA"},"parameters":{"type":"object","additionalProperties":{"type":"string"},"description":"Key/value map of FVP model parameters.","example":{"bp.secure_memory":"false","cluster0.NUM_CORES":"4"}},"data":{"type":"array","items":{"type":"string"},"description":"Raw data to load at specified addresses (format: \"file@address\").","example":["/tmp/data.bin@0x80000000"]},"breaks":{"type":"array","items":{"type":"string"},"description":"Breakpoint addresses to set.","example":["0x80001000"]},"dumps":{"type":"array","items":{"type":"string"},"description":"Memory regions to dump (format: \"file@address,size\").","example":["/tmp/dump.bin@0x80000000,0x1000"]},"cadiLog":{"type":"string","description":"Log all CADI calls into an XML log file.","example":"cadi-log.xml"},"cadiServer":{"type":"string","description":"Start CADI server.","example":"true"},"irisServer":{"type":"string","description":"Start Iris server.","example":"true"},"irisLog":{"type":"string","description":"Iris log level.","example":"info"},"irisAllowRemote":{"type":"string","description":"Allow remote connections to the Iris server.","example":"true"},"irisPortRange":{"type":"string","description":"Port range to scan when starting the Iris server (format: \"min:max\").","example":"7000:7010"},"irisPort":{"type":"string","description":"Specific port for the Iris server.","example":"7100"},"run":{"type":"string","description":"Run the simulation immediately when a debug server is started.","example":"true"},"stat":{"type":"string","description":"Print run statistics on simulation exit.","example":"true"},"quiet":{"type":"string","description":"Suppress informational output.","example":"true"},"start":{"type":"string","description":"Set initial PC to application start address.","example":"0x80000000"},"plugin":{"type":"string","description":"Load plugin.","example":"/usr/local/fvp/plugins/ToolsSharedLib.so"},"fastRam":{"type":"string","description":"Enable FastRAM and load its configuration from file.","example":"fastram.cfg"},"save":{"type":"string","description":"Save checkpoint to directory on simulation exit.","example":"/tmp/checkpoint"},"restore":{"type":"string","description":"Restore checkpoint from directory on simulation startup.","example":"/tmp/checkpoint"},"cpiFile":{"type":"string","description":"File to set Cycle Per Instruction class.","example":"cpi.txt"},"cycleLimit":{"type":"string","description":"Number of cycles to run.","example":"1000000"},"cpuLimit":{"type":"string","description":"Number of host active CPU seconds to run.","example":"3600"},"timeLimit":{"type":"string","description":"Number of wall-clock seconds to run.","example":"3600"},"simLimit":{"type":"string","description":"Number of seconds to simulate.","example":"60"}}},"InstanceConsole":{"type":"object","properties":{"name":{"type":"string","description":"Console display name.","example":"System Console"},"id":{"type":"string","description":"Console port identifier (e.g. port-cons). Used to select this console when getting the console websocket URL.","example":"port-cons"},"port":{"type":"string","description":"TCP port number.","example":"2000"},"hash":{"type":"string","description":"Hash for console authentication.","example":"<redacted>"},"info":{"type":"string","description":"Encrypted info for console authentication.","example":"<redacted>"}},"required":["name","id","port","hash","info"]},"InstanceInterfaceStatus":{"type":"object","properties":{"interfaceId":{"type":"string","description":"Interface identifier.","example":"gpio/0"},"interconnectId":{"type":"string","format":"uuid","description":"Interconnect identifier when the interface is attached.","example":"56494514-33f7-4fc2-9fdc-865e3957e6d3"},"status":{"type":"string","enum":["attached","detached","connected"],"description":"Current interface attachment status."}},"required":["interfaceId","status"]},"InstanceServices":{"type":"object","properties":{"vpn":{"$ref":"#/components/schemas/VpnDefinition"}}},"VpnDefinition":{"type":"object","properties":{"proxy":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"nullable":true}},"description":"VPN proxy definitions.","example":[{"devicePort":22,"routerPort":22,"status":"started"}]},"listeners":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"nullable":true}},"description":"VPN listener definitions."}}},"InstanceAgentState":{"type":"object","nullable":true,"properties":{"hash":{"type":"string","description":"Hash for agent authentication.","example":"<redacted>"},"info":{"type":"string","description":"Encrypted info for agent authentication.","example":"<redacted>"}}},"InstanceNetmonState":{"type":"object","properties":{"hash":{"type":"string","description":"Hash for network monitor authentication.","example":"<redacted>"},"info":{"type":"string","description":"Encrypted info for network monitor authentication.","example":"<redacted>"},"enabled":{"type":"boolean","description":"Whether network monitoring is enabled.","example":true}}},"InstanceNetdumpState":{"type":"object","properties":{"hash":{"type":"string","description":"Hash for netdump authentication.","example":"<redacted>"},"info":{"type":"string","description":"Encrypted info for netdump authentication.","example":"<redacted>"},"enabled":{"type":"boolean","description":"Whether netdump is enabled.","example":true}}},"InstanceTraceState":{"type":"object","properties":{"enabled":{"type":"boolean","nullable":true,"description":"Whether tracing is enabled.","example":true},"length":{"type":"number","description":"Length of trace data.","example":1048576},"filter":{"type":"array","items":{"$ref":"#/components/schemas/InstanceTraceFilter"},"description":"Active trace filters matching traits to values."}},"description":"System call (strace) tracing state."},"InstanceTraceFilter":{"type":"object","properties":{"trait":{"type":"string","description":"Trait to match, e.g. \"pid\".","example":"pid"},"value":{"type":"string","description":"Value the trait must equal.","example":"1234"}},"required":["trait","value"]},"InstanceHyperTraceState":{"type":"object","properties":{"enabled":{"type":"string","nullable":true,"enum":["enabling","enabled","disabling","disabled",null],"description":"HyperTrace (btrace) status."},"length":{"type":"number","description":"Length of trace data.","example":1048576},"filter":{"type":"array","items":{"$ref":"#/components/schemas/InstanceTraceFilter"},"description":"Active trace filters matching traits to values."}},"description":"Hypervisor (btrace) tracing state."},"CreatedBy":{"type":"object","nullable":true,"properties":{"id":{"type":"string","format":"uuid","description":"User identifier.","example":"e8c5b7ea-aa5f-4a4a-bdca-0c67060b5320"},"username":{"type":"string","description":"Username.","example":"jane.doe"},"label":{"type":"string","description":"User label.","example":"Jane Doe"},"deleted":{"type":"boolean","description":"Indicates if user was deleted.","example":true}},"required":["id","username","label"]},"InstanceUefiBootloader":{"type":"object","properties":{"label":{"type":"string","description":"Human-readable label for the UEFI boot option.","example":"Enable UEFI boot"},"name":{"type":"string","description":"UEFI bootloader file name.","example":"uefi.bin"}},"required":["label","name"],"description":"UEFI bootloader descriptor, when the device uses one."},"CreateInstanceResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Instance ID.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"state":{"type":"string","enum":["creating"],"description":"Instance state. Always \"creating\" for a freshly created instance."}},"required":["id","state"]},"ApiConflictError":{"type":"object","properties":{"error":{"type":"string","description":"Human-readable explanation of the conflict.","example":"Conflict with existing resource"},"errorID":{"type":"string","enum":["Conflict"],"description":"Always `Conflict`: the request clashes with the current state, for example the resource already exists or is in a state that does not allow this action. Check the current state before retrying."},"object":{"type":"object","additionalProperties":{"nullable":true},"description":"The existing object the request conflicted with, when there is one.","example":{"id":"1c41b1bc-4f53-48a8-b690-ad30611e1960","name":"Default Project"}}},"required":["error","errorID"]},"CreateInstanceBody":{"type":"object","properties":{"sharedSnapshot":{"type":"string","description":"Identifier of the snapshot that was shared.","example":"c67af9c0-26cd-4233-9782-436c842b60db"},"sharedSnapshotPassword":{"type":"string","description":"Password of the shared snapshot named by sharedSnapshot, as set when it was shared. Required when that snapshot was shared with sharing type passwordPublicLink. This is the same value passed as password to POST /v3/snapshots/accept.","example":"<redacted>"},"name":{"type":"string","description":"The name of the device.","example":"My iPhone 13 Pro"},"key":{"type":"string","description":"Key used to encrypt the instance (hex).","example":"<redacted>"},"flavor":{"type":"string","description":"Which device model to create. Use a `flavor` value from `GET /v3/models`.","example":"iphone13p"},"projectId":{"type":"string","format":"uuid","description":"Project the device is created in. The device uses that project's quota (cores, memory, device count). Get IDs from `GET /v3/projects`.","example":"1c41b1bc-4f53-48a8-b690-ad30611e1960"},"osVersion":{"type":"string","description":"Operating-system version to install, as listed in `osVersion` by `GET /v3/models/{model}/software`. If you give only `osVersion`, the newest build of that version is used.","example":"17.5"},"osBuild":{"type":"string","description":"Exact build to install, as listed in `osBuild` by `GET /v3/models/{model}/software`. Give it together with `osVersion` to pin one build. You must give at least one of `osVersion` and `osBuild`.","example":"21F79"},"patches":{"type":"array","items":{"type":"string"},"description":"List of patches to apply.","example":["jailbroken"]},"fwPackage":{"anyOf":[{"type":"string","format":"uri"},{"type":"string","format":"uuid"}],"description":"Optional. Boots a specific firmware file instead of choosing one from the model's software list. Either the `id` of an uploaded `fw` image (for example one in your project, see `POST /v3/images`) or an http(s) URL. When set, it wins over the software list; still pass `osVersion` or `osBuild`. A domain-level image is copied into your project first. Models whose `supportsCustomFirmwareImage` is false reject an image ID here.","example":"https://example.com/firmware.ipsw"},"originalFirmwarePackageUrl":{"type":"string","description":"URL that the firmware package is available at.","example":"https://example.com/firmware.ipsw"},"encrypt":{"type":"boolean","description":"Whether to encrypt the instance.","example":true},"wifiMac":{"type":"string","description":"WiFi MAC address to assign to the instance.","example":"02:00:00:aa:bb:cc"},"wanAccess":{"type":"boolean","description":"Manages internet access.","example":true},"volume":{"$ref":"#/components/schemas/VolumeOptions"},"snapshot":{"type":"string","format":"uuid","description":"Snapshot ID for this instance to be cloned from if defined.","example":"c67af9c0-26cd-4233-9782-436c842b60db"},"bootOptions":{"$ref":"#/components/schemas/InstanceBootOptions"},"sbs":{"type":"boolean","description":"Should attempt to create springboard snapshot.","example":true},"charmBootArgs":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]}},"description":"Optional charm boot args.","example":[{"charmd":"enabled"},{"strace-file-count":2},{"supportsVideoFile":true}]}},"required":["projectId"]},"VolumeOptions":{"type":"object","properties":{"blocks":{"type":"number","description":"Blocks to resize partition to.","example":5505024},"name":{"type":"string","description":"Name of partition.","example":"userdata_img"}},"required":["blocks","name"]},"PatchInstanceBody":{"type":"object","properties":{"name":{"type":"string","description":"The name of the device.","example":"My iPhone 13 Pro"},"bootOptions":{"allOf":[{"$ref":"#/components/schemas/InstanceBootOptions"},{"description":"The desired boot options."}]},"proxy":{"type":"array","items":{"type":"object","properties":{"devicePort":{"type":"number","description":"The device port to use for proxying.","example":22},"firstAvailable":{"type":"boolean","description":"Use the first available port if devicePort is unavailable.","example":true},"expose":{"type":"boolean","description":"Expose the proxy to the external interface.","example":true},"routerPort":{"type":"number","description":"The router port to use for proxying.","example":22}},"required":["devicePort","firstAvailable","expose","routerPort"]},"description":"Port proxy configurations for the instance."},"straceFilter":{"type":"array","items":{"type":"object","properties":{"trait":{"type":"string","enum":["name","pid","tid"],"description":"Filter trait."},"value":{"type":"string","description":"Value to match.","example":"1234"}},"required":["trait","value"]},"description":"CoreTrace process filter."}}},"PatchInstanceReadOnlyBody":{"type":"object","properties":{"readOnly":{"type":"boolean","description":"Desired read-only state, true enables read-only.","example":true}},"required":["readOnly"]},"InstanceConsoleEndpoint":{"type":"object","properties":{"url":{"type":"string","description":"Console WebSocket URL.","example":"wss://example.com/console/ws?token=<token>"}},"required":["url"]},"Token":{"type":"object","properties":{"token":{"type":"string","description":"Authorization token.","example":"<token>"}},"required":["token"]},"TokenValidateBody":{"type":"object","properties":{"token":{"type":"string","description":"Instance token to validate.","example":"<redacted>"}},"required":["token"]},"StartInstanceBody":{"type":"object","properties":{"paused":{"type":"boolean","description":"Start device paused.","example":true},"sockCap":{"type":"boolean","description":"Start device with Process Network Monitoring enabled.","example":true}}},"StopInstanceBody":{"type":"object","properties":{"soft":{"type":"boolean","default":true,"description":"Controls how the VM is stopped. When true (the default), performs a graceful shutdown. When false, performs a forced, immediate stop."}}},"GpiosState":{"type":"object","properties":{"led":{"$ref":"#/components/schemas/GpioStateDefinition"},"button":{"$ref":"#/components/schemas/GpioStateDefinition"},"switch":{"$ref":"#/components/schemas/GpioStateDefinition"}},"description":"State of the simulated LEDs, buttons and switches on an IoT or embedded board model. Each group (`led`, `button`, `switch`) has one or more banks, and each bank is a list of bits: 1 is on (pressed, lit), 0 is off. Only board models that wire these up report them; phones (iOS and Android) do not."},"GpioStateDefinition":{"type":"object","properties":{"bitCount":{"type":"number","description":"Count of bits in members of this bank.","example":8},"banks":{"type":"array","items":{"type":"array","items":{"anyOf":[{"type":"number","enum":[0]},{"type":"number","enum":[1]}]}},"description":"Bits for each bank of this name as an array of arrays.","example":[[1,0,0,0,0,0,0,0]]}},"required":["bitCount","banks"]},"PeripheralsData":{"type":"object","properties":{"acceleration":{"type":"array","items":{"type":"number"},"description":"Accelerometer reading as [x, y, z].","example":[0,9.81,0]},"gyroscope":{"type":"array","items":{"type":"number"},"description":"Gyroscope reading as [x, y, z].","example":[0,0,0]},"magnetic":{"type":"array","items":{"type":"number"},"description":"Magnetometer reading as [x, y, z].","example":[0,45,0]},"orientation":{"type":"array","items":{"type":"number"},"description":"Device orientation vector.","example":[0,0,0]},"temperature":{"type":"number","description":"Ambient temperature reading.","example":25},"proximity":{"type":"number","description":"Proximity sensor reading.","example":50},"light":{"type":"number","description":"Ambient light sensor reading.","example":20},"pressure":{"type":"number","description":"Barometric pressure reading.","example":1013.25},"humidity":{"type":"number","description":"Relative humidity reading.","example":55},"gpsLat":{"type":"number","description":"GPS latitude in decimal degrees.","example":37.4143},"gpsLon":{"type":"number","description":"GPS longitude in decimal degrees.","example":-122.0774},"gpsAlt":{"type":"number","description":"GPS altitude in meters.","example":45},"gpsToffs":{"type":"number","description":"GPS time offset in seconds.","example":0},"acOnline":{"type":"integer","enum":[0,1],"description":"AC power connection: 0 = disconnected, 1 = connected.","x-enum-varnames":["Disconnected","Connected"]},"batteryPresent":{"type":"integer","enum":[0,1],"description":"Battery presence: 0 = absent, 1 = present.","x-enum-varnames":["Absent","Present"]},"batteryStatus":{"type":"string","enum":["charging","discharging","not-charging"],"description":"Battery charging status.","example":"charging"},"batteryHealth":{"type":"string","enum":["good","overheat","dead","overvolt","failure"],"description":"Battery health.","example":"good"},"batteryCapacity":{"type":"number","description":"Battery charge level as a percentage.","example":82},"biometricPass":{"type":"integer","enum":[0,1],"description":"Biometric bypass: 0 = disabled, 1 = enabled.","x-enum-varnames":["Disabled","Enabled"]}},"additionalProperties":false,"description":"Peripheral readings and settings. Responses include only fields reported by the compute node; no field is guaranteed to be present. An absent field does not imply a zero or false value. All fields are optional to support partial updates.\n\nWrites require the corresponding feature to be enabled; settings for disabled features are ignored:\n- deviceMotion: acceleration, gyroscope, magnetic, orientation.\n- deviceEnvironmentControl: temperature, proximity, light, pressure, humidity.\n- deviceLocation: gpsLat, gpsLon, gpsAlt, gpsToffs.\n- deviceBattery: acOnline, batteryPresent, batteryStatus, batteryHealth, batteryCapacity.\n- biometricBypass: biometricPass.\n\nThese write restrictions do not determine which fields are returned by GET."},"RestoreBackupBody":{"type":"object","properties":{"password":{"type":"string","description":"Password of the backup file. Needed only if the backup is encrypted; leave it out for an unencrypted backup.","example":"<redacted>"}}},"Screenshot":{"type":"string","format":"binary","description":"Screenshot data (binary)."},"RotateBody":{"type":"object","properties":{"orientation":{"type":"number","enum":[1,2,3,4],"description":"Desired orientation. 1=Portrait, 2=Portrait inverted, 3=Landscape (top left), 4=Landscape (top right)."}},"required":["orientation"]},"InputResponse":{"type":"object","properties":{"eta":{"type":"number","description":"Expected time to complete (ms).","example":250}},"required":["eta"]},"InstanceInputBody":{"anyOf":[{"$ref":"#/components/schemas/TouchInputRequest"},{"$ref":"#/components/schemas/TouchCurveInputRequest"},{"$ref":"#/components/schemas/TextInputRequest"}]},"TouchInputRequest":{"type":"object","properties":{"position":{"$ref":"#/components/schemas/FingerPositions"},"buttons":{"type":"array","items":{"type":"string"},"description":"Buttons held when this position is reached. Omit to leave unchanged; use an empty array to release. VM button names: finger, homeButton, holdButton (Power/Hold), volumeUp, volumeDown, backButton, overviewButton. Also accepts single ASCII characters and keyboard key names (e.g. enter, home, power). Use finger:1 for the fingerprint sensor.","example":["finger"]},"normalized":{"type":"boolean","description":"Use normalized 0-10000 coordinates.","example":true},"wait":{"type":"integer","description":"Duration to wait before this input is executed, in milliseconds.","example":100}}},"FingerPositions":{"type":"array","items":{"type":"array","items":{"type":"number"},"minItems":2,"maxItems":2},"description":"Array of per-finger [x,y] touch positions, up to 10 depending on model.","example":[[100,200]]},"TouchCurveInputRequest":{"type":"object","properties":{"start":{"$ref":"#/components/schemas/FingerPositions"},"end":{"$ref":"#/components/schemas/FingerPositions"},"bezierPoints":{"type":"array","items":{"$ref":"#/components/schemas/FingerPositions"},"description":"Per-finger intermediate touch positions.","example":[[[150,250]]]},"startButtons":{"type":"array","items":{"type":"string"},"description":"Buttons held during this curve. VM button names: finger, homeButton, holdButton (Power/Hold), volumeUp, volumeDown, backButton, overviewButton. Also accepts single ASCII characters and keyboard key names (e.g. enter, home, power). Use finger:1 for the fingerprint sensor.","example":["finger"]},"endButtons":{"type":"array","items":{"type":"string"},"description":"Buttons left held after this curve. Omit to leave unchanged; use an empty array to release. VM button names: finger, homeButton, holdButton (Power/Hold), volumeUp, volumeDown, backButton, overviewButton. Also accepts single ASCII characters and keyboard key names (e.g. enter, home, power). Use finger:1 for the fingerprint sensor.","example":["finger"]},"normalized":{"type":"boolean","description":"Use normalized 0-10000 coordinates.","example":true},"wait":{"type":"integer","description":"Duration to wait before this input is executed, in milliseconds.","example":100},"duration":{"type":"integer","description":"Duration to execute this curve over, in milliseconds.","example":250}},"required":["start","end","startButtons","duration"]},"TextInputRequest":{"type":"object","properties":{"text":{"type":"string","description":"Text to type.","example":"Hello, world!"},"keyDuration":{"type":"integer","description":"How long to take to type each key, in milliseconds. Defaults to ~150ms per key downstream when omitted.","example":150}},"required":["text"]},"MediaPlayBody":{"oneOf":[{"$ref":"#/components/schemas/MediaPlayByImage"},{"$ref":"#/components/schemas/MediaPlayByUrl"}],"description":"Media source. Provide exactly one of imageId or url."},"MediaPlayByImage":{"type":"object","properties":{"imageId":{"type":"string","format":"uuid","description":"Image ID.","example":"3e1354a3-fb10-46c0-8b05-56e28edbde69"}},"required":["imageId"]},"MediaPlayByUrl":{"type":"object","properties":{"url":{"type":"string","description":"URL to a media file.","example":"https://example.com/media.mp4"}},"required":["url"]},"KernelTask":{"type":"object","properties":{"kernelId":{"type":"string","description":"Kernel task ID (uint64_t).","example":"0xffffff8012345000"},"name":{"type":"string","description":"Thread name.","example":"launchd"},"processId":{"type":"integer","description":"Process ID of task.","example":1},"threads":{"type":"array","items":{"$ref":"#/components/schemas/KernelThread"},"description":"Threads belonging to this task."}},"required":["kernelId","name","processId","threads"]},"KernelThread":{"type":"object","properties":{"kernelId":{"type":"string","description":"Kernel thread ID (uint64_t).","example":"0xffffff8012345678"},"taskId":{"type":"integer","description":"Task ID.","example":1},"stack":{"type":"array","items":{"type":"string"},"description":"Array of stack addresses.","example":["0xffffff8012345678","0xffffff8012345690"]}},"required":["kernelId","taskId","stack"]},"Kcrange":{"type":"object","properties":{"kernelExtension":{"type":"string","description":"Kernel extension.","example":"com.apple.driver.AppleMobileFileIntegrity"},"range":{"type":"array","items":{"type":"string"},"minItems":2,"maxItems":2,"description":"Start and end address of the kernel extension range.","example":["0xfffffff007c88000","0xfffffff007d1c000"]}},"required":["kernelExtension","range"]},"EnableBtraceBody":{"type":"object","properties":{"ranges":{"type":"array","items":{"type":"array","items":{"type":"string"}},"description":"Kernel address ranges to trace, each a `[start, end]` pair of hexadecimal addresses. To trace one kernel extension, use its `range` from `v3GetInstanceKcrange`.","example":[["0xfffffff007c88000","0xfffffff007d1c000"]]}}},"EnableSslsplitBody":{"type":"object","properties":{"truncatePcap":{"type":"boolean","description":"Whether to truncate the Network Monitor capture file.","example":true}}},"EnableNetdumpBody":{"type":"object","properties":{"portRanges":{"type":"array","items":{"type":"string"},"description":"Optional. Capture only traffic on ports in these ranges, each written `low-high`.","example":["1024-65535"]},"srcPorts":{"type":"array","items":{"type":"string"},"description":"Source ports to capture.","example":["443"]},"dstPorts":{"type":"array","items":{"type":"string"},"description":"Destination ports to capture.","example":["80","443"]},"ports":{"type":"array","items":{"type":"string"},"description":"Ports to capture.","example":["80","443"]},"protocols":{"type":"array","items":{"type":"string"},"description":"Protocols to capture.","example":["tcp","udp"]},"processes":{"type":"array","items":{"type":"string"},"description":"Optional. Capture only traffic sent or received by processes with these names.","example":["Safari"]},"hosts":{"type":"array","items":{"type":"string"},"description":"Host IP addresses to capture.","example":["192.0.2.10"]}}},"MessageBody":{"anyOf":[{"type":"object","properties":{"number":{"type":"string","description":"Source phone number.","example":"+15555550123"},"message":{"type":"string","description":"SMS message body.","example":"Hello from Corellium!"}},"required":["number","message"]},{"type":"object","properties":{"raw":{"type":"string","description":"Hex-encoded raw message bytes.","example":"deadbeef"}},"required":["raw"]}]},"InsufficientStorageError":{"type":"object","properties":{"error":{"type":"string","description":"Error text.","example":"There is not enough storage space to store the requested file"},"errorID":{"type":"string","enum":["InsufficientStorage"],"description":"Error ID."},"total":{"type":"integer","minimum":0,"description":"Total storage capacity in bytes.","example":2199023255552},"available":{"type":"integer","minimum":0,"description":"Available storage in bytes.","example":1073741824},"required":{"type":"integer","minimum":0,"description":"Storage required for the upload in bytes.","example":3448156160}},"required":["error","errorID","total","available","required"]},"InstanceUpgradeResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Instance ID.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"state":{"type":"string","enum":["updating"],"description":"Instance state. Always \"updating\" once an upgrade has been accepted."}},"required":["id","state"]},"InstanceUpgradeBody":{"type":"object","properties":{"osVersion":{"type":"string","description":"iOS version to upgrade to, as listed by `GET /v3/models/{model}/software` for this device's model.","example":"17.5"},"osBuild":{"type":"string","description":"Optional exact build of that version. Without it, the newest build of `osVersion` is used.","example":"21F79"}},"required":["osVersion"]},"AttachInterfaceBody":{"type":"object","properties":{"interfaceId":{"type":"string","description":"Which of the device's I/O interfaces to connect, for example `gpio/0`.","example":"gpio/0"},"interconnectId":{"type":"string","format":"uuid","description":"Interconnect identifier.","example":"56494514-33f7-4fc2-9fdc-865e3957e6d3"}},"required":["interfaceId","interconnectId"]},"DetachInterfaceBody":{"type":"object","properties":{"interconnectId":{"type":"string","format":"uuid","description":"Interconnect identifier.","example":"56494514-33f7-4fc2-9fdc-865e3957e6d3"}},"required":["interconnectId"]},"NodeList":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/NodeInformation"},"description":"List of cluster nodes."},"count":{"type":"integer","minimum":0,"description":"Number of results in this page. Can be less than `limit` on the last page.","example":25},"total":{"type":"integer","minimum":0,"description":"Number of results across all pages, after any filters.","example":137},"limit":{"type":"integer","minimum":0,"description":"The page size that was used (your `limit`, or the default 100).","example":25},"offset":{"type":"integer","minimum":0,"description":"The offset that was used (your `offset`, or the default 0).","example":0},"hasMore":{"type":"boolean","description":"True if more results exist after this page. To read everything, keep requesting with `offset` increased by `limit` until this is false.","example":true}},"required":["results","count","total","limit","offset","hasMore"]},"NodeInformation":{"type":"object","properties":{"nodeId":{"type":"string","description":"Unique identifier for the node.","example":"2x3ZOdu4pshouoY0kttRPoiIk5s"},"address":{"type":"string","description":"IP address of the node.","example":"10.0.0.12"},"hostname":{"type":"string","description":"Hostname of the node.","example":"node-01.example.com"},"sshPort":{"type":"integer","nullable":true,"minimum":1,"maximum":65535,"description":"SSH port for the node (1-65535), or null if unavailable.","example":22},"nodeTypes":{"type":"array","items":{"type":"string","enum":["compute","controller","gpu"]},"description":"Types of services running on this node.","example":["controller","compute"]}},"required":["nodeId","address","hostname","sshPort","nodeTypes"]},"NodeConsoleEndpoint":{"type":"object","properties":{"url":{"type":"string","description":"Console WebSocket URL.","example":"wss://acme-corp.example.com/api/v3/cluster/nodes/2x3ZOdu4pshouoY0kttRPoiIk5s/console?token=<token>"}},"required":["url"]},"ClusterConfig":{"type":"object","properties":{"lastConfigKeys":{"type":"array","items":{"type":"string"}},"localIp":{"type":"string"},"ipBlockNetmask":{"type":"string"},"instanceGateway":{"type":"string"},"instanceDNSServers":{"type":"array","items":{"type":"string"}},"coordinator":{"type":"string"},"onSite":{"type":"boolean"},"cloudProvider":{"type":"string","nullable":true},"networkTypes":{"type":"array","items":{"type":"string"}},"networkType":{"type":"string","enum":["bridged","nat","routed"]},"showDomainSettings":{"type":"boolean"},"version":{"type":"string"},"ipswUrl":{"type":"string"},"coreimgUrl":{"type":"string"},"fwServiceUrl":{"type":"string"},"servicePassword":{"type":"string"},"invalidBuild":{"type":"boolean"},"sepSim":{"type":"boolean"},"installerAvailable":{"type":"boolean"},"stripe":{"type":"object","properties":{"publicKey":{"type":"string"},"privateKey":{"type":"string"},"webhookKey":{"type":"string"}},"required":["publicKey","privateKey","webhookKey"]},"intercomId":{"type":"string"},"auxWebhook":{"type":"string"},"gtmId":{"type":"string"},"zapierFeedbackWebhook":{"type":"string"},"zapierBugsWebhook":{"type":"string"},"billingBackend":{"type":"string"},"maintenance":{"type":"object","properties":{"message":{"type":"string"},"header":{"type":"string"}}},"cloudDomain":{"type":"string"},"development":{"type":"boolean"},"billingDomain":{"type":"string"},"appDomain":{"type":"string"},"enableFirmwareImageUpload":{"type":"boolean"},"netMonCA":{"type":"object","properties":{"certificate":{"type":"string"},"key":{"type":"string"},"subjectHash2":{"type":"string"}},"required":["certificate","key","subjectHash2"]},"snapshotLimit":{"type":"integer"},"maxKernelSize":{"type":"number"},"maxRamdiskSize":{"type":"number"},"charmSDK":{"type":"boolean"},"sentryUrl":{"type":"string"},"remoteGpu":{"type":"boolean"},"rateLimit":{"type":"boolean"},"certFileData":{"type":"string"},"caCertFileSrc":{"type":"string"},"vstrmOnComputeNodes":{"type":"boolean"},"charm":{"type":"object","additionalProperties":{"nullable":true}},"c3poPathPrefix":{"type":"string"},"branding":{"type":"string"},"openGAppsBinary":{"type":"string"},"airgapped":{"type":"boolean"},"nodeStaleTimeout":{"type":"number"},"reportInterval":{"type":"number"},"coordinatorConfig":{"type":"object","properties":{"bindHost":{"type":"string"},"bindPort":{"type":"number"},"dbDatabase":{"type":"string"},"dbHost":{"type":"string"},"dbPort":{"type":"number"},"dbPassword":{"type":"string"},"dbUser":{"type":"string"},"dbLoggingEnabled":{"type":"boolean"},"configDbHost":{"type":"string"},"configDbPort":{"type":"number"},"configDbUser":{"type":"string"},"configDbPassword":{"type":"string"},"configDbName":{"type":"string"},"ipBlock":{"type":"string"},"localIp":{"type":"string"},"ipBlockNetmask":{"type":"string"},"instanceDNSServers":{"type":"array","items":{"type":"string"}},"onSite":{"type":"boolean"},"privateHeaders":{"type":"array","items":{"type":"string"}},"trial":{"type":"object","properties":{"defaultDuration":{"type":"number"},"defaultHours":{"type":"number"},"defaultDevices":{"type":"number"},"defaultCores":{"type":"number"}},"required":["defaultDuration","defaultHours","defaultDevices","defaultCores"]},"trialSurveyId":{"type":"string"},"authProviders":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"provider":{"type":"string"}},"required":["provider"]},{"type":"object","properties":{"provider":{"type":"string"},"discoveryUrl":{"type":"string"},"clientId":{"type":"string"},"clientSecret":{"type":"string"},"label":{"type":"string"},"invitedOnly":{"type":"boolean"}},"required":["provider","discoveryUrl","clientId","clientSecret","label","invitedOnly"]}]}},"perProjectStorageQuota":{"type":"number"},"imageDataPath":{"type":"string"},"ensureDomain":{"type":"object","properties":{"domain":{"type":"string"},"domainName":{"type":"string"},"quotas":{"type":"object","properties":{"cores":{"type":"number"}},"required":["cores"]},"properties":{"type":"object","properties":{"licenseType":{"type":"string"},"android":{"type":"boolean"},"noIOS":{"type":"boolean"}},"required":["licenseType","android","noIOS"]},"adminPasswordHash":{"type":"string"},"adminUserCloudAdministrator":{"type":"boolean"},"isIndividualAggregate":{"type":"boolean"}},"required":["domain","domainName","quotas","properties","adminPasswordHash","adminUserCloudAdministrator","isIndividualAggregate"]},"hubspot":{"type":"object","properties":{"accessToken":{"type":"string"},"hubspotContactLink":{"type":"string"}},"required":["accessToken","hubspotContactLink"]},"nexusUrl":{"type":"string"},"billingTradeCreditDays":{"type":"number"},"jwtTokenExpiration":{"type":"number"},"hypertune":{"type":"object","properties":{"token":{"type":"string"},"branchName":{"type":"string"},"initDataPath":{"type":"string"}},"required":["token"]},"awsMarketplace":{"type":"object","properties":{"sugerToken":{"type":"string"},"sugerWebhookSecret":{"type":"string"},"sugerAPIClientSecret":{"type":"string"},"sugerStripeMapping":{"type":"object","additionalProperties":{"type":"string"}}},"required":["sugerToken","sugerWebhookSecret","sugerAPIClientSecret","sugerStripeMapping"]},"pipedrive":{"type":"object","properties":{"token":{"type":"string"}},"required":["token"]},"webplayer":{"type":"object","properties":{"inactivityDeleteTimeout":{"type":"number"},"inactivityShutdownTimeout":{"type":"number"}},"required":["inactivityDeleteTimeout","inactivityShutdownTimeout"]},"postmarkServerToken":{"type":"string"},"postmarkEmailFrom":{"type":"string"},"postmarkEmailTemplate":{"type":"string"},"s3":{"type":"object","additionalProperties":{"type":"string"}},"ofacApiKey":{"type":"string"},"usbMediaQueueDir":{"type":"string"},"usbMediaAccessEnabled":{"type":"boolean"},"intercomIdVerifySecret":{"type":"string"},"fvpSecret":{"type":"string"}},"required":["bindHost","bindPort","dbDatabase","dbHost","dbPort","dbPassword","dbUser","dbLoggingEnabled","ipBlock","localIp","ipBlockNetmask","onSite","privateHeaders","trialSurveyId"]},"setupConfig":{"type":"object","properties":{"onSite":{"type":"boolean"},"artifactsVolumeSize":{"type":"number"},"networkMonitorInterval":{"type":"number"},"maxNetworkMonitorFileSize":{"type":"string"},"caCertFileSrc":{"type":"string"},"localIp":{"type":"string"},"instanceIpBlockNetmask":{"type":"string"},"instanceGateway":{"type":"string"},"instanceDNSServers":{"type":"array","items":{"type":"string"}},"reportInterval":{"type":"number"},"certKeyFileData":{"type":"string"},"defaultSsid":{"type":"string"},"enableExperimentalDevices":{"type":"boolean"},"controllerNodes":{"type":"array","items":{"type":"string"}},"domain":{"type":"string"},"interface":{"type":"string"},"virtualDeviceInterface":{"type":"string"},"autoApproveTrials":{"type":"string"},"snapshotLimit":{"type":"integer"},"maxDownloadAgentsPerDevice":{"type":"integer"},"clientCertFile":{"type":"string"},"dockerHostIp":{"type":"string"},"domainName":{"type":"string"},"vpnClientIP":{"type":"string"}},"required":["onSite","networkMonitorInterval","maxNetworkMonitorFileSize","caCertFileSrc","localIp","instanceIpBlockNetmask","instanceGateway","reportInterval","interface"]},"nodeSpecificConfig":{"type":"object","properties":{"az":{"type":"string","nullable":true},"externalIp":{"type":"string","nullable":true},"nodeId":{"type":"string","nullable":true}}},"packageConfig":{"type":"object","properties":{"licenseType":{"type":"string"},"clusterId":{"type":"string"},"networkType":{"type":"string","enum":["bridged","nat","routed"]},"physicalInterfaces":{"type":"object","additionalProperties":{"type":"string"}},"features":{"type":"object","properties":{"netMonProcMap":{"type":"boolean"},"CellebriteDeviceImage":{"type":"boolean"},"CustomRamdisk":{"type":"boolean"},"InjectedCdhashes":{"type":"boolean"},"CustomKernel":{"type":"boolean"},"CustomRamdomSeed":{"type":"boolean"},"DisableSnapshotMount":{"type":"boolean"},"TracingTools":{"type":"boolean"},"SepSim":{"type":"boolean"},"CustomBootArgs":{"type":"boolean"},"netdump":{"type":"boolean"},"PAC":{"type":"boolean"},"VstrmOnComputeNodes":{"type":"boolean"},"APRR":{"type":"boolean"},"KernelGDB":{"type":"boolean"},"KallocTracing":{"type":"boolean"},"trackProjectInstanceUsage":{"type":"boolean"},"CustomDeviceTree":{"type":"boolean"},"CustomKernelPatches":{"type":"boolean"},"Mast":{"type":"boolean"},"CharmModules":{"type":"boolean"},"SEP":{"type":"boolean"},"CustomBootLoader":{"type":"boolean"}},"additionalProperties":{"type":"boolean"}},"components":{"type":"object","properties":{"cellebriteDeviceImage":{"type":"boolean"}}},"termsOfService":{"type":"string"},"domainAuthenticationProviders":{"type":"boolean"},"maxNetworkMonitorFileSize":{"type":"string"},"combined":{"type":"boolean"},"flavorFilters":{"type":"array","items":{"type":"object","properties":{"filter":{"type":"object","properties":{"license":{"type":"string"},"type":{"type":"string"}}},"apply":{"type":"object","properties":{"supportsCoreTrace":{"type":"boolean"},"supportsPortFrida":{"type":"boolean"},"supportsCustomFirmware":{"type":"boolean"},"supportsCustomKernel":{"type":"boolean"},"supportsGDB":{"type":"boolean"},"supportsCustomDevicetree":{"type":"boolean"},"supportsNetworkMonitor":{"type":"boolean"}},"additionalProperties":{"type":"boolean"}}}}},"charmSDK":{"type":"boolean"},"highlyAvailable":{"type":"boolean"},"nodeVersion":{"type":"string"},"invalidBuild":{"type":"boolean"},"sepSim":{"type":"boolean"},"kernelGDB":{"type":"boolean"},"android":{"type":"boolean"},"noIOS":{"type":"boolean"},"iosBetas":{"type":"boolean"},"charmModules":{"type":"boolean"},"btrace":{"type":"boolean"},"strace":{"type":"boolean"},"gameStreaming":{"type":"boolean"},"containerTemplateGeneration":{"type":"string"},"s3Supported":{"type":"boolean"}},"required":["flavorFilters"]},"monitorInterval":{"type":"number"},"csp":{"type":"boolean"},"cdk":{"type":"boolean"},"charmExtensionPaths":{"type":"array","items":{"type":"string"}},"firmwareCache":{"type":"string"},"vstrm":{"type":"string"},"console":{"type":"string"},"fetchFirmwareAssets":{"type":"boolean"},"clusterFirmwareAssets":{"type":"boolean"},"authProviders":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"provider":{"type":"string"}},"required":["provider"]},{"type":"object","properties":{"provider":{"type":"string"},"discoveryUrl":{"type":"string"},"clientId":{"type":"string"},"clientSecret":{"type":"string"},"label":{"type":"string"},"invitedOnly":{"type":"boolean"}},"required":["provider","discoveryUrl","clientId","clientSecret","label","invitedOnly"]}]}},"domain":{"type":"string"},"serviceDomain":{"type":"string"},"serviceUser":{"type":"string"},"domainImageUploadQuota":{"type":"number"},"ipswFilters":{"type":"array","items":{"type":"object","properties":{"device":{"type":"object","properties":{"product":{"type":"string"}},"required":["product"]},"version":{"type":"object","properties":{"lt":{"type":"string"},"gt":{"type":"string"},"le":{"type":"string"},"ge":{"type":"string"},"eq":{"type":"string"}}},"include":{"type":"boolean"},"exclude":{"type":"boolean"}}}},"firmwareServiceConfig":{"type":"object","properties":{"fetchFirmwareAssets":{"type":"boolean"},"clusterFirmwareAssets":{"type":"boolean"},"cacheFirmware":{"type":"boolean"},"shouldDownload":{"type":"boolean"},"fallbackOriginalUrl":{"type":"boolean"}}},"aiToolsConfig":{"$ref":"#/components/schemas/AiToolsConfig"}},"required":["lastConfigKeys","localIp","ipBlockNetmask","instanceGateway","cloudProvider","networkTypes","maxKernelSize","maxRamdiskSize","caCertFileSrc","branding","openGAppsBinary","airgapped","aiToolsConfig"]},"AiToolsConfig":{"type":"object","properties":{"aiEnabled":{"type":"boolean","description":"Whether cluster-hosted AI features (e.g. the MCP server) are enabled.","example":true}}},"ClusterConfigUpdateError":{"type":"object","properties":{"message":{"type":"string","description":"Human-readable instruction to retry or resolve manually.","example":"Retry the request or apply the configuration change manually on the affected nodes."},"nodes":{"type":"array","items":{"$ref":"#/components/schemas/NodeInformation"},"description":"Nodes that failed to receive the configuration update."}},"required":["message"]},"PatchClusterConfigBody":{"type":"object","properties":{"snapshotLimit":{"type":"integer","minimum":0,"description":"Maximum number of snapshots that can be taken in the cluster.","example":10},"coordinatorConfig":{"$ref":"#/components/schemas/CoordinatorConfig"},"aiToolsConfig":{"allOf":[{"$ref":"#/components/schemas/AiToolsConfig"},{"description":"Partial AI tools configuration to update."}]},"originatingNode":{"type":"string","description":"IP address of the node that originated this config change; prevents re-broadcast.","example":"10.0.0.12"}}},"CoordinatorConfig":{"type":"object","properties":{"usbMediaAccessEnabled":{"type":"boolean","description":"Whether read-only access to removable USB media is enabled.","example":true}},"description":"Partial coordinator configuration to update."},"ClusterSnapshotList":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/ClusterSnapshot"},"description":"List of cluster snapshots."},"count":{"type":"integer","minimum":0,"description":"Number of results in this page. Can be less than `limit` on the last page.","example":25},"total":{"type":"integer","minimum":0,"description":"Number of results across all pages, after any filters.","example":137},"limit":{"type":"integer","minimum":0,"description":"The page size that was used (your `limit`, or the default 100).","example":25},"offset":{"type":"integer","minimum":0,"description":"The offset that was used (your `offset`, or the default 0).","example":0},"hasMore":{"type":"boolean","description":"True if more results exist after this page. To read everything, keep requesting with `offset` increased by `limit` until this is false.","example":true}},"required":["results","count","total","limit","offset","hasMore"]},"ClusterSnapshot":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the snapshot.","example":"c67af9c0-26cd-4233-9782-436c842b60db"},"name":{"type":"string","description":"Snapshot name.","example":"pre-update-snapshot"},"volume":{"type":"string","nullable":true,"description":"Identifier of the volume this snapshot was taken from.","example":"b6f1c9d2-8e47-4b3a-9c5d-2f1e8a7b6c5d"},"instance":{"type":"string","nullable":true,"description":"Identifier of the instance this snapshot is associated with.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"status":{"type":"object","properties":{"task":{"type":"string","description":"Current task being performed on the snapshot.","example":"creating"},"created":{"type":"boolean","description":"Whether the snapshot has been successfully created.","example":false}},"description":"Current status of the snapshot."},"type":{"type":"string","enum":["iscsi","local","s3"],"description":"Storage backend type."},"computeNode":{"type":"string","description":"Address of the compute node that owns this snapshot.","example":"10.0.0.12:6666"},"metadata":{"type":"object","properties":{"live":{"type":"boolean","description":"Whether this was a live snapshot.","example":true},"fresh":{"type":"boolean","description":"Whether the snapshot was created immediately after device restore.","example":false},"hwPac":{"type":"number","description":"Hardware PAC value.","example":1},"springboard":{"type":"boolean","description":"Whether this is a springboard snapshot.","example":false},"bootOptions":{"allOf":[{"$ref":"#/components/schemas/InstanceBootOptions"},{"description":"Boot options."}]},"device":{"type":"object","additionalProperties":{"nullable":true},"description":"Device metadata.","example":{"flavorId":"iphone13p","type":"ios","product":"iPhone14,2","model":"d63ap","cores":6}},"flavor":{"type":"string","description":"Device flavor.","example":"iphone13p"},"osVersion":{"type":"string","description":"OS version.","example":"16.5"},"osBuild":{"type":"string","description":"OS build identifier.","example":"20F66"},"patches":{"type":"string","description":"Patches applied.","example":"jailbroken"},"cpid":{"type":"number","description":"Chip ID.","example":33040}},"description":"Snapshot metadata."},"createdAt":{"type":"string","format":"date-time","description":"Timestamp when the snapshot was created.","example":"2026-03-14T09:12:47.000Z"},"updatedAt":{"type":"string","format":"date-time","description":"Timestamp when the snapshot was last updated.","example":"2026-03-17T11:41:05.000Z"}},"required":["id","volume","instance","status","type","metadata","createdAt","updatedAt"]},"StorageDeviceList":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/StorageDevice"},"description":"List of storage devices."},"count":{"type":"integer","minimum":0,"description":"Number of results in this page. Can be less than `limit` on the last page.","example":25},"total":{"type":"integer","minimum":0,"description":"Number of results across all pages, after any filters.","example":137},"limit":{"type":"integer","minimum":0,"description":"The page size that was used (your `limit`, or the default 100).","example":25},"offset":{"type":"integer","minimum":0,"description":"The offset that was used (your `offset`, or the default 0).","example":0},"hasMore":{"type":"boolean","description":"True if more results exist after this page. To read everything, keep requesting with `offset` increased by `limit` until this is false.","example":true}},"required":["results","count","total","limit","offset","hasMore"]},"StorageDevice":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the storage device.","example":"73357171-23a0-4a3e-8661-216dbfbdd7ab"},"device":{"type":"string","description":"Device node path (e.g. /dev/sdb1).","example":"/dev/sdb1"},"fsType":{"type":"string","description":"Filesystem type (e.g. ext4, vfat).","example":"ext4"},"fsUuid":{"type":"string","nullable":true,"description":"Filesystem UUID.","example":"4a3f2e1d-8c7b-4a19-9e2f-6d5c4b3a2190"},"label":{"type":"string","description":"Filesystem label.","example":"EXTERNAL_SSD"},"serial":{"type":"string","description":"Device serial number.","example":"0123456789ABCDEF"},"vendor":{"type":"string","description":"Device vendor.","example":"SanDisk"},"model":{"type":"string","description":"Device model.","example":"Ultra USB 3.0"},"mountPolicy":{"type":"string","enum":["RO","RW"],"description":"Mount policy for the device."},"status":{"type":"string","enum":["mounted","unmounted"],"description":"Current mount status."},"createdAt":{"type":"string","format":"date-time","description":"Timestamp when the record was created.","example":"2026-03-14T09:12:47.000Z"},"updatedAt":{"type":"string","format":"date-time","description":"Timestamp when the record was last updated.","example":"2026-03-17T11:41:05.000Z"}},"required":["id","device","fsType","fsUuid","label","serial","vendor","model","mountPolicy","status","createdAt","updatedAt"]},"StorageAlreadyMountedResponse":{"type":"object","properties":{"message":{"type":"string","description":"Human-readable status message.","example":"Device is already mounted."},"mountPoint":{"type":"string","description":"Filesystem path where the device is mounted.","example":"/mnt/usb1"},"device":{"type":"string","description":"Device node path.","example":"/dev/sdb1"}},"required":["message","mountPoint","device"]},"StorageAttachResponse":{"type":"object","properties":{"status":{"type":"string","description":"Job status.","example":"success"},"message":{"type":"string","description":"Human-readable status message.","example":"Mount job queued"},"id":{"type":"string","format":"uuid","description":"Storage device identifier.","example":"73357171-23a0-4a3e-8661-216dbfbdd7ab"}},"required":["status","message","id"]},"StorageQueueError":{"type":"object","properties":{"error":{"type":"string","description":"Error summary.","example":"Failed to queue mount job."},"details":{"type":"string","description":"Underlying error message.","example":"Connection to job queue timed out."},"suggestion":{"type":"string","description":"Suggested remediation.","example":"Retry the request in a few minutes."}},"required":["error","details","suggestion"]},"StorageEjectAlreadyUnmountedResponse":{"type":"object","properties":{"message":{"type":"string","description":"Human-readable status message.","example":"Device is already unmounted."}},"required":["message"]},"FirmwareServiceConfig":{"type":"object","properties":{"cacheFirmware":{"type":"object","properties":{"value":{"type":"boolean","description":"Current setting value.","example":true},"component":{"type":"string","description":"UI component hint.","example":"checkbox"},"title":{"type":"string","description":"Human-readable title.","example":"Cache firmware"},"description":{"type":"string","description":"Setting description.","example":"Cache firmwares in /var/ipsw"},"type":{"type":"string","description":"Value type.","example":"boolean"}},"required":["value"]},"clusterFirmwareAssets":{"type":"object","properties":{"value":{"type":"boolean","description":"Current setting value.","example":true},"component":{"type":"string","description":"UI component hint.","example":"checkbox"},"title":{"type":"string","description":"Human-readable title.","example":"Cache firmware"},"description":{"type":"string","description":"Setting description.","example":"Cache firmwares in /var/ipsw"},"type":{"type":"string","description":"Value type.","example":"boolean"}},"required":["value"]},"fallbackOriginalUrl":{"type":"object","properties":{"value":{"type":"boolean","description":"Current setting value.","example":true},"component":{"type":"string","description":"UI component hint.","example":"checkbox"},"title":{"type":"string","description":"Human-readable title.","example":"Cache firmware"},"description":{"type":"string","description":"Setting description.","example":"Cache firmwares in /var/ipsw"},"type":{"type":"string","description":"Value type.","example":"boolean"}},"required":["value"]},"fetchFirmwareAssets":{"type":"object","properties":{"value":{"type":"boolean","description":"Current setting value.","example":true},"component":{"type":"string","description":"UI component hint.","example":"checkbox"},"title":{"type":"string","description":"Human-readable title.","example":"Cache firmware"},"description":{"type":"string","description":"Setting description.","example":"Cache firmwares in /var/ipsw"},"type":{"type":"string","description":"Value type.","example":"boolean"}},"required":["value"]},"shouldDownload":{"type":"object","properties":{"value":{"type":"boolean","description":"Current setting value.","example":true},"component":{"type":"string","description":"UI component hint.","example":"checkbox"},"title":{"type":"string","description":"Human-readable title.","example":"Cache firmware"},"description":{"type":"string","description":"Setting description.","example":"Cache firmwares in /var/ipsw"},"type":{"type":"string","description":"Value type.","example":"boolean"}},"required":["value"]},"downloadIpswFilters":{"type":"object","properties":{"value":{"type":"array","items":{"$ref":"#/components/schemas/IpswFilterV3"},"description":"Current setting value."},"component":{"type":"string","description":"UI component hint.","example":"checkbox"},"title":{"type":"string","description":"Human-readable title.","example":"Cache firmware"},"description":{"type":"string","description":"Setting description.","example":"Cache firmwares in /var/ipsw"},"type":{"type":"string","description":"Value type.","example":"boolean"}},"required":["value"]}},"required":["cacheFirmware","clusterFirmwareAssets","fallbackOriginalUrl","fetchFirmwareAssets","shouldDownload","downloadIpswFilters"],"additionalProperties":{"type":"object","properties":{"value":{"nullable":true,"description":"Current setting value."},"component":{"type":"string","description":"UI component hint.","example":"checkbox"},"title":{"type":"string","description":"Human-readable title.","example":"Cache firmware"},"description":{"type":"string","description":"Setting description.","example":"Cache firmwares in /var/ipsw"},"type":{"type":"string","description":"Value type.","example":"boolean"}}}},"IpswFilterV3":{"type":"object","properties":{"version":{"type":"object","nullable":true,"properties":{"lt":{"type":"string","nullable":true,"description":"Version less-than bound (exclusive).","example":"18.0"},"le":{"type":"string","nullable":true,"description":"Version less-than-or-equal bound (inclusive).","example":"17.6"},"gt":{"type":"string","nullable":true,"description":"Version greater-than bound (exclusive).","example":"16.0"},"ge":{"type":"string","nullable":true,"description":"Version greater-than-or-equal bound (inclusive).","example":"17.0"},"eq":{"type":"string","nullable":true,"description":"Exact version match.","example":"17.5"}},"additionalProperties":{"nullable":true},"description":"Version constraint."},"device":{"type":"object","nullable":true,"properties":{"product":{"type":"string","nullable":true,"description":"Device product regex pattern (e.g. \"iPhone16,.*\").","example":"iPhone16,.*"}},"additionalProperties":{"nullable":true},"description":"Device constraint."},"exclude":{"type":"boolean","nullable":true,"description":"Exclude firmware matching this filter.","example":false},"include":{"type":"boolean","nullable":true,"description":"Include firmware matching this filter.","example":true}},"additionalProperties":{"nullable":true}},"FirmwareServiceSettings":{"type":"object","properties":{"cacheFirmware":{"type":"boolean","description":"Cache firmwares in /var/ipsw.","example":false},"clusterFirmwareAssets":{"type":"boolean","description":"Assets are cluster-wide.","example":false},"fallbackOriginalUrl":{"type":"boolean","description":"Use original URL to fetch firmware.","example":false},"fetchFirmwareAssets":{"type":"boolean","description":"Automatically fetch assets.","example":true},"shouldDownload":{"type":"boolean","description":"Download firmwares.","example":true},"downloadIpswFilters":{"type":"array","items":{"$ref":"#/components/schemas/IpswFilterV3"},"description":"Filters controlling which IPSW builds are downloaded.","example":[{"device":{"product":"iPhone16,.*"},"include":true}]}},"required":["cacheFirmware","clusterFirmwareAssets","fallbackOriginalUrl","fetchFirmwareAssets","shouldDownload","downloadIpswFilters"]},"PatchFirmwareServiceConfigBody":{"type":"object","properties":{"cacheFirmware":{"type":"boolean","description":"Cache firmwares in /var/ipsw.","example":false},"clusterFirmwareAssets":{"type":"boolean","description":"Assets are cluster-wide.","example":false},"fallbackOriginalUrl":{"type":"boolean","description":"Use original URL to fetch firmware.","example":false},"fetchFirmwareAssets":{"type":"boolean","description":"Automatically fetch assets.","example":true},"shouldDownload":{"type":"boolean","description":"Download firmwares.","example":true},"downloadIpswFilters":{"type":"array","items":{"$ref":"#/components/schemas/IpswFilterV3"},"description":"Filters controlling which IPSW builds are downloaded.","example":[{"device":{"product":"iPhone16,.*"},"include":true}]}}},"FirmwareDeviceList":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/FirmwareDevice"},"description":"Results for this page."},"count":{"type":"integer","minimum":0,"description":"Number of results in this page. Can be less than `limit` on the last page.","example":25},"total":{"type":"integer","minimum":0,"description":"Number of results across all pages, after any filters.","example":137},"limit":{"type":"integer","minimum":0,"description":"The page size that was used (your `limit`, or the default 100).","example":25},"offset":{"type":"integer","minimum":0,"description":"The offset that was used (your `offset`, or the default 0).","example":0},"hasMore":{"type":"boolean","description":"True if more results exist after this page. To read everything, keep requesting with `offset` increased by `limit` until this is false.","example":true}},"required":["results","count","total","limit","offset","hasMore"]},"FirmwareDevice":{"type":"object","properties":{"type":{"type":"string","description":"Device type.","example":"ios"},"model":{"type":"string","description":"Device model.","example":"iPhone13,2"},"name":{"type":"string","description":"Device name.","example":"iPhone 12"},"platform":{"type":"string","description":"Device platform.","example":"t8101"},"hwModel":{"type":"string","description":"Hardware model.","example":"d53gap"},"bdid":{"type":"string","description":"Board ID.","example":"12"},"cpid":{"type":"string","description":"Chip ID.","example":"33025"},"createdAt":{"type":"string","format":"date-time","description":"Creation timestamp.","example":"2026-03-14T09:12:47.000Z"},"updatedAt":{"type":"string","format":"date-time","description":"Last update timestamp.","example":"2026-03-17T11:41:05.000Z"}},"required":["model","name"]},"FirmwareList":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/Firmware"},"description":"Results for this page."},"count":{"type":"integer","minimum":0,"description":"Number of results in this page. Can be less than `limit` on the last page.","example":25},"total":{"type":"integer","minimum":0,"description":"Number of results across all pages, after any filters.","example":137},"limit":{"type":"integer","minimum":0,"description":"The page size that was used (your `limit`, or the default 100).","example":25},"offset":{"type":"integer","minimum":0,"description":"The offset that was used (your `offset`, or the default 0).","example":0},"hasMore":{"type":"boolean","description":"True if more results exist after this page. To read everything, keep requesting with `offset` increased by `limit` until this is false.","example":true}},"required":["results","count","total","limit","offset","hasMore"]},"Firmware":{"type":"object","properties":{"model":{"type":"array","items":{"type":"string"},"description":"Device models the firmware supports.","example":["iPhone12,1","iPhone12,3"]},"firmwareAssets":{"type":"array","nullable":true,"items":{"type":"string"},"description":"Associated firmware asset URLs; null when assets have not been checked for yet.","example":["https://example.com/firmware-assets/asset.bin"]},"filename":{"type":"string","description":"Firmware filename.","example":"firmware.ipsw"},"type":{"type":"string","description":"Firmware type.","example":"ios"},"size":{"type":"number","description":"Firmware size in bytes.","format":"double","example":7838404608},"url":{"type":"string","nullable":true,"description":"Firmware download URL.","example":"https://example.com/firmware.ipsw"},"version":{"type":"string","description":"Firmware version.","example":"17.5"},"buildId":{"type":"string","nullable":true,"description":"Firmware build ID.","example":"21F79"},"md5sum":{"type":"string","nullable":true,"description":"MD5 checksum.","example":"5d41402abc4b2a76b9719d911017c592"},"sha1sum":{"type":"string","nullable":true,"description":"SHA-1 checksum.","example":"aaf4c61ddcc5e8a2dabede0f3b482cd9aea9434d"},"sha256sum":{"type":"string","nullable":true,"description":"SHA-256 checksum.","example":"2cf24dba5fb0a30e26e83b2ac5b9e29e1b161e5c1fa7425e73043362938b9824"},"corelliumChecksum":{"type":"string","nullable":true,"description":"Corellium chunked checksum (<algo>$<chunkSize>$<hash>); used for upload preflight.","example":"sha256$1048576$2cf24dba5fb0a30e26e83b2ac5b9e29e1b161e5c1fa7425e73043362938b9824"},"releaseDate":{"type":"string","nullable":true,"description":"Release date; may be an empty string.","example":"2026-05-22T13:58:34.000Z"},"uploadDate":{"type":"string","nullable":true,"description":"Upload date; may be an empty string.","example":"2026-05-22T13:58:34.000Z"},"metadata":{"type":"object","nullable":true,"additionalProperties":{"nullable":true},"description":"Firmware metadata.","example":{"variants":["domain"]}},"uniqueId":{"type":"string","nullable":true,"description":"Customer-provided identifier; an arbitrary string, not a UUID.","example":"acme-fw-0001"},"androidFlavor":{"type":"string","nullable":true,"description":"Android device flavor; only present for coreimg firmwares.","example":"ranchu"},"apiVersion":{"type":"string","nullable":true,"description":"Android API version; only present for coreimg firmwares.","example":"34"},"rooted":{"type":"boolean","nullable":true,"description":"Whether a device created from this firmware is rooted. Android publishes a `<rev> user` (not rooted) and a `<rev> userdebug` (rooted) build per version. Null on iOS, where rooting is not a property of the firmware.","example":true},"installed":{"type":"boolean","nullable":true,"description":"Whether the firmware is installed.","example":true},"createdAt":{"type":"string","format":"date-time","description":"When the record was created.","example":"2026-03-14T09:12:47.000Z"},"updatedAt":{"type":"string","format":"date-time","description":"When the record was last updated.","example":"2026-03-17T11:41:05.000Z"}},"required":["model","filename","size","version"]},"FirmwareAssetList":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/FirmwareAsset"},"description":"Results for this page."},"count":{"type":"integer","minimum":0,"description":"Number of results in this page. Can be less than `limit` on the last page.","example":25},"total":{"type":"integer","minimum":0,"description":"Number of results across all pages, after any filters.","example":137},"limit":{"type":"integer","minimum":0,"description":"The page size that was used (your `limit`, or the default 100).","example":25},"offset":{"type":"integer","minimum":0,"description":"The offset that was used (your `offset`, or the default 0).","example":0},"hasMore":{"type":"boolean","description":"True if more results exist after this page. To read everything, keep requesting with `offset` increased by `limit` until this is false.","example":true}},"required":["results","count","total","limit","offset","hasMore"]},"FirmwareAsset":{"type":"object","properties":{"domain":{"type":"string","format":"uuid","description":"Owning domain identifier.","example":"c29762d1-45d7-489d-a3a2-9dadc43978ba"},"url":{"type":"string","description":"Asset URL.","example":"https://example.com/firmware-assets/asset.bin"},"payload":{"type":"string","description":"Base64-encoded asset payload.","example":"aGVsbG8gd29ybGQ="},"size":{"type":"number","description":"Asset size in bytes.","format":"double","example":324},"md5sum":{"type":"string","description":"MD5 checksum.","example":"5d41402abc4b2a76b9719d911017c592"},"sha1sum":{"type":"string","description":"SHA-1 checksum.","example":"aaf4c61ddcc5e8a2dabede0f3b482cd9aea9434d"},"sha256sum":{"type":"string","description":"SHA-256 checksum.","example":"2cf24dba5fb0a30e26e83b2ac5b9e29e1b161e5c1fa7425e73043362938b9824"},"uploadDate":{"type":"string","nullable":true,"description":"Upload date; may be an empty string.","example":"2026-05-22T13:58:34.000Z"},"createdAt":{"type":"string","format":"date-time","description":"When the record was created.","example":"2026-03-14T09:12:47.000Z"},"updatedAt":{"type":"string","format":"date-time","description":"When the record was last updated.","example":"2026-03-17T11:41:05.000Z"}},"required":["domain","url","payload","size"]},"FirmwareAssetFilter":{"type":"object","properties":{"url":{"type":"string","description":"Filter by exact URL.","example":"https://example.com/firmware-assets/asset.bin"},"domain":{"type":"string","description":"Filter by exact domain.","example":"c29762d1-45d7-489d-a3a2-9dadc43978ba"}},"description":"Exact-match filters (filter[url], filter[domain])."},"FirmwareAssetsCreatedBody":{"type":"string","description":"The firmware service's response text, relayed as-is."},"CreateFirmwareAssetsBody":{"type":"object","additionalProperties":{"type":"string"},"example":{"https://example.com/firmware-assets/asset.bin":"aGVsbG8gd29ybGQ="}},"ExtendedFirmwareAssetInfo":{"type":"object","properties":{"firmwares":{"type":"array","items":{"type":"string"},"description":"Firmware filenames using this asset.","example":["firmware.ipsw"]},"instances":{"type":"array","items":{"type":"string","format":"uuid"},"description":"Instance identifiers using one of the firmwares.","example":["f7f9832a-f824-416f-a5ea-4adfe34754b5"]}},"required":["firmwares","instances"]},"ActivityListResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/Activity"},"description":"Activity list."},"count":{"type":"integer","minimum":0,"description":"Number of results in this page. Can be less than `limit` on the last page.","example":25},"total":{"type":"integer","minimum":0,"description":"Number of results across all pages, after any filters.","example":137},"limit":{"type":"integer","minimum":0,"description":"The page size that was used (your `limit`, or the default 100).","example":25},"offset":{"type":"integer","minimum":0,"description":"The offset that was used (your `offset`, or the default 0).","example":0},"hasMore":{"type":"boolean","description":"True if more results exist after this page. To read everything, keep requesting with `offset` increased by `limit` until this is false.","example":true}},"required":["results","count","total","limit","offset","hasMore"]},"Activity":{"type":"object","properties":{"identifier":{"type":"string","format":"uuid","description":"Unique identifier for the activity entry.","example":"5927ac2a-fdd4-4ab5-860f-28eec3511028"},"domain":{"type":"string","format":"uuid","description":"Unique identifier for the domain.","example":"c29762d1-45d7-489d-a3a2-9dadc43978ba"},"actor":{"type":"string","format":"uuid","description":"Unique identifier for the user.","example":"e8c5b7ea-aa5f-4a4a-bdca-0c67060b5320"},"event":{"type":"string","enum":["domain.config.device_auto_shutdown","auth.provider.enabled","auth.provider.disabled","instance.status.shutoff","instance.status.active","user.logged_in","user.logged_out","user.password.updated","user.2fa.enabled","user.2fa.disabled","invite.created","invite.deleted","project.user.added","project.user.removed","project.team.added","team.user.added","project.team.removed","team.user.removed","user.updated","user.deleted","team.created","team.updated","team.deleted","instance.created","instance.cloned","instance.deleted","project.created","project.updated","project.deleted","network.created","network.updated","network.deleted","welcome.message.created","welcome.message.updated","mast_assessment.created","mast_assessment.deleted","mast_assessment.start_monitoring","mast_assessment.stop_monitoring","mast_assessment.run_checks","mast_assessment.report_generated","mast_assessment.check.severity","mast_assessment.check.outcome","mast_assessment.check.evidence"],"description":"Resource associated with the activity."},"outcome":{"type":"string","enum":["success","fail"],"description":"The outcome of the activity."},"metadata":{"type":"object","nullable":true,"additionalProperties":{"nullable":true},"description":"Related information that pertains to the activity.","example":{"name":"My iPhone 13 Pro"}},"corelliumVersion":{"type":"string","nullable":true,"description":"The Corellium version this activity occurred in.","example":"7.4.0-28212"},"projectId":{"type":"string","nullable":true,"format":"uuid","description":"Unique identifier for project if applicable.","example":"1c41b1bc-4f53-48a8-b690-ad30611e1960"},"instanceId":{"type":"string","nullable":true,"format":"uuid","description":"Unique identifier for instance if applicable.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"createdAt":{"type":"string","format":"date-time","description":"Timestamp of when the activity was created.","example":"2026-03-14T09:12:47.000Z"},"updatedAt":{"type":"string","format":"date-time","description":"Timestamp of when the activity was last updated.","example":"2026-03-17T11:41:05.000Z"}},"required":["identifier","domain","actor","event","outcome","metadata","corelliumVersion","projectId","instanceId","createdAt","updatedAt"]},"ActivityResourceStartsWithFilter":{"type":"object","properties":{"startsWith":{"anyOf":[{"type":"string","example":"instance."},{"type":"array","items":{"type":"string"},"example":["instance.created","instance.deleted"]}],"description":"Match resources beginning with one or more prefixes.","example":"instance."}},"required":["startsWith"],"additionalProperties":false},"ActivityResourceNotStartsWithFilter":{"type":"object","properties":{"!startsWith":{"anyOf":[{"type":"string","example":"instance."},{"type":"array","items":{"type":"string"},"example":["instance.created","instance.deleted"]}],"description":"Exclude resources beginning with one or more prefixes.","example":["user.","auth."]}},"required":["!startsWith"],"additionalProperties":false},"CreateActivityExportResponse":{"type":"object","properties":{"id":{"type":"string","description":"Export task ID, in the form `activity-export/<UUID>`. Pass only the `<UUID>` part to `v3GetActivityExportStatus` and `v3DownloadActivity`.","example":"activity-export/722cdce5-6f71-4f4a-b2b6-c00f11c015f6"}},"required":["id"]},"ActivityExportFormat":{"type":"string","enum":["application/json","text/csv"],"description":"Specifies the activity export file format."},"CreateActivityExportBody":{"type":"object","properties":{"resource":{"anyOf":[{"type":"string"},{"$ref":"#/components/schemas/ActivityResourceStartsWithFilter"},{"$ref":"#/components/schemas/ActivityResourceNotStartsWithFilter"}],"description":"Resource equality or LHS prefix filter. Examples: `resource=value`, `resource[startsWith]=value`, and `resource[!startsWith]=value`.","example":"instance.created"},"offset":{"type":"integer","nullable":true,"minimum":0,"default":0,"description":"Number of results to skip."},"orderBy":{"type":"string","pattern":"^-?[a-zA-Z_]+$","default":"-createdAt","description":"Field to sort by, for example `createdAt`. Prefix with `-` for newest or largest first. Defaults to `-createdAt` (newest first).","example":"-createdAt"},"instanceId":{"type":"string","description":"Only activity about this device.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"projectId":{"type":"string","description":"Only activity in this project.","example":"1c41b1bc-4f53-48a8-b690-ad30611e1960"},"actor":{"type":"string","description":"Only activity performed by this user (user ID).","example":"e8c5b7ea-aa5f-4a4a-bdca-0c67060b5320"},"search":{"type":"string","description":"Free-text search. Applied last, as a loose match on the results that pass the other filters.","example":"iPhone15,2"},"to":{"type":"string","nullable":true,"format":"date-time","description":"Only activity at or before this time (ISO 8601).","example":"2026-05-22T13:58:34.000Z"},"from":{"type":"string","nullable":true,"format":"date-time","description":"Only activity at or after this time (ISO 8601).","example":"2026-05-22T00:00:00.000Z"}}},"ActivityExportTaskList":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/ActivityExportTask"},"description":"List of export tasks."},"count":{"type":"integer","minimum":0,"description":"Number of results in this page. Can be less than `limit` on the last page.","example":25},"total":{"type":"integer","minimum":0,"description":"Number of results across all pages, after any filters.","example":137},"limit":{"type":"integer","minimum":0,"description":"The page size that was used (your `limit`, or the default 100).","example":25},"offset":{"type":"integer","minimum":0,"description":"The offset that was used (your `offset`, or the default 0).","example":0},"hasMore":{"type":"boolean","description":"True if more results exist after this page. To read everything, keep requesting with `offset` increased by `limit` until this is false.","example":true}},"required":["results","count","total","limit","offset","hasMore"]},"ActivityExportTask":{"type":"object","properties":{"identifier":{"type":"string","description":"Task identifier in the form `activity-export/<UUID>`.","example":"activity-export/722cdce5-6f71-4f4a-b2b6-c00f11c015f6"},"scheduledAt":{"type":"string","format":"date-time","description":"Timestamp of when the task is scheduled to execute.","example":"2026-03-14T09:12:47.000Z"},"status":{"type":"string","nullable":true,"enum":["in-progress","complete","error",null],"description":"Where the export task is. Poll until it is `complete`, then download the file."},"args":{"type":"object","additionalProperties":{"nullable":true},"description":"Arguments passed to the task.","example":{"handlerName":"activity-export","exportType":"text/csv","domainId":"c29762d1-45d7-489d-a3a2-9dadc43978ba","userId":"e8c5b7ea-aa5f-4a4a-bdca-0c67060b5320","apiVersion":"v3"}},"createdAt":{"type":"string","format":"date-time","description":"Timestamp of when the task was created.","example":"2026-03-14T09:12:47.000Z"},"updatedAt":{"type":"string","format":"date-time","description":"Timestamp of when the task was last updated.","example":"2026-03-17T11:41:05.000Z"}},"required":["identifier","scheduledAt","status","args","createdAt","updatedAt"]},"ActivityExportStatus":{"type":"object","properties":{"status":{"type":"string","nullable":true,"enum":["in-progress","complete","error",null],"description":"Where the export task is. Poll until it is `complete`, then download the file."}},"required":["status"]},"BillingSummary":{"type":"object","properties":{"pendingUsageBased":{"type":"object","nullable":true,"properties":{"lastBillDate":{"type":"number","description":"Last bill unix timestamp (ms).","example":1773479567000},"nextBillDate":{"type":"number","description":"Next bill unix timestamp (ms).","example":1774084367000},"billingThreshold":{"type":"number","description":"Dollar threshold that triggers a usage bill.","example":100},"total":{"type":"string","description":"Pending total in dollars, as a fixed two-decimal string.","example":"49.99"},"lineItems":{"type":"array","items":{"$ref":"#/components/schemas/BillingLineItem"},"description":"Pending usage line items. May be empty."}},"required":["lastBillDate","nextBillDate","billingThreshold","total","lineItems"],"description":"Pending usage-based bill report. Null unless the domain bills by usage."}},"required":["pendingUsageBased"]},"BillingLineItem":{"type":"object","properties":{"type":{"type":"string","description":"Usage category name.","example":"On"},"name":{"type":"string","description":"Line item name.","example":"iPhone 13 Pro on per hour"},"shortName":{"type":"string","description":"Short line item name.","example":"iPhone 13 Pro"},"description":{"type":"string","description":"Line item description. May be empty.","example":"my-device, OS version 17.5, OS build 21F79"},"quantity":{"type":"number","description":"Units used.","example":6.25},"unit_cost":{"type":"number","description":"Cost per unit.","example":8}},"required":["type","name","shortName","description","quantity","unit_cost"]},"Subscription":{"type":"object","properties":{"trial":{"type":"object","nullable":true,"properties":{"status":{"type":"string","enum":["not_started","active","completed"],"description":"Trial status."},"start":{"type":"string","nullable":true,"format":"date-time","description":"Trial start time, or null.","example":"2026-03-16T08:22:19.000Z"},"end":{"type":"string","nullable":true,"format":"date-time","description":"Trial end time, or null.","example":"2027-01-15T00:00:00.000Z"},"usedHours":{"type":"number","nullable":true,"minimum":0,"description":"Trial hours used, or null.","example":6},"maxHours":{"type":"number","nullable":true,"minimum":0,"description":"Trial hour allowance, or null.","example":24}},"required":["status","start","end","usedHours","maxHours"],"description":"Trial usage details, or null when the domain has no trial."},"status":{"type":"string","nullable":true,"description":"Subscription status. Null on domains without billing.","example":"active"},"billingType":{"type":"string","description":"Billing type.","example":"usage"},"planName":{"type":"string","nullable":true,"description":"Plan name.","example":"Viper Essentials"},"nextBill":{"type":"string","nullable":true,"description":"Next billing date. Omitted on domains without billing.","example":"2027-01-15T00:00:00.000Z"},"useDeviceAccounting":{"type":"boolean","nullable":true,"description":"Whether device accounting is used.","example":true},"isEnterprise":{"type":"boolean","nullable":true,"description":"Whether the plan is enterprise.","example":false},"isUsageBased":{"type":"boolean","nullable":true,"description":"Whether the plan is usage based.","example":true},"cancelPolicy":{"type":"string","nullable":true,"description":"Cancellation policy.","example":"period_end"}},"required":["trial","status","billingType","planName","useDeviceAccounting","isEnterprise","isUsageBased","cancelPolicy"]},"MeteredSubscriptionUsage":{"type":"object","properties":{"burstRate":{"type":"number","description":"Unit price for burst usage.","example":800},"allocatedHours":{"type":"number","description":"Allocated hours.","example":100},"planBilledAmount":{"type":"number","description":"Plan cost.","example":99500},"burstBilledAmount":{"type":"number","description":"Burst amount billed.","example":29600},"burstBilledUnits":{"type":"number","description":"Burst units billed.","example":37},"burstOutstandingAmount":{"type":"number","description":"Outstanding burst amount.","example":9600},"burstOutstandingUnits":{"type":"number","description":"Outstanding burst units.","example":12},"totalUsageAmount":{"type":"number","description":"Total cost in cents for the period.","example":138700},"totalUsedUnits":{"type":"number","description":"Total used units for the period.","example":149}},"required":["burstRate","allocatedHours","planBilledAmount","burstBilledAmount","burstBilledUnits","burstOutstandingAmount","burstOutstandingUnits","totalUsageAmount","totalUsedUnits"]},"DeviceUsage":{"type":"object","properties":{"hoursUsed":{"type":"number","nullable":true,"description":"Device hours used.","example":62.5},"hoursMax":{"type":"number","nullable":true,"description":"Device hours allowed.","example":100}},"required":["hoursUsed","hoursMax"]},"CancelSubscriptionBody":{"type":"object","properties":{"domainId":{"type":"string","format":"uuid","description":"Domain to cancel (defaults to the caller domain).","example":"c29762d1-45d7-489d-a3a2-9dadc43978ba"},"deleteDomain":{"type":"boolean","description":"Delete the domain as part of cancellation.","example":false}}},"UncancelSubscriptionBody":{"type":"object","properties":{"domainId":{"type":"string","format":"uuid","description":"Domain to uncancel (defaults to the caller domain).","example":"c29762d1-45d7-489d-a3a2-9dadc43978ba"}}},"SubscribeToTrialResponse":{"type":"object","additionalProperties":{"nullable":true}},"SubscribeToTrialBody":{"type":"object","properties":{"trialRequestCode":{"type":"string","description":"Trial request code.","example":"TRIAL2026"},"password":{"type":"string","description":"Account password.","example":"<redacted>"},"termsOfService":{"type":"boolean","description":"Whether terms of service were accepted.","example":true},"enterpriseDomainName":{"type":"string","description":"Enterprise domain name.","example":"acme-corp"},"sso":{"type":"boolean","description":"Whether this is an SSO-based subscription.","example":false},"email":{"type":"string","description":"Requester email.","example":"jane.doe@example.com"},"name":{"type":"string","description":"Requester name.","example":"Jane Doe"},"federatedUserId":{"type":"string","description":"Federated user identifier.","example":"okta|00u1a2b3c4d5e6f7g8h9"}}},"DomainSoftwareList":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/DomainSoftware"},"description":"Domain-level firmware images: uploads not scoped to a project or instance."},"count":{"type":"integer","minimum":0,"description":"Number of results in this page. Can be less than `limit` on the last page.","example":25},"total":{"type":"integer","minimum":0,"description":"Number of results across all pages, after any filters.","example":137},"limit":{"type":"integer","minimum":0,"description":"The page size that was used (your `limit`, or the default 100).","example":25},"offset":{"type":"integer","minimum":0,"description":"The offset that was used (your `offset`, or the default 0).","example":0},"hasMore":{"type":"boolean","description":"True if more results exist after this page. To read everything, keep requesting with `offset` increased by `limit` until this is false.","example":true}},"required":["results","count","total","limit","offset","hasMore"]},"DomainSoftware":{"type":"object","properties":{"imageId":{"type":"string","format":"uuid","description":"Identifier of the uploaded image. Pass to `deleteImage` to remove the upload.","example":"3e1354a3-fb10-46c0-8b05-56e28edbde69"},"flavor":{"type":"string","description":"Flavor the firmware applies to.","example":"iphone17a"},"description":{"type":"string","description":"Human-readable device name.","example":"iPhone Air"},"model":{"type":"string","description":"Device product identifier.","example":"iPhone18,4"},"platform":{"type":"string","nullable":true,"description":"Device platform, when known.","example":"t8101"},"hasProductImage":{"type":"boolean","description":"Whether a product image is available for this flavor.","example":true},"osVersion":{"type":"string","nullable":true,"description":"OS version.","example":"17.5"},"osBuild":{"type":"string","nullable":true,"description":"OS build.","example":"21F79"},"filename":{"type":"string","description":"Uploaded filename.","example":"iPhone18,4_17.5_21F79_Restore.ipsw"},"size":{"type":"number","nullable":true,"description":"Firmware size in bytes.","format":"double","example":7516192768},"releaseDate":{"type":"string","nullable":true,"format":"date-time","description":"Release date.","example":"2026-03-14T09:12:47.000Z"},"uploadDate":{"type":"string","format":"date-time","description":"Date the firmware was uploaded.","example":"2026-03-17T11:41:05.000Z"},"downloadUrl":{"type":"string","nullable":true,"description":"Signed link the firmware can be downloaded from.","example":"https://example.com/firmware/iPhone18,4_17.5_21F79_Restore.ipsw?signature=<signature>"}},"required":["imageId","flavor","description","model","platform","hasProductImage","osVersion","osBuild","filename","size","releaseDate","uploadDate","downloadUrl"]},"CreateDomainAuthProviderResponse":{"type":"object","properties":{"identifier":{"type":"string","format":"uuid","description":"Provider identifier.","example":"8036ef76-8194-4a7c-95b2-42606a5d0171"},"config":{"anyOf":[{"$ref":"#/components/schemas/SAMLConfig"},{"$ref":"#/components/schemas/OpenIDConfig"},{"$ref":"#/components/schemas/LDAPConfig"},{"nullable":true}],"description":"Optional configuration."},"providerType":{"type":"string","description":"Provider type.","example":"open-id-connect"},"label":{"type":"string","description":"Login button text.","example":"Log in with Okta"},"enabled":{"type":"boolean","description":"Enabled/Disabled.","example":true},"createdBy":{"type":"string","nullable":true,"format":"uuid","description":"Optional User ID of creator.","example":"e8c5b7ea-aa5f-4a4a-bdca-0c67060b5320"},"default":{"type":"boolean","description":"True: configured in coordinator.json, False: custom domain provider.","example":false},"createdAt":{"type":"string","format":"date-time","description":"Created date in ISO-8601 format e.g. 2022-05-06T02:39:23.000Z.","example":"2026-03-14T09:12:47.000Z"},"updatedAt":{"type":"string","format":"date-time","description":"Updated date in ISO-8601 format e.g. 2022-05-06T02:39:23.000Z.","example":"2026-03-17T11:41:05.000Z"}},"required":["identifier","providerType","label","enabled","default"]},"SAMLConfig":{"type":"object","properties":{"identityProviderConfig":{"$ref":"#/components/schemas/SamlIdentityProviderConfig"},"serviceProviderConfig":{"$ref":"#/components/schemas/SamlServiceProviderConfig"},"userAttributeMapping":{"$ref":"#/components/schemas/SamlUserAttributeMapping"},"groupMapping":{"type":"array","items":{"$ref":"#/components/schemas/SamlGroupMapping"}}},"required":["identityProviderConfig"],"additionalProperties":{"nullable":true},"description":"SAML provider configuration."},"SamlIdentityProviderConfig":{"type":"object","properties":{"loginUrl":{"type":"string","description":"IdP SSO login endpoint the AuthnRequest is sent to.","example":"https://idp.example.com/sso/saml"},"publicCertificate":{"type":"string","description":"IdP X.509 public certificate, used to verify the SAML response.","example":"-----BEGIN CERTIFICATE-----\n<base64-encoded-x509-certificate>\n-----END CERTIFICATE-----"},"issuerUrl":{"type":"string","description":"IdP unique identifier (issuer / entity ID).","example":"https://idp.example.com/saml/metadata"},"logoutUrl":{"type":"string","description":"Optional IdP Single Logout URL.","example":"https://idp.example.com/slo/saml"}},"required":["loginUrl","publicCertificate","issuerUrl"],"additionalProperties":{"nullable":true}},"SamlServiceProviderConfig":{"type":"object","properties":{"ssoUrl":{"type":"string","description":"SP assertion consumer service URL.","example":"https://acme-corp.example.com/api/v1/auth/providers/idp.example.com/callback"},"publicCertificate":{"type":"string","description":"SP X.509 public certificate.","example":"-----BEGIN CERTIFICATE-----\n<base64-encoded-x509-certificate>\n-----END CERTIFICATE-----"},"audienceUrl":{"type":"string","description":"SP audience / entity ID.","example":"https://acme-corp.example.com/api/v1/auth/providers/idp.example.com/spmetadata"}},"required":["ssoUrl","publicCertificate","audienceUrl"],"additionalProperties":{"nullable":true},"description":"Service-provider configuration, generated by the server. Never includes the private key."},"SamlUserAttributeMapping":{"type":"object","properties":{"username":{"type":"string","description":"SAML assertion attribute mapped to username.","example":"username"},"email":{"type":"string","description":"SAML assertion attribute mapped to email.","example":"email"},"firstName":{"type":"string","description":"SAML assertion attribute mapped to first name.","example":"firstName"},"lastName":{"type":"string","description":"SAML assertion attribute mapped to last name.","example":"lastName"},"group":{"type":"string","description":"SAML assertion attribute mapped to group.","example":"groups"}},"required":["email","firstName","lastName","group"],"additionalProperties":{"nullable":true}},"SamlGroupMapping":{"type":"object","properties":{"groupName":{"type":"string","description":"Group name in the IdP.","example":"Mobile-PenTesters"},"role":{"type":"string","description":"Role granted in Corellium (e.g. admin, member).","example":"admin"},"team":{"type":"string","description":"Associated Corellium team.","example":"089c8ffd-ca4d-4d35-80ab-0847d18b7213"}},"required":["groupName","role","team"],"additionalProperties":{"nullable":true}},"OpenIDConfig":{"type":"object","properties":{"discoveryUrl":{"type":"string","description":"Service Discovery URL.","example":"https://accounts.example.com/.well-known/openid-configuration"},"clientId":{"type":"string","description":"Service Client ID.","example":"corellium-domain-client"},"clientSecret":{"type":"string","description":"Service Client Secret.","example":"<client-secret>"},"invitedOnly":{"type":"boolean","description":"Only accept individuals with invitations.","example":false}},"required":["discoveryUrl","clientId","clientSecret"],"additionalProperties":{"nullable":true}},"LDAPConfig":{"type":"object","properties":{"serverConnectionDetails":{"$ref":"#/components/schemas/LdapServerConnectionDetails"},"authenticationCredentials":{"$ref":"#/components/schemas/LdapAuthenticationCredentials"},"userSearchConfiguration":{"$ref":"#/components/schemas/LdapUserSearchConfiguration"},"userAttributeMapping":{"$ref":"#/components/schemas/LdapUserAttributeMapping"},"groupSearchConfiguration":{"type":"array","items":{"$ref":"#/components/schemas/LdapGroupSearchConfiguration"}}},"required":["serverConnectionDetails","authenticationCredentials","userSearchConfiguration"],"additionalProperties":{"nullable":true},"description":"LDAP provider configuration."},"LdapServerConnectionDetails":{"type":"object","properties":{"serverUrl":{"type":"string","description":"LDAP server URL.","example":"ldap.example.com"},"port":{"type":"string","description":"LDAP server port.","example":"389"},"connectionTimeout":{"type":"string","description":"Connection timeout.","example":"5000"},"enableLdaps":{"type":"boolean","description":"Whether to connect over LDAPS.","example":false},"caCert":{"type":"string","description":"CA certificate for LDAPS.","example":"-----BEGIN CERTIFICATE-----\n<base64-encoded-ca-certificate>\n-----END CERTIFICATE-----"},"caVerify":{"type":"boolean","description":"Whether to verify the server certificate.","example":true}},"required":["serverUrl"],"additionalProperties":{"nullable":true}},"LdapAuthenticationCredentials":{"type":"object","properties":{"bindDn":{"type":"string","description":"Bind DN used to authenticate to the LDAP server.","example":"cn=admin,dc=example,dc=com"},"bindPassword":{"type":"string","description":"Bind password.","example":"<redacted>"}},"required":["bindDn","bindPassword"],"additionalProperties":{"nullable":true}},"LdapUserSearchConfiguration":{"type":"object","properties":{"baseDn":{"type":"string","description":"Base DN for user search.","example":"dc=example,dc=com"},"userSearchBase":{"type":"string","description":"Sub-tree to search for users.","example":"ou=users"},"userSearchFilter":{"type":"string","description":"Filter used to locate users.","example":"objectClass=inetOrgPerson"}},"required":["baseDn"],"additionalProperties":{"nullable":true}},"LdapUserAttributeMapping":{"type":"object","properties":{"usernameAttribute":{"type":"string","description":"LDAP attribute mapped to username.","example":"uid"},"emailAttribute":{"type":"string","description":"LDAP attribute mapped to email.","example":"mail"},"firstNameAttribute":{"type":"string","description":"LDAP attribute mapped to first name.","example":"givenName"},"lastNameAttribute":{"type":"string","description":"LDAP attribute mapped to last name.","example":"sn"}},"additionalProperties":{"nullable":true}},"LdapGroupSearchConfiguration":{"type":"object","properties":{"groupBaseDn":{"type":"string","description":"Base DN for group search.","example":"ou=groups,dc=example,dc=com"},"groupSearchFilter":{"type":"string","description":"Filter used to locate groups.","example":"objectClass=groupOfNames"},"teamId":{"type":"string","description":"Corellium team the group maps to.","example":"089c8ffd-ca4d-4d35-80ab-0847d18b7213"},"role":{"type":"string","description":"Role granted to members of the group.","example":"admin"}},"required":["groupBaseDn","teamId"],"additionalProperties":{"nullable":true}},"CreateDomainAuthProviderBody":{"type":"object","properties":{"providerType":{"type":"string","description":"Provider type.","example":"open-id-connect"},"enabled":{"type":"boolean","description":"Whether the provider is enabled.","example":true},"label":{"type":"string","description":"Login button text.","example":"Log in with Okta"},"config":{"$ref":"#/components/schemas/DomainAuthProviderConfig"}},"required":["providerType","enabled"]},"DomainAuthProviderConfig":{"anyOf":[{"$ref":"#/components/schemas/SAMLConfig"},{"$ref":"#/components/schemas/OpenIDConfig"},{"$ref":"#/components/schemas/LDAPConfig"}],"description":"Optional configuration."},"DomainAuthProvidersList":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/DomainAuthProviderResponse"},"description":"List of auth providers for domain."},"count":{"type":"integer","minimum":0,"description":"Number of results in this page. Can be less than `limit` on the last page.","example":25},"total":{"type":"integer","minimum":0,"description":"Number of results across all pages, after any filters.","example":137},"limit":{"type":"integer","minimum":0,"description":"The page size that was used (your `limit`, or the default 100).","example":25},"offset":{"type":"integer","minimum":0,"description":"The offset that was used (your `offset`, or the default 0).","example":0},"hasMore":{"type":"boolean","description":"True if more results exist after this page. To read everything, keep requesting with `offset` increased by `limit` until this is false.","example":true}},"required":["results","count","total","limit","offset","hasMore"]},"DomainAuthProviderResponse":{"type":"object","properties":{"identifier":{"type":"string","format":"uuid","description":"Provider identifier.","example":"8036ef76-8194-4a7c-95b2-42606a5d0171"},"config":{"anyOf":[{"$ref":"#/components/schemas/SAMLConfig"},{"$ref":"#/components/schemas/OpenIDConfig"},{"$ref":"#/components/schemas/LDAPConfig"},{"nullable":true}],"description":"Optional configuration."},"providerType":{"type":"string","description":"Provider type.","example":"open-id-connect"},"label":{"type":"string","description":"Login button text.","example":"Log in with Okta"},"enabled":{"type":"boolean","description":"Enabled/Disabled.","example":true},"createdBy":{"type":"string","nullable":true,"format":"uuid","description":"Optional User ID of creator.","example":"e8c5b7ea-aa5f-4a4a-bdca-0c67060b5320"},"default":{"type":"boolean","description":"True: configured in coordinator.json, False: custom domain provider.","example":false},"authorizationUrl":{"type":"string","description":"Coordinator endpoint for Authorizing with this provider.","example":"/api/v3/auth/providers/sso.example.com/authorization_url"},"name":{"type":"string","description":"Provider name for a given provider type.","example":"Okta"},"createdAt":{"type":"string","format":"date-time","description":"Created date in ISO-8601 format e.g. 2022-05-06T02:39:23.000Z.","example":"2026-03-14T09:12:47.000Z"},"updatedAt":{"type":"string","format":"date-time","description":"Updated date in ISO-8601 format e.g. 2022-05-06T02:39:23.000Z.","example":"2026-03-17T11:41:05.000Z"}},"required":["identifier","providerType","label","enabled","default"]},"PatchDomainAuthProviderBody":{"type":"object","properties":{"providerType":{"type":"string","description":"Provider type.","example":"open-id-connect"},"enabled":{"type":"boolean","description":"Whether the provider is enabled.","example":true},"label":{"type":"string","description":"Login button text.","example":"Log in with Okta"},"config":{"$ref":"#/components/schemas/DomainAuthProviderConfig"}}},"DomainWelcomeMessageResponse":{"type":"object","properties":{"identifier":{"type":"string","format":"uuid","description":"Unique identifier for the welcome message.","example":"b10bd74a-a906-46b9-a4f3-a45cccdc2576"},"domain":{"type":"string","format":"uuid","description":"Domain identifier.","example":"c29762d1-45d7-489d-a3a2-9dadc43978ba"},"message":{"type":"string","description":"Sanitized welcome message text.","example":"Welcome to Acme Corp! Get started by creating your first device."},"enabled":{"type":"boolean","description":"Whether the welcome message is shown to users.","example":true},"createdAt":{"type":"string","format":"date-time","description":"Creation timestamp (ISO 8601).","example":"2026-03-14T09:12:47.000Z"},"updatedAt":{"type":"string","format":"date-time","description":"Last update timestamp (ISO 8601).","example":"2026-03-17T11:41:05.000Z"}},"required":["identifier","domain","message","enabled","createdAt","updatedAt"]},"SetDomainWelcomeMessageBody":{"type":"object","properties":{"message":{"type":"string","minLength":1,"description":"The welcome message text (HTML allowed, will be sanitized).","example":"<p>Welcome to Acme Corp!</p>"},"enabled":{"type":"boolean","description":"Whether the welcome message is shown to users.","example":true}},"required":["message","enabled"]},"PatchDomainWelcomeMessageBody":{"type":"object","properties":{"message":{"type":"string","minLength":1,"description":"The welcome message text (HTML allowed, will be sanitized).","example":"<p>Welcome to Acme Corp!</p>"},"enabled":{"type":"boolean","description":"Whether the welcome message is shown to users.","example":true}}},"Image":{"type":"object","properties":{"status":{"type":"string","description":"Image status.","example":"active"},"id":{"type":"string","format":"uuid","description":"Image ID.","example":"3e1354a3-fb10-46c0-8b05-56e28edbde69"},"name":{"type":"string","description":"Name of the image, usually the original filename. Names are not unique: several images can share a name.","example":"firmware.ipsw"},"type":{"$ref":"#/components/schemas/ImageType"},"size":{"type":"number","nullable":true,"description":"Size in bytes; null until upload completes.","example":2147483648},"checksum":{"type":"string","nullable":true,"description":"MD5 checksum; null until upload completes.","example":"9e107d9d372bb6826bd81d3542a419d6"},"corelliumChecksum":{"type":"string","nullable":true,"description":"Corellium checksum of the image; null until upload completes.","example":"sha256$1048576$e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"},"encoding":{"$ref":"#/components/schemas/ImageEncoding"},"project":{"type":"string","nullable":true,"format":"uuid","description":"ID of the project the image belongs to. Null for a domain-level image, which is available across your domain rather than to one project.","example":"1c41b1bc-4f53-48a8-b690-ad30611e1960"},"instance":{"type":"string","nullable":true,"format":"uuid","description":"ID of the instance (device) the image is attached to, or null if it is not attached to one.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"createdAt":{"type":"string","format":"date-time","description":"When Image was created.","example":"2026-03-14T09:12:47.000Z"},"updatedAt":{"type":"string","format":"date-time","description":"When Image was last updated.","example":"2026-03-17T11:41:05.000Z"}},"required":["status","id","name","type"]},"ImageType":{"type":"string","enum":["fwbinary","fwpackage","iotfirmware","kernel","devicetree","ramdisk","loaderfile","media","sepfw","seprom","bootrom","llb","iboot","ibootdata","fw","fwasset","partition","extension","vmfile","backup","activity-export","ufd","clbi","pongo","mast-report","mast-frida","mast-wordlist"],"description":"What kind of file the image holds. The type decides what the platform does with the file, so choose it carefully.\n\n**Firmware (whole operating-system images):**\n- `fw`: a complete firmware bundle for creating devices, such as an iOS IPSW or a Corellium `.coreimg` package. Install it cluster-wide with `installFirmware`, or upload it at domain level (no `projectId` or `instanceId`) so device creation can find it.\n- `fwpackage`: another name for `fw`. It is stored as `fw`, and v3 responses report `fw` images as `fwpackage`.\n- `iotfirmware`: firmware for IoT and embedded device models, such as an ELF executable, a raw binary, or a ZIP with a `LOAD.TXT` load map.\n- `fwbinary`: another name for `iotfirmware`. v3 responses report `iotfirmware` images as `fwbinary`.\n- `fwasset`: a JSON file of firmware assets (for example decryption keys), not firmware itself. Install it with `installFirmwareAssets`.\n- `clbi`: a Cellebrite firmware image. Like `fw`, a Cellebrite firmware image uploaded at domain level (no `projectId` or `instanceId`) is offered as a choice when you create a device.\n\n**Files for a specific device:**\n- `partition`: replacement contents for one storage partition of a device. The platform needs a device model to check it against: attach it to a device with `instanceId`, or pass `flavor` on the image-upload routes. `name` must be a partition that model lets users upload.\n- Other types such as `kernel`, `devicetree`, `ramdisk`, `media` and `extension` name the kind of file; the endpoint that uses each one describes it.\n\n**MATRIX files** (always attached to an instance, and never replaced by later uploads):\n- `mast-wordlist`: a text file of sensitive values for a MATRIX assessment to search for.\n- `mast-frida`: a Frida script to load during a MATRIX assessment.\n- `mast-report`: a report generated by MATRIX. Created by the platform, not uploaded.\n\nSome types require a license feature. Using one your license does not include fails with 403."},"ImageEncoding":{"type":"string","enum":["plain","encrypted"],"description":"How the file is stored."},"ImageFirmwareInfo":{"type":"object","properties":{"type":{"type":"string","description":"Firmware type, e.g. 'ios'.","example":"ios"},"version":{"type":"string","description":"OS version.","example":"16.4"},"buildId":{"type":"string","description":"OS build ID.","example":"20E247"},"deviceIds":{"type":"array","items":{"type":"string"},"description":"Device identifiers this firmware supports.","example":["iPhone12,1"]},"boardConfig":{"type":"string","description":"Board configuration.","example":"n104ap"},"bdid":{"type":"number","description":"Board ID.","example":12},"cpid":{"type":"number","description":"Chip ID.","example":32816},"platform":{"type":"string","description":"Chip platform.","example":"t8030"},"bootArgs":{"type":"object","properties":{"normal":{"type":"string","description":"Boot arguments for normal boot.","example":"rd=md0 -progress -no-battery nand-enable-reformat=1"},"restore":{"type":"string","description":"Boot arguments for restore boot.","example":"rd=md0 -restore -progress"}},"additionalProperties":{"nullable":true},"description":"Embedded boot arguments."},"variants":{"type":"array","items":{"type":"string"},"description":"Firmware variants.","example":["Customer Erase Install (IPSW)"]},"device":{"$ref":"#/components/schemas/FirmwareInfoDevice"}},"additionalProperties":{"nullable":true}},"FirmwareInfoDevice":{"type":"object","properties":{"flavor":{"type":"string","description":"Matched device flavor.","example":"iphone11"},"firmwares":{"type":"array","items":{"type":"object","properties":{"filename":{"type":"string","description":"Firmware filename.","example":"iPhone12,1_16.4_20E247_Restore.ipsw"},"version":{"type":"string","description":"Firmware version.","example":"16.4"},"buildId":{"type":"string","description":"Firmware build ID.","example":"20E247"},"url":{"type":"string","format":"uri","description":"Firmware download URL.","example":"https://example.com/download/iPhone12,1_16.4_20E247_Restore.ipsw"},"origUrl":{"type":"string","format":"uri","description":"Original vendor firmware URL.","example":"https://example.com/vendor/iPhone12,1_16.4_20E247_Restore.ipsw"}},"additionalProperties":{"nullable":true}},"description":"Supported firmwares matching the version and build ID of this image."}},"additionalProperties":{"nullable":true},"description":"Matched supported device; only present when extended info was requested."},"GetFirmwareInfoBody":{"type":"object","properties":{"password":{"type":"string","description":"Password to decrypt an encrypted firmware file.","example":"<redacted>"},"extended":{"type":"boolean","description":"Include extended info such as board config, bdid, cpid, platform, and the matched device.","example":true}}},"InstallFirmwareResponse":{"type":"object","properties":{"taskId":{"type":"string","format":"uuid","description":"Identifier of the asynchronous install task.","example":"722cdce5-6f71-4f4a-b2b6-c00f11c015f6"}},"required":["taskId"]},"InstallFirmwareBody":{"type":"object","properties":{"imageId":{"type":"string","format":"uuid","description":"Identifier of a previously uploaded 'fw' type Image.","example":"3e1354a3-fb10-46c0-8b05-56e28edbde69"}},"required":["imageId"]},"InstallFirmwareAssetsResponse":{"type":"object","properties":{"message":{"type":"string","description":"Message returned by the firmware service describing the outcome of the asset upload.","example":"Firmware assets installed successfully."}},"required":["message"]},"InstallFirmwareAssetsBody":{"type":"object","properties":{"imageId":{"type":"string","format":"uuid","description":"Identifier of a previously uploaded 'fwasset' type Image.","example":"3e1354a3-fb10-46c0-8b05-56e28edbde69"}},"required":["imageId"]},"InstallFirmwareStatusResponse":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/TaskStatus"},"installedFirmwareUrl":{"type":"string","nullable":true,"format":"uri","description":"URL of the installed firmware once status is \"complete\"; null otherwise.","example":"https://example.com/download/iPhone12,1_16.4_20E247_Restore.ipsw"}},"required":["status"]},"TaskStatus":{"type":"string","nullable":true,"enum":["in-progress","complete","error",null],"description":"Current task status."},"ImageList":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/Image"},"description":"Results for this page."},"count":{"type":"integer","minimum":0,"description":"Number of results in this page. Can be less than `limit` on the last page.","example":25},"total":{"type":"integer","minimum":0,"description":"Number of results across all pages, after any filters.","example":137},"limit":{"type":"integer","minimum":0,"description":"The page size that was used (your `limit`, or the default 100).","example":25},"offset":{"type":"integer","minimum":0,"description":"The offset that was used (your `offset`, or the default 0).","example":0},"hasMore":{"type":"boolean","description":"True if more results exist after this page. To read everything, keep requesting with `offset` increased by `limit` until this is false.","example":true}},"required":["results","count","total","limit","offset","hasMore"]},"CreateImageBody":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/ImageType"},"encoding":{"$ref":"#/components/schemas/ImageEncoding"},"encapsulated":{"type":"boolean","nullable":true,"description":"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.","example":false},"name":{"type":"string","nullable":true,"description":"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.","example":"firmware.ipsw"},"fullPath":{"type":"string","nullable":true,"description":"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.","example":"/data/uploads/firmware.ipsw"},"projectId":{"type":"string","nullable":true,"format":"uuid","description":"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.\n\n**Lifetime.** The image is deleted automatically when the project is deleted, which makes a scratch project a simple way to clean up test uploads.\n\n**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`.\n\nSide 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.\n\nIgnored when `instanceId` is set: the image then belongs to that instance's project. Leave both unset to create a domain-level image.","example":"1c41b1bc-4f53-48a8-b690-ad30611e1960"},"instanceId":{"type":"string","nullable":true,"format":"uuid","description":"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.\n\n**Lifetime.** The image is deleted automatically when the instance is deleted.\n\nSide 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.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"file":{"type":"string","nullable":true,"format":"binary","description":"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."}},"required":["type","encoding"]},"UploadSizeError":{"type":"object","properties":{"error":{"type":"string","description":"Error text.","example":"Storage quota exceeded"},"errorID":{"type":"string","enum":["UploadSizeError"],"description":"Error ID."},"field":{"type":"string","description":"Limit that was exceeded, e.g. 'storageQuota' or the image type.","example":"storageQuota"}},"required":["error","errorID"]},"AgentAppReadyResponse":{"type":"object","properties":{"ready":{"type":"boolean","description":"Whether the app subsystem is ready.","example":true}},"required":["ready"]},"AgentError":{"type":"object","properties":{"error":{"type":"string","description":"The error encountered by the agent.","example":"Agent request timed out."},"errorID":{"type":"string","enum":["AgentError"],"description":"Error ID."},"originalError":{"type":"object","additionalProperties":{"nullable":true},"description":"The full error object encountered by the agent.","example":{"name":"OperationFailed","message":"Agent request timed out."}}},"required":["error","errorID"]},"AgentInstallBody":{"type":"object","properties":{"path":{"type":"string","description":"Path to the app to install on the VM filesystem.","example":"/var/tmp/Cafe.ipa"}},"required":["path"]},"AgentAppsList":{"type":"object","properties":{"success":{"type":"boolean","description":"Whether the agent request succeeded.","example":true},"apps":{"type":"array","items":{"$ref":"#/components/schemas/AgentApp"},"description":"List of installed apps."},"frontmost":{"type":"string","description":"Bundle ID of the frontmost app or empty string if none (iOS only).","example":"com.corellium.cafe"}},"required":["success","apps"]},"AgentApp":{"type":"object","properties":{"tags":{"type":"array","items":{"type":"string"},"description":"App tags (iOS only).","example":["Favorites"]},"running":{"type":"boolean","description":"Whether the app is currently running.","example":true},"diskUsage":{"type":"integer","minimum":0,"description":"Disk usage in bytes.","example":41943040},"date":{"type":"number","minimum":0,"description":"Unix timestamp (seconds) of when the app was installed.","example":1773479567},"applicationType":{"type":"string","description":"Application type.","example":"User"},"name":{"type":"string","description":"App display name (not present for all Android apps).","example":"Corellium Cafe"},"bundleId":{"type":"string","minLength":1,"description":"App bundle identifier.","example":"com.corellium.cafe"},"bundlePath":{"type":"string","description":"Path to the app bundle (iOS only).","example":"/var/containers/Bundle/Application/Cafe.app"},"bundleDataPath":{"type":"string","description":"Path to the app bundle data (iOS only).","example":"/var/mobile/Containers/Data/Application/Cafe"},"isLaunchable":{"type":"boolean","description":"Whether the app is launchable (Android only).","example":true},"icon":{"type":"string","description":"Base64-encoded app icon when loadIcons is enabled.","example":"iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9L"}},"required":["applicationType","bundleId"]},"AgentAppsStatusList":{"type":"object","properties":{"success":{"type":"boolean","description":"Whether the agent request succeeded.","example":true},"id":{"type":"integer","minimum":0,"description":"Agent sequence ID.","example":7},"apps":{"type":"array","items":{"$ref":"#/components/schemas/AgentAppStatus"},"description":"List of app statuses."},"frontmost":{"type":"string","description":"Bundle ID of the frontmost app or empty string if none (iOS only).","example":"com.corellium.cafe"}},"required":["success","id","apps"]},"AgentAppStatus":{"type":"object","properties":{"running":{"type":"boolean","description":"Whether the app is currently running.","example":true},"bundleId":{"type":"string","description":"App bundle identifier.","example":"com.corellium.cafe"}},"required":["running","bundleId"]},"AgentIconsResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Whether the agent request succeeded.","example":true},"id":{"type":"integer","minimum":0,"description":"Agent sequence ID.","example":7},"icons":{"type":"object","additionalProperties":{"type":"string"},"description":"Map of bundle ID to base64-encoded icon data.","example":{"com.corellium.cafe":"iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9L"}}},"required":["success","id","icons"]},"AgentFileDownloadToken":{"type":"object","properties":{"token":{"type":"string","description":"Authorization token for a preauthorized file download.","example":"a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6"}},"required":["token"]},"AgentFileArchiveDownloadBody":{"type":"object","properties":{"paths":{"type":"array","items":{"type":"string","minLength":1},"minItems":1,"description":"File and directory paths to include. Directory paths must end with a slash.","example":["/var/mobile/Media/DCIM/","/var/tmp/agent.log"]}},"required":["paths"]},"AgentFileAttributesBody":{"type":"object","properties":{"path":{"type":"string","description":"New path to move/rename the file to.","example":"/var/tmp/renamed.log"},"mode":{"type":"integer","minimum":0,"description":"New file mode as a decimal integer (octal 0644 = 420).","example":420},"uid":{"type":"integer","minimum":0,"description":"New owner UID.","example":501},"gid":{"type":"integer","minimum":0,"description":"New group GID.","example":501}}},"AgentTempFileResponse":{"type":"object","properties":{"path":{"type":"string","description":"Unique temporary file path on the VM filesystem.","example":"/var/tmp/tmp3f8a21"}},"required":["path"]},"AgentSystemResult":{"type":"object","properties":{"id":{"type":"integer","minimum":0,"description":"Agent sequence ID.","example":7},"success":{"type":"boolean","description":"Whether the agent operation succeeded.","example":true}},"required":["id","success"]},"AgentSystemSetHostnameBody":{"type":"object","properties":{"hostname":{"type":"string","description":"New hostname for the instance.","example":"corellium-device-01"}},"required":["hostname"]},"AgentSystemSetDevicePropertiesBody":{"type":"object","properties":{"modelId":{"type":"string","nullable":true,"description":"New model ID for the instance. Use null to reset to the default model ID.","example":"SM-G973F"},"manufacturerId":{"type":"string","nullable":true,"description":"New manufacturer ID for the instance. Use null to reset to the default manufacturer ID.","example":"samsung"}}},"AgentSystemNetworkResponse":{"type":"object","properties":{"value":{"type":"string","description":"The IP address bound to eth0.","example":"10.0.0.12"}},"required":["value"]},"AgentSystemGetPropResponse":{"allOf":[{"$ref":"#/components/schemas/AgentSystemResult"},{"type":"object","properties":{"value":{"type":"string","description":"The value of the requested property. Omitted when the property is unset.","example":"33"}}}]},"AgentSystemGetPropBody":{"type":"object","properties":{"property":{"type":"string","description":"The system property to retrieve.","example":"ro.build.version.sdk"}},"required":["property"]},"AgentSystemInstallOpenGappsBody":{"type":"object","properties":{"url":{"type":"string","format":"uri","description":"URL to download the OpenGApps package from.","example":"http://downloads.sourceforge.net/project/opengapps/arm64/20220119/open_gapps-arm64-11.0-pico-20220119.zip"},"hash":{"type":"string","description":"Expected SHA-256 hash of the downloaded package.","example":"58398bf7628f38ef07eaeb3abe26f3ebf0474f4d5ecdac0852bd5de3c15cc828"},"fingerprint":{"type":"string","description":"Build fingerprint to install the package against.","example":"google/flame/flame:11/RP1A.200720.009/6720564:user/release-keys__2020-09-05"}},"required":["url","hash","fingerprint"]},"AgentSystemAdbAuth":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether ADB authorization is enabled.","example":true}},"required":["enabled"]},"AgentProfileListResponse":{"type":"object","properties":{"profiles":{"type":"array","items":{"type":"string"},"description":"Identifiers of the installed profiles.","example":["com.apple.wifi.managed"]}},"required":["profiles"]},"AgentFridaResponse":{"type":"object","properties":{"id":{"type":"integer","minimum":0,"description":"Agent sequence ID.","example":7},"success":{"type":"boolean","description":"Whether the agent request succeeded.","example":true}},"required":["id","success"]},"AgentFridaRunBody":{"type":"object","properties":{"targetPid":{"type":"string","description":"PID of the target process to attach to.","example":"1234"},"targetName":{"type":"string","description":"Name of the target process to attach to.","example":"com.corellium.cafe"}},"required":["targetPid","targetName"]},"AgentFridaProcessList":{"type":"object","properties":{"success":{"type":"boolean","description":"Whether the agent request succeeded.","example":true},"exitStatus":{"type":"integer","description":"Exit status of the frida-ps command.","example":0},"output":{"type":"string","description":"Raw output of the frida-ps command.","example":"  PID  Name\n  1234  com.corellium.cafe\n"},"attached":{"type":"object","properties":{"targetName":{"type":"string","description":"Name of the target process to attach to.","example":"com.corellium.cafe"},"targetPid":{"type":"integer","description":"PID of the process Frida is attached to.","example":1234}},"required":["targetName","targetPid"],"description":"The process Frida is currently attached to, if any."}},"required":["success","exitStatus","output"]},"AgentRemoteItStatus":{"type":"object","properties":{"remoteItStatus":{"type":"string","enum":["unknown","installed","uninstalled","installing","uninstalling","registered"],"description":"Installation state of the Remote.It package."},"claimCode":{"type":"string","description":"Remote.It claim code, present once the package is installed and claimable.","example":"a1b2c3d4e5f6"}},"required":["remoteItStatus"]},"AgentContainerList":{"type":"object","properties":{"containers":{"type":"array","items":{"$ref":"#/components/schemas/AgentContainer"},"description":"List of containers on the VM."}},"required":["containers"]},"AgentContainer":{"type":"object","properties":{"autostart":{"type":"string","description":"Whether the container starts automatically.","example":"1"},"groups":{"type":"string","description":"Container groups.","example":"onboot"},"ipv4":{"type":"string","description":"IPv4 address.","example":"10.0.0.12"},"ipv6":{"type":"string","description":"IPv6 address.","example":"fe80::5054:ff:fe12:3456"},"name":{"type":"string","description":"Container name.","example":"container1"},"pid":{"type":"string","description":"Process ID of the container.","example":"1234"},"ram":{"type":"string","description":"RAM usage.","example":"52428800"},"state":{"type":"string","description":"Container state (e.g. RUNNING, STOPPED).","example":"RUNNING"},"swap":{"type":"string","description":"Swap usage.","example":"0"},"unprivileged":{"type":"string","description":"Whether the container is unprivileged.","example":"1"}},"required":["autostart","groups","ipv4","ipv6","name","pid","ram","state","swap","unprivileged"]},"AgentContainerHealth":{"type":"object","properties":{"healthy":{"type":"boolean","description":"Whether the container is healthy.","example":true}},"required":["healthy"]},"InvitesListResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/Invitation"},"description":"Invitations."},"count":{"type":"integer","minimum":0,"description":"Number of results in this page. Can be less than `limit` on the last page.","example":25},"total":{"type":"integer","minimum":0,"description":"Number of results across all pages, after any filters.","example":137},"limit":{"type":"integer","minimum":0,"description":"The page size that was used (your `limit`, or the default 100).","example":25},"offset":{"type":"integer","minimum":0,"description":"The offset that was used (your `offset`, or the default 0).","example":0},"hasMore":{"type":"boolean","description":"True if more results exist after this page. To read everything, keep requesting with `offset` increased by `limit` until this is false.","example":true}},"required":["results","count","total","limit","offset","hasMore"]},"Invitation":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Invite ID.","example":"5ac8f0be-616d-45b9-b0af-e586fc65ad19"},"email":{"type":"string","format":"email","description":"Invited email address.","example":"jane.doe@example.com"},"settings":{"$ref":"#/components/schemas/InviteSettings"}},"required":["id","email","settings"]},"InviteSettings":{"type":"object","properties":{"teams":{"type":"array","items":{"type":"string"},"description":"Teams the new user is added to when they sign up, by team ID (from `GET /v3/teams`). IDs of teams not in your domain are dropped.","example":["089c8ffd-ca4d-4d35-80ab-0847d18b7213"]},"projects":{"type":"array","items":{"type":"array","items":{"type":"string"},"minItems":2,"maxItems":2},"description":"Projects the new user gets access to when they sign up, as `[projectId, role]` pairs. IDs of projects not in your domain are dropped.","example":[["1c41b1bc-4f53-48a8-b690-ad30611e1960","admin"]]}},"description":"Invite settings."},"InvitationByToken":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Invite ID.","example":"5ac8f0be-616d-45b9-b0af-e586fc65ad19"},"email":{"type":"string","format":"email","description":"Invited email address.","example":"jane.doe@example.com"},"domain":{"type":"string","description":"Domain name.","example":"acme-corp"},"displayName":{"type":"string","description":"Domain display name.","example":"Acme Corp"},"termsAgreementRequired":{"type":"boolean","description":"Whether the invitee must agree to terms.","example":true},"settings":{"$ref":"#/components/schemas/InviteSettings"}},"required":["id","email","domain","displayName","termsAgreementRequired","settings"]},"GetInviteByTokenBody":{"type":"object","properties":{"token":{"type":"string","description":"Invite token.","example":"<token>"}},"required":["token"]},"CreateInvitesResponse":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/InviteResult"}},"InviteResult":{"type":"object","properties":{"invite":{"allOf":[{"$ref":"#/components/schemas/Invitation"},{"description":"The created invite, when successful."}]},"error":{"$ref":"#/components/schemas/InviteResultError"}}},"InviteResultError":{"type":"object","properties":{"error":{"type":"string","description":"Error text.","example":"An invite has already been sent to jane.doe@example.com for this domain"}},"required":["error"],"description":"Error detail, when the invite failed."},"CreateInvitesBody":{"type":"object","properties":{"email":{"type":"array","items":{"type":"string","format":"email"},"minItems":1,"description":"Emails to invite.","example":["jane.doe@example.com"]},"resend":{"type":"boolean","description":"Resend the invite if it already exists.","example":true},"settings":{"allOf":[{"$ref":"#/components/schemas/InviteSettings"},{"description":"Settings applied to the created invites."}]}},"required":["email"]},"EditInvitesBody":{"type":"object","properties":{"ids":{"type":"array","items":{"type":"string"},"minItems":1,"description":"Invite IDs to operate on.","example":["5ac8f0be-616d-45b9-b0af-e586fc65ad19"]},"changes":{"type":"object","properties":{"settings":{"$ref":"#/components/schemas/InviteSettings"}},"description":"Changes to apply to the invites."}},"required":["ids","changes"]},"RevokeInvitesResponse":{"type":"object","properties":{"deletedCount":{"type":"integer","description":"Number of invites revoked.","example":1}},"required":["deletedCount"]},"RevokeInvitesBody":{"type":"object","properties":{"ids":{"type":"array","items":{"type":"string"},"minItems":1,"description":"Invite IDs to operate on.","example":["5ac8f0be-616d-45b9-b0af-e586fc65ad19"]}},"required":["ids"]},"InviteSignupResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Identifier of the newly created user.","example":"e8c5b7ea-aa5f-4a4a-bdca-0c67060b5320"}},"required":["id"]},"InviteSignupBody":{"type":"object","properties":{"inviteToken":{"type":"string","description":"Invite token from the invitation email.","example":"<token>"},"params":{"type":"object","properties":{"email":{"type":"string","format":"email","description":"Account email.","example":"jane.doe@example.com"},"password":{"type":"string","description":"Account password.","example":"<redacted>"},"label":{"type":"string","description":"Account label.","example":"Jane Doe"},"agreed":{"type":"boolean","description":"Whether the invitee agreed to the terms of service.","example":true}},"required":["password","label","agreed"],"description":"New account parameters."}},"required":["inviteToken","params"]},"Model":{"type":"object","properties":{"type":{"type":"string","description":"Device type, e.g. iOS, Android or IoT.","example":"ios"},"flavor":{"type":"string","description":"The model's identifier, for example \"iphone17a\". Pass this value as `flavor` when you create an instance, and as `{model}` when you list its software.","example":"iphone17a"},"description":{"type":"string","nullable":true,"description":"Human-readable model name, e.g. \"iPhone Air\".","example":"iPhone Air"},"model":{"type":"string","description":"Marketing model identifier, e.g. \"iPhone18,4\".","example":"iPhone18,4"},"hardwareModel":{"type":"string","nullable":true,"description":"Hardware board model, e.g. \"d23ap\".","example":"d23ap"},"boardConfig":{"type":"string","nullable":true,"description":"Board configuration identifier.","example":"d23ap"},"platform":{"type":"string","nullable":true,"description":"Device platform.","example":"t8140"},"cpid":{"type":"number","nullable":true,"description":"Chip ID.","example":33088},"bdid":{"type":"number","nullable":true,"description":"Board ID.","example":14},"vendor":{"type":"string","nullable":true,"description":"Vendor gating this model, when it is vendor-restricted.","example":"Arm"},"hidden":{"type":"boolean","description":"Whether this model is hidden from device pickers.","example":false},"isBeta":{"type":"boolean","description":"Whether this model is a beta device.","example":false},"peripherals":{"type":"boolean","description":"Whether the device supports peripherals.","example":true},"hasSoftware":{"type":"boolean","description":"Whether any software build is available for this model.","example":true},"supportsRapidStart":{"type":"boolean","description":"Whether at least one software build for this model can start from a snapshot.","example":true},"defaultFirmware":{"type":"string","nullable":true,"description":"Filename pattern that selects the default build. It ignores case. Null if the model has no default.","example":".*userdebug.*"},"cores":{"type":"number","description":"Number of CPU cores a new instance of this model gets if you do not choose one.","example":6},"coresMin":{"type":"number","description":"Fewest CPU cores you can give an instance of this model.","example":6},"coresMax":{"type":"number","description":"Most CPU cores you can give an instance of this model.","example":6},"coresStep":{"type":"number","description":"If present, core counts must go up in steps of this size between `coresMin` and `coresMax`.","example":2},"coresAllowed":{"type":"array","items":{"type":"number"},"description":"If present, the exact core counts you may choose, smallest first. When set, use one of these values.","example":[2,4,6,8]},"ram":{"type":"number","description":"Memory, in MiB (1024 = 1 GiB), that a new instance gets if you do not choose an amount.","example":8192},"ramMin":{"type":"number","description":"Smallest memory amount, in MiB, you can give an instance of this model.","example":8192},"ramMax":{"type":"number","description":"Largest memory amount, in MiB, you can give an instance of this model.","example":8192},"dynamicHardwareChanges":{"type":"boolean","description":"Whether cores and memory can be changed while the instance is running.","example":false},"partitions":{"type":"array","items":{"$ref":"#/components/schemas/ModelPartition"},"description":"Storage partitions of this model."},"frame":{"$ref":"#/components/schemas/ModelFrame"},"productImage":{"$ref":"#/components/schemas/ModelProductImage"},"hasFrameVariant":{"type":"boolean","description":"Whether this model is the bezel-framed variant of its device type.","example":false},"showOptions":{"type":"array","items":{"type":"string"},"description":"Preset boot options this model offers.","example":["jailbroken","nonjailbroken"]},"stringUdid":{"type":"boolean","description":"Whether this model takes its UDID as a free-form string.","example":true},"charmBootArgs":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"nullable":true}},"description":"Model-specific boot argument field definitions.","example":[{"name":"boot","displayName":"Boot","type":"text","maxLength":32}]},"requiresPresetBootOptions":{"type":"boolean","description":"Whether a preset boot option must be chosen when creating an instance.","example":false},"supportsPresetBootOptions":{"type":"boolean","description":"Whether preset boot options are supported.","example":true},"supportsCustomFirmware":{"type":"boolean","description":"Whether custom firmware is supported.","example":false},"supportsCustomFirmwareImage":{"type":"boolean","description":"Whether a user-supplied firmware image can be uploaded for this model.","example":true},"supportsCustomKernel":{"type":"boolean","description":"Whether a custom kernel is supported.","example":true},"supportsCustomDevicetree":{"type":"boolean","description":"Whether a custom device tree is supported.","example":true},"supportsCustomMmio":{"type":"boolean","description":"Whether custom MMIO configuration is supported.","example":false},"supportsFvp":{"type":"boolean","description":"Whether this model is an Arm Fixed Virtual Platform.","example":false},"mast":{"type":"boolean","description":"Whether MATRIX security assessments can run on instances of this model.","example":true}},"required":["type","flavor","description","model","hardwareModel","boardConfig","platform","cpid","bdid","vendor","hidden","isBeta","peripherals","hasSoftware","supportsRapidStart","defaultFirmware","cores","coresMin","coresMax","ram","ramMin","ramMax","dynamicHardwareChanges","partitions","frame","productImage","hasFrameVariant","showOptions","stringUdid","requiresPresetBootOptions","supportsPresetBootOptions","supportsCustomFirmware","supportsCustomFirmwareImage","supportsCustomKernel","supportsCustomDevicetree","supportsCustomMmio","supportsFvp","mast"]},"ModelPartition":{"type":"object","properties":{"name":{"type":"string","description":"Partition name.","example":"nand"},"blockSize":{"type":"number","description":"Block size in bytes.","example":4096},"blocks":{"type":"number","description":"Default size in blocks.","example":7812500},"blocksMin":{"type":"number","description":"Minimum size in blocks.","example":7812500},"blocksMax":{"type":"number","description":"Maximum size in blocks.","example":31250000},"blocksStep":{"type":"number","description":"Block increment between selectable sizes.","example":1024},"blockValues":{"type":"array","items":{"type":"number"},"description":"Discrete selectable sizes in blocks.","example":[7812500,15625000,31250000]},"userUploaded":{"type":"boolean","description":"Whether this partition can be replaced by a user-supplied image.","example":false}},"required":["name","blockSize"]},"ModelFrame":{"type":"object","nullable":true,"properties":{"width":{"type":"number","description":"Bezel image width.","example":300},"height":{"type":"number","description":"Bezel image height.","example":619.49},"inner":{"$ref":"#/components/schemas/ModelRect"},"home":{"allOf":[{"$ref":"#/components/schemas/ModelRect"},{"description":"Home button area within the bezel."}]},"dimensions":{"type":"object","properties":{"width":{"type":"number","description":"Native display width in pixels.","example":1260},"height":{"type":"number","description":"Native display height in pixels.","example":2736}},"required":["width","height"],"description":"Native display resolution."},"scale":{"type":"number","description":"Display scale factor.","example":3},"hasImage":{"type":"boolean","description":"Whether a bezel image is available for this model.","example":true}},"required":["width","height","hasImage"],"description":"Bezel geometry, or null when this model has no bezel."},"ModelRect":{"type":"object","properties":{"top":{"type":"number","description":"Offset from the top edge.","example":10.29},"left":{"type":"number","description":"Offset from the left edge.","example":12.04},"width":{"type":"number","description":"Width.","example":275.91},"height":{"type":"number","description":"Height.","example":599.12},"radius":{"type":"number","description":"Corner radius, as a fraction of the width.","example":0.12}},"required":["top","left","width","height"],"description":"Screen area within the bezel."},"ModelProductImage":{"type":"object","nullable":true,"properties":{"width":{"type":"number","description":"Product image width.","example":80},"inner":{"allOf":[{"$ref":"#/components/schemas/ModelRect"},{"description":"Screen area within the product image."}]},"hasImage":{"type":"boolean","description":"Whether a product image is available for this model.","example":true}},"required":["width","hasImage"],"description":"Product image geometry, or null when this model has none."},"ModelFirmware":{"type":"object","properties":{"osVersion":{"type":"string","description":"Operating-system version of this build. Pass it as `osVersion` when you create an instance.","example":"12.1.4"},"osBuild":{"type":"string","nullable":true,"description":"Build identifier of this version. Pass it as `osBuild` (together with `osVersion`) when you create an instance to get exactly this build. If you pass only `osVersion`, the newest build of that version is used.","example":"16D57"},"androidFlavor":{"type":"string","nullable":true,"description":"Android-only flavor.","example":"ranchu"},"apiVersion":{"type":"string","nullable":true,"description":"Android-only API version.","example":"34"},"sha256sum":{"type":"string","nullable":true,"description":"SHA-256 checksum.","example":"bf613433f156e8f1ab9ad5a554d89734e66c0e5b8dd4cb2848c9e9673847cbe8"},"sha1sum":{"type":"string","nullable":true,"description":"SHA-1 checksum.","example":"1c93e6b5931378118b909da6f3e5f6dd2e19b114"},"md5sum":{"type":"string","nullable":true,"description":"MD5 checksum.","example":"703a35f48f8e299cb90a2d13653589e2"},"corelliumChecksum":{"type":"string","nullable":true,"description":"Corellium checksum, in the form algorithm$chunkSize$checksum. Absent for a domain upload.","example":"sha256$1048576$bf613433f156e8f1ab9ad5a554d89734e66c0e5b8dd4cb2848c9e9673847cbe8"},"installed":{"type":"boolean","nullable":true,"description":"Whether this build is already stored on your Corellium deployment. A build that is not installed can only be used if your deployment is allowed to fetch it from the vendor; an air-gapped deployment can use only installed builds.","example":true},"size":{"type":"number","nullable":true,"description":"Software size in bytes.","format":"double","example":3448156160},"uniqueId":{"type":"string","nullable":true,"description":"A label chosen by whoever packaged this firmware. It is not guaranteed to be unique and cannot be used to look up an image or firmware; select a build with `osVersion` and `osBuild` instead.","example":"acme-fw-0001"},"metadata":{"type":"object","nullable":true,"properties":{},"additionalProperties":{"nullable":true},"description":"Software metadata.","example":{"variants":["domain"]}},"releaseDate":{"type":"string","nullable":true,"format":"date-time","description":"Release date.","example":"2026-05-22T13:58:34.000Z"},"uploadDate":{"type":"string","nullable":true,"description":"Date uploaded; may be an empty string when unknown.","example":"2026-05-22T13:58:34.000Z"},"url":{"type":"string","nullable":true,"description":"URL the software is available at.","example":"http://updates-http.cdn-apple.com/2019WinterFCS/fullrestores/041-39370/31D8C81A-292C-11E9-80C6-2A11412B0A59/iPhone_4.7_P3_12.1.4_16D57_Restore.ipsw"},"origUrl":{"type":"string","nullable":true,"description":"URL the software is available at from the vendor.","example":"http://updates-http.cdn-apple.com/2019WinterFCS/fullrestores/041-39370/31D8C81A-292C-11E9-80C6-2A11412B0A59/iPhone_4.7_P3_12.1.4_16D57_Restore.ipsw"},"filename":{"type":"string","nullable":true,"description":"Software filename.","example":"iPhone_4.7_P3_12.1.4_16D57_Restore.ipsw"},"rooted":{"type":"boolean","nullable":true,"description":"Whether a device from this firmware is rooted. Android has a rooted and a not-rooted build for each version. Null for iOS.","example":false},"signed":{"type":"boolean","nullable":true,"description":"Whether the vendor still signs this build, from the upstream ipsw data.","example":true},"springboardSnapshot":{"type":"object","nullable":true,"properties":{"volumes":{"type":"array","items":{"type":"object","properties":{"nand":{"type":"number","description":"Snapshotted NAND size in bytes.","format":"double","example":32000000000}},"required":["nand"]}}},"required":["volumes"],"description":"Rapid-start snapshot for this build, if one exists. Divide a listed size by the partition block size to get the block count."}},"required":["osVersion","osBuild"]},"ProjectList":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/ProjectListItem"},"description":"Projects for this page."},"count":{"type":"integer","minimum":0,"description":"Number of results in this page. Can be less than `limit` on the last page.","example":25},"total":{"type":"integer","minimum":0,"description":"Number of results across all pages, after any filters.","example":137},"limit":{"type":"integer","minimum":0,"description":"The page size that was used (your `limit`, or the default 100).","example":25},"offset":{"type":"integer","minimum":0,"description":"The offset that was used (your `offset`, or the default 0).","example":0},"hasMore":{"type":"boolean","description":"True if more results exist after this page. To read everything, keep requesting with `offset` increased by `limit` until this is false.","example":true}},"required":["results","count","total","limit","offset","hasMore"]},"ProjectListItem":{"allOf":[{"$ref":"#/components/schemas/Project"},{"type":"object","properties":{"keyCount":{"type":"integer","minimum":0,"description":"Number of authorized keys on the project.","example":2}},"required":["keyCount"]}]},"ProjectSettings":{"type":"object","properties":{"version":{"type":"integer","description":"Settings schema version.","example":1},"internetAccess":{"type":"boolean","description":"Whether devices in the project can reach the internet. When false, devices can talk only to each other and to the project VPN.","example":true},"dhcp":{"type":"boolean","description":"Whether DHCP is enabled for the project network.","example":true},"connection":{"type":"string","nullable":true,"format":"uuid","description":"ID of a network connection that routes the project's outbound traffic through a VPN, or null to use the normal network. Cannot be changed while any device in the project is running.","example":"0eb5d1e7-2c10-42b1-95fc-30e4e4885cd7"}},"description":"Project settings."},"ProjectQuota":{"type":"object","properties":{"cores":{"type":"integer","minimum":0,"description":"Allocated CPU cores.","example":30},"instances":{"type":"integer","minimum":0,"description":"Allocated instance count.","example":75},"ram":{"type":"integer","minimum":0,"description":"Allocated RAM in mebibytes.","example":184320}},"description":"Resource quotas allocated to the project."},"ProjectUsage":{"type":"object","properties":{"cores":{"type":"integer","minimum":0,"description":"CPU cores in use.","example":6},"instances":{"type":"integer","minimum":0,"description":"Instances in use.","example":3},"ram":{"type":"integer","minimum":0,"description":"RAM in use, in mebibytes.","example":18432},"gpu":{"type":"integer","minimum":0,"description":"GPU units in use.","example":1}},"description":"Resource usage within the project."},"NetworkStatus":{"type":"object","properties":{"type":{"type":"string","description":"Network provider type (e.g. \"openvpn\").","example":"openvpn"},"name":{"type":"string","description":"User-defined network connection name.","example":"office-vpn"},"state":{"type":"string","enum":["disconnected","disconnecting","connecting","connected","error"],"description":"Current egress network connection state."},"details":{"type":"object","additionalProperties":{"nullable":true},"description":"Additional state information, such as the last error.","example":{"error":"connection timed out"}}},"required":["state"],"description":"Egress network connection status for the project. Omitted when the project has none."},"Project":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Project identifier.","example":"1c41b1bc-4f53-48a8-b690-ad30611e1960"},"name":{"type":"string","description":"Project name.","example":"Default Project"},"settings":{"$ref":"#/components/schemas/ProjectSettings"},"quotas":{"$ref":"#/components/schemas/ProjectQuota"},"quotasUsed":{"$ref":"#/components/schemas/ProjectUsage"},"networkStatus":{"$ref":"#/components/schemas/NetworkStatus"},"config":{"type":"object","properties":{"color":{"type":"integer","description":"Project display color.","example":4}},"description":"Project configuration."}},"required":["id","name","settings","quotas","quotasUsed"]},"CreateProjectBody":{"type":"object","properties":{"name":{"type":"string","minLength":1,"description":"Project name.","example":"Default Project"},"color":{"type":"integer","description":"Project display color.","example":4},"settings":{"allOf":[{"$ref":"#/components/schemas/ProjectSettings"},{"description":"Initial project settings."}]},"quotas":{"$ref":"#/components/schemas/ProjectQuotaInput"}},"required":["name"]},"ProjectQuotaInput":{"type":"object","properties":{"cores":{"type":"integer","minimum":0,"description":"Allocated CPU cores.","example":8},"instances":{"type":"integer","minimum":0,"description":"Allocated instance count. Derived from cores when omitted.","example":20},"ram":{"type":"integer","minimum":0,"description":"Ignored on write: RAM in mebibytes is always recomputed as cores * 6144.","example":49152}},"required":["cores"],"description":"Initial resource quotas. When omitted the project is created with ZERO quota and cannot run instances until an administrator allocates quota to it (quotas are reservations against the domain allowance; rebalance from another project if the allowance is fully reserved)."},"PatchProjectBody":{"type":"object","properties":{"name":{"type":"string","minLength":1,"description":"New project name.","example":"Default Project"},"settings":{"allOf":[{"$ref":"#/components/schemas/ProjectSettings"},{"description":"Project settings to update. Provided fields are merged into the existing settings; omitted fields are preserved."}]},"quotas":{"allOf":[{"$ref":"#/components/schemas/ProjectQuotaInput"},{"description":"Updated resource quotas."}]}}},"ProjectInstanceList":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/ProjectInstanceSummary"},"description":"Instances for this page."},"count":{"type":"integer","minimum":0,"description":"Number of results in this page. Can be less than `limit` on the last page.","example":25},"total":{"type":"integer","minimum":0,"description":"Number of results across all pages, after any filters.","example":137},"limit":{"type":"integer","minimum":0,"description":"The page size that was used (your `limit`, or the default 100).","example":25},"offset":{"type":"integer","minimum":0,"description":"The offset that was used (your `offset`, or the default 0).","example":0},"hasMore":{"type":"boolean","description":"True if more results exist after this page. To read everything, keep requesting with `offset` increased by `limit` until this is false.","example":true}},"required":["results","count","total","limit","offset","hasMore"]},"ProjectInstanceSummary":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Instance identifier.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"name":{"type":"string","description":"Instance name.","example":"My Device"},"project":{"type":"string","format":"uuid","description":"Identifier of the project the instance belongs to.","example":"1c41b1bc-4f53-48a8-b690-ad30611e1960"},"state":{"type":"string","description":"Current instance state.","example":"on"}},"required":["id","name","project","state"],"additionalProperties":{"nullable":true}},"ProjectKeyList":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/ProjectKey"},"description":"Authorized keys for this page."},"count":{"type":"integer","minimum":0,"description":"Number of results in this page. Can be less than `limit` on the last page.","example":25},"total":{"type":"integer","minimum":0,"description":"Number of results across all pages, after any filters.","example":137},"limit":{"type":"integer","minimum":0,"description":"The page size that was used (your `limit`, or the default 100).","example":25},"offset":{"type":"integer","minimum":0,"description":"The offset that was used (your `offset`, or the default 0).","example":0},"hasMore":{"type":"boolean","description":"True if more results exist after this page. To read everything, keep requesting with `offset` increased by `limit` until this is false.","example":true}},"required":["results","count","total","limit","offset","hasMore"]},"ProjectKey":{"type":"object","properties":{"kind":{"type":"string","enum":["ssh","adb"],"description":"Kind of authorized key: an SSH key for SSH-based devices or an ADB key for Android."},"label":{"type":"string","nullable":true,"description":"Descriptive label for the key.","example":"Build server key"},"key":{"type":"string","description":"The public key authorized to access devices in the project, in OpenSSH authorized_keys format.","example":"ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIJUlGdieyRXdiVIyQjqthDE1YzmwzH0ZeZuHkBuC9Gwr user@example.com"},"id":{"type":"string","format":"uuid","description":"Project key identifier.","example":"9c1098dc-e881-41fb-b3af-e2d5ddd55d86"},"project":{"type":"string","format":"uuid","description":"Identifier of the project the key belongs to.","example":"1c41b1bc-4f53-48a8-b690-ad30611e1960"},"fingerprint":{"type":"string","nullable":true,"description":"Public key fingerprint.","example":"82:af:e7:ec:8c:03:17:fa:32:89:d7:e3:93:e2:9e:72"},"createdAt":{"type":"string","format":"date-time","description":"Time the key was created.","example":"2026-03-14T09:12:47.000Z"},"updatedAt":{"type":"string","format":"date-time","description":"Time the key was last updated.","example":"2026-03-17T11:41:05.000Z"}},"required":["kind","key","id","project","fingerprint","createdAt","updatedAt"]},"CreateProjectKeyBody":{"type":"object","properties":{"kind":{"type":"string","enum":["ssh","adb"],"description":"Kind of authorized key: an SSH key for SSH-based devices or an ADB key for Android."},"label":{"type":"string","nullable":true,"description":"Descriptive label for the key.","example":"Build server key"},"key":{"type":"string","description":"The public key authorized to access devices in the project, in OpenSSH authorized_keys format.","example":"ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIJUlGdieyRXdiVIyQjqthDE1YzmwzH0ZeZuHkBuC9Gwr user@example.com"}},"required":["kind","key"]},"FetchFirmwareAssetsResponse":{"type":"object","properties":{"added":{"type":"array","items":{"type":"string"},"description":"Asset URLs newly fetched and stored.","example":["https://example.com/firmware/asset.ipsw"]},"existing":{"type":"array","items":{"type":"string"},"description":"Asset URLs already present.","example":["https://example.com/firmware/asset.ipsw"]},"failed":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string","description":"Asset URL that could not be fetched.","example":"https://example.com/firmware/asset.ipsw"},"error":{"type":"string","description":"Reason the fetch failed.","example":"404 Not Found"}},"required":["url","error"]},"description":"Assets that could not be fetched."}},"required":["added","existing","failed"]},"FetchFirmwareAssetsBody":{"type":"object","properties":{"assetUrls":{"type":"array","items":{"type":"string","format":"uri"},"minItems":1,"maxItems":100,"description":"Firmware asset URLs to fetch server-side (1–100 per request).","example":["https://example.com/fcs-keys/ExampleKeyA="]}},"required":["assetUrls"]},"VpnConfigPreauthorization":{"type":"object","properties":{"token":{"type":"string","description":"Signed JWT granting access to the VPN configuration download.","example":"<token>"}},"required":["token"]},"TeamsListResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/Team"},"description":"Array of teams."},"count":{"type":"integer","minimum":0,"description":"Number of results in this page. Can be less than `limit` on the last page.","example":25},"total":{"type":"integer","minimum":0,"description":"Number of results across all pages, after any filters.","example":137},"limit":{"type":"integer","minimum":0,"description":"The page size that was used (your `limit`, or the default 100).","example":25},"offset":{"type":"integer","minimum":0,"description":"The offset that was used (your `offset`, or the default 0).","example":0},"hasMore":{"type":"boolean","description":"True if more results exist after this page. To read everything, keep requesting with `offset` increased by `limit` until this is false.","example":true}},"required":["results","count","total","limit","offset","hasMore"]},"Team":{"type":"object","properties":{"id":{"type":"string","description":"Team identifier (or \"all-users\" for the implicit team).","example":"089c8ffd-ca4d-4d35-80ab-0847d18b7213"},"label":{"type":"string","nullable":true,"description":"Team label; null when the team has no name set.","example":"Mobile QA"},"users":{"type":"array","items":{"$ref":"#/components/schemas/TeamUser"},"description":"Members of the team."}},"required":["id","label","users"]},"TeamUser":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"User identifier.","example":"e8c5b7ea-aa5f-4a4a-bdca-0c67060b5320"},"label":{"type":"string","description":"User label.","example":"Jane Doe"},"name":{"type":"string","description":"Username.","example":"jane.doe"},"email":{"type":"string","description":"User email.","example":"jane.doe@example.com"},"administrator":{"type":"boolean","nullable":true,"description":"Whether the user is a domain administrator.","example":true},"canEditUserAttributes":{"type":"boolean","description":"Whether the user can edit user attributes.","example":true},"clusterAdministrator":{"type":"boolean","description":"Whether the user is a cluster administrator.","example":false},"isFederatedUser":{"type":"boolean","description":"Whether the user authenticates via a federated provider.","example":false}},"required":["id","label"]},"TeamCreated":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Identifier of the newly created team.","example":"089c8ffd-ca4d-4d35-80ab-0847d18b7213"}},"required":["id"]},"CreateTeamBody":{"type":"object","properties":{"name":{"type":"string","minLength":1,"description":"Team name.","example":"Mobile QA"}},"required":["name"]},"UpdateTeamBody":{"type":"object","properties":{"name":{"type":"string","minLength":1,"description":"Team name.","example":"Mobile QA"}}},"TotpGenerateResponse":{"type":"object","properties":{"qrCode":{"type":"string","description":"TOTP otpauth URL encoded as a data-URL QR code.","example":"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAAAAAA6fptVAAAAAXNSR0IArs4c6QAAAAtJREFUGFdjYAAAAAMAAWgmWQ0AAAAASUVORK5CYII="},"secret":{"type":"string","description":"Base32-encoded TOTP secret.","example":"<totp-secret>"}},"required":["qrCode","secret"]},"LoginResult":{"type":"object","properties":{"token":{"type":"string","description":"Signed JWT bearer session token, newly regenerated on every successful login.","example":"<token>"},"expiration":{"type":"string","format":"date-time","description":"Token expiration timestamp.","example":"2027-01-15T00:00:00.000Z"},"user":{"type":"object","properties":{"id":{"type":"string","description":"User identifier.","example":"e8c5b7ea-aa5f-4a4a-bdca-0c67060b5320"},"name":{"type":"string","nullable":true,"description":"Username.","example":"jane.doe"},"label":{"type":"string","nullable":true,"description":"Display name.","example":"Jane Doe"},"email":{"type":"string","nullable":true,"description":"Email address.","example":"jane.doe@example.com"},"clusterAdministrator":{"type":"boolean","description":"Whether the user is a cluster administrator.","example":false},"agreedToTerms":{"type":"string","nullable":true,"description":"When the user last agreed to the terms of service.","example":"2026-03-17T11:41:05.000Z"},"federatedUserId":{"type":"string","nullable":true,"description":"Subject of the linked SSO credential, if any.","example":"jane.doe@example.com"},"intercomHMAC":{"type":"string","description":"HMAC used for Intercom identity verification.","example":"<redacted>"},"misc":{"type":"object","properties":{},"additionalProperties":{"nullable":true},"description":"User metadata. API token bookkeeping only — the token itself is never returned.","example":{"apiToken":{"prefix":"<token-prefix>","lastAuthDate":"2026-03-17T11:41:05.000Z","lastAddress":"192.0.2.10"},"lastVPNType":"ovpn"}}},"required":["id","name","label","email","clusterAdministrator","intercomHMAC","misc"],"additionalProperties":{"nullable":true},"description":"The authenticated user. Absent on a Webplayer token renewal."},"domain":{"type":"object","properties":{"name":{"type":"string","nullable":true,"description":"Domain name.","example":"acme-corp"},"label":{"type":"string","nullable":true,"description":"Domain description.","example":"Acme Corp"},"termsPolicy":{"type":"string","nullable":true,"description":"Terms-of-service policy for the domain.","example":"all"},"cores":{"type":"number","description":"Licensed core quota.","example":48},"individual":{"type":"boolean","description":"Whether this is an individual (aggregate member) domain.","example":false},"totpRequired":{"type":"boolean","description":"Present when the domain mandates TOTP.","example":true},"subscription":{"type":"object","properties":{},"additionalProperties":{"nullable":true},"description":"Billing summary for the domain, present when it has a billing record. Carries the billing wire fields renew_action, next_bill, billing_type and billing_backend.","example":{"renew_action":null,"next_bill":"2027-01-15T00:00:00.000Z","billing_type":"metered","billing_backend":"stripe"}},"licenseType":{"type":"string","description":"License type identifier.","example":"enterprise"},"android":{"type":"boolean","description":"Whether Android devices are enabled.","example":true},"noIOS":{"type":"boolean","description":"Whether iOS devices are disabled.","example":false},"filesOnly":{"type":"boolean","description":"Whether the domain is in files-only mode.","example":false},"deviceDHCPServer":{"type":"boolean","description":"Whether the device DHCP server is enabled.","example":true},"enableArmDevices":{"type":"boolean","description":"Whether ARM devices are enabled.","example":true},"useDeviceAccounting":{"type":"boolean","description":"Whether the domain is billed by device hours instead of core hours.","example":false},"singleProject":{"type":"boolean","description":"Whether the domain is limited to a single project.","example":false},"termsUpdated":{"type":"string","description":"When the domain terms were last updated; compared against the user agreement.","example":"2026-03-14T09:12:47.000Z"},"trial":{"type":"object","nullable":true,"properties":{"start":{"type":"number","description":"Trial start unix timestamp (ms).","example":1773479567000},"end":{"type":"number","description":"Trial end unix timestamp (ms).","example":1775207567000}},"additionalProperties":{"nullable":true},"description":"Trial configuration, null once the domain is no longer on a trial."},"webplayer":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether Webplayer is enabled.","example":true},"allowedDomains":{"type":"array","items":{"type":"string"},"description":"Domains allowed to embed Webplayer sessions.","example":["example.com"]}},"additionalProperties":{"nullable":true},"description":"Webplayer configuration."},"snapshotSharingPermissions":{"type":"object","properties":{"cloudEnabled":{"type":"boolean","description":"Whether cloud sharing is enabled.","example":false},"domainEnabled":{"type":"boolean","description":"Whether domain sharing is enabled.","example":true},"publicLink":{"type":"boolean","description":"Whether public link sharing is enabled.","example":true},"domainRestrictedLink":{"type":"boolean","description":"Whether domain-restricted links are enabled.","example":true},"passwordPublicLink":{"type":"boolean","description":"Whether password-protected public links are enabled.","example":true},"emailInvite":{"type":"boolean","description":"Whether email invites are enabled.","example":true}},"additionalProperties":{"nullable":true},"description":"Snapshot sharing permissions."},"deviceAutoShutdown":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether idle devices are shut down.","example":true},"threshold":{"type":"integer","description":"Hours an instance may run before it is shut down (defaults to 10).","example":10}},"additionalProperties":{"nullable":true},"description":"Automatic device shutdown configuration."},"disabled":{"type":"object","properties":{"type":{"type":"string","description":"Reason the domain is disabled.","example":"SubscriptionCanceled"},"cancelDate":{"type":"string","format":"date-time","description":"When the subscription was canceled.","example":"2026-03-18T16:05:33.000Z"}},"additionalProperties":{"nullable":true},"description":"Disable details carried in the domain configuration. See the top-level `disabled` field."}},"required":["name","label","cores","individual"],"additionalProperties":{"nullable":true},"description":"The session's domain, including its feature configuration."},"time":{"type":"number","description":"Server time when the session was issued, in milliseconds.","example":1773479567000},"identifier":{"type":"string","description":"Webplayer session identifier. Present only on a Webplayer token renewal.","example":"a3569608-10e1-41c7-99fa-1a7d1f336c58"},"disabled":{"type":"object","properties":{"type":{"type":"string","description":"Reason the domain is disabled.","example":"SubscriptionCanceled"},"disabledAt":{"type":"string","format":"date-time","description":"When the domain was disabled. Present for AllocatedHoursExpended.","example":"2026-03-18T16:05:33.000Z"},"deleteInstancesAt":{"type":"string","format":"date-time","description":"When the domain's instances will be deleted.","example":"2027-01-15T00:00:00.000Z"},"cancelDate":{"type":"string","format":"date-time","description":"When the subscription was canceled. Present for SubscriptionCanceled.","example":"2026-03-18T16:05:33.000Z"}},"required":["type"],"additionalProperties":{"nullable":true},"description":"Public disable details. Present only when the domain is disabled."},"missingTOTP":{"type":"boolean","enum":[true],"description":"Present when the domain requires TOTP but the user has not enrolled."}},"required":["token","expiration"]},"TotpEnableBody":{"type":"object","properties":{"secret":{"type":"string","description":"Base32-encoded TOTP secret returned by generate.","example":"<totp-secret>"},"totpToken":{"type":"string","description":"Current TOTP token, used to confirm the secret.","example":"123456"},"password":{"type":"string","description":"User password.","example":"<redacted>"}},"required":["secret","totpToken","password"]},"TotpDisableBody":{"type":"object","properties":{"totpToken":{"type":"string","description":"Current TOTP token.","example":"123456"},"password":{"type":"string","description":"User password.","example":"<redacted>"}},"required":["totpToken","password"]},"UserCreated":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Identifier of the created user.","example":"e8c5b7ea-aa5f-4a4a-bdca-0c67060b5320"}},"required":["id"]},"CreateUserBody":{"type":"object","properties":{"password":{"type":"string","description":"Password (optional when using SSO).","example":"<redacted>"},"administrator":{"type":"boolean","description":"Whether the user is a domain administrator (domain admins only).","example":true},"name":{"type":"string","description":"Username.","example":"jane.doe"},"label":{"type":"string","description":"User label (e.g. \"Domain Administrator\").","example":"Domain Administrator"},"email":{"type":"string","description":"User email.","example":"jane.doe@example.com"},"clusterAdministrator":{"type":"boolean","description":"Whether the user is a cluster administrator (cluster admins only).","example":false}},"required":["name","label"]},"UpdateOwnProfileBody":{"type":"object","properties":{"label":{"type":"string","minLength":1,"maxLength":100,"description":"Display name.","example":"Jane Doe"}},"required":["label"],"additionalProperties":false},"PatchUserBody":{"type":"object","properties":{"name":{"type":"string","description":"Username.","example":"jane.doe"},"label":{"type":"string","description":"User label (e.g. \"Domain Administrator\").","example":"Domain Administrator"},"email":{"type":"string","description":"User email.","example":"jane.doe@example.com"},"clusterAdministrator":{"type":"boolean","description":"Whether the user is a cluster administrator (cluster admins only).","example":false},"password":{"type":"string","description":"Password (optional when using SSO).","example":"<redacted>"},"misc":{"type":"object","additionalProperties":{"nullable":true},"description":"Opaque metadata.","example":{"lastVPNType":"ovpn"}},"administrator":{"type":"boolean","description":"Whether the user is a domain administrator (domain admins only).","example":true},"agreedToTerms":{"type":"string","description":"Timestamp the terms were agreed to.","example":"2026-05-22T13:58:34.000Z"},"totpEnabled":{"type":"boolean","description":"Whether two-factor authentication is enabled.","example":true}}},"AgreedAck":{"type":"object","properties":{"agreedToTerms":{"type":"string","format":"date-time","description":"Timestamp the terms were agreed to.","example":"2026-05-22T13:58:34.000Z"}},"required":["agreedToTerms"]},"InvalidCredentialsError":{"type":"object","properties":{"error":{"type":"string","description":"Error text.","example":"The credentials are incorrect or you may be using a different authentication provider."},"errorID":{"type":"string","enum":["InvalidUsernameorPassword"],"description":"Error ID."}},"required":["error","errorID"]},"ChangePasswordBody":{"type":"object","properties":{"user":{"type":"string","description":"User identifier.","example":"e8c5b7ea-aa5f-4a4a-bdca-0c67060b5320"},"oldPassword":{"type":"string","description":"Current password.","example":"<redacted>"},"newPassword":{"type":"string","description":"New password.","example":"<redacted>"}},"required":["user","oldPassword","newPassword"]},"ResetUnauthorizedResponse":{"anyOf":[{"$ref":"#/components/schemas/InvalidTOTPError"},{"$ref":"#/components/schemas/UnauthorizedError"}]},"InvalidTOTPError":{"type":"object","properties":{"error":{"type":"string","description":"Error text.","example":"Invalid TOTP."},"errorID":{"type":"string","enum":["InvalidTOTP"],"description":"Error ID."}},"required":["error","errorID"]},"UnauthorizedError":{"type":"object","properties":{"error":{"type":"string","description":"Error text.","example":"Access denied"},"errorID":{"type":"string","enum":["Unauthorized"],"description":"Error ID."}},"required":["error","errorID"]},"ResetPasswordBody":{"type":"object","properties":{"token":{"type":"string","description":"Password reset token.","example":"<token>"},"newPassword":{"type":"string","description":"New password.","example":"<redacted>"},"totpToken":{"type":"string","description":"TOTP token when two-factor is required.","example":"123456"}},"required":["token","newPassword"]},"SendResetLinkBody":{"type":"object","properties":{"email":{"type":"string","description":"Email address to send the reset link to.","example":"jane.doe@example.com"}}},"ResetLinkInfo":{"type":"object","properties":{"userId":{"type":"string","format":"uuid","description":"User identifier.","example":"e8c5b7ea-aa5f-4a4a-bdca-0c67060b5320"},"username":{"type":"string","description":"Username.","example":"jane.doe"},"domain":{"type":"string","description":"Domain name.","example":"acme"}},"required":["userId","username","domain"]},"GetResetLinkInfoBody":{"type":"object","properties":{"token":{"type":"string","description":"Password reset token.","example":"<token>"}},"required":["token"]},"LoginBody":{"type":"object","properties":{"username":{"type":"string","description":"Account username. Send together with `password`.","example":"jane.doe"},"password":{"type":"string","description":"Account password. Send together with `username`.","example":"<redacted>"},"totpToken":{"type":"string","description":"One-time TOTP code. Required only when the account has two-factor authentication enabled, sent alongside `username`/`password`.","example":"123456"},"apiToken":{"type":"string","description":"Persistent API key, used as an alternative to username/password for programmatic access. Created by the user (in the web UI or via `POST /v3/auth/apitoken`) rather than issued by login, and sent back verbatim as an opaque string. Also accepted directly in the `Authorization: Bearer` header, and is the value the CLI stores as `--token`. Never returned by this endpoint, and distinct from the session `token`.","example":"<token>"},"token":{"type":"string","description":"An existing session token to renew. This is the signed JWT bearer token previously returned by login. Login always issues a newly-regenerated session token in the response; the supplied token is neither echoed back nor invalidated. Distinct from `apiToken`.","example":"<token>"},"revokeOld":{"type":"boolean","description":"Revoke previously issued tokens on success.","example":true}}},"ApiTokenResult":{"type":"object","properties":{"apiToken":{"type":"string","description":"The generated API token. Returned only once and cannot be retrieved later, so store it securely. Use it wherever an API token is accepted, such as the `apiToken` field of POST /v3/auth/login.","example":"<token>"}},"required":["apiToken"]},"AuthProvidersListResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/AuthProvider"},"description":"Configured authentication providers."},"count":{"type":"integer","minimum":0,"description":"Number of results in this page. Can be less than `limit` on the last page.","example":25},"total":{"type":"integer","minimum":0,"description":"Number of results across all pages, after any filters.","example":137},"limit":{"type":"integer","minimum":0,"description":"The page size that was used (your `limit`, or the default 100).","example":25},"offset":{"type":"integer","minimum":0,"description":"The offset that was used (your `offset`, or the default 0).","example":0},"hasMore":{"type":"boolean","description":"True if more results exist after this page. To read everything, keep requesting with `offset` increased by `limit` until this is false.","example":true}},"required":["results","count","total","limit","offset","hasMore"]},"AuthProvider":{"type":"object","properties":{"identifier":{"type":"string","description":"Provider identifier.","example":"sso.example.com"},"providerType":{"type":"string","description":"Provider type (e.g. database, open-id-connect).","example":"open-id-connect"},"enabled":{"type":"boolean","description":"Whether the provider is enabled.","example":true},"default":{"type":"boolean","description":"Whether this is the default provider.","example":false},"label":{"type":"string","nullable":true,"description":"Human-readable provider label.","example":"Log in with Okta"},"name":{"type":"string","description":"Provider display name.","example":"Okta"},"authorizationUrl":{"type":"string","description":"Relative authorization URL for the provider.","example":"/api/v3/auth/providers/sso.example.com/authorization_url"}},"required":["identifier","providerType","enabled","default","label","name","authorizationUrl"]},"AuthProviderTypesListResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/AuthProviderType"},"description":"Supported authentication provider types."},"count":{"type":"integer","minimum":0,"description":"Number of results in this page. Can be less than `limit` on the last page.","example":25},"total":{"type":"integer","minimum":0,"description":"Number of results across all pages, after any filters.","example":137},"limit":{"type":"integer","minimum":0,"description":"The page size that was used (your `limit`, or the default 100).","example":25},"offset":{"type":"integer","minimum":0,"description":"The offset that was used (your `offset`, or the default 0).","example":0},"hasMore":{"type":"boolean","description":"True if more results exist after this page. To read everything, keep requesting with `offset` increased by `limit` until this is false.","example":true}},"required":["results","count","total","limit","offset","hasMore"]},"AuthProviderType":{"type":"object","properties":{"providerType":{"type":"string","description":"Provider type identifier.","example":"open-id-connect"},"schema":{"type":"object","additionalProperties":{"nullable":true},"description":"JSON Schema describing the provider configuration.","example":{"type":"object","properties":{"providerType":{"type":"string","const":"open-id-connect"},"enabled":{"type":"boolean"},"default":{"type":"boolean","readOnly":true},"label":{"type":["string","null"]},"config":{"type":"object","properties":{"discoveryUrl":{"type":"string","minLength":1},"clientId":{"type":"string","minLength":1},"clientSecret":{"type":"string","minLength":1},"invitedOnly":{"type":"boolean","default":false}},"required":["discoveryUrl","clientId","clientSecret"],"additionalProperties":false,"writeOnly":true}},"required":["providerType","enabled","config"],"additionalProperties":false,"$schema":"http://json-schema.org/draft-07/schema#"}}},"required":["providerType","schema"]},"ConfigResponse":{"type":"object","properties":{"onSite":{"type":"boolean","description":"Denotes whether it's an on-site install.","example":false},"networkTypes":{"type":"array","nullable":true,"items":{"type":"string","enum":["bridged","nat","routed"]},"description":"Valid network types (e.g. \"nat\", \"bridged\", \"routed\").","example":["bridged","nat","routed"]},"networkType":{"type":"string","enum":["bridged","nat","routed"],"description":"Current network type setting."},"showDomainSettings":{"type":"boolean","description":"Denotes whether to show domain settings.","example":false},"version":{"type":"string","description":"Denotes the version.","example":"7.4.0-28212"},"invalidBuild":{"type":"boolean","description":"Denotes whether the build is invalid.","example":false},"sepSim":{"type":"boolean","description":"Denotes whether sepSim is enabled.","example":true},"installerAvailable":{"type":"boolean","description":"Denotes whether installer is available.","example":true},"stripePublicKey":{"type":"string","description":"Stripe public key.","example":"pk_test_xxxxxxxxxxxxxxxxxxxxxxxx"},"intercomId":{"type":"string","description":"Intercom app ID, also known as workspace ID.","example":"abc12345"},"gtmId":{"type":"string","description":"Google Tag Manager ID.","example":"GTM-ABCD123"},"billingBackend":{"type":"string","nullable":true,"description":"Default backend billing API name for new subscriptions (e.g. \"stripe\").","example":"stripe"},"maintenance":{"type":"object","nullable":true,"properties":{"message":{"type":"string","description":"Maintenance message.","example":"The system is currently undergoing scheduled maintenance. Please check back soon."},"header":{"type":"string","description":"Maintenance header.","example":"Scheduled Maintenance"}},"required":["message","header"],"description":"Maintenance details when the server is undergoing maintenance; null/absent otherwise."},"logging":{"$ref":"#/components/schemas/Logging"},"cloudAdmin":{"type":"string","description":"URL for cloud admin login.","example":"https://admin.corellium.com/login"},"filesAdmin":{"type":"string","description":"URL for files admin login.","example":"https://onsite.corellium.com/login"},"cloudDomain":{"type":"string","description":"Cloud domain name (usually corellium.com or staging.corellium.com).","example":"corellium.com"},"billingDomain":{"type":"string","description":"Billing domain name.","example":"billing.app.corellium.com"},"appDomain":{"type":"string","description":"App domain name (usually app.corellium.com or app.staging.corellium.com).","example":"app.corellium.com"},"maxNetworkMonitorFileSize":{"type":"string","description":"Maximum network monitor file size.","example":"2000m"},"enableFirmwareImageUpload":{"type":"boolean","description":"Denotes whether users can upload firmware images.","example":true},"authProviders":{"type":"array","items":{"$ref":"#/components/schemas/ConfigAuthProvider"},"description":"Auth providers."},"welcomeMessage":{"type":"string","description":"Domain welcome message, when enabled.","example":"Welcome to the Corellium virtual device platform!"},"snapshotLimit":{"type":"number","description":"Maximum number of snapshots to allow.","example":10},"maxKernelSize":{"type":"number","description":"The maximum size, in bytes, (default: 100 MiB) that an uploaded kernel should be.","example":104857600},"maxRamdiskSize":{"type":"number","description":"The maximum size, in bytes, (default: 500 MiB) that an uploaded ramdisk should be.","example":524288000},"charmSdk":{"type":"boolean","description":"Denotes whether charmSDK is enabled.","example":true},"trial":{"$ref":"#/components/schemas/Trial"},"sentryUrl":{"type":"string","format":"uri","description":"Sentry URL.","example":"https://sentry.example.com"},"domainAuthenticationProviders":{"type":"boolean","description":"If enabled, adds the default providers in their current configuration.","example":false},"remoteGpu":{"type":"boolean","description":"Whether remote GPU is enabled.","example":false},"defaultSsid":{"type":"string","description":"The configured default SSID from /etc/corellium/setup.json.","example":"Corellium"},"awsMarketplace":{"type":"boolean","description":"Whether this is an AWS Marketplace deployment.","example":false},"openGAppsBinary":{"type":"string","description":"OpenGApps binary location.","example":"http://downloads.sourceforge.net/project/opengapps/arm64/20220119/open_gapps-arm64-11.0-pico-20220119.zip"},"airGapped":{"type":"boolean","description":"Whether the deployment is airgapped.","example":false},"coordinatorConfig":{"allOf":[{"$ref":"#/components/schemas/CoordinatorConfig"},{"description":"Partial coordinator configuration."}]},"aiToolsConfig":{"type":"object","properties":{"aiEnabled":{"type":"boolean","description":"Whether cluster-hosted AI tools are enabled.","example":true}},"description":"Configuration for all cluster-hosted AI tools."}},"required":["onSite","networkTypes","networkType","showDomainSettings","version","sepSim","installerAvailable","cloudAdmin","filesAdmin","maxNetworkMonitorFileSize","enableFirmwareImageUpload","authProviders","snapshotLimit","maxKernelSize","maxRamdiskSize","trial","defaultSsid","coordinatorConfig"],"description":"Cluster configuration. Build-time feature flags may add further boolean properties beyond those listed."},"Logging":{"type":"object","properties":{"development":{"type":"boolean","description":"Denotes whether it's in development.","example":false},"throwWarnings":{"type":"boolean","description":"Denotes whether to throw warnings.","example":false}},"required":["development","throwWarnings"],"description":"Info for logging."},"ConfigAuthProvider":{"type":"object","properties":{"name":{"type":"string","description":"Provider name for a given provider type.","example":"Database"},"providerType":{"type":"string","description":"Provider type.","example":"database"},"default":{"type":"boolean","description":"Denotes whether or not this is the default auth provider.","example":true},"label":{"type":"string","description":"Provider label.","example":"database"},"enabled":{"type":"boolean","description":"Denotes whether they're enabled or not.","example":true},"authorizationUrl":{"type":"string","description":"URL for provider auth.","example":"/api/v1/auth/providers/database/authorization_url"},"identifier":{"type":"string","description":"Provider identifier.","example":"database"},"provider":{"type":"string","description":"Auth provider.","example":"database"}},"required":["name","providerType","default","label","enabled","authorizationUrl","identifier","provider"]},"Trial":{"type":"object","properties":{"defaultDuration":{"type":"number","description":"Default trial duration.","example":30},"defaultHours":{"type":"number","description":"Default trial hours.","example":24},"defaultDevices":{"type":"number","description":"Default trial devices.","example":24},"defaultCores":{"type":"number","description":"Default trial cores.","example":10}},"required":["defaultDuration","defaultHours","defaultDevices","defaultCores"],"description":"Info about trial."},"FlavorFrame":{"type":"object","properties":{"url":{"type":"string","description":"Relative URL to the frame image asset.","example":"frames/iphone8.png"},"width":{"type":"number","description":"Frame image width in points.","example":300},"height":{"type":"number","description":"Frame image height in points.","example":611.7106773823191},"inner":{"type":"object","properties":{"top":{"type":"number","description":"Top offset in points.","example":75.43053960964409},"left":{"type":"number","description":"Left offset in points.","example":21.010332950631458},"width":{"type":"number","description":"Width in points.","example":258.3237657864524},"height":{"type":"number","description":"Height in points.","example":459.47187141216995}},"required":["top","left","width","height"],"description":"Inner screen area within the frame."},"home":{"type":"object","properties":{"top":{"type":"number","description":"Top offset in points.","example":75.43053960964409},"left":{"type":"number","description":"Left offset in points.","example":21.010332950631458},"width":{"type":"number","description":"Width in points.","example":258.3237657864524},"height":{"type":"number","description":"Height in points.","example":459.47187141216995}},"required":["top","left","width","height"],"description":"Home button hit area within the frame.","example":{"top":544.8909299655568,"left":125.71756601607349,"width":48.220436280137775,"height":48.220436280137775}},"dimensions":{"type":"object","properties":{"width":{"type":"number","description":"Native display width in pixels.","example":750},"height":{"type":"number","description":"Native display height in pixels.","example":1334}},"required":["width","height"],"description":"Native display resolution."},"scale":{"type":"number","description":"Display scale factor.","example":2}},"required":["url","width","height","inner","home","dimensions","scale"],"additionalProperties":{"nullable":true},"description":"Frame geometry and metadata for the flavor."},"FlavorImage":{"type":"string","format":"binary","description":"Image file contents."},"HookList":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/Hook"},"description":"List of hypervisor hooks."},"count":{"type":"integer","minimum":0,"description":"Number of results in this page. Can be less than `limit` on the last page.","example":25},"total":{"type":"integer","minimum":0,"description":"Number of results across all pages, after any filters.","example":137},"limit":{"type":"integer","minimum":0,"description":"The page size that was used (your `limit`, or the default 100).","example":25},"offset":{"type":"integer","minimum":0,"description":"The offset that was used (your `offset`, or the default 0).","example":0},"hasMore":{"type":"boolean","description":"True if more results exist after this page. To read everything, keep requesting with `offset` increased by `limit` until this is false.","example":true}},"required":["results","count","total","limit","offset","hasMore"]},"Hook":{"type":"object","properties":{"identifier":{"type":"string","format":"uuid","description":"Hook identifier.","example":"2a1192e8-c7de-4981-bc11-c87fd1f12d13"},"label":{"type":"string","description":"Hook label.","example":"Bypass jailbreak detection"},"address":{"type":"string","description":"EL1/kernel virtual address, in hexadecimal, where the hook fires: the patch runs each time the device executes the instruction at this address.  If a slide is applied at runtime, do not include it.","example":"0x1000042a4"},"patch":{"type":"string","description":"The code to run when the hook fires, in the language given by `patchType`.","example":"return 0;"},"patchType":{"$ref":"#/components/schemas/HookPatchType"},"enabled":{"type":"boolean","description":"Whether the hook runs. Disabled hooks are kept but skipped.","example":true},"instanceId":{"type":"string","format":"uuid","description":"Owning instance identifier.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"createdAt":{"type":"string","format":"date-time","description":"Creation timestamp.","example":"2026-03-14T09:12:47.000Z"},"updatedAt":{"type":"string","format":"date-time","description":"Last update timestamp.","example":"2026-03-17T11:41:05.000Z"}},"required":["identifier","label","address","patch","patchType","enabled","instanceId","createdAt","updatedAt"]},"HookPatchType":{"type":"string","enum":["csmfcc","csmfvm"],"description":"Language the `patch` is written in: `csmfcc` for a C-like language, or `csmfvm` for an assembly-like language."},"CreateHookBody":{"type":"object","properties":{"label":{"type":"string","description":"Hook label.","example":"Bypass jailbreak detection"},"address":{"type":"string","description":"Memory address to hook.","example":"0x1000042a4"},"patch":{"type":"string","description":"Patch code to execute.","example":"return 0;"},"patchType":{"$ref":"#/components/schemas/HookPatchType"},"enabled":{"type":"boolean","default":true,"description":"Whether the hook is active."}},"required":["label","address","patch","patchType"]},"UpdateHookBody":{"type":"object","properties":{"label":{"type":"string","description":"Hook label.","example":"Bypass jailbreak detection"},"address":{"type":"string","description":"Memory address to hook.","example":"0x1000042a4"},"patch":{"type":"string","description":"Patch code to execute.","example":"return 0;"},"patchType":{"$ref":"#/components/schemas/HookPatchType"},"enabled":{"type":"boolean","description":"Whether the hook is active.","example":false}}},"HypertuneHashResponse":{"type":"object","properties":{"hash":{"type":"string","description":"Current Hypertune state hash."}},"required":["hash"]},"HypertuneInitResponse":{"type":"object","properties":{"commitId":{"type":"number","description":"Hypertune configuration commit ID."},"hash":{"type":"string","description":"Hypertune configuration state hash."},"reducedExpression":{"type":"object","additionalProperties":{"nullable":true},"description":"Reduced Hypertune evaluation expression."},"splits":{"type":"object","additionalProperties":{"nullable":true},"description":"Hypertune split configuration."},"commitConfig":{"type":"object","additionalProperties":{"nullable":true},"description":"Hypertune commit configuration."}},"additionalProperties":{"nullable":true}},"InstanceSnapshotsList":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/Snapshot"},"description":"Instance snapshots."},"count":{"type":"integer","minimum":0,"description":"Number of results in this page. Can be less than `limit` on the last page.","example":25},"total":{"type":"integer","minimum":0,"description":"Number of results across all pages, after any filters.","example":137},"limit":{"type":"integer","minimum":0,"description":"The page size that was used (your `limit`, or the default 100).","example":25},"offset":{"type":"integer","minimum":0,"description":"The offset that was used (your `offset`, or the default 0).","example":0},"hasMore":{"type":"boolean","description":"True if more results exist after this page. To read everything, keep requesting with `offset` increased by `limit` until this is false.","example":true}},"required":["results","count","total","limit","offset","hasMore"]},"CreateSnapshotBody":{"type":"object","properties":{"name":{"type":"string","description":"A name to recognise the snapshot by later, for example what state the device was in.","example":"before-update"}},"required":["name"]},"ProviderNetworkConnection":{"oneOf":[{"$ref":"#/components/schemas/OpenVPNNetworkConnection"},{"$ref":"#/components/schemas/VLANNetworkConnection"}],"discriminator":{"propertyName":"provider","mapping":{"openvpn":"#/components/schemas/OpenVPNNetworkConnection","vlan":"#/components/schemas/VLANNetworkConnection"}}},"OpenVPNNetworkConnection":{"type":"object","properties":{"name":{"type":"string","description":"User friendly name for network connection.","example":"office-vpn"},"provider":{"type":"string","enum":["openvpn"],"description":"Type of network connection."},"config":{"anyOf":[{"$ref":"#/components/schemas/OpenVPNConfig"},{"type":"object","nullable":true,"enum":[null]}]},"identifier":{"type":"string","format":"uuid","description":"Unique identifier for the network connection.","example":"0eb5d1e7-2c10-42b1-95fc-30e4e4885cd7"},"projects":{"type":"object","additionalProperties":{"type":"object","properties":{"state":{"type":"string","enum":["disconnected","disconnecting","connecting","connected","error"],"description":"State of the project network connection."},"details":{"type":"object","additionalProperties":{"nullable":true},"description":"Additional parameters for the network state."}},"required":["state"]},"description":"Network states mapped by project IDs.","example":{"1c41b1bc-4f53-48a8-b690-ad30611e1960":{"state":"connected"}}},"createdAt":{"type":"string","format":"date-time","description":"Timestamp when the network connection was created.","example":"2026-03-14T09:12:47.000Z"},"updatedAt":{"type":"string","format":"date-time","description":"Timestamp when the network connection was last updated.","example":"2026-03-17T11:41:05.000Z"},"createdBy":{"type":"string","format":"uuid","description":"User ID of the creator.","example":"e8c5b7ea-aa5f-4a4a-bdca-0c67060b5320"},"updatedBy":{"type":"string","format":"uuid","description":"User ID of the last updater.","example":"e8c5b7ea-aa5f-4a4a-bdca-0c67060b5320"}},"required":["name","provider","identifier","createdAt","updatedAt","createdBy","updatedBy"]},"OpenVPNConfig":{"type":"object","properties":{"username":{"type":"string","description":"Username for OpenVPN connection.","example":"jane.doe"},"password":{"type":"string","description":"Password for OpenVPN connection.","example":"<redacted>"},"config":{"type":"string","description":"OpenVPN connection configuration.","example":"client\ndev tun\nproto udp\nremote vpn.example.com 1194\nresolv-retry infinite\nnobind\npersist-key\npersist-tun\nremote-cert-tls server\ncipher AES-256-CBC\nverb 3\n<ca>\n-----BEGIN CERTIFICATE-----\n<ca-certificate>\n-----END CERTIFICATE-----\n</ca>\n"}},"required":["config"]},"VLANNetworkConnection":{"type":"object","properties":{"name":{"type":"string","description":"User friendly name for network connection.","example":"lab-vlan"},"provider":{"type":"string","enum":["vlan"],"description":"Type of network connection."},"config":{"anyOf":[{"$ref":"#/components/schemas/VLANConfig"},{"type":"object","nullable":true,"enum":[null]}]},"identifier":{"type":"string","format":"uuid","description":"Unique identifier for the network connection.","example":"0eb5d1e7-2c10-42b1-95fc-30e4e4885cd7"},"projects":{"type":"object","additionalProperties":{"type":"object","properties":{"state":{"type":"string","enum":["disconnected","disconnecting","connecting","connected","error"],"description":"State of the project network connection."},"details":{"type":"object","additionalProperties":{"nullable":true},"description":"Additional parameters for the network state."}},"required":["state"]},"description":"Network states mapped by project IDs.","example":{"1c41b1bc-4f53-48a8-b690-ad30611e1960":{"state":"connected"}}},"createdAt":{"type":"string","format":"date-time","description":"Timestamp when the network connection was created.","example":"2026-03-14T09:12:47.000Z"},"updatedAt":{"type":"string","format":"date-time","description":"Timestamp when the network connection was last updated.","example":"2026-03-17T11:41:05.000Z"},"createdBy":{"type":"string","format":"uuid","description":"User ID of the creator.","example":"e8c5b7ea-aa5f-4a4a-bdca-0c67060b5320"},"updatedBy":{"type":"string","format":"uuid","description":"User ID of the last updater.","example":"e8c5b7ea-aa5f-4a4a-bdca-0c67060b5320"}},"required":["name","provider","identifier","createdAt","updatedAt","createdBy","updatedBy"]},"VLANConfig":{"type":"object","properties":{"physicalInterface":{"type":"string","description":"Physical network interface to create VLAN on","example":"eth0"},"vlanId":{"type":"number","minimum":1,"maximum":4094,"description":"VLAN ID (1-4094)","example":42},"dhcpMode":{"type":"string","enum":["internal","external"],"description":"DHCP server mode"},"gateway":{"type":"string","format":"ip","description":"Gateway IP address","example":"10.0.0.1"},"network":{"type":"string","description":"Network address","example":"10.0.0.0/24"},"dnsServers":{"type":"array","items":{"type":"string","format":"ip"},"description":"List of DNS servers","example":["1.1.1.1","8.8.8.8"]}},"required":["physicalInterface","vlanId","dhcpMode"]},"NetworkConnections":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/ProviderNetworkConnection"},"description":"Network connections"},"count":{"type":"integer","minimum":0,"description":"Number of results in this page. Can be less than `limit` on the last page.","example":25},"total":{"type":"integer","minimum":0,"description":"Number of results across all pages, after any filters.","example":137},"limit":{"type":"integer","minimum":0,"description":"The page size that was used (your `limit`, or the default 100).","example":25},"offset":{"type":"integer","minimum":0,"description":"The offset that was used (your `offset`, or the default 0).","example":0},"hasMore":{"type":"boolean","description":"True if more results exist after this page. To read everything, keep requesting with `offset` increased by `limit` until this is false.","example":true}},"required":["results","count","total","limit","offset","hasMore"]},"CreateNetworkConnectionBody":{"oneOf":[{"$ref":"#/components/schemas/CreateOpenVPNNetworkConnectionBody"},{"$ref":"#/components/schemas/CreateVLANNetworkConnectionBody"}],"discriminator":{"propertyName":"provider","mapping":{"openvpn":"#/components/schemas/CreateOpenVPNNetworkConnectionBody","vlan":"#/components/schemas/CreateVLANNetworkConnectionBody"}}},"CreateOpenVPNNetworkConnectionBody":{"type":"object","properties":{"name":{"type":"string","description":"User friendly name for network connection.","example":"office-vpn"},"provider":{"type":"string","enum":["openvpn"],"description":"Type of network connection."},"config":{"$ref":"#/components/schemas/OpenVPNConfig"}},"required":["name","provider","config"]},"CreateVLANNetworkConnectionBody":{"type":"object","properties":{"name":{"type":"string","description":"User friendly name for network connection.","example":"lab-vlan"},"provider":{"type":"string","enum":["vlan"],"description":"Type of network connection."},"config":{"$ref":"#/components/schemas/VLANConfig"}},"required":["name","provider","config"]},"UpdateNetworkConnectionBody":{"type":"object","properties":{"name":{"type":"string","description":"User friendly name for Network connection.","example":"office-vpn"},"config":{"$ref":"#/components/schemas/NetworkConnectionConfig"},"force":{"type":"boolean","default":false,"description":"Force the operation through constraint checks (e.g. stopping active instances)."}},"required":["name"]},"NetworkConnectionConfig":{"oneOf":[{"$ref":"#/components/schemas/OpenVPNConfig"},{"$ref":"#/components/schemas/VLANConfig"}],"description":"Additional network configuration based on selected provider."},"PartialUpdateNetworkConnectionBody":{"type":"object","properties":{"name":{"type":"string","description":"User friendly name for Network connection.","example":"office-vpn"},"config":{"$ref":"#/components/schemas/NetworkConnectionConfig"},"force":{"type":"boolean","default":false,"description":"Force the operation through constraint checks (e.g. stopping active instances)."}}},"NetworkConnectionProviders":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"OpenVPN"},"type":{"type":"string","example":"openvpn"}},"required":["name","type"]},"description":"Network providers"},"count":{"type":"integer","minimum":0,"description":"Number of results in this page. Can be less than `limit` on the last page.","example":25},"total":{"type":"integer","minimum":0,"description":"Number of results across all pages, after any filters.","example":137},"limit":{"type":"integer","minimum":0,"description":"The page size that was used (your `limit`, or the default 100).","example":25},"offset":{"type":"integer","minimum":0,"description":"The offset that was used (your `offset`, or the default 0).","example":0},"hasMore":{"type":"boolean","description":"True if more results exist after this page. To read everything, keep requesting with `offset` increased by `limit` until this is false.","example":true}},"required":["results","count","total","limit","offset","hasMore"]},"NetworkInterfaces":{"type":"object","properties":{"results":{"type":"array","items":{"type":"string","example":"eth0"},"description":"Network Interfaces"},"count":{"type":"integer","minimum":0,"description":"Number of results in this page. Can be less than `limit` on the last page.","example":25},"total":{"type":"integer","minimum":0,"description":"Number of results across all pages, after any filters.","example":137},"limit":{"type":"integer","minimum":0,"description":"The page size that was used (your `limit`, or the default 100).","example":25},"offset":{"type":"integer","minimum":0,"description":"The offset that was used (your `offset`, or the default 0).","example":0},"hasMore":{"type":"boolean","description":"True if more results exist after this page. To read everything, keep requesting with `offset` increased by `limit` until this is false.","example":true}},"required":["results","count","total","limit","offset","hasMore"]},"RolesListResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/Role"},"description":"Array of role assignments."},"count":{"type":"integer","minimum":0,"description":"Number of results in this page. Can be less than `limit` on the last page.","example":25},"total":{"type":"integer","minimum":0,"description":"Number of results across all pages, after any filters.","example":137},"limit":{"type":"integer","minimum":0,"description":"The page size that was used (your `limit`, or the default 100).","example":25},"offset":{"type":"integer","minimum":0,"description":"The offset that was used (your `offset`, or the default 0).","example":0},"hasMore":{"type":"boolean","description":"True if more results exist after this page. To read everything, keep requesting with `offset` increased by `limit` until this is false.","example":true}},"required":["results","count","total","limit","offset","hasMore"]},"Role":{"type":"object","properties":{"role":{"$ref":"#/components/schemas/RoleName"},"project":{"type":"string","format":"uuid","description":"Project identifier (when scoped to a project).","example":"1c41b1bc-4f53-48a8-b690-ad30611e1960"},"deployment":{"type":"string","description":"Deployment identifier (when scoped to a deployment).","example":"prod-us-east"},"user":{"type":"string","format":"uuid","description":"User identifier (when granted to a user).","example":"e8c5b7ea-aa5f-4a4a-bdca-0c67060b5320"},"team":{"type":"string","format":"uuid","description":"Team identifier (when granted to a team).","example":"089c8ffd-ca4d-4d35-80ab-0847d18b7213"}},"required":["role"]},"RoleName":{"type":"string","enum":["admin","member"],"description":"Role identifier."},"StorageList":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/MediaStore"},"description":"Storage devices in this response."},"count":{"type":"integer","minimum":0,"description":"Number of results in this page. Can be less than `limit` on the last page.","example":25},"total":{"type":"integer","minimum":0,"description":"Number of results across all pages, after any filters.","example":137},"limit":{"type":"integer","minimum":0,"description":"The page size that was used (your `limit`, or the default 100).","example":25},"offset":{"type":"integer","minimum":0,"description":"The offset that was used (your `offset`, or the default 0).","example":0},"hasMore":{"type":"boolean","description":"True if more results exist after this page. To read everything, keep requesting with `offset` increased by `limit` until this is false.","example":true}},"required":["results","count","total","limit","offset","hasMore"]},"MediaStore":{"type":"object","properties":{"identifier":{"type":"string","format":"uuid","description":"Storage device identifier.","example":"73357171-23a0-4a3e-8661-216dbfbdd7ab"},"device":{"type":"string","description":"Device name.","example":"/dev/sdb1"},"fsType":{"type":"string","description":"Filesystem type.","example":"ext4"},"fsUuid":{"type":"string","nullable":true,"description":"Filesystem UUID.","example":"4a3f2e1d-8c7b-4a19-9e2f-6d5c4b3a2190"},"label":{"type":"string","description":"Volume label.","example":"EXTERNAL_SSD"},"serial":{"type":"string","description":"Device serial number.","example":"0123456789ABCDEF"},"vendor":{"type":"string","description":"Device vendor.","example":"SanDisk"},"model":{"type":"string","description":"Device model.","example":"Ultra USB 3.0"},"mountPolicy":{"type":"string","enum":["RO","RW"],"description":"Mount policy (read-only or read-write)."},"status":{"type":"string","enum":["mounted","unmounted"],"description":"Mount status."},"createdAt":{"type":"string","format":"date-time","description":"Creation timestamp.","example":"2026-03-14T09:12:47.000Z"},"updatedAt":{"type":"string","format":"date-time","description":"Last update timestamp.","example":"2026-03-17T11:41:05.000Z"}},"required":["identifier","device","fsType","fsUuid","label","serial","vendor","model","mountPolicy","status","createdAt","updatedAt"]},"StorageFileList":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/StorageFile"},"description":"Files and directories in this response."},"count":{"type":"integer","minimum":0,"description":"Number of results in this page. Can be less than `limit` on the last page.","example":25},"total":{"type":"integer","minimum":0,"description":"Number of results across all pages, after any filters.","example":137},"limit":{"type":"integer","minimum":0,"description":"The page size that was used (your `limit`, or the default 100).","example":25},"offset":{"type":"integer","minimum":0,"description":"The offset that was used (your `offset`, or the default 0).","example":0},"hasMore":{"type":"boolean","description":"True if more results exist after this page. To read everything, keep requesting with `offset` increased by `limit` until this is false.","example":true}},"required":["results","count","total","limit","offset","hasMore"]},"StorageFile":{"type":"object","properties":{"name":{"type":"string","description":"File or directory name.","example":"firmware.ipsw"},"ext":{"type":"string","nullable":true,"description":"File extension, or null for directories.","example":"ipsw"},"type":{"type":"string","enum":["file","directory"],"description":"Entry type."},"size":{"type":"integer","description":"Size in bytes (0 for directories).","example":2147483648},"lastModifiedTime":{"type":"string","nullable":true,"format":"date-time","description":"Last modified timestamp, or 1970-01-01T00:00:00.000Z when the entry could not be stat'd.","example":"2026-03-17T11:41:05.000Z"}},"required":["name","ext","type","size","lastModifiedTime"]},"DeploymentVersion":{"type":"object","properties":{"productVersion":{"type":"string","minLength":1,"description":"Deployed Corellium product version."},"coordinatorVersion":{"type":"string","nullable":true,"minLength":1,"description":"Coordinator artifact version."},"buildCommit":{"type":"string","nullable":true,"pattern":"^[0-9a-f]{40}$","description":"Full coordinator source commit SHA."},"buildDate":{"type":"string","nullable":true,"format":"date-time","description":"Coordinator artifact build time in RFC 3339 UTC format."}},"required":["productVersion","coordinatorVersion","buildCommit","buildDate"],"additionalProperties":false,"description":"Version and build identity of the running deployment.","example":{"productVersion":"7.4.0-28212","coordinatorVersion":"1.24.3861","buildCommit":"9f2b1c7d4e5a6b8c0d1e2f3a4b5c6d7e8f901a2b","buildDate":"2026-03-14T09:12:47.000Z"}},"WebPlayerCreatedSession":{"allOf":[{"$ref":"#/components/schemas/WebPlayerSession"},{"type":"object","properties":{"domain":{"$ref":"#/components/schemas/WebPlayerSessionDomain"},"time":{"type":"integer","description":"Server timestamp (ms) when the session was created.","example":1773479567000},"disabled":{"type":"boolean","description":"Present and set when the domain is disabled (public flag).","example":true}}}]},"WebPlayerSessionDomain":{"type":"object","properties":{"name":{"type":"string","description":"Domain name.","example":"acme-corp"},"label":{"type":"string","nullable":true,"description":"Domain description/label.","example":"Acme Corp"},"termsPolicy":{"type":"string","nullable":true,"description":"Domain terms policy.","example":"all-modal"},"cores":{"type":"number","description":"Core quota for the domain.","example":8},"individual":{"type":"boolean","description":"Whether the domain is an individual account nested under an aggregate parent domain.","example":false},"totpRequired":{"type":"boolean","description":"Whether two-factor is required for the domain.","example":true}},"required":["name"],"additionalProperties":{"nullable":true},"description":"Domain configuration for the session."},"WebPlayerSession":{"type":"object","properties":{"identifier":{"type":"string","format":"uuid","description":"Session identifier.","example":"a3569608-10e1-41c7-99fa-1a7d1f336c58"},"token":{"type":"string","description":"Session token to hand to the Web Player in your page. It grants access only to this one device and only to the enabled features, until `expiration`.","example":"<token>"},"expiration":{"type":"string","format":"date-time","description":"Session expiration timestamp.","example":"2027-01-15T00:00:00.000Z"}},"required":["identifier","token","expiration"]},"CreateWebPlayerSessionBody":{"type":"object","properties":{"projectId":{"type":"string","format":"uuid","description":"Project the device is in.","example":"1c41b1bc-4f53-48a8-b690-ad30611e1960"},"instanceId":{"type":"string","format":"uuid","description":"The device (instance) the viewer will see and control.","example":"f7f9832a-f824-416f-a5ea-4adfe34754b5"},"expiresIn":{"type":"integer","minimum":1800,"description":"How long the session token stays valid, in seconds. At least 1800 (30 minutes). Renewing the token keeps the same length.","example":18000},"features":{"$ref":"#/components/schemas/WebPlayerFeatures"},"clientId":{"type":"string","description":"Optional client-supplied tracking string.","example":"web-console-1234"}},"required":["projectId","instanceId","expiresIn","features"]},"WebPlayerFeatures":{"type":"object","properties":{"apps":{"type":"boolean","description":"Whether the viewer may use the apps part of the device interface. Features left out are off.","example":true},"connect":{"type":"boolean","description":"Whether the viewer may use the connect part of the device interface. Features left out are off.","example":true},"console":{"type":"boolean","description":"Whether the viewer may use the console part of the device interface. Features left out are off.","example":true},"coretrace":{"type":"boolean","description":"Whether the viewer may use the coretrace part of the device interface. Features left out are off.","example":true},"deviceControl":{"type":"boolean","description":"Whether the viewer may use the deviceControl part of the device interface. Features left out are off.","example":true},"deviceDelete":{"type":"boolean","description":"Whether the viewer may use the deviceDelete part of the device interface. Features left out are off.","example":true},"files":{"type":"boolean","description":"Whether the viewer may use the files part of the device interface. Features left out are off.","example":true},"frida":{"type":"boolean","description":"Whether the viewer may use the frida part of the device interface. Features left out are off.","example":true},"images":{"type":"boolean","description":"Whether the viewer may use the images part of the device interface. Features left out are off.","example":true},"messaging":{"type":"boolean","description":"Whether the viewer may use the messaging part of the device interface. Features left out are off.","example":true},"netmon":{"type":"boolean","description":"Whether the viewer may use the netmon part of the device interface. Features left out are off.","example":true},"network":{"type":"boolean","description":"Whether the viewer may use the network part of the device interface. Features left out are off.","example":true},"portForwarding":{"type":"boolean","description":"Whether the viewer may use the portForwarding part of the device interface. Features left out are off.","example":true},"powerManagement":{"type":"boolean","description":"Whether the viewer may use the powerManagement part of the device interface. Features left out are off.","example":true},"profile":{"type":"boolean","description":"Whether the viewer may use the profile part of the device interface. Features left out are off.","example":true},"sensors":{"type":"boolean","description":"Whether the viewer may use the sensors part of the device interface. Features left out are off.","example":true},"settings":{"type":"boolean","description":"Whether the viewer may use the settings part of the device interface. Features left out are off.","example":true},"snapshots":{"type":"boolean","description":"Whether the viewer may use the snapshots part of the device interface. Features left out are off.","example":true},"strace":{"type":"boolean","description":"Whether the viewer may use the strace part of the device interface. Features left out are off.","example":true},"system":{"type":"boolean","description":"Whether the viewer may use the system part of the device interface. Features left out are off.","example":true}},"description":"Which parts of the device interface the viewer may use, for example `apps`, `files` or `console`. Only features set to true are available in the session."},"WebPlayerSessionListResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/WebPlayerSession"},"description":"Webplayer sessions."},"count":{"type":"integer","minimum":0,"description":"Number of results in this page. Can be less than `limit` on the last page.","example":25},"total":{"type":"integer","minimum":0,"description":"Number of results across all pages, after any filters.","example":137},"limit":{"type":"integer","minimum":0,"description":"The page size that was used (your `limit`, or the default 100).","example":25},"offset":{"type":"integer","minimum":0,"description":"The offset that was used (your `offset`, or the default 0).","example":0},"hasMore":{"type":"boolean","description":"True if more results exist after this page. To read everything, keep requesting with `offset` increased by `limit` until this is false.","example":true}},"required":["results","count","total","limit","offset","hasMore"]},"WebPlayerAllowedDomains":{"type":"object","properties":{"allowedDomains":{"type":"array","items":{"type":"string"},"description":"Domains permitted for webplayer sessions.","example":["example.com"]}},"required":["allowedDomains"]}},"parameters":{},"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"ApiToken or JWT","description":"Token to authorize API access"}}}}