UiConfigAPI.md

\UiConfigAPI

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

Method	HTTP request	Description
GetUiConfig	Get /api/v1/config/ui
GetUiConfigById	Get /api/v1/config/ui/{id}
UpdateUiConfig	Put /api/v1/config/ui/{id}

GetUiConfig

UiConfigResource GetUiConfig(ctx).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	readarrClient "github.com/devopsarr/readarr-go/readarr"
)

func main() {

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

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

UiConfigResource

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]

GetUiConfigById

UiConfigResource GetUiConfigById(ctx, id).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	readarrClient "github.com/devopsarr/readarr-go/readarr"
)

func main() {
	id := int32(56) // int32 | 

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

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
id	int32

Other Parameters

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

Name	Type	Description	Notes

Return type

UiConfigResource

Authorization

apikey, X-Api-Key

HTTP request headers

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

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

UpdateUiConfig

UiConfigResource UpdateUiConfig(ctx, id).UiConfigResource(uiConfigResource).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	readarrClient "github.com/devopsarr/readarr-go/readarr"
)

func main() {
	id := "id_example" // string | 
	uiConfigResource := *readarrClient.NewUiConfigResource() // UiConfigResource |  (optional)

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

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
id	string

Other Parameters

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

Name	Type	Description	Notes

uiConfigResource | UiConfigResource | |

Return type

UiConfigResource

Authorization

apikey, X-Api-Key

HTTP request headers

• Content-Type: application/json, text/json, application/*+json
• Accept: text/plain, application/json, text/json

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