Skip to content

Instantly share code, notes, and snippets.

@Manouchehri
Created January 24, 2024 18:46
Show Gist options
  • Save Manouchehri/43c280586d3ddbabac0a2e1792813f5f to your computer and use it in GitHub Desktop.
Save Manouchehri/43c280586d3ddbabac0a2e1792813f5f to your computer and use it in GitHub Desktop.
Corellium Webinar Files (20240124)
{
"openapi": "3.0.0",
"info": {
"title": "Corellium API",
"description": "REST API to manage your virtual devices.",
"termsOfService": "https://www.corellium.com/legal/terms",
"version": "5.7.1-19700"
},
"servers": [
{
"url": "https://moda.enterprise.corellium.com/api",
"description": "",
"variables": {
"serverName": {
"default": "moda.enterprise.corellium.com"
}
}
}
],
"security": [
{
"BearerAuth": []
}
],
"components": {
"securitySchemes": {
"BearerAuth": {
"type": "http",
"scheme": "bearer",
"bearerFormat": "ApiToken or JWT",
"description": "Token to authorize API access"
}
},
"schemas": {
"Credentials": {
"description": "",
"required": [
"username",
"password"
],
"type": "object",
"properties": {
"username": {
"description": "Authentication Username",
"type": "string"
},
"password": {
"description": "Authentication Password",
"type": "string",
"format": "password"
}
}
},
"Token": {
"description": "",
"required": [
"token"
],
"type": "object",
"properties": {
"token": {
"description": "",
"type": "string"
},
"expiration": {
"description": "Token expiration",
"type": "string",
"format": "date-time",
"nullable": true
}
}
},
"ApiToken": {
"description": "",
"required": [
"apiToken"
],
"type": "object",
"properties": {
"apiToken": {
"description": "",
"type": "string"
}
}
},
"coupon_options": {
"description": "Coupon options",
"required": [
"type",
"amount",
"used"
],
"type": "object",
"properties": {
"type": {
"description": "",
"type": "string",
"enum": [
"percent",
"discount",
"absolute"
]
},
"amount": {
"description": "Amount",
"type": "number"
},
"used": {
"description": "Is Used. If true, this coupon has been used and cannot be used again",
"type": "boolean"
}
}
},
"plan": {
"description": "Plan options",
"required": [
"licenseType",
"cores"
],
"type": "object",
"properties": {
"licenseType": {
"description": "",
"type": "string",
"enum": [
"premium",
"individual",
"standard",
"enterprise",
"individual-usage",
"enterprise-usage",
"unrestricted"
]
},
"cores": {
"description": "Number of CPU cores",
"type": "integer"
}
}
},
"trial": {
"description": "Trial options",
"required": [
"duration"
],
"type": "object",
"properties": {
"duration": {
"description": "Duration in days",
"type": "number"
}
}
},
"SubscriberInvite": {
"description": "Subscriber Invite",
"required": [
"coupon_code",
"aggregate",
"active",
"reusable",
"createdAt",
"updatedAt"
],
"type": "object",
"properties": {
"coupon_options": {
"description": "Coupon Options",
"$ref": "#/components/schemas/coupon_options",
"nullable": true
},
"plan": {
"description": "Plan Options",
"$ref": "#/components/schemas/plan",
"nullable": true
},
"trial": {
"description": "Trial Options",
"$ref": "#/components/schemas/trial",
"nullable": true
},
"name": {
"description": "Name",
"type": "string",
"nullable": true
},
"email": {
"description": "Email",
"type": "string",
"nullable": true
},
"coupon_code": {
"description": "Coupon code",
"type": "string"
},
"domain": {
"description": "Domain",
"type": "string",
"nullable": true
},
"aggregate": {
"description": "Aggregate",
"type": "string"
},
"use_by": {
"description": "Used By",
"type": "string",
"nullable": true
},
"active": {
"description": "Is Active flag",
"type": "boolean"
},
"reusable": {
"description": "Is reusable flag",
"type": "boolean"
},
"createdAt": {
"description": "Created Date in ISO-8601 format e.g. 2022-05-06T02:39:23.000Z",
"type": "string"
},
"updatedAt": {
"description": "Updated Date in ISO-8601 format e.g. 2022-05-06T02:39:23.000Z",
"type": "string"
}
}
},
"EmptyResponse": {
"description": "",
"type": "object",
"properties": {}
},
"TrialRequestMetadata": {
"description": "",
"type": "object",
"properties": {
"name": {
"description": "",
"type": "string",
"nullable": true
},
"company": {
"description": "provided company name",
"type": "string",
"nullable": true
},
"malware": {
"description": "option from sign up form, interesting using for malware",
"type": "boolean",
"nullable": true
},
"research": {
"description": "option from sign up form, interesting using for research",
"type": "boolean",
"nullable": true
},
"pentest": {
"description": "option from sign up form, interesting using for pentesting",
"type": "boolean",
"nullable": true
},
"other": {
"description": "option from sign up form, interesting using for other area added here",
"type": "string",
"nullable": true
}
}
},
"Address": {
"description": "The user's address",
"type": "object",
"properties": {
"address1": {
"description": "Address line 1 (e.g., street, PO Box, or company name).",
"type": "string",
"nullable": true
},
"address2": {
"description": "Address line 2 (e.g., apartment, suite, unit, or building).",
"type": "string",
"nullable": true
},
"city": {
"description": "City, district, suburb, town, or village.",
"type": "string",
"nullable": true
},
"country": {
"description": "Two-letter country code (ISO 3166-1 alpha-2).",
"type": "string",
"nullable": true
},
"postal_code": {
"description": "ZIP or postal code.",
"type": "string",
"nullable": true
},
"state": {
"description": "State, county, province, or region.",
"type": "string",
"nullable": true
}
}
},
"TrialRequestOptions": {
"description": "",
"type": "object",
"properties": {
"address": {
"description": "The user's address.",
"$ref": "#/components/schemas/Address",
"nullable": true
},
"email": {
"description": "The user's email address.",
"type": "string",
"nullable": true
},
"name": {
"description": "The user's full name.",
"type": "string",
"nullable": true
},
"metadata": {
"description": "Metadata passed in from the sign up flow",
"$ref": "#/components/schemas/TrialRequestMetadata",
"nullable": true
},
"enterprise": {
"description": "If true, create an enterprise domain.",
"type": "boolean",
"nullable": true
},
"token": {
"description": "Stripe payment token.",
"type": "string",
"nullable": true
}
}
},
"GrantTrialRequestResponse": {
"description": "",
"type": "object",
"properties": {
"code": {
"description": "Trial request code",
"type": "string",
"nullable": true
}
}
},
"Plan": {
"description": "",
"type": "object",
"properties": {
"planId": {
"description": "Plan ID",
"type": "string",
"nullable": true
},
"name": {
"description": "Plan Name",
"type": "string",
"nullable": true
}
}
},
"Maintenance": {
"description": "",
"type": "object",
"properties": {
"message": {
"description": "Maintenance message",
"type": "string",
"nullable": true
},
"header": {
"description": "Maintenance header",
"type": "string",
"nullable": true
}
}
},
"Trial": {
"description": "",
"type": "object",
"properties": {
"defaultDuration": {
"description": "Maintenance message",
"type": "number",
"nullable": true
},
"defaultHours": {
"description": "Maintenance header",
"type": "number",
"nullable": true
},
"defaultDevices": {
"description": "Maintenance header",
"type": "number",
"nullable": true
},
"defaultCores": {
"description": "Maintenance header",
"type": "number",
"nullable": true
}
}
},
"Logging": {
"description": "",
"type": "object",
"properties": {
"development": {
"description": "Denotes whether it's in development",
"type": "boolean",
"nullable": true
},
"throwWarnings": {
"description": "Denotes whether to throw warnings",
"type": "boolean",
"nullable": true
}
}
},
"AuthProvider": {
"description": "",
"type": "object",
"properties": {
"name": {
"description": "Provider name for a given provider type",
"type": "string",
"nullable": true
},
"identifier": {
"description": "The identifier for the provider",
"type": "string",
"nullable": true
},
"providerType": {
"description": "Provider type",
"type": "string",
"nullable": true
},
"default": {
"description": "Denotes whether it's the default",
"type": "boolean",
"nullable": true
},
"label": {
"description": "Provider label",
"type": "string",
"nullable": true
},
"enabled": {
"description": "Denotes whether they're enabled or not",
"type": "boolean",
"nullable": true
},
"authorizationUrl": {
"description": "URL for provider auth",
"type": "string",
"nullable": true
},
"id": {
"description": "The identifier for the provider",
"type": "string",
"nullable": true
},
"provider": {
"description": "Auth provider",
"type": "string",
"nullable": true
}
}
},
"ConfigResponse": {
"description": "",
"type": "object",
"properties": {
"onSite": {
"description": "Denotes whether it's an on-site install",
"type": "boolean",
"nullable": true
},
"showDomainSettings": {
"description": "Denotes whether to show domain settings",
"type": "boolean",
"nullable": true
},
"version": {
"description": "Denotes the version",
"type": "string",
"nullable": true
},
"invalidBuild": {
"description": "Denotes whether the build is invalid",
"type": "boolean",
"nullable": true
},
"sepSim": {
"description": "Denotes whether sepSim is enabled",
"type": "boolean",
"nullable": true
},
"installerAvailable": {
"description": "Denotes whether installer is available",
"type": "boolean",
"nullable": true
},
"invoicedPublishableKey": {
"description": "API publishable key to use for Invoiced",
"type": "string",
"nullable": true
},
"stripePublicKey": {
"description": "Stripe public key",
"type": "string",
"nullable": true
},
"intercomId": {
"description": "Intercom app ID, also known as workspace ID",
"type": "string",
"nullable": true
},
"auxWebhook": {
"description": "Webhook URL for aux",
"type": "string",
"nullable": true
},
"gtmId": {
"description": "Google Tag Manager",
"type": "string",
"nullable": true
},
"zapierFeedbackWebhook": {
"description": "Webhook URL to send feedback into Productboard automatically",
"type": "string",
"nullable": true
},
"zapierBugsWebhook": {
"description": "Webhook URL to send frontend errors to Jira automatically",
"type": "string",
"nullable": true
},
"billingBackend": {
"description": "Default backend billing api name for new subscriptions (e.g. \"stripe\")",
"type": "string",
"nullable": true
},
"maintenance": {
"description": "Denotes whether the server is undergoing maintenance",
"oneOf": [
{
"type": "boolean"
},
{
"$ref": "#/components/schemas/Maintenance"
}
],
"nullable": true
},
"logging": {
"description": "Info for logging",
"$ref": "#/components/schemas/Logging",
"nullable": true
},
"cloudAdmin": {
"description": "URL for cloud admin login",
"type": "string",
"nullable": true
},
"filesAdmin": {
"description": "URL for files admin login",
"type": "string",
"nullable": true
},
"cloudDomain": {
"description": "Cloud domain name (usually corellium.com or staging.corellium.com)",
"type": "string",
"nullable": true
},
"billingDomain": {
"description": "Billing domain name",
"type": "string",
"nullable": true
},
"appDomain": {
"description": "App domain name (usually app.corellium.com or app.staging.corellium.com)",
"type": "string",
"nullable": true
},
"maxNetworkMonitorFileSize": {
"description": "Maximum network monitor file size",
"type": "string",
"nullable": true
},
"enableFirmwareImageUpload": {
"description": "Denotes whether users can upload firmware images",
"type": "boolean",
"nullable": true
},
"authProviders": {
"description": "Auth providers",
"type": "array",
"items": {
"$ref": "#/components/schemas/AuthProvider"
},
"nullable": true
},
"snapshotLimit": {
"description": "Maximum number of snapshots to allow",
"type": "number",
"nullable": true
},
"maxKernelSize": {
"description": "The maximum size, in bytes, (default: 100 MB) that an uploaded kernel should be",
"type": "number",
"nullable": true
},
"maxRamdiskSize": {
"description": "The maximum size, in bytes, (default: 500 MB) that an uploaded ramdisk should be",
"type": "number",
"nullable": true
},
"charmSDK": {
"description": "Denotes whether charmSDK is enabled",
"type": "string",
"nullable": true
},
"trial": {
"description": "Info about trial",
"$ref": "#/components/schemas/Trial",
"nullable": true
},
"sentryUrl": {
"description": "Sentry URL",
"type": "string",
"nullable": true
},
"domainAuthenticationProviders": {
"description": "If enabled, adds the default providers in their current configuration",
"type": "boolean",
"nullable": true
}
}
},
"DomainOptions": {
"description": "",
"type": "object",
"properties": {
"totpRequired": {
"description": "if true, totp is required",
"type": "boolean",
"nullable": true
},
"trialExtension": {
"description": "",
"$ref": "#/components/schemas/TrialExtension",
"nullable": true
}
}
},
"TrialExtension": {
"description": "",
"type": "object",
"properties": {
"duration": {
"description": "how many additional days?",
"type": "number",
"nullable": true
},
"reason": {
"description": "why does the user want more time?",
"type": "string",
"nullable": true
},
"denied": {
"description": "",
"type": "boolean",
"nullable": true
},
"deniedReason": {
"description": "explanation for why the request was denied",
"type": "string",
"nullable": true
}
}
},
"OpenIDConfig": {
"description": "",
"type": "object",
"properties": {
"discoveryUrl": {
"description": "Service Discovery URL",
"type": "string",
"nullable": true
},
"clientId": {
"description": "Service Client ID",
"type": "string",
"nullable": true
},
"clientSecret": {
"description": "Service Client Secret",
"type": "string",
"nullable": true
},
"invitedOnly": {
"description": "Only accept individuals with invitations",
"type": "boolean",
"nullable": true
}
}
},
"DomainAuthProviderRequest": {
"description": "",
"required": [
"providerType",
"enabled"
],
"type": "object",
"properties": {
"providerType": {
"description": "Provider Type",
"type": "string"
},
"enabled": {
"description": "Enabled/Disabled",
"type": "boolean"
},
"label": {
"description": "Login Button Text",
"type": "string",
"nullable": true
},
"config": {
"description": "Optional configuration",
"$ref": "#/components/schemas/OpenIDConfig",
"nullable": true
}
}
},
"DomainAuthProviderResponse": {
"description": "",
"required": [
"identifier",
"providerType",
"label",
"default",
"enabled",
"createdAt",
"updatedAt"
],
"type": "object",
"properties": {
"identifier": {
"description": "Provider ID",
"type": "string"
},
"id": {
"description": "Provider ID for backward compatibility with frontend",
"type": "string",
"nullable": true
},
"providerType": {
"description": "Provider Type",
"type": "string"
},
"provider": {
"description": "Provider Type for backward compatibility with frontend",
"type": "string",
"nullable": true
},
"label": {
"description": "Login Button Text",
"type": "string"
},
"name": {
"description": "Title Text for the Frontend's Provider Configuration Form",
"type": "string",
"nullable": true
},
"authorizationUrl": {
"description": "Coordinator endpoint for Authorizing with this provider",
"type": "string",
"nullable": true
},
"default": {
"description": "True: Configured in coordinator.json, False: Custom Domain Provider",
"type": "boolean"
},
"enabled": {
"description": "Enabled/Disabled",
"type": "boolean"
},
"config": {
"description": "Optional configuration",
"nullable": true,
"$ref": "#/components/schemas/OpenIDConfig"
},
"createdBy": {
"description": "Optional User ID of creator",
"nullable": true,
"type": "string"
},
"createdAt": {
"description": "Created Date in ISO-8601 format e.g. 2022-05-06T02:39:23.000Z",
"type": "string"
},
"updatedAt": {
"description": "Updated Date in ISO-8601 format e.g. 2022-05-06T02:39:23.000Z",
"type": "string"
}
}
},
"Extension": {
"description": "",
"type": "object",
"properties": {
"identifier": {
"description": "Identifier",
"type": "string",
"nullable": true
},
"enabled": {
"description": "If true, instances requiring this extension can be created or started",
"type": "boolean",
"nullable": true
},
"createdAt": {
"description": "Created Date in ISO-8601 format e.g. 2022-05-06T02:39:23.000Z",
"type": "string",
"nullable": true
},
"updatedAt": {
"description": "Updated Date in ISO-8601 format e.g. 2022-05-06T02:39:23.000Z",
"type": "string",
"nullable": true
},
"imageId": {
"description": "Image Id",
"type": "string",
"format": "uuid",
"nullable": true
},
"state": {
"description": "State",
"type": "string",
"nullable": true
},
"flavors": {
"description": "Array of Flavor definitions",
"type": "array",
"items": {
"type": "object"
},
"nullable": true
}
}
},
"UpdateExtension": {
"description": "",
"type": "object",
"properties": {
"enabled": {
"description": "If true, instances requiring this extension can be created or started",
"type": "boolean",
"nullable": true
}
}
},
"V1LoadExtensionParameters": {
"description": "",
"required": [
"imageId"
],
"type": "object",
"properties": {
"imageId": {
"description": "The uuid of the image to load",
"type": "string",
"format": "uuid"
}
}
},
"Hook": {
"description": "",
"type": "object",
"properties": {
"identifier": {
"description": "Identifier",
"type": "string",
"format": "uuid",
"nullable": true
},
"label": {
"description": "Label",
"type": "string",
"nullable": true
},
"address": {
"description": "Address",
"type": "string",
"nullable": true
},
"patch": {
"description": "Patch",
"type": "string",
"nullable": true
},
"patchType": {
"description": "Patch Type",
"type": "string",
"enum": [
"csmfcc",
"csmfvm"
],
"nullable": true
},
"enabled": {
"description": "If true, instances can call required hooks",
"type": "boolean",
"nullable": true
},
"createdAt": {
"description": "Created Date in ISO-8601 format e.g. 2022-05-06T02:39:23.000Z",
"type": "string",
"nullable": true
},
"updatedAt": {
"description": "Updated Date in ISO-8601 format e.g. 2022-05-06T02:39:23.000Z",
"type": "string",
"nullable": true
},
"instanceId": {
"description": "Instance Id",
"type": "string",
"format": "uuid",
"nullable": true
}
}
},
"V1CreateHookParameters": {
"description": "",
"required": [
"label",
"address",
"patch",
"patchType"
],
"type": "object",
"properties": {
"label": {
"description": "Label",
"type": "string"
},
"address": {
"description": "Address",
"type": "string"
},
"patch": {
"description": "Patch",
"type": "string"
},
"patchType": {
"description": "Patch Type",
"type": "string",
"enum": [
"csmfcc",
"csmfvm"
]
}
}
},
"Image": {
"description": "",
"required": [
"status"
],
"type": "object",
"properties": {
"status": {
"description": "",
"type": "string"
},
"id": {
"description": "Image ID",
"type": "string",
"format": "uuid",
"nullable": true
},
"name": {
"description": "",
"type": "string",
"nullable": true
},
"type": {
"description": "Type of image",
"type": "string",
"enum": [
"fwbinary",
"kernel",
"devicetree",
"ramdisk",
"loaderfile",
"sepfw",
"seprom",
"bootrom",
"llb",
"iboot",
"ibootdata",
"fwpackage",
"partition",
"backup"
],
"nullable": true
},
"filename": {
"description": "",
"type": "string",
"nullable": true
},
"uniqueid": {
"description": "",
"type": "string",
"nullable": true
},
"size": {
"description": "",
"type": "number",
"nullable": true
},
"project": {
"description": "project ID",
"type": "string",
"format": "uuid",
"nullable": true
},
"created_at": {
"description": "When Image was created",
"type": "string",
"format": "date-time",
"nullable": true
},
"updated_at": {
"description": "When Image was last updated",
"type": "string",
"format": "date-time",
"nullable": true
}
}
},
"ImageCreationOptions": {
"description": "",
"required": [
"type",
"encoding"
],
"type": "object",
"properties": {
"type": {
"description": "Image type",
"type": "string"
},
"encoding": {
"description": "How the file is stored",
"type": "string",
"enum": [
"plain"
]
},
"encapsulated": {
"description": "set to false if the uploaded file is not encapsulated inside an outer zipfile",
"type": "boolean",
"nullable": true
},
"name": {
"description": "Image name",
"type": "string",
"nullable": true
},
"project": {
"description": "Project ID",
"type": "string",
"format": "uuid",
"nullable": true
},
"instance": {
"description": "Instance ID",
"type": "string",
"format": "uuid",
"nullable": true
},
"file": {
"description": "Optionally the actual file",
"type": "string",
"format": "binary",
"nullable": true
}
}
},
"UserError": {
"description": "",
"required": [
"error",
"errorID"
],
"type": "object",
"properties": {
"error": {
"description": "Error text",
"type": "string"
},
"errorID": {
"description": "Error ID",
"type": "string",
"enum": [
"UserError"
]
},
"field": {
"description": "Field associated with error",
"type": "string",
"nullable": true
}
}
},
"ValidationError": {
"description": "",
"required": [
"error",
"errorID"
],
"type": "object",
"properties": {
"error": {
"description": "Error text",
"type": "string"
},
"errorID": {
"description": "Error ID",
"type": "string",
"enum": [
"ValidationError"
]
},
"field": {
"description": "Field associated with error",
"type": "string",
"nullable": true
}
}
},
"ApiInternalConsistencyError": {
"description": "",
"required": [
"error",
"errorID"
],
"type": "object",
"properties": {
"error": {
"description": "Error text",
"type": "string"
},
"errorID": {
"description": "Error ID",
"type": "string"
},
"originalError": {
"description": "Upstream error description",
"type": "string",
"nullable": true
}
}
},
"ApiError": {
"description": "",
"required": [
"error",
"errorID"
],
"type": "object",
"properties": {
"error": {
"description": "Error text",
"type": "string"
},
"errorID": {
"description": "Error ID",
"type": "string"
},
"originalError": {
"description": "Upstream error description",
"type": "string",
"nullable": true
}
}
},
"ApiConflictError": {
"description": "",
"required": [
"error",
"errorID"
],
"type": "object",
"properties": {
"error": {
"description": "Error text",
"type": "string"
},
"errorID": {
"description": "Error ID",
"type": "string",
"enum": [
"Conflict"
]
},
"object": {
"description": "Object that is conflicted with",
"type": "object",
"nullable": true
}
}
},
"ApiNotFoundError": {
"description": "",
"required": [
"error",
"errorID"
],
"type": "object",
"properties": {
"error": {
"description": "Error text",
"type": "string"
},
"errorID": {
"description": "Error ID",
"type": "string"
},
"name": {
"description": "Name of the object requested",
"type": "string",
"nullable": true
},
"params": {
"description": "params provided by user",
"type": "object",
"nullable": true
}
}
},
"File": {
"description": "A File",
"type": "string",
"format": "binary"
},
"PasswordChangeBody": {
"description": "",
"required": [
"user",
"old-password",
"new-password"
],
"type": "object",
"properties": {
"user": {
"description": "userId",
"type": "string",
"format": "uuid"
},
"old-password": {
"description": "old password",
"type": "string"
},
"new-password": {
"description": "new password",
"type": "string"
}
}
},
"InstanceBootOptionsAdditionalTag": {
"description": "### Instance Boot Option\n* kalloc: Enable kalloc/kfree trace access via GDB (Enterprise only)\n* gpu: Enable cloud GPU acceleration (Extra costs incurred, cloud only)\n* no-keyboard: Enable keyboard passthrough from web interface\n* nodevmode: Disable developer mode on iOS16 and greater\n* sep-cons-ext: Patch SEPOS to print debug messages to console\n* iboot-jailbreak: Patch iBoot to disable signature checks\n* llb-jailbreak: Patch LLB to disable signature checks\n* rom-jailbreak: Patch BootROM to disable signature checks",
"type": "string",
"enum": [
"kalloc",
"gpu",
"no-keyboard",
"nodevmode",
"sep-cons-ext",
"iboot-jailbreak",
"llb-jailbreak",
"rom-jailbreak"
]
},
"InstanceBootOptions": {
"description": "",
"type": "object",
"properties": {
"bootArgs": {
"description": "",
"type": "string",
"nullable": true
},
"restoreBootArgs": {
"description": "",
"type": "string",
"nullable": true
},
"udid": {
"description": "Boot udid",
"type": "string",
"format": "uuid",
"nullable": true
},
"ecid": {
"description": "Assigned ECID",
"type": "string",
"format": "hex",
"nullable": true
},
"randomSeed": {
"description": "Random seed to provide to boot if any",
"type": "string",
"nullable": true
},
"pac": {
"description": "Enable PAC",
"type": "boolean",
"nullable": true
},
"aprr": {
"description": "Enable APRR",
"type": "boolean",
"nullable": true
},
"additionalTags": {
"description": "",
"type": "array",
"items": {
"$ref": "#/components/schemas/InstanceBootOptionsAdditionalTag"
},
"nullable": true
}
}
},
"InstanceState": {
"description": "Current Instance State",
"type": "string",
"enum": [
"on",
"off",
"booting",
"deleting",
"creating",
"restoring",
"paused",
"rebooting",
"error"
]
},
"VpnDefinition": {
"description": "",
"type": "object",
"properties": {
"proxy": {
"description": "",
"type": "array",
"items": {
"type": "object"
},
"nullable": true
},
"listeners": {
"description": "",
"type": "array",
"items": {
"type": "object"
},
"nullable": true
}
}
},
"InstanceServices": {
"description": "",
"type": "object",
"properties": {
"vpn": {
"description": "",
"$ref": "#/components/schemas/VpnDefinition",
"nullable": true
}
}
},
"InstanceAgentState": {
"nullable": true,
"type": "object",
"description": "",
"properties": {
"hash": {
"description": "",
"type": "string",
"nullable": true
},
"info": {
"description": "",
"type": "string",
"nullable": true
}
}
},
"InstanceNetmonState": {
"description": "",
"type": "object",
"properties": {
"hash": {
"description": "",
"type": "string",
"nullable": true
},
"info": {
"description": "",
"type": "string",
"nullable": true
},
"enabled": {
"description": "",
"type": "boolean",
"nullable": true
}
}
},
"InstanceNetdumpState": {
"description": "",
"type": "object",
"properties": {
"hash": {
"description": "",
"type": "string",
"nullable": true
},
"info": {
"description": "",
"type": "string",
"nullable": true
},
"enabled": {
"description": "",
"type": "boolean",
"nullable": true
}
}
},
"Instance": {
"description": "",
"type": "object",
"properties": {
"id": {
"description": "Instance Identifier",
"type": "string",
"format": "uuid",
"nullable": true
},
"name": {
"description": "Instance Name",
"type": "string",
"nullable": true
},
"key": {
"description": "Key used to encrypt the Instance",
"type": "string",
"format": "hex",
"nullable": true
},
"flavor": {
"description": "The type of virtual machine this is",
"type": "string",
"nullable": true
},
"type": {
"description": "",
"type": "string",
"nullable": true
},
"project": {
"description": "The projectId of the project this instance belongs to",
"type": "string",
"format": "uuid",
"nullable": true
},
"state": {
"description": "Current state of the instance",
"$ref": "#/components/schemas/InstanceState",
"nullable": true
},
"stateChanged": {
"description": "Time the state of the instance last changed",
"type": "string",
"format": "date-time",
"nullable": true
},
"startedAt": {
"description": "Time the instance was started",
"nullable": true,
"type": "string",
"format": "date-time, NULL if currently SHUTOFF"
},
"userTask": {
"description": "Currently executing User Task",
"type": "string",
"nullable": true
},
"taskState": {
"description": "Current task state if any",
"type": "string",
"nullable": true
},
"error": {
"description": "Current error state if any",
"type": "string",
"nullable": true
},
"bootOptions": {
"description": "Instance boot options",
"$ref": "#/components/schemas/InstanceBootOptions",
"nullable": true
},
"serviceIp": {
"description": "Services IP Address",
"type": "string",
"format": "ipv4",
"nullable": true
},
"wifiIp": {
"description": "LAN IP Address",
"type": "string",
"format": "ipv4",
"nullable": true
},
"secondaryIp": {
"description": "Secondary Inteface LAN IP Address (if supported)",
"type": "string",
"format": "ipv4",
"nullable": true
},
"services": {
"description": "",
"$ref": "#/components/schemas/InstanceServices",
"nullable": true
},
"panicked": {
"description": "",
"type": "boolean",
"nullable": true
},
"created": {
"description": "Time instance was created",
"type": "string",
"format": "date-time",
"nullable": true
},
"model": {
"description": "Model of virtual machine device",
"type": "string",
"nullable": true
},
"fwpackage": {
"description": "URL that package used to create this instance is available at",
"type": "string",
"format": "url",
"nullable": true
},
"os": {
"description": "",
"type": "string",
"nullable": true
},
"agent": {
"description": "",
"$ref": "#/components/schemas/InstanceAgentState",
"nullable": true
},
"netmon": {
"description": "",
"$ref": "#/components/schemas/InstanceNetmonState",
"nullable": true
},
"netdump": {
"description": "",
"$ref": "#/components/schemas/InstanceNetdumpState",
"nullable": true
},
"exposePort": {
"description": "",
"type": "string",
"nullable": true
},
"fault": {
"description": "",
"type": "boolean",
"nullable": true
},
"patches": {
"description": "",
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"createdBy": {
"description": "",
"nullable": true,
"$ref": "#/components/schemas/createdBy"
}
}
},
"createdBy": {
"description": "",
"type": "object",
"properties": {
"id": {
"description": "User Identifier",
"type": "string",
"format": "uuid",
"nullable": true
},
"username": {
"description": "Username",
"type": "string",
"nullable": true
},
"label": {
"description": "User Label",
"type": "string",
"nullable": true
},
"deleted": {
"description": "Indicates if user was deleted",
"type": "boolean",
"nullable": true
}
}
},
"VolumeOptions": {
"description": "",
"type": "object",
"properties": {
"allocate": {
"description": "GB",
"type": "number",
"nullable": true
},
"partitions": {
"description": "",
"type": "array",
"items": {
"type": "object"
},
"nullable": true
},
"computeNode": {
"description": "",
"type": "string",
"nullable": true
}
}
},
"InstanceCreateOptions": {
"description": "",
"required": [
"flavor",
"project",
"os"
],
"type": "object",
"properties": {
"name": {
"description": "the name of the device",
"type": "string",
"nullable": true
},
"key": {
"description": "Key used to encrypt the Instance",
"type": "string",
"format": "hex",
"nullable": true
},
"flavor": {
"description": "the flavor id",
"type": "string"
},
"project": {
"description": "project UUID",
"type": "string"
},
"os": {
"description": "OS Version",
"type": "string"
},
"osbuild": {
"description": "OS Build",
"type": "string",
"nullable": true
},
"patches": {
"description": "list of patches to apply",
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"fwpackage": {
"description": "URL or image id",
"type": "string",
"nullable": true
},
"origFwPackageUrl": {
"description": "URL that firmware package used to create this instance is available at",
"type": "string",
"format": "url",
"nullable": true
},
"encrypt": {
"description": "",
"type": "boolean",
"nullable": true
},
"overrideWifiMAC": {
"description": "",
"type": "string",
"nullable": true
},
"volume": {
"description": "",
"$ref": "#/components/schemas/VolumeOptions",
"nullable": true
},
"snapshot": {
"description": "Snapshot ID for this instance to be cloned from if defined",
"type": "string",
"format": "uuid",
"nullable": true
},
"bootOptions": {
"description": "Instance boot options",
"$ref": "#/components/schemas/InstanceBootOptions",
"nullable": true
},
"device": {
"description": "",
"$ref": "#/components/schemas/Model",
"nullable": true
}
}
},
"InstanceReturn": {
"description": "",
"required": [
"id",
"state"
],
"type": "object",
"properties": {
"id": {
"description": "Instance ID",
"type": "string",
"format": "uuid"
},
"state": {
"description": "Instance state (creating)",
"$ref": "#/components/schemas/InstanceState"
}
}
},
"PatchInstanceOptions": {
"description": "",
"type": "object",
"properties": {
"name": {
"description": "the name of the device",
"type": "string",
"nullable": true
},
"state": {
"description": "the desired state of the device",
"type": "string",
"enum": [
"on",
"off",
"paused",
"deleting"
],
"nullable": true
},
"bootOptions": {
"description": "the desired Boot Options",
"$ref": "#/components/schemas/InstanceBootOptions",
"nullable": true
},
"proxy": {
"description": "",
"type": "Array",
"items": {
"$ref": "#/components/schemas/ProxyConfig"
},
"nullable": true
}
}
},
"ProxyConfig": {
"description": "Represents a Proxy configuration object.",
"type": "object",
"properties": {
"devicePort": {
"description": "The device port to use for proxying.",
"type": "number",
"nullable": true
},
"firstAvailable": {
"description": "If `true`, the first available port will be used if `devicePort` is not available.",
"type": "boolean",
"nullable": true
},
"expose": {
"description": "If `true`, the proxy will be exposed to the external interface.",
"type": "boolean",
"nullable": true
},
"routerPort": {
"description": "The router port to use for proxying.",
"type": "number",
"nullable": true
}
}
},
"AgentError": {
"description": "",
"required": [
"error",
"errorID"
],
"type": "object",
"properties": {
"error": {
"description": "The error encountered by the agent",
"type": "string"
},
"errorID": {
"description": "AgentError",
"type": "string",
"enum": [
"AgentError"
]
},
"originalError": {
"description": "The full error encountered by the agent",
"type": "object",
"nullable": true
}
}
},
"AgentAppReadyResponse": {
"description": "",
"required": [
"ready"
],
"type": "object",
"properties": {
"ready": {
"description": "",
"type": "boolean"
}
}
},
"AgentInstallBody": {
"description": "",
"type": "object",
"properties": {
"path": {
"description": "path to app to install",
"type": "string",
"nullable": true
}
}
},
"AgentApp": {
"description": "",
"type": "object",
"properties": {
"tags": {
"description": "",
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"running": {
"description": "",
"type": "boolean",
"nullable": true
},
"diskUsage": {
"description": "",
"type": "integer",
"nullable": true
},
"Date": {
"description": "",
"type": "integer",
"nullable": true
},
"applicationType": {
"description": "",
"type": "string",
"nullable": true
},
"name": {
"description": "",
"type": "string",
"nullable": true
},
"bundleID": {
"description": "",
"type": "string",
"nullable": true
}
}
},
"AgentAppsList": {
"description": "",
"type": "object",
"properties": {
"apps": {
"description": "",
"type": "array",
"items": {
"$ref": "#/components/schemas/AgentApp"
},
"nullable": true
},
"frontmost": {
"description": "bundleID of frontmost app or empty string if none are frontmost",
"type": "string",
"nullable": true
}
}
},
"AgentAppStatus": {
"description": "",
"type": "object",
"properties": {
"running": {
"description": "",
"type": "boolean",
"nullable": true
},
"bundleID": {
"description": "",
"type": "string",
"nullable": true
}
}
},
"AgentAppsStatusList": {
"description": "",
"type": "object",
"properties": {
"apps": {
"description": "",
"type": "array",
"items": {
"$ref": "#/components/schemas/AgentAppStatus"
},
"nullable": true
},
"frontmost": {
"description": "bundleID of frontmost app or empty string if none are frontmost",
"type": "string",
"nullable": true
}
}
},
"AgentIcons": {
"description": "",
"type": "object",
"properties": {
"icon": {
"description": "The data for an icon",
"type": "string",
"format": "byte",
"nullable": true
}
}
},
"FileChanges": {
"description": "",
"type": "object",
"properties": {
"path": {
"description": "Optional New path",
"type": "string",
"nullable": true
},
"mode": {
"description": "Optional New Mode",
"type": "number",
"nullable": true
},
"uid": {
"description": "Optional New Owner UID",
"type": "number",
"nullable": true
},
"gid": {
"description": "Optional New Group GID",
"type": "number",
"nullable": true
}
}
},
"AgentProfilesReturn": {
"description": "",
"required": [
"profiles"
],
"type": "object",
"properties": {
"profiles": {
"description": "",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"AgentSystemSetHostnameBody": {
"description": "",
"required": [
"hostname"
],
"type": "object",
"properties": {
"hostname": {
"description": "",
"type": "string"
}
}
},
"AgentValueReturn": {
"description": "",
"type": "object",
"properties": {
"value": {
"description": "The requested value",
"type": "string",
"nullable": true
}
}
},
"AgentSystemGetPropBody": {
"description": "",
"required": [
"property"
],
"type": "object",
"properties": {
"property": {
"description": "",
"type": "string"
}
}
},
"AgentSystemAdbAuth": {
"description": "",
"type": "object",
"properties": {
"enabled": {
"description": "",
"type": "boolean",
"nullable": true
}
}
},
"InstanceConsoleEndpoint": {
"description": "",
"type": "object",
"properties": {
"url": {
"description": "Console Websocket URL",
"type": "string",
"format": "url",
"nullable": true
}
}
},
"InstanceStartOptions": {
"description": "",
"type": "object",
"properties": {
"paused": {
"description": "Start device paused",
"type": "boolean",
"nullable": true
},
"sockcap": {
"description": "Start device with Process Network Monitoring enabled",
"type": "boolean",
"nullable": true
}
}
},
"InstanceStopOptions": {
"description": "",
"type": "object",
"properties": {
"soft": {
"description": "Request VM OS power down",
"type": "boolean",
"nullable": true
}
}
},
"V1SetStateBody": {
"description": "",
"required": [
"state"
],
"type": "object",
"properties": {
"state": {
"description": "",
"$ref": "#/components/schemas/InstanceState"
}
}
},
"RateInfo": {
"description": "",
"type": "object",
"properties": {
"onRateMicrocents": {
"description": "The amount per second, in microcents (USD), that this instance charges to be running.",
"type": "integer",
"nullable": true
},
"offRateMicrocents": {
"description": "The amount per second, in microcents (USD), that this instance charges to be stored.",
"type": "integer",
"nullable": true
}
}
},
"Bit": {
"description": "Bit value",
"type": "number",
"enum": [
"0",
"1"
]
},
"GpioStateDefinition": {
"description": "",
"required": [
"bitCount",
"banks"
],
"type": "object",
"properties": {
"bitCount": {
"description": "count of bits in members of this bank",
"type": "number"
},
"banks": {
"description": "bits for each bank of this name as an array of arrays",
"type": "array",
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Bit"
}
}
}
}
},
"GpiosState": {
"description": "Current state of GPIOs",
"type": "object",
"properties": {
"led": {
"description": "",
"$ref": "#/components/schemas/GpioStateDefinition",
"nullable": true
},
"button": {
"description": "",
"$ref": "#/components/schemas/GpioStateDefinition",
"nullable": true
},
"switch": {
"description": "",
"$ref": "#/components/schemas/GpioStateDefinition",
"nullable": true
}
}
},
"PeripheralsData": {
"description": "",
"type": "object",
"properties": {
"acceleration": {
"description": "",
"type": "array",
"items": {
"type": "number"
},
"nullable": true
},
"gyroscope": {
"description": "",
"type": "array",
"items": {
"type": "number"
},
"nullable": true
},
"magnetic": {
"description": "",
"type": "array",
"items": {
"type": "number"
},
"nullable": true
},
"orientation": {
"description": "",
"type": "array",
"items": {
"type": "number"
},
"nullable": true
},
"temperature": {
"description": "",
"type": "number",
"nullable": true
},
"proximity": {
"description": "",
"type": "number",
"nullable": true
},
"light": {
"description": "",
"type": "number",
"nullable": true
},
"pressure": {
"description": "",
"type": "number",
"nullable": true
},
"humidity": {
"description": "",
"type": "number",
"nullable": true
}
}
},
"RestoreBackupData": {
"description": "",
"type": "object",
"properties": {}
},
"Screenshot": {
"description": "Screenshot Data",
"type": "string",
"format": "binary"
},
"RotateBody": {
"description": "",
"required": [
"orientation"
],
"type": "object",
"properties": {
"orientation": {
"description": "Desired orientation",
"type": "number",
"enum": [
"1",
"2",
"3",
"4"
]
}
}
},
"Button": {
"description": "Button definition",
"type": "string",
"enum": [
"finger",
"homeButton",
"holdButton",
"volumeUp",
"volumeDown",
"ringerSwitch",
"backButton",
"overviewButton"
]
},
"TouchInput": {
"description": "",
"type": "object",
"properties": {
"position": {
"description": "array of per-finger [x,y] touch positions, up to 10 depending on model",
"$ref": "#/components/schemas/FingerPositions",
"nullable": true
}
}
},
"TouchCurveInput": {
"description": "",
"type": "object",
"properties": {
"start": {
"description": "array of per-finger [x,y] start touch positions, up to 10 depending on model",
"$ref": "#/components/schemas/FingerPositions",
"nullable": true
},
"end": {
"description": "array of per-finger [x,y] end touch positions, up to 10 depending on model",
"$ref": "#/components/schemas/FingerPositions",
"nullable": true
}
}
},
"TextInput": {
"description": "",
"type": "object",
"properties": {
"text": {
"description": "text to type",
"type": "string",
"nullable": true
}
}
},
"InstanceInput": {
"oneOf": [
{
"$ref": "#/components/schemas/TouchInput"
},
{
"$ref": "#/components/schemas/TouchCurveInput"
},
{
"$ref": "#/components/schemas/TextInput"
}
],
"description": "",
"type": "object",
"properties": {}
},
"MediaPlayBody": {
"description": "",
"type": "object",
"properties": {
"imageId": {
"description": "Image ID",
"type": "string",
"format": "uuid",
"nullable": true
},
"url": {
"description": "URL to a media file",
"type": "string",
"format": "string",
"nullable": true
}
}
},
"KernelThread": {
"description": "",
"type": "object",
"properties": {
"kernelId": {
"description": "Kernel Thread ID",
"type": "string",
"format": "uint64_t",
"nullable": true
},
"tid": {
"description": "Task ID",
"type": "integer",
"nullable": true
},
"stack": {
"description": "Array of stack addresses",
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
}
},
"KernelTask": {
"description": "",
"type": "object",
"properties": {
"kernelId": {
"description": "Kernel Task ID",
"type": "string",
"format": "uint64_t",
"nullable": true
},
"name": {
"description": "Thread name",
"type": "string",
"nullable": true
},
"pid": {
"description": "Process ID of task",
"type": "integer",
"nullable": true
},
"threads": {
"description": "",
"type": "array",
"items": {
"$ref": "#/components/schemas/KernelThread"
},
"nullable": true
}
}
},
"Kcrange": {
"description": "",
"type": "object",
"properties": {
"kext": {
"description": "Kernel Extension",
"type": "string",
"nullable": true
},
"range": {
"description": "Range",
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
}
},
"BtraceEnableOptions": {
"description": "",
"type": "object",
"properties": {
"ranges": {
"description": "",
"type": "array",
"items": {
"type": "array",
"items": {
"type": "string"
}
},
"nullable": true
}
}
},
"NetdumpFilter": {
"description": "",
"type": "object",
"properties": {
"portRanges": {
"description": "",
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"srcPorts": {
"description": "",
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"dstPorts": {
"description": "",
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"ports": {
"description": "",
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"protocols": {
"description": "",
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"processes": {
"description": "",
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
}
},
"InstanceUpgradeBody": {
"description": "",
"required": [
"os"
],
"type": "object",
"properties": {
"os": {
"description": "iOS version",
"type": "string"
},
"osbuild": {
"description": "(optional) iOS build ID",
"type": "string",
"nullable": true
}
}
},
"Invitation": {
"description": "",
"type": "object",
"properties": {
"identifier": {
"description": "Invite ID",
"type": "string",
"format": "uuid",
"nullable": true
},
"email": {
"description": "Invited email",
"type": "string",
"nullable": true
},
"settings": {
"description": "",
"type": "object",
"nullable": true
}
}
},
"InviteRevokeParams": {
"description": "",
"type": "object",
"properties": {
"ids": {
"description": "id or array of ids to revoke",
"oneOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
],
"nullable": true
}
}
},
"Model": {
"description": "",
"required": [
"type",
"name",
"flavor",
"model"
],
"type": "object",
"properties": {
"type": {
"description": "",
"type": "string"
},
"name": {
"description": "",
"type": "string"
},
"flavor": {
"description": "",
"type": "string"
},
"description": {
"description": "",
"type": "string",
"nullable": true
},
"model": {
"description": "",
"type": "string"
},
"boardConfig": {
"description": "",
"type": "string",
"nullable": true
},
"platform": {
"description": "",
"type": "string",
"nullable": true
},
"cpid": {
"description": "",
"type": "number",
"nullable": true
},
"bdid": {
"description": "",
"type": "number",
"nullable": true
},
"peripherals": {
"description": "",
"type": "boolean",
"nullable": true
}
}
},
"Firmware": {
"description": "",
"type": "object",
"properties": {
"version": {
"description": "",
"type": "string",
"nullable": true
},
"buildid": {
"description": "",
"type": "string",
"nullable": true
},
"AndroidFlavor": {
"description": "Android only flavor",
"type": "string",
"nullable": true
},
"APIVersion": {
"description": "Android only API version",
"type": "string",
"nullable": true
},
"sha256sum": {
"description": "",
"type": "string",
"nullable": true
},
"sha1sum": {
"description": "",
"type": "string",
"nullable": true
},
"md5sum": {
"description": "",
"type": "string",
"nullable": true
},
"size": {
"description": "",
"type": "integer",
"nullable": true
},
"uniqueId": {
"description": "",
"type": "string",
"nullable": true
},
"metadata": {
"description": "Firmware metadata",
"type": "object",
"nullable": true
},
"releasedate": {
"description": "Release Date",
"type": "string",
"format": "date-time",
"nullable": true
},
"uploaddate": {
"description": "Date uploaded",
"type": "string",
"format": "date-time",
"nullable": true
},
"url": {
"description": "URL firmware is available at",
"type": "string",
"format": "url",
"nullable": true
},
"orig_url": {
"description": "URL firmware is available at from vendor",
"type": "string",
"format": "url",
"nullable": true
},
"filename": {
"description": "",
"type": "string",
"nullable": true
}
}
},
"ModelSoftware": {
"description": "",
"type": "object",
"properties": {
"name": {
"description": "",
"type": "string",
"nullable": true
},
"boardConfig": {
"description": "",
"type": "string",
"nullable": true
},
"platform": {
"description": "",
"type": "string",
"nullable": true
},
"cpid": {
"description": "",
"type": "number",
"nullable": true
},
"bdid": {
"description": "",
"type": "number",
"nullable": true
},
"firmwares": {
"description": "",
"type": "array",
"items": {
"$ref": "#/components/schemas/Firmware"
},
"nullable": true
}
}
},
"ProjectSettings": {
"description": "",
"type": "object",
"properties": {
"internet-access": {
"description": "",
"type": "boolean",
"nullable": true
},
"dhcp": {
"description": "",
"type": "boolean",
"nullable": true
}
}
},
"ProjectQuota": {
"description": "",
"type": "object",
"properties": {
"cores": {
"description": "",
"type": "number",
"nullable": true
},
"instances": {
"description": "",
"type": "number",
"nullable": true
},
"ram": {
"description": "",
"type": "number",
"nullable": true
}
}
},
"ProjectUsage": {
"description": "",
"type": "object",
"properties": {
"cores": {
"description": "",
"type": "number",
"nullable": true
},
"instances": {
"description": "",
"type": "number",
"nullable": true
},
"ram": {
"description": "",
"type": "number",
"nullable": true
},
"gpu": {
"description": "",
"type": "number",
"nullable": true
}
}
},
"Project": {
"description": "",
"required": [
"id"
],
"type": "object",
"properties": {
"id": {
"description": "Project Identifier",
"type": "string",
"format": "uuid"
},
"name": {
"description": "Project Name",
"type": "string",
"nullable": true
},
"settings": {
"description": "",
"$ref": "#/components/schemas/ProjectSettings",
"nullable": true
},
"quotas": {
"description": "",
"$ref": "#/components/schemas/ProjectQuota",
"nullable": true
},
"quotasUsed": {
"description": "",
"$ref": "#/components/schemas/ProjectUsage",
"nullable": true
}
}
},
"ProjectKey": {
"description": "",
"required": [
"kind",
"key"
],
"type": "object",
"properties": {
"identifier": {
"description": "keyId",
"type": "string",
"format": "uuid",
"nullable": true
},
"kind": {
"description": "kind of key",
"type": "string",
"enum": [
"ssh",
"adb"
]
},
"project": {
"description": "projectId",
"type": "string",
"format": "uuid",
"nullable": true
},
"key": {
"description": "The public key",
"type": "string"
},
"fingerprint": {
"description": "Key fingerprint",
"type": "string",
"nullable": true
},
"updatedAt": {
"description": "Time of last update",
"type": "string",
"format": "date-time",
"nullable": true
},
"createdAt": {
"description": "Time of creation",
"type": "string",
"format": "date-time",
"nullable": true
}
}
},
"Role": {
"description": "",
"required": [
"role",
"project",
"user"
],
"type": "object",
"properties": {
"role": {
"description": "",
"type": "string",
"enum": [
"admin",
"_member_"
]
},
"project": {
"description": "Project ID",
"type": "string",
"format": "uuid"
},
"user": {
"description": "User ID",
"type": "string",
"format": "uuid"
}
}
},
"SnapshotStatus": {
"description": "",
"type": "object",
"properties": {
"task": {
"description": "",
"type": "string",
"nullable": true
},
"created": {
"description": "",
"type": "boolean",
"nullable": true
}
}
},
"Snapshot": {
"description": "",
"type": "object",
"properties": {
"id": {
"description": "Snapshot ID",
"type": "string",
"format": "uuid",
"nullable": true
},
"name": {
"description": "Snapshot name",
"type": "string",
"nullable": true
},
"instance": {
"description": "Instance that this snapshot is of",
"type": "string",
"format": "uuid",
"nullable": true
},
"status": {
"description": "",
"$ref": "#/components/schemas/SnapshotStatus",
"nullable": true
},
"date": {
"description": "UNIX Date that the snapshot was created",
"type": "number",
"nullable": true