Skip to content

Latest commit

 

History

History
213 lines (137 loc) · 5.86 KB

NetdumpApi.md

File metadata and controls

213 lines (137 loc) · 5.86 KB

\NetdumpApi

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

Method HTTP request Description
V1InstancesInstanceIdNetdumpPcapGet Get /v1/instances/{instanceId}/netdump.pcap Download a netdump pcap file
V1StartNetdump Post /v1/instances/{instanceId}/netdump/enable Start Enhanced Network Monitor on an instance.
V1StopNetdump Post /v1/instances/{instanceId}/netdump/disable Stop Enhanced Network Monitor on an instance.

V1InstancesInstanceIdNetdumpPcapGet

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

Download a netdump pcap 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.NetdumpApi.V1InstancesInstanceIdNetdumpPcapGet(context.Background(), instanceId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `NetdumpApi.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 `NetdumpApi.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]

V1StartNetdump

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

Start Enhanced Network Monitor on an 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
    netdumpFilter := *openapiclient.NewNetdumpFilter() // NetdumpFilter |  (optional)

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

V1StopNetdump

V1StopNetdump(ctx, instanceId).Execute()

Stop Enhanced Network Monitor on an 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

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