Skip to content

Latest commit

 

History

History
285 lines (180 loc) · 7.37 KB

AppManagementApi.md

File metadata and controls

285 lines (180 loc) · 7.37 KB
Raw

\AppManagementApi

All URIs are relative to https://api.au.sumologic.com/api

Method HTTP request Description
GetApp Get /v1/apps/{uuid} Get an app by UUID.
GetAsyncInstallStatus Get /v1/apps/install/{jobId}/status App install job status.
InstallApp Post /v1/apps/{uuid}/install Install an app by UUID.
ListApps Get /v1/apps List available apps.

GetApp

App GetApp(ctx, uuid).Execute()

Get an app by UUID.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    uuid := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | The identifier of the app to retrieve.

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
uuid string The identifier of the app to retrieve.

Other Parameters

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

Name Type Description Notes

Return type

App

Authorization

basicAuth

HTTP request headers

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

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

GetAsyncInstallStatus

AsyncJobStatus GetAsyncInstallStatus(ctx, jobId).Execute()

App install job status.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    jobId := "jobId_example" // string | The identifier of the asynchronous install job.

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
jobId string The identifier of the asynchronous install job.

Other Parameters

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

Name Type Description Notes

Return type

AsyncJobStatus

Authorization

basicAuth

HTTP request headers

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

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

InstallApp

BeginAsyncJobResponse InstallApp(ctx, uuid).AppInstallRequest(appInstallRequest).Execute()

Install an app by UUID.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    uuid := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | UUID of the app to install.
    appInstallRequest := *openapiclient.NewAppInstallRequest("Sumo Logic Configuration App", "Sumo Logic Configuration App to configure collectors and data sources", "00000000000001C8") // AppInstallRequest | 

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.AppManagementApi.InstallApp(context.Background(), uuid).AppInstallRequest(appInstallRequest).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `AppManagementApi.InstallApp``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `InstallApp`: BeginAsyncJobResponse
    fmt.Fprintf(os.Stdout, "Response from `AppManagementApi.InstallApp`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
uuid string UUID of the app to install.

Other Parameters

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

Name Type Description Notes

appInstallRequest | AppInstallRequest | |

Return type

BeginAsyncJobResponse

Authorization

basicAuth

HTTP request headers

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

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

ListApps

ListAppsResult ListApps(ctx).Execute()

List available apps.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {

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

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

ListAppsResult

Authorization

basicAuth

HTTP request headers

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

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