LogFileAPI.md

\LogFileAPI

All URIs are relative to http://localhost:7878

Method	HTTP request	Description
GetLogFileByFilename	Get /api/v3/log/file/{filename}
ListLogFile	Get /api/v3/log/file

GetLogFileByFilename

GetLogFileByFilename(ctx, filename).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	whisparrClient "github.com/devopsarr/whisparr-go/whisparr"
)

func main() {
	filename := "filename_example" // string | 

	configuration := whisparrClient.NewConfiguration()
	apiClient := whisparrClient.NewAPIClient(configuration)
	r, err := apiClient.LogFileAPI.GetLogFileByFilename(context.Background(), filename).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `LogFileAPI.GetLogFileByFilename``: %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.
filename	string

Other Parameters

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

Name	Type	Description	Notes

Return type

(empty response body)

Authorization

apikey, X-Api-Key

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

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

ListLogFile

[]LogFileResource ListLogFile(ctx).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	whisparrClient "github.com/devopsarr/whisparr-go/whisparr"
)

func main() {

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

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

[]LogFileResource

Authorization

apikey, X-Api-Key

HTTP request headers

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

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