Skip to content

PublicAPI.md

Latest commit

 

History

History
137 lines (85 loc) · 3.38 KB

PublicAPI.md

File metadata and controls

137 lines (85 loc) · 3.38 KB
Raw

\PublicAPI

All URIs are relative to http://localhost:5055/api/v1

Method HTTP request Description
GetStatus Get /status Get Seerr status
GetStatusAppdata Get /status/appdata Get application data volume status

GetStatus

GetStatus2XXResponse GetStatus(ctx).CheckUpdateAvailable(checkUpdateAvailable).Execute()

Get Seerr status

Example

package main

import (
	"context"
	"fmt"
	"os"
	seerrClient "github.com/devopsarr/seerr-go/seerr"
)

func main() {
	checkUpdateAvailable := false // bool | If false, updateAvailable and commitsBehind will be omitted from the response. Defaults to the versionCheck setting. (optional)

	configuration := seerrClient.NewConfiguration()
	apiClient := seerrClient.NewAPIClient(configuration)
	resp, r, err := apiClient.PublicAPI.GetStatus(context.Background()).CheckUpdateAvailable(checkUpdateAvailable).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `PublicAPI.GetStatus``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetStatus`: GetStatus2XXResponse
	fmt.Fprintf(os.Stdout, "Response from `PublicAPI.GetStatus`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name Type Description Notes
checkUpdateAvailable bool If false, updateAvailable and commitsBehind will be omitted from the response. Defaults to the versionCheck setting.

Return type

GetStatus2XXResponse

Authorization

No authorization required

HTTP request headers

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

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

GetStatusAppdata

GetStatusAppdata2XXResponse GetStatusAppdata(ctx).Execute()

Get application data volume status

Example

package main

import (
	"context"
	"fmt"
	"os"
	seerrClient "github.com/devopsarr/seerr-go/seerr"
)

func main() {

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

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

GetStatusAppdata2XXResponse

Authorization

No authorization required

HTTP request headers

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

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