Skip to content
This repository has been archived by the owner on Oct 25, 2023. It is now read-only.

Latest commit

 

History

History
3794 lines (2461 loc) · 104 KB

InstancesApi.md

File metadata and controls

3794 lines (2461 loc) · 104 KB
Raw

\InstancesApi

All URIs are relative to https://app.corellium.com/api

Method HTTP request Description
V1BtracePreauthorize Get /v1/instances/{instanceId}/btrace-authorize Pre-authorize an btrace download
V1ClearCoreTrace Delete /v1/instances/{instanceId}/strace Clear CoreTrace logs
V1ClearHyperTrace Delete /v1/instances/{instanceId}/btrace Clear HyperTrace logs
V1ClearHyperTraceHooks Post /v1/instances/{instanceId}/hooks/clear Clear Hooks on an instance
V1ClearInstancePanics Delete /v1/instances/{instanceId}/panics Clear Panics
V1CreateInstance Post /v1/instances Create Instance
V1CreateSnapshot Post /v1/instances/{instanceId}/snapshots Create Instance Snapshot
V1DeleteInstance Delete /v1/instances/{instanceId} Remove Instance
V1DeleteInstanceSnapshot Delete /v1/instances/{instanceId}/snapshots/{snapshotId} Delete a Snapshot
V1DisableExposePort Post /v1/instances/{instanceId}/exposeport/disable Disable an exposed port on an instance for device access.
V1EnableExposePort Post /v1/instances/{instanceId}/exposeport/enable Enable an exposed port on an instance for device access.
V1ExecuteHyperTraceHooks Post /v1/instances/{instanceId}/hooks/execute Execute Hooks on an instance
V1GetInstance Get /v1/instances/{instanceId} Get Instance
V1GetInstanceConsole Get /v1/instances/{instanceId}/console Get console websocket URL
V1GetInstanceConsoleLog Get /v1/instances/{instanceId}/consoleLog Get Console Log
V1GetInstanceGpios Get /v1/instances/{instanceId}/gpios Get Instance GPIOs
V1GetInstancePanics Get /v1/instances/{instanceId}/panics Get Panics
V1GetInstancePeripherals Get /v1/instances/{instanceId}/peripherals Get Instance Peripherals
V1GetInstanceRate Get /v1/instances/{instanceId}/rate Get rate information
V1GetInstanceScreenshot Get /v1/instances/{instanceId}/screenshot.{format} Get Instance Screenshot
V1GetInstanceSnapshot Get /v1/instances/{instanceId}/snapshots/{snapshotId} Get Instance Snapshot
V1GetInstanceSnapshots Get /v1/instances/{instanceId}/snapshots Get Instance Snapshots
V1GetInstances Get /v1/instances Get Instances
V1InstancesInstanceIdMessagePost Post /v1/instances/{instanceId}/message Receive a message on an iOS vm
V1InstancesInstanceIdNetdumpPcapGet Get /v1/instances/{instanceId}/netdump.pcap Download a netdump pcap file
V1InstancesInstanceIdNetworkMonitorPcapGet Get /v1/instances/{instanceId}/networkMonitor.pcap Download a Network Monitor pcap file
V1Kcrange Get /v1/instances/{instanceId}/btrace-kcrange Get Kernel extension ranges
V1ListThreads Get /v1/instances/{instanceId}/strace/thread-list Get Running Threads (CoreTrace)
V1MediaPlay Post /v1/instances/{instanceId}/media/play Start playing media
V1MediaStop Post /v1/instances/{instanceId}/media/stop Stop playing media
V1PatchInstance Patch /v1/instances/{instanceId} Update Instance
V1PauseInstance Post /v1/instances/{instanceId}/pause Pause an Instance
V1PostInstanceInput Post /v1/instances/{instanceId}/input Provide Instance Input
V1RebootInstance Post /v1/instances/{instanceId}/reboot Reboot an Instance
V1RenameInstanceSnapshot Patch /v1/instances/{instanceId}/snapshots/{snapshotId} Rename a Snapshot
V1RestoreBackup Post /v1/instances/{instanceId}/restoreBackup Restore backup
V1RestoreInstanceSnapshot Post /v1/instances/{instanceId}/snapshots/{snapshotId}/restore Restore a Snapshot
V1RotateInstance Post /v1/instances/{instanceId}/rotate Rotate device to specified orientation
V1SetInstanceGpios Put /v1/instances/{instanceId}/gpios Set Instance GPIOs
V1SetInstancePeripherals Put /v1/instances/{instanceId}/peripherals Set Instance Peripherals
V1SetInstanceState Put /v1/instances/{instanceId}/state Set state of Instance
V1StartCoreTrace Post /v1/instances/{instanceId}/strace/enable Start CoreTrace on an instance
V1StartHyperTrace Post /v1/instances/{instanceId}/btrace/enable Start HyperTrace on an instance
V1StartInstance Post /v1/instances/{instanceId}/start Start an Instance
V1StartNetdump Post /v1/instances/{instanceId}/netdump/enable Start Enhanced Network Monitor on an instance.
V1StartNetworkMonitor Post /v1/instances/{instanceId}/sslsplit/enable Start Network Monitor on an instance.
V1StopCoreTrace Post /v1/instances/{instanceId}/strace/disable Stop CoreTrace on an instance.
V1StopHyperTrace Post /v1/instances/{instanceId}/btrace/disable Stop HyperTrace on an instance.
V1StopInstance Post /v1/instances/{instanceId}/stop Stop an Instance
V1StopNetdump Post /v1/instances/{instanceId}/netdump/disable Stop Enhanced Network Monitor on an instance.
V1StopNetworkMonitor Post /v1/instances/{instanceId}/sslsplit/disable Stop Network Monitor on an instance.
V1UnpauseInstance Post /v1/instances/{instanceId}/unpause Unpause an Instance
V1UpgradeInstance Post /v1/instances/{instanceId}/upgrade Upgrade iOS version
V2GetInstanceQuickConnectCommand Get /v2/instances/{instanceId}/quickConnectCommand Recommended SSH Command for Quick Connect
V2GetInstanceState Get /v2/instances/{instanceId}/state Get state of Instance

V1BtracePreauthorize

map[string]interface{} V1BtracePreauthorize(ctx, instanceId).Execute()

Pre-authorize an btrace download

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/aimoda/go-corellium-api-client"
)

func main() {
    instanceId := "instanceId_example" // string | Instance ID - uuid

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.InstancesApi.V1BtracePreauthorize(context.Background(), instanceId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `InstancesApi.V1BtracePreauthorize``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `V1BtracePreauthorize`: map[string]interface{}
    fmt.Fprintf(os.Stdout, "Response from `InstancesApi.V1BtracePreauthorize`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
instanceId string Instance ID - uuid

Other Parameters

Other parameters are passed through a pointer to a apiV1BtracePreauthorizeRequest struct via the builder pattern

Name Type Description Notes

Return type

map[string]interface{}

Authorization

BearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

V1ClearCoreTrace

V1ClearCoreTrace(ctx, instanceId).Execute()

Clear CoreTrace logs

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/aimoda/go-corellium-api-client"
)

func main() {
    instanceId := "instanceId_example" // string | Instance ID - uuid

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.InstancesApi.V1ClearCoreTrace(context.Background(), instanceId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `InstancesApi.V1ClearCoreTrace``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
instanceId string Instance ID - uuid

Other Parameters

Other parameters are passed through a pointer to a apiV1ClearCoreTraceRequest struct via the builder pattern

Name Type Description Notes

Return type

(empty response body)

Authorization

BearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

V1ClearHyperTrace

V1ClearHyperTrace(ctx, instanceId).Execute()

Clear HyperTrace logs

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/aimoda/go-corellium-api-client"
)

func main() {
    instanceId := "instanceId_example" // string | Instance ID - uuid

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.InstancesApi.V1ClearHyperTrace(context.Background(), instanceId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `InstancesApi.V1ClearHyperTrace``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
instanceId string Instance ID - uuid

Other Parameters

Other parameters are passed through a pointer to a apiV1ClearHyperTraceRequest struct via the builder pattern

Name Type Description Notes

Return type

(empty response body)

Authorization

BearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

V1ClearHyperTraceHooks

V1ClearHyperTraceHooks(ctx, instanceId).Execute()

Clear Hooks on an instance

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/aimoda/go-corellium-api-client"
)

func main() {
    instanceId := "instanceId_example" // string | Instance ID - uuid

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.InstancesApi.V1ClearHyperTraceHooks(context.Background(), instanceId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `InstancesApi.V1ClearHyperTraceHooks``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
instanceId string Instance ID - uuid

Other Parameters

Other parameters are passed through a pointer to a apiV1ClearHyperTraceHooksRequest struct via the builder pattern

Name Type Description Notes

Return type

(empty response body)

Authorization

BearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

V1ClearInstancePanics

V1ClearInstancePanics(ctx, instanceId).Execute()

Clear Panics

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/aimoda/go-corellium-api-client"
)

func main() {
    instanceId := "instanceId_example" // string | Instance ID - uuid

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.InstancesApi.V1ClearInstancePanics(context.Background(), instanceId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `InstancesApi.V1ClearInstancePanics``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
instanceId string Instance ID - uuid

Other Parameters

Other parameters are passed through a pointer to a apiV1ClearInstancePanicsRequest struct via the builder pattern

Name Type Description Notes

Return type

(empty response body)

Authorization

BearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

V1CreateInstance

InstanceReturn V1CreateInstance(ctx).InstanceCreateOptions(instanceCreateOptions).Execute()

Create Instance

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/aimoda/go-corellium-api-client"
)

func main() {
    instanceCreateOptions := *openapiclient.NewInstanceCreateOptions("Flavor_example", "Project_example", "Os_example") // InstanceCreateOptions | The vm definition to create

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.InstancesApi.V1CreateInstance(context.Background()).InstanceCreateOptions(instanceCreateOptions).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `InstancesApi.V1CreateInstance``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `V1CreateInstance`: InstanceReturn
    fmt.Fprintf(os.Stdout, "Response from `InstancesApi.V1CreateInstance`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiV1CreateInstanceRequest struct via the builder pattern

Name Type Description Notes
instanceCreateOptions InstanceCreateOptions The vm definition to create

Return type

InstanceReturn

Authorization

BearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

V1CreateSnapshot

Snapshot V1CreateSnapshot(ctx, instanceId).SnapshotCreationOptions(snapshotCreationOptions).Execute()

Create Instance Snapshot

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/aimoda/go-corellium-api-client"
)

func main() {
    instanceId := "instanceId_example" // string | Instance ID - uuid
    snapshotCreationOptions := *openapiclient.NewSnapshotCreationOptions("Name_example") // SnapshotCreationOptions | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.InstancesApi.V1CreateSnapshot(context.Background(), instanceId).SnapshotCreationOptions(snapshotCreationOptions).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `InstancesApi.V1CreateSnapshot``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `V1CreateSnapshot`: Snapshot
    fmt.Fprintf(os.Stdout, "Response from `InstancesApi.V1CreateSnapshot`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
instanceId string Instance ID - uuid

Other Parameters

Other parameters are passed through a pointer to a apiV1CreateSnapshotRequest struct via the builder pattern

Name Type Description Notes

snapshotCreationOptions | SnapshotCreationOptions | |

Return type

Snapshot

Authorization

BearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

V1DeleteInstance

V1DeleteInstance(ctx, instanceId).Execute()

Remove Instance

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/aimoda/go-corellium-api-client"
)

func main() {
    instanceId := "instanceId_example" // string | Instance ID

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.InstancesApi.V1DeleteInstance(context.Background(), instanceId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `InstancesApi.V1DeleteInstance``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
instanceId string Instance ID

Other Parameters

Other parameters are passed through a pointer to a apiV1DeleteInstanceRequest struct via the builder pattern

Name Type Description Notes

Return type

(empty response body)

Authorization

BearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

V1DeleteInstanceSnapshot

V1DeleteInstanceSnapshot(ctx, instanceId, snapshotId).Execute()

Delete a Snapshot

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/aimoda/go-corellium-api-client"
)

func main() {
    instanceId := "instanceId_example" // string | Instance ID - uuid
    snapshotId := "snapshotId_example" // string | Snapshot ID - uuid

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.InstancesApi.V1DeleteInstanceSnapshot(context.Background(), instanceId, snapshotId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `InstancesApi.V1DeleteInstanceSnapshot``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
instanceId string Instance ID - uuid
snapshotId string Snapshot ID - uuid

Other Parameters

Other parameters are passed through a pointer to a apiV1DeleteInstanceSnapshotRequest struct via the builder pattern

Name Type Description Notes

Return type

(empty response body)

Authorization

BearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

V1DisableExposePort

V1DisableExposePort(ctx, instanceId).Execute()

Disable an exposed port on an instance for device access.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/aimoda/go-corellium-api-client"
)

func main() {
    instanceId := "instanceId_example" // string | Instance ID - uuid

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.InstancesApi.V1DisableExposePort(context.Background(), instanceId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `InstancesApi.V1DisableExposePort``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
instanceId string Instance ID - uuid

Other Parameters

Other parameters are passed through a pointer to a apiV1DisableExposePortRequest struct via the builder pattern

Name Type Description Notes

Return type

(empty response body)

Authorization

BearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

V1EnableExposePort

V1EnableExposePort(ctx, instanceId).Execute()

Enable an exposed port on an instance for device access.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/aimoda/go-corellium-api-client"
)

func main() {
    instanceId := "instanceId_example" // string | Instance ID - uuid

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.InstancesApi.V1EnableExposePort(context.Background(), instanceId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `InstancesApi.V1EnableExposePort``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
instanceId string Instance ID - uuid

Other Parameters

Other parameters are passed through a pointer to a apiV1EnableExposePortRequest struct via the builder pattern

Name Type Description Notes

Return type

(empty response body)

Authorization

BearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

V1ExecuteHyperTraceHooks

V1ExecuteHyperTraceHooks(ctx, instanceId).Execute()

Execute Hooks on an instance

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/aimoda/go-corellium-api-client"
)

func main() {
    instanceId := "instanceId_example" // string | Instance ID - uuid

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.InstancesApi.V1ExecuteHyperTraceHooks(context.Background(), instanceId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `InstancesApi.V1ExecuteHyperTraceHooks``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
instanceId string Instance ID - uuid

Other Parameters

Other parameters are passed through a pointer to a apiV1ExecuteHyperTraceHooksRequest struct via the builder pattern

Name Type Description Notes

Return type

(empty response body)

Authorization

BearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

V1GetInstance

Instance V1GetInstance(ctx, instanceId).ReturnAttr(returnAttr).Execute()

Get Instance

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/aimoda/go-corellium-api-client"
)

func main() {
    instanceId := "instanceId_example" // string | Instance ID
    returnAttr := []string{"Inner_example"} // []string | Attributes to include in instance return (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.InstancesApi.V1GetInstance(context.Background(), instanceId).ReturnAttr(returnAttr).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `InstancesApi.V1GetInstance``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `V1GetInstance`: Instance
    fmt.Fprintf(os.Stdout, "Response from `InstancesApi.V1GetInstance`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
instanceId string Instance ID

Other Parameters

Other parameters are passed through a pointer to a apiV1GetInstanceRequest struct via the builder pattern

Name Type Description Notes

returnAttr | []string | Attributes to include in instance return |

Return type

Instance

Authorization

BearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

V1GetInstanceConsole

InstanceConsoleEndpoint V1GetInstanceConsole(ctx, instanceId).Execute()

Get console websocket URL

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/aimoda/go-corellium-api-client"
)

func main() {
    instanceId := "instanceId_example" // string | Instance ID - uuid

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.InstancesApi.V1GetInstanceConsole(context.Background(), instanceId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `InstancesApi.V1GetInstanceConsole``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `V1GetInstanceConsole`: InstanceConsoleEndpoint
    fmt.Fprintf(os.Stdout, "Response from `InstancesApi.V1GetInstanceConsole`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
instanceId string Instance ID - uuid

Other Parameters

Other parameters are passed through a pointer to a apiV1GetInstanceConsoleRequest struct via the builder pattern

Name Type Description Notes

Return type

InstanceConsoleEndpoint

Authorization

BearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

V1GetInstanceConsoleLog

string V1GetInstanceConsoleLog(ctx, instanceId).Execute()

Get Console Log

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/aimoda/go-corellium-api-client"
)

func main() {
    instanceId := "instanceId_example" // string | Instance ID - uuid

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.InstancesApi.V1GetInstanceConsoleLog(context.Background(), instanceId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `InstancesApi.V1GetInstanceConsoleLog``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `V1GetInstanceConsoleLog`: string
    fmt.Fprintf(os.Stdout, "Response from `InstancesApi.V1GetInstanceConsoleLog`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
instanceId string Instance ID - uuid

Other Parameters

Other parameters are passed through a pointer to a apiV1GetInstanceConsoleLogRequest struct via the builder pattern

Name Type Description Notes

Return type

string

Authorization

BearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/plain, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

V1GetInstanceGpios

GpiosState V1GetInstanceGpios(ctx, instanceId).Execute()

Get Instance GPIOs

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/aimoda/go-corellium-api-client"
)

func main() {
    instanceId := "instanceId_example" // string | Instance ID - uuid

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.InstancesApi.V1GetInstanceGpios(context.Background(), instanceId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `InstancesApi.V1GetInstanceGpios``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `V1GetInstanceGpios`: GpiosState
    fmt.Fprintf(os.Stdout, "Response from `InstancesApi.V1GetInstanceGpios`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
instanceId string Instance ID - uuid

Other Parameters

Other parameters are passed through a pointer to a apiV1GetInstanceGpiosRequest struct via the builder pattern

Name Type Description Notes

Return type

GpiosState

Authorization

BearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

V1GetInstancePanics

[]map[string]interface{} V1GetInstancePanics(ctx, instanceId).Execute()

Get Panics

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/aimoda/go-corellium-api-client"
)

func main() {
    instanceId := "instanceId_example" // string | Instance ID - uuid

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.InstancesApi.V1GetInstancePanics(context.Background(), instanceId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `InstancesApi.V1GetInstancePanics``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `V1GetInstancePanics`: []map[string]interface{}
    fmt.Fprintf(os.Stdout, "Response from `InstancesApi.V1GetInstancePanics`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
instanceId string Instance ID - uuid

Other Parameters

Other parameters are passed through a pointer to a apiV1GetInstancePanicsRequest struct via the builder pattern

Name Type Description Notes

Return type

[]map[string]interface{}

Authorization

BearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

V1GetInstancePeripherals

PeripheralsData V1GetInstancePeripherals(ctx, instanceId).Execute()

Get Instance Peripherals

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/aimoda/go-corellium-api-client"
)

func main() {
    instanceId := "instanceId_example" // string | Instance ID - uuid

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.InstancesApi.V1GetInstancePeripherals(context.Background(), instanceId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `InstancesApi.V1GetInstancePeripherals``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `V1GetInstancePeripherals`: PeripheralsData
    fmt.Fprintf(os.Stdout, "Response from `InstancesApi.V1GetInstancePeripherals`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
instanceId string Instance ID - uuid

Other Parameters

Other parameters are passed through a pointer to a apiV1GetInstancePeripheralsRequest struct via the builder pattern

Name Type Description Notes

Return type

PeripheralsData

Authorization

BearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

V1GetInstanceRate

RateInfo V1GetInstanceRate(ctx, instanceId).Execute()

Get rate information

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/aimoda/go-corellium-api-client"
)

func main() {
    instanceId := "instanceId_example" // string | Instance ID - uuid

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.InstancesApi.V1GetInstanceRate(context.Background(), instanceId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `InstancesApi.V1GetInstanceRate``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `V1GetInstanceRate`: RateInfo
    fmt.Fprintf(os.Stdout, "Response from `InstancesApi.V1GetInstanceRate`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
instanceId string Instance ID - uuid

Other Parameters

Other parameters are passed through a pointer to a apiV1GetInstanceRateRequest struct via the builder pattern

Name Type Description Notes

Return type

RateInfo

Authorization

BearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

V1GetInstanceScreenshot

*os.File V1GetInstanceScreenshot(ctx, instanceId, format).Scale(scale).Execute()

Get Instance Screenshot

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/aimoda/go-corellium-api-client"
)

func main() {
    instanceId := "instanceId_example" // string | Instance ID - uuid
    format := "format_example" // string | New peripherals state
    scale := int32(56) // int32 | Screenshot scale 1:N (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.InstancesApi.V1GetInstanceScreenshot(context.Background(), instanceId, format).Scale(scale).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `InstancesApi.V1GetInstanceScreenshot``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `V1GetInstanceScreenshot`: *os.File
    fmt.Fprintf(os.Stdout, "Response from `InstancesApi.V1GetInstanceScreenshot`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
instanceId string Instance ID - uuid
format string New peripherals state

Other Parameters

Other parameters are passed through a pointer to a apiV1GetInstanceScreenshotRequest struct via the builder pattern

Name Type Description Notes

scale | int32 | Screenshot scale 1:N |

Return type

*os.File

Authorization

BearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: image/png, image/jpeg, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

V1GetInstanceSnapshot

Snapshot V1GetInstanceSnapshot(ctx, instanceId, snapshotId).Execute()

Get Instance Snapshot

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/aimoda/go-corellium-api-client"
)

func main() {
    instanceId := "instanceId_example" // string | Instance ID - uuid
    snapshotId := "snapshotId_example" // string | Snapshot ID - uuid

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.InstancesApi.V1GetInstanceSnapshot(context.Background(), instanceId, snapshotId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `InstancesApi.V1GetInstanceSnapshot``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `V1GetInstanceSnapshot`: Snapshot
    fmt.Fprintf(os.Stdout, "Response from `InstancesApi.V1GetInstanceSnapshot`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
instanceId string Instance ID - uuid
snapshotId string Snapshot ID - uuid

Other Parameters

Other parameters are passed through a pointer to a apiV1GetInstanceSnapshotRequest struct via the builder pattern

Name Type Description Notes

Return type

Snapshot

Authorization

BearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

V1GetInstanceSnapshots

[]Snapshot V1GetInstanceSnapshots(ctx, instanceId).Execute()

Get Instance Snapshots

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/aimoda/go-corellium-api-client"
)

func main() {
    instanceId := "instanceId_example" // string | Instance ID - uuid

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.InstancesApi.V1GetInstanceSnapshots(context.Background(), instanceId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `InstancesApi.V1GetInstanceSnapshots``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `V1GetInstanceSnapshots`: []Snapshot
    fmt.Fprintf(os.Stdout, "Response from `InstancesApi.V1GetInstanceSnapshots`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
instanceId string Instance ID - uuid

Other Parameters

Other parameters are passed through a pointer to a apiV1GetInstanceSnapshotsRequest struct via the builder pattern

Name Type Description Notes

Return type

[]Snapshot

Authorization

BearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

V1GetInstances

[]Instance V1GetInstances(ctx).Name(name).ReturnAttr(returnAttr).Execute()

Get Instances

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/aimoda/go-corellium-api-client"
)

func main() {
    name := "name_example" // string | Optionally filter by instance name (optional)
    returnAttr := []string{"Inner_example"} // []string | Attributes to include in instance return (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.InstancesApi.V1GetInstances(context.Background()).Name(name).ReturnAttr(returnAttr).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `InstancesApi.V1GetInstances``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `V1GetInstances`: []Instance
    fmt.Fprintf(os.Stdout, "Response from `InstancesApi.V1GetInstances`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiV1GetInstancesRequest struct via the builder pattern

Name Type Description Notes
name string Optionally filter by instance name
returnAttr []string Attributes to include in instance return

Return type

[]Instance

Authorization

BearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

V1InstancesInstanceIdMessagePost

V1InstancesInstanceIdMessagePost(ctx, instanceId).Execute()

Receive a message on an iOS vm

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/aimoda/go-corellium-api-client"
)

func main() {
    instanceId := "instanceId_example" // string | Instance ID - uuid

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.InstancesApi.V1InstancesInstanceIdMessagePost(context.Background(), instanceId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `InstancesApi.V1InstancesInstanceIdMessagePost``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
instanceId string Instance ID - uuid

Other Parameters

Other parameters are passed through a pointer to a apiV1InstancesInstanceIdMessagePostRequest struct via the builder pattern

Name Type Description Notes

Return type

(empty response body)

Authorization

BearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

V1InstancesInstanceIdNetdumpPcapGet

*os.File V1InstancesInstanceIdNetdumpPcapGet(ctx, instanceId).Execute()

Download a netdump pcap file

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/aimoda/go-corellium-api-client"
)

func main() {
    instanceId := "instanceId_example" // string | Instance ID - uuid

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.InstancesApi.V1InstancesInstanceIdNetdumpPcapGet(context.Background(), instanceId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `InstancesApi.V1InstancesInstanceIdNetdumpPcapGet``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `V1InstancesInstanceIdNetdumpPcapGet`: *os.File
    fmt.Fprintf(os.Stdout, "Response from `InstancesApi.V1InstancesInstanceIdNetdumpPcapGet`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
instanceId string Instance ID - uuid

Other Parameters

Other parameters are passed through a pointer to a apiV1InstancesInstanceIdNetdumpPcapGetRequest struct via the builder pattern

Name Type Description Notes

Return type

*os.File

Authorization

BearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/vnd.tcpdump.pcap, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

V1InstancesInstanceIdNetworkMonitorPcapGet

*os.File V1InstancesInstanceIdNetworkMonitorPcapGet(ctx, instanceId).Execute()

Download a Network Monitor pcap file

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/aimoda/go-corellium-api-client"
)

func main() {
    instanceId := "instanceId_example" // string | Instance ID - uuid

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.InstancesApi.V1InstancesInstanceIdNetworkMonitorPcapGet(context.Background(), instanceId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `InstancesApi.V1InstancesInstanceIdNetworkMonitorPcapGet``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `V1InstancesInstanceIdNetworkMonitorPcapGet`: *os.File
    fmt.Fprintf(os.Stdout, "Response from `InstancesApi.V1InstancesInstanceIdNetworkMonitorPcapGet`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
instanceId string Instance ID - uuid

Other Parameters

Other parameters are passed through a pointer to a apiV1InstancesInstanceIdNetworkMonitorPcapGetRequest struct via the builder pattern

Name Type Description Notes

Return type

*os.File

Authorization

BearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/vnd.tcpdump.pcap, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

V1Kcrange

[]Kcrange V1Kcrange(ctx, instanceId).Execute()

Get Kernel extension ranges

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/aimoda/go-corellium-api-client"
)

func main() {
    instanceId := "instanceId_example" // string | Instance ID - uuid

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.InstancesApi.V1Kcrange(context.Background(), instanceId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `InstancesApi.V1Kcrange``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `V1Kcrange`: []Kcrange
    fmt.Fprintf(os.Stdout, "Response from `InstancesApi.V1Kcrange`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
instanceId string Instance ID - uuid

Other Parameters

Other parameters are passed through a pointer to a apiV1KcrangeRequest struct via the builder pattern

Name Type Description Notes

Return type

[]Kcrange

Authorization

BearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

V1ListThreads

[]KernelTask V1ListThreads(ctx, instanceId).Execute()

Get Running Threads (CoreTrace)

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/aimoda/go-corellium-api-client"
)

func main() {
    instanceId := "instanceId_example" // string | Instance ID - uuid

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.InstancesApi.V1ListThreads(context.Background(), instanceId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `InstancesApi.V1ListThreads``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `V1ListThreads`: []KernelTask
    fmt.Fprintf(os.Stdout, "Response from `InstancesApi.V1ListThreads`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
instanceId string Instance ID - uuid

Other Parameters

Other parameters are passed through a pointer to a apiV1ListThreadsRequest struct via the builder pattern

Name Type Description Notes

Return type

[]KernelTask

Authorization

BearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

V1MediaPlay

V1MediaPlay(ctx, instanceId).MediaPlayBody(mediaPlayBody).Execute()

Start playing media

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/aimoda/go-corellium-api-client"
)

func main() {
    instanceId := "instanceId_example" // string | Instance ID - uuid
    mediaPlayBody := *openapiclient.NewMediaPlayBody() // MediaPlayBody | Request Body

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.InstancesApi.V1MediaPlay(context.Background(), instanceId).MediaPlayBody(mediaPlayBody).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `InstancesApi.V1MediaPlay``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
instanceId string Instance ID - uuid

Other Parameters

Other parameters are passed through a pointer to a apiV1MediaPlayRequest struct via the builder pattern

Name Type Description Notes

mediaPlayBody | MediaPlayBody | Request Body |

Return type

(empty response body)

Authorization

BearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

V1MediaStop

V1MediaStop(ctx, instanceId).Execute()

Stop playing media

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/aimoda/go-corellium-api-client"
)

func main() {
    instanceId := "instanceId_example" // string | Instance ID - uuid

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.InstancesApi.V1MediaStop(context.Background(), instanceId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `InstancesApi.V1MediaStop``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
instanceId string Instance ID - uuid

Other Parameters

Other parameters are passed through a pointer to a apiV1MediaStopRequest struct via the builder pattern

Name Type Description Notes

Return type

(empty response body)

Authorization

BearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

V1PatchInstance

Instance V1PatchInstance(ctx, instanceId).PatchInstanceOptions(patchInstanceOptions).Execute()

Update Instance

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/aimoda/go-corellium-api-client"
)

func main() {
    instanceId := "instanceId_example" // string | Instance ID
    patchInstanceOptions := *openapiclient.NewPatchInstanceOptions() // PatchInstanceOptions | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.InstancesApi.V1PatchInstance(context.Background(), instanceId).PatchInstanceOptions(patchInstanceOptions).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `InstancesApi.V1PatchInstance``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `V1PatchInstance`: Instance
    fmt.Fprintf(os.Stdout, "Response from `InstancesApi.V1PatchInstance`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
instanceId string Instance ID

Other Parameters

Other parameters are passed through a pointer to a apiV1PatchInstanceRequest struct via the builder pattern

Name Type Description Notes

patchInstanceOptions | PatchInstanceOptions | |

Return type

Instance

Authorization

BearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

V1PauseInstance

V1PauseInstance(ctx, instanceId).Execute()

Pause an Instance

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/aimoda/go-corellium-api-client"
)

func main() {
    instanceId := "instanceId_example" // string | Instance ID - uuid

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.InstancesApi.V1PauseInstance(context.Background(), instanceId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `InstancesApi.V1PauseInstance``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
instanceId string Instance ID - uuid

Other Parameters

Other parameters are passed through a pointer to a apiV1PauseInstanceRequest struct via the builder pattern

Name Type Description Notes

Return type

(empty response body)

Authorization

BearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

V1PostInstanceInput

int32 V1PostInstanceInput(ctx, instanceId).InstanceInput(instanceInput).Execute()

Provide Instance Input

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/aimoda/go-corellium-api-client"
)

func main() {
    instanceId := "instanceId_example" // string | Instance ID - uuid
    instanceInput := []openapiclient.InstanceInput{openapiclient.InstanceInput{TextInput: openapiclient.NewTextInput()}} // []InstanceInput | The input to send to the VM

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.InstancesApi.V1PostInstanceInput(context.Background(), instanceId).InstanceInput(instanceInput).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `InstancesApi.V1PostInstanceInput``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `V1PostInstanceInput`: int32
    fmt.Fprintf(os.Stdout, "Response from `InstancesApi.V1PostInstanceInput`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
instanceId string Instance ID - uuid

Other Parameters

Other parameters are passed through a pointer to a apiV1PostInstanceInputRequest struct via the builder pattern

Name Type Description Notes

instanceInput | []InstanceInput | The input to send to the VM |

Return type

int32

Authorization

BearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

V1RebootInstance

V1RebootInstance(ctx, instanceId).Execute()

Reboot an Instance

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/aimoda/go-corellium-api-client"
)

func main() {
    instanceId := "instanceId_example" // string | Instance ID - uuid

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.InstancesApi.V1RebootInstance(context.Background(), instanceId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `InstancesApi.V1RebootInstance``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
instanceId string Instance ID - uuid

Other Parameters

Other parameters are passed through a pointer to a apiV1RebootInstanceRequest struct via the builder pattern

Name Type Description Notes

Return type

(empty response body)

Authorization

BearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

V1RenameInstanceSnapshot

Snapshot V1RenameInstanceSnapshot(ctx, instanceId, snapshotId).SnapshotCreationOptions(snapshotCreationOptions).Execute()

Rename a Snapshot

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/aimoda/go-corellium-api-client"
)

func main() {
    instanceId := "instanceId_example" // string | Instance ID - uuid
    snapshotId := "snapshotId_example" // string | Snapshot ID - uuid
    snapshotCreationOptions := *openapiclient.NewSnapshotCreationOptions("Name_example") // SnapshotCreationOptions | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.InstancesApi.V1RenameInstanceSnapshot(context.Background(), instanceId, snapshotId).SnapshotCreationOptions(snapshotCreationOptions).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `InstancesApi.V1RenameInstanceSnapshot``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `V1RenameInstanceSnapshot`: Snapshot
    fmt.Fprintf(os.Stdout, "Response from `InstancesApi.V1RenameInstanceSnapshot`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
instanceId string Instance ID - uuid
snapshotId string Snapshot ID - uuid

Other Parameters

Other parameters are passed through a pointer to a apiV1RenameInstanceSnapshotRequest struct via the builder pattern

Name Type Description Notes

snapshotCreationOptions | SnapshotCreationOptions | |

Return type

Snapshot

Authorization

BearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

V1RestoreBackup

V1RestoreBackup(ctx, instanceId).Body(body).Execute()

Restore backup

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/aimoda/go-corellium-api-client"
)

func main() {
    instanceId := "instanceId_example" // string | Instance ID - uuid
    body := map[string]interface{}{ ... } // map[string]interface{} | Restore backup data (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.InstancesApi.V1RestoreBackup(context.Background(), instanceId).Body(body).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `InstancesApi.V1RestoreBackup``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
instanceId string Instance ID - uuid

Other Parameters

Other parameters are passed through a pointer to a apiV1RestoreBackupRequest struct via the builder pattern

Name Type Description Notes

body | map[string]interface{} | Restore backup data |

Return type

(empty response body)

Authorization

BearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

V1RestoreInstanceSnapshot

V1RestoreInstanceSnapshot(ctx, instanceId, snapshotId).Execute()

Restore a Snapshot

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/aimoda/go-corellium-api-client"
)

func main() {
    instanceId := "instanceId_example" // string | Instance ID - uuid
    snapshotId := "snapshotId_example" // string | Snapshot ID - uuid

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.InstancesApi.V1RestoreInstanceSnapshot(context.Background(), instanceId, snapshotId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `InstancesApi.V1RestoreInstanceSnapshot``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
instanceId string Instance ID - uuid
snapshotId string Snapshot ID - uuid

Other Parameters

Other parameters are passed through a pointer to a apiV1RestoreInstanceSnapshotRequest struct via the builder pattern

Name Type Description Notes

Return type

(empty response body)

Authorization

BearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

V1RotateInstance

V1RotateInstance(ctx, instanceId).RotateBody(rotateBody).Execute()

Rotate device to specified orientation

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/aimoda/go-corellium-api-client"
)

func main() {
    instanceId := "instanceId_example" // string | 
    rotateBody := *openapiclient.NewRotateBody(float32(123)) // RotateBody | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.InstancesApi.V1RotateInstance(context.Background(), instanceId).RotateBody(rotateBody).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `InstancesApi.V1RotateInstance``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
instanceId string

Other Parameters

Other parameters are passed through a pointer to a apiV1RotateInstanceRequest struct via the builder pattern

Name Type Description Notes

rotateBody | RotateBody | |

Return type

(empty response body)

Authorization

BearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

V1SetInstanceGpios

GpiosState V1SetInstanceGpios(ctx, instanceId).GpiosState(gpiosState).Execute()

Set Instance GPIOs

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/aimoda/go-corellium-api-client"
)

func main() {
    instanceId := "instanceId_example" // string | Instance ID - uuid
    gpiosState := *openapiclient.NewGpiosState() // GpiosState | New GPIO state

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.InstancesApi.V1SetInstanceGpios(context.Background(), instanceId).GpiosState(gpiosState).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `InstancesApi.V1SetInstanceGpios``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `V1SetInstanceGpios`: GpiosState
    fmt.Fprintf(os.Stdout, "Response from `InstancesApi.V1SetInstanceGpios`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
instanceId string Instance ID - uuid

Other Parameters

Other parameters are passed through a pointer to a apiV1SetInstanceGpiosRequest struct via the builder pattern

Name Type Description Notes

gpiosState | GpiosState | New GPIO state |

Return type

GpiosState

Authorization

BearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

V1SetInstancePeripherals

PeripheralsData V1SetInstancePeripherals(ctx, instanceId).PeripheralsData(peripheralsData).Execute()

Set Instance Peripherals

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/aimoda/go-corellium-api-client"
)

func main() {
    instanceId := "instanceId_example" // string | Instance ID - uuid
    peripheralsData := *openapiclient.NewPeripheralsData() // PeripheralsData | New peripherals state

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.InstancesApi.V1SetInstancePeripherals(context.Background(), instanceId).PeripheralsData(peripheralsData).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `InstancesApi.V1SetInstancePeripherals``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `V1SetInstancePeripherals`: PeripheralsData
    fmt.Fprintf(os.Stdout, "Response from `InstancesApi.V1SetInstancePeripherals`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
instanceId string Instance ID - uuid

Other Parameters

Other parameters are passed through a pointer to a apiV1SetInstancePeripheralsRequest struct via the builder pattern

Name Type Description Notes

peripheralsData | PeripheralsData | New peripherals state |

Return type

PeripheralsData

Authorization

BearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

V1SetInstanceState

V1SetInstanceState(ctx, instanceId).V1SetStateBody(v1SetStateBody).Execute()

Set state of Instance

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/aimoda/go-corellium-api-client"
)

func main() {
    instanceId := "instanceId_example" // string | Instance ID - uuid
    v1SetStateBody := *openapiclient.NewV1SetStateBody(openapiclient.InstanceState("on")) // V1SetStateBody | Desired State

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.InstancesApi.V1SetInstanceState(context.Background(), instanceId).V1SetStateBody(v1SetStateBody).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `InstancesApi.V1SetInstanceState``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
instanceId string Instance ID - uuid

Other Parameters

Other parameters are passed through a pointer to a apiV1SetInstanceStateRequest struct via the builder pattern

Name Type Description Notes

v1SetStateBody | V1SetStateBody | Desired State |

Return type

(empty response body)

Authorization

BearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

V1StartCoreTrace

V1StartCoreTrace(ctx, instanceId).Execute()

Start CoreTrace on an instance

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/aimoda/go-corellium-api-client"
)

func main() {
    instanceId := "instanceId_example" // string | Instance ID - uuid

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.InstancesApi.V1StartCoreTrace(context.Background(), instanceId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `InstancesApi.V1StartCoreTrace``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
instanceId string Instance ID - uuid

Other Parameters

Other parameters are passed through a pointer to a apiV1StartCoreTraceRequest struct via the builder pattern

Name Type Description Notes

Return type

(empty response body)

Authorization

BearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

V1StartHyperTrace

V1StartHyperTrace(ctx, instanceId).BtraceEnableOptions(btraceEnableOptions).Execute()

Start HyperTrace on an instance

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/aimoda/go-corellium-api-client"
)

func main() {
    instanceId := "instanceId_example" // string | Instance ID - uuid
    btraceEnableOptions := *openapiclient.NewBtraceEnableOptions() // BtraceEnableOptions | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.InstancesApi.V1StartHyperTrace(context.Background(), instanceId).BtraceEnableOptions(btraceEnableOptions).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `InstancesApi.V1StartHyperTrace``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
instanceId string Instance ID - uuid

Other Parameters

Other parameters are passed through a pointer to a apiV1StartHyperTraceRequest struct via the builder pattern

Name Type Description Notes

btraceEnableOptions | BtraceEnableOptions | |

Return type

(empty response body)

Authorization

BearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

V1StartInstance

V1StartInstance(ctx, instanceId).InstanceStartOptions(instanceStartOptions).Execute()

Start an Instance

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/aimoda/go-corellium-api-client"
)

func main() {
    instanceId := "instanceId_example" // string | Instance ID - uuid
    instanceStartOptions := *openapiclient.NewInstanceStartOptions() // InstanceStartOptions | Start options (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.InstancesApi.V1StartInstance(context.Background(), instanceId).InstanceStartOptions(instanceStartOptions).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `InstancesApi.V1StartInstance``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
instanceId string Instance ID - uuid

Other Parameters

Other parameters are passed through a pointer to a apiV1StartInstanceRequest struct via the builder pattern

Name Type Description Notes

instanceStartOptions | InstanceStartOptions | Start options |

Return type

(empty response body)

Authorization

BearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

V1StartNetdump

V1StartNetdump(ctx, instanceId).NetdumpFilter(netdumpFilter).Execute()

Start Enhanced Network Monitor on an instance.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/aimoda/go-corellium-api-client"
)

func main() {
    instanceId := "instanceId_example" // string | Instance ID - uuid
    netdumpFilter := *openapiclient.NewNetdumpFilter() // NetdumpFilter |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.InstancesApi.V1StartNetdump(context.Background(), instanceId).NetdumpFilter(netdumpFilter).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `InstancesApi.V1StartNetdump``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
instanceId string Instance ID - uuid

Other Parameters

Other parameters are passed through a pointer to a apiV1StartNetdumpRequest struct via the builder pattern

Name Type Description Notes

netdumpFilter | NetdumpFilter | |

Return type

(empty response body)

Authorization

BearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

V1StartNetworkMonitor

V1StartNetworkMonitor(ctx, instanceId).Execute()

Start Network Monitor on an instance.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/aimoda/go-corellium-api-client"
)

func main() {
    instanceId := "instanceId_example" // string | Instance ID - uuid

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.InstancesApi.V1StartNetworkMonitor(context.Background(), instanceId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `InstancesApi.V1StartNetworkMonitor``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
instanceId string Instance ID - uuid

Other Parameters

Other parameters are passed through a pointer to a apiV1StartNetworkMonitorRequest struct via the builder pattern

Name Type Description Notes

Return type

(empty response body)

Authorization

BearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

V1StopCoreTrace

V1StopCoreTrace(ctx, instanceId).Execute()

Stop CoreTrace on an instance.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/aimoda/go-corellium-api-client"
)

func main() {
    instanceId := "instanceId_example" // string | Instance ID - uuid

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.InstancesApi.V1StopCoreTrace(context.Background(), instanceId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `InstancesApi.V1StopCoreTrace``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
instanceId string Instance ID - uuid

Other Parameters

Other parameters are passed through a pointer to a apiV1StopCoreTraceRequest struct via the builder pattern

Name Type Description Notes

Return type

(empty response body)

Authorization

BearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

V1StopHyperTrace

V1StopHyperTrace(ctx, instanceId).Execute()

Stop HyperTrace on an instance.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/aimoda/go-corellium-api-client"
)

func main() {
    instanceId := "instanceId_example" // string | Instance ID - uuid

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.InstancesApi.V1StopHyperTrace(context.Background(), instanceId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `InstancesApi.V1StopHyperTrace``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
instanceId string Instance ID - uuid

Other Parameters

Other parameters are passed through a pointer to a apiV1StopHyperTraceRequest struct via the builder pattern

Name Type Description Notes

Return type

(empty response body)

Authorization

BearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

V1StopInstance

V1StopInstance(ctx, instanceId).InstanceStopOptions(instanceStopOptions).Execute()

Stop an Instance

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/aimoda/go-corellium-api-client"
)

func main() {
    instanceId := "instanceId_example" // string | Instance ID - uuid
    instanceStopOptions := *openapiclient.NewInstanceStopOptions() // InstanceStopOptions | Stop options (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.InstancesApi.V1StopInstance(context.Background(), instanceId).InstanceStopOptions(instanceStopOptions).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `InstancesApi.V1StopInstance``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
instanceId string Instance ID - uuid

Other Parameters

Other parameters are passed through a pointer to a apiV1StopInstanceRequest struct via the builder pattern

Name Type Description Notes

instanceStopOptions | InstanceStopOptions | Stop options |

Return type

(empty response body)

Authorization

BearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

V1StopNetdump

V1StopNetdump(ctx, instanceId).Execute()

Stop Enhanced Network Monitor on an instance.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/aimoda/go-corellium-api-client"
)

func main() {
    instanceId := "instanceId_example" // string | Instance ID - uuid

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.InstancesApi.V1StopNetdump(context.Background(), instanceId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `InstancesApi.V1StopNetdump``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
instanceId string Instance ID - uuid

Other Parameters

Other parameters are passed through a pointer to a apiV1StopNetdumpRequest struct via the builder pattern

Name Type Description Notes

Return type

(empty response body)

Authorization

BearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

V1StopNetworkMonitor

V1StopNetworkMonitor(ctx, instanceId).Execute()

Stop Network Monitor on an instance.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/aimoda/go-corellium-api-client"
)

func main() {
    instanceId := "instanceId_example" // string | Instance ID - uuid

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.InstancesApi.V1StopNetworkMonitor(context.Background(), instanceId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `InstancesApi.V1StopNetworkMonitor``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
instanceId string Instance ID - uuid

Other Parameters

Other parameters are passed through a pointer to a apiV1StopNetworkMonitorRequest struct via the builder pattern

Name Type Description Notes

Return type

(empty response body)

Authorization

BearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

V1UnpauseInstance

V1UnpauseInstance(ctx, instanceId).Execute()

Unpause an Instance

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/aimoda/go-corellium-api-client"
)

func main() {
    instanceId := "instanceId_example" // string | Instance ID - uuid

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.InstancesApi.V1UnpauseInstance(context.Background(), instanceId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `InstancesApi.V1UnpauseInstance``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
instanceId string Instance ID - uuid

Other Parameters

Other parameters are passed through a pointer to a apiV1UnpauseInstanceRequest struct via the builder pattern

Name Type Description Notes

Return type

(empty response body)

Authorization

BearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

V1UpgradeInstance

V1UpgradeInstance(ctx, instanceId).InstanceUpgradeBody(instanceUpgradeBody).Execute()

Upgrade iOS version

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/aimoda/go-corellium-api-client"
)

func main() {
    instanceId := "instanceId_example" // string | 
    instanceUpgradeBody := *openapiclient.NewInstanceUpgradeBody("Os_example") // InstanceUpgradeBody | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.InstancesApi.V1UpgradeInstance(context.Background(), instanceId).InstanceUpgradeBody(instanceUpgradeBody).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `InstancesApi.V1UpgradeInstance``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
instanceId string

Other Parameters

Other parameters are passed through a pointer to a apiV1UpgradeInstanceRequest struct via the builder pattern

Name Type Description Notes

instanceUpgradeBody | InstanceUpgradeBody | |

Return type

(empty response body)

Authorization

BearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

V2GetInstanceQuickConnectCommand

string V2GetInstanceQuickConnectCommand(ctx, instanceId).Execute()

Recommended SSH Command for Quick Connect

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/aimoda/go-corellium-api-client"
)

func main() {
    instanceId := "instanceId_example" // string | Instance ID - uuid

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.InstancesApi.V2GetInstanceQuickConnectCommand(context.Background(), instanceId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `InstancesApi.V2GetInstanceQuickConnectCommand``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `V2GetInstanceQuickConnectCommand`: string
    fmt.Fprintf(os.Stdout, "Response from `InstancesApi.V2GetInstanceQuickConnectCommand`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
instanceId string Instance ID - uuid

Other Parameters

Other parameters are passed through a pointer to a apiV2GetInstanceQuickConnectCommandRequest struct via the builder pattern

Name Type Description Notes

Return type

string

Authorization

BearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

V2GetInstanceState

InstanceState V2GetInstanceState(ctx, instanceId).ReturnAttr(returnAttr).Execute()

Get state of Instance

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/aimoda/go-corellium-api-client"
)

func main() {
    instanceId := "instanceId_example" // string | Instance ID - uuid
    returnAttr := []string{"Inner_example"} // []string | The attributes to return. (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.InstancesApi.V2GetInstanceState(context.Background(), instanceId).ReturnAttr(returnAttr).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `InstancesApi.V2GetInstanceState``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `V2GetInstanceState`: InstanceState
    fmt.Fprintf(os.Stdout, "Response from `InstancesApi.V2GetInstanceState`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
instanceId string Instance ID - uuid

Other Parameters

Other parameters are passed through a pointer to a apiV2GetInstanceStateRequest struct via the builder pattern

Name Type Description Notes

returnAttr | []string | The attributes to return. |

Return type

InstanceState

Authorization

BearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]