\AgentApi

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

Method	HTTP request	Description
V1AgentAppReady	Get /v1/instances/{instanceId}/agent/v1/app/ready	Check if App subsystem is ready
V1AgentDeleteFile	Delete /v1/instances/{instanceId}/agent/v1/file/device/{filePath}	Delete a File on VM
V1AgentGetFile	Get /v1/instances/{instanceId}/agent/v1/file/device/{filePath}	Download a File from VM
V1AgentGetTempFilename	Post /v1/instances/{instanceId}/agent/v1/file/temp	Get the path for a new temp file
V1AgentInstallApp	Post /v1/instances/{instanceId}/agent/v1/app/install	Install App at path
V1AgentInstallProfile	Post /v1/instances/{instanceId}/agent/v1/profile/install	Install a Profile to VM
V1AgentKillApp	Post /v1/instances/{instanceId}/agent/v1/app/apps/{bundleId}/kill	Kill an App
V1AgentListAppIcons	Get /v1/instances/{instanceId}/agent/v1/app/icons	List App Icons
V1AgentListApps	Get /v1/instances/{instanceId}/agent/v1/app/apps	List Apps
V1AgentListAppsStatus	Get /v1/instances/{instanceId}/agent/v1/app/apps/update	List Apps Status
V1AgentListProfiles	Get /v1/instances/{instanceId}/agent/v1/profile/profiles	List Profiles
V1AgentRunApp	Post /v1/instances/{instanceId}/agent/v1/app/apps/{bundleId}/run	Run an App
V1AgentSetFileAttributes	Patch /v1/instances/{instanceId}/agent/v1/file/device/{filePath}	Change Attrs of a File on VM
V1AgentSystemGetAdbAuth	Get /v1/instances/{instanceId}/agent/v1/system/adbauth	Get ADB Auth Setting (AOSP only)
V1AgentSystemGetNetwork	Get /v1/instances/{instanceId}/agent/v1/system/network	Get IP of eth0 (AOSP only)
V1AgentSystemGetProp	Post /v1/instances/{instanceId}/agent/v1/system/getprop	Get System Property (AOSP only)
V1AgentSystemInstallOpenGApps	Post /v1/instances/{instanceId}/agent/v1/system/install-opengapps	Install OpenGApps (AOSP only)
V1AgentSystemLock	Post /v1/instances/{instanceId}/agent/v1/system/lock	Lock Device (iOS Only)
V1AgentSystemSetAdbAuth	Put /v1/instances/{instanceId}/agent/v1/system/adbauth	Set ADB Auth Setting (AOSP only)
V1AgentSystemSetHostname	Post /v1/instances/{instanceId}/agent/v1/system/setHostname	Set Hostname of instance
V1AgentSystemShutdown	Post /v1/instances/{instanceId}/agent/v1/system/shutdown	Instruct VM to halt
V1AgentSystemUnlock	Post /v1/instances/{instanceId}/agent/v1/system/unlock	Unlock Device (iOS Only)
V1AgentUninstallApp	Post /v1/instances/{instanceId}/agent/v1/app/apps/{bundleId}/uninstall	Uninstall an App
V1AgentUninstallProfile	Delete /v1/instances/{instanceId}/agent/v1/profile/profiles/{profileId}	Uninstall a Profile from VM
V1AgentUploadFile	Put /v1/instances/{instanceId}/agent/v1/file/device/{filePath}	Upload a file to VM

V1AgentAppReady

AgentAppReadyResponse V1AgentAppReady(ctx, instanceId).Execute()

Check if App subsystem is ready

Example

package main

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

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

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.AgentApi.V1AgentAppReady(context.Background(), instanceId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `AgentApi.V1AgentAppReady``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `V1AgentAppReady`: AgentAppReadyResponse
    fmt.Fprintf(os.Stdout, "Response from `AgentApi.V1AgentAppReady`: %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 apiV1AgentAppReadyRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

AgentAppReadyResponse

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]

V1AgentDeleteFile

V1AgentDeleteFile(ctx, instanceId, filePath).Execute()

Delete a File on VM

Example

package main

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

func main() {
    instanceId := "instanceId_example" // string | Instance ID - uuid
    filePath := "filePath_example" // string | File Path on VM

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

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
instanceId	string	Instance ID - uuid
filePath	string	File Path on VM

Other Parameters

Other parameters are passed through a pointer to a apiV1AgentDeleteFileRequest 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]

V1AgentGetFile

*os.File V1AgentGetFile(ctx, instanceId, filePath).Execute()

Download a File from VM

Example

package main

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

func main() {
    instanceId := "instanceId_example" // string | Instance ID - uuid
    filePath := "filePath_example" // string | File Path on VM

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

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
instanceId	string	Instance ID - uuid
filePath	string	File Path on VM

Other Parameters

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

Name	Type	Description	Notes

Return type

*os.File

Authorization

BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/octet-stream, application/json

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

V1AgentGetTempFilename

string V1AgentGetTempFilename(ctx, instanceId).Execute()

Get the path for a new temp file

Example

package main

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

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

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.AgentApi.V1AgentGetTempFilename(context.Background(), instanceId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `AgentApi.V1AgentGetTempFilename``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `V1AgentGetTempFilename`: string
    fmt.Fprintf(os.Stdout, "Response from `AgentApi.V1AgentGetTempFilename`: %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 apiV1AgentGetTempFilenameRequest 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]

V1AgentInstallApp

V1AgentInstallApp(ctx, instanceId).AgentInstallBody(agentInstallBody).Execute()

Install App at path

Example

package main

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

func main() {
    instanceId := "instanceId_example" // string | Instance ID - uuid
    agentInstallBody := *openapiclient.NewAgentInstallBody() // AgentInstallBody | App parameters

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.AgentApi.V1AgentInstallApp(context.Background(), instanceId).AgentInstallBody(agentInstallBody).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `AgentApi.V1AgentInstallApp``: %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 apiV1AgentInstallAppRequest struct via the builder pattern

Name	Type	Description	Notes

agentInstallBody | AgentInstallBody | App parameters |

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]

V1AgentInstallProfile

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

Install a Profile to VM

Example

package main

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

func main() {
    instanceId := "instanceId_example" // string | Instance ID - uuid
    body := os.NewFile(1234, "some_file") // *os.File | Profile to Install

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.AgentApi.V1AgentInstallProfile(context.Background(), instanceId).Body(body).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `AgentApi.V1AgentInstallProfile``: %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 apiV1AgentInstallProfileRequest struct via the builder pattern

Name	Type	Description	Notes

body | *os.File | Profile to Install |

Return type

(empty response body)

Authorization

BearerAuth

HTTP request headers

Content-Type: application/octet-stream
Accept: application/json

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

V1AgentKillApp

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

Kill an App

Example

package main

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

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

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

Path Parameters

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

Other Parameters

Other parameters are passed through a pointer to a apiV1AgentKillAppRequest 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]

V1AgentListAppIcons

[]AgentIcons V1AgentListAppIcons(ctx, instanceId).BundleID(bundleID).Execute()

List App Icons

Example

package main

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

func main() {
    instanceId := "instanceId_example" // string | Instance ID - uuid
    bundleID := []string{"Inner_example"} // []string | App Bundle ID

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.AgentApi.V1AgentListAppIcons(context.Background(), instanceId).BundleID(bundleID).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `AgentApi.V1AgentListAppIcons``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `V1AgentListAppIcons`: []AgentIcons
    fmt.Fprintf(os.Stdout, "Response from `AgentApi.V1AgentListAppIcons`: %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 apiV1AgentListAppIconsRequest struct via the builder pattern

Name	Type	Description	Notes

bundleID | []string | App Bundle ID |

Return type

[]AgentIcons

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]

V1AgentListApps

AgentAppsList V1AgentListApps(ctx, instanceId).Execute()

List Apps

Example

package main

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

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

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.AgentApi.V1AgentListApps(context.Background(), instanceId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `AgentApi.V1AgentListApps``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `V1AgentListApps`: AgentAppsList
    fmt.Fprintf(os.Stdout, "Response from `AgentApi.V1AgentListApps`: %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 apiV1AgentListAppsRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

AgentAppsList

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]

V1AgentListAppsStatus

AgentAppsList V1AgentListAppsStatus(ctx, instanceId).Execute()

List Apps Status

Example

package main

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

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

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.AgentApi.V1AgentListAppsStatus(context.Background(), instanceId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `AgentApi.V1AgentListAppsStatus``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `V1AgentListAppsStatus`: AgentAppsList
    fmt.Fprintf(os.Stdout, "Response from `AgentApi.V1AgentListAppsStatus`: %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 apiV1AgentListAppsStatusRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

AgentAppsList

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]

V1AgentListProfiles

AgentProfilesReturn V1AgentListProfiles(ctx, instanceId).Execute()

List Profiles

Example

package main

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

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

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.AgentApi.V1AgentListProfiles(context.Background(), instanceId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `AgentApi.V1AgentListProfiles``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `V1AgentListProfiles`: AgentProfilesReturn
    fmt.Fprintf(os.Stdout, "Response from `AgentApi.V1AgentListProfiles`: %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 apiV1AgentListProfilesRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

AgentProfilesReturn

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]

V1AgentRunApp

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

Run an App

Example

package main

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

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

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

Path Parameters

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

Other Parameters

Other parameters are passed through a pointer to a apiV1AgentRunAppRequest 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]

V1AgentSetFileAttributes

V1AgentSetFileAttributes(ctx, instanceId, filePath).FileChanges(fileChanges).Execute()

Change Attrs of a File on VM

Example

package main

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

func main() {
    instanceId := "instanceId_example" // string | Instance ID - uuid
    filePath := "filePath_example" // string | File Path on VM
    fileChanges := *openapiclient.NewFileChanges() // FileChanges | New attrs

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

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
instanceId	string	Instance ID - uuid
filePath	string	File Path on VM

Other Parameters

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

Name	Type	Description	Notes

fileChanges | FileChanges | New attrs |

Return type

(empty response body)

Authorization

BearerAuth

HTTP request headers

Content-Type: application/json
Accept: Not defined

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

V1AgentSystemGetAdbAuth

AgentSystemAdbAuth V1AgentSystemGetAdbAuth(ctx, instanceId).Execute()

Get ADB Auth Setting (AOSP only)

Example

package main

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

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

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.AgentApi.V1AgentSystemGetAdbAuth(context.Background(), instanceId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `AgentApi.V1AgentSystemGetAdbAuth``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `V1AgentSystemGetAdbAuth`: AgentSystemAdbAuth
    fmt.Fprintf(os.Stdout, "Response from `AgentApi.V1AgentSystemGetAdbAuth`: %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 apiV1AgentSystemGetAdbAuthRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

AgentSystemAdbAuth

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]

V1AgentSystemGetNetwork

AgentValueReturn V1AgentSystemGetNetwork(ctx, instanceId).Execute()

Get IP of eth0 (AOSP only)

Example

package main

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

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

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.AgentApi.V1AgentSystemGetNetwork(context.Background(), instanceId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `AgentApi.V1AgentSystemGetNetwork``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `V1AgentSystemGetNetwork`: AgentValueReturn
    fmt.Fprintf(os.Stdout, "Response from `AgentApi.V1AgentSystemGetNetwork`: %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 apiV1AgentSystemGetNetworkRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

AgentValueReturn

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]

V1AgentSystemGetProp

AgentValueReturn V1AgentSystemGetProp(ctx, instanceId).AgentSystemGetPropBody(agentSystemGetPropBody).Execute()

Get System Property (AOSP only)

Example

package main

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

func main() {
    instanceId := "instanceId_example" // string | Instance ID - uuid
    agentSystemGetPropBody := *openapiclient.NewAgentSystemGetPropBody("Property_example") // AgentSystemGetPropBody | Parameters

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.AgentApi.V1AgentSystemGetProp(context.Background(), instanceId).AgentSystemGetPropBody(agentSystemGetPropBody).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `AgentApi.V1AgentSystemGetProp``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `V1AgentSystemGetProp`: AgentValueReturn
    fmt.Fprintf(os.Stdout, "Response from `AgentApi.V1AgentSystemGetProp`: %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 apiV1AgentSystemGetPropRequest struct via the builder pattern

Name	Type	Description	Notes

agentSystemGetPropBody | AgentSystemGetPropBody | Parameters |

Return type

AgentValueReturn

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]

V1AgentSystemInstallOpenGApps

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

Install OpenGApps (AOSP only)

Example

package main

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

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

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.AgentApi.V1AgentSystemInstallOpenGApps(context.Background(), instanceId).Body(body).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `AgentApi.V1AgentSystemInstallOpenGApps``: %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 apiV1AgentSystemInstallOpenGAppsRequest struct via the builder pattern

Name	Type	Description	Notes

body | map[string]interface{} | Installation parameters |

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]

V1AgentSystemLock

V1AgentSystemLock(ctx, instanceId).Execute()

Lock Device (iOS Only)

Example

package main

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

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

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.AgentApi.V1AgentSystemLock(context.Background(), instanceId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `AgentApi.V1AgentSystemLock``: %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 apiV1AgentSystemLockRequest 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]

V1AgentSystemSetAdbAuth

V1AgentSystemSetAdbAuth(ctx, instanceId).AgentSystemAdbAuth(agentSystemAdbAuth).Execute()

Set ADB Auth Setting (AOSP only)

Example

package main

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

func main() {
    instanceId := "instanceId_example" // string | Instance ID - uuid
    agentSystemAdbAuth := *openapiclient.NewAgentSystemAdbAuth() // AgentSystemAdbAuth | Desired ADB Auth Setting

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.AgentApi.V1AgentSystemSetAdbAuth(context.Background(), instanceId).AgentSystemAdbAuth(agentSystemAdbAuth).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `AgentApi.V1AgentSystemSetAdbAuth``: %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 apiV1AgentSystemSetAdbAuthRequest struct via the builder pattern

Name	Type	Description	Notes

agentSystemAdbAuth | AgentSystemAdbAuth | Desired ADB Auth Setting |

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]

V1AgentSystemSetHostname

V1AgentSystemSetHostname(ctx, instanceId).AgentSystemSetHostnameBody(agentSystemSetHostnameBody).Execute()

Set Hostname of instance

Example

package main

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

func main() {
    instanceId := "instanceId_example" // string | Instance ID - uuid
    agentSystemSetHostnameBody := *openapiclient.NewAgentSystemSetHostnameBody("Hostname_example") // AgentSystemSetHostnameBody | New hostname

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.AgentApi.V1AgentSystemSetHostname(context.Background(), instanceId).AgentSystemSetHostnameBody(agentSystemSetHostnameBody).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `AgentApi.V1AgentSystemSetHostname``: %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 apiV1AgentSystemSetHostnameRequest struct via the builder pattern

Name	Type	Description	Notes

agentSystemSetHostnameBody | AgentSystemSetHostnameBody | New hostname |

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]

V1AgentSystemShutdown

V1AgentSystemShutdown(ctx, instanceId).Execute()

Instruct VM to halt

Example

package main

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

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

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.AgentApi.V1AgentSystemShutdown(context.Background(), instanceId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `AgentApi.V1AgentSystemShutdown``: %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 apiV1AgentSystemShutdownRequest 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]

V1AgentSystemUnlock

V1AgentSystemUnlock(ctx, instanceId).Execute()

Unlock Device (iOS Only)

Example

package main

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

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

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.AgentApi.V1AgentSystemUnlock(context.Background(), instanceId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `AgentApi.V1AgentSystemUnlock``: %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 apiV1AgentSystemUnlockRequest 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]

V1AgentUninstallApp

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

Uninstall an App

Example

package main

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

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

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

Path Parameters

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

Other Parameters

Other parameters are passed through a pointer to a apiV1AgentUninstallAppRequest 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]

V1AgentUninstallProfile

V1AgentUninstallProfile(ctx, instanceId, profileId).Execute()

Uninstall a Profile from VM

Example

package main

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

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

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

Path Parameters

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

Other Parameters

Other parameters are passed through a pointer to a apiV1AgentUninstallProfileRequest 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]

V1AgentUploadFile

V1AgentUploadFile(ctx, instanceId, filePath).Body(body).Execute()

Upload a file to VM

Example

package main

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

func main() {
    instanceId := "instanceId_example" // string | Instance ID - uuid
    filePath := "filePath_example" // string | File Path on VM to write to
    body := os.NewFile(1234, "some_file") // *os.File | Uploaded File Contents

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

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
instanceId	string	Instance ID - uuid
filePath	string	File Path on VM to write to

Other Parameters

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

Name	Type	Description	Notes

body | *os.File | Uploaded File Contents |

Return type

(empty response body)

Authorization

BearerAuth

HTTP request headers

Content-Type: application/octet-stream
Accept: application/json

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

Files

AgentApi.md

Latest commit

History

AgentApi.md

File metadata and controls

\AgentApi

V1AgentAppReady

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

V1AgentDeleteFile

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

V1AgentGetFile

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

V1AgentGetTempFilename

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

V1AgentInstallApp

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

V1AgentInstallProfile

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

V1AgentKillApp

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

V1AgentListAppIcons

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

V1AgentListApps

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

V1AgentListAppsStatus

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

V1AgentListProfiles

Example

Path Parameters